summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2006-04-10 21:47:09 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2006-04-10 21:47:09 +0000
commitb7eef891f80d9116e74302ebad287056a3c5e2b5 (patch)
tree3afeb5c8bfd4bc1245f6a5196c67f886be321ec3 /manual
parentbc26c89880fd5c0227ba66094d43ce845d35b630 (diff)
downloadrockbox-b7eef891f80d9116e74302ebad287056a3c5e2b5.tar.gz
rockbox-b7eef891f80d9116e74302ebad287056a3c5e2b5.tar.bz2
rockbox-b7eef891f80d9116e74302ebad287056a3c5e2b5.zip
General layout and content fixes to Advanced Topics and Main Menu by Mark Bright (FS#5086)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9598 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/advanced_topics/main.tex95
-rw-r--r--manual/main_menu/main.tex74
2 files changed, 104 insertions, 65 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 3a4d782b7d..59d86be3a5 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -7,27 +7,26 @@ Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of
\opt{HAVE_LCD_BITMAP}{
\subsection{\label{ref:Loadingfonts}Loading Fonts}
Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the \dap\
- and ``play'' them in the directory browser or select \textbf{General Settings
- {\textgreater} Fonts} from the Main Menu.
-
+ and ``play'' them in the directory browser or select
+ \emph{General Settings $\rightarrow$ Fonts} from the Main Menu.
If you want a font to be loaded automatically every time you start up,
it must be located in the \fname{/.rockbox } folder and the file name
must be at most 24 characters long.
-
- Any BDF font file up to 16 pixels high should be usable with Rockbox. To
- convert from .bdf to .fnt, use the \fname{convbdf} tool. This tool can be
- found in the tools directory of the Rockbox source code.
+ \warn{Advanced Users Only: Any BDF font file up to 16 pixels high should
+ be usable with Rockbox. To convert from .bdf to .fnt, use the \fname{convbdf}
+ tool. This tool can be found in the tools directory of the Rockbox source
+ code.}
}
\subsection{\label{ref:Loadinglanguages}Loading Languages}
-Rockbox can load language files at runtime. Simply copy the .lng file (do not
-use the .lang file) to the \dap\ and ``play'' it in the Rockbox directory
-browser or select \textbf{General Settings $\rightarrow$ Languages }from the
-Main Menu.
+Rockbox can load language files at runtime. Simply copy the .lng file
+\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
+Rockbox directory browser or select \emph{General Settings $\rightarrow$
+Languages }from the Main Menu.
-If you want a language to be loaded automatically every time you start up, it
-must be located in the \fname{/.rockbox }folder and the file name must be a
-maximum of 24 characters long.
+\note{If you want a language to be loaded automatically every time you start
+up, it must be located in the \fname{/.rockbox }folder and the file name must
+be a maximum of 24 characters long.}
Rockbox supports many different languages. You can get .lng files at
\url{http://www.rockbox.org/lang/}.
@@ -39,27 +38,31 @@ file find the instructions on the Rockbox website:
\section{\label{ref:ConfiguringtheWPS}Configuring the WPS}
-\subsection{Description / General Info}
-
-\begin{itemize}
-\item The Custom While Playing Screen (WPS) display is used as a means to customise the WPS to the user's likings.
-\item After editing the .wps file, ``play'' it to make it take effect.
-\item All characters not preceded by \% are displayed as typed.
-\item Lines beginning with \# are comments and will be ignored.
-\item Maximum file size used is \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600}
-\opt{player}{400}
-bytes. If you have a bigger WPS file, only the first part of it will be loaded and used.
-\end{itemize}
+\subsection{WPS -- General Info}
-\subsection{File Location}
-Custom WPS files may be located anywhere on the drive. The only restriction is
-that they must end in .wps. When you ``play'' a .wps file, it will be used for
-future WPS screens. If the ``played'' .wps file is located in the
-\fname{/.rockbox} folder, it will be remembered and used after reboot.
-The .wps filename must be no more than 24 characters long for it to be
+\begin{description}
+\item[Description: ] The WPS or While Playing Screen is the name used to describe
+the information displayed on the \dap\'s screen whilst an audio track is
+being played. The default WPS is a relatively simple screen displaying
+Track name, Artist, Album etc. in the default font as a purely text based
+layout. There are a number of WPS files included in Rockbox, and you can
+load one of these at anytime by selecting it\dots\\
+\emph{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}\\
+\opt{h1xx,h300}{There is a related option to browse .rwps files for \dap\'s
+with LCD remote controls installed. This will load a similar WPS screen
+for the remote but with usually a simpler and more concise layout.}
+
+\note{``Playing'' a wps from the file browser has the same effect.}
+
+\item [File Location: ]Custom WPS files may be located anywhere on the drive.
+The only restriction is that they must end in .wps. When you ``play'' a .wps
+file, it will be used for future WPS screens, and if the ``played'' .wps file is
+located in the \fname{/.rockbox} folder, it will be remembered and used after
+reboot. The .wps filename must be no more than 24 characters long for it to be
remembered.
+\end{description}
-\subsection{How To Create A .wps File}
+\subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own}
Quite simply, enter the WPS code in your favourite text editor, Notepad on
Windows works fine. When you save it, instead of saving it as a .txt file, save
it as a .wps file. Example: Instead of \fname{Rockbox.txt}, save the file as
@@ -69,16 +72,26 @@ done in most editors, for example Notepad in Windows 2000 or XP (but not in
9x/ME) can do this. See appendix \ref{ref:wps_tags} for all the tags that are
available.
+\begin{description}
+ \item All characters not preceded by \% are displayed as typed.
+ \item Lines beginning with \# are comments and will be ignored.
+ \item Maximum file size used is
+ \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600}
+ \opt{player}{400} bytes.\\
+ If you have a bigger WPS file, only the first part of it will be
+ loaded and used.
+\end{description}
+
\subsubsection{Conditional Tags}
-\textbf{If/else}\\
+\emph{If/else}\\
Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\
If the tag specified by ``xx'' has a value, the text between the ``{\textless}'' and the ``{\textbar}'' is displayed (the true part), else the text between the ``{\textbar}'' and the ``{\textgreater}'' is displayed (the false part).
The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals nest, so the text in the if and else part can contain all \% commands, including conditionals.
-\textbf{Enumerations}\\
+\emph{Enumerations}\\
Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\
@@ -89,11 +102,11 @@ Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textba
The last else part is optional, and will be displayed if the tag has no value. The WPS parser will always display the last part if the tag has no value, or if the list of alternatives is too short.
\subsubsection{Next Song info}
-You can display information about the next song {}- the song that is
+You can display information about the next song -- the song that is
about to play after the one currently playing (unless you change the
plan).
-If you use the upper{}-case versions of the
+If you use the upper--case versions of the
three tags: F, I and D, they will instead refer to the next song
instead of the current one. Example: \%Ig is the genre name used in the
next song and \%Ff is the mp3 frequency.
@@ -163,15 +176,17 @@ a subline can be skipped (not displayed) when that condition is met.
\subsubsection{Using Images}
-You can have as many as 52 images in your WPS. There are two ways of
+You can have as many as 52 images in your WPS. There are various ways of
displaying images:
\begin{enumerate}
\item Load and always show the image, using the \%x tag
\item Preload the image with \%xl and show it with \%xd. This way you can
have your images displayed conditionally.
- \item Load an image and show as backdrop using the \%X tag. The image must
- be of the same exact dimensions as your display. (Currently only
- supported on color targets).
+ \opt{h300,x5,ipodcolor,ipodvideo}{
+ \item On colour screen targets only... Load an image and show as backdrop
+ using the \%X tag. The image must be of the same exact dimensions as
+ your display.
+ }
\end{enumerate}
Example:
\begin{verbatim}
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index b7079b50a2..49c14cbc44 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -1,3 +1,4 @@
+% $Id$ %
\chapter{The Main Menu}
\section{Introducing the Main Menu}
@@ -83,29 +84,43 @@ browse the hard drive for alternate firmwares, and finally to reset your
\fixme{TODO: check and enhance the above text}
\section{Browse Themes}
-Within Rockbox it is possible to load a ``Theme'' -- a collection of
-configuration settings coupled with a WPS (While Playing Screen).
-This sets not only the WPS file, but also other relevant options such as
-the correct font or forground/background colours to use.
+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,
+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
+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}
+\opt{ipodvideo}{WpsIpod5g}\opt{ipodnano}{WpsIpodNano}
+\opt{ipodmini}{WpsIpodMini}\opt{x5}{WpsIaudioX5}}.
+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 the section on
+``Making Your Own Settings File'' on page \pageref{ref:CreateYourOwnWPS}
+for more details.
+}
-Selecting this option will list all of the currently installed Themes on the
-\dap\, \ButtonRight\ will load the chosen theme and apply it.
-\fixme{TODO: check and enhance the above text}
\opt{CONFIG_TUNER}{
\section{\label{ref:FMradio}FM Radio \opt{ondio}{(OndioFM Only)}}
- \opt{x5}{\note{Not Implemented on X5 yet}}
+ \opt{x5}{\note{Not currently Implemented on X5}}
\screenshot{main_menu/images/ss-fm-radio-screen}{The FM radio screen}{}
This menu option switches to the radio screen.
- \opt{h1xx,h300,x5}{
+
The FM radio has the ability \opt{HAVE_RECORDING}{to record and } to
remember station frequency settings (presets).
- \note{This option is not \emph{currently} enabled on the X5} }
\opt{recorderv2fm,ondio}{
- The keys are:
\begin{table}
\begin{btnmap}{}{}
\ButtonLeft, \ButtonRight
@@ -120,19 +135,18 @@ Selecting this option will list all of the currently installed Themes on the
\ButtonPlay & \emph{(EXPERIMENTAL)}\\
& freezes all screen updates.May enhance radio reception
in some cases.\\
- %
}
- \opt{RECORDER_PAD}{\ButtonOn}\opt{ONDIO_PAD}{FixMe}
+ \opt{RECORDER_PAD}{\ButtonOn}\opt{ONDIO_PAD}{\ButtonOff}
& Leave the radio screen with the radio playing \\
%
- \ButtonOff & Back to Main Menu.\\
+ \opt{RECORDER_PAD}{\ButtonOff}\opt{ONDIO_PAD}{hold \ButtonOff}
+ & Back to Main Menu.\\
\end{btnmap}
\end{table}
}
+ \fixme{Add Radio recording and Preset keys to FM Recorder and Ondio FM}
\opt{h1xx,h300,x5}{
-
- The keys are:
\begin{table}
\begin{btnmap}{}{}
\ButtonLeft, \ButtonRight & Change frequency in 0.1 MHz steps. \\
@@ -364,7 +378,8 @@ Selecting this option will list all of the currently installed Themes on the
default location is \fname{/recordings}.
\item[Show recording screen on startup:]
- If set to yes, the \dap\ will start up with the while recording screen showing.\\
+ If set to yes, the \dap\ will start up with the while recording screen
+ showing.\\
Options: Yes, No\\
\item[Clipping Light:]
@@ -396,15 +411,22 @@ from where you currently are.
specified file. If no path is provided then playlist is saved to current
directory (see page \pageref{ref:Playlistsubmenu}).
-\item[Recursively Insert Directories.]
+\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
+
+\item[Warn When Erasing Dynamic Playlist: ]
+ \fixme{some information about this function....}
+ Options: Yes, No
\end{description}
\section{Browse Plugins}
With this option you can load and run various plugins that have been
-written for Rockbox.A detailed description of the different plugins begins
+written for Rockbox. There are a wide variety of these supplied with
+Rockbox, including several games, some impressive demo's and a number of
+utilities. A detailed description of the different plugins begins
on page \pageref{ref:plugins}.
\section{\label{ref:Info}Info}
@@ -440,15 +462,17 @@ battery status, hard disk size and the amount of free space on the disk.
for more details.
}
+\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_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 \fixme{check this setting!}
- \opt{RECORDER_PAD}{\ButtonFOne}
- \opt{ONDIO_PAD}{\ButtonMenu}
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonSelect}
- and it allows rapid access to the Shuffle and Repeat Modes
+ This screen is accessed by holding the
+ \opt{RECORDER_PAD}{\ButtonFTwo}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
+ \opt{IPOD_4G_PAD}{\ButtonMenu}
+ \opt{IAUDIO_X5_PAD}{\ButtonRec}
+ key, and it allows rapid access to the Shuffle and Repeat Modes
(Page \pageref{ref:PlaybackOptions})
and the Show Files options (Page \pageref{ref:ShowFiles}).
-
+}