Document Structure » Historie » Revision 5
Revision 4 (Patrick Schulz, 19.09.2024 11:47) → Revision 5/9 (Patrick Schulz, 19.12.2024 14:16)
h1. Document Structure h2. Minimal TeX Document A minimal tex document that uses the CoCoTeX transpect-tex Framework has the following structure: <pre><code class="text"> \documentclass[<options>]{cocotex} (1) \usepackage[<options>]{<publisher style>} \usepackage[<options>]{<verlagsstyle>} (2) ... (3) \begin{document} (4) … (5) \end{document} (6) </code></pre> # Document class ** Document class name is *always* @cocotex@. ** Optional argument (stuff between @[@ and @]@, komma-separated) can be used to pass LaTeX-options such as @a4paper@, @openright@, @twoside@, etc. ** the document type is given with the @pubtype@ Option and one of the following values: *** @mono@ for monographs (i.e., books that are in its entirety written by the same Author(s)) *** @collection@ for books with contributions/chapters from various authors *** @article@ for journal articles *** @journal@ for entire journals, i.e., collection of articles ** Languages: *** @main=<name>@ is 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. (Note: in previous versions, there was an additional @lang-id=@ option which set the document language for accessibility purposes. This is now determined automatically from the @main@ option.) *** 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 used instead of footnotes, use @endnotes@ *** 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 each chapter, set @resetnotesperchapter@ ** PDF Standard and Versions Accessibility Features: *** If PDFs should conform to the PDF Standard PDF/1.7 and PDF Version are PDF/UA-1 standards, set with the @pdf-standard=Z@ option, where @Z@ can be one of: @A-1B@, @ A-1A@, @ A-2B@, @ A-2A@, @ A-2U@, @ A-3B@, @ A-3A@, @ A-3U@, @ A-4@, @ X-3@, @ X-4@, @ X-4P@, @ X-5G@, @ X-5N@, @ X-5PG@, @ X-6@, @ X-6N@, @ X-6P@, @ UA-1@, or @UA-2@. @a11y@ (that is: @a-eleven-y@) *** The if the pdf should conform to PDF Version that is generated from each of the options can be seen in the table below. *** @UA-1@ 2.0 and @UA-2@ enable the accessibility features PDF/UA-2, then use @a11y20@. *** The @X@-Standards cause @hyperref@ macros (@\href@, @\url@, @\hyperlink@, etc.) to be *functionally disabled*, i.e., they can be used in also set the tex file but they cause no hyperlinks language code for the main document in ISO-639 with the resulting PDF file. @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. |_.PDF standard|_.PDF version| |UA-1 | 1.7| |UA-2 | 2.0| |A-1.* | 1.4| |A-[23].* | 1.7| |A-4.* | 2.0| |X-[123].* | 1.4| |X-[45].* | 1.6| |X-6.* | 2.0| 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>