diff options
| -rw-r--r-- | manual/appendix/appendix.tex | 4 | ||||
| -rw-r--r-- | manual/appendix/wps_tags.tex | 83 | ||||
| -rw-r--r-- | manual/preamble.tex | 1 |
3 files changed, 45 insertions, 43 deletions
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex index be619d0..7c3cd04 100644 --- a/manual/appendix/appendix.tex +++ b/manual/appendix/appendix.tex @@ -2,7 +2,7 @@ \chapter{File formats} \section{\label{ref:Supportedfileformats}Supported file formats} \begin{center} -\begin{tabular}{lll}\toprule +\begin{tabularx}{\textwidth}{llX}\toprule \textbf{Icon} & \textbf{File Type} & \textbf{Action} \\\midrule \includegraphics[width=0.37cm]{appendix/images/icon-directory.png} & Directory & The browser enters that directory \\ \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} & Audio file & Rockbox takes you to the WPS and starts playing the file \\ @@ -18,7 +18,7 @@ \includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} & .ch8 & Play a Chip8 game \\ \includegraphics[width=0.37cm]{appendix/images/icon-image-file.png} & .jpg & View a JPEG image \\ \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} & .rvf & View a movie (Rockbox format)\\\bottomrule -\end{tabular} +\end{tabularx} \end{center} \chapter{\label{ref:wps_tags}WPS Tags} diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index b4ca567..2cc15d4 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex @@ -1,16 +1,16 @@ \subsubsection{Status Bar} -\begin{tabular}{@{}ll@{}}\toprule +\begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%we & Status Bar Enabled\\ \%wd & Status Bar Disabled\\\bottomrule -\end{tabular} +\end{tabularx} \newline \newline These tags override the player setting for the display of the status bar, they must be on their own line. \subsubsection{ID3 Info} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%ia & ID3 Artist\\ \%ic & ID3 Composer\\ @@ -20,14 +20,14 @@ These tags override the player setting for the display of the status bar, they m \%it & ID3 Track Title\\ \%iv & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\ \%iy & ID3 Year\\\bottomrule - \end{tabular} + \end{tabularx} \newline \newline Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming. \subsubsection{Power Related Information} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%bl & Show numeric battery level in percent.\\ & Can also be used in a conditional: \%?bl{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textgreater}\\ @@ -39,18 +39,18 @@ Remember that this information is not always available, so use the conditionals & (only on targets that have software charge control or monitoring)\\ \%bs & Sleep timer. Shows the remaining time if the sleeptimer is set\\ \bottomrule - \end{tabular} + \end{tabularx} \subsubsection{File Info} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%fb & File Bitrate (in kbps)\\ \%fc & File Codec (e.g. "MP3" or "FLAC")\\ & This tag can also be used in a conditional tag,\\ - & \%?fc{\textless}mp1{\textbar}mp2{\textbar}mp3{\textbar}wav{\textbar}vorbis{\textbar}flac{\textbar}mpc{\textbar}a52{\textbar}wavpack{\textbar}unknown{\textgreater}\\ - & The codec order is as follows: MP1, MP2, MP3, WAV, Ogg Vorbis (OGG),\\ - & FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, Shorten (SHN), AIFF\\ + & \%?fc{\textless}mp1{\textbar}mp2{\textbar}mp3{\textbar}wav{\textbar}vorbis{\textbar}flac{\textbar}mpc{\textbar}a52{\textbar}wavpack{\textbar}unknown{\textgreater} % + The codec order is as follows: MP1, MP2, MP3, WAV, Ogg Vorbis (OGG),% + FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, Shorten (SHN), AIFF\\ \%ff & File Frequency (in Hz)\\ \%fm & File Name\\ \%fn & File Name (without extension)\\ @@ -60,23 +60,23 @@ Remember that this information is not always available, so use the conditionals \%d1 & First directory from end of file path.\\ \%d2 & Second directory from end of file path.\\ \%d3 & Third directory from end of file path.\\\bottomrule - \end{tabular} + \end{tabularx} \newline \newline Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3", \%d1 is "Isola", \%d2 is "Kent"... You get the picture. \subsubsection{Playlist/Song Info} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%pb & Progress Bar\\ \opt{player}{ - & This will display a 1 character "cup"\\ - & that empties as the time progresses.} + & This will display a 1 character "cup" % + that empties as the time progresses.} \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodnano}{ & This will replace the entire line with a progress bar. \\ - & You can set the height, position and width of the progressbar\\ - & (in pixels): \%pb{\textbar}height{\textbar}leftpos{\textbar}rightpos{\textbar}} \\ + & You can set the height, position and width of the progressbar % + (in pixels): \%pb{\textbar}height{\textbar}leftpos{\textbar}rightpos{\textbar}} \\ \%pf & Player: Full-line progress bar + time display\\ \%pc & Current Time In Song\\ \%pe & Total Number of Playlist Entries\\ @@ -88,62 +88,62 @@ Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3 \%pt & Total Track Time\\ \%pv & Current volume. Can also be used in a conditional: \\ & \%?pv{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}10{\textgreater}\\\bottomrule - \end{tabular} + \end{tabularx} \subsubsection{Runtime Database} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%rp & Song playcount\\ - \%rr & Song rating (0-10). This tag can also be used in a conditional tag,\\ - & \%?rr{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}10{\textgreater}\\\bottomrule - \end{tabular} + \%rr & Song rating (0-10). This tag can also be used in a conditional tag, % + \%?rr{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}10{\textgreater}\\\bottomrule + \end{tabularx} \opt{h1xx,h300}{ \subsubsection{Hold Switches} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%mh & "h" if the main unit hold switch is on\\ \%mr & "r" if the remote hold switch is on\\\bottomrule - \end{tabular} + \end{tabularx} } \subsubsection{Virtual LED} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%lh & "h" if there is hard disk activity\\\bottomrule - \end{tabular} + \end{tabularx} \subsubsection{Repeat Mode} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule - \%mm & Repeat mode, 0-4, in the order: Off, All, One, Shuffle, \opt{player,recorder,recorderv2fm}{A-B}\\\bottomrule - \end{tabular} + \%mm & Repeat mode, 0-4, in the order: Off, All, One, Shuffle\opt{player,recorder,recorderv2fm}{, A-B}\\\bottomrule + \end{tabularx} \newline \newline Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle{\textbar}A-B{\textgreater} \subsubsection{Playback Mode Tags} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%mp & Play status, 0-4, in the order: Stop, Play, Pause, Fast forward, Rewind\\\bottomrule - \end{tabular} + \end{tabularx} \newline \newline Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater} \subsubsection{Images} - \begin{tabular}{@{}ll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule - \%X{\textbar}filename.bmp{\textbar} & Load and set a backdrop image for the WPS.\\ - & This image must be exactly the same size as your LCD.\\ - \%P{\textbar}filename.bmp{\textbar} & Load a Progress bar image for the WPS.\\ - & Use \%pb tag to show the progress bar\\ + \%X{\textbar}filename.bmp{\textbar} & Load and set a backdrop image for the WPS. % + This image must be exactly the same size as your LCD.\\ + \%P{\textbar}filename.bmp{\textbar} & Load a Progress bar image for the WPS. % + Use \%pb tag to show the progress bar\\ \%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar} & Load and display an image\\ & n = image ID (a-z and A-Z)\\ & filename = filename (relative to /.rockbox/ and including .bmp)\\ @@ -157,7 +157,7 @@ Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textba \%xdn & Display a preloaded image\\ & n = image ID (a-z and A-Z)\\\bottomrule - \end{tabular} + \end{tabularx} \newline \newline Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be:\\ @@ -172,12 +172,12 @@ Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be:\\ \subsubsection{Alignment} - \begin{tabular}{@{}lll@{}}\toprule + \begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%al & Text is left aligned\\ \%ac & Text is center aligned\\ \%ar & Text is right aligned\\\bottomrule - \end{tabular} + \end{tabularx} \newline \newline All alignment tags may be present in one line, but they need to be in the order left - center - right. If the aligned texts overlap, they are merged. @@ -193,7 +193,7 @@ Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\ Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\ \subsection{Other Tags} -\begin{tabular}{@{}ll@{}}\toprule +\begin{tabularx}{\textwidth}{lX}\toprule \textbf{Tag} & \textbf{Description}\\\midrule \%\% & Display a '\%'\\ \%{\textless} & Display a '{\textless}'\\ @@ -203,5 +203,6 @@ Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}e \%s & Indicate that the line should scroll. Can occur anywhere in a line\\ & (given that the text is displayed; see conditionals above). \\ & You can specify up to 10 scrolling lines. Scrolling lines can not \\ - & contain dynamic content such as timers, peak meters or progress bars. -\end{tabular}
\ No newline at end of file + & contain dynamic content such as timers, peak meters or progress bars.\\\bottomrule + +\end{tabularx} diff --git a/manual/preamble.tex b/manual/preamble.tex index 6008eef..3900775 100644 --- a/manual/preamble.tex +++ b/manual/preamble.tex @@ -7,6 +7,7 @@ \usepackage{pdfdraftcopy} \draftstring{DRAFT VERSION} %\draftangle{45} +\usepackage{tabularx} \usepackage{float} |