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