From a4282fedaa73bb8ae291aab95340dbe752cfee28 Mon Sep 17 00:00:00 2001 From: Teruaki Kawashima Date: Fri, 19 Feb 2010 14:56:02 +0000 Subject: add manual for bmp viewer plugin. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@24774 a1c6a512-1295-4272-9138-f99709370657 --- manual/plugins/bmpviewer.tex | 105 ++++++++++++++++++++++++++++++++++++++++++ manual/plugins/jpegviewer.tex | 6 +-- manual/plugins/main.tex | 3 ++ manual/plugins/pngviewer.tex | 4 +- 4 files changed, 113 insertions(+), 5 deletions(-) create mode 100755 manual/plugins/bmpviewer.tex (limited to 'manual') diff --git a/manual/plugins/bmpviewer.tex b/manual/plugins/bmpviewer.tex new file mode 100755 index 0000000000..38745a9703 --- /dev/null +++ b/manual/plugins/bmpviewer.tex @@ -0,0 +1,105 @@ +% $Id$ % +\subsection{BMP viewer} +This plugin opens \fname{.bmp} files from the \setting{File Browser} to display them\nopt{lcd_color}{ using Rockbox's greyscale library}. +\opt{swcodec}{ +\par +\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_FUZE_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} % + \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD% + ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD% + ,MROBE100_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD} + {/ \ButtonLeft\ / \ButtonRight} + \opt{COWON_D2_PAD}{} + \opt{HAVEREMOTEKEYMAP}{& } + & Move around in zoomed in image\\ + \opt{RECORDER_PAD}{\ButtonPlay} + \opt{ONDIO_PAD,COWON_D2_PAD}{\ButtonMenu} + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD% + ,SANSA_FUZE_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_FUZE_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,SANSA_FUZE_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 bmp 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,SANSA_FUZE_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 bmp 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{SANSA_FUZE_PAD}{Long \ButtonHome} + \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu} + \opt{COWON_D2_PAD}{\ButtonPower} + \opt{HAVEREMOTEKEYMAP}{& + \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop} + } + & Show menu / Abort \\ +\end{btnmap} +\end{table} + +The menu has the following entries. +\begin{description} +\item[Return.] Returns you to the image +\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[Quit.] Quits the viewer and returns to the \setting{File Browser}. +\end{description} diff --git a/manual/plugins/jpegviewer.tex b/manual/plugins/jpegviewer.tex index 895282cd3d..9a582386e0 100644 --- a/manual/plugins/jpegviewer.tex +++ b/manual/plugins/jpegviewer.tex @@ -87,13 +87,13 @@ view a bigger file you may need to stop playback.} \opt{HAVEREMOTEKEYMAP}{& \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop} } - & Show menu\\ + & Show menu / Abort \\ \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[Return.] Returns you to the image \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. @@ -106,7 +106,7 @@ playback of the currently loaded playlist and change the volume of your \dap. image in greyscale using the \setting{Greyscale} option or set the method of dithering used in the \setting{Dithering} submenu. } -\item[Return.] Returns you to the image +\item[Quit.] Quits the viewer and returns to the \setting{File Browser}. \end{description} \note{ diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index ff332b70c5..6bce439c56 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex @@ -133,6 +133,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).} \begin{rbtabular}{.92\textwidth}{Xlc}% {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}% {}{} + BMP Viewer & \fname{.bmp} & \\ Shortcuts & \fname{.link} & \\ Chip-8 Emulator & \fname{.ch8} & \\ Frotz & \fname{.z1 - .z8} & \\ @@ -159,6 +160,8 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).} {\input{plugins/shortcuts.tex}} +\opt{lcd_bitmap}{\input{plugins/bmpviewer.tex}} + \opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}} \opt{lcd_bitmap}{\input{plugins/frotz.tex}} diff --git a/manual/plugins/pngviewer.tex b/manual/plugins/pngviewer.tex index 88c4ddb264..56ca86af29 100644 --- a/manual/plugins/pngviewer.tex +++ b/manual/plugins/pngviewer.tex @@ -90,7 +90,7 @@ display them. The menu has the following entries. \begin{description} -\item[Quit.] Quits the viewer and returns to the \setting{File Browser}. +\item[Return.] Returns you to the image \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. @@ -98,5 +98,5 @@ The menu has the following entries. \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 +\item[Quit.] Quits the viewer and returns to the \setting{File Browser}. \end{description} -- cgit v1.2.3