Document Structure¶

Minimal TeX Document¶

A minimal tex document that uses the transpect-tex Framework has the following structure:

\documentclass[<options>]{cocotex}                           (1)
\usepackage[<options>]{<verlagsstyle>}                       (2)
...                                                          (3)
\begin{document}                                             (4)
…                                                            (5)
\end{document}                                               (6)

1. 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.
     • 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
   • 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.)
2. Include the customer-specific style with the respective options
3. 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
4. \begin{document} marks the start of the document
5. Content
6. anything after \end{document} is ignored.

Compiling¶

The minimal order of the TeX files is shown below:

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