Headings » Historie » Revision 10
Revision 9 (Patrick Schulz, 05.12.2024 10:49) → Revision 10/11 (Patrick Schulz, 05.12.2024 10:50)
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
Some headings may have additional Components:
* @\tpAbstract{}@ Abstract
* @\tpAbstractTitle{}@ Abstract heading, default: “Abstract”
* @\tpKeywords{}@ Keywords
* @\tpKeywordsTitle{}@ Keyword heading, default: “Keywords”
* @\tpDOI{}@ DOI
* @\tpDOITitle{}@ Title for DOI, default: <empty>.
These headings can have different names from project to project, but by convention the level is usually called @contribution@ and inherits their characteristics from @chapter@.
@\tpBreak@ or @\TitleBreak@ (alias of the former) can be used to create a line break inside each heading Component.
h2. Overrides for Table of Contents, Running Headers and PDF bookmarks
There are three overrides for each of the macros @\tp<Macro>@ with @<Macro> := (Author | Number | Subtitle | Title)@:
* @\tpRun<Macro>@ @\tpRun <Macro>@ for _running headers_,
* @\tpToc<Macro>@ for _table of contents_, and
* @\tpBM<Macro>@ @\tpBM <Macro>@ for the _PDF bookmarks_.
The Overrides are generated by the following rules:<pre><macro> » Run<macro>
<macro> » Toc<macro> » BM<macro></pre>where the macro right of @»@ is assigned the value of the macro left of @»@, unless they are explicitly assigned a value to inside the @heading@ environment.
If @\tp(Run|Toc|BM)<Makro>{}@ is given with an empty argument, the corresponding macro is not used, i.e. this can be used to completely suppress the respective ToC-entry, running header, or bookmark for a given heading.
*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>