summaryrefslogtreecommitdiff
path: root/manual/appendix
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-03-29 18:40:42 +0000
committerMartin Arver <martin.arver@gmail.com>2006-03-29 18:40:42 +0000
commitec60a05d1d329d7bd2c9dade6027d9720a42fb20 (patch)
tree1e193ee2f1ff022e95a231363a61e1bb51c07a7f /manual/appendix
parent75c3d0b9f10ea30b827052b7a6f894734e705c4f (diff)
downloadrockbox-ec60a05d1d329d7bd2c9dade6027d9720a42fb20.tar.gz
rockbox-ec60a05d1d329d7bd2c9dade6027d9720a42fb20.zip
Patch #4944 from Dominik Riebeling. Introduce the tabularx package for better looking tables, and replaces the use of tabular with tabularx in the appendix section.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9348 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/appendix')
-rw-r--r--manual/appendix/appendix.tex4
-rw-r--r--manual/appendix/wps_tags.tex83
2 files changed, 44 insertions, 43 deletions
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex
index be619d0fc9..7c3cd04fca 100644
--- a/manual/appendix/appendix.tex
+++ b/manual/appendix/appendix.tex
@@ -2,7 +2,7 @@
2\chapter{File formats} 2\chapter{File formats}
3\section{\label{ref:Supportedfileformats}Supported file formats} 3\section{\label{ref:Supportedfileformats}Supported file formats}
4\begin{center} 4\begin{center}
5\begin{tabular}{lll}\toprule 5\begin{tabularx}{\textwidth}{llX}\toprule
6\textbf{Icon} & \textbf{File Type} & \textbf{Action} \\\midrule 6\textbf{Icon} & \textbf{File Type} & \textbf{Action} \\\midrule
7\includegraphics[width=0.37cm]{appendix/images/icon-directory.png} & Directory & The browser enters that directory \\ 7\includegraphics[width=0.37cm]{appendix/images/icon-directory.png} & Directory & The browser enters that directory \\
8\includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} & Audio file & Rockbox takes you to the WPS and starts playing the file \\ 8\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 @@
18\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} & .ch8 & Play a Chip8 game \\ 18\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} & .ch8 & Play a Chip8 game \\
19\includegraphics[width=0.37cm]{appendix/images/icon-image-file.png} & .jpg & View a JPEG image \\ 19\includegraphics[width=0.37cm]{appendix/images/icon-image-file.png} & .jpg & View a JPEG image \\
20\includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} & .rvf & View a movie (Rockbox format)\\\bottomrule 20\includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} & .rvf & View a movie (Rockbox format)\\\bottomrule
21\end{tabular} 21\end{tabularx}
22\end{center} 22\end{center}
23 23
24\chapter{\label{ref:wps_tags}WPS Tags} 24\chapter{\label{ref:wps_tags}WPS Tags}
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index b4ca567f15..2cc15d4e5e 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -1,16 +1,16 @@
1\subsubsection{Status Bar} 1\subsubsection{Status Bar}
2\begin{tabular}{@{}ll@{}}\toprule 2\begin{tabularx}{\textwidth}{lX}\toprule
3\textbf{Tag} & \textbf{Description}\\\midrule 3\textbf{Tag} & \textbf{Description}\\\midrule
4\%we & Status Bar Enabled\\ 4\%we & Status Bar Enabled\\
5\%wd & Status Bar Disabled\\\bottomrule 5\%wd & Status Bar Disabled\\\bottomrule
6\end{tabular} 6\end{tabularx}
7\newline 7\newline
8\newline 8\newline
9These tags override the player setting for the display of the status bar, they must be on their own line. 9These tags override the player setting for the display of the status bar, they must be on their own line.
10 10
11\subsubsection{ID3 Info} 11\subsubsection{ID3 Info}
12 12
13 \begin{tabular}{@{}ll@{}}\toprule 13 \begin{tabularx}{\textwidth}{lX}\toprule
14 \textbf{Tag} & \textbf{Description}\\\midrule 14 \textbf{Tag} & \textbf{Description}\\\midrule
15 \%ia & ID3 Artist\\ 15 \%ia & ID3 Artist\\
16 \%ic & ID3 Composer\\ 16 \%ic & ID3 Composer\\
@@ -20,14 +20,14 @@ These tags override the player setting for the display of the status bar, they m
20 \%it & ID3 Track Title\\ 20 \%it & ID3 Track Title\\
21 \%iv & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\ 21 \%iv & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\
22 \%iy & ID3 Year\\\bottomrule 22 \%iy & ID3 Year\\\bottomrule
23 \end{tabular} 23 \end{tabularx}
24\newline 24\newline
25\newline 25\newline
26Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming. 26Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming.
27 27
28\subsubsection{Power Related Information} 28\subsubsection{Power Related Information}
29 29
30 \begin{tabular}{@{}ll@{}}\toprule 30 \begin{tabularx}{\textwidth}{lX}\toprule
31 \textbf{Tag} & \textbf{Description}\\\midrule 31 \textbf{Tag} & \textbf{Description}\\\midrule
32 \%bl & Show numeric battery level in percent.\\ 32 \%bl & Show numeric battery level in percent.\\
33 & Can also be used in a conditional: \%?bl{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textgreater}\\ 33 & 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
39 & (only on targets that have software charge control or monitoring)\\ 39 & (only on targets that have software charge control or monitoring)\\
40 \%bs & Sleep timer. Shows the remaining time if the sleeptimer is set\\ 40 \%bs & Sleep timer. Shows the remaining time if the sleeptimer is set\\
41 \bottomrule 41 \bottomrule
42 \end{tabular} 42 \end{tabularx}
43 43
44\subsubsection{File Info} 44\subsubsection{File Info}
45 45
46 \begin{tabular}{@{}ll@{}}\toprule 46 \begin{tabularx}{\textwidth}{lX}\toprule
47 \textbf{Tag} & \textbf{Description}\\\midrule 47 \textbf{Tag} & \textbf{Description}\\\midrule
48 \%fb & File Bitrate (in kbps)\\ 48 \%fb & File Bitrate (in kbps)\\
49 \%fc & File Codec (e.g. "MP3" or "FLAC")\\ 49 \%fc & File Codec (e.g. "MP3" or "FLAC")\\
50 & This tag can also be used in a conditional tag,\\ 50 & This tag can also be used in a conditional tag,\\
51 & \%?fc{\textless}mp1{\textbar}mp2{\textbar}mp3{\textbar}wav{\textbar}vorbis{\textbar}flac{\textbar}mpc{\textbar}a52{\textbar}wavpack{\textbar}unknown{\textgreater}\\ 51 & \%?fc{\textless}mp1{\textbar}mp2{\textbar}mp3{\textbar}wav{\textbar}vorbis{\textbar}flac{\textbar}mpc{\textbar}a52{\textbar}wavpack{\textbar}unknown{\textgreater} %
52 & The codec order is as follows: MP1, MP2, MP3, WAV, Ogg Vorbis (OGG),\\ 52 The codec order is as follows: MP1, MP2, MP3, WAV, Ogg Vorbis (OGG),%
53 & FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, Shorten (SHN), AIFF\\ 53 FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, Shorten (SHN), AIFF\\
54 \%ff & File Frequency (in Hz)\\ 54 \%ff & File Frequency (in Hz)\\
55 \%fm & File Name\\ 55 \%fm & File Name\\
56 \%fn & File Name (without extension)\\ 56 \%fn & File Name (without extension)\\
@@ -60,23 +60,23 @@ Remember that this information is not always available, so use the conditionals
60 \%d1 & First directory from end of file path.\\ 60 \%d1 & First directory from end of file path.\\
61 \%d2 & Second directory from end of file path.\\ 61 \%d2 & Second directory from end of file path.\\
62 \%d3 & Third directory from end of file path.\\\bottomrule 62 \%d3 & Third directory from end of file path.\\\bottomrule
63 \end{tabular} 63 \end{tabularx}
64\newline 64\newline
65\newline 65\newline
66Example 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. 66Example 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.
67 67
68\subsubsection{Playlist/Song Info} 68\subsubsection{Playlist/Song Info}
69 69
70 \begin{tabular}{@{}ll@{}}\toprule 70 \begin{tabularx}{\textwidth}{lX}\toprule
71 \textbf{Tag} & \textbf{Description}\\\midrule 71 \textbf{Tag} & \textbf{Description}\\\midrule
72 \%pb & Progress Bar\\ 72 \%pb & Progress Bar\\
73 \opt{player}{ 73 \opt{player}{
74 & This will display a 1 character "cup"\\ 74 & This will display a 1 character "cup" %
75 & that empties as the time progresses.} 75 that empties as the time progresses.}
76 \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodnano}{ 76 \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodnano}{
77 & This will replace the entire line with a progress bar. \\ 77 & This will replace the entire line with a progress bar. \\
78 & You can set the height, position and width of the progressbar\\ 78 & You can set the height, position and width of the progressbar %
79 & (in pixels): \%pb{\textbar}height{\textbar}leftpos{\textbar}rightpos{\textbar}} \\ 79 (in pixels): \%pb{\textbar}height{\textbar}leftpos{\textbar}rightpos{\textbar}} \\
80 \%pf & Player: Full-line progress bar + time display\\ 80 \%pf & Player: Full-line progress bar + time display\\
81 \%pc & Current Time In Song\\ 81 \%pc & Current Time In Song\\
82 \%pe & Total Number of Playlist Entries\\ 82 \%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
88 \%pt & Total Track Time\\ 88 \%pt & Total Track Time\\
89 \%pv & Current volume. Can also be used in a conditional: \\ 89 \%pv & Current volume. Can also be used in a conditional: \\
90 & \%?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 90 & \%?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
91 \end{tabular} 91 \end{tabularx}
92 92
93\subsubsection{Runtime Database} 93\subsubsection{Runtime Database}
94 94
95 \begin{tabular}{@{}ll@{}}\toprule 95 \begin{tabularx}{\textwidth}{lX}\toprule
96 \textbf{Tag} & \textbf{Description}\\\midrule 96 \textbf{Tag} & \textbf{Description}\\\midrule
97 \%rp & Song playcount\\ 97 \%rp & Song playcount\\
98 \%rr & Song rating (0-10). This tag can also be used in a conditional tag,\\ 98 \%rr & Song rating (0-10). This tag can also be used in a conditional tag, %
99 & \%?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 99 \%?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
100 \end{tabular} 100 \end{tabularx}
101 101
102\opt{h1xx,h300}{ 102\opt{h1xx,h300}{
103\subsubsection{Hold Switches} 103\subsubsection{Hold Switches}
104 104
105 \begin{tabular}{@{}ll@{}}\toprule 105 \begin{tabularx}{\textwidth}{lX}\toprule
106 \textbf{Tag} & \textbf{Description}\\\midrule 106 \textbf{Tag} & \textbf{Description}\\\midrule
107 \%mh & "h" if the main unit hold switch is on\\ 107 \%mh & "h" if the main unit hold switch is on\\
108 \%mr & "r" if the remote hold switch is on\\\bottomrule 108 \%mr & "r" if the remote hold switch is on\\\bottomrule
109 \end{tabular} 109 \end{tabularx}
110} 110}
111 111
112\subsubsection{Virtual LED} 112\subsubsection{Virtual LED}
113 113
114 \begin{tabular}{@{}ll@{}}\toprule 114 \begin{tabularx}{\textwidth}{lX}\toprule
115 \textbf{Tag} & \textbf{Description}\\\midrule 115 \textbf{Tag} & \textbf{Description}\\\midrule
116 \%lh & "h" if there is hard disk activity\\\bottomrule 116 \%lh & "h" if there is hard disk activity\\\bottomrule
117 \end{tabular} 117 \end{tabularx}
118 118
119\subsubsection{Repeat Mode} 119\subsubsection{Repeat Mode}
120 120
121 \begin{tabular}{@{}ll@{}}\toprule 121 \begin{tabularx}{\textwidth}{lX}\toprule
122 \textbf{Tag} & \textbf{Description}\\\midrule 122 \textbf{Tag} & \textbf{Description}\\\midrule
123 \%mm & Repeat mode, 0-4, in the order: Off, All, One, Shuffle, \opt{player,recorder,recorderv2fm}{A-B}\\\bottomrule 123 \%mm & Repeat mode, 0-4, in the order: Off, All, One, Shuffle\opt{player,recorder,recorderv2fm}{, A-B}\\\bottomrule
124 \end{tabular} 124 \end{tabularx}
125\newline 125\newline
126\newline 126\newline
127Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle{\textbar}A-B{\textgreater} 127Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle{\textbar}A-B{\textgreater}
128 128
129\subsubsection{Playback Mode Tags} 129\subsubsection{Playback Mode Tags}
130 130
131 \begin{tabular}{@{}ll@{}}\toprule 131 \begin{tabularx}{\textwidth}{lX}\toprule
132 \textbf{Tag} & \textbf{Description}\\\midrule 132 \textbf{Tag} & \textbf{Description}\\\midrule
133 \%mp & Play status, 0-4, in the order: Stop, Play, Pause, Fast forward, Rewind\\\bottomrule 133 \%mp & Play status, 0-4, in the order: Stop, Play, Pause, Fast forward, Rewind\\\bottomrule
134 \end{tabular} 134 \end{tabularx}
135\newline 135\newline
136\newline 136\newline
137Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater} 137Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}
138 138
139\subsubsection{Images} 139\subsubsection{Images}
140 140
141 \begin{tabular}{@{}ll@{}}\toprule 141 \begin{tabularx}{\textwidth}{lX}\toprule
142 \textbf{Tag} & \textbf{Description}\\\midrule 142 \textbf{Tag} & \textbf{Description}\\\midrule
143 \%X{\textbar}filename.bmp{\textbar} & Load and set a backdrop image for the WPS.\\ 143 \%X{\textbar}filename.bmp{\textbar} & Load and set a backdrop image for the WPS. %
144 & This image must be exactly the same size as your LCD.\\ 144 This image must be exactly the same size as your LCD.\\
145 \%P{\textbar}filename.bmp{\textbar} & Load a Progress bar image for the WPS.\\ 145 \%P{\textbar}filename.bmp{\textbar} & Load a Progress bar image for the WPS. %
146 & Use \%pb tag to show the progress bar\\ 146 Use \%pb tag to show the progress bar\\
147 \%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar} & Load and display an image\\ 147 \%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar} & Load and display an image\\
148 & n = image ID (a-z and A-Z)\\ 148 & n = image ID (a-z and A-Z)\\
149 & filename = filename (relative to /.rockbox/ and including .bmp)\\ 149 & filename = filename (relative to /.rockbox/ and including .bmp)\\
@@ -157,7 +157,7 @@ Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textba
157 \%xdn & Display a preloaded image\\ 157 \%xdn & Display a preloaded image\\
158 158
159 & n = image ID (a-z and A-Z)\\\bottomrule 159 & n = image ID (a-z and A-Z)\\\bottomrule
160 \end{tabular} 160 \end{tabularx}
161\newline 161\newline
162\newline 162\newline
163Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be:\\ 163Example: 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:\\
172 172
173\subsubsection{Alignment} 173\subsubsection{Alignment}
174 174
175 \begin{tabular}{@{}lll@{}}\toprule 175 \begin{tabularx}{\textwidth}{lX}\toprule
176 \textbf{Tag} & \textbf{Description}\\\midrule 176 \textbf{Tag} & \textbf{Description}\\\midrule
177 \%al & Text is left aligned\\ 177 \%al & Text is left aligned\\
178 \%ac & Text is center aligned\\ 178 \%ac & Text is center aligned\\
179 \%ar & Text is right aligned\\\bottomrule 179 \%ar & Text is right aligned\\\bottomrule
180 \end{tabular} 180 \end{tabularx}
181\newline 181\newline
182\newline 182\newline
183All 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. 183All 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}\\
193Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\ 193Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\
194 194
195\subsection{Other Tags} 195\subsection{Other Tags}
196\begin{tabular}{@{}ll@{}}\toprule 196\begin{tabularx}{\textwidth}{lX}\toprule
197\textbf{Tag} & \textbf{Description}\\\midrule 197\textbf{Tag} & \textbf{Description}\\\midrule
198 \%\% & Display a '\%'\\ 198 \%\% & Display a '\%'\\
199 \%{\textless} & Display a '{\textless}'\\ 199 \%{\textless} & Display a '{\textless}'\\
@@ -203,5 +203,6 @@ Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}e
203 \%s & Indicate that the line should scroll. Can occur anywhere in a line\\ 203 \%s & Indicate that the line should scroll. Can occur anywhere in a line\\
204 & (given that the text is displayed; see conditionals above). \\ 204 & (given that the text is displayed; see conditionals above). \\
205 & You can specify up to 10 scrolling lines. Scrolling lines can not \\ 205 & You can specify up to 10 scrolling lines. Scrolling lines can not \\
206 & contain dynamic content such as timers, peak meters or progress bars. 206 & contain dynamic content such as timers, peak meters or progress bars.\\\bottomrule
207\end{tabular} \ No newline at end of file 207
208\end{tabularx}