summaryrefslogtreecommitdiffstats
path: root/manual
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 /manual
parent167a27dd76849c0ea8ed13d58297e334a9a90a1e (diff)
downloadrockbox-3a74208d4e5a67d86c4b1b978ebf5ecfb0347a55.tar.gz
rockbox-3a74208d4e5a67d86c4b1b978ebf5ecfb0347a55.tar.bz2
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
Diffstat (limited to 'manual')
-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 @@
% $Id$ %
\screenshot{configure_rockbox/images/ss-sound-settings}{The sound settings screen}{}
-The Sound Settings menu offers a selection of sound properties you may
+The sound settings menu offers a selection of sound settings you may
change to customise your listening experience.
\section{\label{ref:volume}Volume}
@@ -28,22 +28,15 @@ change to customise your listening experience.
\opt{ipod3g,ipod4g,gigabeatf,mrobe100}{\fixme{add correct volume range.}}
\section{Bass}
- \opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the
- lower (bass) frequencies in the track. 0 means that bass sounds are unaltered
- (flat response).}
- \opt{h1xx,h300}{The bass setting can be used to increase (but not decrease)
- frequencies below 300Hz. Bass boost can be set from 0 to 24 dB in
- increments of 2 dB. A setting of 0 means that low frequencies are unaltered
- (flat response).}
- \opt{ipodnano,ipodcolor}{This emphasises or suppresses the
- lower frequency (bass) sounds in the track. 0dB means that bass in unaltered
- (flat response). The minimum setting is -6dB and the maximum is 9dB.}
- \opt{ipodvideo}{This emphasises or suppresses the
- lower frequency (bass) sounds in the track. 0dB means that bass in unaltered
- (flat response). The minimum setting is -12dB and the maximum is 12dB.}
- \opt{x5,sansa,h10,h10_5gb}{This emphasises or suppresses the
- lower frequency (bass) sounds in the track. 0dB means that bass in unaltered
- (flat response). The minimum setting is -24dB and the maximum is 24dB.}
+ This setting emphasises
+ \nopt{h1xx,h300}{or suppresses}
+ the lower (bass) frequencies in the sound. A value of 0 dB means that bass
+ sounds are unaltered (flat response).
+ \opt{player,recorder,recorderv2fm,ondio}{}
+ \opt{h1xx,h300}{The minimum setting is 0 dB and the maximum is 24 dB.}
+ \opt{ipodnano,ipodcolor}{The minimum setting is -6 dB and the maximum is 9 dB.}
+ \opt{ipodvideo}{The minimum setting is -12 dB and the maximum is 12 dB.}
+ \opt{x5,sansa,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.}
\opt{ipodvideo}{
\section{Bass Cutoff}
@@ -53,24 +46,16 @@ change to customise your listening experience.
value will vary with sample rate.
}
-
\section{Treble}
- \opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the
- higher (treble) sounds in the track. 0 means that treble sounds are
- unaltered (flat response).}
- \opt{h1xx,h300}{The Treble setting can be used to increase (but not decrease)
- frequencies above 1.5kHz. Treble boost can be set from 0 to 6 dB in
- increments of 2 dB. A setting of 0 means that high frequencies are unaltered
- (flat response).}
- \opt{ipodnano,ipodcolor}{This setting emphasises or suppresses
- the higher frequency (treble) sounds in the track. 0dB means that treble is
- unaltered (flat response). The minimum setting -6dB and the maximum is 9dB.}
- \opt{ipodvideo}{This setting emphasises or suppresses
- the higher frequency (treble) sounds in the track. 0dB means that treble is
- unaltered (flat response). The minimum setting -12dB and the maximum is 12dB.}
- \opt{x5,sansa,h10,h10_5gb}{This setting emphasises or suppresses
- the higher frequency (treble) sounds in the track. 0dB means that treble is
- unaltered (flat response). The minimum setting -24dB and the maximum is 24dB.}
+ This setting emphasises
+ \nopt{h1xx,h300}{or suppresses}
+ the higher (treble) frequencies in the sound. A value of 0 dB means that
+ treble sounds are unaltered (flat response).
+ \opt{player,recorder,recorderv2fm,ondio}{}
+ \opt{h1xx,h300}{The minimum setting is 0 dB and the maximum is 6 dB.}
+ \opt{ipodnano,ipodcolor}{The minimum setting is -6 dB and the maximum is 9 dB.}
+ \opt{ipodvideo}{The minimum setting is -12 dB and the maximum is 12 dB.}
+ \opt{x5,sansa,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.}
\opt{ipodvideo}{
\section{Treble Cutoff}
@@ -89,7 +74,7 @@ change to customise your listening experience.
\section{Channels}
A stereo audio signal consists of two channels, left and right. The
- \setting{Channels} setting controls if these channels are to be combined in
+ \setting{Channels} setting determines if these channels are to be combined in
any way, and if so, in what manner they will be combined.
Available options are:
%
@@ -154,19 +139,19 @@ change to customise your listening experience.
values like 20ms are useful for ensuring a constant volume for in-car use and
other applications where background noise makes a constant loudness desirable.
A longer timeout means that the change in volume back to the previous level
- will be smoother, so there will be less sharp changes in volume level.
+ will be smoother, so there will be fewer sharp changes in volume level.
}
\opt{recorder,recorderv2fm}{
\section{Super Bass}
This setting changes the threshold at which bass frequencies are affected by
the \setting{Loudness} setting, making the sound of drums and bass guitar
- louder in comparison to the rest of the track. This setting only has an
+ louder in comparison to the rest of the sound. This setting only has an
effect if \setting{Loudness} is set to a value larger than 0dB.
}
\opt{recorder,recorderv2fm}{
-\section{MDB {}- Micronas Dynamic Bass}
+\section{MDB {}-- Micronas Dynamic Bass}
The rest of the parameters in this menu relate to the Micronas Dynamic
Bass (MDB) function. MDB is designed to enable the user to hear bass
notes that the headphones and/or speakers are not capable of reproducing.
@@ -177,8 +162,7 @@ change to customise your listening experience.
The practical upshot of this is that MDB produces a more authentic sounding
bass by tricking the brain into believing it is hearing tones that the
- headphones or speakers are not capable of reproducing. Try it and see
- what you think.
+ headphones or speakers are not capable of reproducing.
The MDB parameters are as follows:
%
@@ -329,7 +313,7 @@ change to customise your listening experience.
except that it works on the high end of the frequency spectrum rather
than the low end.
\end{description}
- As a general guide, EQ band 0 should be used for lows, EQ bands 1
+ As a general guide, EQ band 0 should be used for low frequencies, EQ bands 1
through 3 should be used for mids, and EQ band 4 should be used for highs.
\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 @@
\opt{ipodnano}{
\note{Rockbox presently runs only on the original Ipod Nano. Rockbox does
- \emph{not} run on the newer, second generation Ipod Nano (the all aluminium
- version). For information on identifying which Ipod you own, see this page on
+ \emph{not} run on the newer second and third generation Ipod Nano. For
+ information on identifying which Ipod you own, see this page on
Apple's website: \url{http://www.info.apple.com/kbnum/n61688}.
}
}
@@ -41,8 +41,8 @@ installation options.
\begin{description}
\opt{HAVE_RB_BL_ON_DISK}{
\item[The \playerman{} bootloader.]
- The \playerman{} bootloader is the program that tells your \dap{} how to boot
- and load the firmware from disk. It is also responsible for the
+ The \playerman{} bootloader is the program that tells your \dap{} how to load
+ and start the firmware from disk. It is also responsible for the
disk mode on your \dap{}.
This bootloader is stored in special flash memory in your \playerman{}.
@@ -58,7 +58,7 @@ installation options.
\opt{HAVE_RB_BL_IN_FLASH}{
The bootloader is the program that tells your
- \dap{} how to boot and load other components of Rockbox. This is the
+ \dap{} how to load and start other components of Rockbox. This is the
component of Rockbox that is installed to the flash memory of your
\playerman.}
@@ -77,10 +77,10 @@ installation options.
\nopt{player} {
Apart from the required parts there are some addons you might be interested
- in installing too.
+ in installing.
\begin{description}
\item[Fonts.] Rockbox can load custom fonts. The fonts are
- distributed as separate package and thus needs to be installed
+ distributed as a separate package and thus need to be installed
separately. They are not required to run Rockbox itself but
a lot of themes require the fonts package to be installed.
@@ -93,9 +93,8 @@ installation options.
\section{Prerequisites}\label{sec:prerequisites}
\index{Installation!Prerequisites}
Before installing Rockbox you should make sure you meet the prerequisites.
-You may need some additional tools for installation. In most cases these will be
-already available on your computer but if not you need to get some additional
-software.
+You may need some additional tools for installation. In most cases these will already be available on your computer, but if not, installing some additional
+software might be necessary.
\begin{description}
\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.
\begin{description}
\item[ZIP utility.]\index{zip}
Rockbox is distributed as a compressed archive using the
- \fname{.zip} format, so you'll need a tool which can open it.
- Usually your computer will have a tool already installed that can
- do this. Windows XP has built-in support for
- \fname{.zip} files and presents them to you as directories unless you have
- installed a third party program that handles compressed files. For
+ \fname{.zip} format. Your computer will normally already have a means of
+ handling such archive files. Windows XP has built-in support for
+ \fname{.zip} files and presents them to you as directories unless you
+ have installed a third party program that handles compressed files. For
other operating systems this may vary. If the \fname{.zip} file format
is not recognised on your computer you can find a program to handle them
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.
\opt{ipod}{
\note{In addition to the requirements described above, Rockbox only works on
- Ipods formatted with the FAT32 filesystem (i.e. Ipods initialized by iTunes
+ Ipods formatted with the FAT32 filesystem (i.e. Ipods initialized by Itunes
for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
- initialized by iTunes for the Mac). More information and instructions for
+ initialized by Itunes for the Mac). More information and instructions for
converting an Ipod to FAT32 can be found on the
\wikilink{IpodConversionToFAT32} wiki
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.
1.05 or greater which may not be available on the download site yet.}}
To automatically install Rockbox, download the official installer and
-housekeeping tool \textsc{Rockbox Utility}. It allows you to
+housekeeping tool \textsc{Rockbox Utility}. It allows you to:
\begin{itemize}
\item Automatically install all needed components for using Rockbox
(``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.
\section{Getting more help}
This manual is intended to be a comprehensive introduction to the Rockbox
-firmware. There is, however, more help available. The Rockbox website at
+firmware. There is, however, more help available. The Rockbox website at
\url{http://www.rockbox.org/} contains very extensive documentation and guides
written by members of the Rockbox community and this should be your first port
of 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
for joining the rockbox IRC channel so there is no need for you
to install additional software to your computer.
-If you think you found a bug please make sure it actually is a bug and is
+If you think you have found a bug please make sure it actually is a bug and is
still present in the most recent version of rockbox. You should try to
confirm that by using the above mentioned support channels first. After that
you 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 @@
{img:brickmania}
BrickMania is a clone of the classic game Breakout. The aim of the game is to
destroy all the bricks by hitting them with the ball once or more. Sometimes a
-special falls down when you destroy a brick. For a special to take effect, you
-must catch it with the paddle. Look out for the bad ones.\\
+special item falls down when you destroy a brick. For a special item to take
+effect, you must catch it with the paddle. Look out for the bad ones.\\
-\subsubsection{Specials}
+\subsubsection{Special items}
\begin{table}
\begin{center}
\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 @@
% $Id$ %
\chapter{Plugins}\label{ref:plugins}
-Plugins are little programs that Rockbox can load and run. Only one plugin can
+Plugins are programs that Rockbox can load and run. Only one plugin can
be loaded at a time. Plugins have exclusive control over the user interface.
-This means you cannot switch back and forth between a plugin and Rockbox, a
-plugin is loaded, run and then exited, which returns control to Rockbox. Most
-plugins will not interfere with music playback but some of them will stop
+This means you cannot switch back and forth between a plugin and Rockbox. When
+a plugin is loaded, you need to exit it to return to the Rockbox interface.
+Most plugins will not interfere with music playback but some of them will stop
playback while running. Plugins have the file extension \fname{.rock}. Most of
them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.
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 @@
\end{center}
-Throughout this manual, the buttons on the \dap{} are labelled according to the
-picture above. When a table of button actions says ``Long'' before the button it
-means that you should make a long press on that button, in other words, press it
-for approximately 1 second. In detail the buttons are described in the following
-paragraph.
+Throughout this manual, the buttons on the \dap{} are labeled according to the
+picture above. Whenever a button name is prefixed by ``Long'', a long press of
+approximately one second should be performed on that button. The buttons are
+described in detail in the following paragraph.
\blind{
- Additional information is available for blind users on the Rockbox website at
+ Additional information for blind users is available on the Rockbox website at
\wikilink{BlindFAQ}.
%
\opt{h1xx}{
- If you lay the \dap{} on the table with the joystick pointing
+ If you put the \dap{} on a table with the joystick pointing
towards you, and the curved sides at the top, you will find the following
if you start from the top-right corner and follow the side of the \dap{} in a
clockwise direction:
On the right side the buttons \ButtonOn{}, \ButtonOff{}, \ButtonMode{} and
- the \ButtonHold{} switch. Next comes on the bottom the USB port,
- a small hole for resetting the \dap{}, charger plug. On the left side located
- is the button \ButtonRec{}. At least the top has headphone mini-jack plug,
- remote port, optical/line in and optical/line out.
+ the \ButtonHold{} switch. Next comes the USB port on the bottom,
+ a small hole for resetting the \dap{}, then the charger plug. On the left
+ side is the \ButtonRec{} button. The top has a headphone mini-jack plug,
+ remote port, optical/line in and optical/line out connectors.
The joystick in the middle of the \dap{} is
used to navigate menus by pressing it up, down, left and right. Pressing the
- joystick down is labelled \ButtonSelect{} throughout this manual. Its
+ joystick button is labeled \ButtonSelect{} throughout this manual. Its
directions are labelled \ButtonRight{}, \ButtonDown{}, \ButtonLeft{} and
\ButtonUp{}.
The internal microphone is located on the left hand side of the nit towards the
- top, and there is a small reset hole on the bottom of the unit between the
- power and USB sockets. To perform a hard reset, insert a paperclip into this
- hole.}
+ top. As mentioned, there is a small hole on the bottom of the unit
+ between the power and USB sockets. You can hard-reset the device by inserting
+ a paperclip into this hole.}
%
\opt{h300}{
Hold or lay the \dap{} so that the side with the button pad and