Document Structure » Historie » Revision 3
Revision 2 (Martin Kraetke, 22.12.2021 13:51) → Revision 3/4 (Patrick Schulz, 19.09.2024 11:46)
h1. Document Structure h2. Minimal TeX Document A minimal tex document that uses the transpect-tex Framework has the following structure: <pre><code class="text"> \documentclass[options]{cocotex} \documentclass[book]{transpect} (1) \usepackage[main=ngerman,bidi=basic,silent]{babel} (2) \babelprovide[import]{english} (3) \babelprovide[import]{french} (4) \usepackage[<opt>]{<verlagsstyle>} (2) (5) ... (3) (6) \begin{document} (4) (7) … (5) (8) \end{document} (6) (9) </code></pre> # Document class ** Document class name is *always* @cocotex@. @transpect@. ** Optional argument (stuff between @[@ and @]@, komma-separated) can be used to pass LaTeX-options such as @a4paper@, @openright@, @twoside@, etc. ** and the document type is given with the @pubtype@ Option and one of the following values: type: *** @mono@ for monographs (i.e., books that are in its entirety written by the same Author(s)) "book" *** @collection@ "collection" for books with contributions/chapters contributions from various authors *** @article@ "article" for journal articles *** @journal@ for entire journals, i.e., collection of articles ** Languages: *** @main=<name>@ is # you can include the Babel package, in which the main language of the document, this controlls the language of the document-wide meta data, the imprint, headings of fixed document parts (ToC, Index), etc. is specified (main=<myBabelLanguage>) *** other languages that are used throughout the document need to be listed as simple komma-separated entries, e.g., @ngerman@ (German # with new spelling rules), @french@, etc. *** Langauges that use their own script systems need to be listed in @usescript={…}@, e.g., @usescript={hebrew,greek,chinese,syriac}@ ** If endnotes should be @\babelprovide{}@ you can specify aditionally used instead of footnotes, use @endnotes@ languages *** if the endnotes Chapters (or sections) should *not* appear in the ToC, use @ennotoc@ *** If the endnotes should repeat the chapter headings, use @endnoteswithchapters@ *** If footnote and/or endnote counters should be reset with # add an @\babelprovide{<sprachname>}@ for each chapter, set @resetnotesperchapter@ ** Accessibility Features: *** If PDFs should conform to the PDF/1.7 and PDF/UA-1 standards, set @a11y@ (that is: @a-eleven-y@) *** if the pdf should conform to PDF 2.0 and PDF/UA-2, then use @a11y20@. *** also set the language code for the main document in ISO-639 with the @lang-id@ key (@lang-id=deu@ für German, @lang-id=eng@ for English, etc.) # Include the customer-specific style with the respective options # the area between @\documentclass[…]{…}@ and @\begin{document}@ is the TeX preamble. Additional meta information (e.g. color definitions, parameters for the front cover, the @tpMeta@-Environment, ...) may inserted here # @\begin{document}@ marks the start of the document # Content # anything after @\end{document}@ is ignored. h2. Compiling The minimal order of the TeX files is shown below: <pre><code class="ruby"> latex <main>.tex ## first run: collect latex <main>.tex ## second run: read and apply aux, toc, lof, lot latex <main>.tex ## third run: update page numbers after including toc, lof, etc. ./index.sh <main> ## script to generate the index latex <main>.tex ## fourth run: Index-Ausgabe, ggf. Aktualisierung toc für Index-ÜS latex <main>.tex ## fifth run: update toc </code></pre>