| 1 |
|
| 2 |
% birddoc to LaTeX replacement file |
| 3 |
|
| 4 |
% The \relax is there to avoid sgml2latex rewriting the class |
| 5 |
<book> + "\\relax\\documentclass\[a4paper,10pt,openany,oneside\]{book}\n" |
| 6 |
"\\def\\stabledate#1{\\date{}\\pdfinfo{/CreationDate (#1) /ModDate (#1)}}\n" |
| 7 |
"\\pdfsuppressptexinfo=-1" |
| 8 |
"\\usepackage\[colorlinks=true,linkcolor=blue,pdftitle={BIRD User's Guide}\]{hyperref}\n" |
| 9 |
"\\usepackage{enumitem}\n" |
| 10 |
"\\usepackage{birddoc}\n" |
| 11 |
"\\usepackage{qwertz}\n" |
| 12 |
"\\usepackage{url}\n" |
| 13 |
"\\usepackage\[latin1\]{inputenc}\n" |
| 14 |
"\\usepackage{epsfig}\n" |
| 15 |
"\\usepackage{[OPTS]}\n" |
| 16 |
"\\pagestyle{headings}%end-preamble\n" + |
| 17 |
|
| 18 |
</book> + "\\end{document}" + |
| 19 |
|
| 20 |
% Manual Pages are expected to be formatted using nroff (or groff), unless |
| 21 |
% they are included as sections of other qwertz documents. |
| 22 |
|
| 23 |
<manpage> |
| 24 |
</manpage> |
| 25 |
|
| 26 |
<progdoc> "\\progdoc" |
| 27 |
</progdoc> |
| 28 |
|
| 29 |
<titlepag> |
| 30 |
</titlepag> + "\n\n\\begin{document}\n" |
| 31 |
"\\maketitle\n" + |
| 32 |
|
| 33 |
<title> + "\\title{" |
| 34 |
</title> "}" + |
| 35 |
|
| 36 |
<subtitle> "\\\\\n" |
| 37 |
"{\\large " |
| 38 |
</subtitle> "}" + |
| 39 |
|
| 40 |
<author> + "\\author{" |
| 41 |
</author> "}" + |
| 42 |
|
| 43 |
<name> |
| 44 |
</name> |
| 45 |
|
| 46 |
<and> "\\and " + |
| 47 |
</and> |
| 48 |
|
| 49 |
<thanks> "\\thanks{" |
| 50 |
</thanks> "}" |
| 51 |
|
| 52 |
<inst> " \\\\\n\\\\" + |
| 53 |
</inst> |
| 54 |
|
| 55 |
<date> + "\\stabledate{" |
| 56 |
</date> "}" + |
| 57 |
|
| 58 |
<documentid> + "\\pdftrailerid{" |
| 59 |
</documentid> "}" + |
| 60 |
|
| 61 |
<newline> "\\\\ " |
| 62 |
</newline> |
| 63 |
|
| 64 |
<label> "\\label{[ID]}" |
| 65 |
</label> |
| 66 |
|
| 67 |
<header> + "\\markboth" |
| 68 |
</header> |
| 69 |
|
| 70 |
<lhead> "{" |
| 71 |
</lhead> "}" |
| 72 |
|
| 73 |
<rhead> "{" |
| 74 |
</rhead> "}" + |
| 75 |
|
| 76 |
% <comment> + "\n\n\\begin{verbatim}" + |
| 77 |
% </comment> + "\\end{verbatim}\n\n" + |
| 78 |
|
| 79 |
<comment> "{\\tt " |
| 80 |
</comment> "}" |
| 81 |
|
| 82 |
% Hacked by mdw to use linuxdoc-sgml \abstract{...} |
| 83 |
<abstract> + "\\abstract{" |
| 84 |
</abstract> "}" + |
| 85 |
|
| 86 |
<appendix> + "\n \\appendix \n" + |
| 87 |
</appendix> |
| 88 |
|
| 89 |
<toc> + "\\tableofcontents" + |
| 90 |
</toc> |
| 91 |
|
| 92 |
<lof> + "\\listoffigures" + |
| 93 |
</lof> |
| 94 |
|
| 95 |
<lot> + "\\listoftables" + |
| 96 |
</lot> |
| 97 |
|
| 98 |
<chapt> + "\n\\chapter" |
| 99 |
</chapt> |
| 100 |
|
| 101 |
<sect> + "\n\\section" |
| 102 |
</sect> |
| 103 |
|
| 104 |
<sect1> + "\n\\subsection" |
| 105 |
</sect1> |
| 106 |
|
| 107 |
<sect2> + "\n\\subsubsection" |
| 108 |
</sect2> |
| 109 |
|
| 110 |
<sect3> + "\n\\paragraph" |
| 111 |
</sect3> |
| 112 |
|
| 113 |
<sect4> + "\n\\subparagraph" |
| 114 |
</sect4> |
| 115 |
|
| 116 |
<heading> "{" |
| 117 |
</heading> "}\n\n" |
| 118 |
|
| 119 |
<p> "\\phantomsection{}" |
| 120 |
</p> "\n\n" |
| 121 |
|
| 122 |
<itemize> + "\\begin{itemize}" + |
| 123 |
</itemize> + "\\end{itemize}" + |
| 124 |
|
| 125 |
<enum> + "\\begin{enumerate}" + |
| 126 |
</enum> + "\\end{enumerate}" + |
| 127 |
|
| 128 |
<list> + "\\begin{list}{}{}\n" + |
| 129 |
</list> + "\\end{list}" + |
| 130 |
|
| 131 |
<descrip> + "\\begin{description}\[style=unboxed\]" + |
| 132 |
</descrip> + "\\end{description}" + |
| 133 |
|
| 134 |
<item> + "\\item " |
| 135 |
</item> |
| 136 |
|
| 137 |
<tag> + "\\phantomsection\\item\[{\\ttfamily " |
| 138 |
</tag> "}\] \\hfil\\break\n" + |
| 139 |
|
| 140 |
<tagp> + "\\item\[ " |
| 141 |
</tagp> "\] \\hfil\\break\n" + |
| 142 |
|
| 143 |
<cite> "\\cite{[ID]" |
| 144 |
</cite> "}" |
| 145 |
|
| 146 |
<ncite> "\\cite\[[NOTE]\]{[ID]" |
| 147 |
</ncite> "}" |
| 148 |
|
| 149 |
<idx> "\\idx{" |
| 150 |
</idx> "}" |
| 151 |
|
| 152 |
<cdx> "\\cdx{" |
| 153 |
</cdx> "}" |
| 154 |
|
| 155 |
<nidx> "\\nidx{" |
| 156 |
</nidx> "}" |
| 157 |
|
| 158 |
<ncdx> "\\ncdx{" |
| 159 |
</ncdx> "}" |
| 160 |
|
| 161 |
% The idea here is to automatically insert soft hyphens after every slash in |
| 162 |
% the filename, so long filenames will break naturally. The url{} macro is |
| 163 |
% a kluge but it works, |
| 164 |
<file> "{\\tt " |
| 165 |
</file> "}" |
| 166 |
|
| 167 |
<footnote> "\\footnote{" |
| 168 |
</footnote> "}" |
| 169 |
|
| 170 |
<sq> "``" |
| 171 |
</sq> "''" |
| 172 |
|
| 173 |
<lq> + "\\begin{quotation}\n" + |
| 174 |
</lq> + "\n\\end{quotation}\n\n" + |
| 175 |
|
| 176 |
<em> "{\\it " |
| 177 |
</em> "\\/}" |
| 178 |
|
| 179 |
<m> "{\\it " |
| 180 |
</m> "\\/}" |
| 181 |
|
| 182 |
<bf> "{\\bf " |
| 183 |
</bf> "}" |
| 184 |
|
| 185 |
<it> "{\\it " |
| 186 |
</it> "\\/}" |
| 187 |
|
| 188 |
<sf> "{\\sf " |
| 189 |
</sf> "}" |
| 190 |
|
| 191 |
<sl> "{\\sl " |
| 192 |
</sl> "}" |
| 193 |
|
| 194 |
<rm> "{\\rm " |
| 195 |
</rm> "}" |
| 196 |
|
| 197 |
<tt> "{\\tt " |
| 198 |
</tt> "}" |
| 199 |
|
| 200 |
<cf> "{\\tt " |
| 201 |
</cf> "}" |
| 202 |
|
| 203 |
<const> "{\\tt " |
| 204 |
</const> "}" |
| 205 |
|
| 206 |
<func> "{\\it " |
| 207 |
</func> "\\/}" |
| 208 |
|
| 209 |
<struct> "{\\tt " |
| 210 |
</struct> "}" |
| 211 |
|
| 212 |
<param> "{\\it " |
| 213 |
</param> "\\/}" |
| 214 |
|
| 215 |
<type> "{\\rm " |
| 216 |
</type> "}" |
| 217 |
|
| 218 |
<funcdef> "{\\it " |
| 219 |
</funcdef> "\\/}" |
| 220 |
|
| 221 |
<function> "{\\function " |
| 222 |
</function> "}\n\n" |
| 223 |
|
| 224 |
<funcsect> "\n\\funcsect{" |
| 225 |
</funcsect> "}" |
| 226 |
|
| 227 |
<hrule> "\\hrule" |
| 228 |
|
| 229 |
% Added by mdw |
| 230 |
<cparam> "\\cparam{" |
| 231 |
</cparam> "}" |
| 232 |
|
| 233 |
<ref> "\\hyperref\[[ID]\]{[NAME]} (p.\\,\\getpagerefnumber{[ID]})" |
| 234 |
</ref> |
| 235 |
|
| 236 |
<pageref> "\\pageref{[ID]}" |
| 237 |
</pageref> |
| 238 |
|
| 239 |
%url added by HG |
| 240 |
<url> "\\href{[URL]}{[NAME]}" |
| 241 |
</url> |
| 242 |
|
| 243 |
<htmlurl> "\\href{[URL]}{[NAME]}" |
| 244 |
</htmlurl> |
| 245 |
|
| 246 |
<rfc> "\\href{http://www.rfc-editor.org/info/rfc[ID]}{RFC [ID]}" |
| 247 |
</rfc> |
| 248 |
|
| 249 |
<x> |
| 250 |
</x> |
| 251 |
|
| 252 |
<mc> |
| 253 |
</mc> |
| 254 |
|
| 255 |
<biblio> + "\\bibliographystyle{[STYLE]}\n" |
| 256 |
"\\bibliography{[FILES]}\n" |
| 257 |
"\\addbibtoc{}" + |
| 258 |
</biblio> |
| 259 |
|
| 260 |
% <macro> + "\\macro{[ID]}{\\qw[ID]}" |
| 261 |
% </macro> |
| 262 |
|
| 263 |
% <main> + "\\macro{qwmain}{\\qwmain}" |
| 264 |
% </main> |
| 265 |
|
| 266 |
%<code> + "\\par\n" |
| 267 |
% "\\medbreak\\hrule\\nopagebreak\n" |
| 268 |
% "\\begin{verbatim}" + |
| 269 |
% |
| 270 |
%</code> + "\\end{verbatim}\n" |
| 271 |
% "\\nopagebreak\\hrule\\medbreak\n" + |
| 272 |
|
| 273 |
<code> + "\\par\n" |
| 274 |
"\\goodbreak{\\birdnarrow\n" |
| 275 |
"\\begin{verbatim}" + |
| 276 |
|
| 277 |
</code> + "\\end{verbatim}\n" |
| 278 |
"}\\smallbreak\n" + |
| 279 |
|
| 280 |
<verb> + "\\begin{verbatim}" + |
| 281 |
</verb> + "\\end{verbatim}" + |
| 282 |
|
| 283 |
% tscreen added by mdw |
| 284 |
<tscreen> + "\\begin{tscreen}" + |
| 285 |
</tscreen> + "\\end{tscreen}" + |
| 286 |
|
| 287 |
<quote> + "\\begin{quotation}" + |
| 288 |
</quote> + "\\end{quotation}" + |
| 289 |
|
| 290 |
% theorems and such |
| 291 |
|
| 292 |
<def> + "\\begin{definition}" |
| 293 |
</def> + "\\end{definition}\n\n" + |
| 294 |
|
| 295 |
<prop> + "\\begin{proposition}" + |
| 296 |
</prop> + "\\end{proposition}" + |
| 297 |
|
| 298 |
<lemma> + "\\begin{lemma}" |
| 299 |
</lemma> + "\\end{lemma}\n\n" + |
| 300 |
|
| 301 |
<coroll> + "\\begin{corollary}" |
| 302 |
</coroll> + "\\end{corollary}\n\n" + |
| 303 |
|
| 304 |
<proof> + "\n{\\noindent{\\bf Proof.} " + |
| 305 |
</proof> + "}" |
| 306 |
|
| 307 |
<theorem> + "\\begin{theorem}" |
| 308 |
</theorem> + "\\end{theorem}\n\n" + |
| 309 |
|
| 310 |
<thtag> "\[" |
| 311 |
</thtag> "\]" + |
| 312 |
|
| 313 |
% mathematics |
| 314 |
|
| 315 |
<f> "$" |
| 316 |
</f> "$" |
| 317 |
|
| 318 |
<dm> + "\\\[" |
| 319 |
</dm> "\\\]" + |
| 320 |
|
| 321 |
<eq> + "\\begin{equation}" + |
| 322 |
</eq> + "\\end{equation}\n" + |
| 323 |
|
| 324 |
<fr> "\\frac" |
| 325 |
</fr> |
| 326 |
|
| 327 |
<nu> "{" |
| 328 |
</nu> "}" |
| 329 |
|
| 330 |
<de> "{" |
| 331 |
</de> "}" |
| 332 |
|
| 333 |
<lim> |
| 334 |
</lim> |
| 335 |
|
| 336 |
<op> |
| 337 |
</op> |
| 338 |
|
| 339 |
<ll> "_{" |
| 340 |
</ll> "}" |
| 341 |
|
| 342 |
<ul> "^{" |
| 343 |
</ul> "}" |
| 344 |
|
| 345 |
<opd> |
| 346 |
</opd> |
| 347 |
|
| 348 |
<pr> "\\prod" |
| 349 |
</pr> |
| 350 |
|
| 351 |
<in> "\\int" |
| 352 |
</in> |
| 353 |
|
| 354 |
<sum> "\\sum" |
| 355 |
</sum> |
| 356 |
|
| 357 |
<root> "\\sqrt\[[n]\]{" |
| 358 |
</root> "}" |
| 359 |
|
| 360 |
<ar> + "\\begin{array}{[ca]}" + |
| 361 |
</ar> + "\\end{array}" + |
| 362 |
|
| 363 |
<arr> " \\\\ " + |
| 364 |
</arr> |
| 365 |
|
| 366 |
<arc> " & " |
| 367 |
</arc> |
| 368 |
|
| 369 |
|
| 370 |
<sup> "^{" |
| 371 |
</sup> "}" |
| 372 |
|
| 373 |
<inf> "_{" |
| 374 |
</inf> "}" |
| 375 |
|
| 376 |
<unl> "\\underline{" |
| 377 |
</unl> "}" |
| 378 |
|
| 379 |
<ovl> "\\overline{" |
| 380 |
</ovl> "}" |
| 381 |
|
| 382 |
<rf> "\\mbox{\\tt " |
| 383 |
</rf> "}" |
| 384 |
|
| 385 |
<v> "\\vec{" |
| 386 |
</v> "}" |
| 387 |
|
| 388 |
<fi> "{\\cal " |
| 389 |
</fi> "}" |
| 390 |
|
| 391 |
<phr> "{\\rm " |
| 392 |
</phr> "}" |
| 393 |
|
| 394 |
<tu> "\\\\ \n" |
| 395 |
</tu> |
| 396 |
|
| 397 |
% figures |
| 398 |
|
| 399 |
<figure> + "\\begin{figure}\[[LOC]\]" + |
| 400 |
</figure> + "\\end{figure}\n" + |
| 401 |
|
| 402 |
<eps> + "\\centerline{\\epsfig{file=[FILE],height=[HEIGHT],angle=[ANGLE]}}" + |
| 403 |
</eps> |
| 404 |
|
| 405 |
|
| 406 |
<ph> + "\\vspace{[VSPACE]}\n\\par" + |
| 407 |
</ph> |
| 408 |
|
| 409 |
<caption> + "\\caption{" |
| 410 |
</caption> "}" + |
| 411 |
|
| 412 |
% tables |
| 413 |
|
| 414 |
<table> + "\\begin{table}\[[LOC]\]" + |
| 415 |
</table> + "\\end{table}" + |
| 416 |
|
| 417 |
<tabular> + "\\begin{center}\n" |
| 418 |
"\\begin{tabular}{[ca]}" + |
| 419 |
</tabular> + "\\end{tabular}\n" |
| 420 |
"\\end{center}" + |
| 421 |
|
| 422 |
<rowsep> "\\\\ " + |
| 423 |
</rowsep> |
| 424 |
|
| 425 |
<colsep> "& " |
| 426 |
</colsep> |
| 427 |
|
| 428 |
<hline> + "\\hline" + |
| 429 |
</hline> |
| 430 |
|
| 431 |
% end of latex replacement file |