summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThom Johansen <thomj@rockbox.org>2008-07-14 22:47:40 +0000
committerThom Johansen <thomj@rockbox.org>2008-07-14 22:47:40 +0000
commit3a74208d4e5a67d86c4b1b978ebf5ecfb0347a55 (patch)
tree3fc5190f0d9e7588332e09f6f365875c633845e8
parent167a27dd76849c0ea8ed13d58297e334a9a90a1e (diff)
downloadrockbox-3a74208d4e5a67d86c4b1b978ebf5ecfb0347a55.tar.gz
rockbox-3a74208d4e5a67d86c4b1b978ebf5ecfb0347a55.zip
General language cleanup and small restrucuring of the source code of misc. parts of the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18043 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/configure_rockbox/sound_settings.tex66
-rw-r--r--manual/getting_started/installation.tex34
-rw-r--r--manual/getting_started/main.tex4
-rw-r--r--manual/plugins/brickmania.tex6
-rw-r--r--manual/plugins/main.tex8
-rw-r--r--manual/rockbox_interface/main.tex29
6 files changed, 64 insertions, 83 deletions
diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex
index faec0b810e..8b1d0bd499 100644
--- a/manual/configure_rockbox/sound_settings.tex
+++ b/manual/configure_rockbox/sound_settings.tex
@@ -1,7 +1,7 @@
1% $Id$ % 1% $Id$ %
2\screenshot{configure_rockbox/images/ss-sound-settings}{The sound settings screen}{} 2\screenshot{configure_rockbox/images/ss-sound-settings}{The sound settings screen}{}
3 3
4The Sound Settings menu offers a selection of sound properties you may 4The sound settings menu offers a selection of sound settings you may
5change to customise your listening experience. 5change to customise your listening experience.
6 6
7\section{\label{ref:volume}Volume} 7\section{\label{ref:volume}Volume}
@@ -28,22 +28,15 @@ change to customise your listening experience.
28 \opt{ipod3g,ipod4g,gigabeatf,mrobe100}{\fixme{add correct volume range.}} 28 \opt{ipod3g,ipod4g,gigabeatf,mrobe100}{\fixme{add correct volume range.}}
29 29
30\section{Bass} 30\section{Bass}
31 \opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the 31 This setting emphasises
32 lower (bass) frequencies in the track. 0 means that bass sounds are unaltered 32 \nopt{h1xx,h300}{or suppresses}
33 (flat response).} 33 the lower (bass) frequencies in the sound. A value of 0 dB means that bass
34 \opt{h1xx,h300}{The bass setting can be used to increase (but not decrease) 34 sounds are unaltered (flat response).
35 frequencies below 300Hz. Bass boost can be set from 0 to 24 dB in 35 \opt{player,recorder,recorderv2fm,ondio}{}
36 increments of 2 dB. A setting of 0 means that low frequencies are unaltered 36 \opt{h1xx,h300}{The minimum setting is 0 dB and the maximum is 24 dB.}
37 (flat response).} 37 \opt{ipodnano,ipodcolor}{The minimum setting is -6 dB and the maximum is 9 dB.}
38 \opt{ipodnano,ipodcolor}{This emphasises or suppresses the 38 \opt{ipodvideo}{The minimum setting is -12 dB and the maximum is 12 dB.}
39 lower frequency (bass) sounds in the track. 0dB means that bass in unaltered 39 \opt{x5,sansa,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.}
40 (flat response). The minimum setting is -6dB and the maximum is 9dB.}
41 \opt{ipodvideo}{This emphasises or suppresses the
42 lower frequency (bass) sounds in the track. 0dB means that bass in unaltered
43 (flat response). The minimum setting is -12dB and the maximum is 12dB.}
44 \opt{x5,sansa,h10,h10_5gb}{This emphasises or suppresses the
45 lower frequency (bass) sounds in the track. 0dB means that bass in unaltered
46 (flat response). The minimum setting is -24dB and the maximum is 24dB.}
47 40
48\opt{ipodvideo}{ 41\opt{ipodvideo}{
49\section{Bass Cutoff} 42\section{Bass Cutoff}
@@ -53,24 +46,16 @@ change to customise your listening experience.
53 value will vary with sample rate. 46 value will vary with sample rate.
54} 47}
55 48
56
57\section{Treble} 49\section{Treble}
58 \opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the 50 This setting emphasises
59 higher (treble) sounds in the track. 0 means that treble sounds are 51 \nopt{h1xx,h300}{or suppresses}
60 unaltered (flat response).} 52 the higher (treble) frequencies in the sound. A value of 0 dB means that
61 \opt{h1xx,h300}{The Treble setting can be used to increase (but not decrease) 53 treble sounds are unaltered (flat response).
62 frequencies above 1.5kHz. Treble boost can be set from 0 to 6 dB in 54 \opt{player,recorder,recorderv2fm,ondio}{}
63 increments of 2 dB. A setting of 0 means that high frequencies are unaltered 55 \opt{h1xx,h300}{The minimum setting is 0 dB and the maximum is 6 dB.}
64 (flat response).} 56 \opt{ipodnano,ipodcolor}{The minimum setting is -6 dB and the maximum is 9 dB.}
65 \opt{ipodnano,ipodcolor}{This setting emphasises or suppresses 57 \opt{ipodvideo}{The minimum setting is -12 dB and the maximum is 12 dB.}
66 the higher frequency (treble) sounds in the track. 0dB means that treble is 58 \opt{x5,sansa,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.}
67 unaltered (flat response). The minimum setting -6dB and the maximum is 9dB.}
68 \opt{ipodvideo}{This setting emphasises or suppresses
69 the higher frequency (treble) sounds in the track. 0dB means that treble is
70 unaltered (flat response). The minimum setting -12dB and the maximum is 12dB.}
71 \opt{x5,sansa,h10,h10_5gb}{This setting emphasises or suppresses
72 the higher frequency (treble) sounds in the track. 0dB means that treble is
73 unaltered (flat response). The minimum setting -24dB and the maximum is 24dB.}
74 59
75\opt{ipodvideo}{ 60\opt{ipodvideo}{
76\section{Treble Cutoff} 61\section{Treble Cutoff}
@@ -89,7 +74,7 @@ change to customise your listening experience.
89 74
90\section{Channels} 75\section{Channels}
91 A stereo audio signal consists of two channels, left and right. The 76 A stereo audio signal consists of two channels, left and right. The
92 \setting{Channels} setting controls if these channels are to be combined in 77 \setting{Channels} setting determines if these channels are to be combined in
93 any way, and if so, in what manner they will be combined. 78 any way, and if so, in what manner they will be combined.
94 Available options are: 79 Available options are:
95 % 80 %
@@ -154,19 +139,19 @@ change to customise your listening experience.
154 values like 20ms are useful for ensuring a constant volume for in-car use and 139 values like 20ms are useful for ensuring a constant volume for in-car use and
155 other applications where background noise makes a constant loudness desirable. 140 other applications where background noise makes a constant loudness desirable.
156 A longer timeout means that the change in volume back to the previous level 141 A longer timeout means that the change in volume back to the previous level
157 will be smoother, so there will be less sharp changes in volume level. 142 will be smoother, so there will be fewer sharp changes in volume level.
158} 143}
159 144
160\opt{recorder,recorderv2fm}{ 145\opt{recorder,recorderv2fm}{
161\section{Super Bass} 146\section{Super Bass}
162 This setting changes the threshold at which bass frequencies are affected by 147 This setting changes the threshold at which bass frequencies are affected by
163 the \setting{Loudness} setting, making the sound of drums and bass guitar 148 the \setting{Loudness} setting, making the sound of drums and bass guitar
164 louder in comparison to the rest of the track. This setting only has an 149 louder in comparison to the rest of the sound. This setting only has an
165 effect if \setting{Loudness} is set to a value larger than 0dB. 150 effect if \setting{Loudness} is set to a value larger than 0dB.
166} 151}
167 152
168\opt{recorder,recorderv2fm}{ 153\opt{recorder,recorderv2fm}{
169\section{MDB {}- Micronas Dynamic Bass} 154\section{MDB {}-- Micronas Dynamic Bass}
170 The rest of the parameters in this menu relate to the Micronas Dynamic 155 The rest of the parameters in this menu relate to the Micronas Dynamic
171 Bass (MDB) function. MDB is designed to enable the user to hear bass 156 Bass (MDB) function. MDB is designed to enable the user to hear bass
172 notes that the headphones and/or speakers are not capable of reproducing. 157 notes that the headphones and/or speakers are not capable of reproducing.
@@ -177,8 +162,7 @@ change to customise your listening experience.
177 162
178 The practical upshot of this is that MDB produces a more authentic sounding 163 The practical upshot of this is that MDB produces a more authentic sounding
179 bass by tricking the brain into believing it is hearing tones that the 164 bass by tricking the brain into believing it is hearing tones that the
180 headphones or speakers are not capable of reproducing. Try it and see 165 headphones or speakers are not capable of reproducing.
181 what you think.
182 166
183 The MDB parameters are as follows: 167 The MDB parameters are as follows:
184 % 168 %
@@ -329,7 +313,7 @@ change to customise your listening experience.
329 except that it works on the high end of the frequency spectrum rather 313 except that it works on the high end of the frequency spectrum rather
330 than the low end. 314 than the low end.
331 \end{description} 315 \end{description}
332 As a general guide, EQ band 0 should be used for lows, EQ bands 1 316 As a general guide, EQ band 0 should be used for low frequencies, EQ bands 1
333 through 3 should be used for mids, and EQ band 4 should be used for highs. 317 through 3 should be used for mids, and EQ band 4 should be used for highs.
334 318
335\begin {description} 319\begin {description}
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 9cff4819f8..ae40ac2061 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -3,8 +3,8 @@
3 3
4\opt{ipodnano}{ 4\opt{ipodnano}{
5 \note{Rockbox presently runs only on the original Ipod Nano. Rockbox does 5 \note{Rockbox presently runs only on the original Ipod Nano. Rockbox does
6 \emph{not} run on the newer, second generation Ipod Nano (the all aluminium 6 \emph{not} run on the newer second and third generation Ipod Nano. For
7 version). For information on identifying which Ipod you own, see this page on 7 information on identifying which Ipod you own, see this page on
8 Apple's website: \url{http://www.info.apple.com/kbnum/n61688}. 8 Apple's website: \url{http://www.info.apple.com/kbnum/n61688}.
9 } 9 }
10} 10}
@@ -41,8 +41,8 @@ installation options.
41\begin{description} 41\begin{description}
42\opt{HAVE_RB_BL_ON_DISK}{ 42\opt{HAVE_RB_BL_ON_DISK}{
43\item[The \playerman{} bootloader.] 43\item[The \playerman{} bootloader.]
44 The \playerman{} bootloader is the program that tells your \dap{} how to boot 44 The \playerman{} bootloader is the program that tells your \dap{} how to load
45 and load the firmware from disk. It is also responsible for the 45 and start the firmware from disk. It is also responsible for the
46 disk mode on your \dap{}. 46 disk mode on your \dap{}.
47 47
48 This bootloader is stored in special flash memory in your \playerman{}. 48 This bootloader is stored in special flash memory in your \playerman{}.
@@ -58,7 +58,7 @@ installation options.
58 58
59 \opt{HAVE_RB_BL_IN_FLASH}{ 59 \opt{HAVE_RB_BL_IN_FLASH}{
60 The bootloader is the program that tells your 60 The bootloader is the program that tells your
61 \dap{} how to boot and load other components of Rockbox. This is the 61 \dap{} how to load and start other components of Rockbox. This is the
62 component of Rockbox that is installed to the flash memory of your 62 component of Rockbox that is installed to the flash memory of your
63 \playerman.} 63 \playerman.}
64 64
@@ -77,10 +77,10 @@ installation options.
77 77
78\nopt{player} { 78\nopt{player} {
79 Apart from the required parts there are some addons you might be interested 79 Apart from the required parts there are some addons you might be interested
80 in installing too. 80 in installing.
81 \begin{description} 81 \begin{description}
82 \item[Fonts.] Rockbox can load custom fonts. The fonts are 82 \item[Fonts.] Rockbox can load custom fonts. The fonts are
83 distributed as separate package and thus needs to be installed 83 distributed as a separate package and thus need to be installed
84 separately. They are not required to run Rockbox itself but 84 separately. They are not required to run Rockbox itself but
85 a lot of themes require the fonts package to be installed. 85 a lot of themes require the fonts package to be installed.
86 86
@@ -93,9 +93,8 @@ installation options.
93\section{Prerequisites}\label{sec:prerequisites} 93\section{Prerequisites}\label{sec:prerequisites}
94\index{Installation!Prerequisites} 94\index{Installation!Prerequisites}
95Before installing Rockbox you should make sure you meet the prerequisites. 95Before installing Rockbox you should make sure you meet the prerequisites.
96You may need some additional tools for installation. In most cases these will be 96You may need some additional tools for installation. In most cases these will already be available on your computer, but if not, installing some additional
97already available on your computer but if not you need to get some additional 97software might be necessary.
98software.
99 98
100\begin{description} 99\begin{description}
101\item[USB connection.] To transfer Rockbox to your \dap{} you need to 100\item[USB connection.] To transfer Rockbox to your \dap{} you need to
@@ -140,11 +139,10 @@ For manual installation and customization additional software is required.
140\begin{description} 139\begin{description}
141\item[ZIP utility.]\index{zip} 140\item[ZIP utility.]\index{zip}
142 Rockbox is distributed as a compressed archive using the 141 Rockbox is distributed as a compressed archive using the
143 \fname{.zip} format, so you'll need a tool which can open it. 142 \fname{.zip} format. Your computer will normally already have a means of
144 Usually your computer will have a tool already installed that can 143 handling such archive files. Windows XP has built-in support for
145 do this. Windows XP has built-in support for 144 \fname{.zip} files and presents them to you as directories unless you
146 \fname{.zip} files and presents them to you as directories unless you have 145 have installed a third party program that handles compressed files. For
147 installed a third party program that handles compressed files. For
148 other operating systems this may vary. If the \fname{.zip} file format 146 other operating systems this may vary. If the \fname{.zip} file format
149 is not recognised on your computer you can find a program to handle them 147 is not recognised on your computer you can find a program to handle them
150 at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/}, both of 148 at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/}, both of
@@ -158,9 +156,9 @@ For manual installation and customization additional software is required.
158 156
159\opt{ipod}{ 157\opt{ipod}{
160 \note{In addition to the requirements described above, Rockbox only works on 158 \note{In addition to the requirements described above, Rockbox only works on
161 Ipods formatted with the FAT32 filesystem (i.e. Ipods initialized by iTunes 159 Ipods formatted with the FAT32 filesystem (i.e. Ipods initialized by Itunes
162 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods 160 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
163 initialized by iTunes for the Mac). More information and instructions for 161 initialized by Itunes for the Mac). More information and instructions for
164 converting an Ipod to FAT32 can be found on the 162 converting an Ipod to FAT32 can be found on the
165 \wikilink{IpodConversionToFAT32} wiki 163 \wikilink{IpodConversionToFAT32} wiki
166 page on the Rockbox website. Note that after conversion, you can still use 164 page on the Rockbox website. Note that after conversion, you can still use
@@ -180,7 +178,7 @@ For manual installation and customization additional software is required.
1801.05 or greater which may not be available on the download site yet.}} 1781.05 or greater which may not be available on the download site yet.}}
181 179
182To automatically install Rockbox, download the official installer and 180To automatically install Rockbox, download the official installer and
183housekeeping tool \textsc{Rockbox Utility}. It allows you to 181housekeeping tool \textsc{Rockbox Utility}. It allows you to:
184\begin{itemize} 182\begin{itemize}
185\item Automatically install all needed components for using Rockbox 183\item Automatically install all needed components for using Rockbox
186 (``Small Installation'') 184 (``Small Installation'')
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index fdaf2a45f8..35e4c2649d 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -27,7 +27,7 @@ and filenames spelled out or spoken.
27 27
28\section{Getting more help} 28\section{Getting more help}
29This manual is intended to be a comprehensive introduction to the Rockbox 29This manual is intended to be a comprehensive introduction to the Rockbox
30firmware. There is, however, more help available. The Rockbox website at 30firmware. There is, however, more help available. The Rockbox website at
31\url{http://www.rockbox.org/} contains very extensive documentation and guides 31\url{http://www.rockbox.org/} contains very extensive documentation and guides
32written by members of the Rockbox community and this should be your first port 32written by members of the Rockbox community and this should be your first port
33of call when looking for further help. 33of call when looking for further help.
@@ -47,7 +47,7 @@ can be found at \url{http://www.rockbox.org/irc/}. We also have a web client
47for joining the rockbox IRC channel so there is no need for you 47for joining the rockbox IRC channel so there is no need for you
48to install additional software to your computer. 48to install additional software to your computer.
49 49
50If you think you found a bug please make sure it actually is a bug and is 50If you think you have found a bug please make sure it actually is a bug and is
51still present in the most recent version of rockbox. You should try to 51still present in the most recent version of rockbox. You should try to
52confirm that by using the above mentioned support channels first. After that 52confirm that by using the above mentioned support channels first. After that
53you can submit that issue to our tracker. Refer to \reference{sec:feedback} 53you can submit that issue to our tracker. Refer to \reference{sec:feedback}
diff --git a/manual/plugins/brickmania.tex b/manual/plugins/brickmania.tex
index d8966b41f2..2c7a49211a 100644
--- a/manual/plugins/brickmania.tex
+++ b/manual/plugins/brickmania.tex
@@ -3,10 +3,10 @@
3{img:brickmania} 3{img:brickmania}
4BrickMania is a clone of the classic game Breakout. The aim of the game is to 4BrickMania is a clone of the classic game Breakout. The aim of the game is to
5destroy all the bricks by hitting them with the ball once or more. Sometimes a 5destroy all the bricks by hitting them with the ball once or more. Sometimes a
6special falls down when you destroy a brick. For a special to take effect, you 6special item falls down when you destroy a brick. For a special item to take
7must catch it with the paddle. Look out for the bad ones.\\ 7effect, you must catch it with the paddle. Look out for the bad ones.\\
8 8
9\subsubsection{Specials} 9\subsubsection{Special items}
10\begin{table} 10\begin{table}
11 \begin{center} 11 \begin{center}
12 \begin{tabularx}{.75\textwidth}{clX}\toprule 12 \begin{tabularx}{.75\textwidth}{clX}\toprule
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 3838c2e91b..d5f101b310 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -1,10 +1,10 @@
1% $Id$ % 1% $Id$ %
2\chapter{Plugins}\label{ref:plugins} 2\chapter{Plugins}\label{ref:plugins}
3Plugins are little programs that Rockbox can load and run. Only one plugin can 3Plugins are programs that Rockbox can load and run. Only one plugin can
4be loaded at a time. Plugins have exclusive control over the user interface. 4be loaded at a time. Plugins have exclusive control over the user interface.
5This means you cannot switch back and forth between a plugin and Rockbox, a 5This means you cannot switch back and forth between a plugin and Rockbox. When
6plugin is loaded, run and then exited, which returns control to Rockbox. Most 6a plugin is loaded, you need to exit it to return to the Rockbox interface.
7plugins will not interfere with music playback but some of them will stop 7Most plugins will not interfere with music playback but some of them will stop
8playback while running. Plugins have the file extension \fname{.rock}. Most of 8playback while running. Plugins have the file extension \fname{.rock}. Most of
9them can be started from \setting{Browse Plugins} in the \setting{Main Menu}. 9them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.
10 10
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index c637268fa2..c4b9e35835 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -12,37 +12,36 @@
12 12
13\end{center} 13\end{center}
14 14
15Throughout this manual, the buttons on the \dap{} are labelled according to the 15Throughout this manual, the buttons on the \dap{} are labeled according to the
16picture above. When a table of button actions says ``Long'' before the button it 16picture above. Whenever a button name is prefixed by ``Long'', a long press of
17means that you should make a long press on that button, in other words, press it 17approximately one second should be performed on that button. The buttons are
18for approximately 1 second. In detail the buttons are described in the following 18described in detail in the following paragraph.
19paragraph.
20 19
21\blind{ 20\blind{
22 Additional information is available for blind users on the Rockbox website at 21 Additional information for blind users is available on the Rockbox website at
23 \wikilink{BlindFAQ}. 22 \wikilink{BlindFAQ}.
24 23
25 % 24 %
26 \opt{h1xx}{ 25 \opt{h1xx}{
27 If you lay the \dap{} on the table with the joystick pointing 26 If you put the \dap{} on a table with the joystick pointing
28 towards you, and the curved sides at the top, you will find the following 27 towards you, and the curved sides at the top, you will find the following
29 if you start from the top-right corner and follow the side of the \dap{} in a 28 if you start from the top-right corner and follow the side of the \dap{} in a
30 clockwise direction: 29 clockwise direction:
31 On the right side the buttons \ButtonOn{}, \ButtonOff{}, \ButtonMode{} and 30 On the right side the buttons \ButtonOn{}, \ButtonOff{}, \ButtonMode{} and
32 the \ButtonHold{} switch. Next comes on the bottom the USB port, 31 the \ButtonHold{} switch. Next comes the USB port on the bottom,
33 a small hole for resetting the \dap{}, charger plug. On the left side located 32 a small hole for resetting the \dap{}, then the charger plug. On the left
34 is the button \ButtonRec{}. At least the top has headphone mini-jack plug, 33 side is the \ButtonRec{} button. The top has a headphone mini-jack plug,
35 remote port, optical/line in and optical/line out. 34 remote port, optical/line in and optical/line out connectors.
36 The joystick in the middle of the \dap{} is 35 The joystick in the middle of the \dap{} is
37 used to navigate menus by pressing it up, down, left and right. Pressing the 36 used to navigate menus by pressing it up, down, left and right. Pressing the
38 joystick down is labelled \ButtonSelect{} throughout this manual. Its 37 joystick button is labeled \ButtonSelect{} throughout this manual. Its
39 directions are labelled \ButtonRight{}, \ButtonDown{}, \ButtonLeft{} and 38 directions are labelled \ButtonRight{}, \ButtonDown{}, \ButtonLeft{} and
40 \ButtonUp{}. 39 \ButtonUp{}.
41 40
42 The internal microphone is located on the left hand side of the nit towards the 41 The internal microphone is located on the left hand side of the nit towards the
43 top, and there is a small reset hole on the bottom of the unit between the 42 top. As mentioned, there is a small hole on the bottom of the unit
44 power and USB sockets. To perform a hard reset, insert a paperclip into this 43 between the power and USB sockets. You can hard-reset the device by inserting
45 hole.} 44 a paperclip into this hole.}
46 % 45 %
47 \opt{h300}{ 46 \opt{h300}{
48 Hold or lay the \dap{} so that the side with the button pad and 47 Hold or lay the \dap{} so that the side with the button pad and