summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/appendix/wps_tags.tex26
1 files changed, 18 insertions, 8 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 1036da875c..f7965e7e02 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -175,7 +175,7 @@ Ffwd{\textbar}Rew{\textgreater}}
175 \begin{tagmap}{}{} 175 \begin{tagmap}{}{}
176 \nopt{archos}{% 176 \nopt{archos}{%
177 \config{\%X{\textbar}filename.bmp{\textbar}} 177 \config{\%X{\textbar}filename.bmp{\textbar}}
178 & Load and set a backdrop image for the WPS. % 178 & Load and set a backdrop image for the WPS.
179 This image must be exactly the same size as your LCD.\\ 179 This image must be exactly the same size as your LCD.\\
180 }% 180 }%
181 \config{\%P{\textbar}filename.bmp{\textbar}} 181 \config{\%P{\textbar}filename.bmp{\textbar}}
@@ -183,24 +183,34 @@ Ffwd{\textbar}Rew{\textgreater}}
183 progress bar\\ 183 progress bar\\
184 \config{\%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}} 184 \config{\%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}}
185 & Load and display an image\\ 185 & Load and display an image\\
186 & \config{n}: image ID (a-z and A-Z)\\ 186 & \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\\
187 & \config{filename}: filename relative to \fname{/.rockbox/} and including .bmp\\ 187 & \config{filename}: filename relative to \fname{/.rockbox/} and including .bmp\\
188 & \config{x}: x coordinate\\ 188 & \config{x}: x coordinate\\
189 & \config{y}: y coordinate.\\ 189 & \config{y}: y coordinate.\\
190 \config{\%xl{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}} 190 \config{\%xl{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}[nimages{\textbar}]}
191 & Preload an image for later display\\ 191 & Preload an image for later display (useful for when your images are displayed conditionally)\\
192 & \config{n}: image ID (a-z and A-Z)\\ 192 & \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\\
193 & \config{filename}: filename relative to \fname{/.rockbox/} and including .bmp\\ 193 & \config{filename}: filename relative to \fname{/.rockbox/} and including .bmp\\
194 & \config{x}: x coordinate\\ 194 & \config{x}: x coordinate\\
195 & \config{y}: y coordinate.\\ 195 & \config{y}: y coordinate.\\
196 \config{\%xdn} & Display a preloaded image\\ 196 & \config{nimages}: (optional) number of sub-images (tiled vertically, of the same height)
197 & \config{n}: image ID (a-z and A-Z)\\ 197 contained in the bitmap. Default is 1.\\
198 \config{\%xdn[i]} & Display a preloaded image\\
199 & \config{n}: image ID (a-z and A-Z) as it was specified in \config{\%x} or \config{\%xl}\\
200 & \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52).
201 By default the first (i.e. top most) sub-image will be used.\\
198 \end{tagmap} 202 \end{tagmap}
199\end{table} 203\end{table}
200 204
201Example: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\ 205Example 1: image \fname{/.rockbox/bg.bmp} with ID ``a'' at 37, 109 would be:\\
202\config{\%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar}} 206\config{\%x{\textbar}a{\textbar}bg.bmp{\textbar}37{\textbar}109{\textbar}}
203 207
208Example 2: loads a bitmap strip containing 10 volume icon images (all the same size),
209and then references the individual sub-images in a conditional:\\
210\config{\%xl{\textbar}M{\textbar}volume.bmp{\textbar}134{\textbar}153{\textbar}10{\textbar}}\\
211\config{\?pv<\%xdMa{\textbar}\%xdMb{\textbar}\%xdMc{\textbar}\%xdMd{\textbar}\%xdMe{\textbar}\%xdMf{\textbar}\%xdMg{\textbar}\%xdMh{\textbar}\%xdMi{\textbar}\%xdMj>}
212
213
204\note{ 214\note{
205 \begin{itemize} 215 \begin{itemize}
206 \item The images must be in a rockbox compatible format (1 bit per pixel BMP) 216 \item The images must be in a rockbox compatible format (1 bit per pixel BMP)