Update the manual to reflect recent menu changes, add descriptions of how to move and remove tracks in the playlist viewer, Recording settings are now in their own chapter.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12553 a1c6a512-1295-4272-9138-f99709370657

3 files changed, 108 insertions, 270 deletions

diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index ca1207d3ad..3eae984ab2 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -1,26 +1,18 @@
 % $Id$ %
 \chapter{The Main Menu}
-
-\section{Introducing the Main Menu}
+\section{\label{ref:main_menu}Introducing the Main Menu}
 \screenshot{main_menu/images/ss-main-menu}{The main menu}{}
-The \setting{Main Menu} is the screen from which the rest of the Rockbox functions can be 
-accessed. It is used for a variety of functions, which are detailed below. 
-All options in Rockbox can be controlled via the \setting{Main Menu}.
-To enter the \setting{Main Menu}, 
-  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{press the \ButtonMode\ button.}%
-  \opt{RECORDER_PAD}{press the \ButtonFOne\ button.}%
-  \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD}{press the \ButtonMenu\
-    button.}%
+The \setting{Main Menu} is the screen from which all of the Rockbox functions can be 
+accessed. To enter the \setting{Main Menu}, 
+  \nopt{ONDIO_PAD}{press the \ActionStdMenu{} button.}%
   \opt{ONDIO_PAD}{hold the \ButtonMenu{} button.}%
-  \opt{IAUDIO_X5_PAD}{press the \ButtonRec\ button.}%
-  \opt{IRIVER_H10_PAD}{press the \ButtonPower\ button.}%
 
 All settings are stored on the unit. However, Rockbox does not spin up 
-the disk solely for the purpose of saving settings.  Instead, Rockbox will
+the disk solely for the purpose of saving settings. Instead, Rockbox will
 save settings when it spins up the disk the next time, for example when 
-refilling the MP3 buffer or navigating through the file browser. Changes to 
-settings may therefore not be saved unless the \dap\ is shut down safely 
-(see \reference{ref:Safeshutdown}).
+refilling the MP3 buffer or navigating through the \setting{File Browser}.
+Changes to settings may therefore not be saved unless the \dap{} is shut down
+safely (see \reference{ref:Safeshutdown}).
 
 \section{Navigating the Main Menu}
 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
@@ -75,19 +67,31 @@ If the \setting{Save a list of recently created bookmarks} option is enabled
 then you can view a list of several recent bookmarks here and select one to 
 jump straight to that track. See \reference{ref:Bookmarkconfigactual} 
 for more details on configuring bookmarking in Rockbox.
-\note{This option is off by default.}
+\note{This entry is not shown in the \setting{Main Menu} when the option is off
+  and the option is off by default.}
+
+\section{Files}
+Browse the files on your \dap{} (see \reference{ref:file_browser}).
+
+\section{Database}
+Browse by the meta-data in your audio files (see \reference{ref:database}).
 
-\section{Sound Settings}
+\section{Now Playing/Resume Playback}
+Go to the \setting{While Playing Screen} and resume if music playback is
+stopped or paused and there is something to resume (see \reference{ref:WPS}).
+
+\section{Settings}
+\subsection{Sound Settings}
 The \setting{Sound Settings} menu offers a selection of sound properties you may 
 change to customise your listening experience.  The details of this menu are 
 covered in detail in \reference{ref:configure_rockbox_sound}. 
 
-\section{General Settings}
+\subsection{General Settings}
 The \setting{General Settings} menu allows you to customise the way Rockbox looks 
 and the way it plays music.  The details of this menu are covered in detail in 
 \reference{ref:configure_rockbox_general}.
 
-\section{Manage Settings}
+\subsection{Manage Settings}
 The \setting{Manage Settings} option allows the saving and re-loading of user 
 configuration settings, browsing the hard drive for alternate firmwares, and finally
 resetting your \dap{} back to initial configuration.
@@ -98,13 +102,13 @@ Rockbox firmware.}
 The details of this menu are covered in detail in 
 \reference{ref:manage_settings}.
 
-\section{Browse Themes}
+\subsection{Browse Themes}
 This option will display all the currently installed themes on the \dap, 
-press \ButtonRight\ to load the chosen theme and apply it.
+press \ActionTreeEnter{} to load the chosen theme and apply it.
 
 A theme is basically a configuration file, stored in a specific directory, 
 that typically changes the WPS 
-\opt{h1xx,h300,x5}{and remote WPS}, font used and on some platforms
+\opt{HAVE_REMOTE_LCD}{and remote WPS}, font used and on some platforms
 additional information such as background image and text colours.
 
 There are a number of themes that ship with Rockbox. If none of
@@ -120,22 +124,26 @@ these suit your needs, many more can be downloaded from
 Some of the downloads from this site will actually be standalone WPS files, 
 others will be full-blown themes. 
 
-\note{Themes do not have to be purely visual.  It is quite possible to create
-a theme that switches between audio configurations for use in the car, with
-headphones and when connected to an external amplifier.  See 
-\reference{ref:CreateYourOwnWPS} for more details.
-}
+\note{Themes do not have to be purely visual. It is quite possible to create
+  a theme that switches between audio configurations for use in the car, with
+  headphones and when connected to an external amplifier. See
+  \reference{ref:CreateYourOwnWPS} for more details.}
 
-\opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}}
+\subsection{Recording Settings}
+The \setting{Recording Settings} menu allows you to configure settings related
+to recording. The details of this menu are covered in detail in 
+\reference{ref:Recordingsettings}.
 
-\opt{HAVE_RECORDING}{\input{main_menu/recording.tex}}
+\opt{HAVE_RECORDING}{\input{main_menu/recording_screen.tex}}
 
-\section{\label{ref:playlistoptions}Playlist Options}
+\opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}}
+
+\section{\label{ref:playlistoptions}Playlist}
   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
+  the \setting{Playlist} menu. Both automatically and manually created
   playlists can be edited using this menu.
 
 \begin{description}
@@ -151,27 +159,20 @@ from where you currently are.
   Saves the current dynamic playlist, excluding queued tracks, to the 
 specified file. If no path is provided then playlist is saved to current 
 directory (see \reference{ref:Playlistsubmenu}).
-  
-\item[Recursively Insert Directories: ]
-  If set to \setting{On}, then when a directory is inserted or queued into a 
-  dynamic playlist, all sub-directories will also be inserted. If set to \setting{Ask},
-  Rockbox will prompt the user about whether to include sub-directories.
-  Options: \setting{Off}, \setting{Ask}, \setting{On}
-
-\item[Warn When Erasing Dynamic Playlist: ]
-  If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
-  take an action that will cause Rockbox to erase the current dynamic playlist.
-  Options: \setting{Yes}, \setting{No}
+
+\item[Playlist Catalog:]
+  The \setting{Playlist Catalog} provides a simple interface to maintain
+  several playlist (see \reference{label:WorkingWithPlaylists}).
 \end{description}
 
-\section{Browse Plugins}
+\section{Plugins}
   With this option you can load and run various plugins that have been
 written for Rockbox. There are a wide variety of these supplied with
 Rockbox, including several games, some impressive demos and a number of
 utilities. A detailed description of the different plugins is to be found in 
 \reference{ref:plugins}.
 
-\section{\label{ref:Info}Info}
+\section{\label{ref:Info}System}
   This option shows RAM buffer size, battery voltage level and estimated time
 remaining, disk total space and disk free space.
 \opt{player}{Use the MINUS and PLUS keys to step through several 
@@ -192,6 +193,12 @@ pages of information.}
 \item[Version:]
   Software version and credits display.
   
+\item[Sleep Timer:]
+  The \setting{Sleep Timer} powers off your \dap{} after playing for a given
+  time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
+  The \setting{Sleep Timer} is reset on boot.
+  \opt{HAVE_RTC_ALARM}{Using this option disables the \setting{Wake up alarm}.}
+
 \item[Debug (Keep Out!):]
   This sub menu is intended to be used \emph{only} by Rockbox developers.
   It shows hardware, disk, battery status and other technical information.  
diff --git a/manual/main_menu/recording.tex b/manual/main_menu/recording.tex
deleted file mode 100644
index b810c9f168..0000000000
--- a/manual/main_menu/recording.tex
+++ /dev/null
@@ -1,225 +0,0 @@
-% $Id$ %
-\section{\label{ref:Recording}Recording}
-\subsection{\label{ref:while_recording_screen}While Recording Screen}
-\screenshot{main_menu/images/ss-while-recording-screen}{The while recording
-  screen}{}
-
-Entering the \setting{Recording} option in the \setting{Main Menu} brings up
-a screen in which you can choose to enter the \setting{Recording Screen} or
-the \setting{Recording Settings} (see below). The \setting{Recording Screen}
-shows the time elapsed and the size of the file being recorded. A peak meter
-is present to allow you set gain correctly. There is also a volume setting,
-this will only affect the output level of the \dap{} and does \emph{not}
-affect the recorded sound.
-\opt{SWCODEC}{
-\note{When you start a recording, the hard disk will spin up. This will cause
-the peak meters to freeze in the process. This is expected behaviour, and
-nothing to worry about. The recording continues during the spin up.}}
-\opt{MASCODEC}{The frequency, channels and quality}
-\opt{SWCODEC}{The frequency and channels} settings are shown on the last line.
-
-The controls for this screen are:
-\begin{table}
-  \begin{btnmap}{}{}
-    
-    \ActionStdPrev{} / \ActionStdNext & Select setting.\\
-    %
-    \ActionSettingsDec{} / \ActionSettingsInc & Adjust selected setting.\\
-    %
-    \ActionRecPause & Start recording.\\
-                    & While recording: pause recording (press again to
-                      continue).\\
-    %
-    \ActionRecExit  & Exit \setting{Recording Screen}.\\
-                    & While recording: Stop recording.\\
-    %
-    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{
-      \ActionRecNewfile & Starts recording.\\
-                        & While recording: close the current file and open
-                          a new one.\\
-    }
-    %
-    \ActionRecMenu & Open \setting{Recording Settings} (see below).\\
-    %
-    \opt{RECORDER_PAD}{
-      \ActionRecFTwo & Quick menu for recording settings. A quick press will
-      leave the screen up (press \ActionRecFTwo{} again to exit), while holding
-      it will close the screen when you release it.\\
-    }
-    %
-    \opt{RECORDER_PAD}{
-      \ActionRecFThree & Quick menu for source setting.\\
-      & Quick/hold works as for \ActionRecFTwo.\\
-      & While recording: Start a new recording file.\\
-    }
-  \end{btnmap}
-\end{table}
-
-\subsection{\label{ref:Recordingsettings}Recording Settings}
-\screenshot{main_menu/images/ss-recording-settings}{The recording settings screen}{}
-
-\opt{MASCODEC}{
-  \begin{description}
-  \item[Quality:]
-    Choose the quality here (0 to 7). Default is 5, best quality is 7,
-    smallest file size is 0. This setting effects how much your sound
-    sample will be compressed. Higher quality settings result in larger
-    MP3 files.
-    
-    The quality setting is just a way of selecting an average bit rate,
-    or number of  bits per second, for a recording.  When  this setting
-    is lowered, recordings are compressed more (meaning worse sound quality),
-    and the average bitrate changes as follows.
-  \end{description}
-  
-  \begin{table}[h!]
-    \begin{center}
-      \begin{tabularx}{0.75\textwidth}{lX}\toprule
-        \emph{Frequency} & \emph{Bitrate} (Kbit/s) -- quality 0$\rightarrow$7 \\\midrule
-        44100Hz stereo   & 75, 80, 90, 100, 120, 140, 160, 170 \\
-        22050Hz stereo   & 39, 41, 45, 50,  60,  80,  110, 130 \\
-        44100Hz mono     & 65, 68, 73, 80,  90,  105, 125, 140 \\
-        22050Hz mono     & 35, 38, 40, 45,  50,  60,  75,  90 \\\bottomrule
-      \end{tabularx}
-    \end{center}
-  \end{table}
-}
-
-\begin{description}
-\opt{SWCODEC}{
-  \item[Format:]
-    Choose which format to save your recording in. The available choices are
-    the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the
-    losslessly compressed \setting{WavPack} and the lossy
-    \setting{MPEG Layer 3}.
-
-  \item[Encoder Settings:]
-    This sets the bitrate when using the \setting{MPEG Layer 3} format. And has
-    no settings for the other formats.
-}
-
-  \item[Frequency:]
-    Choose the recording frequency (sample rate).
-    \opt{MASCODEC}{48kHz, 44.1kHz, 32kHz, 24kHz, 22.05kHz, 16kHz}
-    \opt{h1xx,h300}{44.1kHz, 22.05kHz and 11.025kHz}
-    \opt{x5}{88.2kHz, 44.1kHz, 22.05kHz and 11.025kHz}
-    are available. Higher sample rates use up more disk space, but give better
-    sound quality.
-    \opt{SWCODEC}{\note{The 11.025kHz setting is not available when using%
-      \setting{MPEG Layer 3} format.}
-    }%
-    \opt{MASCODEC}{
-      The frequency setting also determines which version of the MPEG standard
-      the sound is recorded using:\\
-      MPEG v1 for 48, 44.1 and 32\\
-      MPEG v2 for 24, 22.05 and 16\\
-    }
-    \opt{recorder,recorderv2fm,h1xx}
-      {\note{You cannot change the sample rate for digital recordings.}
-    }  
-
-\item[Source:]
-  Choose the source of the recording. This can be
-  \opt{recorder,recorderv2fm,h1xx}{\setting{SPDIF (digital)},}%
-  \setting{Mic} or \setting{Line In}.
-  \opt{CONFIG_TUNER}{For recording from the radio see \reference{ref:FMradio}.}
-
-\item[Channels:]
-  This allows you to select mono or stereo recording. Please note that
-  for mono recording, only the left channel is recorded. Mono recordings
-  are usually somewhat smaller than stereo.
-
-\opt{MASCODEC}{
-  \item[Independent Frames:]
-    The independent frames option tells the \dap{} to encode with the bit
-    reservoir disabled, so the frames are independent of each other. This
-    makes a file easier to edit.
-}
-      
-\item[File Split Options:]
-  This sub menu contains options for file splitting, which can be used to split
-  up long recordings into manageable pieces. The splits are seamless (frame
-  accurate), no audio is lost at the split point. The break between recordings
-  is only the time required to stop and restart the recording, on the order of
-  2 -- 4 seconds.
-  \begin{description}
-    \item[Split Measure:]
-      This option controls wether to split the recording when the
-      \setting{Split Filesize} is reached or when the
-      \setting{Split Time} has elapsed.
-
-    \item[What to do when Splitting:]
-      This controls what will happend when the splitting condition is
-      fullfilled the two available options here are
-      \setting{Start a new file} or \setting{Stop recording}.
-
-    \item[Split Time:]
-      Set the time to record between each split, if time is used as
-      \setting{Split Measure}.\\
-      Options (hours:minutes between splits): Off, 00:05, 00:10, 00:15, 00:30,
-      1:00, 1:14 (74 minute  CD), 1:20 (80 minute CD), 2:00, 4:00, 8:00, 10:00,
-      12:00, 18:00, 24:00.
-
-    \item[Split Filesize:]
-      Set the filesize to record between each split, if filesize is used as
-      \setting{Split Measure}.
-
-  \end{description}
-
-  \item[Prerecord Time:]
-    This setting buffers a small amount of audio so that when the record button
-    is pressed, the recording will begin from that number of seconds earlier.
-    This is useful for ensuring that a recording begins before a cue that is
-    being waited for.
-
-  \item[Directory:]
-    Allows changing the location where the recorded files are saved. The
-    default location is \fname{/recordings}. If set to
-    \setting{Current Directory} the recorded files will be saved in the
-    directory where the \setting{File Browser} was left.
-
-  \item[Show recording screen on startup:]
-    If set to yes, the \dap{} will start up with the recording screen showing.
-
-  \nopt{ondio}{
-  \item[Clipping Light:]
-    Causes the backlight to flash on when clipping has been detected.\\
-    Options: \setting{Off}, \setting{Main unit only},
-    \setting{Main and remote unit}, \setting{Remote unit only}.
-  }
-  \item[Trigger:]
-    \fixme{Add description of triggered recording.}
-
-\opt{h1xx,h300}{%
-  \item[Automatic Gain Control:]
-    The \setting{Automatic Gain Control} has five different presets for
-    automatically controlling the gain while recording.
-    \begin{description}
-      \item[Safety (clip):]
-        This preset will lower the gain when the levels get too high (-1dB)
-        and will never increase gain.
-        
-      \item[Live (slow):]
-        This preset is designed to be used for recording of live shows and has
-        quite large headroom for loud parts. It heads for a nominal target peak
-        level of -9dB and will slowly increase or decrease gain to reach it.
-        
-      \item[DJ-Set (slow):]
-        This preset heads for a nominal target peak level of -5dB and will
-        slowly increase or decrease gain to reach it.
-        
-      \item[Medium:]
-        This preset heads for a nominal target peak level of -6dB and will
-        increase or decrease gain to reach it.
-
-      \item[Voice (fast):]
-        This preset is designed to be used for voice recording and heads for a
-        nominal target peak level of -7dB and will quickly increase or
-        decrease gain to reach it.
-    \end{description}
-
-  \item[AGC clip time:]
-    This setting controls how long the level is too loud or soft before the
-    \setting{Automatic Gain Control} kicks in.
-}%
-\end{description}
diff --git a/manual/main_menu/recording_screen.tex b/manual/main_menu/recording_screen.tex
new file mode 100644
index 0000000000..7ae4205abd
--- /dev/null
+++ b/manual/main_menu/recording_screen.tex
@@ -0,0 +1,56 @@
+% $Id$ %
+\section{\label{ref:Recording}Recording}
+\subsection{\label{ref:while_recording_screen}While Recording Screen}
+\screenshot{main_menu/images/ss-while-recording-screen}{The while recording
+  screen}{}
+
+Entering the \setting{Recording} option in the \setting{Main Menu} brings up
+a screen in which you can choose to enter the \setting{Recording Screen} or
+the \setting{Recording Settings} (see below). The \setting{Recording Screen}
+shows the time elapsed and the size of the file being recorded. A peak meter
+is present to allow you set gain correctly. There is also a volume setting,
+this will only affect the output level of the \dap{} and does \emph{not}
+affect the recorded sound.
+\opt{SWCODEC}{
+\note{When you start a recording, the hard disk will spin up. This will cause
+the peak meters to freeze in the process. This is expected behaviour, and
+nothing to worry about. The recording continues during the spin up.}}
+\opt{MASCODEC}{The frequency, channels and quality}
+\opt{SWCODEC}{The frequency and channels} settings are shown on the last line.
+
+The controls for this screen are:
+\begin{table}
+  \begin{btnmap}{}{}
+    
+    \ActionStdPrev{} / \ActionStdNext & Select setting.\\
+    %
+    \ActionSettingsDec{} / \ActionSettingsInc & Adjust selected setting.\\
+    %
+    \ActionRecPause & Start recording.\\
+                    & While recording: pause recording (press again to
+                      continue).\\
+    %
+    \ActionRecExit  & Exit \setting{Recording Screen}.\\
+                    & While recording: Stop recording.\\
+    %
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{
+      \ActionRecNewfile & Starts recording.\\
+                        & While recording: close the current file and open
+                          a new one.\\
+    }
+    %
+    \ActionRecMenu & Open \setting{Recording Settings} (see below).\\
+    %
+    \opt{RECORDER_PAD}{
+      \ActionRecFTwo & Quick menu for recording settings. A quick press will
+      leave the screen up (press \ActionRecFTwo{} again to exit), while holding
+      it will close the screen when you release it.\\
+    }
+    %
+    \opt{RECORDER_PAD}{
+      \ActionRecFThree & Quick menu for source setting.\\
+      & Quick/hold works as for \ActionRecFTwo.\\
+      & While recording: Start a new recording file.\\
+    }
+  \end{btnmap}
+\end{table}