summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-08-18 16:57:56 +0000
committerMartin Arver <martin.arver@gmail.com>2006-08-18 16:57:56 +0000
commit09c3961a4964ed5e31d9a5e5d09302f4ae03ecf6 (patch)
tree4b9e8c5735d179d33fb6529afcd9b60ecae71766
parent89e411b34ce434f4f0906d1e3c575e79107157ab (diff)
downloadrockbox-09c3961a4964ed5e31d9a5e5d09302f4ae03ecf6.tar.gz
rockbox-09c3961a4964ed5e31d9a5e5d09302f4ae03ecf6.zip
Fix for commas and periods eaten up by our macros. Do not use \ after a macro if followed by a , or a . Use nothing or {} instead. Thanks to Mikachu for noticing.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10649 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/advanced_topics/main.tex288
-rw-r--r--manual/getting_started/iriver_install.tex2
-rw-r--r--manual/plugins/solitaire.tex2
-rw-r--r--manual/rockbox_interface/main.tex16
4 files changed, 154 insertions, 154 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index a65d50f1e7..57007e34f8 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -41,13 +41,13 @@ file find the instructions on the Rockbox website:
41\subsection{WPS -- General Info} 41\subsection{WPS -- General Info}
42 42
43\begin{description} 43\begin{description}
44\item[Description: ] The WPS or While Playing Screen is the name used to describe 44\item[Description: ] The WPS or While Playing Screen is the name used to
45the information displayed on the \daps\ screen whilst an audio track is 45 describe the information displayed on the \daps\ screen whilst an audio track
46being played. The default WPS is a relatively simple screen displaying 46 is being played. The default WPS is a relatively simple screen displaying
47Track name, Artist, Album etc. in the default font as a purely text based 47 Track 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 48 layout. There are a number of WPS files included in Rockbox, and you can
49load one of these at anytime by selecting it in 49 load 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
52\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
53 \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
@@ -56,11 +56,11 @@ load one of these at anytime by selecting it in
56\note{``Playing'' a \fname{.wps} from the file browser has the same effect.} 56\note{``Playing'' a \fname{.wps} from the file browser has the same effect.}
57 57
58\item [File Location: ]Custom WPS files may be located anywhere on the drive. 58\item [File Location: ]Custom WPS files may be located anywhere on the drive.
59The only restriction is that they must end in \fname{.wps}. When you ``play'' 59 The only restriction is that they must end in \fname{.wps}. When you ``play''
60a \fname{.wps} file, it will be used for future WPS screens, and if the 60 a \fname{.wps} file, it will be used for future WPS screens, and if the
61``played'' \fname{.wps} file is located in the \fname{/.rockbox} folder, it 61 ``played'' \fname{.wps} file is located in the \fname{/.rockbox} folder, it
62will be remembered and used after reboot. The \fname{.wps} filename must be no 62 will be remembered and used after reboot. The \fname{.wps} filename must be
63more than 24 characters long for it to be remembered. 63 no more than 24 characters long for it to be remembered.
64\end{description} 64\end{description}
65 65
66\subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own} 66\subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own}
@@ -70,17 +70,17 @@ file, save it as a \fname{.wps} file. Example: Instead of \fname{Rockbox.txt},
70save the file as \fname{Rockbox.wps}. To make sure non english characters 70save the file as \fname{Rockbox.wps}. To make sure non english characters
71display correctly in your WPS you must save the .wps file with UTF-8 character 71display correctly in your WPS you must save the .wps file with UTF-8 character
72encoding. This can be done in most editors, for example Notepad in Windows 2000 72encoding. This can be done in most editors, for example Notepad in Windows 2000
73or XP (but not in 9x/ME) can do this. See appendix \reference{ref:wps_tags} for all 73or XP (but not in 9x/ME) can do this. See appendix \reference{ref:wps_tags} for
74the tags that are available. 74all the tags that are available.
75 75
76\begin{itemize} 76\begin{itemize}
77 \item All characters not preceded by \% are displayed as typed. 77\item All characters not preceded by \% are displayed as typed.
78 \item Lines beginning with \# are comments and will be ignored. 78\item Lines beginning with \# are comments and will be ignored.
79 \item Maximum file size used is 79\item Maximum file size used is
80 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600} 80 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600}
81 \opt{player}{400} bytes. 81 \opt{player}{400} bytes.
82 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
83 loaded and used. 83 loaded and used.
84\end{itemize} 84\end{itemize}
85 85
86\subsubsection{Conditional Tags} 86\subsubsection{Conditional Tags}
@@ -104,7 +104,7 @@ For tags with multiple values, like Play status, the conditional can hold a
104list of alternatives, one for each value the tag can have. 104list of alternatives, one for each value the tag can have.
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}
108\end{example} 108\end{example}
109 109
110The last else part is optional, and will be displayed if the tag has no value. 110The last else part is optional, and will be displayed if the tag has no value.
@@ -123,9 +123,9 @@ the 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 \emph{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 126 times, but will most likely be available at the end of a song. We
127suggest you use the conditional display tag a lot when displaying 127 suggest you use the conditional display tag a lot when displaying
128information about the next song!} 128 information about the next song!}
129 129
130\subsubsection{Alternating sublines} 130\subsubsection{Alternating sublines}
131 131
@@ -189,10 +189,10 @@ displaying images:
189 \item Load and always show the image, using the \config{\%x} tag 189 \item Load and always show the image, using the \config{\%x} tag
190 \item Preload the image with \config{\%xl} and show it with \config{\%xd}. 190 \item Preload the image with \config{\%xl} and show it with \config{\%xd}.
191 This way you can have your images displayed conditionally. 191 This way you can have your images displayed conditionally.
192 \opt{HAVE_LCD_COLOR}{ 192 \opt{HAVE_LCD_COLOR}{
193 \item Load an image and show as backdrop using the \config{\%X} tag. The 193 \item Load an image and show as backdrop using the \config{\%X} tag. The
194 image must be of the same exact dimensions as your display. 194 image must be of the same exact dimensions as your display.
195 } 195 }
196\end{enumerate} 196\end{enumerate}
197 197
198\optv{HAVE_LCD_COLOR}{ 198\optv{HAVE_LCD_COLOR}{
@@ -239,126 +239,126 @@ title [artist]''.
239 239
240\section{\label{ref:manage_settings}Managing Rockbox settings} 240\section{\label{ref:manage_settings}Managing Rockbox settings}
241 241
242 \subsection{Introduction to \fname{.cfg} files.} 242\subsection{Introduction to \fname{.cfg} files.}
243 Rockbox allows users to store and load multiple settings through the use of 243Rockbox allows users to store and load multiple settings through the use of
244 configuration files. A configuration file is simply a text file with the 244configuration files. A configuration file is simply a text file with the
245 extension \fname{.cfg}. 245extension \fname{.cfg}.
246 246
247 A configuration file may reside anywhere on the hard disk. Multiple 247A configuration file may reside anywhere on the hard disk. Multiple
248 configuration files are permitted. So, for example, you could have 248configuration files are permitted. So, for example, you could have
249 a \fname{car.cfg} file for the settings that you use while playing your 249a \fname{car.cfg} file for the settings that you use while playing your
250 jukebox in your car, and a \fname{headphones.cfg} file to store the 250jukebox in your car, and a \fname{headphones.cfg} file to store the
251 settings that you use while listening to your \dap\ through headphones. 251settings that you use while listening to your \dap\ through headphones.
252 252
253 See \reference{ref:cfg_specs} below for an explanation of the format 253See \reference{ref:cfg_specs} below for an explanation of the format
254 for configuration files. See \reference{ref:manage_settings_menu} for an 254for configuration files. See \reference{ref:manage_settings_menu} for an
255 explanation of how to create, edit and load configuration files. 255explanation of how to create, edit and load configuration files.
256 256
257 \subsection{\label{ref:cfg_specs}Specifications for \fname{.cfg} 257\subsection{\label{ref:cfg_specs}Specifications for \fname{.cfg}
258 files.} 258 files.}
259 259
260 The Rockbox configuration file is a plain text file, so once you use the 260The Rockbox configuration file is a plain text file, so once you use the
261 \setting{Write .cfg file} option to create the file, you can edit the file on 261\setting{Write .cfg file} option to create the file, you can edit the file on
262 your computer using any text editor program. See 262your computer using any text editor program. See
263 Appendix \reference{ref:config_file_options} for available settings. Configuration 263Appendix \reference{ref:config_file_options} for available settings. Configuration
264 files use the following formatting rules: % 264files use the following formatting rules: %
265 265
266 \begin{enumerate} 266\begin{enumerate}
267 \item Each setting must be on a separate line. 267\item Each setting must be on a separate line.
268 \item Each line has the format ``setting: value''. 268\item Each line has the format ``setting: value''.
269 \item Values must be within the ranges specified in this manual for each 269\item Values must be within the ranges specified in this manual for each
270 setting. 270 setting.
271 \item Lines starting with \# are ignored. This lets you write comments into 271\item Lines starting with \# are ignored. This lets you write comments into
272 your configuration files. 272 your configuration files.
273 \end{enumerate} 273\end{enumerate}
274 274
275 Example of a configuration file: 275Example of a configuration file:
276 \begin{example} 276\begin{example}
277 # Example configuration file 277 # Example configuration file
278 # volume: 70 278 # volume: 70
279 # bass: 11 279 # bass: 11
280 # treble: 12 280 # treble: 12
281 # balance: 0 281 # balance: 0
282 # time format: 12hour 282 # time format: 12hour
283 # volume display: numeric 283 # volume display: numeric
284 # show files: supported 284 # show files: supported
285 # wps: /.rockbox/car.wps 285 # wps: /.rockbox/car.wps
286 # lang: /.rockbox/afrikaans.lng 286 # lang: /.rockbox/afrikaans.lng
287 \end{example} 287\end{example}
288 288
289 \note{As you can see from the example, configuration files do not need to 289\note{As you can see from the example, configuration files do not need to
290 contain all of the Rockbox options. You can create configuration files 290 contain all of the Rockbox options. You can create configuration files
291 that change only certain settings. So, for example, supppose you 291 that change only certain settings. So, for example, supppose you
292 typically use the \dap at one volume in the car, and another when using 292 typically use the \dap at one volume in the car, and another when using
293 headphones. Further, suppose you like to use an inverse LCD when you are 293 headphones. Further, suppose you like to use an inverse LCD when you are
294 in the car, and a regular LCD setting when you are using headphones. You 294 in the car, and a regular LCD setting when you are using headphones. You
295 could create configuration files that control only the volume and LCD 295 could create configuration files that control only the volume and LCD
296 settings. Create a few different files with different settings, give 296 settings. Create a few different files with different settings, give
297 each file a different name (such as \fname{car.cfg}, 297 each file a different name (such as \fname{car.cfg},
298 \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg 298 \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg
299 files} option to quickly change settings.} 299 files} option to quickly change settings.}
300
301\subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings}
302 menu} The \setting{Manage Settings} menu can be found in the \setting{Main
303 Menu}. The \setting{Manage Settings} menu allows you to save and load
304\fname{.cfg} files. \opt{MASCODEC}{The \setting{Manage Settings} menu also
305 allows you to load or save different firmware versions.}
306
307\begin{description}
308
309\item [Browse .cfg Files.]Opens the file browser in the
310 \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration)
311 files. Selecting a \fname{.cfg} file will cause Rockbox to load the
312 settings contained in that file. Pressing \ButtonLeft\ will exit back to
313 the \setting{Manage Settings} menu. See the \setting{Write .cfg files}
314 option on the \setting{Manage Settings} menu for details of how to save
315 and edit a configuration file.
316
317\item [Browse Firmwares.]
318 %
319 \opt{SWCODEC}{\fixme{This is a legacy item, and is deprecated.}}
320 %
321 \opt{MASCODEC}{
322 This displays a list of firmware files in the \fname{/.rockbox}
323 system directory.
324 %
325 \opt{recorder,recorderv2fm}{Firmware files have an extension of
326 \fname{.ajz}. }
327 %
328 \opt{player,ondio}{Firmware files have an extension of \fname{.mod}. }
329 %
330 Playing a firmware file loads it into memory. Thus, it is possible
331 to run the original Archos firmware or a different version of Rockbox
332 from here (assuming that you have the right files installed on your
333 disk. There is no need for any other file or directory to be
334 installed to use this option; the firmware is resident in that one
335 file.
336 }
337
338\item [Reset Settings.]This wipes the saved settings in the \dap\ and
339 resets all settings to their default values.
300 340
301 \subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings} 341 \opt{h100,h300}{\note{You can also reset all settings to their default
302 menu} The \setting{Manage Settings} menu can be found in the \setting{Main 342 values by turning off the \dap, turning it back on, and pressing the
303 Menu}. The \setting{Manage Settings} menu allows you to save and load 343 \ButtonRec button immediately after the \dap\ turns on.}
304 \fname{.cfg} files. \opt{MASCODEC}{The \setting{Manage Settings} menu also 344 }
305 allows you to load or save different firmware versions.} 345 \opt{ipod}{\note{You can also reset all settings to their default values
306 346 by turning off the \dap, and turning it back on with the hold button
307 \begin{description} 347 on.}
308 348 }
309 \item [Browse .cfg Files.]Opens the file browser in the
310 \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration)
311 files. Selecting a \fname{.cfg} file will cause Rockbox to load the
312 settings contained in that file. Pressing \ButtonLeft\ will exit back to
313 the \setting{Manage Settings} menu. See the \setting{Write .cfg files}
314 option on the \setting{Manage Settings} menu for details of how to save
315 and edit a configuration file.
316
317 \item [Browse Firmwares.]
318 %
319 \opt{SWCODEC}{\fixme{This is a legacy item, and is deprecated.}}
320 %
321 \opt{MASCODEC}{
322 This displays a list of firmware files in the \fname{/.rockbox}
323 system directory.
324 %
325 \opt{recorder,recorderv2fm}{Firmware files have an extension of
326 \fname{.ajz}. }
327 %
328 \opt{player,ondio}{Firmware files have an extension of \fname{.mod}. }
329 %
330 Playing a firmware file loads it into memory. Thus, it is possible
331 to run the original Archos firmware or a different version of Rockbox
332 from here (assuming that you have the right files installed on your
333 disk. There is no need for any other file or directory to be
334 installed to use this option; the firmware is resident in that one
335 file.
336 }
337
338 \item [Reset Settings.]This wipes the saved settings in the \dap\ and
339 resets all settings to their default values.
340
341 \opt{h100,h300}{\note{You can also reset all settings to their default
342 values by turning off the \dap\, turning it back on, and pressing the
343 \ButtonRec button immediately after the \dap\ turns on.}
344 }
345 \opt{ipod}{\note{You can also reset all settings to their default values
346 by turning off the \dap\, and turning it back on with the hold button
347 on.}
348 }
349 349
350 \item [Write .cfg file.]This option writes a \fname{.cfg} file to 350\item [Write .cfg file.]This option writes a \fname{.cfg} file to
351 your \daps\ hard disk. The configuration file has the \fname{.cfg} 351 your \daps\ hard disk. The configuration file has the \fname{.cfg}
352 extension and is used to store all of the user settings that are described 352 extension and is used to store all of the user settings that are described
353 throughout this manual. 353 throughout this manual.
354 354
355 Hint: Use the \setting{Write .cfg file} feature (\setting{Main 355 Hint: Use the \setting{Write .cfg file} feature (\setting{Main Menu
356 Menu $\rightarrow$ General Settings}) to save the current settings, then 356 $\rightarrow$ General Settings}) to save the current settings, then
357 use a text editor to customize the settings file. See Appendix 357 use a text editor to customize the settings file. See Appendix
358 \reference{ref:config_file_options} for the full reference of available 358 \reference{ref:config_file_options} for the full reference of available
359 options. 359 options.
360 360
361 \end{description} 361\end{description}
362 362
363\section{\label{ref:FirmwareLoading}Firmware Loading} 363\section{\label{ref:FirmwareLoading}Firmware Loading}
364\opt{player,recorder,recorderv2fm,ondio}{ 364\opt{player,recorder,recorderv2fm,ondio}{
diff --git a/manual/getting_started/iriver_install.tex b/manual/getting_started/iriver_install.tex
index 1b0e0a7db0..5d8e6b440e 100644
--- a/manual/getting_started/iriver_install.tex
+++ b/manual/getting_started/iriver_install.tex
@@ -23,7 +23,7 @@
23 \opt{IRIVER_H300_PAD}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU. 23 \opt{IRIVER_H300_PAD}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
24 \note{The US H3xx firmware is not currently supported and cannot be 24 \note{The US H3xx firmware is not currently supported and cannot be
25 patched to be used with the bootloader. If you wish to install Rockbox 25 patched to be used with the bootloader. If you wish to install Rockbox
26 on a US \playername\, you must use an international firmware, which will 26 on a US \playername, you must use an international firmware, which will
27 permanently remove DRM support from the player.} 27 permanently remove DRM support from the player.}
28 }% 28 }%
29 If the file that you downloaded is a \fname{.zip} file, use an unzip 29 If the file that you downloaded is a \fname{.zip} file, use an unzip
diff --git a/manual/plugins/solitaire.tex b/manual/plugins/solitaire.tex
index 41ca0946fc..7ddf7cc1a8 100644
--- a/manual/plugins/solitaire.tex
+++ b/manual/plugins/solitaire.tex
@@ -16,7 +16,7 @@ visit\\
16\begin{table} 16\begin{table}
17 \begin{btnmap}{}{} 17 \begin{btnmap}{}{}
18 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD} 18 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
19 {\ButtonLeft, \ButtonRight, \ButtonUp\, \ButtonDown} 19 {\ButtonLeft, \ButtonRight, \ButtonUp, \ButtonDown}
20 \opt{IPOD_4G_PAD}{\ButtonLeft, \ButtonRight, \ButtonMenu, \ButtonPlay} 20 \opt{IPOD_4G_PAD}{\ButtonLeft, \ButtonRight, \ButtonMenu, \ButtonPlay}
21 & Move Cursor around.\\ 21 & Move Cursor around.\\
22 % 22 %
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index 009c05d754..4ebc6b71ef 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -74,21 +74,21 @@ picture above.
74 } 74 }
75 % 75 %
76 \opt{ipodnano}{ 76 \opt{ipodnano}{
77 The main controls on the \dap\ are a slightly indented wheel with a 77 The main controls on the \dap{} are a slightly indented wheel with a
78 flat round button in the center. Hold the \dap\ with these controls on the 78 flat round button in the center. Hold the \dap{} with these controls on the
79 top surface. There is a Hold switch at one end, and headphone and USB jacks 79 top surface. There is a Hold switch at one end, and headphone and USB jacks
80 at the other; be sure the end with the switch is facing away from you. 80 at the other; be sure the end with the switch is facing away from you.
81 81
82 The button in the middle of the wheel is called \ButtonSelect\. You can 82 The button in the middle of the wheel is called \ButtonSelect. You can
83 operate the wheel by pressing the top, bottom, left or right sections, 83 operate the wheel by pressing the top, bottom, left or right sections,
84 or by sliding your finger around it. The top is \ButtonMenu\, the bottom is 84 or by sliding your finger around it. The top is \ButtonMenu, the bottom is
85 \ButtonPlay\, the left is \ButtonLeft\, and the right is \ButtonRight\. 85 \ButtonPlay, the left is \ButtonLeft, and the right is \ButtonRight.
86 When the manual says to \ButtonScrollFwd\, it means to slide your finger 86 When the manual says to \ButtonScrollFwd, it means to slide your finger
87 clockwise around the wheel. \ButtonScrollBack\ means to slide your finger 87 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
88 counterclockwise. Note that the wheel is sensitive, so you will need to move 88 counterclockwise. Note that the wheel is sensitive, so you will need to move
89 slowly at first and get a feel for how it works. 89 slowly at first and get a feel for how it works.
90 90
91 Note that when the Hold switch is pushed toward the center of the \dap\, 91 Note that when the Hold switch is pushed toward the center of the \dap,
92 Hold is on, and none of the other controls do anything; be sure Hold is 92 Hold is on, and none of the other controls do anything; be sure Hold is
93 off before trying to use your player. 93 off before trying to use your player.
94 } 94 }