blob: d26e732a3ceb6fe422972603bd76c6114f84ea27 [file] [log] [blame]
Martin Arver3622c932006-03-29 18:48:52 +00001\documentclass[a4paper,11pt]{scrreprt}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +00002\usepackage[latin1]{inputenc}
Martin Arver8bedb5c2006-03-22 23:26:30 +00003\usepackage{palatino}
Martin Arver35dcf902006-03-08 17:58:11 +00004%\renewcommand{\familydefault}{\sfdefault}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +00005
Martin Arver0da41d82006-03-24 11:53:07 +00006%Comment this out at release
Martin Arvere6f31912006-03-24 17:19:32 +00007\usepackage{pdfdraftcopy}
8\draftstring{DRAFT VERSION}
Martin Arver0da41d82006-03-24 11:53:07 +00009%\draftangle{45}
Martin Arverec60a052006-03-29 18:40:42 +000010\usepackage{tabularx}
Nils Wallméniusc687b302006-04-02 13:50:01 +000011\usepackage{multirow}
Martin Arver0da41d82006-03-24 11:53:07 +000012
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000013\usepackage{float}
14\floatstyle{ruled}
15
Linus Nielsen Feltzing2740dc52006-03-14 09:52:20 +000016\usepackage[colorlinks=true, pdfstartview=FitV, linkcolor=blue, citecolor=blue, urlcolor=blue]{hyperref}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000017\usepackage{xspace}
18\usepackage{optional}
19
20\input{platform/\platform.tex}
21
Martin Arver63c8bb22006-03-21 10:28:35 +000022\newcommand{\playername}{\playerman\ \playertype}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000023
24\newcommand{\fname}[1]{\textbf{#1}}
25\newcommand{\tabeltc}[1]{{\centering #1 \par}}
26\newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}
27
Martin Arvera0cdee02006-03-31 12:25:22 +000028\newcommand{\fixme}[1]{\textbf{\textcolor{red}{#1}}}
29
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000030\usepackage{fancyhdr}
31\usepackage{graphicx}
32\usepackage{verbatim}
33\usepackage{lscape}
34\usepackage{makeidx}
35\usepackage{amsmath}
36\usepackage{amssymb}
37\usepackage{fancyvrb}
38\usepackage{enumerate}
39\usepackage{subfigure}
40\usepackage{color}
Martin Arvera245e882006-03-08 15:04:36 +000041\usepackage{booktabs}
Martin Arverd3d3e342006-03-15 10:56:14 +000042\usepackage{longtable}
Martin Arver7d6810c2006-03-31 11:50:33 +000043\usepackage{url}
44\urlstyle{sf}
Martin Arver9be37f32006-03-31 13:29:27 +000045\usepackage{marvosym}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000046
Martin Arver6d5d7342006-03-30 22:03:46 +000047% fancy header style adjustments
48%\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
49%\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
50\renewcommand{\rightmark}[1]{\thechapter\ }
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000051\fancyhead{}
52\fancyfoot{}
Martin Arver6d5d7342006-03-30 22:03:46 +000053\fancyhead[L]{{\textsc{\leftmark}}}
54\fancyhead[R]{\iffloatpage{}{\thepage}}
55\fancyfoot[L]{\textsc{Rockbox users manual}}
56\fancyfoot[R]{\textsc{\playername}}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000057
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000058\renewcommand{\headrulewidth}{\iffloatpage{0pt}{0.4pt}}
59\renewcommand{\footrulewidth}{\iffloatpage{0pt}{0.4pt}}
60\setlength{\headheight}{18.5pt}
61\newcounter{example}[chapter]
Martin Arver0da41d82006-03-24 11:53:07 +000062
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000063\newenvironment{example}
64 {\stepcounter{example}\paragraph{Example \theexample:}}
65 {\hfill$\Box$
66
67 \bigskip
68 \noindent}
Martin Arver0da41d82006-03-24 11:53:07 +000069
Martin Arvercbc55992006-03-30 15:54:47 +000070% found on the internet, posting by Donald Arseneau
71% I may as well include my robust expandable definions, which can be
72% used in \edef or \write where the \def would not be executed:
73%
74% \if\blank --- checks if parameter is blank (Spaces count as blank)
75% \if\given --- checks if parameter is not blank: like \if\blank{#1}\else
76% \if\nil --- checks if parameter is null (spaces are NOT null)
77% use \if\given{ } ... \else ... \fi etc.
78%
79{\catcode`\!=8 % funny catcode so ! will be a delimiter
80\catcode`\Q=3 % funny catcode so Q will be a delimiter
81\long\gdef\given#1{88\fi\Ifbl@nk#1QQQ\empty!}
82\long\gdef\blank#1{88\fi\Ifbl@nk#1QQ..!}% if null or spaces
83\long\gdef\nil#1{\IfN@Ught#1* {#1}!}% if null
84\long\gdef\IfN@Ught#1 #2!{\blank{#2}}
85\long\gdef\Ifbl@nk#1#2Q#3!{\ifx#3}% same as above
86}
87
88% add screenshot image.
89% Usage: \screenshot{filename}{caption}{label}
90% Note: use this only for screenshots!
91% Note: leave caption empty to supress it.
92\newcommand{\screenshot}[3]{
93 \begin{figure}[!ht]
94 \begin{center}
Dominik Riebelinge5a2b692006-04-01 19:16:12 +000095 \IfFileExists{#1}{\includegraphics[width=4cm]{#1}}{%
96 \typeout{Missing image: #1}%
97 \color{red}{\textbf{WARNING!} Image not found}}%
98 \if\blank{#3}\else{\label{#3}}\fi\if\blank{#2}\else{%
Martin Arvercbc55992006-03-30 15:54:47 +000099 \caption{#2}}\fi
100 \end{center}
101 \end{figure}
102}
Martin Arver0da41d82006-03-24 11:53:07 +0000103
Martin Arver9be37f32006-03-31 13:29:27 +0000104% command to display a note.
105% Usage: \note{text of your note}
106% Note: do NOT use \textbf or similar to emphasize text, use \emph!
107\newcommand{\note}[1]{
Dominik Riebelingdf91a9b2006-04-01 15:35:30 +0000108 \ifinner\else\par\noindent\fi
109 \textbf{Note:}\ %
110 \ifinner#1\else\marginpar{\raisebox{-6pt}{\Huge\Writinghand}}#1\par\fi%
Martin Arver9be37f32006-03-31 13:29:27 +0000111}
112
113% command to display a warning.
114% Usage: \warn{text of your warning}
115% Note: do NOT use \textbf or similar to emphasize text!
116\newcommand{\warn}[1]{
Dominik Riebelingdf91a9b2006-04-01 15:35:30 +0000117 \ifinner\else\par\noindent\fi
118 \textbf{Warning:\ }%
119 \ifinner#1\else\marginpar{\raisebox{-6pt}{\Huge\Stopsign}}#1\par\fi%
120}
121