From 9bcc6701bf1689d3d06089b1d239f1ecfb9e9844 Mon Sep 17 00:00:00 2001 From: Frank Gevaerts Date: Sat, 1 Aug 2009 13:42:51 +0000 Subject: Add png viewer plugin documentation Author: Christophe Gouiran Flyspray: FS#10475 git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22092 a1c6a512-1295-4272-9138-f99709370657 --- manual/plugins/main.tex | 2 + manual/plugins/pngviewer.tex | 96 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 manual/plugins/pngviewer.tex diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index 1a684b1007..1a57fc96ef 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex @@ -137,6 +137,8 @@ the associated file. Viewers are stored in the \opt{lcd_bitmap}{\opt{swcodec}{\input{plugins/mpegplayer.tex}}} +\opt{lcd_bitmap}{\opt{lcd_color}{\input{plugins/pngviewer.tex}}} + \opt{lcd_color}{\input{plugins/ppmviewer.tex}} \opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}} diff --git a/manual/plugins/pngviewer.tex b/manual/plugins/pngviewer.tex new file mode 100644 index 0000000000..c205ac0666 --- /dev/null +++ b/manual/plugins/pngviewer.tex @@ -0,0 +1,96 @@ +% $Id: $id$ % +\subsection{PNG viewer} +Open a PNG file in the \setting{File Browser} to view it% +\opt{swcodec}{ + \note{When an audio file is playing the size of the image is limited as + the decoding process needs to share memory with audio tracks. To be able to + view a bigger file you may need to stop playback.} +} +\nopt{large_plugin_buffer}{% +\note{This plugin will cause playback to stop.}% +}% + +\begin{table} +\begin{btnmap}{}{} + \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD% + ,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD} + {\ButtonUp\ / \ButtonDown}% + \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu\ / \ButtonPlay}% + \opt{IRIVER_H10_PAD}{\ButtonScrollUp\ / \ButtonScrollDown} % + / \ButtonLeft\ / \ButtonRight + \opt{HAVEREMOTEKEYMAP}{& } + & Move around in zoomed in image\\ + \opt{RECORDER_PAD}{\ButtonPlay} + \opt{ONDIO_PAD}{\ButtonMenu} + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD% + ,SANSA_C200_PAD,MROBE100_PAD}{\ButtonSelect} + \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd} + \opt{IRIVER_H10_PAD}{\ButtonPlay} + \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp} + \opt{HAVEREMOTEKEYMAP}{& } + & Zoom in\\ + \opt{RECORDER_PAD}{\ButtonOn} + \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown} + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode} + \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack} + \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{Long \ButtonSelect} + \opt{IRIVER_H10_PAD}{Long \ButtonPlay} + \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown} + \opt{MROBE100_PAD}{\ButtonPlay} + \opt{HAVEREMOTEKEYMAP}{& } + & Zoom out\\ + \opt{RECORDER_PAD}{\ButtonFThree} + \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight} + \opt{IRIVER_H100_PAD}{\ButtonOn} + \opt{IRIVER_H300_PAD}{\ButtonRec} + \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight} + \opt{IAUDIO_X5_PAD}{\ButtonPlay} + \opt{IRIVER_H10_PAD}{\ButtonFF} + \opt{SANSA_E200_PAD}{\ButtonScrollFwd} + \opt{SANSA_C200_PAD}{\ButtonVolUp} + \opt{GIGABEAT_PAD}{\ButtonA+\ButtonRight} + \opt{GIGABEAT_S_PAD}{\ButtonNext} + \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonRight} + \opt{HAVEREMOTEKEYMAP}{& } + & Next png in directory\\ + \opt{RECORDER_PAD}{\ButtonFTwo} + \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft} + \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonRec} + \opt{IRIVER_H300_PAD}{\ButtonOn} + \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft} + \opt{IRIVER_H10_PAD}{\ButtonRew} + \opt{SANSA_E200_PAD}{\ButtonScrollBack} + \opt{SANSA_C200_PAD}{\ButtonVolDown} + \opt{GIGABEAT_PAD}{\ButtonA+\ButtonLeft} + \opt{GIGABEAT_S_PAD}{\ButtonPrev} + \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonLeft} + \opt{HAVEREMOTEKEYMAP}{& } + & Previous png in directory\\ + \opt{SANSA_E200_PAD,SANSA_C200_PAD}{%currently only defined for the sansa pads + \ButtonRec + \opt{HAVEREMOTEKEYMAP}{& } + & Toggle slide show mode\\ + } + \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff} + \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu} + \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower} + \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu} + \opt{HAVEREMOTEKEYMAP}{& + \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop} + } + & Show menu / Abort while decoding \\ +\end{btnmap} +\end{table} + +The menu has the following entries. +\begin{description} +\item[Quit.] Quits the viewer and returns to the \setting{File Browser}. +\item[Toggle Slideshow Mode.] Enables or disables the slideshow mode. +\item[Change Slideshow Timeout.] You can set the timeout for the slideshow + between 1 second and 20 seconds. +\opt{large_plugin_buffer}{ +\item[Show Playback Menu.] From the playback menu you can control the +playback of the currently loaded playlist and change the volume of your \dap. +} +\item[Return.] Returns you to the image +\end{description} -- cgit v1.2.3