diff options
author | Alex Parker <rockbox@aeparker.com> | 2010-07-31 12:47:12 +0000 |
---|---|---|
committer | Alex Parker <rockbox@aeparker.com> | 2010-07-31 12:47:12 +0000 |
commit | d7cb3b13fbb0f6ccec0bfabd3b618b2b9b8a870d (patch) | |
tree | 6e7207c7f60258e44bc11c0f2523bfacf694495f | |
parent | 4a8ea6c9d9b0db1de59ee4d2b9cc0125caa990c7 (diff) | |
download | rockbox-d7cb3b13fbb0f6ccec0bfabd3b618b2b9b8a870d.tar.gz rockbox-d7cb3b13fbb0f6ccec0bfabd3b618b2b9b8a870d.zip |
Manual: add some missing theme tags, and close FS#11472.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27637 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/appendix/wps_tags.tex | 45 |
1 files changed, 37 insertions, 8 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 9fd5e42e20..bc71956584 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -161,6 +161,29 @@ or \config{\%D(2)}), produce the information for the next file to be played. | |||
161 | the rest of the track>}\\ | 161 | the rest of the track>}\\ |
162 | \config{\%Sp} & Current playback pitch\\ | 162 | \config{\%Sp} & Current playback pitch\\ |
163 | \end{tagmap} | 163 | \end{tagmap} |
164 | |||
165 | \section{Playlist Viewer} | ||
166 | \begin{tagmap} | ||
167 | \config{\%Vp(start,if tag present,other)} & Display the playlist viewer in | ||
168 | the current viewport.\\ | ||
169 | \end{tagmap} | ||
170 | |||
171 | \begin{itemize} | ||
172 | \item `start' is the offset relative to the currently playing track for the | ||
173 | playlist to display from (0 the current track, 1 is the next track, etc.). | ||
174 | \item `if tag present' is the skin code to display if the track has been buffered. | ||
175 | \item `other' is the skin code to display if the track hasnt been buffered, | ||
176 | essentially only the filename is know at this point. | ||
177 | \end{itemize} | ||
178 | |||
179 | The entire viewport will be used, so don't expect other tags in the same | ||
180 | viewport to work well. Supported tags are \%pp, all tags starting with \%i, | ||
181 | most tags starting with \%f, \%pt and \%s.\\ | ||
182 | |||
183 | Example: \config{\%Vp(1,\%pp - \%it,\%pp - \%fn)} -- Display the playlist | ||
184 | position, then either the track title (from the tags) or | ||
185 | the filename. The viewer will display as many tracks as will fit in the | ||
186 | viewport. | ||
164 | 187 | ||
165 | \section{Runtime Database} | 188 | \section{Runtime Database} |
166 | \begin{tagmap} | 189 | \begin{tagmap} |
@@ -202,8 +225,7 @@ or \config{\%D(2)}), produce the information for the next file to be played. | |||
202 | \begin{tagmap} | 225 | \begin{tagmap} |
203 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle, A-B\\ | 226 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle, A-B\\ |
204 | \end{tagmap} | 227 | \end{tagmap} |
205 | Example: \config{\%?mm<Off|All|One|Shuffle% | 228 | Example: \config{\%?mm<Off|All|One|Shuffle|A-B>} |
206 | |A-B>} | ||
207 | 229 | ||
208 | \section{Playback Mode} | 230 | \section{Playback Mode} |
209 | \begin{tagmap} | 231 | \begin{tagmap} |
@@ -211,9 +233,7 @@ Example: \config{\%?mm<Off|All|One|Shuffle% | |||
211 | Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, | 233 | Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, |
212 | FM Radio muted\\ | 234 | FM Radio muted\\ |
213 | \end{tagmap} | 235 | \end{tagmap} |
214 | Example: \config{\%?mp<Stop|Play|Pause|% | 236 | Example: \config{\%?mp<Stop|Play|Pause|Ffwd|Rew|Rec|Rec pause|FM|FM pause>} |
215 | Ffwd|Rew|Rec|Rec pause|FM|% | ||
216 | FM pause>} | ||
217 | 237 | ||
218 | \section{Current Screen} | 238 | \section{Current Screen} |
219 | \begin{tagmap} | 239 | \begin{tagmap} |
@@ -223,8 +243,7 @@ FM pause>} | |||
223 | The tag can also be used as the switch in a conditional tag. For players without | 243 | The tag can also be used as the switch in a conditional tag. For players without |
224 | some capabilities (e.g. having no FM radio) some values will be never yielded. | 244 | some capabilities (e.g. having no FM radio) some values will be never yielded. |
225 | 245 | ||
226 | Example: \config{You are in the \%?cs<Main menu|WPS|% | 246 | Example: \config{You are in the \%?cs<Main menu|WPS|Recording screen|FM Radio screen>} |
227 | Recording screen|FM Radio screen>} | ||
228 | 247 | ||
229 | \section{List Title (\fname{.sbs} only)} | 248 | \section{List Title (\fname{.sbs} only)} |
230 | \begin{tagmap} | 249 | \begin{tagmap} |
@@ -435,17 +454,27 @@ and must have the same name as the preset. They need to be in either | |||
435 | and tuned to a preset (and not recording) in order for them to be shown. | 454 | and tuned to a preset (and not recording) in order for them to be shown. |
436 | } | 455 | } |
437 | 456 | ||
438 | \section{Alignment} | 457 | \section{Alignment and language direction} |
439 | \begin{tagmap} | 458 | \begin{tagmap} |
440 | \config{\%al} & Align the text left\\ | 459 | \config{\%al} & Align the text left\\ |
441 | \config{\%aL} & Align the text left, or to the right if RTL language is in use\\ | 460 | \config{\%aL} & Align the text left, or to the right if RTL language is in use\\ |
442 | \config{\%ac} & Centre the text\\ | 461 | \config{\%ac} & Centre the text\\ |
443 | \config{\%ar} & Align the text right\\ | 462 | \config{\%ar} & Align the text right\\ |
444 | \config{\%aR} & Align the text right, or to the left if RTL language is in use\\ | 463 | \config{\%aR} & Align the text right, or to the left if RTL language is in use\\ |
464 | \config{\%ax} & The next tag should follow the set language direction. When | ||
465 | prepended to a viewport declaration, the viewport will | ||
466 | be horizontally mirrored if the user language is set to | ||
467 | a RTL language. Currently the \%Cl, \%V and \%Vl tags | ||
468 | support this.\\ | ||
469 | \config{\%Sr} & Use as a conditional to define options for left to right, or | ||
470 | right to left languages. \%?Sr<RTL|LTR>\\ | ||
445 | \end{tagmap} | 471 | \end{tagmap} |
472 | |||
446 | All alignment tags may be present in one line, but they need to be in the | 473 | All alignment tags may be present in one line, but they need to be in the |
447 | order left -- centre -- right. If the aligned texts overlap, they are merged. | 474 | order left -- centre -- right. If the aligned texts overlap, they are merged. |
448 | 475 | ||
476 | Example: \config{\%ax\%V(\dots)} | ||
477 | |||
449 | \section{Conditional Tags} | 478 | \section{Conditional Tags} |
450 | 479 | ||
451 | \begin{tagmap} | 480 | \begin{tagmap} |