summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-06-07 12:15:46 +0000
committerMartin Arver <martin.arver@gmail.com>2006-06-07 12:15:46 +0000
commit47ea9065350e8399018b62a57839debaab6c5212 (patch)
tree7689424193feab9717f1a706faf186c069609abb
parent0dd1f8ec11f28fe34c93ba97af95eb2be2fef44f (diff)
downloadrockbox-47ea9065350e8399018b62a57839debaab6c5212.tar.gz
rockbox-47ea9065350e8399018b62a57839debaab6c5212.zip
Introduce new example environment. Slight adjustment of the code env. Change fname to use texttt. Add fname to the firmwarefilename macro in the platform files. Cleanup of the advanced topics chapter. The archos flashing still needs attention.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10081 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/advanced_topics/main.tex182
-rw-r--r--manual/platform/h1xx.tex2
-rw-r--r--manual/platform/h300.tex2
-rw-r--r--manual/platform/ipod4g.tex2
-rw-r--r--manual/platform/ipodcolor.tex2
-rw-r--r--manual/platform/ipodmini.tex2
-rw-r--r--manual/platform/ipodnano.tex2
-rw-r--r--manual/platform/ipodvideo.tex2
-rw-r--r--manual/platform/ondiofm.tex2
-rw-r--r--manual/platform/ondiosp.tex2
-rw-r--r--manual/platform/player.tex2
-rw-r--r--manual/platform/recorder.tex2
-rw-r--r--manual/platform/recorderv2fm.tex2
-rw-r--r--manual/platform/x5.tex2
-rw-r--r--manual/preamble.tex27
15 files changed, 120 insertions, 115 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 6116fa8f7c..3152b0c668 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -6,26 +6,25 @@ Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of
6 6
7\opt{HAVE_LCD_BITMAP}{ 7\opt{HAVE_LCD_BITMAP}{
8 \subsection{\label{ref:Loadingfonts}Loading Fonts} 8 \subsection{\label{ref:Loadingfonts}Loading Fonts}
9 Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the \dap\ 9 Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the
10 and ``play'' them in the directory browser or select 10 \dap\ and ``play'' them in the directory browser or select
11 \emph{General Settings $\rightarrow$ Fonts} from the Main Menu. 11 \setting{General Settings $\rightarrow$ Fonts} from the Main Menu.
12 If you want a font to be loaded automatically every time you start up, 12 If you want a font to be loaded automatically every time you start up,
13 it must be located in the \fname{/.rockbox } folder and the file name 13 it must be located in the \fname{/.rockbox } folder and the filename
14 must be at most 24 characters long. 14 must be at most 24 characters long.
15 \warn{Advanced Users Only: Any BDF font file up to 16 pixels high should 15 \warn{Advanced Users Only: Any BDF font file up to 16 pixels high should
16 be usable with Rockbox. To convert from .bdf to .fnt, use the \fname{convbdf} 16 be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use the \fname{convbdf} tool. This tool can be found in the \fname{tools} directory
17 tool. This tool can be found in the tools directory of the Rockbox source 17 of the Rockbox source code.}
18 code.}
19} 18}
20 19
21\subsection{\label{ref:Loadinglanguages}Loading Languages} 20\subsection{\label{ref:Loadinglanguages}Loading Languages}
22Rockbox can load language files at runtime. Simply copy the .lng file 21Rockbox can load language files at runtime. Simply copy the \fname{.lng} file
23\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the 22\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
24Rockbox directory browser or select \emph{General Settings $\rightarrow$ 23Rockbox directory browser or select \setting{General Settings $\rightarrow$
25Languages }from the Main Menu. 24Languages }from the Main Menu.
26 25
27\note{If you want a language to be loaded automatically every time you start 26\note{If you want a language to be loaded automatically every time you start
28up, it must be located in the \fname{/.rockbox }folder and the file name must 27up, it must be located in the \fname{/.rockbox }folder and the filename must
29be a maximum of 24 characters long.} 28be a maximum of 24 characters long.}
30 29
31If your language is not yet supported and you want to write your own language 30If your language is not yet supported and you want to write your own language
@@ -38,35 +37,35 @@ file find the instructions on the Rockbox website:
38 37
39\begin{description} 38\begin{description}
40\item[Description: ] The WPS or While Playing Screen is the name used to describe 39\item[Description: ] The WPS or While Playing Screen is the name used to describe
41the information displayed on the \dap\'s screen whilst an audio track is 40the information displayed on the \daps\ screen whilst an audio track is
42being played. The default WPS is a relatively simple screen displaying 41being played. The default WPS is a relatively simple screen displaying
43Track name, Artist, Album etc. in the default font as a purely text based 42Track name, Artist, Album etc. in the default font as a purely text based
44layout. There are a number of WPS files included in Rockbox, and you can 43layout. There are a number of WPS files included in Rockbox, and you can
45load one of these at anytime by selecting it\dots\\ 44load one of these at anytime by selecting it\dots\\
46\emph{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}\\ 45\setting{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}\\
47\opt{h1xx,h300}{There is a related option to browse .rwps files for \dap\'s 46\opt{h1xx,h300}{There is a related option to browse \fname{.rwps} files for
48with LCD remote controls installed. This will load a similar WPS screen 47 \daps\ with LCD remote controls installed. This will load a similar WPS
49for the remote but with usually a simpler and more concise layout.} 48 screen for the remote but with usually a simpler and more concise layout.}
50 49
51\note{``Playing'' a wps from the file browser has the same effect.} 50\note{``Playing'' a \fname{.wps} from the file browser has the same effect.}
52 51
53\item [File Location: ]Custom WPS files may be located anywhere on the drive. 52\item [File Location: ]Custom WPS files may be located anywhere on the drive.
54The only restriction is that they must end in .wps. When you ``play'' a .wps 53The only restriction is that they must end in \fname{.wps}. When you ``play''
55file, it will be used for future WPS screens, and if the ``played'' .wps file is 54a \fname{.wps} file, it will be used for future WPS screens, and if the
56located in the \fname{/.rockbox} folder, it will be remembered and used after 55``played'' \fname{.wps} file is located in the \fname{/.rockbox} folder, it
57reboot. The .wps filename must be no more than 24 characters long for it to be 56will be remembered and used after reboot. The \fname{.wps} filename must be no
58remembered. 57more than 24 characters long for it to be remembered.
59\end{description} 58\end{description}
60 59
61\subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own} 60\subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own}
62Quite simply, enter the WPS code in your favourite text editor, Notepad on 61Quite simply, enter the WPS code in your favourite text editor, Notepad on
63Windows works fine. When you save it, instead of saving it as a .txt file, save 62Windows works fine. When you save it, instead of saving it as a \fname{.txt}
64it as a .wps file. Example: Instead of \fname{Rockbox.txt}, save the file as 63file, save it as a \fname{.wps} file. Example: Instead of \fname{Rockbox.txt},
65\fname{Rockbox.wps}. To make sure non english characters display correctly in 64save the file as \fname{Rockbox.wps}. To make sure non english characters
66your WPS you must save the .wps file with UTF-8 character encoding. This can be 65display correctly in your WPS you must save the .wps file with UTF-8 character
67done in most editors, for example Notepad in Windows 2000 or XP (but not in 66encoding. This can be done in most editors, for example Notepad in Windows 2000
689x/ME) can do this. See appendix \ref{ref:wps_tags} for all the tags that are 67or XP (but not in 9x/ME) can do this. See appendix \ref{ref:wps_tags} for all
69available. 68the tags that are available.
70 69
71\begin{description} 70\begin{description}
72 \item All characters not preceded by \% are displayed as typed. 71 \item All characters not preceded by \% are displayed as typed.
@@ -80,15 +79,14 @@ available.
80 79
81\subsubsection{Conditional Tags} 80\subsubsection{Conditional Tags}
82 81
83\emph{If/else}\\ 82\begin{description}
84 83\item[If/else: ]
85Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\ 84Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\
86 85
87If the tag specified by ``xx'' has a value, the text between the ``{\textless}'' and the ``{\textbar}'' is displayed (the true part), else the text between the ``{\textbar}'' and the ``{\textgreater}'' is displayed (the false part). 86If the tag specified by ``xx'' has a value, the text between the ``{\textless}'' and the ``{\textbar}'' is displayed (the true part), else the text between the ``{\textbar}'' and the ``{\textgreater}'' is displayed (the false part).
88The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals nest, so the text in the if and else part can contain all \% commands, including conditionals. 87The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals nest, so the text in the if and else part can contain all \% commands, including conditionals.
89 88
90\emph{Enumerations}\\ 89\item[Enumerations: ]
91
92Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\ 90Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\
93 91
94For tags with multiple values, like Play status, the conditional can hold a list of alternatives, one for each value the tag can have. 92For tags with multiple values, like Play status, the conditional can hold a list of alternatives, one for each value the tag can have.
@@ -96,6 +94,7 @@ For tags with multiple values, like Play status, the conditional can hold a list
96Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}\\ 94Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}\\
97 95
98The last else part is optional, and will be displayed if the tag has no value. The WPS parser will always display the last part if the tag has no value, or if the list of alternatives is too short. 96The last else part is optional, and will be displayed if the tag has no value. The WPS parser will always display the last part if the tag has no value, or if the list of alternatives is too short.
97\end{description}
99 98
100\subsubsection{Next Song info} 99\subsubsection{Next Song info}
101You can display information about the next song -- the song that is 100You can display information about the next song -- the song that is
@@ -107,10 +106,10 @@ three tags: F, I and D, they will instead refer to the next song
107instead of the current one. Example: \%Ig is the genre name used in the 106instead of the current one. Example: \%Ig is the genre name used in the
108next song and \%Ff is the mp3 frequency. 107next song and \%Ff is the mp3 frequency.
109 108
110Take note that the next song information WILL NOT be available at all 109\note{The next song information WILL NOT be available at all
111times, but will most likely be available at the end of a song. We 110times, but will most likely be available at the end of a song. We
112suggest you use the conditional display tag a lot when displaying 111suggest you use the conditional display tag a lot when displaying
113information about the next song! 112information about the next song!}
114 113
115\subsubsection{Alternating sublines} 114\subsubsection{Alternating sublines}
116 115
@@ -141,19 +140,21 @@ as they are separated into different sublines.
141 140
142Example subline definition: 141Example subline definition:
143 142
144\begin{verbatim} 143\begin{example}
145 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds, 144 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds,
146 Display id3 title for 2 seconds, 145 Display id3 title for 2 seconds,
147 Display current and remaining track time 146 Display current and remaining track time
148 for 3 seconds, 147 for 3 seconds,
149 repeat... 148 repeat...
150\end{verbatim} 149\end{example}
151 150
152Conditionals can be used with sublines to display a different set and/or number of sublines on the line depending on the evaluation of the conditional. 151Conditionals can be used with sublines to display a different set and/or number of sublines on the line depending on the evaluation of the conditional.
153 152
154Example subline with conditionals: 153Example subline with conditionals:
155 154
156\%?it{\textless}\%t8\%s\%it{\textbar}\%s\%fn{\textgreater};\%?ia{\textless}\%t3\%s\%ia{\textbar}\%t0{\textgreater}\\ 155\begin{example}
156 %?it{\textless}%t8%s%it{\textbar}%s%fn{\textgreater};%?ia{\textless}%t3%s%ia{\textbar}%t0{\textgreater}\\
157\end{example}
157 158
158The format above will do two different things depending if ID3 tags are present. If the ID3 artist and title are present: 159The format above will do two different things depending if ID3 tags are present. If the ID3 artist and title are present:
159 160
@@ -178,68 +179,60 @@ displaying images:
178 \item Load and always show the image, using the \%x tag 179 \item Load and always show the image, using the \%x tag
179 \item Preload the image with \%xl and show it with \%xd. This way you can 180 \item Preload the image with \%xl and show it with \%xd. This way you can
180 have your images displayed conditionally. 181 have your images displayed conditionally.
181 \opt{h300,x5,ipodcolor,ipodvideo}{ 182 \opt{HAVE_LCD_COLOR}{
182 \item On colour screen targets only... Load an image and show as backdrop 183 \item Load an image and show as backdrop using the \%X tag. The image must be
183 using the \%X tag. The image must be of the same exact dimensions as 184 of the same exact dimensions as your display.
184 your display.
185 } 185 }
186\end{enumerate} 186\end{enumerate}
187 187
188Example:\\ 188\optv{HAVE_LCD_COLOR}{
189\opt{HAVE_LCD_COLOR}{ 189 Example on background image use:
190 \config{\%X|background.bmp|}\\ 190 \begin{example}
191 %X|background.bmp|\\
192 \end{example}
193 The image with filename \fname{background.bmp} is loaded and used in the WPS.
191} 194}
192\config{ 195
196Example on bitmap preloading and use:
197\begin{example}
193 \%x|a|static\_icon.bmp|50|50|\\ 198 \%x|a|static\_icon.bmp|50|50|\\
194 \%xl|b|rep\_off.bmp|16|64|\\ 199 \%xl|b|rep\_off.bmp|16|64|\\
195 \%xl|c|rep\_all.bmp|16|64|\\ 200 \%xl|c|rep\_all.bmp|16|64|\\
196 \%xl|d|rep\_one.bmp|16|64|\\ 201 \%xl|d|rep\_one.bmp|16|64|\\
197 \%xl|e|rep\_shuffle.bmp|16|64|\\ 202 \%xl|e|rep\_shuffle.bmp|16|64|\\
198 \%?mm<\%xdb|\%xdc|\%xdd|\%xde>\\ 203 \%?mm<%xdb|%xdc|%xdd|%xde>\\
199} 204\end{example}
200\opt{HAVE_LCD_COLOR}{This example loads and displays a background image.} Four 205Four images at the same x and y position are preloaded in the example. Which
201images at the same x and y position are preloaded. Which image to display is 206image to display is determined by the \%mm tag (the repeat mode).
202determined by the \%mm tag (the repeat mode).
203 207
204\subsubsection{Example File} 208\subsubsection{Example File}
205\begin{verbatim} 209\begin{example}
206%s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]> 210 \%s\%?in<\%in - >\%?it<\%it|\%fn> \%?ia<[\%ia\%?id<, \%id>]>
207%pb%pc/%pt 211 \%pb\%pc/\%pt
208\end{verbatim} 212\end{example}
209That is, ``tracknum -- title [artist, album]'', where most fields are only 213That is, ``tracknum -- title [artist, album]'', where most fields are only
210displayed if available. Could also be rendered as ``filename'' or ``tracknum -- 214displayed if available. Could also be rendered as ``filename'' or ``tracknum --
211title [artist]''. 215title [artist]''.
212 216
213\subsubsection{Default} 217%\opt{HAVE_LCD_BITMAP}{
214If you haven't selected a .wps file in the \fname{/.rockbox} directory, you get
215the hard coded layout. The default WPS screen is:
216\fixme{do we really want to include the default wps in a users manual?}
217\opt{player}{
218%\begin{verbatim}
219 %s%pp/%pe: %?it<%it|%fn> - %?ia<%ia|%d2> - %?id<%id|%d1>
220 %pc%?ps<*|/>%pt
221%\end{verbatim}
222}
223
224\opt{HAVE_LCD_BITMAP}{
225% \begin{verbatim} 218% \begin{verbatim}
226 %s%?it<%?in<%in. |>%it|%fn> 219% %s%?it<%?in<%in. |>%it|%fn>
227 %s%?ia<%ia|%?d2<%d2|(root)>> 220% %s%?ia<%ia|%?d2<%d2|(root)>>
228 %s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|> 221% %s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|>
229 222%
230 %al%pc/%pt%ar[%pp:%pe] 223% %al%pc/%pt%ar[%pp:%pe]
231 %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)> 224% %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>
232 %pb 225% %pb
233 %pm 226% %pm
234 % \end{verbatim} 227% % \end{verbatim}
235} 228%}
236 229
237\section{\label{ref:SettingsFile}Making your own settings file} 230\section{\label{ref:SettingsFile}Making your own settings file}
238A .cfg file is used to load settings from a plain text file. A .cfg file may 231A \fname{.cfg} file is used to load settings from a plain text file. A
239reside anywhere on the hard disk. The only restriction is that the filename 232\fname{.cfg} file may reside anywhere on the hard disk. The only restriction is
240must end in .cfg 233that the filename must end in \fname{.cfg}
241 234
242Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu$\rightarrow$ 235Hint: Use the \setting{Write .cfg file} feature (\setting{Main Menu$\rightarrow$
243General Settings}) to save the current settings, then use a text editor to 236General Settings}) to save the current settings, then use a text editor to
244customize the settings file. See appendix \ref{ref:config_file_options} 237customize the settings file. See appendix \ref{ref:config_file_options}
245for the full reference of available options. 238for the full reference of available options.
@@ -253,7 +246,7 @@ for the full reference of available options.
253\end{itemize} 246\end{itemize}
254 247
255\subsection{Example File} 248\subsection{Example File}
256\begin{verbatim} 249\begin{example}
257 volume: 70 250 volume: 70
258 bass: 11 251 bass: 11
259 treble: 12 252 treble: 12
@@ -263,7 +256,7 @@ for the full reference of available options.
263 show files: supported 256 show files: supported
264 wps: /.rockbox/car.wps 257 wps: /.rockbox/car.wps
265 lang: /.rockbox/afrikaans.lng 258 lang: /.rockbox/afrikaans.lng
266\end{verbatim} 259\end{example}
267 260
268\section{\label{ref:PartISection1}Differences between binaries} 261\section{\label{ref:PartISection1}Differences between binaries}
269There are 3 different types of firmware binaries from Rockbox website: 262There are 3 different types of firmware binaries from Rockbox website:
@@ -293,23 +286,22 @@ eat also some more time.}
293 286
294\section{\label{ref:FirmwareLoading}Firmware Loading} 287\section{\label{ref:FirmwareLoading}Firmware Loading}
295\opt{player,recorder,recorderv2fm,ondio}{ 288\opt{player,recorder,recorderv2fm,ondio}{
296When your Jukebox powers on, it loads the Archos firmware in ROM, which 289 When your \dap\ powers on, it loads the Archos firmware in ROM, which
297automatically checks your Jukebox hard disk's root folder for a file 290 automatically checks your Jukebox hard disk's root folder for a file named
298named \fname{archos.mod} (on the player version) or 291 \firmwarefilename. Note that Archos firmware can only read the first
299\fname{ajbrec.ajz} (on the recorder version). Note that Archos 292 ten characters of each filename in this process, so don't rename your old
300firmware can only read the first ten characters of each file name in 293 firmware files with names like \firmwarefilename.\fname{old} and so on,
301this process, so don't rename your old firmware files with names like 294 because it's possible that the \dap\ will load a file other than the one you
302archos.mod.old and so on, because it's possible that the Jukebox will 295 intended.
303load a file other than the one you intended.
304} 296}
305 297
306\section{\label{ref:using_rolo}Using ROLO (Rockbox loader)} 298\section{\label{ref:using_rolo}Using ROLO (Rockbox loader)}
307Rockbox is able to load and start another firmware file without rebooting. 299Rockbox is able to load and start another firmware file without rebooting.
308You just press PLAY on an 300You just press PLAY on an%
309\opt{recorder,recorderv2fm,ondio}{.ajz} 301\opt{recorder,recorderv2fm,ondio}{\fname{.ajz}}
310\opt{player}{.mod}\opt{h1xx,h300}{.iriver} 302\opt{player}{.mod}\opt{h1xx,h300}{\fname{.iriver}}
311\opt{ipodnano,ipodvideo,ipodnano}{.ipod} 303\opt{ipodnano,ipodvideo,ipodnano}{\fname{.ipod}}%
312file. This can be used to test new firmware versions without deleting your 304-file. This can be used to test new firmware versions without deleting your
313current version. 305current version.
314 306
315\opt{recorder,recorderv2fm,ondio}{\input{advanced_topics/archos-flashing.tex}} 307\opt{recorder,recorderv2fm,ondio}{\input{advanced_topics/archos-flashing.tex}}
diff --git a/manual/platform/h1xx.tex b/manual/platform/h1xx.tex
index e616b7ec1b..b4fbec95e2 100644
--- a/manual/platform/h1xx.tex
+++ b/manual/platform/h1xx.tex
@@ -15,7 +15,7 @@
15\newcommand{\dap}{player} 15\newcommand{\dap}{player}
16%For use when referring to the player. E.g. the \daps\ capacity ... 16%For use when referring to the player. E.g. the \daps\ capacity ...
17\newcommand{\daps}{player's} 17\newcommand{\daps}{player's}
18\newcommand{\firmwarefilename}{rockbox.iriver} 18\newcommand{\firmwarefilename}{\fname{rockbox.iriver}}
19 19
20\newcommand{\ButtonLeft}{Left} 20\newcommand{\ButtonLeft}{Left}
21\newcommand{\ButtonRight}{Right} 21\newcommand{\ButtonRight}{Right}
diff --git a/manual/platform/h300.tex b/manual/platform/h300.tex
index 136122e290..3a9ac77d8f 100644
--- a/manual/platform/h300.tex
+++ b/manual/platform/h300.tex
@@ -17,7 +17,7 @@
17\newcommand{\dap}{player} 17\newcommand{\dap}{player}
18%For use when referring to the player. E.g. the \daps\ capacity ... 18%For use when referring to the player. E.g. the \daps\ capacity ...
19\newcommand{\daps}{player's} 19\newcommand{\daps}{player's}
20\newcommand{\firmwarefilename}{rockbox.iriver} 20\newcommand{\firmwarefilename}{\fname{rockbox.iriver}}
21 21
22\newcommand{\ButtonLeft}{Left} 22\newcommand{\ButtonLeft}{Left}
23\newcommand{\ButtonRight}{Right} 23\newcommand{\ButtonRight}{Right}
diff --git a/manual/platform/ipod4g.tex b/manual/platform/ipod4g.tex
index 95664bff93..494429564e 100644
--- a/manual/platform/ipod4g.tex
+++ b/manual/platform/ipod4g.tex
@@ -14,7 +14,7 @@
14\newcommand{\dap}{player} 14\newcommand{\dap}{player}
15%For use when referring to the player. E.g. the \daps\ capacity ... 15%For use when referring to the player. E.g. the \daps\ capacity ...
16\newcommand{\daps}{player's} 16\newcommand{\daps}{player's}
17\newcommand{\firmwarefilename}{rockbox.ipod} 17\newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
18 18
19\newcommand{\ButtonLeft}{Prev} 19\newcommand{\ButtonLeft}{Prev}
20\newcommand{\ButtonRight}{Next} 20\newcommand{\ButtonRight}{Next}
diff --git a/manual/platform/ipodcolor.tex b/manual/platform/ipodcolor.tex
index 3a245bbb22..5e52ac8f5b 100644
--- a/manual/platform/ipodcolor.tex
+++ b/manual/platform/ipodcolor.tex
@@ -15,7 +15,7 @@
15\newcommand{\dap}{player} 15\newcommand{\dap}{player}
16%For use when referring to the player. E.g. the \daps\ capacity ... 16%For use when referring to the player. E.g. the \daps\ capacity ...
17\newcommand{\daps}{player's} 17\newcommand{\daps}{player's}
18\newcommand{\firmwarefilename}{rockbox.ipod} 18\newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
19 19
20\newcommand{\ButtonLeft}{Prev} 20\newcommand{\ButtonLeft}{Prev}
21\newcommand{\ButtonRight}{Next} 21\newcommand{\ButtonRight}{Next}
diff --git a/manual/platform/ipodmini.tex b/manual/platform/ipodmini.tex
index 857ef73bfa..b1dba17e6f 100644
--- a/manual/platform/ipodmini.tex
+++ b/manual/platform/ipodmini.tex
@@ -14,7 +14,7 @@
14\newcommand{\dap}{player} 14\newcommand{\dap}{player}
15%For use when referring to the player. E.g. the \daps\ capacity ... 15%For use when referring to the player. E.g. the \daps\ capacity ...
16\newcommand{\daps}{player's} 16\newcommand{\daps}{player's}
17\newcommand{\firmwarefilename}{rockbox.ipod} 17\newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
18 18
19\newcommand{\ButtonLeft}{Prev} 19\newcommand{\ButtonLeft}{Prev}
20\newcommand{\ButtonRight}{Next} 20\newcommand{\ButtonRight}{Next}
diff --git a/manual/platform/ipodnano.tex b/manual/platform/ipodnano.tex
index 0173652e1f..d720b9e79d 100644
--- a/manual/platform/ipodnano.tex
+++ b/manual/platform/ipodnano.tex
@@ -15,7 +15,7 @@
15\newcommand{\dap}{player} 15\newcommand{\dap}{player}
16%For use when referring to the player. E.g. the \daps\ capacity ... 16%For use when referring to the player. E.g. the \daps\ capacity ...
17\newcommand{\daps}{player's} 17\newcommand{\daps}{player's}
18\newcommand{\firmwarefilename}{rockbox.ipod} 18\newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
19 19
20\newcommand{\ButtonLeft}{Prev} 20\newcommand{\ButtonLeft}{Prev}
21\newcommand{\ButtonRight}{Next} 21\newcommand{\ButtonRight}{Next}
diff --git a/manual/platform/ipodvideo.tex b/manual/platform/ipodvideo.tex
index 6611f7538c..6597e1934a 100644
--- a/manual/platform/ipodvideo.tex
+++ b/manual/platform/ipodvideo.tex
@@ -15,7 +15,7 @@
15\newcommand{\dap}{player} 15\newcommand{\dap}{player}
16%For use when referring to the player. E.g. the \daps\ capacity ... 16%For use when referring to the player. E.g. the \daps\ capacity ...
17\newcommand{\daps}{player's} 17\newcommand{\daps}{player's}
18\newcommand{\firmwarefilename}{rockbox.ipod} 18\newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
19 19
20\newcommand{\ButtonLeft}{Prev} 20\newcommand{\ButtonLeft}{Prev}
21\newcommand{\ButtonRight}{Next} 21\newcommand{\ButtonRight}{Next}
diff --git a/manual/platform/ondiofm.tex b/manual/platform/ondiofm.tex
index c48aff84bc..917fb4da62 100644
--- a/manual/platform/ondiofm.tex
+++ b/manual/platform/ondiofm.tex
@@ -18,7 +18,7 @@
18\newcommand{\dap}{player} 18\newcommand{\dap}{player}
19%For use when referring to the player. E.g. the \daps\ capacity ... 19%For use when referring to the player. E.g. the \daps\ capacity ...
20\newcommand{\daps}{player's} 20\newcommand{\daps}{player's}
21\newcommand{\firmwarefilename}{ajbrec.ajz} 21\newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
22 22
23\newcommand{\ButtonLeft}{Left} 23\newcommand{\ButtonLeft}{Left}
24\newcommand{\ButtonRight}{Right} 24\newcommand{\ButtonRight}{Right}
diff --git a/manual/platform/ondiosp.tex b/manual/platform/ondiosp.tex
index 879a01f898..be1f2ec15f 100644
--- a/manual/platform/ondiosp.tex
+++ b/manual/platform/ondiosp.tex
@@ -15,7 +15,7 @@
15\newcommand{\dap}{player} 15\newcommand{\dap}{player}
16%For use when referring to the player. E.g. the \daps\ capacity ... 16%For use when referring to the player. E.g. the \daps\ capacity ...
17\newcommand{\daps}{player's} 17\newcommand{\daps}{player's}
18\newcommand{\firmwarefilename}{ajbrec.ajz} 18\newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
19 19
20\newcommand{\ButtonLeft}{Left} 20\newcommand{\ButtonLeft}{Left}
21\newcommand{\ButtonRight}{Right} 21\newcommand{\ButtonRight}{Right}
diff --git a/manual/platform/player.tex b/manual/platform/player.tex
index 93a71f703e..6357191b13 100644
--- a/manual/platform/player.tex
+++ b/manual/platform/player.tex
@@ -12,7 +12,7 @@
12\newcommand{\dap}{player} 12\newcommand{\dap}{player}
13%For use when referring to the player. E.g. the \daps\ capacity ... 13%For use when referring to the player. E.g. the \daps\ capacity ...
14\newcommand{\daps}{player's} 14\newcommand{\daps}{player's}
15\newcommand{\firmwarefilename}{archos.mod} 15\newcommand{\firmwarefilename}{\fname{archos.mod}}
16 16
17\newcommand{\ButtonLeft}{Left} 17\newcommand{\ButtonLeft}{Left}
18\newcommand{\ButtonRight}{Right} 18\newcommand{\ButtonRight}{Right}
diff --git a/manual/platform/recorder.tex b/manual/platform/recorder.tex
index 6eff1c176a..6a514e72eb 100644
--- a/manual/platform/recorder.tex
+++ b/manual/platform/recorder.tex
@@ -15,7 +15,7 @@
15\newcommand{\dap}{player} 15\newcommand{\dap}{player}
16%For use when referring to the player. E.g. the \daps\ capacity ... 16%For use when referring to the player. E.g. the \daps\ capacity ...
17\newcommand{\daps}{player's} 17\newcommand{\daps}{player's}
18\newcommand{\firmwarefilename}{ajbrec.ajz} 18\newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
19 19
20\newcommand{\ButtonOn}{On} 20\newcommand{\ButtonOn}{On}
21\newcommand{\ButtonOff}{Stop} 21\newcommand{\ButtonOff}{Stop}
diff --git a/manual/platform/recorderv2fm.tex b/manual/platform/recorderv2fm.tex
index 3dfa2e4214..cd2cd759be 100644
--- a/manual/platform/recorderv2fm.tex
+++ b/manual/platform/recorderv2fm.tex
@@ -16,7 +16,7 @@
16\newcommand{\dap}{player} 16\newcommand{\dap}{player}
17%For use when referring to the player. E.g. the \daps\ capacity ... 17%For use when referring to the player. E.g. the \daps\ capacity ...
18\newcommand{\daps}{player's} 18\newcommand{\daps}{player's}
19\newcommand{\firmwarefilename}{ajbrec.ajz} 19\newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
20 20
21\newcommand{\ButtonOn}{On} 21\newcommand{\ButtonOn}{On}
22\newcommand{\ButtonOff}{Stop} 22\newcommand{\ButtonOff}{Stop}
diff --git a/manual/platform/x5.tex b/manual/platform/x5.tex
index 0981d0b374..3c84b6df0b 100644
--- a/manual/platform/x5.tex
+++ b/manual/platform/x5.tex
@@ -17,7 +17,7 @@
17\newcommand{\dap}{player} 17\newcommand{\dap}{player}
18%For use when referring to the player. E.g. the \daps\ capacity ... 18%For use when referring to the player. E.g. the \daps\ capacity ...
19\newcommand{\daps}{player's} 19\newcommand{\daps}{player's}
20\newcommand{\firmwarefilename}{rockbox.iaudio} 20\newcommand{\firmwarefilename}{\fname{rockbox.iaudio}}
21 21
22\newcommand{\ButtonLeft}{Left} 22\newcommand{\ButtonLeft}{Left}
23\newcommand{\ButtonRight}{Right} 23\newcommand{\ButtonRight}{Right}
diff --git a/manual/preamble.tex b/manual/preamble.tex
index 020a91f9ed..31bc596609 100644
--- a/manual/preamble.tex
+++ b/manual/preamble.tex
@@ -28,7 +28,7 @@
28 pdfsubject = {Rockbox user manual for \playername} 28 pdfsubject = {Rockbox user manual for \playername}
29} 29}
30 30
31\newcommand{\fname}[1]{\textbf{#1}} 31\newcommand{\fname}[1]{\texttt{#1}}
32\newcommand{\tabeltc}[1]{{\centering #1 \par}} 32\newcommand{\tabeltc}[1]{{\centering #1 \par}}
33\newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}} 33\newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}
34 34
@@ -76,12 +76,12 @@
76\setlength{\headheight}{18.5pt} 76\setlength{\headheight}{18.5pt}
77\newcounter{example}[chapter] 77\newcounter{example}[chapter]
78 78
79\newenvironment{example} 79%% \newenvironment{example}
80 {\stepcounter{example}\paragraph{Example \theexample:}} 80%% {\stepcounter{example}\paragraph{Example \theexample:}}
81 {\hfill$\Box$ 81%% {\hfill$\Box$
82 82
83 \bigskip 83%% \bigskip
84 \noindent} 84%% \noindent}
85 85
86% found on the internet, posting by Donald Arseneau 86% found on the internet, posting by Donald Arseneau
87% I may as well include my robust expandable definions, which can be 87% I may as well include my robust expandable definions, which can be
@@ -220,9 +220,22 @@
220% This is intended to make the LaTeX sources more readable. 220% This is intended to make the LaTeX sources more readable.
221% Note: when using the code environment you need to use optv instead of opt! 221% Note: when using the code environment you need to use optv instead of opt!
222\DefineVerbatimEnvironment{code}{Verbatim}% 222\DefineVerbatimEnvironment{code}{Verbatim}%
223 {numbers=left,frame=lines,% 223 {framerule=0.4pt, framesep=1ex,numbers=left,frame=lines,%
224 gobble=4,fontsize=\footnotesize,xleftmargin=10pt,% 224 gobble=4,fontsize=\footnotesize,xleftmargin=10pt,%
225 label=\textnormal{\textsc{Code}},% 225 label=\textnormal{\textsc{Code}},%
226 commandchars=\\\{\}% 226 commandchars=\\\{\}%
227 } 227 }
228 228
229% define environment "example" based on fancyvrb.
230% use it to set example code the user should type / see on his screen.
231% Note: the first 4 characters of each line will be stripped,
232% requiring everything to be indendet by exactly _4_ spaces!
233% This is intended to make the LaTeX sources more readable.
234% Note: when using the example environment you need to use optv instead of opt!
235\DefineVerbatimEnvironment{example}{Verbatim}%
236 {commentchar=!,framerule=0.4pt, framesep=1ex,frame=lines,%
237 fontsize=\footnotesize,xleftmargin=10pt,%
238 label=\textnormal{\textsc{Example}},%
239 commandchars=\\\{\}%
240 }
241