Headings » Historie » Revision 6
Revision 5 (Maren Pufe, 12.01.2022 11:00) → Revision 6/11 (Patrick Schulz, 05.12.2024 10:44)
h1. Headings
h2. General Markup
<pre><code class="text">
\begin{heading}[<opt>]{<level>}
%% heading information:
\tpTitle{…}
\tpAuthor{…}
\tpSubtitle{…}
\tpNumber{…}
\tpQuote{…}
\tpQuoteSource{…}
%% overrides for ToC-entries:
\tpTocTitle{…}
\tpTocAuthor{…}
\tpTocSubtitle{…}
\tpTocNumber{…}
%% overrides for running header:
\tpRunTitle{…}
\tpRunAuthor{…}
\tpRunSubtitle{…}
\tpRunNumber{…}
\end{heading}
</code></pre>
* @<level>@ should include the name of the heading level such as @chapter@, @section@, @subsubsection@…
* @<opt>@ optional argument for headings. If there are none, then omit the brackets.
** @notoc@: heading is not included in the table of contents
** @noBM@: heading is not included in bookmarks
* @\tpTitle{}@ contains the heading title. This instruction is mandatory, the commands below are optional
* @\tpAuthor{}@ the author
* @\tpSubtitle{}@ subtitle
* @\tpNumber{}@ the counter of the heading, e.g. "Chapter 2", "2.2.1" etc.
* @\tpQuote{}@ epigraph
* @\tpQuoteSource{}@ author or source of the epigraph
* @\tpNumber{}@ override for automatic heading numbering
Spezielle ÜSen haben weitere Datenfelder:
* @\tpAbstract{}@ Abstract
* @\tpAbstractTitle{}@ Abstract heading, default: “Abstract”
* @\tpKeywords{}@ Keywords
* @\tpKeywordsTitle{}@ Keyword heading, default: “Keywords”
* @\tpDOI{}@ DOI
* @\tpDOITitle{}@ Title for DOI, default: <empty>.
These "special headings" can have different names from project to project, but by convention the level is usually called @contribution@ and inherits their characteristics from @chapter@.
@\TitleBreak@ can be used in every macro, which creates a line break.
h2. Overrides for Table of Contents, Running Headers and PDF bookmarks
* There are three overrides for each of the macros @\tp<Macro>@ with @<Macro> := @<Macro>: = (Author | Number | Subtitle | Title)@:
** @\tpRun <Macro>@ for _running headers_, (for running headers), @\tpToc<Macro> @(for IHV), and @\tpBM <Macro>@ (for PDF bookmarks).
** @\tpToc<Macro>@ If the override for _table running headers or table of contents_, and contents is missing, the content of @\tp<Macro>@ for running header or ToC entry is used.
** @\tpBM <Macro>@ for If \tpBM is not used, the _PDF bookmarks_.
The Overrides are generated unless they are explicitly given by the following rules:<pre><macro> » Run<macro> content of @\tpToc<Makro>@ is used instead
<macro> » Toc<macro> » BM<macro></pre>where ** If @\tp(Run|Toc|BM)<Macro>{<Text>}@ is used, @<text>@ instead of the macro right of @»@ content von @\tp(Toc)<Makro>@ is generated from the thing left of @»@.
If used
** if @\tp(Run|Toc|BM)<Makro>{}@ is given used with an empty argument, the corresponding macro there is not used, i.e. this can be used to completely suppress the respective ToC-entry, running header, or bookmark for a given heading. no output.
*Example:*
<pre>
\begin{heading}{chapter}
\tpTitle{Title of the heading}
\tpAuthor{Jane Doe}
\tpTocAuthor{The incredible Jane Doe}
\tpRunTitle{Title of the running header}
\tpRunAuthor{Author of the running header}
\end{heading}
</pre>
h3. *Note on PDF-Bookmarks*
There should be no TeX markup within @\tpBM{}@. This applies also to language markup like @\foreignlanguage@. Just use plain text with Unicode characters here.
h2. List of Figures and List of Tables
These two listings are marked as normal headings according to the hierarchy level and then the macro for creating the listing follows.
<pre>
\begin{heading}{section}
\tpTitle{My List of Figures}
\tpTocTitle{Figures}
\tpRunTitle{Lots of Figures}
\end{heading}
\listoffigures
</pre>