diff options
author | Alex Parker <rockbox@aeparker.com> | 2009-09-20 17:03:11 +0000 |
---|---|---|
committer | Alex Parker <rockbox@aeparker.com> | 2009-09-20 17:03:11 +0000 |
commit | 9cbf1c3886cee9a6a9c59698c17d4214ca6e6aae (patch) | |
tree | 991a2f41d191249327e8da228271da8078e38675 /manual/appendix | |
parent | 7e229f9c50e14ee059be9a746d67ceba1c2db96e (diff) | |
download | rockbox-9cbf1c3886cee9a6a9c59698c17d4214ca6e6aae.tar.gz rockbox-9cbf1c3886cee9a6a9c59698c17d4214ca6e6aae.zip |
Port r22756 to the 3.4 branch - Add viewports to the manual. Adapted from FS#9934 by Jonas Häggqvist and FS#10553 by David Kauffmann.
git-svn-id: svn://svn.rockbox.org/rockbox/branches/v3_4@22757 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/appendix')
-rw-r--r-- | manual/appendix/wps_tags.tex | 39 |
1 files changed, 31 insertions, 8 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 9be085d01a..7c4fd5418a 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -27,7 +27,33 @@ Remember that this information is not always available, so use the | |||
27 | conditionals to show alternate information in preference to assuming. | 27 | conditionals to show alternate information in preference to assuming. |
28 | 28 | ||
29 | These tags, when written with a capital ``I'' (e.g. \config{\%Ia} or \config{\%Ic}), | 29 | These tags, when written with a capital ``I'' (e.g. \config{\%Ia} or \config{\%Ic}), |
30 | produce the information for the next song to be played. | 30 | show the information for the next song to be played. |
31 | |||
32 | \nopt{lcd_charcell}{ | ||
33 | \section{Viewports} | ||
34 | \begin{table} | ||
35 | \begin{tagmap}{}{} | ||
36 | \nopt{lcd_non-mono}{~% | ||
37 | \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}% | ||
38 | [height]{\textbar}[font]{\textbar}} | ||
39 | & (see section \ref{ref:Viewports})\\} | ||
40 | |||
41 | \nopt{lcd_color}{\opt{lcd_non-mono}{% | ||
42 | \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}% | ||
43 | [height]{\textbar}[font]{\textbar}[fgshade]{\textbar}[bgshade]{\textbar}} | ||
44 | & (see section \ref{ref:Viewports})\\}} | ||
45 | |||
46 | \opt{lcd_color}{% | ||
47 | \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}% | ||
48 | [height]{\textbar}[font]{\textbar}[fgcolour]{\textbar}[bgcolour]{\textbar}} | ||
49 | & (see section \ref{ref:Viewports})\\} | ||
50 | |||
51 | \config{\%Vd'identifier'} & Display the 'identifier' viewport. E.g. | ||
52 | \config{\%?C{\textless}\%C\%Vda{\textbar}\%Vdb{\textgreater}} | ||
53 | will show viewport 'a' if album art is found, and 'b' if it isn't.\\ | ||
54 | \end{tagmap} | ||
55 | \end{table} | ||
56 | } | ||
31 | 57 | ||
32 | \section{Power Related Information} | 58 | \section{Power Related Information} |
33 | \begin{table} | 59 | \begin{table} |
@@ -91,9 +117,9 @@ produce the information for the next file to be played. | |||
91 | that empties as the time progresses.} | 117 | that empties as the time progresses.} |
92 | \opt{lcd_bitmap}{ | 118 | \opt{lcd_bitmap}{ |
93 | & This will replace the entire line with a progress bar. \\ | 119 | & This will replace the entire line with a progress bar. \\ |
94 | & You can set the height, position and width of the progressbar % | 120 | & You can set the position, width and height of the progressbar % |
95 | (in pixels): \config{\%pb{\textbar}height{\textbar}leftpos% | 121 | (in pixels) and load a custom image for it: % |
96 | {\textbar}rightpos{\textbar}toppos{\textbar}}} \\ | 122 | \config{\%pb{\textbar}image.bmp{\textbar}x{\textbar}y{\textbar}width{\textbar}height{\textbar}}} \\ |
97 | \opt{player}{% | 123 | \opt{player}{% |
98 | \config{\%pf} & Full-line progress bar \& time display\\ | 124 | \config{\%pf} & Full-line progress bar \& time display\\ |
99 | }% | 125 | }% |
@@ -231,7 +257,7 @@ Examples: | |||
231 | 257 | ||
232 | 258 | ||
233 | \opt{lcd_bitmap}{ | 259 | \opt{lcd_bitmap}{ |
234 | \section{Images} | 260 | \section{\label{ref:wps_images}Images} |
235 | \begin{table} | 261 | \begin{table} |
236 | \begin{tagmap}{}{} | 262 | \begin{tagmap}{}{} |
237 | \nopt{archos}{% | 263 | \nopt{archos}{% |
@@ -239,9 +265,6 @@ Examples: | |||
239 | & Load and set a backdrop image for the WPS. | 265 | & Load and set a backdrop image for the WPS. |
240 | This image must be exactly the same size as your LCD.\\ | 266 | This image must be exactly the same size as your LCD.\\ |
241 | }% | 267 | }% |
242 | \config{\%P{\textbar}filename.bmp{\textbar}} | ||
243 | & Load a Progress Bar image for the WPS. Use \config{\%pb} tag to show the | ||
244 | progress bar\\ | ||
245 | \config{\%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}} | 268 | \config{\%x{\textbar}n{\textbar}filename{\textbar}x{\textbar}y{\textbar}} |
246 | & Load and display an image\\ | 269 | & Load and display an image\\ |
247 | & \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\\ | 270 | & \config{n}: image ID (a-z and A-Z) for later referencing in \config{\%xd}\\ |