cannam@86
|
1 % $Id$
|
cannam@86
|
2 \documentclass[12pt,paper=a4]{scrartcl}
|
cannam@86
|
3
|
cannam@86
|
4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
cannam@86
|
5 % Packages
|
cannam@86
|
6 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
cannam@86
|
7
|
cannam@86
|
8 % ...
|
cannam@86
|
9 %\usepackage[margin=3cm]{geometry}
|
cannam@86
|
10 \usepackage{a4wide}
|
cannam@86
|
11
|
cannam@86
|
12 % ...
|
cannam@86
|
13 \usepackage[english]{babel}
|
cannam@86
|
14
|
cannam@86
|
15 %\usepackage[latin1]{inputenc}
|
cannam@86
|
16 %\usepackage[T1]{fontenc}
|
cannam@86
|
17
|
cannam@86
|
18 % Do not indent paragraphs, instead separate them via vertical spacing
|
cannam@86
|
19 \usepackage{parskip}
|
cannam@86
|
20
|
cannam@86
|
21 % Support for graphics, provides \includegraphics
|
cannam@86
|
22 \usepackage{graphicx}
|
cannam@86
|
23 %\graphicspath{{images/}} % Specify subdir containing the images
|
cannam@86
|
24
|
cannam@86
|
25 % Hyperref enriches the generated PDF with clickable links,
|
cannam@86
|
26 % and provides many other useful features.
|
cannam@86
|
27 \usepackage{nameref}
|
cannam@86
|
28 \usepackage[colorlinks]{hyperref}
|
cannam@86
|
29 \def\sectionautorefname{Section} % Write section with capital 'S'
|
cannam@86
|
30 \def\subsectionautorefname{Subsection} % Write subsection with capital 'S'
|
cannam@86
|
31
|
cannam@86
|
32
|
cannam@86
|
33 % The fancyvrb package provides the "Verbatim" environment, which,
|
cannam@86
|
34 % unlike the built-in "verbatim", allows embedding TeX commands, as
|
cannam@86
|
35 % well as tons of other neat stuff (line numbers, formatting adjustments, ...)
|
cannam@86
|
36 \usepackage{fancyvrb}
|
cannam@86
|
37 \fvset{tabsize=4,fontsize=\scriptsize,numbers=left}
|
cannam@86
|
38
|
cannam@86
|
39 % Normally, one can not use the underscore character in LaTeX without
|
cannam@86
|
40 % escaping it (\_ instead of _). Since the Vorbis specs use it a lot,
|
cannam@86
|
41 % we use the underscore package to change this default behavior.
|
cannam@86
|
42 \usepackage[nohyphen]{underscore}
|
cannam@86
|
43
|
cannam@86
|
44 \usepackage{enumitem}
|
cannam@86
|
45
|
cannam@86
|
46 % In LaTeX, pictures are normally put into floating environments, and it is
|
cannam@86
|
47 % left to the typesetting engine to place them in the "optimal" spot. These
|
cannam@86
|
48 % docs however expect pictures to be placed in a *specific* position. So we
|
cannam@86
|
49 % don't use \begin{figure}...\end{figure}, but rather a center environment.
|
cannam@86
|
50 % To still be able to use captions, we use the capt-of package.
|
cannam@86
|
51 \usepackage{capt-of}
|
cannam@86
|
52
|
cannam@86
|
53
|
cannam@86
|
54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
cannam@86
|
55 % Custom commands
|
cannam@86
|
56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
cannam@86
|
57
|
cannam@86
|
58 % Custom ref command, using hyperrefs autoref & nameref, to simulate the
|
cannam@86
|
59 % behavior of DocBook's '<xref>'.
|
cannam@86
|
60 \newcommand{\xref}[1]{\autoref{#1}, ``\nameref{#1}''}
|
cannam@86
|
61
|
cannam@86
|
62 % Emulat DocBook's '<link>'.
|
cannam@86
|
63 \newcommand{\link}[2]{\hyperref[#1]{#2}}
|
cannam@86
|
64
|
cannam@86
|
65 % Simple 'Note' environment. Can be customized later on.
|
cannam@86
|
66 \newenvironment{note}{\subparagraph*{Note:}}{}
|
cannam@86
|
67
|
cannam@86
|
68 % Map DocBook's <programlisting> to fancyvrb's Verbatim environment
|
cannam@86
|
69 \let\programlisting\Verbatim
|
cannam@86
|
70 \let\endprogramlisting\endVerbatim
|
cannam@86
|
71
|
cannam@86
|
72 % Fake some more DocBook elements
|
cannam@86
|
73 \newcommand{\function}[1]{\texttt{#1}}
|
cannam@86
|
74 \newcommand{\filename}[1]{\texttt{#1}}
|
cannam@86
|
75 \newcommand{\varname}[1]{\texttt{#1}}
|
cannam@86
|
76 \newcommand{\literal}[1]{\texttt{#1}}
|
cannam@86
|
77
|
cannam@86
|
78 % Redefine \~ to generate something that looks more appropriate when used in text.
|
cannam@86
|
79 \renewcommand{\~}{$\sim$}
|
cannam@86
|
80
|
cannam@86
|
81 % Useful helper macro that inserts TODO comments very visibly into the generated
|
cannam@86
|
82 % file. Helps you to not forget to resolve those TODOs... :)
|
cannam@86
|
83 \newcommand{\TODO}[1]{\textcolor{red}{*** #1 ***}}
|
cannam@86
|
84
|
cannam@86
|
85 % Configure graphics formats: Prefer PDF, fall back to PNG or JPG, as available.
|
cannam@86
|
86 \DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg}
|
cannam@86
|
87
|
cannam@86
|
88
|
cannam@86
|
89 % NOTE: Things to watch out for: Some chars are reserved in LaTeX. You need to translate them...
|
cannam@86
|
90 % ~ -> $\sim$ (or \~ which we defined above)
|
cannam@86
|
91 % % -> \%
|
cannam@86
|
92 % & -> \&
|
cannam@86
|
93 % < -> $<$
|
cannam@86
|
94 % > -> $>$
|
cannam@86
|
95 % and others. Refer to any of the many LaTeX refs out there if in doubt!
|
cannam@86
|
96
|
cannam@86
|
97 \begin{document}
|
cannam@86
|
98
|
cannam@86
|
99
|
cannam@86
|
100 \title{Vorbis I specification}
|
cannam@86
|
101 \author{Xiph.Org Foundation}
|
cannam@86
|
102 \maketitle
|
cannam@86
|
103
|
cannam@86
|
104 \tableofcontents
|
cannam@86
|
105
|
cannam@86
|
106 \include{01-introduction}
|
cannam@86
|
107 \include{02-bitpacking}
|
cannam@86
|
108 \include{03-codebook}
|
cannam@86
|
109 \include{04-codec}
|
cannam@86
|
110 \include{05-comment}
|
cannam@86
|
111 \include{06-floor0}
|
cannam@86
|
112 \include{07-floor1}
|
cannam@86
|
113 \include{08-residue}
|
cannam@86
|
114 \include{09-helper}
|
cannam@86
|
115 \include{10-tables}
|
cannam@86
|
116
|
cannam@86
|
117 \appendix
|
cannam@86
|
118 \include{a1-encapsulation-ogg}
|
cannam@86
|
119 \include{a2-encapsulation-rtp}
|
cannam@86
|
120
|
cannam@86
|
121 \include{footer}
|
cannam@86
|
122
|
cannam@86
|
123
|
cannam@86
|
124 % TODO: Use a bibliography, as in the example below?
|
cannam@86
|
125 \begin{thebibliography}{99}
|
cannam@86
|
126
|
cannam@86
|
127 \bibitem{Sporer/Brandenburg/Edler} T.~Sporer, K.~Brandenburg and B.~Edler,
|
cannam@86
|
128 The use of multirate filter banks for coding of high quality digital audio,
|
cannam@86
|
129 \url{http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps}.
|
cannam@86
|
130
|
cannam@86
|
131
|
cannam@86
|
132 \end{thebibliography}
|
cannam@86
|
133
|
cannam@86
|
134 \end{document}
|