Some small corrections to Advanced Topics. Code policing.

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

1 files changed, 102 insertions, 76 deletions

diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index e9c9fbd849..3a4d782b7d 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -1,37 +1,41 @@
 \chapter{Advanced Topics}
 
 \section{\label{ref:CustomisingUI}Customising the userinterface}
-\subsection{\label{ref:GettingExtras}Getting Extras (Fonts,Languages)}
+\subsection{\label{ref:GettingExtras}Getting Extras (Fonts, Languages)}
 Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of different languages. Rockbox comes with several fonts and languages already included. If new fonts and language files have been created, then they will be found at \url{http://www.rockbox.org/fonts/} and \url{http://www.rockbox.org/lang/}.
 
-\subsection{\label{ref:Loadingfonts}Loading Fonts (Recorder, Ondio)}
-Rockbox can load fonts dynamically. Simply copy the .fnt file to the \dap\ and ``play'' them in the directory browser or select \textbf{General Settings {\textgreater} 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.
+\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.
+
+  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.
+}
 
 \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 {}-{\textgreater} 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.
+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 supports many different languages. You can get .lng files at \url{http://www.rockbox.org/lang/}.
-Currently all of these languages are included in the Rockbox
-distribution.
+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.
 
-If your language is not yet supported and you want to write your own language file,  follow these instructions:
+Rockbox supports many different languages. You can get .lng files at
+\url{http://www.rockbox.org/lang/}.
+Currently all of these languages are included in the Rockbox distribution.
 
-\begin{itemize}
-\item Copy the\url{./ http://www.rockbox.org/lang/english.lang} file and start filling in the ``new:'' lines.
-\item Name your file \fname{{\textless}language{\textgreater}.lang}, where
-\fname{{\textless}language{\textgreater}} is the local name for your language. i.e. \fname{svenska.lang}, \fname{francais.lang} etc.
-\item When you are done, submit your .lang file to Rockbox patch tracker.\\
-  (\url{http://www.rockbox.org/bugs/index.php?type=4})
-\end{itemize}
+If your language is not yet supported and you want to write your own language
+file find the instructions on the Rockbox website:
+\url{http://www.rockbox.org/twiki/bin/view/Main/HowtoUpdateLangfile}
 
 \section{\label{ref:ConfiguringtheWPS}Configuring the WPS}
 
@@ -42,14 +46,28 @@ If your language is not yet supported and you want to write your own language fi
 \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.
+\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{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 remembered.
+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
+remembered.
 
 \subsection{How To Create A .wps File}
-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 \fname{Rockbox.wps}. To make sure non english characters display correctly in your WPS you must save the .wps file with UTF-8 character encoding. This can be 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.
+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
+\fname{Rockbox.wps}. To make sure non english characters display correctly in
+your WPS you must save the .wps file with UTF-8 character encoding. This can be
+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.
 
 \subsubsection{Conditional Tags}
 
@@ -128,7 +146,7 @@ Example subline with conditionals:
 
 \%?it{\textless}\%t8\%s\%it{\textbar}\%s\%fn{\textgreater};\%?ia{\textless}\%t3\%s\%ia{\textbar}\%t0{\textgreater}\\
 
-The format above will do two different things depending if ID3 tags are present. If the ID3 artist and title are present :
+The format above will do two different things depending if ID3 tags are present. If the ID3 artist and title are present:
 
 Display id3 title for 8 seconds,\\
 
@@ -136,19 +154,24 @@ Display id3 artist for 3 seconds,\\
 
 repeat...\\
 
-If the ID3 artist and title are not present :\\
+If the ID3 artist and title are not present:\\
 
 Display the filename continuously.\\
 
-Note that by using a subline display time of 0 in one branch of a conditional, a subline can be skipped (not displayed) when that condition is met. 
+Note that by using a subline display time of 0 in one branch of a conditional,
+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 displaying images:
+You can have as many as 52 images in your WPS. There are two 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).
+  \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).
 \end{enumerate}
 Example:
 \begin{verbatim}
@@ -160,17 +183,23 @@ Example:
 %xl|e|rep_shuffle.bmp|16|64|
 %?mm<%xdb|%xdc|%xdd|%xde>
 \end{verbatim}
-This example loads and displays a background image, and preloads four other images at the same x and y position. Which image to display is determined by the \%mm tag (the repeat mode).
+This example loads and displays a background image, and preloads four other
+images at the same x and y position. Which image to display is determined by
+the \%mm tag (the repeat mode).
 
 \subsubsection{Example File}
 \begin{verbatim}
 %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]>
 %pb%pc/%pt
 \end{verbatim}
-That is, "tracknum - title [artist, album]", where most fields are only displayed if available. Could also be rendered as "filename" or "tracknum - title [artist]".
+That is, ``tracknum -- title [artist, album]'', where most fields are only
+displayed if available. Could also be rendered as ``filename'' or ``tracknum --
+title [artist]''.
 
 \subsubsection{Default}
-If you haven't selected a .wps file in the \fname{/.rockbox} directory, you get the hard coded layout. The default WPS screen is:
+If you haven't selected a .wps file in the \fname{/.rockbox} directory, you get
+the hard coded layout. The default WPS screen is:
+\fixme{do we really want to include the default wps in a users manual?}
 \opt{player}{
 %\begin{verbatim}
   %s%pp/%pe: %?it<%it|%fn> - %?ia<%ia|%d2> - %?id<%id|%d1>
@@ -192,9 +221,14 @@ If you haven't selected a .wps file in the \fname{/.rockbox} directory, you get
 }
 
 \section{\label{ref:SettingsFile}Making your own settings file}
-A .cfg file is used to load settings from a plain text file. A .cfg file may reside anywhere on the hard disk. The only restriction is that the filename must end in .cfg
+A .cfg file is used to load settings from a plain text file. A .cfg file may
+reside anywhere on the hard disk. The only restriction is that the filename
+must end in .cfg
 
-Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu{}-{\textgreater} General Settings}) to save the current settings, then use a text editor to customize the settings file. See appendix \ref{ref:config_file_options} for the full reference of available options.
+Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu$\rightarrow$
+General Settings}) to save the current settings, then use a text editor to
+customize the settings file. See appendix \ref{ref:config_file_options} 
+for the full reference of available options.
 
 \subsection{Format Rules}
 
@@ -218,43 +252,29 @@ Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu{}-{\textgreater} Ge
 \end{verbatim}
 
 \section{\label{ref:PartISection1}Differences between binaries}
-There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge.
-
-\begin{itemize}
-\item The current version is the latest stable version developed by the Rockbox Team. It's free of known critical bugs.  It is available from \url{http://www.rockbox.org/download/}.
-\item The Daily Build is a development version of Rockbox. It supports all new features and patches developed since last stable version. It may also contain bugs! This version is generated automatically every day and can be found at \url{http://www.rockbox.org/daily.shtml}.
-\item Bleeding edge builds are the same as the Daily build, but built from the latest development on each commit to the CVS repository. These builds are for people who want to test the code that developers just checked in.
-\end{itemize}
-
-\opt{recorder,recorderv2fm,ondo,player}{
-There are binaries for different \dap\ models:
-
-\begin{itemize}
-\item \begin{itemize}
-\item The Player version is suitable for Archos Jukebox 5000, 6000 and
-all Studio models.
-\end{itemize}
-\end{itemize}
-\begin{itemize}
-\item \begin{itemize}
-\item If you have a recorder with cylindrically rounded bumpers, you
-need the ``regular'' recorder version. 
-\item FM Recorders are models with a FM radio.
-\item The V2 recorder is a recorder in an FM Recorder form factor, but
-without radio. 
-\item The 8mb version requires a hardware hack, where the RAM chips are
-replaced. 
-\item  The Ondio builds come with and without radio support, for the
-Ondio FM and SP respectively.
-\end{itemize}
-\end{itemize}
-If in doubt as to which version to use, the table on page
-\pageref{ref:Jukeboxtypetable} may be of assistance.
-
-Note: All references in this manual to
-``Recorder'' apply equally to the FM Recorder
-unless otherwise specified.
-}
+There are 3 different types of firmware binaries from Rockbox website: 
+Current Version, Daily Builds and Bleeding Edge.
+
+\begin{description}
+\item[Current Version.] The current version is the latest stable version
+developed by the Rockbox Team. It's free of known critical bugs.  It is
+available from \url{http://www.rockbox.org/download/}.
+\item[Daily Builds.] The Daily Build is a development version of Rockbox. It
+supports all new features and patches developed since last stable version. It
+may also contain bugs! This version is generated automatically every day 
+and can be found at \url{http://www.rockbox.org/daily.shtml}.
+\item[Bleeding Edge.] Bleeding edge builds are the same as the Daily build, 
+but built from the latest development on each commit to the CVS repository.
+These builds are for people who want to test the code that developers just
+checked in.
+\end{description}
+\note{If you don't want to get undefined behaviour from your \dap\ you should
+really stick to the Current Version. Development versions may have lots of
+changes so they may behave completely different than described in this manual,
+introduce new (and maybe annoying) bugs and similar. If you want to help the
+project development you can try development builds and help by reporting bugs,
+feature requests and so so. But be aware that using a development build may
+eat also some more time.}
 
 
 \section{\label{ref:FirmwareLoading}Firmware Loading}
@@ -270,6 +290,12 @@ load a file other than the one you intended.
 }
 
 \section{\label{ref:using_rolo}Using ROLO (Rockbox loader)}
-Rockbox is able to load and start another firmware file without rebooting. You just press PLAY on an \opt{recorder,recorderv2fm,ondio}{.ajz}\opt{player}{.mod}\opt{h1xx,h300}{.iriver}\opt{ipodnano,ipodvideo,ipodnano}{.ipod} file. This can be used to test new firmware versions without deleting your current version.
+Rockbox is able to load and start another firmware file without rebooting. 
+You just press PLAY on an 
+\opt{recorder,recorderv2fm,ondio}{.ajz}
+\opt{player}{.mod}\opt{h1xx,h300}{.iriver}
+\opt{ipodnano,ipodvideo,ipodnano}{.ipod} 
+file. This can be used to test new firmware versions without deleting your
+current version.
 
 \opt{recorder,recorderv2fm,ondio}{\input{advanced_topics/archos-flashing.tex}}