summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Levin <al.le@rockbox.org>2010-07-02 19:55:47 +0000
committerAlexander Levin <al.le@rockbox.org>2010-07-02 19:55:47 +0000
commit15d0ac01345346ae348bb15c58ddf88ef0ac0020 (patch)
tree8ea08068104b727f96eadbff447b54c0fbad0e3f
parent12427106d2710e3452002676c02153562bb01cc2 (diff)
downloadrockbox-15d0ac01345346ae348bb15c58ddf88ef0ac0020.tar.gz
rockbox-15d0ac01345346ae348bb15c58ddf88ef0ac0020.zip
No need to use textless, textgreater and textbar where <, > and | can be used
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27249 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/appendix/wps_tags.tex82
1 files changed, 37 insertions, 45 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index f840d9eff5..9fd5e42e20 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -53,7 +53,7 @@ show the information for the next song to be played.
53 & See section \ref{ref:Viewports}\\} 53 & See section \ref{ref:Viewports}\\}
54 54
55 \config{\%Vd('identifier')} & Display the `identifier' viewport. E.g. 55 \config{\%Vd('identifier')} & Display the `identifier' viewport. E.g.
56 \config{\%?C{\textless}\%Vd(a){\textbar}\%Vd(b){\textgreater}} 56 \config{\%?C<\%Vd(a)|\%Vd(b)>}
57 will show viewport `a' if album art is found, and `b' if it isn't.\\ 57 will show viewport `a' if album art is found, and `b' if it isn't.\\
58 58
59 \config{\%Vi('label',\dots)} & 59 \config{\%Vi('label',\dots)} &
@@ -75,8 +75,7 @@ show the information for the next song to be played.
75 \begin{tagmap} 75 \begin{tagmap}
76 \config{\%bl} & Numeric battery level in percents. 76 \config{\%bl} & Numeric battery level in percents.
77 Can also be used in a conditional: 77 Can also be used in a conditional:
78 \config{\%?bl{\textless}-1{\textbar}0{\textbar}1{\textbar}% 78 \config{\%?bl<-1|0|1|2|\ldots|N>},
79 2{\textbar}\ldots{\textbar}N{\textgreater}},
80 where the value $-1$ is used when the battery level isn't 79 where the value $-1$ is used when the battery level isn't
81 known (it usually is). 80 known (it usually is).
82 An image can also be used, the proportion of the image 81 An image can also be used, the proportion of the image
@@ -94,15 +93,11 @@ show the information for the next song to be played.
94\section{Information about the file} 93\section{Information about the file}
95 \begin{tagmap} 94 \begin{tagmap}
96 \config{\%fb} & File Bitrate (in kbps)\\ 95 \config{\%fb} & File Bitrate (in kbps)\\
97 \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % 96 \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC'').
98 This tag can also be used in a conditional tag, % 97 This tag can also be used in a conditional tag:
99 \config{\%?fc{\textless}mp1\-{\textbar}mp2\-{\textbar}mp3\-% 98 \config{\%?fc<mp1|mp2|mp3|aiff|wav|ogg|\newline
100 {\textbar}aiff\-{\textbar}wav\-{\textbar}ogg\-{\textbar}flac\-% 99 flac|mpc|a52|wavpack|alac|aac|shn|sid|adx|nsf|\newline
101 {\textbar}mpc\-{\textbar}a52\-{\textbar}wavpack\-{\textbar}alac\-% 100 speex|spc|ape|wma|mod|sap|unknown>}.
102 {\textbar}aac\-{\textbar}shn\-{\textbar}sid\-{\textbar}adx\-%
103 {\textbar}nsf\-{\textbar}speex\-{\textbar}spc\-{\textbar}ape\-%
104 {\textbar}wma\-{\textbar}mod\-{\textbar}sap%
105 {\textbar}unknown{\textgreater}}.
106 The codec order is as follows: MP1, MP2, MP3, AIFF, WAV, 101 The codec order is as follows: MP1, MP2, MP3, AIFF, WAV,
107 Ogg Vorbis (OGG), FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, 102 Ogg Vorbis (OGG), FLAC, MPC, AC3, WavPack (WV), ALAC, AAC,
108 Shorten (SHN), SID, ADX, NSF, Speex, SPC, APE, WMA, MOD, SAP.\\ 103 Shorten (SHN), SID, ADX, NSF, Speex, SPC, APE, WMA, MOD, SAP.\\
@@ -150,21 +145,20 @@ or \config{\%D(2)}), produce the information for the next file to be played.
150 \config{\%ps} & ``s'' if shuffle mode is enabled\\ 145 \config{\%ps} & ``s'' if shuffle mode is enabled\\
151 \config{\%pt} & Total track time\\ 146 \config{\%pt} & Total track time\\
152 \config{\%pv} & Current volume (in dB). Can also be used in a conditional: 147 \config{\%pv} & Current volume (in dB). Can also be used in a conditional:
153 \config{\%?pv{\textless}0{\textbar}1{\textbar}2{\textbar}\ldots% 148 \config{\%?pv<0|1|2|\ldots|N>}\newline
154 {\textbar}N{\textgreater}}\newline
155 0 is used for mute, the last option is used for values greater than zero. 149 0 is used for mute, the last option is used for values greater than zero.
156 \opt{lcd_bitmap}{This can also be used like \%pb to provide a continuous scale: 150 \opt{lcd_bitmap}{This can also be used like \%pb to provide a continuous scale:
157 \config{\%pv(x,y,[width],[height],image.bmp)}} \\ 151 \config{\%pv(x,y,[width],[height],image.bmp)}} \\
158 \config{\%pS} & Track is starting. An optional number gives how many seconds 152 \config{\%pS} & Track is starting. An optional number gives how many seconds
159 the tag remains true for after the start of the track. The default is 153 the tag remains true for after the start of the track. The default is
160 10 seconds if no number is specified. 154 10 seconds if no number is specified.
161 \config{\%pS(7){\textless}in the first 7 seconds of track{\textbar}in 155 \config{\%pS(7)<in the first 7 seconds of track|in
162 the rest of the track{\textgreater}}\\ 156 the rest of the track>}\\
163 \config{\%pE} & Track is ending. An optional number gives how many seconds 157 \config{\%pE} & Track is ending. An optional number gives how many seconds
164 before the end of the track the tag becomes true. The default is 158 before the end of the track the tag becomes true. The default is
165 10 seconds if no number is specified. 159 10 seconds if no number is specified.
166 \config{\%pE(7){\textless}in the last 7 seconds of track{\textbar}in 160 \config{\%pE(7)<in the last 7 seconds of track|in
167 the rest of the track{\textgreater}}\\ 161 the rest of the track>}\\
168 \config{\%Sp} & Current playback pitch\\ 162 \config{\%Sp} & Current playback pitch\\
169 \end{tagmap} 163 \end{tagmap}
170 164
@@ -172,9 +166,7 @@ or \config{\%D(2)}), produce the information for the next file to be played.
172 \begin{tagmap} 166 \begin{tagmap}
173 \config{\%rp} & Song playcount\\ 167 \config{\%rp} & Song playcount\\
174 \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag: % 168 \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag: %
175 \config{\%?rr{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}% 169 \config{\%?rr<0|1|2|3|4|5|6|7|8|9|10>}\\
176 4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}%
177 10{\textgreater}}\\
178 \config{\%ra} & Autoscore for the song\\ 170 \config{\%ra} & Autoscore for the song\\
179 \end{tagmap} 171 \end{tagmap}
180 172
@@ -186,9 +178,9 @@ or \config{\%D(2)}), produce the information for the next file to be played.
186 \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip, 178 \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip,
187 Shuffle, Shuffle and Man Skip, Always\\ 179 Shuffle, Shuffle and Man Skip, Always\\
188 \config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional, 180 \config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional,
189 Replaygain type in use: \config{\%?rg{\textless}Off{\textbar}Track% 181 Replaygain type in use: \config{\%?rg<Off|Track%
190 {\textbar}Album{\textbar}TrackShuffle{\textbar}AlbumShuffle% 182 |Album|TrackShuffle|AlbumShuffle%
191 {\textbar}No tag{\textgreater}}\\ 183 |No tag>}\\
192 } 184 }
193 \end{tagmap} 185 \end{tagmap}
194} 186}
@@ -210,8 +202,8 @@ or \config{\%D(2)}), produce the information for the next file to be played.
210 \begin{tagmap} 202 \begin{tagmap}
211 \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle, A-B\\ 203 \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle, A-B\\
212 \end{tagmap} 204 \end{tagmap}
213Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% 205Example: \config{\%?mm<Off|All|One|Shuffle%
214{\textbar}A-B{\textgreater}} 206|A-B>}
215 207
216\section{Playback Mode} 208\section{Playback Mode}
217 \begin{tagmap} 209 \begin{tagmap}
@@ -219,9 +211,9 @@ Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle%
219 Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, 211 Fast Forward, Rewind, Recording, Recording paused, FM Radio playing,
220 FM Radio muted\\ 212 FM Radio muted\\
221 \end{tagmap} 213 \end{tagmap}
222Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% 214Example: \config{\%?mp<Stop|Play|Pause|%
223Ffwd{\textbar}Rew{\textbar}Rec{\textbar}Rec pause{\textbar}FM{\textbar}% 215Ffwd|Rew|Rec|Rec pause|FM|%
224FM pause{\textgreater}} 216FM pause>}
225 217
226\section{Current Screen} 218\section{Current Screen}
227 \begin{tagmap} 219 \begin{tagmap}
@@ -231,8 +223,8 @@ FM pause{\textgreater}}
231The tag can also be used as the switch in a conditional tag. For players without 223The tag can also be used as the switch in a conditional tag. For players without
232some capabilities (e.g. having no FM radio) some values will be never yielded. 224some capabilities (e.g. having no FM radio) some values will be never yielded.
233 225
234Example: \config{You are in the \%?cs{\textless}Main menu{\textbar}WPS{\textbar}% 226Example: \config{You are in the \%?cs<Main menu|WPS|%
235Recording screen{\textbar}FM Radio screen{\textgreater}} 227Recording screen|FM Radio screen>}
236 228
237\section{List Title (\fname{.sbs} only)} 229\section{List Title (\fname{.sbs} only)}
238 \begin{tagmap} 230 \begin{tagmap}
@@ -245,7 +237,7 @@ Recording screen{\textbar}FM Radio screen{\textgreater}}
245 237
246 This tag can be used to give custom formatting to list titles. 238 This tag can be used to give custom formatting to list titles.
247 Define a viewport with the font and formatting desired, and then use 239 Define a viewport with the font and formatting desired, and then use
248 \config{\%?Lt{\textless}\%Lt{\textgreater}} to display the title within the 240 \config{\%?Lt<\%Lt>} to display the title within the
249 viewport. If \config{\%Lt} is present anywhere in the \fname{.sbs}, then the 241 viewport. If \config{\%Lt} is present anywhere in the \fname{.sbs}, then the
250 \config{\%Vi} viewport will not show the title. 242 \config{\%Vi} viewport will not show the title.
251 243
@@ -263,7 +255,7 @@ The tag can be used as the switch in a conditional tag to display different thin
263depending on whether the volume is being changed. It can produce neat effects 255depending on whether the volume is being changed. It can produce neat effects
264when used with conditional viewports. 256when used with conditional viewports.
265 257
266Example: \config{\%?mv(2.5){\textless}Volume changing{\textbar}\%pv{\textgreater}} 258Example: \config{\%?mv(2.5)<Volume changing|\%pv>}
267 259
268The example above will display the text ``Volume changing'' if the volume is 260The example above will display the text ``Volume changing'' if the volume is
269being changed and 2.5 seconds after the volume button has been released. After 261being changed and 2.5 seconds after the volume button has been released. After
@@ -279,7 +271,7 @@ that, it will display the volume value.
279Examples: 271Examples:
280\begin{enumerate} 272\begin{enumerate}
281\item As a simple tag: \config{\%St(skip length)} 273\item As a simple tag: \config{\%St(skip length)}
282\item As a conditional: \config{\%?St(eq enabled){\textless}Eq is enabled{\textbar}Eq is disabled{\textgreater}} 274\item As a conditional: \config{\%?St(eq enabled)<Eq is enabled|Eq is disabled>}
283\end{enumerate} 275\end{enumerate}
284 276
285 277
@@ -318,8 +310,8 @@ Examples:
318\item Load a bitmap strip containing 5 volume icon images (all the same size) 310\item Load a bitmap strip containing 5 volume icon images (all the same size)
319with image ID ``M'', and then reference the individual sub-images in a conditional:\\ 311with image ID ``M'', and then reference the individual sub-images in a conditional:\\
320\config{\%xl(M,volume.bmp,134,153,5)}\\ 312\config{\%xl(M,volume.bmp,134,153,5)}\\
321\config{\%?pv<\%xd(Ma){\textbar}\%xd(Mb){\textbar}\%xd(Mc){\textbar}% 313\config{\%?pv<\%xd(Ma)|\%xd(Mb)|\%xd(Mc)|%
322\%xd(Md){\textbar}\%xd(Me)>} 314\%xd(Md)|\%xd(Me)>}
323\end{enumerate} 315\end{enumerate}
324 316
325 317
@@ -371,8 +363,8 @@ that order):
371\end{enumerate} 363\end{enumerate}
372 364
373The following characters will be replaced with an underscore (\_) when looking 365The following characters will be replaced with an underscore (\_) when looking
374for albumtitle.bmp or albumartist-albumtitle.bmp: \textbackslash{} / : \textless{} 366for albumtitle.bmp or albumartist-albumtitle.bmp: \textbackslash{} / : <
375\textgreater{} ? * \textbar{}. Doublequotes will be replaced by single quotes. 367> ? * |. Doublequotes will be replaced by single quotes.
376If no album artist is set, artist will be used instead. See \wikilink{AlbumArt} 368If no album artist is set, artist will be used instead. See \wikilink{AlbumArt}
377in the wiki for programs that will help you automate the process of putting 369in the wiki for programs that will help you automate the process of putting
378album art on your \dap{}. 370album art on your \dap{}.
@@ -457,9 +449,9 @@ order left -- centre -- right. If the aligned texts overlap, they are merged.
457\section{Conditional Tags} 449\section{Conditional Tags}
458 450
459\begin{tagmap} 451\begin{tagmap}
460\config{\%?xx{\textless}true{\textbar}false{\textgreater}} 452\config{\%?xx<true|false>}
461 & If / Else: Evaluate for true or false case \\ 453 & If / Else: Evaluate for true or false case \\
462\config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}\tabnlindent{}alt3{\textbar}\dots{\textbar}else{\textgreater}} 454\config{\%?xx<alt1|alt2|\tabnlindent{}alt3|\dots|else>}
463 & Enumerations: Evaluate for first / second / third / \dots / last condition \\ 455 & Enumerations: Evaluate for first / second / third / \dots / last condition \\
464\end{tagmap} 456\end{tagmap}
465 457
@@ -513,7 +505,7 @@ or alternate information on those that do not
513. 505.
514 506
515Example: 507Example:
516\config{\%?cc{\textless}\%cH:\%cM{\textbar}No clock detected{\textgreater}} 508\config{\%?cc<\%cH:\%cM|No clock detected>}
517 509
518\section{Text Translation} 510\section{Text Translation}
519 \begin{tagmap} 511 \begin{tagmap}
@@ -579,11 +571,11 @@ Example:
579 \config{\%)} & The character `)'\\ 571 \config{\%)} & The character `)'\\
580 \config{\%,} & The character `,'\\ 572 \config{\%,} & The character `,'\\
581 \config{\%\%} & The character `\%'\\ 573 \config{\%\%} & The character `\%'\\
582 \config{\%{\textless}} & The character `{\textless}'\\ 574 \config{\%<} & The character `<'\\
583 \config{\%{\textbar}} & The character `{\textbar}'\\ 575 \config{\%|} & The character `|'\\
584 \config{\%{\textgreater}} & The character `{\textgreater}'\\ 576 \config{\%>} & The character `>'\\
585 \config{\%;} & The character `;'\\ 577 \config{\%;} & The character `;'\\
586 \config{\#} & The character `\#'\\ 578 \config{\#} & The character `\#'\\
587 \config{\%s} & Indicate that the line should scroll. Can occur 579 \config{\%s} & Indicate that the line should scroll. Can occur
588 anywhere in a line (given that the text is 580 anywhere in a line (given that the text is
589 displayed; see conditionals above). You can specify 581 displayed; see conditionals above). You can specify