Projekt

Allgemein

Profil

Dokumentaufbau » Historie » Version 8

Marcus Hottenroth, 21.10.2026 12:03

1 1 Patrick Schulz
h1. Dokumentaufbau
2
3 7 Marcus Hottenroth
h2. Minimales TeX-Dokument
4 1 Patrick Schulz
5 7 Marcus Hottenroth
Ein minimales TeX-Dokument, das das Xerif-Framework nutzt, hat folgenden Aufbau:
6 1 Patrick Schulz
<pre><code class="text">
7 4 Patrick Schulz
\documentclass[main=<hauptsprache>,<andere_sprachen>,usescript={<fallback>},book]{cocotex}   (1)
8 5 Marcus Hottenroth
\usepackage[<opt>]{<verlagsstyle>}                                                           (2)
9
…                                                                                            (3)
10
\begin{document}                                                                             (4)
11
…                                                                                            (5)
12
\end{document}                                                                               (6)
13 1 Patrick Schulz
</code></pre>
14 4 Patrick Schulz
15 1 Patrick Schulz
# Dokumentenklasse. 
16 5 Marcus Hottenroth
** Die Klasse ist *immer* @cocotex@. 
17
** Im optionalen Argument (zwischen @[@ und @]@) werden die LaTeX-Standardoptionen verarbeitet (z. B. a4paper, openright, twoside etc.) sowie durch Komma getrennt die verwendeten Dokumentsprachen angegeben. Die Hauptsprache ist die letztgenannte. Sprachen, die eine Fallbackschrift benötigen (z. B. Arabisch, Hebräisch, Chinesisch), werden kommasepariert via @usescript={…}@ in das optionale Dokumentenklassenargument eingetragen.
18
** Zusätzlich wird der Dokumententyp über @pubtype=…@ angegeben, z. B. 
19
*** @mono@ für Monographien
20
*** @collection@ für Sammelbände
21
*** @journal@ für Zeitschriftenartikel
22
# Einbinden des Verlagsstylesheets mit den jeweiligen Optionen.
23
# Der Bereich zwischen @\documentclass[…]{…}@ und @\begin{document}@ wird Präambel genannt. Hier müssen u. U. weitere Metaangaben (etwa Farbdefinitionen, Parameter für die Titelei etc.) folgen.
24
# @\begin{document}@ markiert den Beginn des auszugebenden Bereichs.
25 1 Patrick Schulz
# Inhalt des Dokuments.
26
# Alles nach @\end{document}@ wird ignoriert.
27 7 Marcus Hottenroth
28
29 8 Marcus Hottenroth
h2. Umfangreiches TeX-Dokument
30 7 Marcus Hottenroth
31 8 Marcus Hottenroth
Dieser Seite hängt eine [beinahe vollständige TeX-Vorlage](https://redmine.le-tex.de/attachments/download/36802/Xeriftemplate.sty) an, die für jedwedes Xerifprojekt genutzt werden kann. Es enthält die am häufigsten verwendeten Konstrukte sowie einige wichtige Beispiele zu Spezialfällen.
32 7 Marcus Hottenroth
33 1 Patrick Schulz
34
h2. Kompilierung
35
36
Reihenfolge sollte *mindestens* sein:
37
<pre><code class="ruby">
38 6 Marcus Hottenroth
lualatex <main>.tex                   ## 1. Durchlauf: Einsammeln von Informationen und Schreiben der aux-, toc-, lof-, lot- und Indexdateien.
39
lualatex <main>.tex                   ## 2. Durchlauf: aux-, toc-, lof- und lot-Datei auslesen und anwenden.
40
lualatex <main>.tex                   ## 3. Durchlauf: Aktualisieren der Seitenzahlen durch Umbruchverschiebungen, nachdem toc, lof, etc. eingebunden sind.
41
bash ./index.sh <main> <index letter> ## Indexgenerierung
42
lualatex <main>.tex                   ## 4. Durchlauf: Indexausgabe, ggf. Aktualisierung der toc-Datei für Indexüberschriften.
43
lualatex <main>.tex                   ## 5. Durchlauf: aktualisiertes Inhaltsverzeichnis wird ausgegeben.
44 1 Patrick Schulz
</code></pre>
45 6 Marcus Hottenroth
Sollten nach dem Index-Bereich weitere Kapitel folgen, mussen die letzten drei Schritte u. U. wiederholt werden, vgl. [[Index]].