Projekt

Allgemein

Profil

Dokumentaufbau » Historie » Version 1

Patrick Schulz, 09.02.2021 10:46

1 1 Patrick Schulz
h1. Dokumentaufbau
2
3
h2. Minimales tex-Dokument
4
5
Ein minimales tex-Dokument, das das transpect-tex Common Framework nutzt, hat folgenden Aufbau:
6
<pre><code class="text">
7
\documentclass[book]{transpect}                              (1)
8
\usepackage{fontspec}                                        (2)
9
\usepackage[main=ngerman,bidi=basic]{babel}                  (3)
10
\babelprovide{english}                                       (4)
11
\usepackage[<opt>]{<verlagsstyle>}                           (5)
12
...                                                          (6)
13
\begin{document}                                             (7)
14
…                                                            (8)
15
\end{document}                                               (9)
16
</code></pre>
17
18
# Dokumentenklasse. 
19
** Dies ist *immer* @transpect@. 
20
** Im optionalen Argument (zwischen @[@ und @]@) werden die LaTeX-Standardoptionen verarbeitet (z.B. a4paper, openright, twoside, etc.)
21
** Zusätzlich der Dokumententyp, z.B. 
22
*** "book" für Monographien
23
*** "collection" für Sammelbände
24
*** "article" für Zeitschriftenartikel
25
# Einbinden des fontspec-Pakets für die Schriften
26
# einbinden des Babel-Pakets, in dem die Hauptsprache des Dokuments festgelegt wird (main=<hauptsprache>)
27
# Mittels @\babelprovide{}@ müssen *alle zusätzlich verwendenten Sprachen* aufgelistet werden; pro Sprache ein @\babelprovide{<sprachname>}@
28
# Einbinden des Verlags-Stylesheets mit den jeweiligen Optionen
29
# Der Bereich zwischen @\documentclass[…]{…}@ und @\begin{document}@ wird Präambel genannt. Hier müssen u.U. weitere Meta-Angaben (etwa Farbdefinitionen, Parameter für die Titelei, …) folgen
30
# @\begin{document}@ markiert den Beginn des auszugebenden Bereichs
31
# Inhalt
32
# alles nach @\end{document}@ wird komplett ignoriert.
33
34
h2. Kompilierung
35
36
Reihenfolge sollte *mindestens* sein:
37
<pre><code class="ruby">
38
latex <main>.tex       ## 1. Durchlauf: Einsammeln
39
latex <main>.tex       ## 2. Durchlauf: aux, toc, lof, lot, etc. auslesen und anwenden
40
latex <main>.tex       ## 3. Durchlauf: Aktualisieren Seitenzahlen durch Umbruchverschiebungen nachdem toc, lof, etc. eingebunden sind.
41
./index.sh <main>      ## Index-Generierung
42
latex <main>.tex       ## 4. Durchlauf: Index-Ausgabe, ggf. Aktualisierung toc für Index-ÜS
43
latex <main>.tex       ## 5. Durchlauf: aktualisiertes toc wird ausgegeben
44
</code></pre>