summaryrefslogtreecommitdiff
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
parentd9490178ff85b9b5af673826613d2a5b134b8783 (diff)
downloadrockbox-f744e2651fc3d8a330d721e1443dc904df51aafd.tar.gz
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
-rw-r--r--docs/CREDITS-MANUAL1
-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
7 files changed, 52 insertions, 20 deletions
diff --git a/docs/CREDITS-MANUAL b/docs/CREDITS-MANUAL
index 475774985d..5ecbde46b6 100644
--- a/docs/CREDITS-MANUAL
+++ b/docs/CREDITS-MANUAL
@@ -34,3 +34,4 @@ Will Robertson
34Robert Menes 34Robert Menes
35Alex Parker 35Alex Parker
36Dan Davison 36Dan Davison
37David Kaufmann
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 @@
1% $Id$ % 1% $Id$ %
2\subsection{JPEG viewer} 2\subsection{JPEG viewer}
3Open a JPEG file in the \setting{File Browser} to view it% 3This plugin opens \fname{.jpeg} files from the \setting{File Browser} to display them\nopt{lcd_color}{ using Rockbox's greyscale library}.
4\nopt{lcd_color}{ using Rockbox's
5greyscale library}.
6\opt{swcodec}{ 4\opt{swcodec}{
7 \note{When an audio file is playing the size of the image is limited as 5\par
8 the decoding process needs to share memory with audio tracks. To be able to 6\note{
9 view a bigger file you may need to stop playback.} 7When an audio file is playing the size of the image is limited as
8the decoding process needs to share memory with audio tracks. To be able to
9view a bigger file you may need to stop playback.}
10} 10}
11\nopt{large_plugin_buffer}{% 11\nopt{large_plugin_buffer}{%
12\note{This plugin will cause playback to stop.}% 12\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%
119\section{\label{ref:Viewersplugins}Viewers} 119\section{\label{ref:Viewersplugins}Viewers}
120 120
121Viewers are plugins which are associated with specific file extensions. 121Viewers are plugins which are associated with specific file extensions.
122They cannot be run directly but are started by ``playing'' 122They cannot be run directly but are started by ``playing''the associated file.
123the associated file. Viewers are stored in the 123Viewers are stored in the \fname{/.rockbox/rocks/viewers/} directory.
124\textbf{/.rockbox/rocks/viewers/ }directory. 124\par
125\note{
126Some viewer plugins can only be used by selecting the \setting{Open With...}
127option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
128\begin{table}
129\begin{rbtabular}{.92\textwidth}{Xlc}%
130 {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
131 {}{}
132 Shortcuts & \fname{.link} & \\
133 Chip-8 Emulator & \fname{.ch8} & \\
134 JPEG Viewer & \fname{.jpg, .jpeg} & \\
135 Lua scripting language& \fname{.lua} & \\
136 Midiplay & \fname{.mid, .midi} & \\
137 \opt{swcodec}{
138 MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\}
139 \opt{masf}{\opt{lcd_bitmap}{
140 Movie Player & \fname{.rvf} & \\}}
141 PNG viewer & \fname{.png} & \\
142 \opt{lcd_color}{
143 PPM viewer & \fname{.ppm} & \\}
144 Rockboy & \fname{.gb, .gbc} & \\
145 Search & \fname{.m3u, .m3u8} & x \\
146 Sort & \fname{.*} & x \\
147 Text Viewer & \fname{.txt, .*} & \\
148 VBRfix & \fname{.mp3} & x \\
149 \opt{masf}{
150 Wavplay & \fname{.wav} & \\}
151 ZXBox & \fname{.tap, .tax, .sna, .z80} & \\
152\end{rbtabular}
153\end{table}
125 154
126{\input{plugins/shortcuts.tex}} 155{\input{plugins/shortcuts.tex}}
127 156
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 @@
2\subsection{Movie Player} 2\subsection{Movie Player}
3Play movies on your \dap! In order to do this, movies must be in AVI format, 3Play movies on your \dap! In order to do this, movies must be in AVI format,
4and then converted to \fname{.RVF}, Rockbox's own video format. For more 4and then converted to \fname{.RVF}, Rockbox's own video format. For more
5details on how to use this plugin, please see 5details on how to use this plugin, please see \wikilink{VideoTutorial}.
6\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 @@
1% $Id: $id$ % 1% $Id: $id$ %
2\subsection{PNG viewer} 2\subsection{PNG viewer}
3Open a PNG file in the \setting{File Browser} to view it.\\% 3This plugin opens \fname{.png} files from the \setting{File Browser} to
4display them.
4\opt{swcodec}{ 5\opt{swcodec}{
5 \note{When an audio file is playing the size of the image is limited as 6 \note{When an audio file is playing the size of the image is limited as
6 the decoding process needs to share memory with audio tracks. To be able to 7 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 @@
1% $Id$ % 1% $Id$ %
2\subsection{PPM viewer} 2\subsection{PPM viewer}
3Open a PPM file in the \setting{File Browser} to view it. PPM viewer exits 3This plugin opens \fname{.ppm} files from the \setting{File Browser}
4when any button is pressed.\\ 4to display them. Exit the ppm viewer plugin by pressing any button.
5
6\note{Both ASCII PPM (P3) and raw PPM (P6) files are supported.}
5 7
6\note{Both ASCII PPM (P3) and raw PPM (P6) files are supported.
7For more information about PPM files, see 8For more information about PPM files, see
8\url{http://netpbm.sourceforge.net/doc/ppm.html}} 9\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.
6This function is especially useful when the playback of a file skips, 6This function is especially useful when the playback of a file skips,
7fwd/rew does not work correctly or the time display is incorrect. 7fwd/rew does not work correctly or the time display is incorrect.
8To use this plugin, open the \setting{Context Menu} (see \reference{ref:Contextmenu}) 8To use this plugin, open the \setting{Context Menu} (see \reference{ref:Contextmenu})
9upon a \fname{.mp3} file and select \setting{Open With... $\rightarrow$ vbrfix}. 9upon a \fname{.mp3} file and select \setting{Open With\dots $\rightarrow$ vbrfix}.
10 10\par
11\note{VBRfix can only run when music is 11\note{
12 turned off (since it uses the same memory as the player) and can take a 12VBRfix can only run when music is turned off (since it uses
13 while to complete if run on big files.} 13the same memory as the player) and can take a while to complete if
14run on big files.}