1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 % Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 % Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 % Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
12 % Copyright (C) 2006 The Rockbox Manual Team
14 % All files in this archive are subject to the GNU Free Documentation License
15 % See the file COPYING-MANUAL in the source tree docs/ directory for full license
18 % Contributors are listed in the file docs/CREDITS-MANUAL
20 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
22 \documentclass[a4paper,
11pt
]{scrreprt
}
23 \usepackage[utf8
]{inputenc}
24 % This manual used to use Palatino as font. This caused issues with small caps
25 % (textsc), so do not use that font as default one anymore.
39 \usepackage[table
]{xcolor
}
41 \input{platform/
\platform.tex
}
44 \newcommand{\playername}{\playerman\
\playerlongtype}
46 \hypersetup{% add some values to the pdf properties
52 pdftitle =
{Rockbox user manual
},
53 pdfauthor =
{The Rockbox Team
},
54 pdfsubject =
{Rockbox user manual for
\playername}
57 \newcommand{\fname}[1]{\texttt{#1}}
58 \newcommand{\tabeltc}[1]{{\centering #1 \par}}
59 \newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}
61 \newcommand{\fixme}[1]{\textbf{\textcolor{red
}{#1}}}
68 \usepackage{enumerate
}
70 \ifpdfoutput{\usepackage{booktabs
}}%
72 \toprule}{}\newcommand{\midrule}{\hline}\newcommand{\bottomrule}{}%
74 \usepackage{longtable
}
81 % pdf output: try pdf first, then png and jpg as file format
82 % html output: try png first, then jpg. Ignore pdf files
83 % this only applies if no file extension is given!
84 \ifpdfoutput{\DeclareGraphicsExtensions{.pdf,.png,.jpg
}}%
85 {\DeclareGraphicsExtensions{.png,.jpg
}}
87 % fancy header style adjustments
90 \fancyhead[L
]{{\nouppercase{\textsc{\leftmark}}}}
91 \fancyhead[R
]{\iffloatpage{}{\thepage}}
92 \fancyfoot[L
]{\textsc{The Rockbox manual
}}
93 \fancyfoot[R
]{\textsc{\playerman{} \playertype}}
94 \fancypagestyle{plain
}{}
96 \renewcommand{\headrulewidth}{\iffloatpage{0pt
}{0.4pt
}}
97 \renewcommand{\footrulewidth}{\iffloatpage{0pt
}{0.4pt
}}
98 \setlength{\headheight}{18.5pt
}
99 \newcounter{example
}[chapter
]
101 %% \newenvironment{example}
102 %% {\stepcounter{example}\paragraph{Example \theexample:}}
108 % found on the internet, posting by Donald Arseneau
109 % I may as well include my robust expandable definions, which can be
110 % used in \edef or \write where the \def would not be executed:
112 % \if\blank --- checks if parameter is blank (Spaces count as blank)
113 % \if\given --- checks if parameter is not blank: like \if\blank{#1}\else
114 % \if\nil --- checks if parameter is null (spaces are NOT null)
115 % use \if\given{ } ... \else ... \fi etc.
117 {\catcode`\!=
8 % funny catcode so ! will be a delimiter
118 \catcode`
\Q=
3 % funny catcode so Q will be a delimiter
119 \long\gdef\given#1{88\fi\Ifbl@nk
#1QQQ
\empty!
}
120 \long\gdef\blank#1{88\fi\Ifbl@nk
#1QQ..!
}% if null or spaces
121 \long\gdef\nil#1{\IfN@Ught
#1*
{#1}!
}% if null
122 \long\gdef\IfN@Ught
#1 #2!
{\blank{#2}}
123 \long\gdef\Ifbl@nk
#1#2Q
#3!
{\ifx#3}% same as above
126 % environment for setting the changelog.
127 \newenvironment{changelog
}%
128 {\renewcommand{\labelitemi}{$
\star$
}\setitemize{noitemsep,topsep=
0pt
}%
133 % add screenshot image.
134 % Usage: \screenshot{filename}{caption}{label}
135 % By using the 'H' (HERE) placement, the screenshots are placed where
137 % Note: use this only for screenshots!
138 % Note: leave caption empty to supress it.
139 \newcommand{\screenshot}[3]{
142 \IfFileExists{#1-
\genericimg-
\specimg.png
}
143 {\includegraphics[width=
\screenshotsize]{#1-
\genericimg-
\specimg.png
}
144 \typeout{Note: device specific image used
}}
145 {\IfFileExists{#1-
\genericimg.png
}
146 {\includegraphics[width=
\screenshotsize]{#1-
\genericimg.png
}}
148 {\includegraphics[width=
\screenshotsize]{#1}
149 \typeout{Warning: deprecated plain image name used
}}%
150 {\typeout{Missing image:
#1 (
\genericimg) (
\specimg)
}%
151 \color{red
}{\textbf{WARNING!
} Image not found
}%
155 \if\blank{#3}\else{\label{#3}}\fi\if\blank{#2}\else{%
161 % command to display a note.
162 % Usage: \note{text of your note}
163 % Note: do NOT use \textbf or similar to emphasize text, use \emph!
165 \newcommand{\note}[1]{
166 \ifinner\else\par\noindent\fi
168 \ifinner#1\else\marginpar{\raisebox{-
6pt
}{\Huge\Writinghand}}#1\par\fi%
170 {\newcommand{\note}[1]{\ifinner\else\par\noindent\fi\textbf{Note:
{} }#1\par}}
172 % command to display a warning.
173 % Usage: \warn{text of your warning}
174 % Note: do NOT use \textbf or similar to emphasize text!
176 \newcommand{\warn}[1]{
177 \ifinner\else\par\noindent\fi
179 \ifinner#1\else\marginpar{\raisebox{-
6pt
}{\Huge\Stopsign}}#1\par\fi%
181 {\newcommand{\warn}[1]{\ifinner\else\par\noindent\fi\textbf{Warning:
{} }#1}}
183 % command to mark a text block as intended especially for blind people
184 % Usage: \blind{text}
186 \newcommand{\blind}[1]{
187 \ifinner\else\par\noindent\fi
188 \ifinner#1\else\marginpar{\raisebox{-
6pt
}{\Huge\ForwardToEnd}}#1\par\fi%
190 {\newcommand{\blind}[1]{\ifinner\else\par\noindent\fi#1}}
192 % make table floats use "H" (as for screenshots) as default positioning
193 \makeatletter\renewcommand{\fps@table
}{H
}\makeatother
194 % change defaults for floats on a page as we have a lot of small images
195 \setcounter{topnumber
}{3} % default: 2
196 \setcounter{bottomnumber
}{2} % default: 1
197 \setcounter{totalnumber
}{5} % default: 3
203 % command to set the default table heading for button lists
204 \newcommand{\taghead}{\textbf{Tag
} &
\textbf{Description
} \\
\midrule}
206 % environment intended to be used with tag maps (for wps)
207 % usage: \begin{tagmap}{caption}{label} Tag & Description \\ \end{tagmap}
208 % Note: this automatically sets the table lines.
209 % Note: you *need* to terminate the last line with a linebreak \\
210 % Note: you still need to enclose this with \begin{table} / \end{table}
211 % Cheers for the usenet helping me building this up :)
212 \newenvironment{tagmap
}[2]{%
213 \expandafter\let\expandafter\SavedEndTab\csname endtabular*
\endcsname
214 \expandafter\renewcommand\expandafter*
\csname endtabular*
\endcsname{%
217 \if\given{#1}\caption{#1}\fi%
218 \if\given{#2}\label{#2}\fi%
222 \tabularx{\textwidth}{lX
}\toprule % here is the table width defined
228 % When creating HTML, use the soul package.
229 % This produces much nicer HTML code (textsc results in each character being
230 % put in a separate <span>).
231 \ifpdfoutput{\newcommand{\caps}[1]{\textsc{#1}}}{\usepackage{soul
}}
232 \newcommand{\setting}[1]{\caps{#1}}
234 \newcommand{\config}[1]{\texttt{#1}}
236 % set link to download server
237 % Usage: \download{bootloader/bootloader-ipodnano.ipod}
239 % "http://download.rockbox.org/bootloader/bootloader-ipodnano.ipod"
240 \newcommand{\download}[1]{\url{http://download.rockbox.org/
#1}}
242 % set link to the wiki.
243 % Usage: \wikilink{WebHome}
244 % with "WebHome" being the wiki page name
245 \newcommand{\wikibaseurl}{http://www.rockbox.org/wiki/
}
246 \ifpdfoutput{\newcommand{\wikiicon}{\Pointinghand}}
247 {\newcommand{\wikiicon}{}}
248 \newcommand{\wikilink}[1]{\wikiicon{}\href{\wikibaseurl#1}{#1}}
249 %\newcommand{\wikilink}[1]{\url{http://www.rockbox.org/wiki/#1}}
251 % define environment "code" based on fancyvrb.
252 % use it to set code the user should type / see on his screen.
253 % Note: the first 4 characters of each line will be stripped,
254 % requiring everything to be indendet by exactly _4_ spaces!
255 % This is intended to make the LaTeX sources more readable.
256 % Note: when using the code environment you need to use optv instead of opt!
257 \DefineVerbatimEnvironment{code
}{Verbatim
}%
258 {framerule=
0.4pt, framesep=
1ex,frame=lines,
%numbers=left,stepnumber=5,%
259 gobble=
4,fontsize=
\footnotesize,xleftmargin=
10pt,xrightmargin=
10pt,
%
260 label=
\textnormal{\textsc{Code
}},
%
264 % define environment "example" based on fancyvrb.
265 % use it to set example code the user should type / see on his screen.
266 % Note: the first 4 characters of each line will be stripped,
267 % requiring everything to be indendet by exactly _4_ spaces!
268 % This is intended to make the LaTeX sources more readable.
269 % Note: when using the example environment you need to use optv instead of opt!
270 \DefineVerbatimEnvironment{example
}{Verbatim
}%
271 {commentchar=!,framerule=
0.4pt, framesep=
1ex,frame=lines,
%
272 gobble=
4,fontsize=
\footnotesize,xleftmargin=
10pt,xrightmargin=
10pt,
%
273 label=
\textnormal{\textsc{Example
}},
%
277 % Use the nopt command to exclude a certain defined feature from a sectio
279 % \nopt{ondio}{This text will be excluded for ondios}
280 \newcommand{\optnvalue}{0}
281 \newcommand{\nopt}[2]{%
282 \renewcommand{\optnvalue}{0}\opt{#1}{\renewcommand{\optnvalue}{1}}%
283 \ifthenelse{\optnvalue >
0}{}{#2}%
286 % Use the reference to handle get a flexible reference command
287 % usage \reference{ref_section}
289 \newcommand{\reference}[1]{%
290 section~
\ref{#1} (page~
\pageref{#1})
%
292 {\newcommand{\reference}[1]{section~
\ref{#1}}}
294 % special HTML output adjustments
295 \ifpdfoutput{}{\setlength{\parindent}{0mm
}}
296 \ifpdfoutput{}{\renewcommand{\Forward}[1]{$
\triangleright$
{}#1}}
298 \newcommand{\btnfnt}[1]{\textbf{#1}}
306 % command to set the default table heading for button lists
307 \newcommand{\btnhead}{\textbf{Key
} \opt{HAVEREMOTEKEYMAP
}{%
308 &
\textbf{Remote Key
}} &
\textbf{Action
} \\
\midrule}
309 % environment intended to be used with button maps
310 % usage: \begin{btnmap}{caption}{label} Button & ButtonAction \\ \end{btnmap}
311 % Note: this automatically sets the table lines.
312 % Note: you *need* to terminate the last line with a linebreak \\
313 % Note: you still need to enclose this with \begin{table} / \end{table}
314 % Cheers for the usenet helping me building this up :)
316 % tabularx is set to be either two or three columns wide depending on whether
317 % HAVEREMOTEKEYMAP is defined in the platform file for the target in question.
318 % If it is, then every button table has three columns of the form
319 % Main Unit Key & Remote Key & Description \\
321 \newenvironment{btnmap
}[2]{%
322 \rowcolors{1}{}{gray!
30}
323 \expandafter\let\expandafter\SavedEndTab\csname endtabular*
\endcsname
324 \expandafter\renewcommand\expandafter*
\csname endtabular*
\endcsname{%
327 \if\given{#1}\caption{#1}\fi%
328 \if\given{#2}\label{#2}\fi%
332 \opt{HAVEREMOTEKEYMAP
}{
333 % here is the table width defined for 3 columns
334 \tabularx{.95\textwidth}{>
{\raggedright\arraybackslash}p
{.2\textwidth}>
{\raggedright\arraybackslash}p
{.2\textwidth}X
}\toprule
336 \nopt{HAVEREMOTEKEYMAP
}{
337 % here is the table width defined for 2 columns
338 \tabularx{.75\textwidth}{>
{\raggedright\arraybackslash}p
{.22\textwidth}X
}\toprule