Projekt

Allgemein

Profil

Dokumentaufbau » Historie » Version 4

Patrick Schulz, 05.10.2022 12:54

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 4 Patrick Schulz
\documentclass[main=<hauptsprache>,<andere_sprachen>,usescript={<fallback>},book]{cocotex}   (1)
8 3 Patrick Schulz
\usepackage[<opt>]{<verlagsstyle>}                                      (2)
9
...                                                                     (3)
10
\begin{document}                                                        (4)
11
…                                                                       (5)
12
\end{document}                                                          (6)
13 1 Patrick Schulz
</code></pre>
14
15
# Dokumentenklasse. 
16 4 Patrick Schulz
** Dies ist *immer* @cocotex@ (bis v0.2 des Frameworks auch @transpect@). 
17 1 Patrick Schulz
** Im optionalen Argument (zwischen @[@ und @]@) werden die LaTeX-Standardoptionen verarbeitet (z.B. a4paper, openright, twoside, etc.)
18 3 Patrick Schulz
*** sowie die verwendeten Dokuemnt-Sprachen. Die Hauptsprache steht hinter @main=…@, alle weiteren folgen Komma-Separiert
19
*** *außer* Sprachen, die eine Fallback-Schrift benötigen (z.B. arabisch, hebräisch, chinesisch…). Diese werden innerhalb der klammern von @usescript={…}@ kommasepariert gelistet.
20 1 Patrick Schulz
** Zusätzlich der Dokumententyp, z.B. 
21
*** "book" für Monographien
22 2 Patrick Schulz
*** "collection" für Sammelbände
23
*** "article" für Zeitschriftenartikel
24 1 Patrick Schulz
# Einbinden des Verlags-Stylesheets mit den jeweiligen Optionen
25
# 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
26
# @\begin{document}@ markiert den Beginn des auszugebenden Bereichs
27
# Inhalt
28
# alles nach @\end{document}@ wird komplett ignoriert.
29
30
h2. Kompilierung
31
32
Reihenfolge sollte *mindestens* sein:
33
<pre><code class="ruby">
34
latex <main>.tex       ## 1. Durchlauf: Einsammeln
35
latex <main>.tex       ## 2. Durchlauf: aux, toc, lof, lot, etc. auslesen und anwenden
36
latex <main>.tex       ## 3. Durchlauf: Aktualisieren Seitenzahlen durch Umbruchverschiebungen nachdem toc, lof, etc. eingebunden sind.
37
./index.sh <main>      ## Index-Generierung
38
latex <main>.tex       ## 4. Durchlauf: Index-Ausgabe, ggf. Aktualisierung toc für Index-ÜS
39
latex <main>.tex       ## 5. Durchlauf: aktualisiertes toc wird ausgegeben
40
</code></pre>
41 3 Patrick Schulz
Sollten nach dem Index-Bereich weitere Kapitel folgen, mussen die letzten drei Schritte u.U. wiederholt werden, vgl. [[Index]]