summaryrefslogtreecommitdiff
path: root/manual/appendix/wps_tags.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/appendix/wps_tags.tex')
-rw-r--r--manual/appendix/wps_tags.tex58
1 files changed, 24 insertions, 34 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index f1f79b9351..1aec7bae99 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -47,7 +47,7 @@ Example:
47 \config{\%iy} & Year\\ 47 \config{\%iy} & Year\\
48 \config{\%ik} & Disc Number\\ 48 \config{\%ik} & Disc Number\\
49 \end{tagmap} 49 \end{tagmap}
50Remember that this information is not always available, so use the 50Remember that this information is not always available, so use the
51conditionals to show alternate information in preference to assuming. 51conditionals to show alternate information in preference to assuming.
52 52
53These tags, when written with a capital ``I'' (e.g. \config{\%Ia} or \config{\%Ic}), 53These tags, when written with a capital ``I'' (e.g. \config{\%Ia} or \config{\%Ic}),
@@ -112,7 +112,7 @@ show the information for the next song to be played.
112\section{Power Related Information} 112\section{Power Related Information}
113 \begin{tagmap} 113 \begin{tagmap}
114 \config{\%bl} & Numeric battery level in percents. 114 \config{\%bl} & Numeric battery level in percents.
115 Can also be used in a conditional: 115 Can also be used in a conditional:
116 \config{\%?bl<-1|0|1|2|\ldots|N>}, 116 \config{\%?bl<-1|0|1|2|\ldots|N>},
117 where the value $-1$ is used when the battery level isn't 117 where the value $-1$ is used when the battery level isn't
118 known (it usually is). The value $N$ is only used when the 118 known (it usually is). The value $N$ is only used when the
@@ -153,7 +153,7 @@ show the information for the next song to be played.
153 (N can be 1, 2, 3, \dots)\\ 153 (N can be 1, 2, 3, \dots)\\
154 \end{tagmap} 154 \end{tagmap}
155Example for the \config{\%d(N)} commands: If the file is 155Example for the \config{\%d(N)} commands: If the file is
156``\fname{/Rock/Kent/Isola/11 - 747.mp3}'', \config{\%d(1)} is ``\fname{Isola}'', 156``\fname{/Rock/Kent/Isola/11 - 747.mp3}'', \config{\%d(1)} is ``\fname{Isola}'',
157\config{\%d(2)} is ``\fname{Kent}'' and \config{\%d(3)} is ``\fname{Rock}''. 157\config{\%d(2)} is ``\fname{Kent}'' and \config{\%d(3)} is ``\fname{Rock}''.
158 158
159These tags, when written with the first letter capitalized (e.g. \config{\%Fn} 159These tags, when written with the first letter capitalized (e.g. \config{\%Fn}
@@ -162,28 +162,20 @@ or \config{\%D(2)}), produce the information for the next file to be played.
162\section{Playlist/Song Info} 162\section{Playlist/Song Info}
163 \begin{tagmap} 163 \begin{tagmap}
164 \config{\%pb} & Progress Bar. 164 \config{\%pb} & Progress Bar.
165 \opt{player}{
166 This will display a one character ``cup''
167 that empties as the time progresses.}
168 \opt{lcd_bitmap}{ 165 \opt{lcd_bitmap}{
169 This will replace the entire line with a progress bar. 166 This will replace the entire line with a progress bar.
170 You can set the position, width and height of the progressbar 167 You can set the position, width and height of the progressbar
171 (in pixels) and load a custom image for it: 168 (in pixels) and load a custom image for it:
172 \config{\%pb(x,y,[width],[height],image.bmp)}} \\ 169 \config{\%pb(x,y,[width],[height],image.bmp)}} \\
173 \opt{player}{%
174 \config{\%pf} & Full-line progress bar \& time display\\
175 }%
176 \config{\%px} & Percentage played in song\\ 170 \config{\%px} & Percentage played in song\\
177 \config{\%pc} & Current time in song\\ 171 \config{\%pc} & Current time in song\\
178 \config{\%pe} & Total number of playlist entries\\ 172 \config{\%pe} & Total number of playlist entries\\
179 \nopt{player}{%
180 \config{\%pm} & Peak Meter. The entire line is used as % 173 \config{\%pm} & Peak Meter. The entire line is used as %
181 volume peak meter.\\% 174 volume peak meter.\\%
182 \config{\%pL} & Peak meter for the left channel. Can be used as a value, % 175 \config{\%pL} & Peak meter for the left channel. Can be used as a value, %
183 a conditional tag or a bar tag.\\ 176 a conditional tag or a bar tag.\\
184 \config{\%pR} & Peak meter for the right channel. Can be used as a value, % 177 \config{\%pR} & Peak meter for the right channel. Can be used as a value, %
185 a conditional tag or a bar tag.\\ 178 a conditional tag or a bar tag.\\
186 }%
187 \config{\%pn} & Playlist name (without path or extension)\\ 179 \config{\%pn} & Playlist name (without path or extension)\\
188 \config{\%pp} & Playlist position\\ 180 \config{\%pp} & Playlist position\\
189 \config{\%pr} & Remaining time in song\\ 181 \config{\%pr} & Remaining time in song\\
@@ -206,7 +198,7 @@ or \config{\%D(2)}), produce the information for the next file to be played.
206 the rest of the track>}\\ 198 the rest of the track>}\\
207 \config{\%Sp} & Current playback pitch\\ 199 \config{\%Sp} & Current playback pitch\\
208 \end{tagmap} 200 \end{tagmap}
209 201
210\section{Playlist Viewer} 202\section{Playlist Viewer}
211 \begin{tagmap} 203 \begin{tagmap}
212 \config{\%Vp(start,code to render)} & Display the playlist viewer in 204 \config{\%Vp(start,code to render)} & Display the playlist viewer in
@@ -274,7 +266,7 @@ Example: \config{\%?mm<Off|All|One|Shuffle|A-B>}
274 266
275\section{Playback Mode} 267\section{Playback Mode}
276 \begin{tagmap} 268 \begin{tagmap}
277 \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, 269 \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause,
278 Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, 270 Fast Forward, Rewind, Recording, Recording paused, FM Radio playing,
279 FM Radio muted\\ 271 FM Radio muted\\
280 \end{tagmap} 272 \end{tagmap}
@@ -303,7 +295,7 @@ Example: \config{\%?mp<Stop|Play|Pause|Ffwd|Rew|Rec|Rec pause|FM|FM pause>}
303 13 & Playlist Catalogue Viewer \\ 295 13 & Playlist Catalogue Viewer \\
304 14 & Plugin \\ 296 14 & Plugin \\
305 15 & Context menu \\ 297 15 & Context menu \\
306 16 & System Info screen \\ 298 16 & System Info screen \\
307 17 & Time and Date Screen \\ 299 17 & Time and Date Screen \\
308 18 & Bookmark browser \\ 300 18 & Bookmark browser \\
309 19 & Shortcuts menu \\ 301 19 & Shortcuts menu \\
@@ -374,7 +366,6 @@ Examples:
374\opt{lcd_bitmap}{ 366\opt{lcd_bitmap}{
375\section{\label{ref:wps_images}Images} 367\section{\label{ref:wps_images}Images}
376 \begin{tagmap} 368 \begin{tagmap}
377 \nopt{archos}{%
378 \config{\%X(filename.bmp)} 369 \config{\%X(filename.bmp)}
379 & Load and set a backdrop image for the WPS. 370 & Load and set a backdrop image for the WPS.
380 This image must be exactly the same size as your LCD.\\ 371 This image must be exactly the same size as your LCD.\\
@@ -396,12 +387,12 @@ Examples:
396 contained in the bitmap. Default is 1.\\ 387 contained in the bitmap. Default is 1.\\
397 \config{\%xd(n[i] [,tag] [,offset])} & Display a preloaded image. 388 \config{\%xd(n[i] [,tag] [,offset])} & Display a preloaded image.
398 \config{n}: image ID as it was specified in \config{\%x} or \config{\%xl}\newline 389 \config{n}: image ID as it was specified in \config{\%x} or \config{\%xl}\newline
399 \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52). 390 \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52).
400 (ignored when \config{tag} is used). Only useable if the ID is a single letter. 391 (ignored when \config{tag} is used). Only useable if the ID is a single letter.
401 By default the first (i.e. top most) sub-image will be used.\newline 392 By default the first (i.e. top most) sub-image will be used.\newline
402 \config{tag}: (optional) Another tag to calculate the subimage from e.g \config{\%xd(A, \%mh)} would 393 \config{tag}: (optional) Another tag to calculate the subimage from e.g \config{\%xd(A, \%mh)} would
403 use the first subimage when \config{\%mh} is on and the second when it is off\newline 394 use the first subimage when \config{\%mh} is on and the second when it is off\newline
404 \config{offset}: (optional) Add this number to the value from the \config{tag} when 395 \config{offset}: (optional) Add this number to the value from the \config{tag} when
405 chosing the subimage (may be negative)\\ 396 chosing the subimage (may be negative)\\
406 \config{\%x9(n)} 397 \config{\%x9(n)}
407 & Display an image as a 9-patch bitmap covering the entire viewport.\newline 398 & Display an image as a 9-patch bitmap covering the entire viewport.\newline
@@ -409,7 +400,7 @@ Examples:
409 are unscaled, the four middle sections are scaled along one axis and the middle 400 are unscaled, the four middle sections are scaled along one axis and the middle
410 section is scaled on both axis.\newline 401 section is scaled on both axis.\newline
411 \config{n}: image ID\\ 402 \config{n}: image ID\\
412 403
413 \end{tagmap} 404 \end{tagmap}
414 405
415Examples: 406Examples:
@@ -429,12 +420,11 @@ with image ID ``M'', and then reference the individual sub-images in a condition
429 \item The images must be in BMP format 420 \item The images must be in BMP format
430 \item The image tag must be on its own line 421 \item The image tag must be on its own line
431 \item The ID is case sensitive 422 \item The ID is case sensitive
432 \item The size of the LCD screen for each \dap{} varies. See table below 423 \item The size of the LCD screen for each \dap{} varies. See table below
433 for appropriate sizes of each device. The x and y coordinates must 424 for appropriate sizes of each device. The x and y coordinates must
434 respect each of the \daps{} limits. 425 respect each of the \daps{} limits.
435 \end{itemize} 426 \end{itemize}
436} 427}
437}
438 428
439\opt{albumart}{ 429\opt{albumart}{
440\subsection{How to display the album art} 430\subsection{How to display the album art}
@@ -519,8 +509,8 @@ and tuned to a preset (and not recording) in order for them to be shown.
519 \config{\%Sr} & Use as a conditional to define options for left to right, or 509 \config{\%Sr} & Use as a conditional to define options for left to right, or
520 right to left languages. \%?Sr<RTL|LTR>\\ 510 right to left languages. \%?Sr<RTL|LTR>\\
521 \end{tagmap} 511 \end{tagmap}
522 512
523All alignment tags may be present in one line, but they need to be in the 513All alignment tags may be present in one line, but they need to be in the
524order left -- centre -- right. If the aligned texts overlap, they are merged. 514order left -- centre -- right. If the aligned texts overlap, they are merged.
525 515
526Example: \config{\%ax\%V(\dots)} 516Example: \config{\%ax\%V(\dots)}
@@ -569,7 +559,7 @@ Examples of the \%if tag:\\
569 559
570Allows grouping of several items (sublines) onto one line, with the 560Allows grouping of several items (sublines) onto one line, with the
571display cycling round the defined sublines. See 561display cycling round the defined sublines. See
572\reference{ref:AlternatingSublines} for details. 562\reference{ref:AlternatingSublines} for details.
573 563
574\opt{rtc}{ 564\opt{rtc}{
575\section{Time and Date} 565\section{Time and Date}
@@ -601,7 +591,7 @@ display cycling round the defined sublines. See
601 \config{\%Sx(English)} 591 \config{\%Sx(English)}
602 & Display the translation of ``English'' in the current language\\ 592 & Display the translation of ``English'' in the current language\\
603 \end{tagmap} 593 \end{tagmap}
604 594
605 \begin{itemize} 595 \begin{itemize}
606 \item ``English'' must be a phrase used in the language file. 596 \item ``English'' must be a phrase used in the language file.
607 \item It should match the \config{Source:} line in the language file. 597 \item It should match the \config{Source:} line in the language file.
@@ -685,7 +675,7 @@ display cycling round the defined sublines. See
685 Some tags can be used to display a bar which draws according to the value of 675 Some tags can be used to display a bar which draws according to the value of
686 the tag. To use these tags like a bar you need to use the following parameters 676 the tag. To use these tags like a bar you need to use the following parameters
687 (\%XX should be replaced with the actual tag). 677 (\%XX should be replaced with the actual tag).
688 678
689\opt{touchscreen}{ 679\opt{touchscreen}{
690 Volume and progress bars automatically create touch regions the same size 680 Volume and progress bars automatically create touch regions the same size
691 as the bar (slightly larger actually). This can be disabled with the 681 as the bar (slightly larger actually). This can be disabled with the
@@ -716,13 +706,13 @@ display cycling round the defined sublines. See
716 the centre of the image matches the current position. This must be 706 the centre of the image matches the current position. This must be
717 followed by the label of the desired image. 707 followed by the label of the desired image.
718 \item[backdrop] -- draw a preloaded image under the bar. The full 708 \item[backdrop] -- draw a preloaded image under the bar. The full
719 image will be displayed and must be the same size as the bar. 709 image will be displayed and must be the same size as the bar.
720 This must be followed by the label of the desired image. 710 This must be followed by the label of the desired image.
721 \item[nofill] -- don't draw the bar, only its frame (for use with the 711 \item[nofill] -- don't draw the bar, only its frame (for use with the
722 ``slider'' option). 712 ``slider'' option).
723 \item[noborder] -- don't draw the border for image-less bars, instead maximise 713 \item[noborder] -- don't draw the border for image-less bars, instead maximise
724 the filling over the specified area. This doesn't work for bars which 714 the filling over the specified area. This doesn't work for bars which
725 specify an image. 715 specify an image.
726 \item[nobar] -- don't draw the bar or its frame (for use with the 716 \item[nobar] -- don't draw the bar or its frame (for use with the
727 ``slider'' option). 717 ``slider'' option).
728 \opt{touchscreen}{ 718 \opt{touchscreen}{
@@ -755,7 +745,7 @@ a horizontal progressbar which doesn't fill and draws the image
755 substring is a number so it can be used with conditionals. (i.e \config{\%cM}). 745 substring is a number so it can be used with conditionals. (i.e \config{\%cM}).
756 0 is the first conditional option 746 0 is the first conditional option
757\end{description} 747\end{description}
758 748
759\begin{tagmap} 749\begin{tagmap}
760 \config{\%(} & The character `('\\ 750 \config{\%(} & The character `('\\
761 \config{\%)} & The character `)'\\ 751 \config{\%)} & The character `)'\\
@@ -766,10 +756,10 @@ a horizontal progressbar which doesn't fill and draws the image
766 \config{\%>} & The character `>'\\ 756 \config{\%>} & The character `>'\\
767 \config{\%;} & The character `;'\\ 757 \config{\%;} & The character `;'\\
768 \config{\%\#} & The character `\#'\\ 758 \config{\%\#} & The character `\#'\\
769 \config{\%s} & Indicate that the line should scroll. Can occur 759 \config{\%s} & Indicate that the line should scroll. Can occur
770 anywhere in a line (given that the text is 760 anywhere in a line (given that the text is
771 displayed; see conditionals above). You can specify 761 displayed; see conditionals above). You can specify
772 up to ten scrolling lines. Scrolling lines can not 762 up to ten scrolling lines. Scrolling lines can not
773 contain dynamic content such as timers, peak meters 763 contain dynamic content such as timers, peak meters
774 or progress bars.\\ 764 or progress bars.\\
775\end{tagmap} 765\end{tagmap}