summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Levin <al.le@rockbox.org>2010-07-02 19:32:48 +0000
committerAlexander Levin <al.le@rockbox.org>2010-07-02 19:32:48 +0000
commit12427106d2710e3452002676c02153562bb01cc2 (patch)
tree2464e05e0c01784ddb00e31e0e7d36f3fc4cba63
parentd8f5f5175fc6a428020ae55f20ab72525fa34968 (diff)
downloadrockbox-12427106d2710e3452002676c02153562bb01cc2.tar.gz
rockbox-12427106d2710e3452002676c02153562bb01cc2.zip
Onle one table row per WPS tag
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27248 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/appendix/wps_tags.tex89
1 files changed, 45 insertions, 44 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index b65e58f958..f840d9eff5 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -73,13 +73,13 @@ show the information for the next song to be played.
73 73
74\section{Power Related Information} 74\section{Power Related Information}
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{\textless}-1{\textbar}0{\textbar}1{\textbar}%
79 2{\textbar}\ldots{\textbar}N{\textgreater}}, 79 2{\textbar}\ldots{\textbar}N{\textgreater}},
80 where the value $-1$ is used when the battery level isn't 80 where the value $-1$ is used when the battery level isn't
81 known (it usually is)\\ 81 known (it usually is).
82 & An image can also be used, the proportion of the image 82 An image can also be used, the proportion of the image
83 shown correspinds to the battery level: 83 shown correspinds to the battery level:
84 \config{\%bl(x,y,[width],[height],image.bmp)}\\ 84 \config{\%bl(x,y,[width],[height],image.bmp)}\\
85 \config{\%bv} & The battery level in volts\\ 85 \config{\%bv} & The battery level in volts\\
@@ -102,8 +102,8 @@ show the information for the next song to be played.
102 {\textbar}aac\-{\textbar}shn\-{\textbar}sid\-{\textbar}adx\-% 102 {\textbar}aac\-{\textbar}shn\-{\textbar}sid\-{\textbar}adx\-%
103 {\textbar}nsf\-{\textbar}speex\-{\textbar}spc\-{\textbar}ape\-% 103 {\textbar}nsf\-{\textbar}speex\-{\textbar}spc\-{\textbar}ape\-%
104 {\textbar}wma\-{\textbar}mod\-{\textbar}sap% 104 {\textbar}wma\-{\textbar}mod\-{\textbar}sap%
105 {\textbar}unknown{\textgreater}}.\\ 105 {\textbar}unknown{\textgreater}}.
106 & The codec order is as follows: MP1, MP2, MP3, AIFF, WAV, 106 The codec order is as follows: MP1, MP2, MP3, AIFF, WAV,
107 Ogg Vorbis (OGG), FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, 107 Ogg Vorbis (OGG), FLAC, MPC, AC3, WavPack (WV), ALAC, AAC,
108 Shorten (SHN), SID, ADX, NSF, Speex, SPC, APE, WMA, MOD, SAP.\\ 108 Shorten (SHN), SID, ADX, NSF, Speex, SPC, APE, WMA, MOD, SAP.\\
109 \config{\%ff} & File Frequency (in Hz)\\ 109 \config{\%ff} & File Frequency (in Hz)\\
@@ -125,14 +125,14 @@ or \config{\%D(2)}), produce the information for the next file to be played.
125 125
126\section{Playlist/Song Info} 126\section{Playlist/Song Info}
127 \begin{tagmap} 127 \begin{tagmap}
128 \config{\%pb} & Progress Bar\\ 128 \config{\%pb} & Progress Bar.
129 \opt{player}{ 129 \opt{player}{
130 & This will display a one character ``cup'' 130 This will display a one character ``cup''
131 that empties as the time progresses.} 131 that empties as the time progresses.}
132 \opt{lcd_bitmap}{ 132 \opt{lcd_bitmap}{
133 & This will replace the entire line with a progress bar. \\ 133 This will replace the entire line with a progress bar.
134 & You can set the position, width and height of the progressbar % 134 You can set the position, width and height of the progressbar
135 (in pixels) and load a custom image for it: % 135 (in pixels) and load a custom image for it:
136 \config{\%pb(x,y,[width],[height],image.bmp)}} \\ 136 \config{\%pb(x,y,[width],[height],image.bmp)}} \\
137 \opt{player}{% 137 \opt{player}{%
138 \config{\%pf} & Full-line progress bar \& time display\\ 138 \config{\%pf} & Full-line progress bar \& time display\\
@@ -149,23 +149,23 @@ or \config{\%D(2)}), produce the information for the next file to be played.
149 \config{\%pr} & Remaining time in song\\ 149 \config{\%pr} & Remaining time in song\\
150 \config{\%ps} & ``s'' if shuffle mode is enabled\\ 150 \config{\%ps} & ``s'' if shuffle mode is enabled\\
151 \config{\%pt} & Total track time\\ 151 \config{\%pt} & Total track time\\
152 \config{\%pv} & Current volume (in dB). Can also be used in a conditional: \\ 152 \config{\%pv} & Current volume (in dB). Can also be used in a conditional:
153 & \config{\%?pv{\textless}0{\textbar}1{\textbar}2{\textbar}\ldots% 153 \config{\%?pv{\textless}0{\textbar}1{\textbar}2{\textbar}\ldots%
154 {\textbar}N{\textgreater}}\\ 154 {\textbar}N{\textgreater}}\newline
155 & 0 is used for mute, the last option is used for values greater than zero.\\ 155 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: 156 \opt{lcd_bitmap}{This can also be used like \%pb to provide a continuous scale:
157 \config{\%pv(x,y,[width],[height],image.bmp)}} \\ 157 \config{\%pv(x,y,[width],[height],image.bmp)}} \\
158 \config{\%pS} & Track is starting. An optional number gives how many seconds 158 \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 159 the tag remains true for after the start of the track. The default is
160 10 seconds if no number is specified.\\ 160 10 seconds if no number is specified.
161 & \config{\%pS(7){\textless}in the first 7 seconds of track{\textbar}in 161 \config{\%pS(7){\textless}in the first 7 seconds of track{\textbar}in
162 the rest of the track{\textgreater}}\\ 162 the rest of the track{\textgreater}}\\
163 \config{\%pE} & Track is ending. An optional number gives how many seconds 163 \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 164 before the end of the track the tag becomes true. The default is
165 10 seconds if no number is specified.\\ 165 10 seconds if no number is specified.
166 & \config{\%pE(7){\textless}in the last 7 seconds of track{\textbar}in 166 \config{\%pE(7){\textless}in the last 7 seconds of track{\textbar}in
167 the rest of the track{\textgreater}}\\ 167 the rest of the track{\textgreater}}\\
168 \config{\%Sp} & Current Playback Pitch\\ 168 \config{\%Sp} & Current playback pitch\\
169 \end{tagmap} 169 \end{tagmap}
170 170
171\section{Runtime Database} 171\section{Runtime Database}
@@ -292,22 +292,22 @@ Examples:
292 This image must be exactly the same size as your LCD.\\ 292 This image must be exactly the same size as your LCD.\\
293 }% 293 }%
294 \config{\%x(n,filename,x,y)} 294 \config{\%x(n,filename,x,y)}
295 & Load and display an image\\ 295 & Load and display an image\newline
296 & \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\\ 296 \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\newline
297 & \config{filename}: file name relative to \fname{/.rockbox/} and including ``.bmp''\\ 297 \config{filename}: file name relative to \fname{/.rockbox/} and including ``.bmp''\newline
298 & \config{x}: x coordinate\\ 298 \config{x}: x coordinate\newline
299 & \config{y}: y coordinate.\\ 299 \config{y}: y coordinate.\\
300 \config{\%xl(n,filename,x,y,\tabnlindent[nimages])} 300 \config{\%xl(n,filename,x,y,\tabnlindent[nimages])}
301 & Preload an image for later display (useful for when your images are displayed conditionally)\\ 301 & Preload an image for later display (useful for when your images are displayed conditionally).\newline
302 & \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\\ 302 \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\newline
303 & \config{filename}: file name relative to \fname{/.rockbox/} and including ``.bmp''\\ 303 \config{filename}: file name relative to \fname{/.rockbox/} and including ``.bmp''\newline
304 & \config{x}: x coordinate\\ 304 \config{x}: x coordinate\newline
305 & \config{y}: y coordinate\\ 305 \config{y}: y coordinate\newline
306 & \config{nimages}: (optional) number of sub-images (tiled vertically, of the same height) 306 \config{nimages}: (optional) number of sub-images (tiled vertically, of the same height)
307 contained in the bitmap. Default is 1.\\ 307 contained in the bitmap. Default is 1.\\
308 \config{\%xd(n[i])} & Display a preloaded image\\ 308 \config{\%xd(n[i])} & Display a preloaded image.
309 & \config{n}: image ID (a-z and A-Z) as it was specified in \config{\%x} or \config{\%xl}\\ 309 \config{n}: image ID (a-z and A-Z) as it was specified in \config{\%x} or \config{\%xl}\newline
310 & \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52). 310 \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52).
311 By default the first (i.e. top most) sub-image will be used.\\ 311 By default the first (i.e. top most) sub-image will be used.\\
312 \end{tagmap} 312 \end{tagmap}
313 313
@@ -384,14 +384,14 @@ follows.
384 384
385 \begin{tagmap} 385 \begin{tagmap}
386 \config{\%Cl(x,y,[maxwidth],\tabnlindent[maxheight],\tabnlindent{}hor\_align,\tabnlindent{}vert\_align)} 386 \config{\%Cl(x,y,[maxwidth],\tabnlindent[maxheight],\tabnlindent{}hor\_align,\tabnlindent{}vert\_align)}
387 & Define the settings for album art\\ 387 & Define the settings for album art\newline
388 & \config{x}: x coordinate\\ 388 \config{x}: x coordinate\newline
389 & \config{y}: y coordinate\\ 389 \config{y}: y coordinate\newline
390 & \config{maxwidth}: Maximum height\\ 390 \config{maxwidth}: Maximum height\newline
391 & \config{maxheight}: Maximum width\\ 391 \config{maxheight}: Maximum width\newline
392 & \config{hor\_align}: Horizontal alignment, enter as `l', `c' or `r' for 392 \config{hor\_align}: Horizontal alignment, enter as `l', `c' or `r' for
393 left, centre or right. Centre is default\\ 393 left, centre or right. Centre is default\newline
394 & \config{vert\_align}: Vertical alignment, enter as `t', `c' or `b' for 394 \config{vert\_align}: Vertical alignment, enter as `t', `c' or `b' for
395 top, centre or bottom. Centre is default\\ 395 top, centre or bottom. Centre is default\\
396 \config{\%Cd} & Display the album art as configured. \\ 396 \config{\%Cd} & Display the album art as configured. \\
397 \config{\%C} & Use in a conditional to determine if an image is available. \\ 397 \config{\%C} & Use in a conditional to determine if an image is available. \\
@@ -482,7 +482,8 @@ display cycling round the defined sublines. See
482 \opt{rtc}{ 482 \opt{rtc}{
483 \config{\%cd} & Day of month from 01 to 31\\ 483 \config{\%cd} & Day of month from 01 to 31\\
484 \config{\%ce} & Zero padded day of month from 1 to 31\\ 484 \config{\%ce} & Zero padded day of month from 1 to 31\\
485 \config{\%cf} & A conditional for 12/24 hour format. \%?cf{\textless}24 hour stuff{\textbar}12 hour stuff{\textgreater}\\ 485 \config{\%cf} & A conditional for 12/24 hour format.\newline
486 \config{\%?cf<24 hour stuff|12 hour stuff>}\\
486 \config{\%cH} & Zero padded hour from 00 to 23 (24 hour format)\\ 487 \config{\%cH} & Zero padded hour from 00 to 23 (24 hour format)\\
487 \config{\%ck} & Hour from 0 to 23 (24 hour format)\\ 488 \config{\%ck} & Hour from 0 to 23 (24 hour format)\\
488 \config{\%cI} & Zero padded hour from 01 to 12 (am/pm format)\\ 489 \config{\%cI} & Zero padded hour from 01 to 12 (am/pm format)\\