Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improvements to the viewers section of the manual (FS#10531 by David Kaufmann)

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22764 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Alexander Levin 2009-09-21 10:43:22 +00:00
parent d9490178ff
commit f744e2651f
7 changed files with 52 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/CREDITS-MANUAL
View file

@ -34,3 +34,4 @@ Will Robertson
Robert Menes
Alex Parker
Dan Davison
David Kaufmann

12
manual/plugins/jpegviewer.tex
View file

@ -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.}%

35
manual/plugins/main.tex
View file

@ -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}}

3
manual/plugins/movieplayer.tex
View file

@ -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}.

3
manual/plugins/pngviewer.tex
View file

@ -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

7
manual/plugins/ppmviewer.tex
View file

@ -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}}

11
manual/plugins/vbrfix.tex
View file

@ -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.}