devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Introduce new example environment. Slight adjustment of the code env. Change fname to use texttt. Add fname to the firmwarefilename macro in the platform files. Cleanup of the advanced topics chapter. The archos flashing still needs attention.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10081 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Martin Arver 2006-06-07 12:15:46 +00:00
parent 0dd1f8ec11
commit 47ea906535
15 changed files with 120 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

182
manual/advanced_topics/main.tex
View file

@ -6,26 +6,25 @@ Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of
\opt{HAVE_LCD_BITMAP}{ \opt{HAVE_LCD_BITMAP}{
\subsection{\label{ref:Loadingfonts}Loading Fonts} \subsection{\label{ref:Loadingfonts}Loading Fonts}
Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the \dap\ Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the
and ``play'' them in the directory browser or select \dap\ and ``play'' them in the directory browser or select
\emph{General Settings $\rightarrow$ Fonts} from the Main Menu. \setting{General Settings $\rightarrow$ Fonts} from the Main Menu.
If you want a font to be loaded automatically every time you start up, 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 it must be located in the \fname{/.rockbox } folder and the filename
must be at most 24 characters long. must be at most 24 characters long.
\warn{Advanced Users Only: Any BDF font file up to 16 pixels high should \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} be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use the \fname{convbdf} tool. This tool can be found in the \fname{tools} directory
tool. This tool can be found in the tools directory of the Rockbox source of the Rockbox source code.}
code.}
} }
\subsection{\label{ref:Loadinglanguages}Loading Languages} \subsection{\label{ref:Loadinglanguages}Loading Languages}
Rockbox can load language files at runtime. Simply copy the .lng file Rockbox can load language files at runtime. Simply copy the \fname{.lng} file
\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the \emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
Rockbox directory browser or select \emph{General Settings $\rightarrow$ Rockbox directory browser or select \setting{General Settings $\rightarrow$
Languages }from the Main Menu. Languages }from the Main Menu.
\note{If you want a language to be loaded automatically every time you start \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 up, it must be located in the \fname{/.rockbox }folder and the filename must
be a maximum of 24 characters long.} be a maximum of 24 characters long.}
If your language is not yet supported and you want to write your own language If your language is not yet supported and you want to write your own language
@ -38,35 +37,35 @@ file find the instructions on the Rockbox website:
\begin{description} \begin{description}
\item[Description: ] The WPS or While Playing Screen is the name used to describe \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 the information displayed on the \daps\ screen whilst an audio track is
being played. The default WPS is a relatively simple screen displaying 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 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 layout. There are a number of WPS files included in Rockbox, and you can
load one of these at anytime by selecting it\dots\\ load one of these at anytime by selecting it\dots\\
\emph{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}\\ \setting{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}\\
\opt{h1xx,h300}{There is a related option to browse .rwps files for \dap\'s \opt{h1xx,h300}{There is a related option to browse \fname{.rwps} files for
with LCD remote controls installed. This will load a similar WPS screen \daps\ with LCD remote controls installed. This will load a similar WPS
for the remote but with usually a simpler and more concise layout.} 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.} \note{``Playing'' a \fname{.wps} from the file browser has the same effect.}
\item [File Location: ]Custom WPS files may be located anywhere on the drive. \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 The only restriction is that they must end in \fname{.wps}. When you ``play''
file, it will be used for future WPS screens, and if the ``played'' .wps file is a \fname{.wps} file, it will be used for future WPS screens, and if the
located in the \fname{/.rockbox} folder, it will be remembered and used after ``played'' \fname{.wps} file is located in the \fname{/.rockbox} folder, it
reboot. The .wps filename must be no more than 24 characters long for it to be will be remembered and used after reboot. The \fname{.wps} filename must be no
remembered. more than 24 characters long for it to be remembered.
\end{description} \end{description}
\subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own} \subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own}
Quite simply, enter the WPS code in your favourite text editor, Notepad on 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 Windows works fine. When you save it, instead of saving it as a \fname{.txt}
it as a .wps file. Example: Instead of \fname{Rockbox.txt}, save the file as file, save it as a \fname{.wps} file. Example: Instead of \fname{Rockbox.txt},
\fname{Rockbox.wps}. To make sure non english characters display correctly in save the file as \fname{Rockbox.wps}. To make sure non english characters
your WPS you must save the .wps file with UTF-8 character encoding. This can be display correctly in your WPS you must save the .wps file with UTF-8 character
done in most editors, for example Notepad in Windows 2000 or XP (but not in encoding. This can be done in most editors, for example Notepad in Windows 2000
9x/ME) can do this. See appendix \ref{ref:wps_tags} for all the tags that are or XP (but not in 9x/ME) can do this. See appendix \ref{ref:wps_tags} for all
available. the tags that are available.
\begin{description} \begin{description}
\item All characters not preceded by \% are displayed as typed. \item All characters not preceded by \% are displayed as typed.
@ -80,15 +79,14 @@ available.
\subsubsection{Conditional Tags} \subsubsection{Conditional Tags}
\emph{If/else}\\ \begin{description}
\item[If/else: ]
Syntax: \%?xx{\textless}true{\textbar}false{\textgreater}\\ 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). 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. 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.
\emph{Enumerations}\\ \item[Enumerations: ]
Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\ Syntax: \%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}...{\textbar}else{\textgreater}\\
For tags with multiple values, like Play status, the conditional can hold a list of alternatives, one for each value the tag can have. For tags with multiple values, like Play status, the conditional can hold a list of alternatives, one for each value the tag can have.
@ -96,6 +94,7 @@ For tags with multiple values, like Play status, the conditional can hold a list
Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}\\ Example: \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}\\
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. 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.
\end{description}
\subsubsection{Next Song info} \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
@ -107,10 +106,10 @@ 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 instead of the current one. Example: \%Ig is the genre name used in the
next song and \%Ff is the mp3 frequency. next song and \%Ff is the mp3 frequency.
Take note that the next song information WILL NOT be available at all \note{The next song information WILL NOT be available at all
times, but will most likely be available at the end of a song. We times, but will most likely be available at the end of a song. We
suggest you use the conditional display tag a lot when displaying suggest you use the conditional display tag a lot when displaying
information about the next song! information about the next song!}
\subsubsection{Alternating sublines} \subsubsection{Alternating sublines}
@ -141,19 +140,21 @@ as they are separated into different sublines.
Example subline definition: Example subline definition:
\begin{verbatim} \begin{example}
%s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds, %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds,
Display id3 title for 2 seconds, Display id3 title for 2 seconds,
Display current and remaining track time Display current and remaining track time
for 3 seconds, for 3 seconds,
repeat... repeat...
\end{verbatim} \end{example}
Conditionals can be used with sublines to display a different set and/or number of sublines on the line depending on the evaluation of the conditional. Conditionals can be used with sublines to display a different set and/or number of sublines on the line depending on the evaluation of the conditional.
Example subline with conditionals: Example subline with conditionals:
\%?it{\textless}\%t8\%s\%it{\textbar}\%s\%fn{\textgreater};\%?ia{\textless}\%t3\%s\%ia{\textbar}\%t0{\textgreater}\\ \begin{example}
%?it{\textless}%t8%s%it{\textbar}%s%fn{\textgreater};%?ia{\textless}%t3%s%ia{\textbar}%t0{\textgreater}\\
\end{example}
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:
@ -178,68 +179,60 @@ displaying images:
\item Load and always show the image, using the \%x tag \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 \item Preload the image with \%xl and show it with \%xd. This way you can
have your images displayed conditionally. have your images displayed conditionally.
\opt{h300,x5,ipodcolor,ipodvideo}{ \opt{HAVE_LCD_COLOR}{
\item On colour screen targets only... Load an image and show as backdrop \item Load an image and show as backdrop using the \%X tag. The image must be
using the \%X tag. The image must be of the same exact dimensions as of the same exact dimensions as your display.
your display.
} }
\end{enumerate} \end{enumerate}
Example:\\ \optv{HAVE_LCD_COLOR}{
\opt{HAVE_LCD_COLOR}{ Example on background image use:
\config{\%X|background.bmp|}\\ \begin{example}
%X|background.bmp|\\
\end{example}
The image with filename \fname{background.bmp} is loaded and used in the WPS.
} }
\config{
Example on bitmap preloading and use:
\begin{example}
\%x|a|static\_icon.bmp|50|50|\\ \%x|a|static\_icon.bmp|50|50|\\
\%xl|b|rep\_off.bmp|16|64|\\ \%xl|b|rep\_off.bmp|16|64|\\
\%xl|c|rep\_all.bmp|16|64|\\ \%xl|c|rep\_all.bmp|16|64|\\
\%xl|d|rep\_one.bmp|16|64|\\ \%xl|d|rep\_one.bmp|16|64|\\
\%xl|e|rep\_shuffle.bmp|16|64|\\ \%xl|e|rep\_shuffle.bmp|16|64|\\
\%?mm<\%xdb|\%xdc|\%xdd|\%xde>\\ \%?mm<%xdb|%xdc|%xdd|%xde>\\
} \end{example}
\opt{HAVE_LCD_COLOR}{This example loads and displays a background image.} Four Four images at the same x and y position are preloaded in the example. Which
images at the same x and y position are preloaded. Which image to display is image to display is determined by the \%mm tag (the repeat mode).
determined by the \%mm tag (the repeat mode).
\subsubsection{Example File} \subsubsection{Example File}
\begin{verbatim} \begin{example}
%s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]> \%s\%?in<\%in - >\%?it<\%it|\%fn> \%?ia<[\%ia\%?id<, \%id>]>
%pb%pc/%pt \%pb\%pc/\%pt
\end{verbatim} \end{example}
That is, ``tracknum -- title [artist, album]'', where most fields are only That is, ``tracknum -- title [artist, album]'', where most fields are only
displayed if available. Could also be rendered as ``filename'' or ``tracknum -- displayed if available. Could also be rendered as ``filename'' or ``tracknum --
title [artist]''. title [artist]''.
\subsubsection{Default} %\opt{HAVE_LCD_BITMAP}{
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>
%pc%?ps<*|/>%pt
%\end{verbatim}
}
\opt{HAVE_LCD_BITMAP}{
% \begin{verbatim} % \begin{verbatim}
%s%?it<%?in<%in. |>%it|%fn> % %s%?it<%?in<%in. |>%it|%fn>
%s%?ia<%ia|%?d2<%d2|(root)>> % %s%?ia<%ia|%?d2<%d2|(root)>>
%s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|> % %s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|>
%
%al%pc/%pt%ar[%pp:%pe] % %al%pc/%pt%ar[%pp:%pe]
%fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)> % %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>
%pb % %pb
%pm % %pm
% \end{verbatim} % % \end{verbatim}
} %}
\section{\label{ref:SettingsFile}Making your own settings file} \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 A \fname{.cfg} file is used to load settings from a plain text file. A
reside anywhere on the hard disk. The only restriction is that the filename \fname{.cfg} file may reside anywhere on the hard disk. The only restriction is
must end in .cfg that the filename must end in \fname{.cfg}
Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu$\rightarrow$ Hint: Use the \setting{Write .cfg file} feature (\setting{Main Menu$\rightarrow$
General Settings}) to save the current settings, then use a text editor to General Settings}) to save the current settings, then use a text editor to
customize the settings file. See appendix \ref{ref:config_file_options} customize the settings file. See appendix \ref{ref:config_file_options}
for the full reference of available options. for the full reference of available options.
@ -253,7 +246,7 @@ for the full reference of available options.
\end{itemize} \end{itemize}
\subsection{Example File} \subsection{Example File}
\begin{verbatim} \begin{example}
volume: 70 volume: 70
bass: 11 bass: 11
treble: 12 treble: 12
@ -263,7 +256,7 @@ for the full reference of available options.
show files: supported show files: supported
wps: /.rockbox/car.wps wps: /.rockbox/car.wps
lang: /.rockbox/afrikaans.lng lang: /.rockbox/afrikaans.lng
\end{verbatim} \end{example}
\section{\label{ref:PartISection1}Differences between binaries} \section{\label{ref:PartISection1}Differences between binaries}
There are 3 different types of firmware binaries from Rockbox website: There are 3 different types of firmware binaries from Rockbox website:
@ -293,23 +286,22 @@ eat also some more time.}
\section{\label{ref:FirmwareLoading}Firmware Loading} \section{\label{ref:FirmwareLoading}Firmware Loading}
\opt{player,recorder,recorderv2fm,ondio}{ \opt{player,recorder,recorderv2fm,ondio}{
When your Jukebox powers on, it loads the Archos firmware in ROM, which When your \dap\ powers on, it loads the Archos firmware in ROM, which
automatically checks your Jukebox hard disk's root folder for a file automatically checks your Jukebox hard disk's root folder for a file named
named \fname{archos.mod} (on the player version) or \firmwarefilename. Note that Archos firmware can only read the first
\fname{ajbrec.ajz} (on the recorder version). Note that Archos ten characters of each filename in this process, so don't rename your old
firmware can only read the first ten characters of each file name in firmware files with names like \firmwarefilename.\fname{old} and so on,
this process, so don't rename your old firmware files with names like because it's possible that the \dap\ will load a file other than the one you
archos.mod.old and so on, because it's possible that the Jukebox will intended.
load a file other than the one you intended.
} }
\section{\label{ref:using_rolo}Using ROLO (Rockbox loader)} \section{\label{ref:using_rolo}Using ROLO (Rockbox loader)}
Rockbox is able to load and start another firmware file without rebooting. Rockbox is able to load and start another firmware file without rebooting.
You just press PLAY on an You just press PLAY on an%
\opt{recorder,recorderv2fm,ondio}{.ajz} \opt{recorder,recorderv2fm,ondio}{\fname{.ajz}}
\opt{player}{.mod}\opt{h1xx,h300}{.iriver} \opt{player}{.mod}\opt{h1xx,h300}{\fname{.iriver}}
\opt{ipodnano,ipodvideo,ipodnano}{.ipod} \opt{ipodnano,ipodvideo,ipodnano}{\fname{.ipod}}%
file. This can be used to test new firmware versions without deleting your -file. This can be used to test new firmware versions without deleting your
current version. current version.
\opt{recorder,recorderv2fm,ondio}{\input{advanced_topics/archos-flashing.tex}} \opt{recorder,recorderv2fm,ondio}{\input{advanced_topics/archos-flashing.tex}}

2
manual/platform/h1xx.tex
View file

@ -15,7 +15,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.iriver} \newcommand{\firmwarefilename}{\fname{rockbox.iriver}}
\newcommand{\ButtonLeft}{Left} \newcommand{\ButtonLeft}{Left}
\newcommand{\ButtonRight}{Right} \newcommand{\ButtonRight}{Right}

2
manual/platform/h300.tex
View file

@ -17,7 +17,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.iriver} \newcommand{\firmwarefilename}{\fname{rockbox.iriver}}
\newcommand{\ButtonLeft}{Left} \newcommand{\ButtonLeft}{Left}
\newcommand{\ButtonRight}{Right} \newcommand{\ButtonRight}{Right}

2
manual/platform/ipod4g.tex
View file

@ -14,7 +14,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.ipod} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
\newcommand{\ButtonLeft}{Prev} \newcommand{\ButtonLeft}{Prev}
\newcommand{\ButtonRight}{Next} \newcommand{\ButtonRight}{Next}

2
manual/platform/ipodcolor.tex
View file

@ -15,7 +15,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.ipod} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
\newcommand{\ButtonLeft}{Prev} \newcommand{\ButtonLeft}{Prev}
\newcommand{\ButtonRight}{Next} \newcommand{\ButtonRight}{Next}

2
manual/platform/ipodmini.tex
View file

@ -14,7 +14,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.ipod} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
\newcommand{\ButtonLeft}{Prev} \newcommand{\ButtonLeft}{Prev}
\newcommand{\ButtonRight}{Next} \newcommand{\ButtonRight}{Next}

2
manual/platform/ipodnano.tex
View file

@ -15,7 +15,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.ipod} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
\newcommand{\ButtonLeft}{Prev} \newcommand{\ButtonLeft}{Prev}
\newcommand{\ButtonRight}{Next} \newcommand{\ButtonRight}{Next}

2
manual/platform/ipodvideo.tex
View file

@ -15,7 +15,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.ipod} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}}
\newcommand{\ButtonLeft}{Prev} \newcommand{\ButtonLeft}{Prev}
\newcommand{\ButtonRight}{Next} \newcommand{\ButtonRight}{Next}

2
manual/platform/ondiofm.tex
View file

@ -18,7 +18,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{ajbrec.ajz} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
\newcommand{\ButtonLeft}{Left} \newcommand{\ButtonLeft}{Left}
\newcommand{\ButtonRight}{Right} \newcommand{\ButtonRight}{Right}

2
manual/platform/ondiosp.tex
View file

@ -15,7 +15,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{ajbrec.ajz} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
\newcommand{\ButtonLeft}{Left} \newcommand{\ButtonLeft}{Left}
\newcommand{\ButtonRight}{Right} \newcommand{\ButtonRight}{Right}

2
manual/platform/player.tex
View file

@ -12,7 +12,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{archos.mod} \newcommand{\firmwarefilename}{\fname{archos.mod}}
\newcommand{\ButtonLeft}{Left} \newcommand{\ButtonLeft}{Left}
\newcommand{\ButtonRight}{Right} \newcommand{\ButtonRight}{Right}

2
manual/platform/recorder.tex
View file

@ -15,7 +15,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{ajbrec.ajz} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
\newcommand{\ButtonOn}{On} \newcommand{\ButtonOn}{On}
\newcommand{\ButtonOff}{Stop} \newcommand{\ButtonOff}{Stop}

2
manual/platform/recorderv2fm.tex
View file

@ -16,7 +16,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{ajbrec.ajz} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}}
\newcommand{\ButtonOn}{On} \newcommand{\ButtonOn}{On}
\newcommand{\ButtonOff}{Stop} \newcommand{\ButtonOff}{Stop}

2
manual/platform/x5.tex
View file

@ -17,7 +17,7 @@
\newcommand{\dap}{player} \newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity ... %For use when referring to the player. E.g. the \daps\ capacity ...
\newcommand{\daps}{player's} \newcommand{\daps}{player's}
\newcommand{\firmwarefilename}{rockbox.iaudio} \newcommand{\firmwarefilename}{\fname{rockbox.iaudio}}
\newcommand{\ButtonLeft}{Left} \newcommand{\ButtonLeft}{Left}
\newcommand{\ButtonRight}{Right} \newcommand{\ButtonRight}{Right}

27
manual/preamble.tex
View file

@ -28,7 +28,7 @@
pdfsubject = {Rockbox user manual for \playername} pdfsubject = {Rockbox user manual for \playername}
} }
\newcommand{\fname}[1]{\textbf{#1}} \newcommand{\fname}[1]{\texttt{#1}}
\newcommand{\tabeltc}[1]{{\centering #1 \par}} \newcommand{\tabeltc}[1]{{\centering #1 \par}}
\newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}} \newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}
@ -76,12 +76,12 @@
\setlength{\headheight}{18.5pt} \setlength{\headheight}{18.5pt}
\newcounter{example}[chapter] \newcounter{example}[chapter]
\newenvironment{example} %% \newenvironment{example}
{\stepcounter{example}\paragraph{Example \theexample:}} %% {\stepcounter{example}\paragraph{Example \theexample:}}
{\hfill$\Box$ %% {\hfill$\Box$
\bigskip %% \bigskip
\noindent} %% \noindent}
% found on the internet, posting by Donald Arseneau % found on the internet, posting by Donald Arseneau
% I may as well include my robust expandable definions, which can be % I may as well include my robust expandable definions, which can be
@ -220,9 +220,22 @@
% This is intended to make the LaTeX sources more readable. % This is intended to make the LaTeX sources more readable.
% Note: when using the code environment you need to use optv instead of opt! % Note: when using the code environment you need to use optv instead of opt!
\DefineVerbatimEnvironment{code}{Verbatim}% \DefineVerbatimEnvironment{code}{Verbatim}%
{numbers=left,frame=lines,% {framerule=0.4pt, framesep=1ex,numbers=left,frame=lines,%
gobble=4,fontsize=\footnotesize,xleftmargin=10pt,% gobble=4,fontsize=\footnotesize,xleftmargin=10pt,%
label=\textnormal{\textsc{Code}},% label=\textnormal{\textsc{Code}},%
commandchars=\\\{\}% commandchars=\\\{\}%
} }
% define environment "example" based on fancyvrb.
% use it to set example code the user should type / see on his screen.
% Note: the first 4 characters of each line will be stripped,
% requiring everything to be indendet by exactly _4_ spaces!
% This is intended to make the LaTeX sources more readable.
% Note: when using the example environment you need to use optv instead of opt!
\DefineVerbatimEnvironment{example}{Verbatim}%
{commentchar=!,framerule=0.4pt, framesep=1ex,frame=lines,%
fontsize=\footnotesize,xleftmargin=10pt,%
label=\textnormal{\textsc{Example}},%
commandchars=\\\{\}%
}