1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% __________ __ ___.
% Open \______ \ ____ ____ | | _\_ |__ _______ ___
% Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
% Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
% Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
% \/ \/ \/ \/ \/
% - M A N U A L -
%
% $Id$
%
% Copyright (C) 2006 The Rockbox Manual Team
%
% All files in this archive are subject to the GNU Free Documentation License
% See the file COPYING-MANUAL in the source tree docs/ directory for full license
% agreement.
%
% Contributors are listed in the file docs/CREDITS-MANUAL
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentclass[a4paper,11pt,hyphens]{scrreprt}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
% load ix-utf8enc.dfu to get additional characters from the inputenx package.
\makeatletter\input{ix-utf8enc.dfu}\makeatother
% This manual used to use Palatino as font. This caused issues with small caps
% (textsc), so do not use that font as default one anymore.
% Use Latin Modern instead which improves searchability of the PDF output.
\usepackage{lmodern}
\usepackage{tabularx}
\usepackage{multirow}
\usepackage{multicol}
\usepackage{scrhack}
\usepackage{float}
\floatstyle{ruled}
\usepackage{hyperref}
\usepackage{enumitem}
\usepackage{optional}
\usepackage[table]{xcolor}
\input{platform/\platform.tex}
\input{features.tex}
\newcommand{\playername}{\playerman\ \playerlongtype}
\hypersetup{% add some values to the pdf properties
colorlinks = true,
pdfstartview = FitV,
linkcolor = blue,
citecolor = blue,
urlcolor = blue,
pdftitle = {Rockbox user manual},
pdfauthor = {The Rockbox Team},
pdfsubject = {Rockbox user manual for \playername}
}
\newcommand{\fname}[1]{\texttt{#1}}
\newcommand{\tabeltc}[1]{{\centering #1 \par}}
\newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}
\newcommand{\fixme}[1]{\textbf{\textcolor{red}{#1}}}
% Colors used to typeset table headers and alternating table rows
\colorlet{tblhdrbgcolor}{blue!30} % Background color for headers
\colorlet{tbloddrowbgcolor}{blue!10} % Background color for odd rows (headers not included)
\colorlet{tblevenrowbgcolor}{white} % Background color for even rows (headers not included)
\usepackage{fancyhdr}
\usepackage{graphicx}
\usepackage{verbatim}
\usepackage{makeidx}
\usepackage{fancyvrb}
\usepackage{color}
% Ifpdfoutput is part of KOMAscript 3.28, in earlier versions it's ifpdfoutput.
% We use Ifpdfoutput, so redefine it here for old KOMAscript versions.
% See also https://ctan.org/ctan-ann/id/mailman.2801.1577740444.2586.ctan-ann@ctan.org
\ifdefined\Ifpdfoutput%
\else\newcommand{\Ifpdfoutput}{\ifpdfoutput}%
\fi
\Ifpdfoutput{\usepackage{booktabs}}%
{\newcommand{%
\toprule}{}\newcommand{\midrule}{\hline}\newcommand{\bottomrule}{}%
}
\usepackage{longtable}
\usepackage{url}
\urlstyle{sf}
\Urlmuskip = 0mu plus 1mu
\usepackage{marvosym}
\usepackage{rotating}
% pdf output: try pdf first, then png and jpg as file format
% html output: try png first, then jpg. Ignore pdf files
% this only applies if no file extension is given!
\Ifpdfoutput{\DeclareGraphicsExtensions{.pdf,.png,.jpg}}%
{\DeclareGraphicsExtensions{.png,.jpg}}
% fancy header style adjustments
\fancyhead{}
\fancyfoot{}
\fancyhead[L]{{\nouppercase{\textsc{\leftmark}}}}
\fancyhead[R]{\iffloatpage{}{\thepage}}
\fancyfoot[L]{\textsc{The Rockbox manual} {\scriptsize(version \buildversion)}}
\fancyfoot[R]{\textsc{\playerman{} \playertype}}
\fancypagestyle{plain}{}
\renewcommand{\headrulewidth}{\iffloatpage{0pt}{0.4pt}}
\renewcommand{\footrulewidth}{\iffloatpage{0pt}{0.4pt}}
\setlength{\headheight}{18.5pt}
\newcounter{example}[chapter]
\Ifpdfoutput{%
\renewcommand{\toprule}{\specialrule{\heavyrulewidth}{\abovetopsep}{0pt}}
\renewcommand{\midrule}{\specialrule{\lightrulewidth}{0pt}{\belowrulesep}}
}{}
\newcommand{\tblhdrstrut}{\rule[-1.3ex]{0mm}{4.0ex}}
%% \newenvironment{example}
%% {\stepcounter{example}\paragraph{Example \theexample:}}
%% {\hfill$\Box$
%% \bigskip
%% \noindent}
% found on the internet, posting by Donald Arseneau
% I may as well include my robust expandable definions, which can be
% used in \edef or \write where the \def would not be executed:
%
% \if\blank --- checks if parameter is blank (Spaces count as blank)
% \if\given --- checks if parameter is not blank: like \if\blank{#1}\else
% \if\nil --- checks if parameter is null (spaces are NOT null)
% use \if\given{ } ... \else ... \fi etc.
%
{\catcode`\!=8 % funny catcode so ! will be a delimiter
\catcode`\Q=3 % funny catcode so Q will be a delimiter
\long\gdef\given#1{88\fi\Ifbl@nk#1QQQ\empty!}
\long\gdef\blank#1{88\fi\Ifbl@nk#1QQ..!}% if null or spaces
\long\gdef\nil#1{\IfN@Ught#1* {#1}!}% if null
\long\gdef\IfN@Ught#1 #2!{\blank{#2}}
\long\gdef\Ifbl@nk#1#2Q#3!{\ifx#3}% same as above
}
% environment for setting the changelog.
\newenvironment{changelog}%
{\renewcommand{\labelitemi}{$\star$}\setitemize{noitemsep,topsep=0pt}%
\begin{itemize}}%
{\end{itemize}}
\newcommand{\dapdisplaysize}{\dapdisplaywidth$\times$\dapdisplayheight$\times$\dapdisplaydepth}
\newcommand{\genericimg}{\dapdisplaywidth x\dapdisplayheight x\dapdisplaydepth}
% add screenshot image.
% Usage: \screenshot{filename}{caption}{label}
% By using the 'H' (HERE) placement, the screenshots are placed where
% we want them.
% Note: use this only for screenshots!
% Note: leave caption empty to supress it.
% Resulting file names in the source should consist of up to 3 parts
% "filename-\genericimg-[\specimg|\seriesimg]" (the third is optional)
% filename is specified by the use of this macro in the tex file
% \genericimg will be generated using the display's resolution (see above)
% \specimg or \seriesimg are possible options set in the platform files
% Files will be used in the following order: 1.filename contains \specimg part
% 2. filename contains \seriesimg part, 3. filename without the third part
% set seriesimg if it isn't defined in the platform file to not break manuals
\ifdefined\seriesimg
\else
\newcommand{\seriesimg}{\specimg}
\fi
\newcommand{\includescreenshot}{\Ifpdfoutput{\includegraphics[width=\screenshotsize]}{\includegraphics}}
\newcommand{\screenshot}[3]{
\begin{figure}[H]
\begin{center}
\IfFileExists{#1-\genericimg-\specimg.png}
{\includescreenshot{#1-\genericimg-\specimg.png}
\typeout{Note: device specific image used}}
{\IfFileExists{#1-\genericimg-\seriesimg.png}
{\includescreenshot{#1-\genericimg-\seriesimg.png}
\typeout{Note: series specific image used}}
{\IfFileExists{#1-\genericimg.png}
{\includescreenshot{#1-\genericimg.png}}
{\IfFileExists{#1}
{\includescreenshot{#1}
\typeout{Warning: deprecated plain image name used}}%
{\typeout{Missing image: #1 (\genericimg) (\specimg)}%
\color{red}{\textbf{WARNING!} Image not found}%
}
}
}
}
\if\blank{#3}\else{\label{#3}}\fi\if\blank{#2}\else{%
\caption{#2}}\fi
\end{center}
\end{figure}
}
% command to display a note.
% Usage: \note{text of your note}
% Note: do NOT use \textbf or similar to emphasize text, use \emph!
\Ifpdfoutput{
\newcommand{\note}[1]{
\ifinner\else\vspace{1ex}\par\noindent\fi
\textbf{Note:}\ %
\ifinner#1\else\marginpar{\raisebox{-6pt}{\Huge\Writinghand}}#1\par\vspace{1ex}\fi%
}}
{\newcommand{\note}[1]{\ifinner\else\par\noindent\fi\textbf{Note:{} }#1\par}}
% command to display a warning.
% Usage: \warn{text of your warning}
% Note: do NOT use \textbf or similar to emphasize text!
\Ifpdfoutput{
\newcommand{\warn}[1]{
\ifinner\else\par\noindent\fi
\textbf{Warning:\ }%
\ifinner#1\else\marginpar{\raisebox{-6pt}{\Huge\Stopsign}}#1\par\fi%
}}
{\newcommand{\warn}[1]{\ifinner\else\par\noindent\fi\textbf{Warning:{} }#1}}
% command to mark a text block as intended especially for blind people
% Usage: \blind{text}
\Ifpdfoutput{
\newcommand{\blind}[1]{\mbox{}\marginpar{\raisebox{-1ex}{\Huge{\ForwardToEnd}}}#1}
}
{\newcommand{\blind}[1]{\ifinner\else\par\noindent\fi#1}}
% make table floats use "H" (as for screenshots) as default positioning
\makeatletter\renewcommand{\fps@table}{H}\makeatother
% change defaults for floats on a page as we have a lot of small images
\setcounter{topnumber}{3} % default: 2
\setcounter{bottomnumber}{2} % default: 1
\setcounter{totalnumber}{5} % default: 3
% Environment for typesetting tables in a consistent way. The header has
% a darker background; rows are white and light gray (alternating). Top,
% middle and bottom rules are automatically set.
%
% Params:
% #1 -- table width
% #2 -- column specification (as used in the package tabularx)
% #3 -- contents of the header row. The number of items must
% match the number of specs in #2
% #4 -- caption (optional). If used then this must be inside a floating
% environment, e.g. table
% #5 -- label (optional)
%
% Example:
% \begin{rbtabular}{0.9\textwidth}{lX}{Col1 & Col2}{}{}
% A1 & A2\\
% B1 & B2\\
% C1 & C2\\
% \end{rbtabular}
%
\newenvironment{rbtabular}[5]{%
\rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor}
\expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname
\expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{%
\bottomrule
\SavedEndTab%
\if\given{#4}\caption{#4}\fi%
\if\given{#5}\label{#5}\fi%
\endcenter%
}
\center
\tabularx{#1}{#2}\toprule\rowcolor{tblhdrbgcolor}
\tblhdrstrut#3\\\midrule
}{%
\endtabularx
}
\newcommand{\tabnlindent}{\newline\mbox{ }\mbox{ }}
% command to set the default table heading for button lists
\newcommand{\taghead}{\tblhdrstrut\textbf{Tag} & \textbf{Description} \\\midrule}
% environment intended to be used with tag maps (for wps)
% usage: \begin{tagmap}{caption}{label} Tag & Description \\ \end{tagmap}
% Note: this automatically sets the table lines.
% Note: you *need* to terminate the last line with a linebreak \\
% Cheers for the usenet helping me building this up :)
\newenvironment{tagmap}{%
\rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor}
\expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname
\expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{%
\bottomrule
\SavedEndTab%
\endcenter%
}
\center
\tabularx{\textwidth}{Xp{.7\textwidth}}\toprule\rowcolor{tblhdrbgcolor} % here is the table width defined
\taghead
}{%
\endtabularx
}
% When creating HTML, use the soul package.
% This produces much nicer HTML code (textsc results in each character being
% put in a separate <span>).
\Ifpdfoutput{\newcommand{\caps}[1]{\textsc{#1}}}{\usepackage{soul}}
\newcommand{\setting}[1]{\caps{#1}}
\newcommand{\config}[1]{\texttt{#1}}
% set link to download server
% Usage: \download{bootloader/bootloader-ipodnano.ipod}
% gets expanded to
% "https://download.rockbox.org/bootloader/bootloader-ipodnano.ipod"
\newcommand{\download}[1]{\url{https://download.rockbox.org/#1}}
% set link to the wiki.
% Usage: \wikilink{WebHome}
% with "WebHome" being the wiki page name
\newcommand{\wikibaseurl}{https://www.rockbox.org/wiki/}
\Ifpdfoutput{\newcommand{\wikiicon}{\Pointinghand}}
{\newcommand{\wikiicon}{}}
\newcommand{\wikilink}[1]{\wikiicon{}\href{\wikibaseurl#1}{#1}}
%\newcommand{\wikilink}[1]{\url{https://www.rockbox.org/wiki/#1}}
% define environment "code" based on fancyvrb.
% use it to set 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 code environment you need to use optv instead of opt!
\DefineVerbatimEnvironment{code}{Verbatim}%
{framerule=0.4pt, framesep=1ex,frame=lines,%numbers=left,stepnumber=5,%
gobble=4,fontsize=\footnotesize,xleftmargin=10pt,xrightmargin=10pt,%
label=\textnormal{\textsc{Code}},%
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,%
gobble=4,fontsize=\footnotesize,xleftmargin=10pt,xrightmargin=10pt,%
label=\textnormal{\textsc{Example}},%
commandchars=\\\{\}%
}
% Use the nopt command to exclude a certain defined feature from a section
% Example:
% \nopt{ondio}{This text will be excluded for ondios}
\makeatletter
\newcommand*\nopt[1]{\if\Opl@notlisted{#1}\expandafter\@firstofone
\else \expandafter\@gobble \fi}
\makeatother
% Use the reference to handle get a flexible reference command
% usage \reference{ref_section}
\Ifpdfoutput{%
\newcommand{\reference}[1]{%
section~\ref{#1} (page~\pageref{#1})%
}}
{\newcommand{\reference}[1]{section~\ref{#1}}}
% special HTML output adjustments
\Ifpdfoutput{}{\setlength{\parindent}{0mm}}
\Ifpdfoutput{}{\renewcommand{\Forward}[1]{$\triangleright${}#1}}
\newcommand{\btnfnt}[1]{\textbf{#1}}
%\hfuzz=2pt
% generate index
\usepackage{makeidx}
\makeindex
% command to set the default table heading for button lists
\newcommand{\btnhead}{\textbf{Key} \opt{HAVEREMOTEKEYMAP}{%
& \textbf{Remote Key}} & \textbf{Action} \\\midrule}
% environment intended to be used with button maps
% usage: \begin{btnmap} Button & ButtonAction \\ \end{btnmap}
% Note: this automatically sets the table lines.
% Note: you *need* to terminate the last line with a linebreak \\
% Cheers for the usenet helping me building this up :)
% tabularx is set to be either two or three columns wide depending on whether
% HAVEREMOTEKEYMAP is defined in the platform file for the target in question.
% If it is, then every button table has three columns of the form
% Main Unit Key & Remote Key & Description \\
\newenvironment{btnmap}{%
\rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor}
\expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname
\expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{%
\bottomrule
\SavedEndTab%
\endcenter\vspace{2ex}%
}
\vspace{2ex}\center
\opt{HAVEREMOTEKEYMAP}{
% here is the table width defined for 3 columns
\tabularx{.95\textwidth}{>{\raggedright\arraybackslash}p{.2\textwidth}>{\raggedright\arraybackslash}p{.2\textwidth}X}\toprule\rowcolor{tblhdrbgcolor}
}
\nopt{HAVEREMOTEKEYMAP}{
% here is the table width defined for 2 columns
\tabularx{.75\textwidth}{>{\raggedright\arraybackslash}p{.22\textwidth}X}\toprule\rowcolor{tblhdrbgcolor}
}
\tblhdrstrut\btnhead
}{%
\endtabularx
}
|