Projekt

Allgemein

Profil

Dokumentaufbau » Historie » Revision 3

Revision 2 (Patrick Schulz, 26.03.2021 13:56) → Revision 3/6 (Patrick Schulz, 16.02.2022 10:54)

h1. Dokumentaufbau 

 h2. Minimales tex-Dokument 

 Ein minimales tex-Dokument, das das transpect-tex Common Framework nutzt, hat folgenden Aufbau: 
 <pre><code class="text"> 
 \documentclass[main=<hauptsprache>,<andere_sprachen>,usescript={<fallback>},book]{transpect}     \documentclass[book]{transpect}                                (1) 
 \usepackage[<opt>]{<verlagsstyle>}                                        \usepackage[main=ngerman,bidi=basic,silent]{babel}             (2) 
 ...                                                                       \babelprovide[import]{english}                                 (3) 
 \begin{document}                                                          \babelprovide[import]{french}                                  (4) 
  \usepackage[<opt>]{<verlagsstyle>}                             (5) 
 \end{document} ...                                                            (6) 
 \begin{document}                                               (7) 
 …                                                              (8) 
 \end{document}                                                 (9) 
 </code></pre> 

 # Dokumentenklasse.  
 ** Dies ist *immer* @transpect@.  
 ** Im optionalen Argument (zwischen @[@ und @]@) werden die LaTeX-Standardoptionen verarbeitet (z.B. a4paper, openright, twoside, etc.) 
 *** sowie die verwendeten Dokuemnt-Sprachen. Die Hauptsprache steht hinter @main=…@, alle weiteren folgen Komma-Separiert 
 *** *außer* Sprachen, die eine Fallback-Schrift benötigen (z.B. arabisch, hebräisch, chinesisch…). Diese werden innerhalb der klammern von @usescript={…}@ kommasepariert gelistet. 
 ** Zusätzlich der Dokumententyp, z.B.  
 *** "book" für Monographien 
 *** "collection" für Sammelbände 
 *** "article" für Zeitschriftenartikel 
 # einbinden des Babel-Pakets, in dem die Hauptsprache des Dokuments festgelegt wird (main=<hauptsprache>) 
 # Mittels @\babelprovide{}@ müssen *alle zusätzlich verwendenten Sprachen* aufgelistet werden;  
 # pro Sprache ein @\babelprovide{<sprachname>}@ 
 # Einbinden des Verlags-Stylesheets mit den jeweiligen Optionen 
 # 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 
 # @\begin{document}@ markiert den Beginn des auszugebenden Bereichs 
 # Inhalt 
 # 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]]