summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2006-06-07 17:09:06 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2006-06-07 17:09:06 +0000
commitf949c8e3e1bed05ad8d984985348f3a31c3bb02a (patch)
tree8385a4988c66b84d4f9a5b169a05f2825c252ad9
parent68e40170f2c943318cefcb4c446db846a6659a9c (diff)
downloadrockbox-f949c8e3e1bed05ad8d984985348f3a31c3bb02a.tar.gz
rockbox-f949c8e3e1bed05ad8d984985348f3a31c3bb02a.zip
Remove some superfluous line breaks. Use itemize where appropriate.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10085 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/advanced_topics/main.tex71
1 files changed, 32 insertions, 39 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 4b51325715..41b52e0367 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -46,8 +46,9 @@ the information displayed on the \daps\ screen whilst an audio track is
46being played. The default WPS is a relatively simple screen displaying 46being played. The default WPS is a relatively simple screen displaying
47Track name, Artist, Album etc. in the default font as a purely text based 47Track name, Artist, Album etc. in the default font as a purely text based
48layout. There are a number of WPS files included in Rockbox, and you can 48layout. There are a number of WPS files included in Rockbox, and you can
49load one of these at anytime by selecting it\dots\\ 49load one of these at anytime by selecting it in
50\setting{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}\\ 50\setting{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}.
51
51\opt{h1xx,h300}{There is a related option to browse \fname{.rwps} files for 52\opt{h1xx,h300}{There is a related option to browse \fname{.rwps} files for
52 \daps\ with LCD remote controls installed. This will load a similar WPS 53 \daps\ with LCD remote controls installed. This will load a similar WPS
53 screen for the remote but with usually a simpler and more concise layout.} 54 screen for the remote but with usually a simpler and more concise layout.}
@@ -72,21 +73,21 @@ encoding. This can be done in most editors, for example Notepad in Windows 2000
72or XP (but not in 9x/ME) can do this. See appendix \ref{ref:wps_tags} for all 73or XP (but not in 9x/ME) can do this. See appendix \ref{ref:wps_tags} for all
73the tags that are available. 74the tags that are available.
74 75
75\begin{description} 76\begin{itemize}
76 \item All characters not preceded by \% are displayed as typed. 77 \item All characters not preceded by \% are displayed as typed.
77 \item Lines beginning with \# are comments and will be ignored. 78 \item Lines beginning with \# are comments and will be ignored.
78 \item Maximum file size used is 79 \item Maximum file size used is
79 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600} 80 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600}
80 \opt{player}{400} bytes.\\ 81 \opt{player}{400} bytes.
81 If you have a bigger WPS file, only the first part of it will be 82 If you have a bigger WPS file, only the first part of it will be
82 loaded and used. 83 loaded and used.
83\end{description} 84\end{itemize}
84 85
85\subsubsection{Conditional Tags} 86\subsubsection{Conditional Tags}
86 87
87\begin{description} 88\begin{description}
88\item[If/else: ] 89\item[If/else: ]
89Syntax: \config{\%?xx{\textless}true{\textbar}false{\textgreater}}\\ 90Syntax: \config{\%?xx{\textless}true{\textbar}false{\textgreater}}
90 91
91If the tag specified by ``\config{xx}'' has a value, the text between the 92If the tag specified by ``\config{xx}'' has a value, the text between the
92``\config{{\textless}}'' and the ``\config{{\textbar}}'' is displayed (the true 93``\config{{\textless}}'' and the ``\config{{\textbar}}'' is displayed (the true
@@ -97,11 +98,10 @@ specified if no else part is desired. The conditionals nest, so the text in the
97if and else part can contain all \config{\%} commands, including conditionals. 98if and else part can contain all \config{\%} commands, including conditionals.
98 99
99\item[Enumerations: ] 100\item[Enumerations: ]
100Syntax: \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}}\\ 101Syntax: \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}}
101 102
102For tags with multiple values, like Play status, the conditional can hold a 103For tags with multiple values, like Play status, the conditional can hold a
103list of alternatives, one for each value the tag can have. 104list of alternatives, one for each value the tag can have.
104
105Example enumeration: 105Example enumeration:
106\begin{example} 106\begin{example}
107 \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater} 107 \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}
@@ -117,12 +117,12 @@ You can display information about the next song -- the song that is
117about to play after the one currently playing (unless you change the 117about to play after the one currently playing (unless you change the
118plan). 118plan).
119 119
120If you use the upper--case versions of the 120If you use the upper-case versions of the
121three tags: \config{F}, \config{I} and \config{D}, they will instead refer to 121three tags: \config{F}, \config{I} and \config{D}, they will instead refer to
122the next song instead of the current one. Example: \config{\%Ig} is the genre 122the next song instead of the current one. Example: \config{\%Ig} is the genre
123name used in the next song and \config{\%Ff} is the mp3 frequency. 123name used in the next song and \config{\%Ff} is the mp3 frequency.
124 124
125\note{The next song information WILL NOT be available at all 125\note{The next song information \emph{will not} be available at all
126times, but will most likely be available at the end of a song. We 126times, but will most likely be available at the end of a song. We
127suggest you use the conditional display tag a lot when displaying 127suggest you use the conditional display tag a lot when displaying
128information about the next song!} 128information about the next song!}
@@ -141,20 +141,18 @@ time (in seconds and optional tenths of a second) for the subline to be
141displayed. 141displayed.
142 142
143Subline related special characters and tags: 143Subline related special characters and tags:
144 144\begin{description}
145\config{;} : Split items on a line into separate sublines 145\item[;] Split items on a line into separate sublines
146 146\item[\%t] Set the subline display time. The
147\config{\%t} : Set the subline display time. The
148'\config{\%t}' is followed by either integer 147'\config{\%t}' is followed by either integer
149seconds (\config{\%t5}), or seconds and tenths of a second (\config{\%t3.5}). 148seconds (\config{\%t5}), or seconds and tenths of a second (\config{\%t3.5}).
149\end{description}
150 150
151Each alternating subline can still be optionally scrolled while it is 151Each alternating subline can still be optionally scrolled while it is
152being displayed, and scrollable formats can be displayed on the same 152being displayed, and scrollable formats can be displayed on the same
153line with non{}-scrollable formats (such as track elapsed time) as long 153line with non{}-scrollable formats (such as track elapsed time) as long
154as they are separated into different sublines. 154as they are separated into different sublines.
155
156Example subline definition: 155Example subline definition:
157
158\begin{example} 156\begin{example}
159 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds, 157 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds,
160 Display id3 title for 2 seconds, 158 Display id3 title for 2 seconds,
@@ -165,30 +163,25 @@ Example subline definition:
165 163
166Conditionals can be used with sublines to display a different set and/or number 164Conditionals can be used with sublines to display a different set and/or number
167of sublines on the line depending on the evaluation of the conditional. 165of sublines on the line depending on the evaluation of the conditional.
168
169Example subline with conditionals: 166Example subline with conditionals:
170
171\begin{example} 167\begin{example}
172 %?it{\textless}%t8%s%it{\textbar}%s%fn{\textgreater};%?ia{\textless}%t3%s%ia{\textbar}%t0{\textgreater}\\ 168 %?it{\textless}%t8%s%it{\textbar}%s%fn{\textgreater};%?ia{\textless}%t3%s%ia{\textbar}%t0{\textgreater}\\
173\end{example} 169\end{example}
174 170
175The format above will do two different things depending if ID3 tags are 171The format above will do two different things depending if ID3 tags are
176present. If the ID3 artist and title are present: 172present. If the ID3 artist and title are present:
177 173\begin{itemize}
178Display id3 title for 8 seconds,\\ 174\item Display id3 title for 8 seconds,
179 175\item Display id3 artist for 3 seconds,
180Display id3 artist for 3 seconds,\\ 176\item repeat\dots
181 177\end{itemize}
182repeat...\\ 178If the ID3 artist and title are not present:
183 179\begin{itemize}
184If the ID3 artist and title are not present:\\ 180\item Display the filename continuously.
185 181\end{itemize}
186Display the filename continuously.\\
187
188Note that by using a subline display time of 0 in one branch of a conditional, 182Note that by using a subline display time of 0 in one branch of a conditional,
189a subline can be skipped (not displayed) when that condition is met. 183a subline can be skipped (not displayed) when that condition is met.
190 184
191
192\subsubsection{Using Images} 185\subsubsection{Using Images}
193You can have as many as 52 images in your WPS. There are various ways of 186You can have as many as 52 images in your WPS. There are various ways of
194displaying images: 187displaying images:
@@ -205,27 +198,27 @@ displaying images:
205\optv{HAVE_LCD_COLOR}{ 198\optv{HAVE_LCD_COLOR}{
206 Example on background image use: 199 Example on background image use:
207 \begin{example} 200 \begin{example}
208 %X|background.bmp|\\ 201 %X|background.bmp|
209 \end{example} 202 \end{example}
210 The image with filename \fname{background.bmp} is loaded and used in the WPS. 203 The image with filename \fname{background.bmp} is loaded and used in the WPS.
211} 204}
212 205
213Example on bitmap preloading and use: 206Example on bitmap preloading and use:
214\begin{example} 207\begin{example}
215 \%x|a|static\_icon.bmp|50|50|\\ 208 %x|a|static_icon.bmp|50|50|
216 \%xl|b|rep\_off.bmp|16|64|\\ 209 %xl|b|rep\_off.bmp|16|64|
217 \%xl|c|rep\_all.bmp|16|64|\\ 210 %xl|c|rep\_all.bmp|16|64|
218 \%xl|d|rep\_one.bmp|16|64|\\ 211 %xl|d|rep\_one.bmp|16|64|
219 \%xl|e|rep\_shuffle.bmp|16|64|\\ 212 %xl|e|rep\_shuffle.bmp|16|64|
220 \%?mm<%xdb|%xdc|%xdd|%xde>\\ 213 %?mm<%xdb|%xdc|%xdd|%xde>
221\end{example} 214\end{example}
222Four images at the same x and y position are preloaded in the example. Which 215Four images at the same x and y position are preloaded in the example. Which
223image to display is determined by the \config{\%mm} tag (the repeat mode). 216image to display is determined by the \config{\%mm} tag (the repeat mode).
224 217
225\subsubsection{Example File} 218\subsubsection{Example File}
226\begin{example} 219\begin{example}
227 \%s\%?in<\%in - >\%?it<\%it|\%fn> \%?ia<[\%ia\%?id<, \%id>]> 220 %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]>
228 \%pb\%pc/\%pt 221 %pb%pc/%pt
229\end{example} 222\end{example}
230That is, ``tracknum -- title [artist, album]'', where most fields are only 223That is, ``tracknum -- title [artist, album]'', where most fields are only
231displayed if available. Could also be rendered as ``filename'' or ``tracknum -- 224displayed if available. Could also be rendered as ``filename'' or ``tracknum --