len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2026-04-12 00:47:49 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix bug report 5350 (incorrect button sequence shown in section 2.4.1 for main menu on iriver platforms). Also added reference to how to enter main menu to beginning of Chapter 3. Some other minor editing and much updating of \setting macro where necessary throughout chapters 2 and 3.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9921 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Michael DiFebbo 2006-05-12 16:56:21 +00:00
parent 111d8764dd
commit e28e2fccb8
3 changed files with 100 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

86
manual/main_menu/main.tex
View file

@ -3,13 +3,19 @@
\section{Introducing the Main Menu}
\screenshot{main_menu/images/ss-main-menu}{The main menu}{}
This is the screen from which the rest of the Rockbox functions can be
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 this menu.
All options in Rockbox can be controlled via the \setting{Main Menu}.
All settings are persistently stored on the unit. However, Rockbox does
not spin up the disk solely for the purpose of saving settings, but instead
will save them when it spins up the disk the next time, for example when
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,ONDIO_PAD}{press the \ButtonMenu\ button.}
\opt{IAUDIO_X5_PAD}{hold the \ButtonPlay\ 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
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 page \pageref{ref:Safeshutdown}).
@ -18,13 +24,13 @@ settings may therefore not be saved unless the \dap\ is shut down safely
\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{
\begin{table}
\begin{btnmap}{}{}
\opt{IPOD_4G_PAD}{\ButtonScrollFwd}
\opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollFwd}
\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp}
& Moves up in the menu.\\
& Inside a setting, increases the value or
chooses next option \\
%
\opt{IPOD_4G_PAD}{\ButtonScrollBack}
\opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollBack}
\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonDown}
& Moves down in the menu.\\
& Inside a setting, decreases the value or
@ -32,11 +38,11 @@ settings may therefore not be saved unless the \dap\ is shut down safely
%
\opt{RECORDER_PAD}{\ButtonPlay/\ButtonRight}
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonSelect/\ButtonRight}
\opt{ONDIO_PAD,IPOD_4G_PAD}{\ButtonRight}
\opt{ONDIO_PAD,IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonRight}
& Selects option \\
%
\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff/\ButtonLeft}
\opt{IAUDIO_X5_PAD,ONDIO_PAD,IPOD_4G_PAD}{\ButtonLeft}
\opt{IAUDIO_X5_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonLeft}
& Exits menu, setting or moves to parent menu\\
\end{btnmap}
\end{table}
@ -61,38 +67,38 @@ settings may therefore not be saved unless the \dap\ is shut down safely
\section {Recent Bookmarks}
\screenshot{main_menu/images/ss-list-bookmarks}%
{The list bookmarks screen}{}
If the ``save a list of recently created bookmarks'' option is enabled
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 page \pageref{ref:Bookmarkconfigactual}
for more details on configuring bookmarking in Rockbox.
\note{This option is off by default.}
\section{Sound Settings}
The Sound Settings menu offers a selection of sound properties you may
The \setting{Sound Settings} menu offers a selection of sound properties you may
change to customize your listening experience. The details of this menu are
covered in detail starting on page \pageref{ref:configure_rockbox_sound}.
\section{General Settings}
The General Settings menu allows you to customize the way Rockbox looks and
the way it plays music. The details of this menu are covered in detail
The \setting{General Settings} menu allows you to customize the way Rockbox looks
and the way it plays music. The details of this menu are covered in detail
starting on page \pageref{ref:configure_rockbox_general}.
\section{Manage Settings}
This option allows the saving and re-loading of user configuration settings,
browse the hard drive for alternate firmwares, and finally to reset your
\dap\ back to initial configuration. The details of this menu are covered in detail
starting on page \pageref{ref:ManageSetting}.
The \setting{Manage Settings} option allows the saving and re-loading of user
configuration settings, browse the hard drive for alternate firmwares, and finally
to reset your \dap\ back to initial configuration. The details of this menu are
covered in detail starting on page \pageref{ref:ManageSetting}.
\section{Browse Themes}
This option will display all the currently installed themes on the \dap,
press \ButtonRight\ to load the chosen theme and apply it.
A Theme is basically a configuration file, stored in a specific directory,
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
additional information such as background image and text colours.
There are a number of such themes that ship with Rockbox, and if none of
There are a number of themes that ship with Rockbox. If none of
these suit your needs, many more can be downloaded from
\url{www.rockbox.org/twiki/bin/view/Main/\opt{RECORDER_PAD}{/WpsArchos}
\opt{h1xx}{WpsIriverH100}\opt{h300,ipodcolor}{WpsIriverH300}
@ -393,9 +399,9 @@ for more details.
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 File Menu (see page \pageref{ref:Filemenu}) or using
the Playlist Options menu. Both automatic and manually created playlists
can be edited using this menu.
created by hand using the \setting{File Menu} (see page \pageref{ref:Filemenu})
or using the \setting{Playlist Options} menu. Both automatic and manually
created playlists can be edited using this menu.
\begin{description}
\item[Create Playlist:]
@ -412,20 +418,21 @@ specified file. If no path is provided then playlist is saved to current
directory (see page \pageref{ref:Playlistsubmenu}).
\item[Recursively Insert Directories: ]
If set to ON then when you insert/queue a directory in Dynamic Playlist,
all subdirectories will also be inserted. If set to ASK then you are prompted
about recursive insertion when inserting a directory.
Options: Off, Ask, On
If set to \setting{On}, then when a directory is inserted or queued into a
dynamic playlist, all subdirectories will also be inserted. If set to \setting{Ask},
Rockbox will prompt the user about whether to include subdirectories.
Options: \setting{Off}, \setting{Ask}, \setting{On}
\item[Warn When Erasing Dynamic Playlist: ]
\fixme{some information about this function....}
Options: Yes, No
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}
\end{description}
\section{Browse 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 demo's and a number of
Rockbox, including several games, some impressive demos and a number of
utilities. A detailed description of the different plugins begins
on page \pageref{ref:plugins}.
@ -446,9 +453,9 @@ battery status, hard disk size and the amount of free space on the disk.
\item[Debug (Keep Out!):]
This submenu is intended to be used \emph{only} by Rockbox developers.
It shows hardware, disk, battery status and a lot of other information.
It shows hardware, disk, battery status and other technical information.
\warn{It is not recommended that users access this menu unless instructed to
do so in the course of fixing a problem with Rockbox. If you think you've
do so in the course of fixing a problem with Rockbox. If you think you have
messed up your settings by use of this menu please try to reset \emph{all}
settings before asking for help.}
\end{description}
@ -457,22 +464,23 @@ battery status, hard disk size and the amount of free space on the disk.
\section{Shutdown}
This menu option saves the Rockbox configuration and turns off the hard
drive before shutting down the machine. For maximum safety this procedure
is recommended when turning off the Jukebox. (There is a very small risk
is recommended when turning off the \dap. (There is a very small risk
of hard disk corruption otherwise.) See page \pageref{ref:Safeshutdown}
for more details.
}
\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{
\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD,IPOD_VIDEO_PAD}
{
\section{Quick Menu}
Whilst not strictly part of the main menu, it is worth noting that a few
of the more commonly used settings are available from the ''Quick Menu".
This screen is accessed by holding the
Whilst not strictly part of the \setting{Main Menu}, it is worth noting that a few
of the more commonly used settings are available from the \setting{Quick Menu}.
The \setting{Quick Menu} screen is accessed by holding the
\opt{RECORDER_PAD}{\ButtonFTwo}
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
\opt{IPOD_4G_PAD}{\ButtonMenu}
\opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonMenu}
\opt{IAUDIO_X5_PAD}{\ButtonRec}
key, and it allows rapid access to the Shuffle and Repeat Modes
key, and it allows rapid access to the \setting{Shuffle} and \setting{Repeat} modes
(Page \pageref{ref:PlaybackOptions})
and the Show Files options (Page \pageref{ref:ShowFiles}).
and the \setting{Show Files} option (Page \pageref{ref:ShowFiles}).
}

76
manual/rockbox_interface/main.tex
View file

@ -40,23 +40,24 @@ picture above. To turn on and shut down your \dap, the following keys are used:
\section{\label{ref:file_browser}File Browser}
\screenshot{rockbox_interface/images/ss-file-browser}{The file browser}{}
Rockbox lets you browse your music in either of two ways. The ``File Browser''
lets you navigate through the files and folders on your \dap, entering folders
and executing the default action on each file. To help differentiate files,
each file format is displayed with an icon.
Rockbox lets you browse your music in either of two ways. The
\setting{File Browser} lets you navigate through the files and folders on
your \dap, entering folders and executing the default action on each file.
To help differentiate files, each file format is displayed with an icon.
The ``Tag Cache Browser,'' on the other hand, allows you to navigate through
the music on your player using categories like album, artist, genre, etc.
The \setting{Tag Cache Browser}, on the other hand, allows you to navigate
through the music on your player using categories like album, artist, genre, etc.
You can select whether to browse using the File Browser or the Tag Cache Browser by
adjusting the \setting{Show Files} setting. If you choose the File Browser, the
\setting{Show Files} setting also lets you select what types of files you wish to
view. See page \pageref{ref:ShowFiles} for more information on the \setting{Show
Files} setting.
You can select whether to browse using the \setting{File Browser} or the
\setting{Tag Cache Browser} by adjusting the \setting{Show Files} setting.
If you choose the \setting{File Browser}, the \setting{Show Files} setting also
lets you select what types of files you wish to view. See page
\pageref{ref:ShowFiles} for more information on the \setting{Show Files} setting.
\note{The File Browser allows you to manipulate your files in ways that are not
available within the Tag Cache Browser. Read more about Tag Cache in Section
\ref{ref:tagcache}. The remainder of this section deals with the File Browser.}
\note{The \setting{File Browser} allows you to manipulate your files in ways that
are not available within the \setting{Tag Cache Browser}. Read more about
\setting{Tag Cache} in Section \ref{ref:tagcache}. The remainder of this section
deals with the \setting{File Browser}.}
\subsection{\label{ref:controls}Controls}
\begin{table}
@ -100,7 +101,7 @@ available within the Tag Cache Browser. Read more about Tag Cache in Section
%
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
\opt{RECORDER_PAD}{\ButtonFOne}
\opt{PLAYER_PAD,IPOD_4G_PAD,ONDIO_PAD}{\ButtonMenu}
\opt{PLAYER_PAD,IPOD_4G_PAD,ONDIO_PAD,IPOD_VIDEO_PAD}{\ButtonMenu}
\opt{IAUDIO_X5_PAD}{Hold \ButtonPlay}
& Enter the Main Menu \\
%
@ -121,25 +122,26 @@ available within the Tag Cache Browser. Read more about Tag Cache in Section
\subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu}
\screenshot{rockbox_interface/images/ss-file-menu}{The File Menu}{}
The File Menu allows you to perform certain operations on files or folders.
To access the File Menu, position the selector over a file or folder and
The \setting{File Menu} allows you to perform certain operations on files or
folders. To access the \setting{File Menu}, position the selector over a file
or folder and
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}
{hold the \ButtonSelect\ button.}
\opt{RECORDER_PAD,PLAYER_PAD}{press the \ButtonPlay/\ButtonOn+\ButtonPlay\
buttons.}
\opt{ONDIO_PAD}{hold the \ButtonRight\ button.}
\note{The File Menu is a context sensitive menu. If the File Menu is
invoked on a file, it will display options available for files. If the
File Menu is invoked on a folder or directory, it will display options
for directories.}
\note{The \setting{File Menu} is a context sensitive menu. If the
\setting{File Menu} is invoked on a file, it will display options available
for files. If the \setting{File Menu} is invoked on a folder or directory,
it will display options for directories.}
The File Menu contains the following options (unless otherwise noted, each
option pertains both to files and directories):
The \setting{File Menu} contains the following options (unless otherwise noted,
each option pertains both to files and directories):
\begin{description}
\item [Playlist:]
Enters to the Playlist Submenu (see below).
Enters the \setting{Playlist Submenu} (see below).
\item [Rename:]
This function lets the user modify a file name.
\item [Cut:]
@ -167,7 +169,7 @@ option pertains both to files and directories):
\item [Open with:]
Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox,
Rockbox automatically detects the file type and runs the appropriate plugin.
The ``Open With'' function can be used to override the default action and
The \setting{Open With} function can be used to override the default action and
select a viewer by hand. For example, this function can be used to view a text file
even if the file has a non-standard extension (i.e., the file has an extension
of something other than ``.txt''). See page \textmd{\pageref{ref:Viewersplugins}}
@ -178,7 +180,7 @@ option pertains both to files and directories):
\subsection{\label{ref:Playlistsubmenu}Playlist Submenu}
\screenshot{rockbox_interface/images/ss-playlist-menu}{The Playlist Submenu}{}
The Playlist Submenu allows you to put tracks into a ``dynamic playlist''.
The \setting{Playlist Submenu} allows you to put tracks into a ``dynamic playlist''.
If there is no music currently playing, Rockbox will create a new dynamic playlist
and put the selected track(s) into the playlist. If there is music currently playing,
Rockbox will put the selected track(s) into the current playlist. The place in which
@ -205,24 +207,24 @@ options:
Queue track(s) at end of playlist.
\end{description}
The Playlist Submenu can be used to add either single tracks or entire directories
to a playlist. If the Playlist Submenu is invoked on a single track, it will put
only that track into the playlist. On the other hand, if the Playlist Submenu
is invoked on a directory, Rockbox adds all of the tracks in that directory to
the playlist.
The \setting{Playlist Submenu} can be used to add either single tracks or
entire directories to a playlist. If the \setting{Playlist Submenu} is
invoked on a single track, it will put only that track into the playlist.
On the other hand, if the \setting{Playlist Submenu} is invoked on a
directory, Rockbox adds all of the tracks in that directory to the playlist.
\note{You can control whether or not Rockbox includes the contents of subdirectories
when adding an entire directory to a playlists. Set the \setting{Main Menu
when adding an entire directory to a playlists. Set the \setting{Main Menu
$\rightarrow$ Playlist Options $\rightarrow$ Recusively Insert Directories} setting to
\setting{Yes} if you would like Rockbox to include tracks in subdirectories as well as tracks
in the currently-selected directory.}
If you want to have Rockbox create a playlist of a whole folder (to play an entire
album, for example), use the File Browser to select the song. When a single song is
selected from the File Browser, Rockbox will automatically create a playlist with all
songs in the current folder. However, if you want to play only a single song and then
stop, stop playback, navigate to the song you want to play, and use the \setting{Playlist
$\rightarrow$ Insert} function to select the song.
album, for example), use the \setting{File Browser} to select the song. When a single
song is selected from the \setting{File Browser}, Rockbox will automatically create a
playlist with all songs in the current folder. However, if you want to play only a single
song and then stop, stop playback, navigate to the song you want to play, and use the
\setting{Playlist $\rightarrow$ Insert} function to select the song.
Dynamic playlists are saved so resume will restore them exactly as they were before
shutdown.

27
manual/rockbox_interface/wps.tex
View file

@ -76,13 +76,13 @@ your WPS (While Playing Screen).
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{\ButtonSelect}
\opt{ONDIO_PAD}{\ButtonMenu}
\opt{RECORDER_PAD,PLAYER_PAD}{\ButtonOn}
& Go to file browser \\
& Go to File Browser \\
%
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{Hold \ButtonSelect}
\opt{ONDIO_PAD}{Hold \ButtonMenu}
\opt{RECORDER_PAD,PLAYER_PAD}{Hold \ButtonOn}
\opt{IAUDIO_X5_PAD}{\fixme{Please add correct keys}}
& Enter WPS context menu \\
& Enter WPS Context Menu \\
%
\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{
Hold \ButtonOn
@ -95,10 +95,10 @@ your WPS (While Playing Screen).
\opt{PLAYER_PAD}{\ButtonStop}
& Stop playback \\
%
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
\opt{RECORDER_PAD}{\ButtonFOne}
\opt{PLAYER_PAD,ONDIO_PAD,IPOD_4G_PAD}{\ButtonMenu}
\opt{IAUDIO_X5_PAD}{\fixme{Please add correct keys}}
\opt{PLAYER_PAD,IPOD_4G_PAD,ONDIO_PAD,IPOD_VIDEO_PAD}{\ButtonMenu}
\opt{IAUDIO_X5_PAD}{Hold \ButtonPlay}
& Go to Main menu \\
%
%These actions need definitions for the other targets
@ -132,11 +132,12 @@ your WPS (While Playing Screen).
peak volume value that occurred recently.
\item [The clip indicator:]
This is a little black block that is displayed at the very right of the
scale when an overflow occurs. It usually doesn't show up during normal
scale when an overflow occurs. It usually does not show up during normal
playback unless you play an audio file that is distorted heavily. If you
encounter clipping while recording your recording will sound distorted. You
should lower the gain. Note that the clip detection is not very precise.
Clipping might occur without being indicated.
encounter clipping while recording, your recording will sound distorted. You
should lower the gain.
\note{Note that the clip detection is not very precise.
Clipping might occur without being indicated.}
\item [The scale:]
Between the indicators of the right and left channel there are little dots.
These dots represent important volume values. In linear mode each dot is a
@ -145,11 +146,11 @@ your WPS (While Playing Screen).
{}-40db, {}-50db, {}-60db.
\end{description}
}
\subsection{\label{sec:quickscreens}Quickscreens}
\subsection{\label{sec:quickscreens}WPS Quick Screens}
\subsubsection{\label{sec:contextmenu}Context Menu}
Like the context menu for the file browser this context menu allows you
to quickly access some often used functions.
\subsubsection{\label{sec:contextmenu}The WPS Context Menu}
Like the context menu for the File Browser, the \setting{WPS Context Menu}
allows you to quickly access some often used functions.
\opt{h1xx,h300,RECORDER_PAD,ONDIO_PAD,IPOD_4G_PAD,x5}{
These include the ID3 Viewer and the pitch screen.}