Projekt

Allgemein

Profil

Dokumentaufbau » Historie » Revision 6

Revision 5 (Marcus Hottenroth, 27.12.2023 09:42) → Revision 6/9 (Marcus Hottenroth, 27.12.2023 09:53)

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. Kompilierung 

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