Document Structure » Historie » Version 1
Martin Kraetke, 22.12.2021 13:51
| 1 | 1 | Martin Kraetke | h1. Document Structure |
|---|---|---|---|
| 2 | |||
| 3 | h1. Document Structure |
||
| 4 | |||
| 5 | h2. Minimal TeX Document |
||
| 6 | |||
| 7 | A minimal tex document that uses the transpect-tex Framework has the following structure: |
||
| 8 | |||
| 9 | <pre><code class="text"> |
||
| 10 | \documentclass[book]{transpect} (1) |
||
| 11 | \usepackage[main=ngerman,bidi=basic,silent]{babel} (2) |
||
| 12 | \babelprovide[import]{english} (3) |
||
| 13 | \babelprovide[import]{french} (4) |
||
| 14 | \usepackage[<opt>]{<verlagsstyle>} (5) |
||
| 15 | ... (6) |
||
| 16 | \begin{document} (7) |
||
| 17 | … (8) |
||
| 18 | \end{document} (9) |
||
| 19 | </code></pre> |
||
| 20 | |||
| 21 | # Document class |
||
| 22 | ** Document class name is *always* @transpect@. |
||
| 23 | ** Optional argument can be used to pass LaTeX-options such as @a4paper@, @openright@, @twoside@, etc. |
||
| 24 | ** and the document type: |
||
| 25 | *** "book" |
||
| 26 | *** "collection" for books with contributions from various authors |
||
| 27 | *** "article" for journal articles |
||
| 28 | # you can include the Babel package, in which the main language of the document is specified (main=<myBabelLanguage>) |
||
| 29 | # with @\babelprovide{}@ you can specify aditionally used languages |
||
| 30 | # add an @\babelprovide{<sprachname>}@ for each language |
||
| 31 | # Include the customer-specific style with the respective options |
||
| 32 | # the area between @\documentclass[…]{…}@ and @\begin{document}@ is the TeX preamble. Additional meta information (e.g. color definitions, parameters for the front cover, ...) may inserted here |
||
| 33 | # @\begin{document}@ marks the start of the document |
||
| 34 | # Content |
||
| 35 | # anything after @\end{document}@ is ignored. |
||
| 36 | |||
| 37 | h2. Compiling |
||
| 38 | |||
| 39 | The minimal order of the TeX files is shown below: |
||
| 40 | <pre><code class="ruby"> |
||
| 41 | latex <main>.tex ## first run: collect |
||
| 42 | latex <main>.tex ## second run: read and apply aux, toc, lof, lot |
||
| 43 | latex <main>.tex ## third run: update page numbers after including toc, lof, etc. |
||
| 44 | ./index.sh <main> ## script to generate the index |
||
| 45 | latex <main>.tex ## fourth run: Index-Ausgabe, ggf. Aktualisierung toc für Index-ÜS |
||
| 46 | latex <main>.tex ## fifth run: update toc |
||
| 47 | </code></pre> |