summaryrefslogtreecommitdiffstats
path: root/manual/preamble.tex
blob: d1317cd700a1822d22c30465cb6b5c574b632708 (plain)
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
\documentclass[a4paper,11pt]{scrreprt}
\usepackage[latin1]{inputenc}
\usepackage{palatino}
%\renewcommand{\familydefault}{\sfdefault}

%Comment this out at release
\usepackage{pdfdraftcopy}
\draftstring{DRAFT VERSION}
%\draftangle{45}
\usepackage{tabularx}
\usepackage{multirow}

\usepackage{float}
\floatstyle{ruled}

\usepackage[colorlinks=true, pdfstartview=FitV, linkcolor=blue, citecolor=blue, urlcolor=blue]{hyperref}
\usepackage{xspace}
\usepackage{optional}

\input{platform/\platform.tex}

\newcommand{\playername}{\playerman\ \playertype}

\newcommand{\fname}[1]{\textbf{#1}}
\newcommand{\tabeltc}[1]{{\centering #1 \par}}
\newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}

\newcommand{\fixme}[1]{\textbf{\textcolor{red}{#1}}}

\usepackage{fancyhdr}
\usepackage{graphicx}
\usepackage{verbatim}
\usepackage{lscape}
\usepackage{makeidx}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{fancyvrb}
\usepackage{enumerate}
\usepackage{subfigure}
\usepackage{color}
\usepackage{booktabs}
\usepackage{longtable}
\usepackage{url}
\urlstyle{sf}
\usepackage{marvosym}

% fancy header style adjustments
%\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
%\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
\renewcommand{\rightmark}[1]{\thechapter\ }
\fancyhead{}
\fancyfoot{}
\fancyhead[L]{{\textsc{\leftmark}}}
\fancyhead[R]{\iffloatpage{}{\thepage}}
\fancyfoot[L]{\textsc{Rockbox users manual}}
\fancyfoot[R]{\textsc{\playername}}

\renewcommand{\headrulewidth}{\iffloatpage{0pt}{0.4pt}}
\renewcommand{\footrulewidth}{\iffloatpage{0pt}{0.4pt}}
\setlength{\headheight}{18.5pt}
\newcounter{example}[chapter]

\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
} 

% add screenshot image.
% Usage: \screenshot{filename}{caption}{label}
% Note: use this only for screenshots!
% Note: leave caption empty to supress it.
\newcommand{\screenshot}[3]{
  \begin{figure}[!ht]
    \begin{center}
      \IfFileExists{#1-\genericimg.png}
        {\includegraphics[width=4cm]{#1-\genericimg.png}}
        {\IfFileExists{#1}
          {\includegraphics[width=4cm]{#1}
           \typeout{Warning: deprecated plain image name used}}%
          {\typeout{Missing image: #1 (\genericimg)}%
           \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!
\newcommand{\note}[1]{
  \ifinner\else\par\noindent\fi
  \textbf{Note:}\ %
  \ifinner#1\else\marginpar{\raisebox{-6pt}{\Huge\Writinghand}}#1\par\fi%
}

% command to display a warning.
% Usage: \warn{text of your warning}
% Note: do NOT use \textbf or similar to emphasize text!
\newcommand{\warn}[1]{
  \ifinner\else\par\noindent\fi
  \textbf{Warning:\ }%
  \ifinner#1\else\marginpar{\raisebox{-6pt}{\Huge\Stopsign}}#1\par\fi%
}

% make table floats use "!htb" as default positioning 
\makeatletter\renewcommand{\fps@table}{!htb}\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