diff options
Diffstat (limited to 'manual')
| -rwxr-xr-x | manual/configure_rockbox/file_view.tex | 118 | ||||
| -rwxr-xr-x | manual/configure_rockbox/playback_options.tex | 353 | ||||
| -rwxr-xr-x | manual/configure_rockbox/sound_settings.tex | 4 | ||||
| -rwxr-xr-x | manual/getting_started/ipod_install.tex | 2 | ||||
| -rw-r--r-- | manual/getting_started/main.tex | 4 | ||||
| -rw-r--r-- | manual/main_menu/main.tex | 12 | ||||
| -rw-r--r-- | manual/plugins/main.tex | 2 | ||||
| -rw-r--r-- | manual/plugins/wormlet.tex | 2 | ||||
| -rw-r--r-- | manual/rockbox_interface/tagcache.tex | 123 | ||||
| -rw-r--r-- | manual/rockbox_interface/wps.tex | 2 |
10 files changed, 319 insertions, 303 deletions
diff --git a/manual/configure_rockbox/file_view.tex b/manual/configure_rockbox/file_view.tex index 5170215bd4..dfbbb3aa8f 100755 --- a/manual/configure_rockbox/file_view.tex +++ b/manual/configure_rockbox/file_view.tex @@ -1,64 +1,64 @@ % $Id$ % \section{File View} - The File View menu deals with options relating to how the File Browser - displays files. +The File View menu deals with options relating to how the File Browser +displays files. +% +\begin{description} +\item[Sort Case Sensitive:] + If this option is set to \setting{Yes}, all files that start with upper case + letters will be listed first, followed by all files that begin with lower + case letters. If this option is set to NO, then case will be ignored when + sorting files. +\item[Sort Directories:] + This option controls how Rockbox sorts folders. The default is to sort + them alphabetically. \setting{By date} sorts them with the oldest folder first. + \setting{By newest date} sorts them with the newest folder first. + +\item[Sort Files:] + This option controls how Rockbox sorts files. All of the options for + \setting{Sort Directories} are available in this option. In addition, there + is a \setting{By type} option which sorts files alphabetically by their type + (such as \fname{.mp3}) then alphabetically within each type. + +\item[\label{ref:ShowFiles}Show Files:] + This option controls which files are displayed in the File Browser. % \begin{description} - \item[Sort Case Sensitive:] - If this option is set to \setting{Yes}, all files that start with upper case - letters will be listed first, followed by all files that begin with lower - case letters. If this option is set to NO, then case will be ignored when - sorting files. - \item[Sort Directories:] - This option controls how Rockbox sorts folders. The default is to sort - them alphabetically. \setting{By date} sorts them with the oldest folder first. - \setting{By newest date} sorts them with the newest folder first. - - \item[Sort Files:] - This option controls how Rockbox sorts files. All of the options for - \setting{Sort Directories} are available in this option. In addition, there - is a \setting{By type} option which sorts files alphabetically by their type - (such as \fname{.mp3}) then alphabetically within each type. - - \item[\label{ref:ShowFiles}Show Files:] - This option controls which files are displayed in the File Browser. - % - \begin{description} - \item[All:] The File Browser displays all files and directories. - Extensions are shown. No files or directories are hidden. - \item[ID3 Database:] This shows the files based on the Tag Cache - information, thus disabling the file browser. You can browse the - database by various tags and search them. Only information present - in music file tags are shown. For a detailed description of Tag Cache - refer to \reference{ref:tagcache}. - \item[Playlists:] The File Browser displays only directories and playlists, - for simplified navigation. - \item[Music:] The File Browser displays only folders, \fname{.m3u} files - and the supported \emph{audio} file formats. Extensions are stripped. - Files and directories starting with \fname{.} or with the ``hidden'' - flag set are hidden. - \item[Supported:] The File Browser displays all directories and files - supported by Rockbox (see \reference{ref:Supportedfileformats}). - Files and directories starting with \fname{.} or with the ``hidden'' - flag set are hidden. - \end{description} - - \item[Follow Playlist:] - This option determine what directory the File Browser - displays first. If \setting{Follow Playlist} is set to \setting{Yes}, when - you enter the File Browser from the WPS, you will find yourself in the same - directory as the currently playing file. If \setting{Follow Playlist} is set - to \setting{No}, when you enter the File Browser from the WPS, you will find - yourself in the directory you were in when you last left the File Browser. - - \item[Show Icons:] - Rockbox has the ability to display an icon to the left of the file - in the File Browser. For details of these icons, please see - \reference{ref:Supportedfileformats}. - - \item[Tag Cache:] - This option allows you to configure the Tag Cache. - See \reference{ref:tagcache} for more information about using - the Tag Cache. - + \item[All:] The File Browser displays all files and directories. + Extensions are shown. No files or directories are hidden. + \item[ID3 Database:] This shows the files based on the Tag Cache + information, thus disabling the file browser. You can browse the + database by various tags and search them. Only information present + in music file tags are shown. For a detailed description of Tag Cache + refer to \reference{ref:tagcache}. + \item[Playlists:] The File Browser displays only directories and playlists, + for simplified navigation. + \item[Music:] The File Browser displays only folders, \fname{.m3u} files + and the supported \emph{audio} file formats. Extensions are stripped. + Files and directories starting with \fname{.} or with the ``hidden'' + flag set are hidden. + \item[Supported:] The File Browser displays all directories and files + supported by Rockbox (see \reference{ref:Supportedfileformats}). + Files and directories starting with \fname{.} or with the ``hidden'' + flag set are hidden. \end{description} + +\item[Follow Playlist:] + This option determines what directory the File Browser displays first. If + \setting{Follow Playlist} is set to \setting{Yes}, when you enter the File + Browser from the WPS, you will find yourself in the same directory as the + currently playing file. If \setting{Follow Playlist} is set to \setting{No}, + when you enter the File Browser from the WPS, you will find yourself in the + directory you were in when you last left the File Browser. + +\item[Show Icons:] + Rockbox has the ability to display an icon to the left of the file + in the File Browser. For details of these icons, please see + \reference{ref:Supportedfileformats}. + +\item[Tag Cache:] + This option allows you to configure the Tag Cache. + See \reference{ref:tagcache} for more information about using + the Tag Cache. + +\end{description} diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex index 2de8a09300..e2217f136c 100755 --- a/manual/configure_rockbox/playback_options.tex +++ b/manual/configure_rockbox/playback_options.tex @@ -1,191 +1,206 @@ % $Id$ % \section{\label{ref:PlaybackOptions}Playback Options} - The \setting{Playback Options} submenu allows you to configure settings - related to audio playback. +The \setting{Playback Options} submenu allows you to configure settings +related to audio playback. +\begin{description} +\item[Shuffle: ]Alters how Rockbox will select which next song to play.\\ + Options: \setting{On}/\setting{Off}. + % +\item[Repeat: ]Configures settings related to repeating of directories or + playlists.\\ + Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle} + \nopt{ondiosp,ondiofm}{\setting{/A--B}}: \begin{description} - \item[Shuffle: ]Alters how Rockbox will select which next song to play.\\ - Options: \setting{On}/\setting{Off}. - % - \item[Repeat: ]Configures settings related to repeating of directories or - playlists.\\ - Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle} - \nopt{ondiosp,ondiofm}{\setting{/A--B}}: - \begin{description} - % - \item[Off: ]The current directory or playlist will not repeat - when it is finished. - \note{If you have the \setting{Auto change directory} option set to - \setting{Yes}, Rockbox will move on to the next directory on your - hard drive. If the \setting{Auto Change Directory} option is set to - \setting{No}, playback will stop when the current directory or - playlist is finished.} - % - \item[All: ]The current directory or playlist will repeat when it is - finished. - \note{This option does \emph{not} shuffle all files on your \dap. - Rockbox is playlist oriented. When you play a song, a directory, or - an album, Rockbox creates a playlist and plays it. Thus, to shuffle - all songs on the \dap, you need to create a playlist of all songs on - the player, and play that playlist with shuffle mode set to - \setting{All}.} - % - \item[One: ]Repeat one track over and over. - % - \item[Shuffle: ]When the current directory or playlist has finished - playing, it will be shuffled and then repeated. - % - \nopt{ondiosp,ondiofm}{ - \item[A--B: ]Repeats between two user defined point within a track, - typically used by musicians when attempting to learn a piece of music. - This option is more complicated to use that the others as the \dap\ - must first be placed into A--B repeat mode and then the start and end - points defined.\\ - \fixme{ - Hold Play and press Left --- Sets Start Point (A)\\ - Hold Play and press Right --- Sets End Point (B)\\ - } - } - \end{description} - - \item[Play Selected First: ]This setting controls what happens when you - select a file for playback while shuffle mode is on. If the - \setting{Play Selected First} setting is \setting{Yes}, the file you - selected will be played first. If this setting is \setting{No}, a random - file in the directory will be played first. - - \item[Resume: ]Rockbox can be configured to start playing automatically - when you turn on the \dap. If the resume function is set to start - automatically playing, Rockbox will start at the point where you last - turned off the \dap. The options for the \setting{Resume} function are: - \begin{description} - \item[Yes: ]Rockbox will unconditionally try to resume. - \item[No: ]Rockbox will not resume. - \emph{If resume is set to \setting{No}, Rockbox will start in the - \setting{File Browser}.} - \end{description} - \note{Earlier versions of Rockbox had an ``Ask'' setting, which would ask whether - to resume when the jukebox was turned on. This setting has been eliminated because it - was redundant. If resume is set to ``Yes'' pressing - \opt{PLAYER_PAD,RECORDER_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\fixme{FixMe}} - \opt{ONDIO_PAD}{\fixme{FixMe}} - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} - on the \dap\ will resume from the point where the \dap\ was stopped before shutdown. - - \item[Fast-Forward/Rewind: ]How fast you want search (fast forward or rewind) to accelerate - when you hold down the button. \setting{Off} means no acceleration. \setting{2x/1s} means double - the search speed once every second the button is held. \setting{2x/5s} means double the - search speed once every 5 seconds the button is held. - - \item[Anti-Skip Buffer: ]This setting allows you to control how much music is stored - in the \dap's memory whilst playing a song, acting as a buffer against shock or - playback problems. The \dap\ transfers the selected amount of the forthcoming song - into its memory at high speed whilst you are playing the song. It keeps a ``rolling'' - buffer, which keeps feeding more of the forthcoming song into memory as it goes along. - If the \dap\ is knocked, shaken or jogged heavily while Rockbox is trying to read the - hard drive, Rockbox might not be able to read the drive. Rockbox will retry over and - over again until it succeeds, but may eventually reach the end of the memory buffer. - When that happens, Rockbox must stop playing and wait for more data from the disk, - which causes your music to skip. The anti-skip setting tells Rockbox how much extra - buffer memory to spare to handle this situation. This setting therefore allows you to - reduce the chances of there being a gap or pause during playback of songs. - - \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 seconds.} + % + \item[Off: ]The current directory or playlist will not repeat + when it is finished. + \note{If you have the \setting{Auto change directory} option set to + \setting{Yes}, Rockbox will move on to the next directory on your + hard drive. If the \setting{Auto Change Directory} option is set to + \setting{No}, playback will stop when the current directory or + playlist is finished.} + % + \item[All: ]The current directory or playlist will repeat when it is + finished. + \note{This option does \emph{not} shuffle all files on your \dap. + Rockbox is playlist oriented. When you play a song, a directory, or + an album, Rockbox creates a playlist and plays it. Thus, to shuffle + all songs on the \dap, you need to create a playlist of all songs on + the player, and play that playlist with shuffle mode set to + \setting{All}.} + % + \item[One: ]Repeat one track over and over. + % + \item[Shuffle: ]When the current directory or playlist has finished + playing, it will be shuffled and then repeated. + % + \nopt{ondiosp,ondiofm}{ + \item[A--B: ]Repeats between two user defined point within a track, + typically used by musicians when attempting to learn a piece of music. + This option is more complicated to use that the others as the \dap\ + must first be placed into A--B repeat mode and then the start and end + points defined.\\ + \fixme{ + Hold Play and press Left --- Sets Start Point (A)\\ + Hold Play and press Right --- Sets End Point (B)\\ + } + } + \end{description} + +\item[Play Selected First: ]This setting controls what happens when you + select a file for playback while shuffle mode is on. If the + \setting{Play Selected First} setting is \setting{Yes}, the file you + selected will be played first. If this setting is \setting{No}, a random + file in the directory will be played first. + +\item[Resume: ]Rockbox can be configured to start playing automatically + when you turn on the \dap. If the resume function is set to start + automatically playing, Rockbox will start at the point where you last + turned off the \dap. The options for the \setting{Resume} function are: + \begin{description} + \item[Yes: ]Rockbox will unconditionally try to resume. + \item[No: ]Rockbox will not resume. + \emph{If resume is set to \setting{No}, Rockbox will start in the + \setting{File Browser}.} + \end{description} + \note{Earlier versions of Rockbox had an ``Ask'' setting, which would ask + whether to resume when the jukebox was turned on. This setting has been + eliminated because it was redundant. If resume is set to ``Yes'' pressing + \opt{PLAYER_PAD,RECORDER_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\fixme{FixMe}} + \opt{ONDIO_PAD}{\fixme{FixMe}} + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} + on the \dap\ will resume from the point where the \dap\ was stopped before + shutdown. + + \item[Fast-Forward/Rewind: ]How fast you want search (fast forward or rewind) + to accelerate when you hold down the button. \setting{Off} means no + acceleration. \setting{2x/1s} means double the search speed once every + second the button is held. \setting{2x/5s} means double the search speed + once every 5 seconds the button is held. + + \item[Anti-Skip Buffer: ]This setting allows you to control how much music is + stored in the \dap's memory whilst playing a song, acting as a buffer + against shock or playback problems. The \dap\ transfers the selected amount + of the forthcoming song into its memory at high speed whilst you are + playing the song. It keeps a ``rolling'' buffer, which keeps feeding more + of the forthcoming song into memory as it goes along. + If the \dap\ is knocked, shaken or jogged heavily while Rockbox is trying + to read the hard drive, Rockbox might not be able to read the drive. + Rockbox will retry over and over again until it succeeds, but may + eventually reach the end of the memory buffer. When that happens, Rockbox + must stop playing and wait for more data from the disk, which causes your + music to skip. The anti-skip setting tells Rockbox how much extra buffer + memory to spare to handle this situation. This setting therefore allows you + to reduce the chances of there being a gap or pause during playback of + songs. + + \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 + seconds.} \opt{SWCODEC}{The anti-skip buffer can be set to various values between 5 seconds and 10 minutes.} - + \note{Having a large anti-skip buffer tends to use more power, and may reduce your battery life. It is recommended to always use the lowest possible setting that allows correct and continuous playback.} - - \item[Fade On Stop/Pause: ]Enables and disables a fade effect when you - pause or stop playing a song. If the Fade on Stop/Pause option is - set to \setting{Yes}, your music will fade out when you stop or pause playback, - and fade in when you resume playback. - - \item[Party Mode: ]Enables unstoppable music playback. When new songs are - selected, they are added to the end of the current dynamic playlist - instead of being played immediately. - The \fixme{PLAY} and \fixme{STOP} buttons are disabled. - + + \item[Fade On Stop/Pause: ]Enables and disables a fade effect when you + pause or stop playing a song. If the Fade on Stop/Pause option is + set to \setting{Yes}, your music will fade out when you stop or pause + playback, and fade in when you resume playback. + + \item[Party Mode: ]Enables unstoppable music playback. When new songs are + selected, they are added to the end of the current dynamic playlist + instead of being played immediately. + The \fixme{PLAY} and \fixme{STOP} buttons are disabled. + \opt{SWCODEC}{ \item[Crossfade: ] - This setting enables a cross-fader. At the end of a song, the song will fade out as the - next song fades in, creating a smooth transition between songs.\\ + This setting enables a cross-fader. At the end of a song, the song will + fade out as the next song fades in, creating a smooth transition between + songs.\\ Options: - \begin{description} - \item[Enable Crossfade: ]If set to \setting{Off}, crossfade is disabled. If set to \setting{Always}, - songs will always crossfade into one another. If set to \setting{Shuffle}, crossfade is - enabled when the shuffle feature is set to \setting{Yes}, but disabled otherwise. If set to - track skip only, tracks will only crossfade when you manually change tracks. + \begin{description} + \item[Enable Crossfade: ]If set to \setting{Off}, crossfade is disabled. + If set to \setting{Always}, songs will always crossfade into one + another. If set to \setting{Shuffle}, crossfade is enabled when the + shuffle feature is set to \setting{Yes}, but disabled otherwise. If set + to track skip only, tracks will only crossfade when you manually change + tracks. % - \item[Fade In Delay: ]The ``fade in delay'' is the length of time between when the crossfade - process begins and when the new track begins to fade in. + \item[Fade In Delay: ]The ``fade in delay'' is the length of time between + when the crossfade process begins and when the new track begins to fade + in. % - \item[Fade In Duration: ]The length of time, in seconds, that it takes your music to fade in. + \item[Fade In Duration: ]The length of time, in seconds, that it takes + your music to fade in. % - \item[Fade Out Delay: ]The ``fade out delay'' is the length of time between when the crossfade - process begins and when the old track begins to fade out. + \item[Fade Out Delay: ]The ``fade out delay'' is the length of time + between when the crossfade process begins and when the old track begins + to fade out. % - \item[Fade Out Duration: ]The length of time, in seconds, that it takes your music to fade out. + \item[Fade Out Duration: ]The length of time, in seconds, that it takes + your music to fade out. % - \item[Fade Out Mode: ]If set to \setting{Crossfade}, one song will fade out and the next song will - simultaneously fade in. If set to \setting{Mix}, the ending song will continue to play as normal - until its end, while the starting song will fade in from under it. \setting{Mix} mode is not + \item[Fade Out Mode: ]If set to \setting{Crossfade}, one song will fade + out and the next song will simultaneously fade in. If set to + \setting{Mix}, the ending song will continue to play as normal until + its end, while the starting song will fade in from under it. + \setting{Mix} mode is not used for manual track skips, even if it is selected here. - \end{description} - - \note{The crossfade setting is particularly effective when the player is set on shuffle.} + \end{description} + + \note{The crossfade setting is particularly effective when the player is + set on shuffle.} } - + \opt{SWCODEC}{ - \item[Replaygain: ]This allows you to control the replaygain function. - The purpose of replaygain is to adjust the volume of the music played - so that all songs (or albums, depending on your settings) have the - same apparent volume. This prevents sudden changes in volume when - changing between songs recorded at different volume levels. - For replaygain to work, the songs must have been processed by a program - that adds replaygain information to the ID3 tags (vorbis tags - respectively). - \note{APEv2 tags are not currently supported.} - - Options for replaygain are: + \item[Replaygain: ]This allows you to control the replaygain function. + The purpose of replaygain is to adjust the volume of the music played + so that all songs (or albums, depending on your settings) have the + same apparent volume. This prevents sudden changes in volume when + changing between songs recorded at different volume levels. + For replaygain to work, the songs must have been processed by a program + that adds replaygain information to the ID3 tags (or Vorbis tags). + \note{APEv2 tags are not currently supported.} + + Options for replaygain are: + \begin{description} + \item[Enable Replaygain: ]This turns on/off the replaygain function. + % + \item[Prevent Clipping: ]Avoid clipping of a song's waveform. + If a song would clip during playback, the volume is lowered for + that song. Replaygain information is needed for this to work. + % + \item[Replaygain type: ]Choose the type of replaygain to apply: \begin{description} - \item[Enable Replaygain: ]This turns on/off the replaygain function. - % - \item[Prevent Clipping: ]Avoid clipping of a song's waveform. - If a song would clip during playback, the volume is lowered for - that song. Replaygain information is needed for this to work. - % - \item[Replaygain type: ]Choose the type of replaygain to apply: - \begin{description} - \item[Album Gain: ]Maintain a constant volume level between - albums, but keep any intentional volume variations between - songs in an album. (If album gain value is not available, - uses track gain information). - % - \item[Track Gain: ]Maintain a constant volume level between - tracks. If track gain value is not available, no replaygain - is applied. - % - \item[Track Gain if Shuffling: ]Maintains a constant volume - between tracks if shuffle mode is selected. Reverts to album - mode if shuffle is off. - \end{description} - % - \item[Pre-Amp: ]This allows you to adjust the volume when replaygain - is applied. Replaygain often lowers the volume, sometimes quite - much, so here you can compensate for that. Please note that a - (large) positive pre-amp setting can cause clipping, unless - prevent clipping is enabled. The pre-amp can be set to any - decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB. + \item[Album Gain: ]Maintain a constant volume level between + albums, but keep any intentional volume variations between + songs in an album. (If album gain value is not available, + uses track gain information). + % + \item[Track Gain: ]Maintain a constant volume level between + tracks. If track gain value is not available, no replaygain + is applied. + % + \item[Track Gain if Shuffling: ]Maintains a constant volume + between tracks if shuffle mode is selected. Reverts to album + mode if shuffle is off. \end{description} - } + % + \item[Pre-Amp: ]This allows you to adjust the volume when replaygain + is applied. Replaygain often lowers the volume, sometimes quite + much, so here you can compensate for that. Please note that a + (large) positive pre-amp setting can cause clipping, unless + prevent clipping is enabled. The pre-amp can be set to any + decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB. + \end{description} } - \item[Auto Change Directory: ]Control what Rockbox does when it reaches the end - of a directory. If Auto Change Directory is set to \setting{Yes}, Rockbox will - continue to the next directory. If \setting{Auto Change Directory} is set to \setting{No}, - playback will stop at the end of the current directory. - \note{You must have the \setting{Repeat} option set to \setting{No} for \setting{Auto Change Directory} - to function properly.} - % - \end{description} + } +\item[Auto Change Directory: ]Control what Rockbox does when it reaches the end + of a directory. If Auto Change Directory is set to \setting{Yes}, Rockbox + will continue to the next directory. If \setting{Auto Change Directory} is + set to \setting{No}, playback will stop at the end of the current directory. + \note{You must have the \setting{Repeat} option set to \setting{No} for + \setting{Auto Change Directory} to function properly.} + % +\end{description} diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex index ed39cd1f27..e9b3e2f121 100755 --- a/manual/configure_rockbox/sound_settings.tex +++ b/manual/configure_rockbox/sound_settings.tex @@ -23,12 +23,12 @@ as a negative number. Volume can be adjusted from a \opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the lower (bass) sounds 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) + \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,ipodvideo}{This emphasizes or suppresses the - lower (Bass) sounds in the track. 0dB means that bass in unaltered + lower (bass) sounds in the track. 0dB means that bass in unaltered (flat response). The minimum setting is -6dB and the maximum is 9dB.} \opt{x5}{\fixme{add platform specific information here}} diff --git a/manual/getting_started/ipod_install.tex b/manual/getting_started/ipod_install.tex index d3f9fb8e13..08a6e8d596 100755 --- a/manual/getting_started/ipod_install.tex +++ b/manual/getting_started/ipod_install.tex @@ -35,7 +35,7 @@ for the next daily builds.} \item \url{http://download.rockbox.org/bootloader/ipod/ipodpatcher.exe} \item \url{http://download.rockbox.org/bootloader/ipod/ipod_fw.exe} \end{itemize} - \item Locate the \dap{} by opening a command windows. You can do this by + \item Locate the \dap{} by opening a command window. You can do this by clicking ``Start'', ``Execute'' and typing \fname{cmd}. Press Enter to execute that command. Now change directory to the folder you created and run the following commands: diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex index e5a6c82aa4..0e930ff1a6 100644 --- a/manual/getting_started/main.tex +++ b/manual/getting_started/main.tex @@ -73,7 +73,7 @@ are used: here. Notes are used to mark informations that could help you or indicate a possible ``weirdness'' in rockbox that would be explained. } -\warn{This is a warning. In contrast to notes as mentioned above a warning +\warn{This is a warning. In contrast to notes mentioned above, a warning should be taken more seriously. While ignoring notes won't cause any serious damage ignoring warnings \emph{could} cause serious damage. If you're new to rockbox you should really read the warnings before doing anything that is @@ -84,7 +84,7 @@ are used: read the manual in the same way sighted people can do we've added some additional descriptions. If you aren't blind or visually impaired you most likely can completely skip these blocks. To make this easier, there is an - icon shown in the margin like here. + icon shown in the margin on the right. } }{}% end ifpdfoutput diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex index 9a27f6fe84..34fc46269b 100644 --- a/manual/main_menu/main.tex +++ b/manual/main_menu/main.tex @@ -126,12 +126,12 @@ headphones and when connected to an external amplifier. See \opt{HAVE_RECORDING}{\input{main_menu/recording.tex}} \section{\label{ref:playlistoptions}Playlist Options} - This menu allows you to work with playlists. Playlists can either be created -automatically by playing a file in a directory directly, which will cause all -of the files in that directory to be placed in the playlist, or they can be -created by hand using the \setting{File Menu} (see \reference{ref:Filemenu}) -or using the \setting{Playlist Options} menu. Both automatic and manually -created playlists can be edited using this menu. + This menu allows you to work with playlists. Playlists can be created in + three ways. Playing a file in a directory causes all the files in the + directory to be placed in a playlist. Playlists can be created manually by + either using the \setting{File Menu} (see \reference{ref:Filemenu}) or using + the \setting{Playlist Options} menu. Both automatically and manually created + playlists can be edited using this menu. \begin{description} \item[Create Playlist:] diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index 180bb1a521..cd60a0b55e 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex @@ -5,7 +5,7 @@ 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 -playback while runnig. Plugins have the file extension \fname{.rock}. Most of +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}. Viewer plugins get started automatically by opening an associated file (i.e. diff --git a/manual/plugins/wormlet.tex b/manual/plugins/wormlet.tex index 7a3953de60..73d666c465 100644 --- a/manual/plugins/wormlet.tex +++ b/manual/plugins/wormlet.tex @@ -117,7 +117,7 @@ game. Press \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu} \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{\ButtonSelect} -to pause the game. Hit +to pause the game. Press \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu} \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{\ButtonSelect} again to resume the game. diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex index 5fbbeb9755..1343957d87 100644 --- a/manual/rockbox_interface/tagcache.tex +++ b/manual/rockbox_interface/tagcache.tex @@ -14,67 +14,68 @@ described in the following section. \subsection{\label{ref:tagcachemenu}The Tag Cache Menu} - \begin{description} - \opt{SWCODEC}{ - \item[Load To Ram: ] - The Tag Cache database can either be kept on disk (to save memory), or - loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads - the tagcache to RAM, allowing faster browsing and searching. Setting this - option to \setting{No} keeps the tagcache on the disk, meaning slower - browsing but it does not use extra RAM and saves some battery on boot up. - - \note{If you use TagCache frequently, you should load to RAM, as this - will reduce the overall battery consumption because the disk will not - need to spin on each search.} - } - - \item[Auto Update: ] - If \setting{Auto update} is set to \setting{on}, each time the play - boots, Tag Cache will automatically do everything that the - \setting{Update now} setting does. Note that the \setting{Auto - Update} will only check for deleted files if the Directory Cache - (\setting{General Settings $\rightarrow$ System $\rightarrow$ - Disk $\rightarrow$ Directory Cache}) is enabled. - "Update now" includes that check whether dircache has been enabled or not. - - \item[Initialize Now: ] - Before you use the Tag Cache for the first time, you must initialize it by - using the \setting{Initialize Now} function in the \setting{Tag Cache - Menu}. \setting{Initialize Now} removes all database files (removing - runtimedb data also) and rebuilds the database from scratch. This takes - approximately 5 to 10 minutes, and may require a restart to allow the - files to be committed to the cache. - - The Tag Cache initialization happens in the background, so you can continue - to listen to music while the Tag Cache is being initialized. If you shut - down your player during initialization, the database building process will - continue next time you turn it on. - - \item[Update Now: ] - \setting{Update now} causes Tag Cache to detect new and deleted files - Note that unlike the \setting{Auto Update} function, \setting{Update Now} - will update the database regardless of whether the \setting{Directory Cache} - is enabled. Thus, an update using \setting{Update now} may take a long - time. Unlike \setting{Initialize Now}, the \setting{Update Now} function - does not remove runtime database information. - - \item[Gather Runtime Data (Experimental): ] - When enabled, this option allows the most played, unplayed and most recently - played tracks to be logged and scored. - - \item[Export modifications: ] - This allows for the runtime data to be exported into - \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in - ASCII format. This is needed when Tag Cache structures change, because new - code cannot read old Tag Cache database code. But, all modifications - exported to ASCII format should be readable by all Tag Cache versions. - - \item[Import modifications: ] - Allows the \fname{/.rockbox/tagcache\_changelog.txt} backup to be - conveniently loaded into the Tag Cache. This is performed automatically when - the Tag Cache is initialized. - - \end{description} +\begin{description} + \opt{SWCODEC}{ + \item[Load To Ram: ] + The Tag Cache database can either be kept on disk (to save memory), or + loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads + the tagcache to RAM, allowing faster browsing and searching. Setting this + option to \setting{No} keeps the tagcache on the disk, meaning slower + browsing but it does not use extra RAM and saves some battery on boot up. + + \note{If you use TagCache frequently, you should load to RAM, as this + will reduce the overall battery consumption because the disk will not + need to spin on each search.} + } + +\item[Auto Update: ] + If \setting{Auto update} is set to \setting{on}, each time the \dap{} + boots, Tag Cache will automatically do everything that the + \setting{Update now} setting does. Note that the \setting{Auto + Update} will only check for deleted files if the Directory Cache + (\setting{General Settings $\rightarrow$ System $\rightarrow$ + Disk $\rightarrow$ Directory Cache}) is enabled. + \setting{Update now} includes that check whether dircache has been enabled or + not. + +\item[Initialize Now: ] + Before you use the Tag Cache for the first time, you must initialize it by + using the \setting{Initialize Now} function in the \setting{Tag Cache + Menu}. \setting{Initialize Now} removes all database files (removing + runtimedb data also) and rebuilds the database from scratch. This takes + approximately 5 to 10 minutes, and may require a restart to allow the + files to be committed to the cache. + + The Tag Cache initialization happens in the background, so you can continue + to listen to music while the Tag Cache is being initialized. If you shut + down your player during initialization, the database building process will + continue next time you turn it on. + +\item[Update Now: ] + \setting{Update now} causes Tag Cache to detect new and deleted files + Note that unlike the \setting{Auto Update} function, \setting{Update Now} + will update the database regardless of whether the \setting{Directory Cache} + is enabled. Thus, an update using \setting{Update now} may take a long + time. Unlike \setting{Initialize Now}, the \setting{Update Now} function + does not remove runtime database information. + +\item[Gather Runtime Data (Experimental): ] + When enabled, this option allows the most played, unplayed and most recently + played tracks to be logged and scored. + +\item[Export modifications: ] + This allows for the runtime data to be exported into \\ + \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in + ASCII format. This is needed when Tag Cache structures change, because new + code cannot read old Tag Cache database code. But, all modifications + exported to ASCII format should be readable by all Tag Cache versions. + +\item[Import modifications: ] + Allows the \fname{/.rockbox/tagcache\_changelog.txt} backup to be + conveniently loaded into the Tag Cache. This is performed automatically when + the Tag Cache is initialized. + +\end{description} \subsection{Using the Tag Cache} Once the Tag Cache has been initialized, you can browse your music by Artist, diff --git a/manual/rockbox_interface/wps.tex b/manual/rockbox_interface/wps.tex index 1b9c60760b..7e421aa99a 100644 --- a/manual/rockbox_interface/wps.tex +++ b/manual/rockbox_interface/wps.tex @@ -11,7 +11,7 @@ currently playing audio file. \begin{itemize} \item Status bar: The Status bar shows Battery level, charger status, volume, play mode, repeat mode, shuffle mode\opt{CONFIG_RTC}{ and clock}. - In contrast to all other item the status bar is always at the top of + In contrast to all other items, the status bar is always at the top of the screen. \item (Scrolling) path and filename of the current song. \item The ID3 track name. |