summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorAlexander Levin <al.le@rockbox.org>2009-09-21 10:43:22 +0000
committerAlexander Levin <al.le@rockbox.org>2009-09-21 10:43:22 +0000
commitf744e2651fc3d8a330d721e1443dc904df51aafd (patch)
treef8c5a791069e9d61d4617c3c26c49d0ba4c541a0 /manual
parentd9490178ff85b9b5af673826613d2a5b134b8783 (diff)
downloadrockbox-f744e2651fc3d8a330d721e1443dc904df51aafd.tar.gz
rockbox-f744e2651fc3d8a330d721e1443dc904df51aafd.tar.bz2
rockbox-f744e2651fc3d8a330d721e1443dc904df51aafd.zip
Improvements to the viewers section of the manual (FS#10531 by David Kaufmann)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22764 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/jpegviewer.tex12
-rw-r--r--manual/plugins/main.tex35
-rw-r--r--manual/plugins/movieplayer.tex3
-rw-r--r--manual/plugins/pngviewer.tex3
-rw-r--r--manual/plugins/ppmviewer.tex7
-rw-r--r--manual/plugins/vbrfix.tex11
6 files changed, 51 insertions, 20 deletions
diff --git a/manual/plugins/jpegviewer.tex b/manual/plugins/jpegviewer.tex
index afa4c7a9b6..7cbdc4b99b 100644
--- a/manual/plugins/jpegviewer.tex
+++ b/manual/plugins/jpegviewer.tex
@@ -1,12 +1,12 @@
% $Id$ %
\subsection{JPEG viewer}
-Open a JPEG file in the \setting{File Browser} to view it%
-\nopt{lcd_color}{ using Rockbox's
-greyscale library}.
+This plugin opens \fname{.jpeg} files from the \setting{File Browser} to display them\nopt{lcd_color}{ using Rockbox's greyscale library}.
\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.}
+\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.}%
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 51344123f7..5e98d08170 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -119,9 +119,38 @@ text files%
\section{\label{ref:Viewersplugins}Viewers}
Viewers are plugins which are associated with specific file extensions.
-They cannot be run directly but are started by ``playing''
-the associated file. Viewers are stored in the
-\textbf{/.rockbox/rocks/viewers/ }directory.
+They cannot be run directly but are started by ``playing''the associated file.
+Viewers are stored in the \fname{/.rockbox/rocks/viewers/} directory.
+\par
+\note{
+Some viewer plugins can only be used by selecting the \setting{Open With...}
+option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
+\begin{table}
+\begin{rbtabular}{.92\textwidth}{Xlc}%
+ {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
+ {}{}
+ Shortcuts & \fname{.link} & \\
+ Chip-8 Emulator & \fname{.ch8} & \\
+ JPEG Viewer & \fname{.jpg, .jpeg} & \\
+ Lua scripting language& \fname{.lua} & \\
+ Midiplay & \fname{.mid, .midi} & \\
+ \opt{swcodec}{
+ MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\}
+ \opt{masf}{\opt{lcd_bitmap}{
+ Movie Player & \fname{.rvf} & \\}}
+ PNG viewer & \fname{.png} & \\
+ \opt{lcd_color}{
+ PPM viewer & \fname{.ppm} & \\}
+ Rockboy & \fname{.gb, .gbc} & \\
+ Search & \fname{.m3u, .m3u8} & x \\
+ Sort & \fname{.*} & x \\
+ Text Viewer & \fname{.txt, .*} & \\
+ VBRfix & \fname{.mp3} & x \\
+ \opt{masf}{
+ Wavplay & \fname{.wav} & \\}
+ ZXBox & \fname{.tap, .tax, .sna, .z80} & \\
+\end{rbtabular}
+\end{table}
{\input{plugins/shortcuts.tex}}
diff --git a/manual/plugins/movieplayer.tex b/manual/plugins/movieplayer.tex
index 3c72559cbf..93a64d7415 100644
--- a/manual/plugins/movieplayer.tex
+++ b/manual/plugins/movieplayer.tex
@@ -2,5 +2,4 @@
\subsection{Movie Player}
Play movies on your \dap! In order to do this, movies must be in AVI format,
and then converted to \fname{.RVF}, Rockbox's own video format. For more
-details on how to use this plugin, please see
-\wikilink{VideoTutorial}.
+details on how to use this plugin, please see \wikilink{VideoTutorial}.
diff --git a/manual/plugins/pngviewer.tex b/manual/plugins/pngviewer.tex
index 40e91977de..fd03c88c2e 100644
--- a/manual/plugins/pngviewer.tex
+++ b/manual/plugins/pngviewer.tex
@@ -1,6 +1,7 @@
% $Id: $id$ %
\subsection{PNG viewer}
-Open a PNG file in the \setting{File Browser} to view it.\\%
+This plugin opens \fname{.png} files from the \setting{File Browser} to
+display them.
\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
diff --git a/manual/plugins/ppmviewer.tex b/manual/plugins/ppmviewer.tex
index 7594fafe69..87e8156a9f 100644
--- a/manual/plugins/ppmviewer.tex
+++ b/manual/plugins/ppmviewer.tex
@@ -1,8 +1,9 @@
% $Id$ %
\subsection{PPM viewer}
-Open a PPM file in the \setting{File Browser} to view it. PPM viewer exits
-when any button is pressed.\\
+This plugin opens \fname{.ppm} files from the \setting{File Browser}
+to display them. Exit the ppm viewer plugin by pressing any button.
+
+\note{Both ASCII PPM (P3) and raw PPM (P6) files are supported.}
-\note{Both ASCII PPM (P3) and raw PPM (P6) files are supported.
For more information about PPM files, see
\url{http://netpbm.sourceforge.net/doc/ppm.html}}
diff --git a/manual/plugins/vbrfix.tex b/manual/plugins/vbrfix.tex
index 9c54c55f3e..9d8be401ae 100644
--- a/manual/plugins/vbrfix.tex
+++ b/manual/plugins/vbrfix.tex
@@ -6,8 +6,9 @@ rate, time information and to more accurately fwd/rew in the stream.
This function is especially useful when the playback of a file skips,
fwd/rew does not work correctly or the time display is incorrect.
To use this plugin, open the \setting{Context Menu} (see \reference{ref:Contextmenu})
-upon a \fname{.mp3} file and select \setting{Open With... $\rightarrow$ vbrfix}.
-
-\note{VBRfix can only run when music is
- turned off (since it uses the same memory as the player) and can take a
- while to complete if run on big files.}
+upon a \fname{.mp3} file and select \setting{Open With\dots $\rightarrow$ vbrfix}.
+\par
+\note{
+VBRfix can only run when music is turned off (since it uses
+the same memory as the player) and can take a while to complete if
+run on big files.}