xerif

Wiki »

Headings » Historie » Revision 3

Revision 2 (Martin Kraetke, 22.12.2021 16:07) → Revision 3/5 (Martin Kraetke, 22.12.2021 16:07)

h1. Headings 

 h2. General Markup Headings in the transpect-tex framework 

 <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 
 * @\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>: = (Author | Number | Subtitle | Title)@: @\tpRun <Macro>@ (for running headers), @\tpToc<Macro> @(for IHV), and @\tpBM <Macro>@ (for PDF bookmarks). 
 ** 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. 
 ** If \tpBM is not used, the content of @\tpToc<Makro>@ is used instead 
 ** If @\tp(Run|Toc|BM)<Macro>{<Text>}@ is used, @<text>@ instead of the content von @\tp(Toc)<Makro>@ is used 
 ** if @\tp(Run|Toc|BM)<Makro>{}@ is used with empty argument, there is 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 Unicode Text for this macro. 

 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>