Projekt

Allgemein

Profil

Dokumentaufbau » Historie » Revision 8

Revision 7 (Marcus Hottenroth, 21.10.2026 12:02) → Revision 8/9 (Marcus Hottenroth, 21.10.2026 12:03)

h1. Dokumentaufbau 

 h2. Minimales TeX-Dokument 

 Ein minimales TeX-Dokument, das das Xerif-Framework nutzt, hat folgenden Aufbau: 
 <pre><code class="text"> 
 \documentclass[main=<hauptsprache>,<andere_sprachen>,usescript={<fallback>},book]{cocotex}     (1) 
 \usepackage[<opt>]{<verlagsstyle>}                                                             (2) 
 …                                                                                              (3) 
 \begin{document}                                                                               (4) 
 …                                                                                              (5) 
 \end{document}                                                                                 (6) 
 </code></pre> 

 # Dokumentenklasse.  
 ** Die Klasse ist *immer* @cocotex@.  
 ** 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. 
 ** Zusätzlich wird der Dokumententyp über @pubtype=…@ angegeben, z. B.  
 *** @mono@ für Monographien 
 *** @collection@ für Sammelbände 
 *** @journal@ für Zeitschriftenartikel 
 # Einbinden des Verlagsstylesheets mit den jeweiligen Optionen. 
 # 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. 
 # @\begin{document}@ markiert den Beginn des auszugebenden Bereichs. 
 # Inhalt des Dokuments. 
 # Alles nach @\end{document}@ wird ignoriert. 


 h2. Umfangreiches TeX-Dokument Extensive TeX document 

 Dieser Seite hängt eine [beinahe vollständige TeX-Vorlage](https://redmine.le-tex.de/attachments/download/36802/Xeriftemplate.sty) TeX-Vorlage](https://redmine.le-tex.de/attachments/download/36801/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. 


 h2. Kompilierung 

 Reihenfolge sollte *mindestens* sein: 
 <pre><code class="ruby"> 
 lualatex <main>.tex                     ## 1. Durchlauf: Einsammeln von Informationen und Schreiben der aux-, toc-, lof-, lot- und Indexdateien. 
 lualatex <main>.tex                     ## 2. Durchlauf: aux-, toc-, lof- und lot-Datei auslesen und anwenden. 
 lualatex <main>.tex                     ## 3. Durchlauf: Aktualisieren der Seitenzahlen durch Umbruchverschiebungen, nachdem toc, lof, etc. eingebunden sind. 
 bash ./index.sh <main> <index letter> ## Indexgenerierung 
 lualatex <main>.tex                     ## 4. Durchlauf: Indexausgabe, ggf. Aktualisierung der toc-Datei für Indexüberschriften. 
 lualatex <main>.tex                     ## 5. Durchlauf: aktualisiertes Inhaltsverzeichnis wird ausgegeben. 
 </code></pre> 
 Sollten nach dem Index-Bereich weitere Kapitel folgen, mussen die letzten drei Schritte u. U. wiederholt werden, vgl. [[Index]].