Projekt

Allgemein

Profil

Headings » Historie » Version 5

Maren Pufe, 12.01.2022 11:00

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
Spezielle ÜSen haben weitere Datenfelder:
41
* @\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
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@. 
49
50 2 Martin Kraetke
@\TitleBreak@ can be used in every macro, which creates a line break.
51 1 Martin Kraetke
52
h2. Overrides for Table of Contents, Running Headers and PDF bookmarks
53
54
55
* There are three overrides for each of the macros @\tp<Macro>@ with @<Macro>: = (Author | Number | Subtitle | Title)@: @\tpRun <Macro>@ (for running headers), @\tpToc<Macro> @(for IHV), and @\tpBM <Macro>@ (for PDF bookmarks).
56
** If the override for running headers or table of contents is missing, the content of @\tp<Macro>@ for running header or ToC entry is used.
57
** If \tpBM is not used, the content of @\tpToc<Makro>@ is used instead
58
** If @\tp(Run|Toc|BM)<Macro>{<Text>}@ is used, @<text>@ instead of the content von @\tp(Toc)<Makro>@ is used
59
** if @\tp(Run|Toc|BM)<Makro>{}@ is used with empty argument, there is no output.
60
61
*Example:*
62
63
<pre>
64
\begin{heading}{chapter}
65
  \tpTitle{Title of the heading}
66
  \tpAuthor{Jane Doe}
67
  \tpTocAuthor{The incredible Jane Doe}
68
  \tpRunTitle{Title of the running header}
69
  \tpRunAuthor{Author of the running header}
70
\end{heading}
71
</pre>
72
73
h3. *Note on PDF-Bookmarks*
74
75 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.
76 1 Martin Kraetke
77
h2. List of Figures and List of Tables
78
79
These two listings are marked as normal headings according to the hierarchy level and then the macro for creating the listing follows. 
80
81
<pre>
82
\begin{heading}{section}
83
\tpTitle{My List of Figures}
84
\tpTocTitle{Figures}
85
\tpRunTitle{Lots of Figures}
86
\end{heading}
87
88
\listoffigures
89
</pre>