diff options
author | Martin Arver <martin.arver@gmail.com> | 2006-03-23 14:11:52 +0000 |
---|---|---|
committer | Martin Arver <martin.arver@gmail.com> | 2006-03-23 14:11:52 +0000 |
commit | 94c1289da7daf480850241b3081a8863b17733e9 (patch) | |
tree | 9af365bcffc639272e33a4ad41f952781196a0e3 /manual/appendix | |
parent | e7463a45baba2da0498e4aec619f72e7a74fced3 (diff) | |
download | rockbox-94c1289da7daf480850241b3081a8863b17733e9.tar.gz rockbox-94c1289da7daf480850241b3081a8863b17733e9.zip |
Move WPS tag definitions to the appendix
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9206 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/appendix')
-rw-r--r-- | manual/appendix/appendix.tex | 19 | ||||
-rw-r--r-- | manual/appendix/wps_tags.tex | 205 |
2 files changed, 224 insertions, 0 deletions
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex index b0d1211587..997aef6650 100644 --- a/manual/appendix/appendix.tex +++ b/manual/appendix/appendix.tex | |||
@@ -21,6 +21,25 @@ | |||
21 | \end{tabular} | 21 | \end{tabular} |
22 | \end{center} | 22 | \end{center} |
23 | 23 | ||
24 | \chapter{\label{ref:wps_tags}WPS Tags} | ||
25 | \input{appendix/wps_tags.tex} | ||
26 | |||
27 | \chapter{LCD Screen Sizes} | ||
28 | \begin{center} | ||
29 | \begin{tabular}{@{}lll@{}}\toprule | ||
30 | \textbf{Player} & \textbf{Main LCD Size} & \textbf{Remote LCD Size}\\\midrule | ||
31 | iriver H1x0 & 160x128 & 128x64\\ | ||
32 | iriver H3x0 & 220x176 & 128x64\\ | ||
33 | Archos Recorders & 112x64 & \\ | ||
34 | Archos Ondio & 112x64 & \\ | ||
35 | iPod Nano & 176x132 & \\ | ||
36 | iPod 4G Color & 220x176 & \\ | ||
37 | iPod 5G Video & 320x240 & \\ | ||
38 | iAudio X5 & 160x128 & \\\bottomrule | ||
39 | \end{tabular} | ||
40 | \end{center} | ||
41 | |||
42 | |||
24 | \chapter{User feedback} | 43 | \chapter{User feedback} |
25 | \section{Bug reports} | 44 | \section{Bug reports} |
26 | If you experience inappropriate performance from any supported feature, | 45 | If you experience inappropriate performance from any supported feature, |
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex new file mode 100644 index 0000000000..4a812f26de --- /dev/null +++ b/manual/appendix/wps_tags.tex | |||
@@ -0,0 +1,205 @@ | |||
1 | \subsubsection{Status Bar} | ||
2 | \begin{tabular}{@{}ll@{}}\toprule | ||
3 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
4 | \%we & Status Bar Enabled\\ | ||
5 | \%wd & Status Bar Disabled\\\bottomrule | ||
6 | \end{tabular} | ||
7 | \newline | ||
8 | \newline | ||
9 | These tags override the player setting for the display of the status bar, they must be on their own line. | ||
10 | |||
11 | \subsubsection{ID3 Info} | ||
12 | |||
13 | \begin{tabular}{@{}ll@{}}\toprule | ||
14 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
15 | \%ia & ID3 Artist\\ | ||
16 | \%ic & ID3 Composer\\ | ||
17 | \%id & ID3 Album Name\\ | ||
18 | \%ig & ID3 Genre Name\\ | ||
19 | \%in & ID3 Track Number\\ | ||
20 | \%it & ID3 Track Title\\ | ||
21 | \%iv & ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)\\ | ||
22 | \%iy & ID3 Year\\\bottomrule | ||
23 | \end{tabular} | ||
24 | \newline | ||
25 | \newline | ||
26 | Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming. | ||
27 | |||
28 | \subsubsection{Battery Info} | ||
29 | |||
30 | \begin{tabular}{@{}ll@{}}\toprule | ||
31 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
32 | \%bl & Show numeric battery level in percent.\\ | ||
33 | & Can also be used in a conditional: \%?bl{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textgreater}\\ | ||
34 | \%bv & Show the battery level in volts\\ | ||
35 | \%bt & Show estimated battery time left\\ | ||
36 | \%bp & "p" if the charger is connected \\ | ||
37 | & (only on targets that can charge batteries)\\ | ||
38 | \%bc & "c" if the unit is currently charging the battery\\ | ||
39 | & (only on targets that have software charge control or monitoring)\\\bottomrule | ||
40 | \end{tabular} | ||
41 | |||
42 | \subsubsection{File Info} | ||
43 | |||
44 | \begin{tabular}{@{}ll@{}}\toprule | ||
45 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
46 | \%fb & File Bitrate (in kbps)\\ | ||
47 | \%fc & File Codec (e.g. "MP3" or "FLAC")\\ | ||
48 | & This tag can also be used in a conditional tag,\\ | ||
49 | & \%?fc{\textless}mp1{\textbar}mp2{\textbar}mp3{\textbar}wav{\textbar}vorbis{\textbar}flac{\textbar}mpc{\textbar}a52{\textbar}wavpack{\textbar}unknown{\textgreater}\\ | ||
50 | & The codec order is as follows: MP1, MP2, MP3, WAV, Ogg Vorbis (OGG),\\ | ||
51 | & FLAC, MPC, AC3, WavPack (WV), ALAC, AAC, Shorten (SHN), AIFF\\ | ||
52 | \%ff & File Frequency (in Hz)\\ | ||
53 | \%fm & File Name\\ | ||
54 | \%fn & File Name (without extension)\\ | ||
55 | \%fp & File Path\\ | ||
56 | \%fs & File Size (In Kilobytes)\\ | ||
57 | \%fv & "(avg)" if variable bit rate or "" if constant bit rate\\ | ||
58 | \%d1 & First directory from end of file path.\\ | ||
59 | \%d2 & Second directory from end of file path.\\ | ||
60 | \%d3 & Third directory from end of file path.\\\bottomrule | ||
61 | \end{tabular} | ||
62 | \newline | ||
63 | \newline | ||
64 | Example for the the \%dN commands: If the path is "/Rock/Kent/Isola/11 - 747.mp3", \%d1 is "Isola", \%d2 is "Kent"... You get the picture. | ||
65 | |||
66 | \subsubsection{Playlist/Song Info} | ||
67 | |||
68 | \begin{tabular}{@{}ll@{}}\toprule | ||
69 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
70 | \%pb & Progress Bar\\ | ||
71 | \opt{player}{ | ||
72 | & This will display a 1 character "cup"\\ | ||
73 | & that empties as the time progresses.} | ||
74 | \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodnano}{ | ||
75 | & This will replace the entire line with a progress bar. \\ | ||
76 | & You can set the height, position and width of the progressbar\\ | ||
77 | & (in pixels): \%pb{\textbar}height{\textbar}leftpos{\textbar}rightpos{\textbar}} \\ | ||
78 | \%pf & Player: Full-line progress bar + time display\\ | ||
79 | \%pc & Current Time In Song\\ | ||
80 | \%pe & Total Number of Playlist Entries\\ | ||
81 | \%pm & Peak Meter (Recorder only) The entire line is used as volume peak meter.\\ | ||
82 | \%pn & Playlist Name (Without path or extension)\\ | ||
83 | \%pp & Playlist Position\\ | ||
84 | \%pr & Remaining Time In Song\\ | ||
85 | \%ps & Shuffle. Shows 's' if shuffle mode is enabled.\\ | ||
86 | \%pt & Total Track Time\\ | ||
87 | \%pv & Current volume. Can also be used in a conditional: \\ | ||
88 | & \%?pv{\textless}0{\textbar}1{\textbar}2{\textbar}3{\textbar}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}10{\textgreater}\\\bottomrule | ||
89 | \end{tabular} | ||
90 | |||
91 | \subsubsection{Runtime Database} | ||
92 | |||
93 | \begin{tabular}{@{}ll@{}}\toprule | ||
94 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
95 | \%rp & Song playcount\\ | ||
96 | \%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}4{\textbar}5{\textbar}6{\textbar}7{\textbar}8{\textbar}9{\textbar}10{\textgreater}\\\bottomrule | ||
98 | \end{tabular} | ||
99 | |||
100 | \opt{h1xx,h300}{ | ||
101 | \subsubsection{Hold Switches} | ||
102 | |||
103 | \begin{tabular}{@{}ll@{}}\toprule | ||
104 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
105 | \%mh & "h" if the main unit hold switch is on\\ | ||
106 | \%mr & "r" if the remote hold switch is on\\\bottomrule | ||
107 | \end{tabular} | ||
108 | } | ||
109 | |||
110 | \subsubsection{Virtual LED} | ||
111 | |||
112 | \begin{tabular}{@{}ll@{}}\toprule | ||
113 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
114 | \%lh & "h" if there is hard disk activity\\\bottomrule | ||
115 | \end{tabular} | ||
116 | |||
117 | \subsubsection{Repeat Mode} | ||
118 | |||
119 | \begin{tabular}{@{}ll@{}}\toprule | ||
120 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
121 | \%mm & Repeat mode, 0-4, in the order: Off, All, One, Shuffle, \opt{player,recorder,recorderv2fm}{A-B}\\\bottomrule | ||
122 | \end{tabular} | ||
123 | \newline | ||
124 | \newline | ||
125 | Example: \%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle{\textbar}A-B{\textgreater} | ||
126 | |||
127 | \subsubsection{Playback Mode Tags} | ||
128 | |||
129 | \begin{tabular}{@{}ll@{}}\toprule | ||
130 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
131 | \%mp & Play status, 0-4, in the order: Stop, Play, Pause, Fast forward, Rewind\\\bottomrule | ||
132 | \end{tabular} | ||
133 | \newline | ||
134 | \newline | ||
135 | Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater} | ||
136 | |||
137 | \subsubsection{Images} | ||
138 | |||
139 | \begin{tabular}{@{}ll@{}}\toprule | ||
140 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
141 | \%X{\textbar}filename.bmp{\textbar} & Load and set a backdrop image for the WPS.\\ | ||
142 | & This image must be exactly the same size as your LCD.\\ | ||
143 | \%P{\textbar}filename.bmp{\textbar} & Load a Progress bar image for the WPS.\\ | ||
144 | & Use \%pb tag to show the progress bar\\ | ||
145 | \%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar} & Load and display an image\\ | ||
146 | & n = image ID (a-z and A-Z)\\ | ||
147 | & filename = filename (relative to /.rockbox/ and including .bmp)\\ | ||
148 | & x = x coordinate\\ | ||
149 | & y = y coordinate.\\ | ||
150 | \%xl{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar} & Preload an image for later display\\ | ||
151 | & n = image ID (a-z and A-Z)\\ | ||
152 | & filename = filename (relative to /.rockbox/ and including .bmp)\\ | ||
153 | & x = x coordinate\\ | ||
154 | & y = y coordinate.\\ | ||
155 | \%xdn & Display a preloaded image\\ | ||
156 | |||
157 | & n = image ID (a-z and A-Z)\\\bottomrule | ||
158 | \end{tabular} | ||
159 | \newline | ||
160 | \newline | ||
161 | Example: image /.rockbox/bg.bmp with ID "a" at 37, 109 would be:\\ | ||
162 | \%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar} | ||
163 | |||
164 | \begin{itemize} | ||
165 | \item \textbf{Note:} The images must be in a rockbox compatible format (1 bit per pixel BMP) | ||
166 | \item \textbf{Note:} The image tag must be on its own line | ||
167 | \item \textbf{Note:} The ID is case sensitive, giving 52 different ID's | ||
168 | \item \textbf{Note:} The size of the LCD screen for each player varies. See table below for appropriate sizes of each device. The x and y coordinates must repect each of the players' limits. | ||
169 | \end{itemize} | ||
170 | |||
171 | \subsubsection{Alignment} | ||
172 | |||
173 | \begin{tabular}{@{}lll@{}}\toprule | ||
174 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
175 | \%al & Text is left aligned\\ | ||
176 | \%ac & Text is center aligned\\ | ||
177 | \%ar & Text is right aligned\\\bottomrule | ||
178 | \end{tabular} | ||
179 | \newline | ||
180 | \newline | ||
181 | All alignment tags may be present in one line, but they need to be in the order left - center - right. If the aligned texts overlap, they are merged. | ||
182 | |||
183 | \subsubsection{Conditional Tags} | ||
184 | |||
185 | \textbf{If/else}\\ | ||
186 | |||
187 | Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\ | ||
188 | |||
189 | \textbf{Enumerations}\\ | ||
190 | |||
191 | Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\ | ||
192 | |||
193 | \subsection{Other Tags} | ||
194 | \begin{tabular}{@{}ll@{}}\toprule | ||
195 | \textbf{Tag} & \textbf{Description}\\\midrule | ||
196 | \%\% & Display a '\%'\\ | ||
197 | \%{\textless} & Display a '{\textless}'\\ | ||
198 | \%{\textbar} & Display a '{\textbar}'\\ | ||
199 | \%{\textgreater} & Display a '{\textgreater}'\\ | ||
200 | \%; & Display a ';'\\ | ||
201 | \%s & Indicate that the line should scroll. Can occur anywhere in a line\\ | ||
202 | & (given that the text is displayed; see conditionals above). \\ | ||
203 | & You can specify up to 10 scrolling lines. Scrolling lines can not \\ | ||
204 | & contain dynamic content such as timers, peak meters or progress bars. | ||
205 | \end{tabular} \ No newline at end of file | ||