diff options
Diffstat (limited to 'manual')
-rw-r--r-- | manual/appendix/file_formats.tex | 2 | ||||
-rw-r--r-- | manual/appendix/wps_tags.tex | 69 | ||||
-rw-r--r-- | manual/preamble.tex | 5 |
3 files changed, 11 insertions, 65 deletions
diff --git a/manual/appendix/file_formats.tex b/manual/appendix/file_formats.tex index a60e7fc08d..bb6a9d6afd 100644 --- a/manual/appendix/file_formats.tex +++ b/manual/appendix/file_formats.tex | |||
@@ -1,7 +1,6 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
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{table} | ||
5 | \begin{rbtabular}{\textwidth}{clp{7em}X}% | 4 | \begin{rbtabular}{\textwidth}{clp{7em}X}% |
6 | {\textbf{Icon} & \textbf{File Type} & \textbf{Extension} | 5 | {\textbf{Icon} & \textbf{File Type} & \textbf{Extension} |
7 | & \textbf{Action when selected}}{}{} | 6 | & \textbf{Action when selected}}{}{} |
@@ -103,7 +102,6 @@ | |||
103 | \includegraphics[width=0.37cm]{appendix/images/icon-wps.png} | 102 | \includegraphics[width=0.37cm]{appendix/images/icon-wps.png} |
104 | & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\\ | 103 | & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\\ |
105 | \end{rbtabular} | 104 | \end{rbtabular} |
106 | \end{table} | ||
107 | 105 | ||
108 | \opt{swcodec}{ | 106 | \opt{swcodec}{ |
109 | \section{\label{ref:Supportedaudioformats}Supported audio formats} | 107 | \section{\label{ref:Supportedaudioformats}Supported audio formats} |
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 93ea018cd2..9974401f7f 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -1,17 +1,14 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \chapter{\label{ref:wps_tags}WPS Tags} | 2 | \chapter{\label{ref:wps_tags}WPS Tags} |
3 | \section{Status Bar} | 3 | \section{Status Bar} |
4 | \begin{table} | ||
5 | \begin{tagmap}{}{} | 4 | \begin{tagmap}{}{} |
6 | \config{\%we} & Display Status Bar\\ | 5 | \config{\%we} & Display Status Bar\\ |
7 | \config{\%wd} & Hide Status Bar\\ | 6 | \config{\%wd} & Hide Status Bar\\ |
8 | \end{tagmap} | 7 | \end{tagmap} |
9 | \end{table} | ||
10 | These tags override the player setting for the display of the status bar. | 8 | These tags override the player setting for the display of the status bar. |
11 | They must be noted on their own line (which will not be shown in the WPS). | 9 | They must be noted on their own line (which will not be shown in the WPS). |
12 | 10 | ||
13 | \section{Information from the track tags} | 11 | \section{Information from the track tags} |
14 | \begin{table} | ||
15 | \begin{tagmap}{}{} | 12 | \begin{tagmap}{}{} |
16 | \config{\%ia} & Artist\\ | 13 | \config{\%ia} & Artist\\ |
17 | \config{\%ic} & Composer\\ | 14 | \config{\%ic} & Composer\\ |
@@ -26,7 +23,6 @@ They must be noted on their own line (which will not be shown in the WPS). | |||
26 | \config{\%iy} & Year\\ | 23 | \config{\%iy} & Year\\ |
27 | \config{\%ik} & Disc Number\\ | 24 | \config{\%ik} & Disc Number\\ |
28 | \end{tagmap} | 25 | \end{tagmap} |
29 | \end{table} | ||
30 | Remember that this information is not always available, so use the | 26 | Remember that this information is not always available, so use the |
31 | conditionals to show alternate information in preference to assuming. | 27 | conditionals to show alternate information in preference to assuming. |
32 | 28 | ||
@@ -35,7 +31,6 @@ show the information for the next song to be played. | |||
35 | 31 | ||
36 | \nopt{lcd_charcell}{ | 32 | \nopt{lcd_charcell}{ |
37 | \section{Viewports} | 33 | \section{Viewports} |
38 | \begin{table} | ||
39 | \begin{tagmap}{}{} | 34 | \begin{tagmap}{}{} |
40 | \nopt{lcd_non-mono}{~% | 35 | \nopt{lcd_non-mono}{~% |
41 | \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}% | 36 | \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}% |
@@ -56,11 +51,9 @@ show the information for the next song to be played. | |||
56 | \config{\%?C{\textless}\%C\%Vda{\textbar}\%Vdb{\textgreater}} | 51 | \config{\%?C{\textless}\%C\%Vda{\textbar}\%Vdb{\textgreater}} |
57 | will show viewport 'a' if album art is found, and 'b' if it isn't.\\ | 52 | will show viewport 'a' if album art is found, and 'b' if it isn't.\\ |
58 | \end{tagmap} | 53 | \end{tagmap} |
59 | \end{table} | ||
60 | } | 54 | } |
61 | 55 | ||
62 | \section{Power Related Information} | 56 | \section{Power Related Information} |
63 | \begin{table} | ||
64 | \begin{tagmap}{}{} | 57 | \begin{tagmap}{}{} |
65 | \config{\%bl} & Numeric battery level in percents\\ | 58 | \config{\%bl} & Numeric battery level in percents\\ |
66 | & Can also be used in a conditional: | 59 | & Can also be used in a conditional: |
@@ -76,10 +69,8 @@ show the information for the next song to be played. | |||
76 | targets that have software charge control or monitoring)\\ | 69 | targets that have software charge control or monitoring)\\ |
77 | \config{\%bs} & Remaining time of the sleep timer (if it is set)\\ | 70 | \config{\%bs} & Remaining time of the sleep timer (if it is set)\\ |
78 | \end{tagmap} | 71 | \end{tagmap} |
79 | \end{table} | ||
80 | 72 | ||
81 | \section{Information about the file} | 73 | \section{Information about the file} |
82 | \begin{table} | ||
83 | \begin{tagmap}{}{} | 74 | \begin{tagmap}{}{} |
84 | \config{\%fb} & File Bitrate (in kbps)\\ | 75 | \config{\%fb} & File Bitrate (in kbps)\\ |
85 | \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % | 76 | \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % |
@@ -105,7 +96,6 @@ show the information for the next song to be played. | |||
105 | \config{\%d2} & Second directory from the end of the file path\\ | 96 | \config{\%d2} & Second directory from the end of the file path\\ |
106 | \config{\%d3} & Third directory from the end of the file path\\ | 97 | \config{\%d3} & Third directory from the end of the file path\\ |
107 | \end{tagmap} | 98 | \end{tagmap} |
108 | \end{table} | ||
109 | Example for the \config{\%dN} commands: If the path is | 99 | Example for the \config{\%dN} commands: If the path is |
110 | ``/Rock/Kent/Isola/11 - 747.mp3'', \config{\%d1} is ``Isola'', | 100 | ``/Rock/Kent/Isola/11 - 747.mp3'', \config{\%d1} is ``Isola'', |
111 | \config{\%d2} is ``Kent'' and \config{\%d3} is ``Rock''. | 101 | \config{\%d2} is ``Kent'' and \config{\%d3} is ``Rock''. |
@@ -114,7 +104,6 @@ These tags, when written with the first letter capitalized (e.g. \config{\%Fn} o | |||
114 | produce the information for the next file to be played. | 104 | produce the information for the next file to be played. |
115 | 105 | ||
116 | \section{Playlist/Song Info} | 106 | \section{Playlist/Song Info} |
117 | \begin{table} | ||
118 | \begin{tagmap}{}{} | 107 | \begin{tagmap}{}{} |
119 | \config{\%pb} & Progress Bar\\ | 108 | \config{\%pb} & Progress Bar\\ |
120 | \opt{player}{ | 109 | \opt{player}{ |
@@ -146,10 +135,8 @@ produce the information for the next file to be played. | |||
146 | & 0 is used for mute, the last option is used for values greater than zero.\\ | 135 | & 0 is used for mute, the last option is used for values greater than zero.\\ |
147 | \config{\%Sp} & Current Playback Pitch\\ | 136 | \config{\%Sp} & Current Playback Pitch\\ |
148 | \end{tagmap} | 137 | \end{tagmap} |
149 | \end{table} | ||
150 | 138 | ||
151 | \section{Runtime Database} | 139 | \section{Runtime Database} |
152 | \begin{table} | ||
153 | \begin{tagmap}{}{} | 140 | \begin{tagmap}{}{} |
154 | \config{\%rp} & Song playcount\\ | 141 | \config{\%rp} & Song playcount\\ |
155 | \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag: % | 142 | \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag: % |
@@ -158,11 +145,9 @@ produce the information for the next file to be played. | |||
158 | 10{\textgreater}}\\ | 145 | 10{\textgreater}}\\ |
159 | \config{\%ra} & Autoscore for the song\\ | 146 | \config{\%ra} & Autoscore for the song\\ |
160 | \end{tagmap} | 147 | \end{tagmap} |
161 | \end{table} | ||
162 | 148 | ||
163 | \opt{swcodec}{ | 149 | \opt{swcodec}{ |
164 | \section{Sound (DSP) settings} | 150 | \section{Sound (DSP) settings} |
165 | \begin{table} | ||
166 | \begin{tagmap}{}{} | 151 | \begin{tagmap}{}{} |
167 | \config{\%Sp} & Current playback pitch \\ | 152 | \config{\%Sp} & Current playback pitch \\ |
168 | \opt{swcodec}{ | 153 | \opt{swcodec}{ |
@@ -174,7 +159,6 @@ produce the information for the next file to be played. | |||
174 | {\textbar}No tag{\textgreater}}\\ | 159 | {\textbar}No tag{\textgreater}}\\ |
175 | } | 160 | } |
176 | \end{tagmap} | 161 | \end{tagmap} |
177 | \end{table} | ||
178 | } | 162 | } |
179 | 163 | ||
180 | % this will not include the "remote hold switch" tag for targets lacking | 164 | % this will not include the "remote hold switch" tag for targets lacking |
@@ -182,57 +166,45 @@ produce the information for the next file to be played. | |||
182 | \opt{hold_button}{ | 166 | \opt{hold_button}{ |
183 | \opt{remote_button_hold}{ | 167 | \opt{remote_button_hold}{ |
184 | \section{Hold Switches} | 168 | \section{Hold Switches} |
185 | \begin{table} | ||
186 | \begin{tagmap}{}{} | 169 | \begin{tagmap}{}{} |
187 | \config{\%mh} & ``h'' if the main unit hold switch is on\\ | 170 | \config{\%mh} & ``h'' if the main unit hold switch is on\\ |
188 | \config{\%mr} & ``r'' if the remote hold switch is on\\ | 171 | \config{\%mr} & ``r'' if the remote hold switch is on\\ |
189 | \end{tagmap} | 172 | \end{tagmap} |
190 | \end{table} | ||
191 | } | 173 | } |
192 | \nopt{remote_button_hold}{ | 174 | \nopt{remote_button_hold}{ |
193 | \section{Hold Switch} | 175 | \section{Hold Switch} |
194 | \begin{table} | ||
195 | \begin{tagmap}{}{} | 176 | \begin{tagmap}{}{} |
196 | \config{\%mh} & ``h'' if the hold switch is on\\ | 177 | \config{\%mh} & ``h'' if the hold switch is on\\ |
197 | \end{tagmap} | 178 | \end{tagmap} |
198 | \end{table} | ||
199 | } | 179 | } |
200 | } | 180 | } |
201 | 181 | ||
202 | \section{Virtual LED} | 182 | \section{Virtual LED} |
203 | \begin{table} | ||
204 | \begin{tagmap}{}{} | 183 | \begin{tagmap}{}{} |
205 | \config{\%lh} & ``h'' if the \disk\ is accessed\\ | 184 | \config{\%lh} & ``h'' if the \disk\ is accessed\\ |
206 | \end{tagmap} | 185 | \end{tagmap} |
207 | \end{table} | ||
208 | 186 | ||
209 | \section{Repeat Mode} | 187 | \section{Repeat Mode} |
210 | \begin{table} | ||
211 | \begin{tagmap}{}{} | 188 | \begin{tagmap}{}{} |
212 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle | 189 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle |
213 | \opt{player,recorder,recorderv2fm}{, A-B}\\ | 190 | \opt{player,recorder,recorderv2fm}{, A-B}\\ |
214 | \end{tagmap} | 191 | \end{tagmap} |
215 | \end{table} | ||
216 | Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% | 192 | Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% |
217 | {\textbar}A-B{\textgreater}} | 193 | {\textbar}A-B{\textgreater}} |
218 | 194 | ||
219 | \section{Playback Mode} | 195 | \section{Playback Mode} |
220 | \begin{table} | ||
221 | \begin{tagmap}{}{} | 196 | \begin{tagmap}{}{} |
222 | \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, | 197 | \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, |
223 | Fast Forward, Rewind\\ | 198 | Fast Forward, Rewind\\ |
224 | \end{tagmap} | 199 | \end{tagmap} |
225 | \end{table} | ||
226 | Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% | 200 | Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% |
227 | Ffwd{\textbar}Rew{\textgreater}} | 201 | Ffwd{\textbar}Rew{\textgreater}} |
228 | 202 | ||
229 | \section{Current Screen} | 203 | \section{Current Screen} |
230 | \begin{table} | ||
231 | \begin{tagmap}{}{} | 204 | \begin{tagmap}{}{} |
232 | \config{\%cs} & The current screen, 1-5, in the order: | 205 | \config{\%cs} & The current screen, 1-5, in the order: |
233 | Menus, WPS, Recording screen, FM Radio screen, Current Playlist screen\\ | 206 | Menus, WPS, Recording screen, FM Radio screen, Current Playlist screen\\ |
234 | \end{tagmap} | 207 | \end{tagmap} |
235 | \end{table} | ||
236 | The tag can also be used as the switch in a conditional tag. For players without | 208 | The tag can also be used as the switch in a conditional tag. For players without |
237 | some capabilities (e.g. having no FM radio) some values will be never yielded. | 209 | some capabilities (e.g. having no FM radio) some values will be never yielded. |
238 | 210 | ||
@@ -240,11 +212,9 @@ Example: \config{You are in the \%?cs{\textless}Main menu{\textbar}WPS{\textbar} | |||
240 | Recording screen{\textbar}FM Radio screen{\textgreater}} | 212 | Recording screen{\textbar}FM Radio screen{\textgreater}} |
241 | 213 | ||
242 | \section{Changing Volume} | 214 | \section{Changing Volume} |
243 | \begin{table} | ||
244 | \begin{tagmap}{}{} | 215 | \begin{tagmap}{}{} |
245 | \config{\%mv[t]} & ``v'' if the volume is being changed\\ | 216 | \config{\%mv[t]} & ``v'' if the volume is being changed\\ |
246 | \end{tagmap} | 217 | \end{tagmap} |
247 | \end{table} | ||
248 | 218 | ||
249 | The tag produces the letter ``v'' while the volume is being changed and some | 219 | The tag produces the letter ``v'' while the volume is being changed and some |
250 | amount of time after that, i.e. after the volume button has been released. The | 220 | amount of time after that, i.e. after the volume button has been released. The |
@@ -262,13 +232,11 @@ being changed and 2.5 secs after the volume button has been released. After | |||
262 | that, it will display the volume value. | 232 | that, it will display the volume value. |
263 | 233 | ||
264 | \section{Settings} | 234 | \section{Settings} |
265 | \begin{table} | ||
266 | \begin{tagmap}{}{} | 235 | \begin{tagmap}{}{} |
267 | \config{\%St{\textbar}<setting name>{\textbar}} & The value of the Rockbox | 236 | \config{\%St{\textbar}<setting name>{\textbar}} & The value of the Rockbox |
268 | setting with the specified name. See \reference{ref:config_file_options} | 237 | setting with the specified name. See \reference{ref:config_file_options} |
269 | for the list of the available settings.\\ | 238 | for the list of the available settings.\\ |
270 | \end{tagmap} | 239 | \end{tagmap} |
271 | \end{table} | ||
272 | 240 | ||
273 | Examples: | 241 | Examples: |
274 | \begin{enumerate} | 242 | \begin{enumerate} |
@@ -279,7 +247,6 @@ Examples: | |||
279 | 247 | ||
280 | \opt{lcd_bitmap}{ | 248 | \opt{lcd_bitmap}{ |
281 | \section{\label{ref:wps_images}Images} | 249 | \section{\label{ref:wps_images}Images} |
282 | \begin{table} | ||
283 | \begin{tagmap}{}{} | 250 | \begin{tagmap}{}{} |
284 | \nopt{archos}{% | 251 | \nopt{archos}{% |
285 | \config{\%X{\textbar}filename.bmp{\textbar}} | 252 | \config{\%X{\textbar}filename.bmp{\textbar}} |
@@ -305,7 +272,6 @@ Examples: | |||
305 | & \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52). | 272 | & \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52). |
306 | By default the first (i.e. top most) sub-image will be used.\\ | 273 | By default the first (i.e. top most) sub-image will be used.\\ |
307 | \end{tagmap} | 274 | \end{tagmap} |
308 | \end{table} | ||
309 | 275 | ||
310 | Examples: | 276 | Examples: |
311 | \begin{enumerate} | 277 | \begin{enumerate} |
@@ -333,7 +299,6 @@ with image ID ``M'', and then reference the individual sub-images in a condition | |||
333 | 299 | ||
334 | \opt{albumart}{ | 300 | \opt{albumart}{ |
335 | \section{Album Art} | 301 | \section{Album Art} |
336 | \begin{table} | ||
337 | \begin{tagmap}{}{} | 302 | \begin{tagmap}{}{} |
338 | \config{\%Cl{\textbar}x{\textbar}y{\textbar}[[l{\textbar}c{\textbar}r]maxwidth]{\textbar}[[t{\textbar}c{\textbar}b]maxheight]{\textbar}} | 303 | \config{\%Cl{\textbar}x{\textbar}y{\textbar}[[l{\textbar}c{\textbar}r]maxwidth]{\textbar}[[t{\textbar}c{\textbar}b]maxheight]{\textbar}} |
339 | & Define the settings for albumart\\ | 304 | & Define the settings for albumart\\ |
@@ -343,7 +308,6 @@ with image ID ``M'', and then reference the individual sub-images in a condition | |||
343 | & \config{maxheight}: Maximum width\\ | 308 | & \config{maxheight}: Maximum width\\ |
344 | \config{\%C} & Display the album art as configured. This tag can also be used as a conditional.\\ | 309 | \config{\%C} & Display the album art as configured. This tag can also be used as a conditional.\\ |
345 | \end{tagmap} | 310 | \end{tagmap} |
346 | \end{table} | ||
347 | 311 | ||
348 | The picture will be rescaled, preserving aspect ratio to fit the given | 312 | The picture will be rescaled, preserving aspect ratio to fit the given |
349 | \config{maxwidth} and \config{maxheight}. If the aspect ratio doesn't match the | 313 | \config{maxwidth} and \config{maxheight}. If the aspect ratio doesn't match the |
@@ -376,7 +340,6 @@ Examples: | |||
376 | } | 340 | } |
377 | 341 | ||
378 | \section{Alignment} | 342 | \section{Alignment} |
379 | \begin{table} | ||
380 | \begin{tagmap}{}{} | 343 | \begin{tagmap}{}{} |
381 | \config{\%al} & Align the text left\\ | 344 | \config{\%al} & Align the text left\\ |
382 | \config{\%aL} & Align the text left, or to the right if RTL language is in use\\ | 345 | \config{\%aL} & Align the text left, or to the right if RTL language is in use\\ |
@@ -384,31 +347,26 @@ Examples: | |||
384 | \config{\%ar} & Align the text right\\ | 347 | \config{\%ar} & Align the text right\\ |
385 | \config{\%aR} & Align the text right, or to the left if RTL language is in use\\ | 348 | \config{\%aR} & Align the text right, or to the left if RTL language is in use\\ |
386 | \end{tagmap} | 349 | \end{tagmap} |
387 | \end{table} | ||
388 | All alignment tags may be present in one line, but they need to be in the | 350 | All alignment tags may be present in one line, but they need to be in the |
389 | order left -- centre -- right. If the aligned texts overlap, they are merged. | 351 | order left -- centre -- right. If the aligned texts overlap, they are merged. |
390 | 352 | ||
391 | \section{Conditional Tags} | 353 | \section{Conditional Tags} |
392 | 354 | ||
393 | \begin{table} | ||
394 | \begin{tagmap}{}{} | 355 | \begin{tagmap}{}{} |
395 | \config{\%?xx{\textless}true{\textbar}false{\textgreater}} | 356 | \config{\%?xx{\textless}true{\textbar}false{\textgreater}} |
396 | & If / Else: Evaluate for true or false case \\ | 357 | & If / Else: Evaluate for true or false case \\ |
397 | \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} | 358 | \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} |
398 | & Enumerations: Evaluate for first / second / third / \dots / last condition \\ | 359 | & Enumerations: Evaluate for first / second / third / \dots / last condition \\ |
399 | \end{tagmap} | 360 | \end{tagmap} |
400 | \end{table} | ||
401 | 361 | ||
402 | \section{Subline Tags} | 362 | \section{Subline Tags} |
403 | 363 | ||
404 | \begin{table} | ||
405 | \begin{tagmap}{}{} | 364 | \begin{tagmap}{}{} |
406 | \config{\%t{\textless}time{\textgreater}} | 365 | \config{\%t{\textless}time{\textgreater}} |
407 | & Set the subline display cycle time (\%t5 or \%t3.4 formats) \\ | 366 | & Set the subline display cycle time (\%t5 or \%t3.4 formats) \\ |
408 | \config{;} | 367 | \config{;} |
409 | & Split items on a line into separate sublines \\ | 368 | & Split items on a line into separate sublines \\ |
410 | \end{tagmap} | 369 | \end{tagmap} |
411 | \end{table} | ||
412 | 370 | ||
413 | Allows grouping of several items (sublines) onto one line, with the | 371 | Allows grouping of several items (sublines) onto one line, with the |
414 | display cycling round the defined sublines. See | 372 | display cycling round the defined sublines. See |
@@ -416,7 +374,6 @@ display cycling round the defined sublines. See | |||
416 | 374 | ||
417 | 375 | ||
418 | \section{Time and Date} | 376 | \section{Time and Date} |
419 | \begin{table} | ||
420 | \begin{tagmap}{}{} | 377 | \begin{tagmap}{}{} |
421 | \opt{rtc}{ | 378 | \opt{rtc}{ |
422 | \config{\%cd} & Day of month from 01 to 31\\ | 379 | \config{\%cd} & Day of month from 01 to 31\\ |
@@ -440,7 +397,6 @@ display cycling round the defined sublines. See | |||
440 | } | 397 | } |
441 | \config{\%cc} & Check for presence of the clock hardware\\ | 398 | \config{\%cc} & Check for presence of the clock hardware\\ |
442 | \end{tagmap} | 399 | \end{tagmap} |
443 | \end{table} | ||
444 | The \%cc tag returns ``c'' if the necessary hardware is present and can also be | 400 | The \%cc tag returns ``c'' if the necessary hardware is present and can also be |
445 | used as a conditional. This can be very useful for designing a WPS that works on | 401 | used as a conditional. This can be very useful for designing a WPS that works on |
446 | multiple targets, some with and some without a clock. By using this tag as a | 402 | multiple targets, some with and some without a clock. By using this tag as a |
@@ -456,14 +412,12 @@ Example: | |||
456 | 412 | ||
457 | \opt{touchscreen}{ | 413 | \opt{touchscreen}{ |
458 | \section{Touchscreen Areas (WPS only)} | 414 | \section{Touchscreen Areas (WPS only)} |
459 | \begin{table} | 415 | \begin{tagmap}{}{} |
460 | \begin{tagmap}{}{} | 416 | \config{\%T{\textbar}x{\textbar}y{\textbar}width{\textbar}height% |
461 | \config{\%T{\textbar}x{\textbar}y{\textbar}width{\textbar}height% | 417 | {\textbar}action{\textbar}} |
462 | {\textbar}action{\textbar}} | 418 | & Invoke the action specified when the user presses in the defined |
463 | & Invoke the action specified when the user presses in the defined | 419 | touchscreen area.\\ |
464 | touchscreen area.\\ | 420 | \end{tagmap} |
465 | \end{tagmap} | ||
466 | \end{table} | ||
467 | If the action starts with \& then the area must be held. Possible actions are: | 421 | If the action starts with \& then the area must be held. Possible actions are: |
468 | 422 | ||
469 | \begin{description} | 423 | \begin{description} |
@@ -488,11 +442,9 @@ Example: | |||
488 | \end{description} | 442 | \end{description} |
489 | 443 | ||
490 | \section{Last Touchscreen Press (WPS only)} | 444 | \section{Last Touchscreen Press (WPS only)} |
491 | \begin{table} | 445 | \begin{tagmap}{}{} |
492 | \begin{tagmap}{}{} | 446 | \config{\%Tl} & Indicates that the touchscreen is pressed.\\ |
493 | \config{\%Tl} & Indicates that the touchscreen is pressed.\\ | 447 | \end{tagmap} |
494 | \end{tagmap} | ||
495 | \end{table} | ||
496 | This tag can be used to display text or images or a viewport when the | 448 | This tag can be used to display text or images or a viewport when the |
497 | touchscreen is pressed (like an On Screen Display). If you put a number | 449 | touchscreen is pressed (like an On Screen Display). If you put a number |
498 | straight after \%Tl it will be used as a timeout in seconds | 450 | straight after \%Tl it will be used as a timeout in seconds |
@@ -503,7 +455,6 @@ Example: | |||
503 | } | 455 | } |
504 | 456 | ||
505 | \section{Other Tags} | 457 | \section{Other Tags} |
506 | \begin{table} | ||
507 | \begin{tagmap}{}{} | 458 | \begin{tagmap}{}{} |
508 | \config{\%\%} & The character `\%'\\ | 459 | \config{\%\%} & The character `\%'\\ |
509 | \config{\%{\textless}} & The character `{\textless}'\\ | 460 | \config{\%{\textless}} & The character `{\textless}'\\ |
@@ -517,4 +468,4 @@ Example: | |||
517 | contain dynamic content such as timers, peak meters | 468 | contain dynamic content such as timers, peak meters |
518 | or progress bars.\\ | 469 | or progress bars.\\ |
519 | \end{tagmap} | 470 | \end{tagmap} |
520 | \end{table} | 471 | |
diff --git a/manual/preamble.tex b/manual/preamble.tex index 1e3ccce95a..7969ca98c2 100644 --- a/manual/preamble.tex +++ b/manual/preamble.tex | |||
@@ -255,16 +255,13 @@ | |||
255 | % usage: \begin{tagmap}{caption}{label} Tag & Description \\ \end{tagmap} | 255 | % usage: \begin{tagmap}{caption}{label} Tag & Description \\ \end{tagmap} |
256 | % Note: this automatically sets the table lines. | 256 | % Note: this automatically sets the table lines. |
257 | % Note: you *need* to terminate the last line with a linebreak \\ | 257 | % Note: you *need* to terminate the last line with a linebreak \\ |
258 | % Note: you still need to enclose this with \begin{table} / \end{table} | ||
259 | % Cheers for the usenet helping me building this up :) | 258 | % Cheers for the usenet helping me building this up :) |
260 | \newenvironment{tagmap}[2]{% | 259 | \newenvironment{tagmap}{% |
261 | \rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor} | 260 | \rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor} |
262 | \expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname | 261 | \expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname |
263 | \expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{% | 262 | \expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{% |
264 | \bottomrule | 263 | \bottomrule |
265 | \SavedEndTab% | 264 | \SavedEndTab% |
266 | \if\given{#1}\caption{#1}\fi% | ||
267 | \if\given{#2}\label{#2}\fi% | ||
268 | \endcenter% | 265 | \endcenter% |
269 | } | 266 | } |
270 | \center | 267 | \center |