Projekt

Allgemein

Profil

Dokumentaufbau » Historie » Revision 5

Revision 4 (Patrick Schulz, 05.10.2022 12:54) → Revision 5/6 (Marcus Hottenroth, 27.12.2023 09:42)

h1. Dokumentaufbau 

 

 h2. Minimales tex-Dokument 

 Ein minimales tex-Dokument, das das Xerif-Framework transpect-tex Common 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 Dies ist *immer* @cocotex@. @cocotex@ (bis v0.2 des Frameworks auch @transpect@).  
 ** Im optionalen Argument (zwischen @[@ und @]@) werden die LaTeX-Standardoptionen verarbeitet (z. B. (z.B. a4paper, openright, twoside twoside, etc.) 
 *** sowie durch Komma getrennt die verwendeten Dokumentsprachen angegeben. Dokuemnt-Sprachen. Die Hauptsprache ist die letztgenannte. steht hinter @main=…@, alle weiteren folgen Komma-Separiert 
 *** *außer* Sprachen, die eine Fallbackschrift Fallback-Schrift benötigen (z. B. Arabisch, Hebräisch, Chinesisch), (z.B. arabisch, hebräisch, chinesisch…). Diese werden innerhalb der klammern von @usescript={…}@ kommasepariert via @usescript={…}@ in das optionale Dokumentenklassenargument eingetragen. gelistet. 
 ** Zusätzlich wird der Dokumententyp über @pubtype=…@ angegeben, z. B. Dokumententyp, z.B.  
 *** @mono@ "book" für Monographien 
 *** @collection@ "collection" für Sammelbände 
 *** @journal@ "article" für Zeitschriftenartikel 
 # Einbinden des Verlagsstylesheets Verlags-Stylesheets mit den jeweiligen Optionen. Optionen 
 # Der Bereich zwischen @\documentclass[…]{…}@ und @\begin{document}@ wird Präambel genannt. Hier müssen u. U. u.U. weitere Metaangaben Meta-Angaben (etwa Farbdefinitionen, Parameter für die Titelei etc.) folgen. Titelei, …) folgen 
 # @\begin{document}@ markiert den Beginn des auszugebenden Bereichs. Bereichs 
 # Inhalt des Dokuments. 
 # Alles alles nach @\end{document}@ wird komplett ignoriert. 

 

 h2. Kompilierung 

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