From 909b9462da8387e1c8379a52058c61bf18e222e5 Mon Sep 17 00:00:00 2001 From: Nils Wallménius Date: Sat, 3 Mar 2007 00:07:31 +0000 Subject: 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 --- manual/main_menu/main.tex | 97 +++++++++++++++++++++++++---------------------- 1 file changed, 52 insertions(+), 45 deletions(-) (limited to 'manual/main_menu/main.tex') 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. -- cgit v1.2.3