Projekt

Allgemein

Profil

Headings » Historie » Version 9

Patrick Schulz, 05.12.2024 10:49

1 1 Martin Kraetke
h1. Headings
2
3 3 Martin Kraetke
h2. General Markup
4 1 Martin Kraetke
5
<pre><code class="text">
6
\begin{heading}[<opt>]{<level>}
7
  %% heading information:
8
  \tpTitle{…}
9
  \tpAuthor{…}
10
  \tpSubtitle{…}
11
  \tpNumber{…}
12
  \tpQuote{…}
13
  \tpQuoteSource{…}
14
  %% overrides for ToC-entries:
15
  \tpTocTitle{…}
16
  \tpTocAuthor{…}
17
  \tpTocSubtitle{…}
18
  \tpTocNumber{…}
19
  %% overrides for running header:
20
  \tpRunTitle{…}
21
  \tpRunAuthor{…}
22
  \tpRunSubtitle{…}
23
  \tpRunNumber{…}
24
\end{heading}
25
</code></pre>
26
27
* @<level>@ should include the name of the heading level such as @chapter@, @section@, @subsubsection@…
28
* @<opt>@ optional argument for headings. If there are none, then omit the brackets.
29
** @notoc@: heading is not included in the table of contents
30 5 Maren Pufe
** @noBM@: heading is not included in bookmarks
31 1 Martin Kraetke
* @\tpTitle{}@ contains the heading title. This instruction is mandatory, the commands below are optional
32
* @\tpAuthor{}@ the author
33
* @\tpSubtitle{}@ subtitle
34
* @\tpNumber{}@ the counter of the heading, e.g. "Chapter 2", "2.2.1" etc.
35
* @\tpQuote{}@ epigraph 
36
* @\tpQuoteSource{}@ author or source of the epigraph
37
* @\tpNumber{}@ override for automatic heading numbering 
38
39
40 7 Patrick Schulz
Some headings may have additional Components:
41 1 Martin Kraetke
* @\tpAbstract{}@ Abstract
42
* @\tpAbstractTitle{}@ Abstract heading, default: “Abstract”
43
* @\tpKeywords{}@ Keywords
44
* @\tpKeywordsTitle{}@ Keyword heading, default: “Keywords”
45
* @\tpDOI{}@ DOI
46
* @\tpDOITitle{}@ Title for DOI, default: <empty>.
47
48 7 Patrick Schulz
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@. 
49 1 Martin Kraetke
50 7 Patrick Schulz
@\tpBreak@ or @\TitleBreak@ (alias of the former) can be used to create a line break inside each heading Component.
51 1 Martin Kraetke
52
h2. Overrides for Table of Contents, Running Headers and PDF bookmarks
53
54
55 9 Patrick Schulz
There are three overrides for each of the macros @\tp<Macro>@ with @<Macro> := (Author | Number | Subtitle | Title)@:
56
* @\tpRun <Macro>@ for _running headers_,
57
* @\tpToc<Macro>@ for _table of contents_, and
58
* @\tpBM <Macro>@ for the _PDF bookmarks_.
59 6 Patrick Schulz
60 8 Patrick Schulz
The Overrides are generated by the following rules:<pre><macro> » Run<macro>
61
<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.
62 6 Patrick Schulz
63
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.
64 1 Martin Kraetke
65
*Example:*
66
67
<pre>
68
\begin{heading}{chapter}
69
  \tpTitle{Title of the heading}
70
  \tpAuthor{Jane Doe}
71
  \tpTocAuthor{The incredible Jane Doe}
72
  \tpRunTitle{Title of the running header}
73
  \tpRunAuthor{Author of the running header}
74
\end{heading}
75
</pre>
76
77
h3. *Note on PDF-Bookmarks*
78
79 4 Martin Kraetke
There should be no TeX markup within @\tpBM{}@. This applies also to language markup like @\foreignlanguage@. Just use plain text with Unicode characters here.
80 1 Martin Kraetke
81
h2. List of Figures and List of Tables
82
83
These two listings are marked as normal headings according to the hierarchy level and then the macro for creating the listing follows. 
84
85
<pre>
86
\begin{heading}{section}
87
\tpTitle{My List of Figures}
88
\tpTocTitle{Figures}
89
\tpRunTitle{Lots of Figures}
90
\end{heading}
91
92
\listoffigures
93
</pre>