doc/Vorbis_I_spec.tex

   1 % $Id$
   2 % latex2html -show_section_numbers -split 0 -html_version 4.0 Vorbis_I_spec.tex
   3 %\documentclass[a4paper]{article}
   4 \documentclass[a4paper]{scrartcl}
   5 %\documentclass[twoside,idxtotoc,bibtotoc,a4paper,12pt,BCOR12mm,DIV13]{scrbook}
   6
   7 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   8 % Packages
   9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  10
  11 % ...
  12 %\usepackage[margin=3cm]{geometry}
  13 \usepackage{a4wide}
  14
  15 % ...
  16 \usepackage{enumitem}
  17
  18 % ...
  19 \usepackage[english]{babel}
  20
  21 %\usepackage[latin1]{inputenc}
  22 %\usepackage[T1]{fontenc}
  23
  24 % Do not indent paragraphs, instead separate them via vertical spacing
  25 \usepackage{parskip}
  26
  27 % Support for graphics, provides \includegraphics
  28 \usepackage{graphicx}
  29 %\graphicspath{{images/}}       % Specify subdir containing the images
  30
  31 % Hyperref enriches the generated PDF with clickable links,
  32 % and provides many other useful features.
  33 \usepackage{nameref}
  34 %\usepackage{hyperref}
  35 \usepackage[colorlinks]{hyperref}
  36 %\usepackage[pdfborder={0 0 0}]{hyperref}
  37 \def\sectionautorefname{Section}        % Write section with capital 'S'
  38 \def\subsectionautorefname{Subsection}  % Write subsection with capital 'S'
  39
  40
  41 % provides the 'comment' env, which is useful to temporarily comment out a block of code
  42 \usepackage{verbatim}
  43
  44 % ...
  45 %\usepackage{listings}
  46 %\lstset{language=Pascal}
  47
  48 % The fancyvrb package provides the "Verbatim" environment, which,
  49 % unlike the built-in "verbatim", allows embedding TeX commands, as
  50 % well as tons of other neat stuff (line numbers, formatting adjustments, ...)
  51 \usepackage{fancyvrb}
  52 %\fvset{tabsize=4,fontsize=\scriptsize,numbers=left}
  53 \fvset{tabsize=4,fontsize=\small}
  54 %\fvset{tabsize=4}
  55
  56 % ...
  57 \usepackage{color}      % Colored text, used for \TODO macro
  58
  59 % ...
  60 \usepackage[nohyphen]{underscore}
  61
  62 % ...
  63 \usepackage{capt-of}
  64
  65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  66 % Custom commands
  67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  68
  69 % Custom ref command, using hyperrefs autoref & nameref, to simulate the
  70 % behavior of DocBooks's 'xref'.
  71 \newcommand{\xref}[1]{\autoref{#1}, ``\nameref{#1}''}
  72
  73 %...
  74 \newcommand{\link}[2]{\hyperref[#1]{#2}}
  75
  76 % Redefine \~ to generate something that looks more appropriate when used in text.
  77 \renewcommand{\~}{$\sim$}
  78
  79 % ...
  80 \newenvironment{note}{\subparagraph*{Note:}}{}
  81
  82 % ...
  83 \let\programlisting\Verbatim
  84 \let\endprogramlisting\endVerbatim
  85
  86 % ...
  87 \newcommand{\function}[1]{\texttt{#1}}
  88 \newcommand{\filename}[1]{\texttt{#1}}
  89 \newcommand{\varname}[1]{\texttt{#1}}
  90 \newcommand{\literal}[1]{\texttt{#1}}
  91
  92 % ...
  93 \newcommand{\TODO}[1]{\textcolor{red}{*** #1 ***}}
  94 \newcommand{\NOTE}[1]{\textcolor{blue}{*** #1 ***}}
  95
  96 \DeclareGraphicsExtensions{.pdf,.png}
  97
  98
  99 % TODO/FIXME: Things to watch out for:
 100 % - Translate some chars: ~ -> $\sim$,  % -> \%, & -> \&, ...
 101
 102 \begin{document}
 103
 104
 105 \title{Vorbis I specification}
 106 \author{Xiph.org Foundation}
 107 \maketitle
 108
 109 \tableofcontents
 110
 111 \include{01-introduction}
 112 \include{02-bitpacking}
 113 \include{03-codebook}
 114 \include{04-codec}
 115 \include{05-comment}
 116 \include{06-floor0}
 117 \include{07-floor1}
 118 \include{08-residue}
 119 \include{09-helper}
 120 \include{10-tables}
 121
 122 \appendix
 123 \include{a1-encapsulation-ogg}
 124 \include{a2-encapsulation-rtp}
 125
 126 \include{footer}
 127
 128
 129 % TODO: Use a bibliography, as in the example below?
 130 \begin{thebibliography}{99}
 131
 132 \bibitem{Sporer/Brandenburg/Edler} T.~Sporer, K.~Brandenburg and B.~Edler,
 133 The use of multirate filter banks for coding of high quality digital audio,
 134 \url{http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps}.
 135
 136
 137 \end{thebibliography}
 138
 139 \end{document}