diff options
Diffstat (limited to 'manual')
-rw-r--r-- | manual/appendix/wps_tags.tex | 191 | ||||
-rw-r--r-- | manual/preamble.tex | 1 |
2 files changed, 97 insertions, 95 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index df311e8238..b829614774 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -2,166 +2,167 @@ | |||
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{tagmap}{}{} | 4 | \begin{tagmap}{}{} |
5 | \%we & Status Bar Enabled\\ | 5 | \config{\%we} & Status Bar Enabled\\ |
6 | \%wd & Status Bar Disabled\\ | 6 | \config{\%wd} & Status Bar Disabled\\ |
7 | \end{tagmap} | 7 | \end{tagmap} |
8 | These tags override the player setting for the display of the status bar. | 8 | These tags override the player setting for the display of the status bar. |
9 | They must be noted on their own line. | 9 | They must be noted on their own line. |
10 | 10 | ||
11 | \section{ID3 Info} | 11 | \section{ID3 Info} |
12 | \begin{tagmap}{}{} | 12 | \begin{tagmap}{}{} |
13 | \%ia & ID3 Artist\\ | 13 | \config{\%ia} & ID3 Artist\\ |
14 | \%ic & ID3 Composer\\ | 14 | \config{\%ic} & ID3 Composer\\ |
15 | \%id & ID3 Album Name\\ | 15 | \config{\%id} & ID3 Album Name\\ |
16 | \%ig & ID3 Genre Name\\ | 16 | \config{\%ig} & ID3 Genre Name\\ |
17 | \%in & ID3 Track Number\\ | 17 | \config{\%in} & ID3 Track Number\\ |
18 | \%it & ID3 Track Title\\ | 18 | \config{\%it} & ID3 Track Title\\ |
19 | \%iv & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\ | 19 | \config{\%iv} & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\ |
20 | \%iy & ID3 Year\\ | 20 | \config{\%iy} & ID3 Year\\ |
21 | \end{tagmap} | 21 | \end{tagmap} |
22 | Remember that this information is not always available, so use the | 22 | Remember that this information is not always available, so use the |
23 | conditionals to show alternate information in preference to assuming. | 23 | conditionals to show alternate information in preference to assuming. |
24 | 24 | ||
25 | \section{Power Related Information} | 25 | \section{Power Related Information} |
26 | \begin{tagmap}{}{} | 26 | \begin{tagmap}{}{} |
27 | \%bl & Show numeric battery level in percent.\\ | 27 | \config{\%bl} & Show numeric battery level in percent.\\ |
28 | & Can also be used in a conditional: | 28 | & Can also be used in a conditional: |
29 | \%?bl{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textgreater}\\ | 29 | \config{\%?bl{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textgreater}}\\ |
30 | \%bv & Show the battery level in volts\\ | 30 | \config{\%bv} & Show the battery level in volts\\ |
31 | \%bt & Show estimated battery time left\\ | 31 | \config{\%bt} & Show estimated battery time left\\ |
32 | \%bp & ``p'' if the charger is connected \\ | 32 | \config{\%bp} & ``p'' if the charger is connected \\ |
33 | & (only on targets that can charge batteries)\\ | 33 | & (only on targets that can charge batteries)\\ |
34 | \%bc & ``c'' if the unit is currently charging the battery\\ | 34 | \config{\%bc} & ``c'' if the unit is currently charging the battery\\ |
35 | & (only on targets that have software charge control or monitoring)\\ | 35 | & (only on targets that have software charge control or monitoring)\\ |
36 | \%bs & Sleep timer. Shows the remaining time if the sleeptimer is set\\ | 36 | \config{\%bs} & Sleep timer. Shows the remaining time if the sleeptimer is set\\ |
37 | \end{tagmap} | 37 | \end{tagmap} |
38 | 38 | ||
39 | \section{File Info} | 39 | \section{File Info} |
40 | \begin{tagmap}{}{} | 40 | \begin{tagmap}{}{} |
41 | \%fb & File Bitrate (in kbps)\\ | 41 | \config{\%fb} & File Bitrate (in kbps)\\ |
42 | \%fc & File Codec (e.g. ``MP3'' or ``FLAC''). % | 42 | \config{\%fc} & File Codec (e.g. ``MP3'' or ``FLAC''). % |
43 | This tag can also be used in a conditional tag, % | 43 | This tag can also be used in a conditional tag, % |
44 | \%?fc{\textless}mp1\-{\textbar}mp2\-{\textbar}mp3\-{\textbar}wav\-% | 44 | \config{\%?fc{\textless}mp1\-{\textbar}mp2\-{\textbar}mp3\-{\textbar}wav\-% |
45 | {\textbar}vorbis\-{\textbar}flac\-{\textbar}mpc\-{\textbar}a52\-% | 45 | {\textbar}vorbis\-{\textbar}flac\-{\textbar}mpc\-{\textbar}a52\-% |
46 | {\textbar}wavpack\-{\textbar}alac\-{\textbar}aac\-{\textbar}shn\-% | 46 | {\textbar}wavpack\-{\textbar}alac\-{\textbar}aac\-{\textbar}shn\-% |
47 | {\textbar}aiff\-% | 47 | {\textbar}aiff\-% |
48 | {\textbar}unknown{\textgreater}. % | 48 | {\textbar}unknown{\textgreater}}. % |
49 | The codec order is as follows: MP1, MP2, MP3, WAV, Ogg Vorbis (OGG),% | 49 | The codec order is as follows: MP1, MP2, MP3, WAV, Ogg Vorbis (OGG),% |
50 | FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, Shorten (SHN), AIFF\\ | 50 | FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, Shorten (SHN), AIFF\\ |
51 | \%ff & File Frequency (in Hz)\\ | 51 | \config{\%ff} & File Frequency (in Hz)\\ |
52 | \%fm & File Name\\ | 52 | \config{\%fm} & File Name\\ |
53 | \%fn & File Name (without extension)\\ | 53 | \config{\%fn} & File Name (without extension)\\ |
54 | \%fp & File Path\\ | 54 | \config{\%fp} & File Path\\ |
55 | \%fs & File Size (In Kilobytes)\\ | 55 | \config{\%fs} & File Size (In Kilobytes)\\ |
56 | \%fv & ``(avg)'' if variable bit rate or ``'' if constant bit rate\\ | 56 | \config{\%fv} & ``(avg)'' if variable bit rate or ``'' if constant bit rate\\ |
57 | \%d1 & First directory from end of file path.\\ | 57 | \config{\%d1} & First directory from end of file path.\\ |
58 | \%d2 & Second directory from end of file path.\\ | 58 | \config{\%d2} & Second directory from end of file path.\\ |
59 | \%d3 & Third directory from end of file path.\\ | 59 | \config{\%d3} & Third directory from end of file path.\\ |
60 | \end{tagmap} | 60 | \end{tagmap} |
61 | Example for the the \%dN commands: If the path is | 61 | Example for the the \config{\%dN} commands: If the path is |
62 | ``/Rock/Kent/Isola/11 - 747.mp3'', \%d1 is ``Isola'', \%d2 is ``Kent'' \dots | 62 | ``/Rock/Kent/Isola/11 - 747.mp3'', \config{\%d1} is ``Isola'', |
63 | \config{\%d2} is ``Kent'' \dots | ||
63 | You get the picture. | 64 | You get the picture. |
64 | 65 | ||
65 | \section{Playlist/Song Info} | 66 | \section{Playlist/Song Info} |
66 | \begin{tagmap}{}{} | 67 | \begin{tagmap}{}{} |
67 | \%pb & Progress Bar\\ | 68 | \config{\%pb} & Progress Bar\\ |
68 | \opt{player}{ | 69 | \opt{player}{ |
69 | & This will display a 1 character ``cup'' % | 70 | & This will display a 1 character ``cup'' % |
70 | that empties as the time progresses.} | 71 | that empties as the time progresses.} |
71 | \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodnano}{ | 72 | \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodnano}{ |
72 | & This will replace the entire line with a progress bar. \\ | 73 | & This will replace the entire line with a progress bar. \\ |
73 | & You can set the height, position and width of the progressbar % | 74 | & You can set the height, position and width of the progressbar % |
74 | (in pixels): \%pb{\textbar}height{\textbar}leftpos% | 75 | (in pixels): \config{\%pb{\textbar}height{\textbar}leftpos% |
75 | {\textbar}rightpos{\textbar}} \\ | 76 | {\textbar}rightpos{\textbar}}} \\ |
76 | \opt{player}{ | 77 | \opt{player}{ |
77 | \%pf & Full-line progress bar \& time display\\ | 78 | \config{\%pf} & Full-line progress bar \& time display\\ |
78 | } | 79 | } |
79 | \%pc & Current Time In Song\\ | 80 | \config{\%pc} & Current Time In Song\\ |
80 | \%pe & Total Number of Playlist Entries\\ | 81 | \config{\%pe} & Total Number of Playlist Entries\\ |
81 | \%pm & Peak Meter (Recorder only) The entire line is used as volume peak meter.\\ | 82 | \config{\%pm} & Peak Meter (Recorder only) The entire line is used as volume peak meter.\\ |
82 | \%pn & Playlist Name (Without path or extension)\\ | 83 | \config{\%pn} & Playlist Name (Without path or extension)\\ |
83 | \%pp & Playlist Position\\ | 84 | \config{\%pp} & Playlist Position\\ |
84 | \%pr & Remaining Time In Song\\ | 85 | \config{\%pr} & Remaining Time In Song\\ |
85 | \%ps & Shuffle. Shows 's' if shuffle mode is enabled.\\ | 86 | \config{\%ps} & Shuffle. Shows 's' if shuffle mode is enabled.\\ |
86 | \%pt & Total Track Time\\ | 87 | \config{\%pt} & Total Track Time\\ |
87 | \%pv & Current volume. Can also be used in a conditional: \\ | 88 | \config{\%pv} & Current volume. Can also be used in a conditional: \\ |
88 | & \%?pv{\textless}0{\textbar}1{\textbar}2{\textbar}3% | 89 | & \config{\%?pv{\textless}0{\textbar}1{\textbar}2{\textbar}3% |
89 | {\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8% | 90 | {\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8% |
90 | {\textbar}9{\textbar}10{\textgreater}\\ | 91 | {\textbar}9{\textbar}10{\textgreater}}\\ |
91 | \end{tagmap} | 92 | \end{tagmap} |
92 | 93 | ||
93 | \section{Runtime Database} | 94 | \section{Runtime Database} |
94 | \begin{tagmap}{}{} | 95 | \begin{tagmap}{}{} |
95 | \%rp & Song playcount\\ | 96 | \config{\%rp} & Song playcount\\ |
96 | \%rr & Song rating (0-10). This tag can also be used in a conditional tag, % | 97 | \config{\%rr} & Song rating (0-10). This tag can also be used in a conditional tag, % |
97 | \%?rr{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}% | 98 | \config{\%?rr{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}% |
98 | 4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}% | 99 | 4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}% |
99 | 10{\textgreater}\\ | 100 | 10{\textgreater}}\\ |
100 | \end{tagmap} | 101 | \end{tagmap} |
101 | 102 | ||
102 | \opt{SWCODEC}{ | 103 | \opt{SWCODEC}{ |
103 | \section{Sound (DSP) settings} | 104 | \section{Sound (DSP) settings} |
104 | \begin{tagmap}{}{} | 105 | \begin{tagmap}{}{} |
105 | \%sp & display current playback pitch \\ | 106 | \config{\%sp} & display current playback pitch \\ |
106 | \end{tagmap} | 107 | \end{tagmap} |
107 | } | 108 | } |
108 | \opt{h1xx,h300}{ | 109 | \opt{h1xx,h300}{ |
109 | \section{Hold Switches} | 110 | \section{Hold Switches} |
110 | \begin{tagmap}{}{} | 111 | \begin{tagmap}{}{} |
111 | \%mh & ``h'' if the main unit hold switch is on\\ | 112 | \config{\%mh} & ``h'' if the main unit hold switch is on\\ |
112 | \%mr & ``r'' if the remote hold switch is on\\ | 113 | \config{\%mr} & ``r'' if the remote hold switch is on\\ |
113 | \end{tagmap} | 114 | \end{tagmap} |
114 | } | 115 | } |
115 | 116 | ||
116 | \section{Virtual LED} | 117 | \section{Virtual LED} |
117 | \begin{tagmap}{}{} | 118 | \begin{tagmap}{}{} |
118 | \%lh & ``h'' if there is hard disk activity\\ | 119 | \config{\%lh} & ``h'' if there is hard disk activity\\ |
119 | \end{tagmap} | 120 | \end{tagmap} |
120 | 121 | ||
121 | \section{Repeat Mode} | 122 | \section{Repeat Mode} |
122 | \begin{tagmap}{}{} | 123 | \begin{tagmap}{}{} |
123 | \%mm & Repeat mode, 0-4, in the order: Off, All, One, Shuffle | 124 | \config{\%mm} & Repeat mode, 0-4, in the order: Off, All, One, Shuffle |
124 | \opt{player,recorder,recorderv2fm}{, A-B}\\ | 125 | \opt{player,recorder,recorderv2fm}{, A-B}\\ |
125 | \end{tagmap} | 126 | \end{tagmap} |
126 | Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% | 127 | Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle% |
127 | {\textbar}A-B{\textgreater} | 128 | {\textbar}A-B{\textgreater}} |
128 | 129 | ||
129 | \section{Playback Mode Tags} | 130 | \section{Playback Mode Tags} |
130 | \begin{tagmap}{}{} | 131 | \begin{tagmap}{}{} |
131 | \%mp & Play status, 0-4, in the order: Stop, Play, Pause, | 132 | \config{\%mp} & Play status, 0-4, in the order: Stop, Play, Pause, |
132 | Fast forward, Rewind\\ | 133 | Fast forward, Rewind\\ |
133 | \end{tagmap} | 134 | \end{tagmap} |
134 | Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% | 135 | Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}% |
135 | Ffwd{\textbar}Rew{\textgreater} | 136 | Ffwd{\textbar}Rew{\textgreater}} |
136 | 137 | ||
137 | \section{Images} | 138 | \section{Images} |
138 | \begin{tagmap}{}{} | 139 | \begin{tagmap}{}{} |
139 | \opt{h300,x5,ipodcolor,ipodvideo}{ | 140 | \opt{h300,x5,ipodcolor,ipodvideo}{ |
140 | \%X{\textbar}filename.bmp{\textbar} | 141 | \config{\%X{\textbar}filename.bmp{\textbar}} |
141 | & Load and set a backdrop image for the WPS. % | 142 | & Load and set a backdrop image for the WPS. % |
142 | This image must be exactly the same size as your LCD.\\ | 143 | This image must be exactly the same size as your LCD.\\ |
143 | } | 144 | } |
144 | \%P{\textbar}filename.bmp{\textbar} | 145 | \config{\%P{\textbar}filename.bmp{\textbar}} |
145 | & Load a Progress bar image for the WPS. Use \%pb tag to show the | 146 | & Load a Progress bar image for the WPS. Use \config{\%pb} tag to show the |
146 | progress bar\\ | 147 | progress bar\\ |
147 | \%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar} | 148 | \config{\%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}} |
148 | & Load and display an image\\ | 149 | & Load and display an image\\ |
149 | & n: image ID (a-z and A-Z)\\ | 150 | & \config{n}: image ID (a-z and A-Z)\\ |
150 | & filename: filename relative to \fname{/.rockbox/} and including .bmp\\ | 151 | & \config{filename}: filename relative to \fname{/.rockbox/} and including .bmp\\ |
151 | & x: x coordinate\\ | 152 | & \config{x}: x coordinate\\ |
152 | & y: y coordinate.\\ | 153 | & \config{y}: y coordinate.\\ |
153 | \%xl{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar} | 154 | \config{\%xl{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}} |
154 | & Preload an image for later display\\ | 155 | & Preload an image for later display\\ |
155 | & n: image ID (a-z and A-Z)\\ | 156 | & \config{n}: image ID (a-z and A-Z)\\ |
156 | & filename: filename relative to \fname{/.rockbox/} and including .bmp\\ | 157 | & \config{filename}: filename relative to \fname{/.rockbox/} and including .bmp\\ |
157 | & x: x coordinate\\ | 158 | & \config{x}: x coordinate\\ |
158 | & y: y coordinate.\\ | 159 | & \config{y}: y coordinate.\\ |
159 | \%xdn & Display a preloaded image\\ | 160 | \config{\%xdn} & Display a preloaded image\\ |
160 | & n: image ID (a-z and A-Z)\\ | 161 | & \config{n}: image ID (a-z and A-Z)\\ |
161 | \end{tagmap} | 162 | \end{tagmap} |
162 | 163 | ||
163 | Example: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\ | 164 | Example: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\ |
164 | \%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar} | 165 | \config{\%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar}} |
165 | 166 | ||
166 | \note{ | 167 | \note{ |
167 | \begin{itemize} | 168 | \begin{itemize} |
@@ -176,9 +177,9 @@ Example: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\ | |||
176 | 177 | ||
177 | \section{Alignment} | 178 | \section{Alignment} |
178 | \begin{tagmap}{}{} | 179 | \begin{tagmap}{}{} |
179 | \%al & Text is left aligned\\ | 180 | \config{\%al} & Text is left aligned\\ |
180 | \%ac & Text is center aligned\\ | 181 | \config{\%ac} & Text is center aligned\\ |
181 | \%ar & Text is right aligned\\ | 182 | \config{\%ar} & Text is right aligned\\ |
182 | \end{tagmap} | 183 | \end{tagmap} |
183 | All alignment tags may be present in one line, but they need to be in the | 184 | All alignment tags may be present in one line, but they need to be in the |
184 | order left -- center -- right. If the aligned texts overlap, they are merged. | 185 | order left -- center -- right. If the aligned texts overlap, they are merged. |
@@ -186,23 +187,23 @@ order left -- center -- right. If the aligned texts overlap, they are merged. | |||
186 | \section{Conditional Tags} | 187 | \section{Conditional Tags} |
187 | 188 | ||
188 | \begin{tagmap}{}{} | 189 | \begin{tagmap}{}{} |
189 | \%?xx{\textless}true{\textbar}false{\textgreater} | 190 | \config{\%?xx{\textless}true{\textbar}false{\textgreater}} |
190 | & If / Else: Evaluate for true or false case \\ | 191 | & If / Else: Evaluate for true or false case \\ |
191 | \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater} | 192 | \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} |
192 | & Enumerations: Evaluate for first / second / third / \dots / last condition \\ | 193 | & Enumerations: Evaluate for first / second / third / \dots / last condition \\ |
193 | \end{tagmap} | 194 | \end{tagmap} |
194 | 195 | ||
195 | \section{Other Tags} | 196 | \section{Other Tags} |
196 | \begin{tagmap}{}{} | 197 | \begin{tagmap}{}{} |
197 | \%\% & Display a `\%'\\ | 198 | \config{\%\%} & Display a `\%'\\ |
198 | \%{\textless} & Display a `{\textless}'\\ | 199 | \config{\%{\textless}} & Display a `{\textless}'\\ |
199 | \%{\textbar} & Display a `{\textbar}'\\ | 200 | \config{\%{\textbar}} & Display a `{\textbar}'\\ |
200 | \%{\textgreater} & Display a `{\textgreater}'\\ | 201 | \config{\%{\textgreater}} & Display a `{\textgreater}'\\ |
201 | \%; & Display a `;'\\ | 202 | \config{\%;} & Display a `;'\\ |
202 | \%s & Indicate that the line should scroll. Can occur anywhere in | 203 | \config{\%s} & Indicate that the line should scroll. Can occur |
203 | a line (given that the text is displayed; see conditionals | 204 | anywhere in a line (given that the text is |
204 | above). You can specify up to 10 scrolling lines. Scrolling | 205 | displayed; see conditionals above). You can specify |
205 | lines can not contain dynamic content such as timers, | 206 | up to 10 scrolling lines. Scrolling lines can not |
206 | peak meters or progress bars.\\ | 207 | contain dynamic content such as timers, peak meters |
208 | or progress bars.\\ | ||
207 | \end{tagmap} | 209 | \end{tagmap} |
208 | |||
diff --git a/manual/preamble.tex b/manual/preamble.tex index 9f6fd5ca73..fd1e32165b 100644 --- a/manual/preamble.tex +++ b/manual/preamble.tex | |||
@@ -202,3 +202,4 @@ | |||
202 | 202 | ||
203 | \newcommand{\setting}[1]{\textsc{#1}} | 203 | \newcommand{\setting}[1]{\textsc{#1}} |
204 | 204 | ||
205 | \newcommand{\config}[1]{\texttt{#1}} \ No newline at end of file | ||