diff options
-rw-r--r-- | manual/appendix/wps_tags.tex | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index b8e4e25206..802ac146ca 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -1,7 +1,7 @@ | |||
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{tagmap}{}{} | 4 | \begin{tagmap} |
5 | \config{\%we} & Display Status Bar\\ | 5 | \config{\%we} & Display Status Bar\\ |
6 | \config{\%wd} & Hide Status Bar\\ | 6 | \config{\%wd} & Hide Status Bar\\ |
7 | \config{\%wi} & Display the inbuilt Status Bar in the current viewport\\ | 7 | \config{\%wi} & Display the inbuilt Status Bar in the current viewport\\ |
@@ -10,7 +10,7 @@ These tags override the player setting for the display of the status bar. | |||
10 | They must be noted on their own line (which will not be shown in the WPS). | 10 | They must be noted on their own line (which will not be shown in the WPS). |
11 | 11 | ||
12 | \section{Information from the track tags} | 12 | \section{Information from the track tags} |
13 | \begin{tagmap}{}{} | 13 | \begin{tagmap} |
14 | \config{\%ia} & Artist\\ | 14 | \config{\%ia} & Artist\\ |
15 | \config{\%ic} & Composer\\ | 15 | \config{\%ic} & Composer\\ |
16 | \config{\%iA} & Album Artist\\ | 16 | \config{\%iA} & Album Artist\\ |
@@ -32,8 +32,8 @@ show the information for the next song to be played. | |||
32 | 32 | ||
33 | \nopt{lcd_charcell}{ | 33 | \nopt{lcd_charcell}{ |
34 | \section{Viewports} | 34 | \section{Viewports} |
35 | \begin{tagmap}{}{} | 35 | \begin{tagmap} |
36 | \nopt{lcd_non-mono}{~% | 36 | \nopt{lcd_non-mono}{% |
37 | \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}% | 37 | \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}% |
38 | [height]{\textbar}[font]{\textbar}} | 38 | [height]{\textbar}[font]{\textbar}} |
39 | & (see section \ref{ref:Viewports})\\} | 39 | & (see section \ref{ref:Viewports})\\} |
@@ -55,7 +55,7 @@ show the information for the next song to be played. | |||
55 | } | 55 | } |
56 | 56 | ||
57 | \section{Power Related Information} | 57 | \section{Power Related Information} |
58 | \begin{tagmap}{}{} | 58 | \begin{tagmap} |
59 | \config{\%bl} & Numeric battery level in percents\\ | 59 | \config{\%bl} & Numeric battery level in percents\\ |
60 | & Can also be used in a conditional: | 60 | & Can also be used in a conditional: |
61 | \config{\%?bl{\textless}-1{\textbar}0{\textbar}1{\textbar}% | 61 | \config{\%?bl{\textless}-1{\textbar}0{\textbar}1{\textbar}% |
@@ -72,7 +72,7 @@ show the information for the next song to be played. | |||
72 | \end{tagmap} | 72 | \end{tagmap} |
73 | 73 | ||
74 | \section{Information about the file} | 74 | \section{Information about the file} |
75 | \begin{tagmap}{}{} | 75 | \begin{tagmap} |
76 | \config{\%fb} & File Bitrate (in kbps)\\ | 76 | \config{\%fb} & File Bitrate (in kbps)\\ |
77 | \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % | 77 | \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % |
78 | This tag can also be used in a conditional tag, % | 78 | This tag can also be used in a conditional tag, % |
@@ -105,7 +105,7 @@ These tags, when written with the first letter capitalized (e.g. \config{\%Fn} o | |||
105 | produce the information for the next file to be played. | 105 | produce the information for the next file to be played. |
106 | 106 | ||
107 | \section{Playlist/Song Info} | 107 | \section{Playlist/Song Info} |
108 | \begin{tagmap}{}{} | 108 | \begin{tagmap} |
109 | \config{\%pb} & Progress Bar\\ | 109 | \config{\%pb} & Progress Bar\\ |
110 | \opt{player}{ | 110 | \opt{player}{ |
111 | & This will display a one character ``cup'' | 111 | & This will display a one character ``cup'' |
@@ -148,7 +148,7 @@ produce the information for the next file to be played. | |||
148 | \end{tagmap} | 148 | \end{tagmap} |
149 | 149 | ||
150 | \section{Runtime Database} | 150 | \section{Runtime Database} |
151 | \begin{tagmap}{}{} | 151 | \begin{tagmap} |
152 | \config{\%rp} & Song playcount\\ | 152 | \config{\%rp} & Song playcount\\ |
153 | \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag: % | 153 | \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag: % |
154 | \config{\%?rr{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}% | 154 | \config{\%?rr{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}% |
@@ -159,7 +159,7 @@ produce the information for the next file to be played. | |||
159 | 159 | ||
160 | \opt{swcodec}{ | 160 | \opt{swcodec}{ |
161 | \section{Sound (DSP) settings} | 161 | \section{Sound (DSP) settings} |
162 | \begin{tagmap}{}{} | 162 | \begin{tagmap} |
163 | \config{\%Sp} & Current playback pitch \\ | 163 | \config{\%Sp} & Current playback pitch \\ |
164 | \opt{swcodec}{ | 164 | \opt{swcodec}{ |
165 | \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip, | 165 | \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip, |
@@ -177,26 +177,26 @@ produce the information for the next file to be played. | |||
177 | \opt{hold_button}{ | 177 | \opt{hold_button}{ |
178 | \opt{remote_button_hold}{ | 178 | \opt{remote_button_hold}{ |
179 | \section{Hold Switches} | 179 | \section{Hold Switches} |
180 | \begin{tagmap}{}{} | 180 | \begin{tagmap} |
181 | \config{\%mh} & ``h'' if the main unit hold switch is on\\ | 181 | \config{\%mh} & ``h'' if the main unit hold switch is on\\ |
182 | \config{\%mr} & ``r'' if the remote hold switch is on\\ | 182 | \config{\%mr} & ``r'' if the remote hold switch is on\\ |
183 | \end{tagmap} | 183 | \end{tagmap} |
184 | } | 184 | } |
185 | \nopt{remote_button_hold}{ | 185 | \nopt{remote_button_hold}{ |
186 | \section{Hold Switch} | 186 | \section{Hold Switch} |
187 | \begin{tagmap}{}{} | 187 | \begin{tagmap} |
188 | \config{\%mh} & ``h'' if the hold switch is on\\ | 188 | \config{\%mh} & ``h'' if the hold switch is on\\ |
189 | \end{tagmap} | 189 | \end{tagmap} |
190 | } | 190 | } |
191 | } | 191 | } |
192 | 192 | ||
193 | \section{Virtual LED} | 193 | \section{Virtual LED} |
194 | \begin{tagmap}{}{} | 194 | \begin{tagmap} |
195 | \config{\%lh} & ``h'' if the \disk\ is accessed\\ | 195 | \config{\%lh} & ``h'' if the \disk\ is accessed\\ |
196 | \end{tagmap} | 196 | \end{tagmap} |
197 | 197 | ||
198 | \section{Repeat Mode} | 198 | \section{Repeat Mode} |
199 | \begin{tagmap}{}{} | 199 | \begin{tagmap} |
200 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle | 200 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle |
201 | \opt{player,recorder,recorderv2fm}{, A-B}\\ | 201 | \opt{player,recorder,recorderv2fm}{, A-B}\\ |
202 | \end{tagmap} | 202 | \end{tagmap} |
@@ -204,7 +204,7 @@ Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% | |||
204 | {\textbar}A-B{\textgreater}} | 204 | {\textbar}A-B{\textgreater}} |
205 | 205 | ||
206 | \section{Playback Mode} | 206 | \section{Playback Mode} |
207 | \begin{tagmap}{}{} | 207 | \begin{tagmap} |
208 | \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, | 208 | \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, |
209 | Fast Forward, Rewind\\ | 209 | Fast Forward, Rewind\\ |
210 | \end{tagmap} | 210 | \end{tagmap} |
@@ -212,7 +212,7 @@ Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% | |||
212 | Ffwd{\textbar}Rew{\textgreater}} | 212 | Ffwd{\textbar}Rew{\textgreater}} |
213 | 213 | ||
214 | \section{Current Screen} | 214 | \section{Current Screen} |
215 | \begin{tagmap}{}{} | 215 | \begin{tagmap} |
216 | \config{\%cs} & The current screen, 1-5, in the order: | 216 | \config{\%cs} & The current screen, 1-5, in the order: |
217 | Menus, WPS, Recording screen, FM Radio screen, Current Playlist screen\\ | 217 | Menus, WPS, Recording screen, FM Radio screen, Current Playlist screen\\ |
218 | \end{tagmap} | 218 | \end{tagmap} |
@@ -223,7 +223,7 @@ Example: \config{You are in the \%?cs{\textless}Main menu{\textbar}WPS{\textbar} | |||
223 | Recording screen{\textbar}FM Radio screen{\textgreater}} | 223 | Recording screen{\textbar}FM Radio screen{\textgreater}} |
224 | 224 | ||
225 | \section{List Title (\fname{.sbs} only)} | 225 | \section{List Title (\fname{.sbs} only)} |
226 | \begin{tagmap}{}{} | 226 | \begin{tagmap} |
227 | \config{\%Lt} & Title text. Should be used in a conditional so that non-list | 227 | \config{\%Lt} & Title text. Should be used in a conditional so that non-list |
228 | screens don't show a title when they shouldn't\\ | 228 | screens don't show a title when they shouldn't\\ |
229 | \config{\%Li} & Title icon. This uses the same order as custom icons (see | 229 | \config{\%Li} & Title icon. This uses the same order as custom icons (see |
@@ -238,7 +238,7 @@ Recording screen{\textbar}FM Radio screen{\textgreater}} | |||
238 | \config{\%Vi} viewport will not show the title. | 238 | \config{\%Vi} viewport will not show the title. |
239 | 239 | ||
240 | \section{Changing Volume} | 240 | \section{Changing Volume} |
241 | \begin{tagmap}{}{} | 241 | \begin{tagmap} |
242 | \config{\%mv[t]} & ``v'' if the volume is being changed\\ | 242 | \config{\%mv[t]} & ``v'' if the volume is being changed\\ |
243 | \end{tagmap} | 243 | \end{tagmap} |
244 | 244 | ||
@@ -258,7 +258,7 @@ being changed and 2.5 secs after the volume button has been released. After | |||
258 | that, it will display the volume value. | 258 | that, it will display the volume value. |
259 | 259 | ||
260 | \section{Settings} | 260 | \section{Settings} |
261 | \begin{tagmap}{}{} | 261 | \begin{tagmap} |
262 | \config{\%St{\textbar}<setting name>{\textbar}} & The value of the Rockbox | 262 | \config{\%St{\textbar}<setting name>{\textbar}} & The value of the Rockbox |
263 | setting with the specified name. See \reference{ref:config_file_options} | 263 | setting with the specified name. See \reference{ref:config_file_options} |
264 | for the list of the available settings.\\ | 264 | for the list of the available settings.\\ |
@@ -273,7 +273,7 @@ Examples: | |||
273 | 273 | ||
274 | \opt{lcd_bitmap}{ | 274 | \opt{lcd_bitmap}{ |
275 | \section{\label{ref:wps_images}Images} | 275 | \section{\label{ref:wps_images}Images} |
276 | \begin{tagmap}{}{} | 276 | \begin{tagmap} |
277 | \nopt{archos}{% | 277 | \nopt{archos}{% |
278 | \config{\%X{\textbar}filename.bmp{\textbar}} | 278 | \config{\%X{\textbar}filename.bmp{\textbar}} |
279 | & Load and set a backdrop image for the WPS. | 279 | & Load and set a backdrop image for the WPS. |
@@ -325,7 +325,7 @@ with image ID ``M'', and then reference the individual sub-images in a condition | |||
325 | 325 | ||
326 | \opt{albumart}{ | 326 | \opt{albumart}{ |
327 | \section{Album Art} | 327 | \section{Album Art} |
328 | \begin{tagmap}{}{} | 328 | \begin{tagmap} |
329 | \config{\%Cl{\textbar}x{\textbar}y{\textbar}[[l{\textbar}c{\textbar}r]maxwidth]{\textbar}[[t{\textbar}c{\textbar}b]maxheight]{\textbar}} | 329 | \config{\%Cl{\textbar}x{\textbar}y{\textbar}[[l{\textbar}c{\textbar}r]maxwidth]{\textbar}[[t{\textbar}c{\textbar}b]maxheight]{\textbar}} |
330 | & Define the settings for albumart\\ | 330 | & Define the settings for albumart\\ |
331 | & \config{x}: x coordinate\\ | 331 | & \config{x}: x coordinate\\ |
@@ -366,7 +366,7 @@ Examples: | |||
366 | } | 366 | } |
367 | 367 | ||
368 | \section{Alignment} | 368 | \section{Alignment} |
369 | \begin{tagmap}{}{} | 369 | \begin{tagmap} |
370 | \config{\%al} & Align the text left\\ | 370 | \config{\%al} & Align the text left\\ |
371 | \config{\%aL} & Align the text left, or to the right if RTL language is in use\\ | 371 | \config{\%aL} & Align the text left, or to the right if RTL language is in use\\ |
372 | \config{\%ac} & Centre the text\\ | 372 | \config{\%ac} & Centre the text\\ |
@@ -378,7 +378,7 @@ order left -- centre -- right. If the aligned texts overlap, they are merged. | |||
378 | 378 | ||
379 | \section{Conditional Tags} | 379 | \section{Conditional Tags} |
380 | 380 | ||
381 | \begin{tagmap}{}{} | 381 | \begin{tagmap} |
382 | \config{\%?xx{\textless}true{\textbar}false{\textgreater}} | 382 | \config{\%?xx{\textless}true{\textbar}false{\textgreater}} |
383 | & If / Else: Evaluate for true or false case \\ | 383 | & If / Else: Evaluate for true or false case \\ |
384 | \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} | 384 | \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} |
@@ -387,7 +387,7 @@ order left -- centre -- right. If the aligned texts overlap, they are merged. | |||
387 | 387 | ||
388 | \section{Subline Tags} | 388 | \section{Subline Tags} |
389 | 389 | ||
390 | \begin{tagmap}{}{} | 390 | \begin{tagmap} |
391 | \config{\%t{\textless}time{\textgreater}} | 391 | \config{\%t{\textless}time{\textgreater}} |
392 | & Set the subline display cycle time (\%t5 or \%t3.4 formats) \\ | 392 | & Set the subline display cycle time (\%t5 or \%t3.4 formats) \\ |
393 | \config{;} | 393 | \config{;} |
@@ -400,7 +400,7 @@ display cycling round the defined sublines. See | |||
400 | 400 | ||
401 | 401 | ||
402 | \section{Time and Date} | 402 | \section{Time and Date} |
403 | \begin{tagmap}{}{} | 403 | \begin{tagmap} |
404 | \opt{rtc}{ | 404 | \opt{rtc}{ |
405 | \config{\%cd} & Day of month from 01 to 31\\ | 405 | \config{\%cd} & Day of month from 01 to 31\\ |
406 | \config{\%ce} & Zero padded day of month from 1 to 31\\ | 406 | \config{\%ce} & Zero padded day of month from 1 to 31\\ |
@@ -437,7 +437,7 @@ Example: | |||
437 | \config{\%?cc{\textless}\%cH:\%cM{\textbar}No clock detected{\textgreater}} | 437 | \config{\%?cc{\textless}\%cH:\%cM{\textbar}No clock detected{\textgreater}} |
438 | 438 | ||
439 | \section{Text Translation} | 439 | \section{Text Translation} |
440 | \begin{tagmap}{}{} | 440 | \begin{tagmap} |
441 | \config{\%Sx{\textbar}{\textless}English{\textgreater}{\textbar}} | 441 | \config{\%Sx{\textbar}{\textless}English{\textgreater}{\textbar}} |
442 | & Display the translation of ``English'' in the current language\\ | 442 | & Display the translation of ``English'' in the current language\\ |
443 | \end{tagmap} | 443 | \end{tagmap} |
@@ -453,7 +453,7 @@ Example: | |||
453 | 453 | ||
454 | \opt{touchscreen}{ | 454 | \opt{touchscreen}{ |
455 | \section{Touchscreen Areas (WPS only)} | 455 | \section{Touchscreen Areas (WPS only)} |
456 | \begin{tagmap}{}{} | 456 | \begin{tagmap} |
457 | \config{\%T{\textbar}x{\textbar}y{\textbar}width{\textbar}height% | 457 | \config{\%T{\textbar}x{\textbar}y{\textbar}width{\textbar}height% |
458 | {\textbar}action{\textbar}} | 458 | {\textbar}action{\textbar}} |
459 | & Invoke the action specified when the user presses in the defined | 459 | & Invoke the action specified when the user presses in the defined |
@@ -483,7 +483,7 @@ Example: | |||
483 | \end{description} | 483 | \end{description} |
484 | 484 | ||
485 | \section{Last Touchscreen Press (WPS only)} | 485 | \section{Last Touchscreen Press (WPS only)} |
486 | \begin{tagmap}{}{} | 486 | \begin{tagmap} |
487 | \config{\%Tl} & Indicates that the touchscreen is pressed.\\ | 487 | \config{\%Tl} & Indicates that the touchscreen is pressed.\\ |
488 | \end{tagmap} | 488 | \end{tagmap} |
489 | This tag can be used to display text or images or a viewport when the | 489 | This tag can be used to display text or images or a viewport when the |
@@ -496,7 +496,7 @@ Example: | |||
496 | } | 496 | } |
497 | 497 | ||
498 | \section{Other Tags} | 498 | \section{Other Tags} |
499 | \begin{tagmap}{}{} | 499 | \begin{tagmap} |
500 | \config{\%\%} & The character `\%'\\ | 500 | \config{\%\%} & The character `\%'\\ |
501 | \config{\%{\textless}} & The character `{\textless}'\\ | 501 | \config{\%{\textless}} & The character `{\textless}'\\ |
502 | \config{\%{\textbar}} & The character `{\textbar}'\\ | 502 | \config{\%{\textbar}} & The character `{\textbar}'\\ |