diff options
author | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2006-08-03 18:32:41 +0000 |
---|---|---|
committer | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2006-08-03 18:32:41 +0000 |
commit | da1e28c17ff81116f0b214430397c4cae1230301 (patch) | |
tree | 5600d0c2ceab2b697f58344fffe3611a16b1ee69 | |
parent | aa6ce70ba246b1f25eda6904c1c6774af813eb37 (diff) | |
download | rockbox-da1e28c17ff81116f0b214430397c4cae1230301.tar.gz rockbox-da1e28c17ff81116f0b214430397c4cae1230301.zip |
Make the wps tagmaps floats (for better displaying in the html manual). Add the new added wps tags.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10441 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/appendix/wps_tags.tex | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index b829614774..6d449aee4e 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -1,14 +1,17 @@ | |||
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{table} | ||
4 | \begin{tagmap}{}{} | 5 | \begin{tagmap}{}{} |
5 | \config{\%we} & Status Bar Enabled\\ | 6 | \config{\%we} & Status Bar Enabled\\ |
6 | \config{\%wd} & Status Bar Disabled\\ | 7 | \config{\%wd} & Status Bar Disabled\\ |
7 | \end{tagmap} | 8 | \end{tagmap} |
9 | \end{table} | ||
8 | These tags override the player setting for the display of the status bar. | 10 | These tags override the player setting for the display of the status bar. |
9 | They must be noted on their own line. | 11 | They must be noted on their own line. |
10 | 12 | ||
11 | \section{ID3 Info} | 13 | \section{ID3 Info} |
14 | \begin{table} | ||
12 | \begin{tagmap}{}{} | 15 | \begin{tagmap}{}{} |
13 | \config{\%ia} & ID3 Artist\\ | 16 | \config{\%ia} & ID3 Artist\\ |
14 | \config{\%ic} & ID3 Composer\\ | 17 | \config{\%ic} & ID3 Composer\\ |
@@ -19,10 +22,12 @@ They must be noted on their own line. | |||
19 | \config{\%iv} & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\ | 22 | \config{\%iv} & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\ |
20 | \config{\%iy} & ID3 Year\\ | 23 | \config{\%iy} & ID3 Year\\ |
21 | \end{tagmap} | 24 | \end{tagmap} |
25 | \end{table} | ||
22 | Remember that this information is not always available, so use the | 26 | Remember that this information is not always available, so use the |
23 | conditionals to show alternate information in preference to assuming. | 27 | conditionals to show alternate information in preference to assuming. |
24 | 28 | ||
25 | \section{Power Related Information} | 29 | \section{Power Related Information} |
30 | \begin{table} | ||
26 | \begin{tagmap}{}{} | 31 | \begin{tagmap}{}{} |
27 | \config{\%bl} & Show numeric battery level in percent.\\ | 32 | \config{\%bl} & Show numeric battery level in percent.\\ |
28 | & Can also be used in a conditional: | 33 | & Can also be used in a conditional: |
@@ -35,8 +40,10 @@ conditionals to show alternate information in preference to assuming. | |||
35 | & (only on targets that have software charge control or monitoring)\\ | 40 | & (only on targets that have software charge control or monitoring)\\ |
36 | \config{\%bs} & Sleep timer. Shows the remaining time if the sleeptimer is set\\ | 41 | \config{\%bs} & Sleep timer. Shows the remaining time if the sleeptimer is set\\ |
37 | \end{tagmap} | 42 | \end{tagmap} |
43 | \end{table} | ||
38 | 44 | ||
39 | \section{File Info} | 45 | \section{File Info} |
46 | \begin{table} | ||
40 | \begin{tagmap}{}{} | 47 | \begin{tagmap}{}{} |
41 | \config{\%fb} & File Bitrate (in kbps)\\ | 48 | \config{\%fb} & File Bitrate (in kbps)\\ |
42 | \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % | 49 | \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % |
@@ -58,12 +65,14 @@ conditionals to show alternate information in preference to assuming. | |||
58 | \config{\%d2} & Second directory from end of file path.\\ | 65 | \config{\%d2} & Second directory from end of file path.\\ |
59 | \config{\%d3} & Third directory from end of file path.\\ | 66 | \config{\%d3} & Third directory from end of file path.\\ |
60 | \end{tagmap} | 67 | \end{tagmap} |
68 | \end{table} | ||
61 | Example for the the \config{\%dN} commands: If the path is | 69 | Example for the the \config{\%dN} commands: If the path is |
62 | ``/Rock/Kent/Isola/11 - 747.mp3'', \config{\%d1} is ``Isola'', | 70 | ``/Rock/Kent/Isola/11 - 747.mp3'', \config{\%d1} is ``Isola'', |
63 | \config{\%d2} is ``Kent'' \dots | 71 | \config{\%d2} is ``Kent'' \dots |
64 | You get the picture. | 72 | You get the picture. |
65 | 73 | ||
66 | \section{Playlist/Song Info} | 74 | \section{Playlist/Song Info} |
75 | \begin{table} | ||
67 | \begin{tagmap}{}{} | 76 | \begin{tagmap}{}{} |
68 | \config{\%pb} & Progress Bar\\ | 77 | \config{\%pb} & Progress Bar\\ |
69 | \opt{player}{ | 78 | \opt{player}{ |
@@ -90,8 +99,10 @@ You get the picture. | |||
90 | {\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8% | 99 | {\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8% |
91 | {\textbar}9{\textbar}10{\textgreater}}\\ | 100 | {\textbar}9{\textbar}10{\textgreater}}\\ |
92 | \end{tagmap} | 101 | \end{tagmap} |
102 | \end{table} | ||
93 | 103 | ||
94 | \section{Runtime Database} | 104 | \section{Runtime Database} |
105 | \begin{table} | ||
95 | \begin{tagmap}{}{} | 106 | \begin{tagmap}{}{} |
96 | \config{\%rp} & Song playcount\\ | 107 | \config{\%rp} & Song playcount\\ |
97 | \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag, % | 108 | \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag, % |
@@ -99,43 +110,60 @@ You get the picture. | |||
99 | 4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}% | 110 | 4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}% |
100 | 10{\textgreater}}\\ | 111 | 10{\textgreater}}\\ |
101 | \end{tagmap} | 112 | \end{tagmap} |
113 | \end{table} | ||
102 | 114 | ||
103 | \opt{SWCODEC}{ | 115 | \opt{SWCODEC}{ |
104 | \section{Sound (DSP) settings} | 116 | \section{Sound (DSP) settings} |
117 | \begin{table} | ||
105 | \begin{tagmap}{}{} | 118 | \begin{tagmap}{}{} |
106 | \config{\%sp} & display current playback pitch \\ | 119 | \config{\%sp} & display current playback pitch \\ |
120 | \opt{SWCODEC}{ | ||
121 | \config{\%xf} & Crossfade setting, in the order: Off, Shuffle, Skip, Always\\ | ||
122 | \config{\%rg} & ReplayGain setting, in the order: Off, Track, Album, Shuffle\\ | ||
123 | \config{\%xd} & Crossfeed setting\\ | ||
124 | } | ||
107 | \end{tagmap} | 125 | \end{tagmap} |
126 | \end{table} | ||
108 | } | 127 | } |
109 | \opt{h1xx,h300}{ | 128 | \opt{h1xx,h300}{ |
110 | \section{Hold Switches} | 129 | \section{Hold Switches} |
130 | \begin{table} | ||
111 | \begin{tagmap}{}{} | 131 | \begin{tagmap}{}{} |
112 | \config{\%mh} & ``h'' if the main unit hold switch is on\\ | 132 | \config{\%mh} & ``h'' if the main unit hold switch is on\\ |
113 | \config{\%mr} & ``r'' if the remote hold switch is on\\ | 133 | \config{\%mr} & ``r'' if the remote hold switch is on\\ |
114 | \end{tagmap} | 134 | \end{tagmap} |
135 | \end{table} | ||
115 | } | 136 | } |
116 | 137 | ||
117 | \section{Virtual LED} | 138 | \section{Virtual LED} |
139 | \begin{table} | ||
118 | \begin{tagmap}{}{} | 140 | \begin{tagmap}{}{} |
119 | \config{\%lh} & ``h'' if there is hard disk activity\\ | 141 | \config{\%lh} & ``h'' if there is hard disk activity\\ |
120 | \end{tagmap} | 142 | \end{tagmap} |
143 | \end{table} | ||
121 | 144 | ||
122 | \section{Repeat Mode} | 145 | \section{Repeat Mode} |
146 | \begin{table} | ||
123 | \begin{tagmap}{}{} | 147 | \begin{tagmap}{}{} |
124 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle | 148 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle |
125 | \opt{player,recorder,recorderv2fm}{, A-B}\\ | 149 | \opt{player,recorder,recorderv2fm}{, A-B}\\ |
126 | \end{tagmap} | 150 | \end{tagmap} |
151 | \end{table} | ||
127 | Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% | 152 | Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% |
128 | {\textbar}A-B{\textgreater}} | 153 | {\textbar}A-B{\textgreater}} |
129 | 154 | ||
130 | \section{Playback Mode Tags} | 155 | \section{Playback Mode Tags} |
156 | \begin{table} | ||
131 | \begin{tagmap}{}{} | 157 | \begin{tagmap}{}{} |
132 | \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, | 158 | \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, |
133 | Fast forward, Rewind\\ | 159 | Fast forward, Rewind\\ |
134 | \end{tagmap} | 160 | \end{tagmap} |
161 | \end{table} | ||
135 | Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% | 162 | Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% |
136 | Ffwd{\textbar}Rew{\textgreater}} | 163 | Ffwd{\textbar}Rew{\textgreater}} |
137 | 164 | ||
138 | \section{Images} | 165 | \section{Images} |
166 | \begin{table} | ||
139 | \begin{tagmap}{}{} | 167 | \begin{tagmap}{}{} |
140 | \opt{h300,x5,ipodcolor,ipodvideo}{ | 168 | \opt{h300,x5,ipodcolor,ipodvideo}{ |
141 | \config{\%X{\textbar}filename.bmp{\textbar}} | 169 | \config{\%X{\textbar}filename.bmp{\textbar}} |
@@ -160,6 +188,7 @@ Ffwd{\textbar}Rew{\textgreater}} | |||
160 | \config{\%xdn} & Display a preloaded image\\ | 188 | \config{\%xdn} & Display a preloaded image\\ |
161 | & \config{n}: image ID (a-z and A-Z)\\ | 189 | & \config{n}: image ID (a-z and A-Z)\\ |
162 | \end{tagmap} | 190 | \end{tagmap} |
191 | \end{table} | ||
163 | 192 | ||
164 | Example: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\ | 193 | Example: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\ |
165 | \config{\%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar}} | 194 | \config{\%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar}} |
@@ -176,24 +205,29 @@ Example: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\ | |||
176 | } | 205 | } |
177 | 206 | ||
178 | \section{Alignment} | 207 | \section{Alignment} |
208 | \begin{table} | ||
179 | \begin{tagmap}{}{} | 209 | \begin{tagmap}{}{} |
180 | \config{\%al} & Text is left aligned\\ | 210 | \config{\%al} & Text is left aligned\\ |
181 | \config{\%ac} & Text is center aligned\\ | 211 | \config{\%ac} & Text is center aligned\\ |
182 | \config{\%ar} & Text is right aligned\\ | 212 | \config{\%ar} & Text is right aligned\\ |
183 | \end{tagmap} | 213 | \end{tagmap} |
214 | \end{table} | ||
184 | All alignment tags may be present in one line, but they need to be in the | 215 | All alignment tags may be present in one line, but they need to be in the |
185 | order left -- center -- right. If the aligned texts overlap, they are merged. | 216 | order left -- center -- right. If the aligned texts overlap, they are merged. |
186 | 217 | ||
187 | \section{Conditional Tags} | 218 | \section{Conditional Tags} |
188 | 219 | ||
220 | \begin{table} | ||
189 | \begin{tagmap}{}{} | 221 | \begin{tagmap}{}{} |
190 | \config{\%?xx{\textless}true{\textbar}false{\textgreater}} | 222 | \config{\%?xx{\textless}true{\textbar}false{\textgreater}} |
191 | & If / Else: Evaluate for true or false case \\ | 223 | & If / Else: Evaluate for true or false case \\ |
192 | \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} | 224 | \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} |
193 | & Enumerations: Evaluate for first / second / third / \dots / last condition \\ | 225 | & Enumerations: Evaluate for first / second / third / \dots / last condition \\ |
194 | \end{tagmap} | 226 | \end{tagmap} |
227 | \end{table} | ||
195 | 228 | ||
196 | \section{Other Tags} | 229 | \section{Other Tags} |
230 | \begin{table} | ||
197 | \begin{tagmap}{}{} | 231 | \begin{tagmap}{}{} |
198 | \config{\%\%} & Display a `\%'\\ | 232 | \config{\%\%} & Display a `\%'\\ |
199 | \config{\%{\textless}} & Display a `{\textless}'\\ | 233 | \config{\%{\textless}} & Display a `{\textless}'\\ |
@@ -207,3 +241,5 @@ order left -- center -- right. If the aligned texts overlap, they are merged. | |||
207 | contain dynamic content such as timers, peak meters | 241 | contain dynamic content such as timers, peak meters |
208 | or progress bars.\\ | 242 | or progress bars.\\ |
209 | \end{tagmap} | 243 | \end{tagmap} |
244 | \end{table} | ||
245 | |||