Blame doc/Vorbis_I_spec.tex

Packit 06404a
% $Id$
Packit 06404a
\documentclass[12pt,paper=a4]{scrartcl}
Packit 06404a
Packit 06404a
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Packit 06404a
% Packages
Packit 06404a
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Packit 06404a
Packit 06404a
% ...
Packit 06404a
%\usepackage[margin=3cm]{geometry}
Packit 06404a
\usepackage{a4wide}
Packit 06404a
Packit 06404a
% ...
Packit 06404a
\usepackage[english]{babel}
Packit 06404a
Packit 06404a
%\usepackage[latin1]{inputenc}
Packit 06404a
%\usepackage[T1]{fontenc}
Packit 06404a
Packit 06404a
% Do not indent paragraphs, instead separate them via vertical spacing
Packit 06404a
\usepackage{parskip}
Packit 06404a
Packit 06404a
% Support for graphics, provides \includegraphics
Packit 06404a
\usepackage{graphicx}
Packit 06404a
%\graphicspath{{images/}}	% Specify subdir containing the images
Packit 06404a
Packit 06404a
% Hyperref enriches the generated PDF with clickable links,
Packit 06404a
% and provides many other useful features.
Packit 06404a
\usepackage{nameref}
Packit 06404a
\usepackage[colorlinks]{hyperref}
Packit 06404a
\def\sectionautorefname{Section}	% Write section with capital 'S'
Packit 06404a
\def\subsectionautorefname{Subsection}	% Write subsection with capital 'S'
Packit 06404a
Packit 06404a
Packit 06404a
% The fancyvrb package provides the "Verbatim" environment, which,
Packit 06404a
% unlike the built-in "verbatim", allows embedding TeX commands, as
Packit 06404a
% well as tons of other neat stuff (line numbers, formatting adjustments, ...)
Packit 06404a
\usepackage{fancyvrb}
Packit 06404a
\fvset{tabsize=4,fontsize=\scriptsize,numbers=left}
Packit 06404a
Packit 06404a
% Normally, one can not use the underscore character in LaTeX without
Packit 06404a
% escaping it (\_ instead of _). Since the Vorbis specs use it a lot,
Packit 06404a
% we use the underscore package to change this default behavior.
Packit 06404a
\usepackage[nohyphen]{underscore}
Packit 06404a
Packit 06404a
\usepackage{enumitem}
Packit 06404a
Packit 06404a
% In LaTeX, pictures are normally put into floating environments, and it is
Packit 06404a
% left to the typesetting engine to place them in the "optimal" spot. These
Packit 06404a
% docs however expect pictures to be placed in a *specific* position. So we
Packit 06404a
% don't use \begin{figure}...\end{figure}, but rather a center environment.
Packit 06404a
% To still be able to use captions, we use the capt-of package.
Packit 06404a
\usepackage{capt-of}
Packit 06404a
Packit 06404a
% strikeout support
Packit 06404a
\usepackage[normalem]{ulem}
Packit 06404a
Packit 06404a
% blockquote support
Packit 06404a
\usepackage{csquotes}
Packit 06404a
Packit 06404a
% allow 'special' characters in filenames, like undescore :-P
Packit 06404a
\usepackage{grffile}
Packit 06404a
Packit 06404a
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Packit 06404a
% Custom commands
Packit 06404a
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Packit 06404a
Packit 06404a
% Custom ref command, using hyperrefs autoref & nameref, to simulate the 
Packit 06404a
% behavior of DocBook's '<xref>'.
Packit 06404a
\newcommand{\xref}[1]{\autoref{#1}, ``\nameref{#1}''}
Packit 06404a
Packit 06404a
% Emulat DocBook's '<link>'.
Packit 06404a
\newcommand{\link}[2]{\hyperref[#1]{#2}}
Packit 06404a
Packit 06404a
% Simple 'Note' environment. Can be customized later on.
Packit 06404a
\newenvironment{note}{\subparagraph*{Note:}}{}
Packit 06404a
Packit 06404a
% Map DocBook's <programlisting> to fancyvrb's Verbatim environment
Packit 06404a
\let\programlisting\Verbatim
Packit 06404a
\let\endprogramlisting\endVerbatim
Packit 06404a
Packit 06404a
% Fake some more DocBook elements
Packit 06404a
\newcommand{\function}[1]{\texttt{#1}}
Packit 06404a
\newcommand{\filename}[1]{\texttt{#1}}
Packit 06404a
\newcommand{\varname}[1]{\texttt{#1}}
Packit 06404a
\newcommand{\literal}[1]{\texttt{#1}}
Packit 06404a
Packit 06404a
% Redefine \~ to generate something that looks more appropriate when used in text.
Packit 06404a
\renewcommand{\~}{$\sim$}
Packit 06404a
Packit 06404a
% Useful helper macro that inserts TODO comments very visibly into the generated
Packit 06404a
% file. Helps you to not forget to resolve those TODOs... :)
Packit 06404a
\newcommand{\TODO}[1]{\textcolor{red}{*** #1 ***}}
Packit 06404a
Packit 06404a
% Configure graphics formats: Prefer PDF, fall back to PNG or JPG, as available.
Packit 06404a
\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg}
Packit 06404a
Packit 06404a
Packit 06404a
% NOTE: Things to watch out for: Some chars are reserved in LaTeX. You need to translate them...
Packit 06404a
%   ~ -> $\sim$ (or \~ which we defined above)
Packit 06404a
%   % -> \%
Packit 06404a
%   & -> \&
Packit 06404a
%   < -> $<$
Packit 06404a
%   > -> $>$
Packit 06404a
% and others. Refer to any of the many LaTeX refs out there if in doubt!
Packit 06404a
Packit 06404a
\begin{document}
Packit 06404a
Packit 06404a
Packit 06404a
\title{Vorbis I specification}
Packit 06404a
\author{Xiph.Org Foundation}
Packit 06404a
\maketitle
Packit 06404a
Packit 06404a
\tableofcontents
Packit 06404a
Packit 06404a
\include{01-introduction}
Packit 06404a
\include{02-bitpacking}
Packit 06404a
\include{03-codebook}
Packit 06404a
\include{04-codec}
Packit 06404a
\include{05-comment}
Packit 06404a
\include{06-floor0}
Packit 06404a
\include{07-floor1}
Packit 06404a
\include{08-residue}
Packit 06404a
\include{09-helper}
Packit 06404a
\include{10-tables}
Packit 06404a
Packit 06404a
\appendix
Packit 06404a
\include{a1-encapsulation-ogg}
Packit 06404a
\include{a2-encapsulation-rtp}
Packit 06404a
Packit 06404a
\include{footer}
Packit 06404a
Packit 06404a
 
Packit 06404a
% TODO: Use a bibliography, as in the example below?
Packit 06404a
\begin{thebibliography}{99} 
Packit 06404a
 
Packit 06404a
\bibitem{Sporer/Brandenburg/Edler} T.~Sporer, K.~Brandenburg and B.~Edler, 
Packit 06404a
The use of multirate filter banks for coding of high quality digital audio,
Packit 06404a
\url{http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps}.
Packit 06404a
Packit 06404a
Packit 06404a
\end{thebibliography}
Packit 06404a
Packit 06404a
\end{document}