| 1 |
% \iffalse meta-comment |
| 2 |
%/GitFileInfo=tudscr-doc.dtx |
| 3 |
% |
| 4 |
% TUD-Script -- Corporate Design of Technische Universität Dresden |
| 5 |
% ---------------------------------------------------------------------------- |
| 6 |
% |
| 7 |
% Copyright (C) Falk Hanisch <[email protected]>, 2012-2022 |
| 8 |
% |
| 9 |
% ---------------------------------------------------------------------------- |
| 10 |
% |
| 11 |
% This work may be distributed and/or modified under the conditions of the |
| 12 |
% LaTeX Project Public License, either version 1.3c of this license or |
| 13 |
% any later version. The latest version of this license is in |
| 14 |
% http://www.latex-project.org/lppl.txt |
| 15 |
% and version 1.3c or later is part of all distributions of |
| 16 |
% LaTeX version 2008-05-04 or later. |
| 17 |
% |
| 18 |
% This work has the LPPL maintenance status "maintained". |
| 19 |
% |
| 20 |
% The current maintainer and author of this work is Falk Hanisch. |
| 21 |
% |
| 22 |
% ---------------------------------------------------------------------------- |
| 23 |
% |
| 24 |
% \fi |
| 25 |
% |
| 26 |
% \iffalse ins:batch + dtx:driver |
| 27 |
%<*ins> |
| 28 |
\ifx\documentclass\undefined |
| 29 |
\input docstrip.tex |
| 30 |
\ifToplevel{\batchinput{tudscr.ins}} |
| 31 |
\else |
| 32 |
\let\endbatchfile\relax |
| 33 |
\fi |
| 34 |
\endbatchfile |
| 35 |
%</ins> |
| 36 |
%<*dtx> |
| 37 |
\ProvidesFile{tudscr-doc.dtx}[2022/08/09] |
| 38 |
\RequirePackage{tudscr-gitinfo} |
| 39 |
\documentclass[english,ngerman,xindy]{tudscrdoc} |
| 40 |
\iftutex |
| 41 |
\usepackage{fontspec} |
| 42 |
\else |
| 43 |
\usepackage[T1]{fontenc} |
| 44 |
\usepackage[ngerman=ngerman-x-latest]{hyphsubst} |
| 45 |
\fi |
| 46 |
\usepackage{babel} |
| 47 |
\usepackage{tudscrfonts} |
| 48 |
\usepackage[babel]{microtype} |
| 49 |
|
| 50 |
\GitHubBase{\TUDScriptRepository} |
| 51 |
\begin{document} |
| 52 |
\author{Falk Hanisch\TUDScriptContactTitle} |
| 53 |
\maketitle |
| 54 |
\tableofcontents |
| 55 |
\DocInput{\filename} |
| 56 |
\end{document} |
| 57 |
%</dtx> |
| 58 |
% \fi |
| 59 |
% |
| 60 |
% \selectlanguage{ngerman} |
| 61 |
% |
| 62 |
% \changes{v2.03}{2015/01/09}{\cls{tudscrdoc}: Indextyp Seitenstilebene}^^A |
| 63 |
% \changes{v2.05}{2016/04/21}{Verwendung von \app{texindy} möglich}^^A |
| 64 |
% |
| 65 |
% |
| 66 |
% |
| 67 |
% \section{Die Klasse \cls{tudscrdoc} -- Erweiterte Quelltextdokumentation} |
| 68 |
% |
| 69 |
% Mit dieser Klasse erfolgt die Quelltextdokumentation des \TUDScript-Bundles. |
| 70 |
% Sie lädt standarmäßig die Klasse \cls{ltxdoc}, ersetzt allerdings im Stile |
| 71 |
% von \cls{scrdoc} im Hintergrund \cls{article} durch \cls{scrartcl}. |
| 72 |
% |
| 73 |
% \iffalse |
| 74 |
%<*class&option> |
| 75 |
% \fi |
| 76 |
% |
| 77 |
% Damit der zu \cls{scrartcl} gehörige Titel genutzt werden kann, wird dieser |
| 78 |
% temporär gesichert. |
| 79 |
% \begin{macrocode} |
| 80 |
\newcommand*\scr@maketitle{} |
| 81 |
\PassOptionsToClass{toc=left,fontsize=10pt,parskip=half-}{scrartcl} |
| 82 |
\AfterClass{scrartcl}{\let\scr@maketitle\@maketitle} |
| 83 |
\AfterClass{ltxdoc}{\let\@maketitle\scr@maketitle} |
| 84 |
% \end{macrocode} |
| 85 |
% Der folgende Quelltext ist 1:1 aus \cls{scrdoc} kopiert. |
| 86 |
% \begin{macrocode} |
| 87 |
\newcommand*\tud@saved@LoadClass{} |
| 88 |
\let\tud@saved@LoadClass=\LoadClass |
| 89 |
\renewcommand*\LoadClass[2][]{% |
| 90 |
\begingroup% |
| 91 |
\edef\@tempc{#2}\def\@tempb{article}% |
| 92 |
\ifx\@tempc\@tempb% |
| 93 |
\let\LoadClass\tud@saved@LoadClass% |
| 94 |
\def\@tempc{scrartcl}% |
| 95 |
\fi% |
| 96 |
\edef\@tempc{% |
| 97 |
\endgroup% |
| 98 |
\noexpand\tud@saved@LoadClass[{#1}]{\@tempc}% |
| 99 |
}% |
| 100 |
\@tempc% |
| 101 |
} |
| 102 |
\newcommand*\tud@saved@PassOptionsToClass{} |
| 103 |
\let\tud@saved@PassOptionsToClass=\PassOptionsToClass |
| 104 |
\renewcommand*\PassOptionsToClass[2]{% |
| 105 |
\begingroup% |
| 106 |
\edef\@tempc{#2}\def\@tempb{article}% |
| 107 |
\ifx\@tempc\@tempb% |
| 108 |
\def\@tempc{scrartcl}% |
| 109 |
\fi% |
| 110 |
\edef\@tempc{% |
| 111 |
\endgroup% |
| 112 |
\noexpand\tud@saved@PassOptionsToClass{#1}{\@tempc}% |
| 113 |
}% |
| 114 |
\@tempc% |
| 115 |
} |
| 116 |
\LoadClassWithOptions{ltxdoc}[2015/03/26] |
| 117 |
\setcounter{IndexColumns}{2} |
| 118 |
\setcounter{StandardModuleDepth}{2} |
| 119 |
% \end{macrocode} |
| 120 |
% |
| 121 |
% \subsection{Ignorierte Makros bei der Nutzung von zusätzlichen Indexeinträgen} |
| 122 |
% |
| 123 |
% Befehle, welche bei der Verwendung von \cs{EnableCrossrefs} dennoch nicht im |
| 124 |
% Index erscheinen sollen, müssen mit \cs{DoNotIndex angegeben werden.} |
| 125 |
% |
| 126 |
% \begin{macro}{\DisableCrossrefsForced} |
| 127 |
% \changes{v2.05i}{2017/03/02}{neu}^^A |
| 128 |
% Deaktivieren von Makroeinträgen im Index nach der Verwendung von |
| 129 |
% \cs{EnableCrossrefs}. Sollte in einer Gruppe genutzt werden! |
| 130 |
% \begin{macrocode} |
| 131 |
\newcommand*\DisableCrossrefsForced{} |
| 132 |
\let\DisableCrossrefsForced\DisableCrossrefs |
| 133 |
% \end{macrocode} |
| 134 |
% \end{macro}^^A \DisableCrossrefsForced |
| 135 |
% |
| 136 |
% \subsection{Klassenoptionen} |
| 137 |
% |
| 138 |
% \begin{option}{final} |
| 139 |
% \begin{macro}{\tudfinalflag} |
| 140 |
% Option bzw. Flag für das automatisierte Erzeugen der Quelltextdokumentation |
| 141 |
% mit einem Skript ohne ToDo-Befehle. |
| 142 |
% \begin{macrocode} |
| 143 |
\DeclareOption{final}{\let\tudfinalflag\relax} |
| 144 |
% \end{macrocode} |
| 145 |
% \end{macro}^^A \tudfinalflag |
| 146 |
% \end{option}^^A final |
| 147 |
% \begin{option}{texindy} |
| 148 |
% \changes{v2.05}{2016/04/21}{neu}^^A |
| 149 |
% \begin{option}{xindy} |
| 150 |
% \changes{v2.05}{2016/04/21}{neu}^^A |
| 151 |
% \begin{option}{xdy} |
| 152 |
% \changes{v2.05}{2016/04/21}{neu}^^A |
| 153 |
% \begin{macro}{\tudxdyflag} |
| 154 |
% \changes{v2.05}{2016/04/21}{neu}^^A |
| 155 |
% Option(en) für das Erstellen der Indexdateien im Stil von \app{texindy}. |
| 156 |
% \begin{macrocode} |
| 157 |
\DeclareOption{texindy}{\let\tudxdyflag\relax} |
| 158 |
\DeclareOption{xindy}{\let\tudxdyflag\relax} |
| 159 |
\DeclareOption{xdy}{\let\tudxdyflag\relax} |
| 160 |
% \end{macrocode} |
| 161 |
% \end{macro}^^A \tudxdyflag |
| 162 |
% \end{option}^^A xdy |
| 163 |
% \end{option}^^A xindy |
| 164 |
% \end{option}^^A texindy |
| 165 |
% Die beiden Optionen werden abgearbeitet |
| 166 |
% \begin{macrocode} |
| 167 |
\ProcessOptions\relax |
| 168 |
% \end{macrocode} |
| 169 |
% |
| 170 |
% \iffalse |
| 171 |
%</class&option> |
| 172 |
%<*class&body> |
| 173 |
% \fi |
| 174 |
% |
| 175 |
% \subsection{Standardwerte für Titelei, Absatzauszeichnung und Index} |
| 176 |
% |
| 177 |
% Folgende Werte sind standardmäßig für den Titel eingestellt, können aber |
| 178 |
% jederzeit überschrieben werden. |
| 179 |
% \begin{macrocode} |
| 180 |
\AtEndOfClass{% |
| 181 |
\@ifpackageloaded{tudscr-gitinfo}{% |
| 182 |
\GetFileInfo{\jobname}% |
| 183 |
\title{\file{\filename}}% |
| 184 |
\date{% |
| 185 |
\filedate% |
| 186 |
\ifdefvoid{\fileversion}{}{\nobreakspace\fileversion}% |
| 187 |
\ifdefvoid{\filerevision}{}{\nobreakspace\texttt{\filerevision}}% |
| 188 |
}% |
| 189 |
}{}% |
| 190 |
\CodelineIndex% |
| 191 |
\RecordChanges% |
| 192 |
} |
| 193 |
% \end{macrocode} |
| 194 |
% Wurde in der Präambel \cs{GetFileInfo} nicht aufgerufen, dann erfolgt dies zu |
| 195 |
% Beginn des Dokumentes. |
| 196 |
% \begin{macrocode} |
| 197 |
\AtBeginDocument{% |
| 198 |
\ifdefvoid{\filename}{% |
| 199 |
\IfFileExists{\jobname.dtx}{% |
| 200 |
\edef\filename{\jobname.dtx}% |
| 201 |
}{% |
| 202 |
\edef\filename{\jobname.tex}% |
| 203 |
}% |
| 204 |
\undef\filedate% |
| 205 |
\undef\fileversion% |
| 206 |
\undef\filerevision% |
| 207 |
\undef\fileinfo% |
| 208 |
\expandafter\GetFileInfo\expandafter{\filename}% |
| 209 |
}{}% |
| 210 |
\ifdefvoid{\filerevision}{\let\filerevision\@empty}{}% |
| 211 |
} |
| 212 |
% \end{macrocode} |
| 213 |
% |
| 214 |
% \subsection{Seitenstil} |
| 215 |
% |
| 216 |
% \begin{macro}{\@docinclude} |
| 217 |
% \begin{macro}{\ps@tudscrdoc} |
| 218 |
% Die Auswahl des Seitenstils wird im Vergleich zur Klasse \cls{ltxdoc} |
| 219 |
% verbessert und an das Paket \pkg{tudscr-gitinfo} angepasst. |
| 220 |
% \begin{macrocode} |
| 221 |
\pretocmd\@docinclude{% |
| 222 |
\GetFileInfo{#1}\pagestyle{tudscrdoc}% |
| 223 |
}{}{\tud@patch@wrn{@docinclude}} |
| 224 |
\def\ps@tudscrdoc{% |
| 225 |
\let\@mkboth\@gobbletwo% |
| 226 |
\let\@oddhead\@empty% |
| 227 |
\let\@evenhead\@empty% |
| 228 |
\def\@oddfoot{% |
| 229 |
File\ifnum\c@part>\z@\nobreakspace\thepart\fi:% |
| 230 |
\nobreakspace\texttt{\ifdefvoid{\filename}{?}{\filename}}% |
| 231 |
\enskip Version:\nobreakspace\ifdefvoid{\filedate}{?}{\filedate}% |
| 232 |
\ifdefvoid{\fileversion}{}{\nobreakspace\fileversion}% |
| 233 |
\ifdefvoid{\filerevision}{}{\enskip\texttt{\filerevision}}% |
| 234 |
\hfill\thepage% |
| 235 |
}% |
| 236 |
\def\@evenfoot{\@oddfoot}% |
| 237 |
} |
| 238 |
\pagestyle{tudscrdoc}% |
| 239 |
\let\ps@titlepage\ps@tudscrdoc% |
| 240 |
% \end{macrocode} |
| 241 |
% \end{macro}^^A \ps@tudscrdoc |
| 242 |
% \end{macro}^^A \@docinclude |
| 243 |
% |
| 244 |
% \subsection{Definition und Erscheinungsbild von Deklarationselementen} |
| 245 |
% |
| 246 |
% Das Paket~\pkg{doc} stellt die Funktionalitäten zur Quelltextdokumentation |
| 247 |
% innerhalb von \file{.dtx}-Dateien bereit. Mit \pkg{doc}~|v3.0| ist es |
| 248 |
% zusätzlich möglich, mit \cs{NewDocElement} weitere Deklarationselemente zu |
| 249 |
% erstellen. Allerdings wird für die Anpassung des Erscheinungsbildes der |
| 250 |
% Indexeinträge keine Schnittstelle bereitgestellt, weshalb im Folgenden einige |
| 251 |
% Patches notwendig sind. |
| 252 |
% |
| 253 |
% \subsubsection{Randnotizen und multiple Erläuterungen} |
| 254 |
% |
| 255 |
% Das Paket~\pkg{doc} stellt mit |\Describe|\meta{Typ} Befehle für die |
| 256 |
% Erläuterung einzelner Deklarationselemente bereit. Sollen gleich mehrere |
| 257 |
% Elemente in einem Abschnitt erläutert werden, fehlt jedoch die entsprechende |
| 258 |
% Schnittstelle, weshalb zusätzlich die Befehle |\Describe|\meta{Typ}|s| |
| 259 |
% darauf aufbauend definiert werden. |
| 260 |
% |
| 261 |
% \begin{length}{\tud@dim@marginnotevskip} |
| 262 |
% \changes{v2.05i}{2017/03/09}{neu}^^A |
| 263 |
% \begin{macro}{\marginpar} |
| 264 |
% Da die Befehle |\Describe|\meta{Typ} zur Erzeugung einer Randnotiz für |
| 265 |
% jeden Eintrag \cs{marginpar} verwenden, müssen diese mit einem vertikalen |
| 266 |
% Versatz gesetzt werden, falls gleich mehrere auf einmal zu erzeugen sind. |
| 267 |
% Hierfür wird das Paket~\pkg{marginnote} genutzt. |
| 268 |
% \begin{macrocode} |
| 269 |
\tud@newdim\tud@dim@marginnotevskip |
| 270 |
\AfterPackage*{marginnote}{% |
| 271 |
\renewcommand*\marginpar[2][]{% |
| 272 |
\IfArgIsEmpty{#1}{% |
| 273 |
\marginnote{#2}[\tud@dim@marginnotevskip]% |
| 274 |
}{% |
| 275 |
\marginnote[{#1}]{#2}[\tud@dim@marginnotevskip]% |
| 276 |
}% |
| 277 |
}% |
| 278 |
} |
| 279 |
% \end{macrocode} |
| 280 |
% \end{macro}^^A \marginpar |
| 281 |
% \end{length}^^A \tud@dim@marginnotevskip |
| 282 |
% \begin{macro}{\doc@createdescribes} |
| 283 |
% \changes{v2.05i}{2017/03/09}{neu}^^A |
| 284 |
% Die Definition für |\Describe|\meta{Typ}|s|. Die so erzeugten Befehle passen |
| 285 |
% für jeden neuen Eintrag die Länge \cs{marginnotevskip} selbstständig an. Für |
| 286 |
% jeden angegebenen Eintrag |\Describe|\meta{Typ}|s|\oarg{...}\marg{Element(e)} |
| 287 |
% wird an |\Describe|\meta{Typ}\oarg{...}\marg{Element} das optionale Argument |
| 288 |
% durchgereicht. Erzeugt werden Befehle via \cs{@NewDocElement}. |
| 289 |
% \begin{macrocode} |
| 290 |
\newcommand*\doc@createdescribes[1]{% |
| 291 |
\expandafter\newcommand\expandafter*\csname Describe#1s\endcsname[2][]{% |
| 292 |
\tud@setdim\tud@dim@marginnotevskip{\z@}% |
| 293 |
\def\@tempc{##2}% |
| 294 |
\@for\@tempa:=\@tempc\do{% |
| 295 |
\trim@spaces@in\@tempa% |
| 296 |
\ifx\@tempa\@empty\else% |
| 297 |
\def\@tempb{\@nameuse{Describe#1}[{##1}]}% |
| 298 |
\expandafter\@tempb\expandafter{\@tempa}% |
| 299 |
\tud@addtodim\tud@dim@marginnotevskip{1\baselineskip}% |
| 300 |
\fi% |
| 301 |
}% |
| 302 |
\tud@setdim\tud@dim@marginnotevskip{\z@}% |
| 303 |
\ignorespaces% |
| 304 |
}% |
| 305 |
} |
| 306 |
% \end{macrocode} |
| 307 |
% \end{macro}^^A \doc@createdescribes |
| 308 |
% \begin{macro}{\tud@idx@typemarkup} |
| 309 |
% \changes{v2.05g}{2016/11/10}{neu}^^A |
| 310 |
% \changes{v2.06o}{2022/07/20}{Anpassungen für \pkg{doc}}^^A |
| 311 |
% Dieses Makro dient zur Formatierung des Typen der Deklarationselemente in |
| 312 |
% Index, Änderungsliste und Randnotizen. |
| 313 |
% \begin{macrocode} |
| 314 |
\NewDocumentCommand{\tud@idx@typemarkup}{r()}{% |
| 315 |
\begingroup% |
| 316 |
\normalfont\scriptsize\space(#1)% |
| 317 |
\endgroup% |
| 318 |
} |
| 319 |
% \end{macrocode} |
| 320 |
% \end{macro}^^A \tud@idx@typemarkup |
| 321 |
% \begin{macro}{\@NewDocElement} |
| 322 |
% \changes{v2.06o}{2022/07/20}{neu}^^A |
| 323 |
% Erzeugen der Befehle von |\Describe|\meta{Typ}|s|\oarg{...}\marg{Element(e)}. |
| 324 |
% Weiterhin werden für die Verwendung von \cls{ltxdoc} und \pkg{hypdoc} |
| 325 |
% \hrfn{https://github.com/latex3/latex2e/issues/900}{einige Bugs} gefixt. |
| 326 |
% \begin{macrocode} |
| 327 |
\AtBeginDocument{\let\PrintMacroName\@@PrintMacroName} |
| 328 |
\apptocmd\@NewDocElement{% |
| 329 |
\doc@createdescribes{#2}% |
| 330 |
\csletcs{@@PrintDescribe#2}{PrintDescribe#2}% |
| 331 |
\csletcs{@@Print#2Name}{Print#2Name}% |
| 332 |
\csletcs{@@SpecialMain#2Index}{SpecialMain#2Index}% |
| 333 |
\csletcs{@@Special#2Index}{Special#2Index}% |
| 334 |
}{}{\tud@patch@wrn{@NewDocElement}} |
| 335 |
% \end{macrocode} |
| 336 |
% Hiermit wird die Formatierung des Elementtyps bei Deklarationen angepasst. |
| 337 |
% Zu beachten ist, das zusätzlich zur ursprünglichen Definition \cs{strut} zum |
| 338 |
% Schluss (nochmals) ausgeführt wird. Somit lassen sich potenzielle Probleme |
| 339 |
% mit dem Paket \pkg{microtype} vermeiden. |
| 340 |
% \begin{macrocode} |
| 341 |
\patchcmd\@NewDocElement{% |
| 342 |
\@temptokena\expandafter{% |
| 343 |
\expandafter\textnormal\expandafter{% |
| 344 |
\expandafter\space\expandafter(\doc@printtype)% |
| 345 |
}% |
| 346 |
}% |
| 347 |
}{% |
| 348 |
\@temptokena\expandafter{% |
| 349 |
\expandafter\textnormal\expandafter{% |
| 350 |
\expandafter\tud@idx@typemarkup\expandafter(\doc@printtype)\strut% |
| 351 |
}% |
| 352 |
}% |
| 353 |
}{}{\tud@patch@wrn{@NewDocElement}} |
| 354 |
% \end{macrocode} |
| 355 |
% \end{macro}^^A \@NewDocElement |
| 356 |
% |
| 357 |
% \subsubsection{Erweiterte Einträge für Index und Änderungsliste} |
| 358 |
% |
| 359 |
% \begin{macro}{\tud@idx@sortkey} |
| 360 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 361 |
% \begin{macro}{\tud@idx@format} |
| 362 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 363 |
% \begin{macro}{\tud@idx@element} |
| 364 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 365 |
% \begin{macro}{\tud@idx@parent} |
| 366 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 367 |
% \changes{v2.06o}{2022/07/20}{Anpassungen für \pkg{doc}}^^A |
| 368 |
% Mit diesen Befehlen kann beim Erzeugen von Einträgen für die Änderungsliste |
| 369 |
% auf die zuvor bereits erzeugten Indexeinträge zurückggegriffen werden. Ein |
| 370 |
% zuvor erzeugter Elterneintrag wird mit Sortierschlüssel und der eigentlichen |
| 371 |
% Formatierung in zwei Token in \cs{tud@idx@parent} expandiert, um später |
| 372 |
% darauf zurückgreifen zu können~-- dies ist insbesondere für Parameter nötig. |
| 373 |
% \begin{macrocode} |
| 374 |
\newcommand*\tud@idx@sortkey{} |
| 375 |
\let\tud@idx@sortkey\relax |
| 376 |
\newcommand*\tud@idx@format{} |
| 377 |
\let\tud@idx@format\relax |
| 378 |
\newcommand*\tud@idx@element{} |
| 379 |
\let\tud@idx@element\relax |
| 380 |
\newcommand*\tud@idx@parent{} |
| 381 |
\let\tud@idx@parent\relax |
| 382 |
% \end{macrocode} |
| 383 |
% \end{macro}^^A \tud@idx@parent |
| 384 |
% \end{macro}^^A \tud@idx@element |
| 385 |
% \end{macro}^^A \tud@idx@format |
| 386 |
% \end{macro}^^A \tud@idx@sortkey |
| 387 |
% \begin{macro}{\doc@createspecialindexes} |
| 388 |
% \changes{v2.06o}{2022/07/20}{neu}^^A |
| 389 |
% \begin{macro}{\doc@createspecialmacrolikeindexes} |
| 390 |
% \changes{v2.06o}{2022/07/20}{neu}^^A |
| 391 |
% Für den Index muss bei diesen Makros eine Anpassung erfolgen, damit die |
| 392 |
% Sortierung auch bei der Verwendung von \app{texindy} richtig erfolgt und |
| 393 |
% keine Einträge, welche es trotz gleicher Bezeichnung für unterschiedliche |
| 394 |
% Deklarationselemente (beispielsweise gleichnamige Umgebungen und Optionen) |
| 395 |
% gibt, unterschlagen werden. Deshalb wird den erzeugten Sortierschlüsseln die |
| 396 |
% Ausgabe des Deklarationstyps aus |#2| respektive |\@temptokena| hinzugefügt. |
| 397 |
% Außerdem wird der Markupbefehl \cs{tud@idx@typemarkup} für diese eingehangen. |
| 398 |
% |
| 399 |
% Weiterhin werden das Deklarationselement in \cs{tud@idx@element} sowie der |
| 400 |
% Sortierschlüssel in \cs{tud@idx@sortkey} und der formatierte Indexeintrag in |
| 401 |
% \cs{tud@idx@format} gesichert, um diese sowohl in der Änderungsliste als auch |
| 402 |
% für eigens definierte Elterneinträge (\cs{tud@idx@parent}) nutzen zu können. |
| 403 |
% \begin{macrocode} |
| 404 |
\CheckCommand*\doc@createspecialindexes[3]{% |
| 405 |
\@temptokena{\space (#2)}% |
| 406 |
\@temptokenb{#3:}% |
| 407 |
\@nameedef{SpecialMain#1Index}##1{% |
| 408 |
\noexpand\@bsphack |
| 409 |
\ifdoc@toplevel |
| 410 |
\noexpand\special@index{% |
| 411 |
##1\noexpand\actualchar{\string\ttfamily\space##1}% |
| 412 |
\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 413 |
\noexpand\encapchar main% |
| 414 |
}% |
| 415 |
\fi |
| 416 |
\ifx\@nil#3\@nil\else |
| 417 |
\noexpand\special@index{% |
| 418 |
\the\@temptokenb\noexpand\levelchar |
| 419 |
##1\noexpand\actualchar{\string\ttfamily\space##1}% |
| 420 |
\noexpand\encapchar main% |
| 421 |
}% |
| 422 |
\fi |
| 423 |
\noexpand\@esphack% |
| 424 |
}% |
| 425 |
\@nameedef{Special#1Index}##1{% |
| 426 |
\noexpand\@bsphack |
| 427 |
\ifdoc@toplevel |
| 428 |
\noexpand\doc@providetarget |
| 429 |
\noexpand\index{% |
| 430 |
##1\noexpand\actualchar{\string\ttfamily\space##1}% |
| 431 |
\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 432 |
\noexpand\doc@handleencap{usage}% |
| 433 |
}% |
| 434 |
\fi |
| 435 |
\ifx\@nil#3\@nil\else |
| 436 |
\noexpand\index{% |
| 437 |
\the\@temptokenb\noexpand\levelchar |
| 438 |
##1\noexpand\actualchar{\string\ttfamily\space##1}% |
| 439 |
\noexpand\doc@handleencap{usage}% |
| 440 |
}% |
| 441 |
\fi |
| 442 |
\noexpand\@esphack% |
| 443 |
}% |
| 444 |
} |
| 445 |
\renewcommand*\doc@createspecialindexes[3]{% |
| 446 |
\@temptokena{\space (#2)}% |
| 447 |
\@temptokenb{#3:}% |
| 448 |
\@nameedef{SpecialMain#1Index}##1{% |
| 449 |
\noexpand\@bsphack |
| 450 |
\ifdoc@toplevel |
| 451 |
\noexpand\special@index{% |
| 452 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 453 |
##1\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 454 |
\noexpand\actualchar{\string\ttfamily\space##1}% |
| 455 |
% PATCH: add `\tud@idx@typemarkup' for markup |
| 456 |
\ifx\@nil#2\@nil\else\noexpand\tud@idx@typemarkup\the\@temptokena\fi |
| 457 |
\noexpand\encapchar main% |
| 458 |
}% |
| 459 |
\fi |
| 460 |
\ifx\@nil#3\@nil\else |
| 461 |
\noexpand\special@index{% |
| 462 |
\the\@temptokenb\noexpand\levelchar |
| 463 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 464 |
##1\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 465 |
\noexpand\actualchar{\string\ttfamily\space##1}% |
| 466 |
\noexpand\encapchar main% |
| 467 |
}% |
| 468 |
\fi |
| 469 |
\noexpand\@esphack% |
| 470 |
% \end{macrocode} |
| 471 |
% Bei allen Varianten der Indexeinträge werden diese nach dem Erstellen |
| 472 |
% gesichert, um diese in der richtigen Formatierung als Elterneinträge |
| 473 |
% für Parameter im Index sowie für die Änderungsliste nutzen zu können. |
| 474 |
% \begin{macrocode} |
| 475 |
% PATCH: assign used sort key and formatted entry to dedicated macros |
| 476 |
\gdef\noexpand\tud@idx@sortkey{##1\ifx\@nil#2\@nil\else\the\@temptokena\fi}% |
| 477 |
\gdef\noexpand\tud@idx@format{% |
| 478 |
{\string\ttfamily\space##1}% |
| 479 |
\ifx\@nil#2\@nil\else\noexpand\tud@idx@typemarkup\the\@temptokena\fi |
| 480 |
}% |
| 481 |
% PATCH: reset settings for nested index and changelog entries |
| 482 |
\gdef\noexpand\tud@idx@element{#1}% |
| 483 |
\global\let\noexpand\tud@idx@parent\relax% |
| 484 |
}% |
| 485 |
\@nameedef{Special#1Index}##1{% |
| 486 |
\noexpand\@bsphack |
| 487 |
\ifdoc@toplevel |
| 488 |
\noexpand\doc@providetarget |
| 489 |
\noexpand\index{% |
| 490 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 491 |
##1\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 492 |
\noexpand\actualchar{\string\ttfamily\space##1}% |
| 493 |
% PATCH: add `\tud@idx@typemarkup' for markup |
| 494 |
\ifx\@nil#2\@nil\else\noexpand\tud@idx@typemarkup\the\@temptokena\fi |
| 495 |
\noexpand\doc@handleencap{usage}% |
| 496 |
}% |
| 497 |
\fi |
| 498 |
\ifx\@nil#3\@nil\else |
| 499 |
\noexpand\index{% |
| 500 |
\the\@temptokenb\noexpand\levelchar |
| 501 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 502 |
##1\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 503 |
\noexpand\actualchar{\string\ttfamily\space##1}% |
| 504 |
\noexpand\doc@handleencap{usage}% |
| 505 |
}% |
| 506 |
\fi |
| 507 |
\noexpand\@esphack% |
| 508 |
% PATCH: assign used sort key and formatted entry to dedicated macros |
| 509 |
\gdef\noexpand\tud@idx@sortkey{##1\ifx\@nil#2\@nil\else\the\@temptokena\fi}% |
| 510 |
\gdef\noexpand\tud@idx@format{% |
| 511 |
{\string\ttfamily\space##1}% |
| 512 |
\ifx\@nil#2\@nil\else\noexpand\tud@idx@typemarkup\the\@temptokena\fi |
| 513 |
}% |
| 514 |
% PATCH: reset settings for nested index and changelog entries |
| 515 |
\gdef\noexpand\tud@idx@element{#1}% |
| 516 |
\global\let\noexpand\tud@idx@parent\relax% |
| 517 |
}% |
| 518 |
} |
| 519 |
\CheckCommand*\doc@createspecialmacrolikeindexes[3]{% |
| 520 |
\@temptokena{\space (#2)}% |
| 521 |
\@temptokenb{#3:}% |
| 522 |
\@nameedef{Code#1Index}##1##2{% |
| 523 |
\noexpand\@SpecialIndexHelper@##2\noexpand\@nil |
| 524 |
\noexpand\@bsphack |
| 525 |
\noexpand\ifdoc@noindex\noexpand\else |
| 526 |
\ifdoc@toplevel |
| 527 |
\noexpand\special@index{% |
| 528 |
\noexpand\@gtempa\noexpand\actualchar |
| 529 |
\string\verb% % to fool emacs highlighting |
| 530 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 531 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 532 |
\ifx\@nil#2\@nil\else \the\@temptokena \fi |
| 533 |
\noexpand\encapchar ##1% |
| 534 |
}% |
| 535 |
\fi |
| 536 |
\ifx\@nil#3\@nil\else |
| 537 |
\noexpand\special@index{% |
| 538 |
\the\@temptokenb\noexpand\levelchar |
| 539 |
\noexpand\@gtempa\noexpand\actualchar |
| 540 |
\string\verb% % to fool emacs highlighting |
| 541 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 542 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 543 |
\noexpand\encapchar ##1% |
| 544 |
}% |
| 545 |
\fi |
| 546 |
\noexpand\fi |
| 547 |
\noexpand\@esphack% |
| 548 |
}% |
| 549 |
\@nameedef{SpecialMain#1Index}##1{% |
| 550 |
\expandafter\noexpand\csname Code#1Index\endcsname{main}{##1}% |
| 551 |
}% |
| 552 |
\@nameedef{Special#1Index}##1{% |
| 553 |
\noexpand\@SpecialIndexHelper@##1\noexpand\@nil |
| 554 |
\noexpand\@bsphack |
| 555 |
\noexpand\ifdoc@noindex\noexpand\else |
| 556 |
\ifdoc@toplevel |
| 557 |
\noexpand\doc@providetarget |
| 558 |
\noexpand\index{% |
| 559 |
\noexpand\@gtempa\noexpand\actualchar |
| 560 |
\string\verb% % to fool emacs highlighting |
| 561 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 562 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 563 |
\ifx\@nil#2\@nil\else \the\@temptokena \fi |
| 564 |
\noexpand\doc@handleencap{usage}% |
| 565 |
}% |
| 566 |
\fi |
| 567 |
\ifx\@nil#3\@nil\else |
| 568 |
\noexpand\index{% |
| 569 |
\the\@temptokenb\noexpand\levelchar |
| 570 |
\noexpand\@gtempa\noexpand\actualchar |
| 571 |
\string\verb% % to fool emacs highlighting |
| 572 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 573 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 574 |
\noexpand\doc@handleencap{usage}% |
| 575 |
}% |
| 576 |
\fi |
| 577 |
\noexpand\fi |
| 578 |
\noexpand\@esphack% |
| 579 |
}% |
| 580 |
} |
| 581 |
\renewcommand*\doc@createspecialmacrolikeindexes[3]{% |
| 582 |
\@temptokena{\space (#2)}% |
| 583 |
\@temptokenb{#3:}% |
| 584 |
\@nameedef{Code#1Index}##1##2{% |
| 585 |
\noexpand\@SpecialIndexHelper@##2\noexpand\@nil |
| 586 |
\noexpand\@bsphack |
| 587 |
\noexpand\ifdoc@noindex\noexpand\else |
| 588 |
\ifdoc@toplevel |
| 589 |
\noexpand\special@index{% |
| 590 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 591 |
\noexpand\@gtempa\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 592 |
\noexpand\actualchar |
| 593 |
\string\verb% % to fool emacs highlighting |
| 594 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 595 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 596 |
% PATCH: add `\tud@idx@typemarkup' for markup |
| 597 |
\ifx\@nil#2\@nil\else\noexpand\tud@idx@typemarkup\the\@temptokena\fi |
| 598 |
\noexpand\encapchar ##1% |
| 599 |
}% |
| 600 |
\fi |
| 601 |
\ifx\@nil#3\@nil\else |
| 602 |
\noexpand\special@index{% |
| 603 |
\the\@temptokenb\noexpand\levelchar |
| 604 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 605 |
\noexpand\@gtempa\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 606 |
\noexpand\actualchar |
| 607 |
\string\verb% % to fool emacs highlighting |
| 608 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 609 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 610 |
\noexpand\encapchar ##1% |
| 611 |
}% |
| 612 |
\fi |
| 613 |
\noexpand\fi |
| 614 |
\noexpand\@esphack% |
| 615 |
}% |
| 616 |
% \end{macrocode} |
| 617 |
% Für das Sichern der Indexeinträge muss ein bisschen mit der Expansion der |
| 618 |
% Makros gezaubert werden. Der in \cs{@gtempa} relevante Teil für den Index |
| 619 |
% ist erst nach der Expansion (via \cs{doc@expr}) verfügbar, muss aber in einer |
| 620 |
% zweiten Expansion aus eben diesem Makro expandiert werden. Wiederum muss der |
| 621 |
% Teil aus |\ifx\@nil#2\@nil\else\the\@temptokena\fi| hier direkt expandiert |
| 622 |
% werden und wird danach vor weiterer Expansion geschützt! |
| 623 |
% \begin{macrocode} |
| 624 |
\@nameedef{SpecialMain#1Index}##1{% |
| 625 |
\expandafter\noexpand\csname Code#1Index\endcsname{main}{##1}% |
| 626 |
% PATCH: assign used sort key and formatted entry to dedicated macros |
| 627 |
\xdef\noexpand\tud@idx@sortkey{% |
| 628 |
\noexpand\expandonce\noexpand\@gtempa% |
| 629 |
\ifx\@nil#2\@nil\else\noexpand\unexpanded{\the\@temptokena}\fi% |
| 630 |
}% |
| 631 |
\xdef\noexpand\tud@idx@format{% |
| 632 |
\unexpanded{\noexpand\string\noexpand\verb}% |
| 633 |
\unexpanded{\noexpand\quotechar*\noexpand\verbatimchar}% |
| 634 |
\unexpanded{\noexpand\bslash}\noexpand\expandonce\noexpand\@gtempa% |
| 635 |
\unexpanded{\noexpand\verbatimchar}% |
| 636 |
\ifx\@nil#2\@nil\else |
| 637 |
\noexpand\unexpanded{\noexpand\tud@idx@typemarkup\the\@temptokena}% |
| 638 |
\fi |
| 639 |
}% |
| 640 |
% PATCH: reset settings for nested index and changelog entries |
| 641 |
\gdef\noexpand\tud@idx@element{#1}% |
| 642 |
\global\let\noexpand\tud@idx@parent\relax |
| 643 |
}% |
| 644 |
\@nameedef{Special#1Index}##1{% |
| 645 |
\noexpand\@SpecialIndexHelper@##1\noexpand\@nil |
| 646 |
\noexpand\@bsphack |
| 647 |
\noexpand\ifdoc@noindex\noexpand\else |
| 648 |
\ifdoc@toplevel |
| 649 |
\noexpand\doc@providetarget |
| 650 |
\noexpand\index{% |
| 651 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 652 |
\noexpand\@gtempa\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 653 |
\noexpand\actualchar |
| 654 |
\string\verb% % to fool emacs highlighting |
| 655 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 656 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 657 |
% PATCH: add `\tud@idx@typemarkup' for markup |
| 658 |
\ifx\@nil#2\@nil\else\noexpand\tud@idx@typemarkup\the\@temptokena\fi |
| 659 |
\noexpand\doc@handleencap{usage}% |
| 660 |
}% |
| 661 |
\fi |
| 662 |
\ifx\@nil#3\@nil\else |
| 663 |
\noexpand\index{% |
| 664 |
\the\@temptokenb\noexpand\levelchar |
| 665 |
% PATCH: add `\the\@temptokena' to sorting argument |
| 666 |
\noexpand\@gtempa\ifx\@nil#2\@nil\else\the\@temptokena\fi |
| 667 |
\noexpand\actualchar |
| 668 |
\string\verb% % to fool emacs highlighting |
| 669 |
\noexpand\quotechar*\noexpand\verbatimchar |
| 670 |
\noexpand\bslash\noexpand\@gtempa\noexpand\verbatimchar |
| 671 |
\noexpand\doc@handleencap{usage}% |
| 672 |
}% |
| 673 |
\fi |
| 674 |
\noexpand\fi |
| 675 |
\noexpand\@esphack% |
| 676 |
% \end{macrocode} |
| 677 |
% Zur Sicherung der Indexeinträge das selbe Spiel für die Expansion wie zuvor. |
| 678 |
% \begin{macrocode} |
| 679 |
% PATCH: assign used sort key and formatted entry to dedicated macros |
| 680 |
\xdef\noexpand\tud@idx@sortkey{% |
| 681 |
\noexpand\expandonce\noexpand\@gtempa% |
| 682 |
\ifx\@nil#2\@nil\else\noexpand\unexpanded{\the\@temptokena}\fi% |
| 683 |
}% |
| 684 |
\xdef\noexpand\tud@idx@format{% |
| 685 |
\unexpanded{\noexpand\string\noexpand\verb}% |
| 686 |
\unexpanded{\noexpand\quotechar*\noexpand\verbatimchar}% |
| 687 |
\unexpanded{\noexpand\bslash}\noexpand\expandonce\noexpand\@gtempa% |
| 688 |
\unexpanded{\noexpand\verbatimchar}% |
| 689 |
\ifx\@nil#2\@nil\else |
| 690 |
\noexpand\unexpanded{\noexpand\tud@idx@typemarkup\the\@temptokena}% |
| 691 |
\fi |
| 692 |
}% |
| 693 |
% PATCH: reset settings for nested index and changelog entries |
| 694 |
\gdef\noexpand\tud@idx@element{#1}% |
| 695 |
\global\let\noexpand\tud@idx@parent\relax |
| 696 |
}% |
| 697 |
} |
| 698 |
% \end{macrocode} |
| 699 |
% \end{macro}^^A \doc@createspecialmacrolikeindexes |
| 700 |
% \end{macro}^^A \doc@createspecialindexes |
| 701 |
% |
| 702 |
% \subsubsection{Erstellen aller Deklarationselemente} |
| 703 |
% |
| 704 |
% Nachdem nun die Anpassungen für die Änderungsliste erfolgt sind, können nun |
| 705 |
% die für die Dokumentation notwendigen Umgebungen mit \cs{NewDocElement} |
| 706 |
% erstellt werden, wobei die Lokalisierungsvariablen |\tud@|\meta{\dots}|@name| |
| 707 |
% zum Tragen kommen. |
| 708 |
% \begin{macrocode} |
| 709 |
\def\tud@res@a#1{% |
| 710 |
\kernel@ifnextchar[%] |
| 711 |
{\tud@res@b{#1}}{\tud@res@b{#1}[]}% |
| 712 |
} |
| 713 |
\def\tud@res@b#1[#2]#3#4{% |
| 714 |
#1[{% |
| 715 |
idxgroup=\csname tud@#4s@name\endcsname,% |
| 716 |
idxtype=\csname tud@#4@name\endcsname,% |
| 717 |
printtype=\csname tud@#4@name\endcsname,% |
| 718 |
#2% |
| 719 |
}]{#3}{#4}% |
| 720 |
} |
| 721 |
\tud@res@a\RenewDocElement[macrolike,idxgroup,idxtype,printtype]{Macro}{macro} |
| 722 |
\tud@res@a\RenewDocElement{Env}{environment} |
| 723 |
\tud@res@a\NewDocElement{Option}{option} |
| 724 |
\tud@res@a\NewDocElement{LayerPageStyle}{layerpagestyle} |
| 725 |
\tud@res@a\NewDocElement{Layer}{layer} |
| 726 |
\tud@res@a\NewDocElement[macrolike]{Length}{length} |
| 727 |
\tud@res@a\NewDocElement{Counter}{counter} |
| 728 |
\tud@res@a\NewDocElement{Color}{TUDcolor} |
| 729 |
\tud@res@a\NewDocElement[macrolike]{Localization}{localization} |
| 730 |
\tud@res@a\NewDocElement[macrolike]{Field}{field} |
| 731 |
\tud@res@a\NewDocElement{Font}{KOMAfont} |
| 732 |
\tud@res@a\NewDocElement{Parameter}{parameter} |
| 733 |
% \end{macrocode} |
| 734 |
% |
| 735 |
% \subsubsection{Besonderheiten des Deklarationselementes \emph{Parameter}} |
| 736 |
% |
| 737 |
% \begin{macro}{\DescribeMacroParameters} |
| 738 |
% \changes{v2.06o}{2022/07/20}{neu}^^A |
| 739 |
% \begin{macro}{\DescribeEnvParameters} |
| 740 |
% \changes{v2.06o}{2022/07/20}{neu}^^A |
| 741 |
% \begin{macro}{\Describe@Parameters} |
| 742 |
% \changes{v2.06o}{2022/07/20}{neu}^^A |
| 743 |
% Hiermit können Parameter für Befehle und Umgebungen beschrieben werden. Mit |
| 744 |
% |\Describe|\meta{Typ}|Parameters|\oarg{...}\marg{Element(e)}\marg{Parameter} |
| 745 |
% erfolgt der Aufruf, wobei das optionale Argument an \cs{DescribeParameter} |
| 746 |
% durchgereicht wird. |
| 747 |
% \begin{macrocode} |
| 748 |
\newcommand*\DescribeMacroParameters{} |
| 749 |
\def\DescribeMacroParameters{% |
| 750 |
\kernel@ifnextchar[%] |
| 751 |
{\Describe@Parameters{Macro}}{\Describe@Parameters{Macro}[]}% |
| 752 |
} |
| 753 |
\newcommand*\DescribeEnvParameters{} |
| 754 |
\def\DescribeEnvParameters{% |
| 755 |
\kernel@ifnextchar[%] |
| 756 |
{\Describe@Parameters{Env}}{\Describe@Parameters{Env}[]}% |
| 757 |
} |
| 758 |
% \end{macrocode} |
| 759 |
% Für eine möglichst einfache Schnittstelle wird ein bisschen getrickst. Das |
| 760 |
% optionale Argument wird zunächst dahingehend ausgewertet, ob Indexeinträge |
| 761 |
% überhaupt erzeugt werden sollen. In diesem Fall wird die Ausgabe unterdrückt, |
| 762 |
% um diese bei der Angabe mehrerer \marg{Element(e)} nicht mehrfach zu erhalten. |
| 763 |
% \begin{macrocode} |
| 764 |
\newcommand*\Describe@Parameters{} |
| 765 |
\def\Describe@Parameters#1[#2]#3#4{% |
| 766 |
\begingroup% |
| 767 |
\csname keys_set:nn\endcsname{doc}{#2}% |
| 768 |
\ifdoc@noindex% |
| 769 |
\aftergroup\@gobble% |
| 770 |
\else% |
| 771 |
\aftergroup\@firstofone% |
| 772 |
\fi% |
| 773 |
\endgroup{% |
| 774 |
\def\@tempc{#3}% |
| 775 |
\@for\@tempa:=\@tempc\do{% |
| 776 |
\trim@spaces@in\@tempa% |
| 777 |
\ifx\@tempa\@empty\else% |
| 778 |
\begingroup% |
| 779 |
% \end{macrocode} |
| 780 |
% Durch den Aufruf von |\Describe|\meta{Typ} wird der Elterneintrag erzeugt. |
| 781 |
% Dieser muss durch \pkg{doc} zwar erstellt, jedoch nicht in den Index |
| 782 |
% eingetragen werden, weshalb \prm{noindex} nicht möglich ist und stattdessen |
| 783 |
% \cs{index} hier das Argument verschluckt. |
| 784 |
% \begin{macrocode} |
| 785 |
\let\index\@gobble% |
| 786 |
\def\@tempb{\@nameuse{Describe#1}[noprint]}% |
| 787 |
\expandafter\@tempb\expandafter{\@tempa}% |
| 788 |
\xdef\tud@idx@parent{% |
| 789 |
{\expandonce\tud@idx@sortkey}{\expandonce\tud@idx@format}% |
| 790 |
}% |
| 791 |
\endgroup% |
| 792 |
\DescribeParameters[{#2,noprint}]{#4}% |
| 793 |
\fi% |
| 794 |
}% |
| 795 |
}% |
| 796 |
% \end{macrocode} |
| 797 |
% Nach dem Erstellen der Indexeinträge erfolgt die \emph{einmalige} Ausgabe |
| 798 |
% aller genannten Parameter. |
| 799 |
% \begin{macrocode} |
| 800 |
\begingroup% |
| 801 |
\csname keys_set:nn\endcsname{doc}{#2}% |
| 802 |
\ifdoc@noprint% |
| 803 |
\aftergroup\@gobble% |
| 804 |
\else% |
| 805 |
\aftergroup\@firstofone% |
| 806 |
\fi% |
| 807 |
\endgroup{% |
| 808 |
\DescribeParameters[{#2,noindex}]{#4}% |
| 809 |
}% |
| 810 |
\global\let\tud@idx@parent\relax% |
| 811 |
} |
| 812 |
% \end{macrocode} |
| 813 |
% \end{macro}^^A \Describe@Parameters |
| 814 |
% \end{macro}^^A \DescribeEnvParameters |
| 815 |
% \end{macro}^^A \DescribeMacroParameters |
| 816 |
% \begin{macro}{\SpecialMainParameterIndex} |
| 817 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 818 |
% \changes{v2.06o}{2022/07/20}{Anpassungen für \pkg{doc}}^^A |
| 819 |
% \begin{macro}{\SpecialParameterIndex} |
| 820 |
% \changes{v2.05i}{2017/02/20}{neu}^^A |
| 821 |
% \changes{v2.06o}{2022/07/20}{Anpassungen für \pkg{doc}}^^A |
| 822 |
% Die Gestalt der Parameter als Haupteinträge wird hier definiert. |
| 823 |
% \begin{macrocode} |
| 824 |
\renewcommand*\SpecialMainParameterIndex[1]{% |
| 825 |
\ifx\tud@idx@parent\relax% |
| 826 |
\@expandtwoargs\in@{\tud@idx@element}{Macro,Env}% |
| 827 |
\ifin@% |
| 828 |
\xdef\tud@idx@parent{% |
| 829 |
{\expandonce\tud@idx@sortkey}{\expandonce\tud@idx@format}% |
| 830 |
}% |
| 831 |
\else% |
| 832 |
\ClassError{\TUD@Class@Name}{No previous macro or environment}{% |
| 833 |
Since parameters can only be used for macros or\MessageBreak% |
| 834 |
environments, you have to use `parameter' within\MessageBreak% |
| 835 |
`macro' or `environment'.% |
| 836 |
}% |
| 837 |
\fi% |
| 838 |
\fi% |
| 839 |
\ifx\tud@idx@parent\relax\else% |
| 840 |
\gdef\tud@idx@sortkey{#1\space(\tud@parameter@name)}% |
| 841 |
\gdef\tud@idx@format{% |
| 842 |
{\string\ttfamily\space#1}% |
| 843 |
\tud@idx@typemarkup\space(\tud@parameter@name)% |
| 844 |
}% |
| 845 |
\@bsphack% |
| 846 |
\special@index{% |
| 847 |
\expandafter\@firstoftwo\tud@idx@parent\actualchar% |
| 848 |
\expandafter\@secondoftwo\tud@idx@parent\levelchar% |
| 849 |
\tud@idx@sortkey\actualchar\tud@idx@format% |
| 850 |
\encapchar main% |
| 851 |
}% |
| 852 |
\@esphack% |
| 853 |
\fi% |
| 854 |
} |
| 855 |
% \end{macrocode} |
| 856 |
% Hier wird die Gestalt der Indexeinträge für Parameter festgelegt, wenn diese |
| 857 |
% durch \cs{Describe@Parameters} erzeugt werden. |
| 858 |
% \begin{macrocode} |
| 859 |
\renewcommand*\SpecialParameterIndex[1]{% |
| 860 |
\ifx\tud@idx@parent\relax% |
| 861 |
\ClassError{\TUD@Class@Name}{No macro or environment given}{% |
| 862 |
Since parameters can only be used for macros or\MessageBreak% |
| 863 |
environments, you have to use an appropriate command like\MessageBreak% |
| 864 |
`\string\DescribeMacroParameters' or `\string\DescribeEnvParameters'.% |
| 865 |
}% |
| 866 |
\else% |
| 867 |
\gdef\tud@idx@sortkey{#1\space(\tud@parameter@name)}% |
| 868 |
\gdef\tud@idx@format{% |
| 869 |
{\string\ttfamily\space#1}% |
| 870 |
\tud@idx@typemarkup\space(\tud@parameter@name)% |
| 871 |
}% |
| 872 |
\@bsphack% |
| 873 |
\index{% |
| 874 |
\expandafter\@firstoftwo\tud@idx@parent\actualchar% |
| 875 |
\expandafter\@secondoftwo\tud@idx@parent\levelchar% |
| 876 |
\tud@idx@sortkey\actualchar\tud@idx@format% |
| 877 |
\encapchar usage% |
| 878 |
}% |
| 879 |
\@esphack% |
| 880 |
\fi% |
| 881 |
} |
| 882 |
% \end{macrocode} |
| 883 |
% \end{macro}^^A \SpecialParameterIndex |
| 884 |
% \end{macro}^^A \SpecialMainParameterIndex |
| 885 |
% |
| 886 |
% \subsection{Index und Änderungsliste} |
| 887 |
% Sollte \app{texindy} zum Einsatz kommen, wird die Gestalt von Index und |
| 888 |
% Änderungsliste angepasst, was eine Anpassung der erzeugten Einträge bedingt. |
| 889 |
% Die notwendigen Befehle werden zunächst nachfolgenddefiniert. Über den Hook |
| 890 |
% |begindocument/before| erfolgt später die Zuweisung. |
| 891 |
% |
| 892 |
% \begin{macro}{\tud@xdy@reference} |
| 893 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 894 |
% \begin{macro}{\tud@xdy@destination} |
| 895 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 896 |
% \begin{macro}{\tud@xdy@filesep} |
| 897 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 898 |
% \begin{macro}{\tud@xdy@mapping} |
| 899 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 900 |
% \begin{macro}{\tud@xdy@@mapping} |
| 901 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 902 |
% Für die verwendeten Referenzen von Einträgen für Index und Änderungsliste |
| 903 |
% gibt es im Zusammenspiel von \pkg{doc} und \pkg{hypdoc} mehrere Varianten. |
| 904 |
% Das Paket \pkg{doc} unterscheidet zwischen Verweisen auf Seitenzahlen und |
| 905 |
% Codezeilen. Das Paket \pkg{hypdoc} stellt für beide Varianten jeweils eine |
| 906 |
% eigene Implentierung für das Erzeugen von Hyperlinks bereit. Mit dem Befehl |
| 907 |
% \cs{tud@xdy@reference} wird für die Verwendung von \app{texindy} für alle |
| 908 |
% Varianten eine einheitliche Form definiert. Alle Einträge für Index und |
| 909 |
% Änderungsliste verwenden das Format |
| 910 |
% \meta{Target}|:|\meta{Dateischlüssel}|-|\meta{Codezeile}|:|\meta{Seitenzahl} |
| 911 |
% für Referenzen. Es wird über \cs{tud@xdy@filesep} sichergestellt, dass für |
| 912 |
% den Dateischlüssel immer ein definierter Zustand besteht. |
| 913 |
% |
| 914 |
% An \cs{tud@xdy@reference} wird als einziges Argument die aktuelle Codezeile |
| 915 |
% \cs{c@CodelineNo} des Paketes \pkg{doc} übergeben, das Target für Link zur |
| 916 |
% Codezeile wird ggf. automatisch durch \pkg{hypdoc} gesetzt. Die Auswetung der |
| 917 |
% so erzeugten Referenz erfolgt mit \cs{tud@xdy@@mapping}. War das an |
| 918 |
% \cs{tud@xdy@reference} übergebene Argument größer 0, wird die Ausgabe für |
| 919 |
% eine Codezeile erzeugt, andernfalls für eine Seitenangabe. |
| 920 |
% \begin{macrocode} |
| 921 |
\ifdefined\tudxdyflag |
| 922 |
\newcommand*\tud@xdy@filesep{?-} |
| 923 |
\newcommand*\tud@xdy@reference[1]{0:\filesep#1:\thepage} |
| 924 |
% \end{macrocode} |
| 925 |
% Mit \cs{tud@xdy@destination} erfolgt die Formatierung bei der Ausgabe. Sollte |
| 926 |
% kein Dateischlüssel gesetzt sein, erfolgt dennoch eine Ausgabe. Der Zustand |
| 927 |
% besteht dann, wenn \cs{DocInclude} nicht verwendet wurde. |
| 928 |
% \begin{macrocode} |
| 929 |
\newcommand*\tud@xdy@destination[3]{% |
| 930 |
#1\if#2\expandafter\@car\tud@xdy@filesep\@nil\else\mbox{--}#2\fi% |
| 931 |
\ifnum#3>\z@\textsubscript{\kern.1em#3}\fi% |
| 932 |
} |
| 933 |
% \end{macrocode} |
| 934 |
% Neben der Refernz wird an \cs{tud@xdy@mapping} noch ein Attribut für die |
| 935 |
% Formatierung der Ausgabe übergeben. Gültige Werte sind |main|, |usage|, |
| 936 |
% |code| und |change| (siehe \file{tudscr-texindy.dtx}). Die erzeugte Ausgabe |
| 937 |
% der Referenz wird dann mit \cs{main}, \cs{usage}, \cs{code} oder \cs{change} |
| 938 |
% formatiert, falls vorhanden. Diese Befehle müssen genau ein obligatorisches |
| 939 |
% Argument verarbeiten. |
| 940 |
% \begin{macrocode} |
| 941 |
\newcommand*\tud@xdy@mapping[2]{\tud@xdy@@mapping{#1}#2\@nil} |
| 942 |
\newcommand*\tud@xdy@@mapping{} |
| 943 |
% \end{macrocode} |
| 944 |
% Ohne \pkg{hypdoc} werden für die Ausgabe Links auf die entsprechenden Seiten |
| 945 |
% erzeugt, falls zumindes \pkg{hyperref} geladen wurde. |
| 946 |
% \begin{macrocode} |
| 947 |
\def\tud@xdy@@mapping#1#2:#3-#4:#5\@nil{% |
| 948 |
\begingroup% |
| 949 |
\ifundef{\hyperlink}{\let\tud@res@a\@gobble}{\let\tud@res@a\@firstofone}% |
| 950 |
\csname\ifx\\#1\\relax\else#1\fi\endcsname{% |
| 951 |
\tud@res@a{\hyperlink{page.#5}}{\tud@xdy@destination{#5}{#3}{#4}}% |
| 952 |
}% |
| 953 |
\endgroup% |
| 954 |
} |
| 955 |
% \end{macrocode} |
| 956 |
% Mit \pkg{hypdoc} werden via \cs{c@HD@hypercount} Sprungmarken ins Dokument |
| 957 |
% sowie auf Codezeilen generiert. Diese werden durch \cs{tud@xdy@@mapping} |
| 958 |
% an die korrespondierenden Befehle von \pkg{hypdoc} durchgereicht. |
| 959 |
% \begin{macrocode} |
| 960 |
\AfterPackage*{hypdoc}{% |
| 961 |
\renewcommand*\tud@xdy@reference[1]{\the\c@HD@hypercount:\filesep#1:\thepage}% |
| 962 |
\def\tud@xdy@@mapping#1#2:#3-#4:#5\@nil{% |
| 963 |
\ifnum#2>\z@\relax |
| 964 |
\hdclindex{#2}{#1}{\tud@xdy@destination{#5}{#3}{#4}}% |
| 965 |
\else |
| 966 |
\csname\ifx\\#1\\relax\else#1\fi\endcsname{% |
| 967 |
\hyperlink{page.#5}{\tud@xdy@destination{#5}{#3}{#4}}% |
| 968 |
}% |
| 969 |
\fi |
| 970 |
}% |
| 971 |
} |
| 972 |
\fi |
| 973 |
% \end{macrocode} |
| 974 |
% \end{macro}^^A \tud@xdy@@mapping |
| 975 |
% \end{macro}^^A \tud@xdy@mapping |
| 976 |
% \end{macro}^^A \tud@xdy@filesep |
| 977 |
% \end{macro}^^A \tud@xdy@destination |
| 978 |
% \end{macro}^^A \tud@xdy@reference |
| 979 |
% |
| 980 |
% \subsubsection{Erzeugen von Indexeinträgen} |
| 981 |
% |
| 982 |
% Nachdem die Form der Referenzierung für \app{texindy} definiert wurde, müssen |
| 983 |
% die Einträge im Index auch entsprechend erstellt werden. |
| 984 |
% |
| 985 |
% \begin{macro}{\tud@xdy@wrindex} |
| 986 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 987 |
% \begin{macro}{\tud@xdy@page@wrindex} |
| 988 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 989 |
% \begin{macro}{\tud@xdy@codeline@wrindex} |
| 990 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 991 |
% Mit \cs{PageIndex} respektive \cs{CodelineIndex} aus dem Paket \pkg{doc} |
| 992 |
% wird festgelegt, ob Index und Änderungsliste Seitenzahlen oder Codezeilen |
| 993 |
% als Referenz verwenden. Dementsprechend werden \cs{tud@xdy@page@wrindex} und |
| 994 |
% \cs{tud@xdy@codeline@wrindex} definiert, die sich grundsätzlich nur darin |
| 995 |
% unterscheiden, ob \cs{tud@xdy@reference} mit |0| oder der aktuellen |
| 996 |
% Codezeile |\number\c@CodelineNo| als Argument genutzt wird. |
| 997 |
% \begin{macrocode} |
| 998 |
\ifdefined\tudxdyflag |
| 999 |
\newcommand*\tud@xdy@wrindex[1]{% |
| 1000 |
\protected@write\@indexfile{}{% |
| 1001 |
\string\indexentry{#1}{\tud@xdy@reference{0}}% |
| 1002 |
}% |
| 1003 |
\endgroup% |
| 1004 |
\@esphack% |
| 1005 |
} |
| 1006 |
\newcommand*\tud@xdy@page@wrindex[1]{% |
| 1007 |
\begingroup |
| 1008 |
\let\@wrindex\tud@xdy@wrindex% |
| 1009 |
\index{#1}% |
| 1010 |
\endgroup |
| 1011 |
} |
| 1012 |
\AfterPackage*{hypdoc}{% |
| 1013 |
\renewcommand*\tud@xdy@page@wrindex[1]{% |
| 1014 |
\begingroup |
| 1015 |
\let\@wrindex\tud@xdy@wrindex% |
| 1016 |
\HDorg@index{#1}% |
| 1017 |
\endgroup |
| 1018 |
} |
| 1019 |
} |
| 1020 |
\newcommand*\tud@xdy@codeline@wrindex[1]{% |
| 1021 |
\if@filesw |
| 1022 |
\begingroup |
| 1023 |
\let\protect\noexpand |
| 1024 |
\immediate\write\@indexfile{% |
| 1025 |
\string\indexentry{#1}{\tud@xdy@reference{\number\c@CodelineNo}}% |
| 1026 |
}% |
| 1027 |
\endgroup |
| 1028 |
\fi |
| 1029 |
} |
| 1030 |
\fi |
| 1031 |
% \end{macrocode} |
| 1032 |
% \end{macro}^^A \tud@xdy@codeline@wrindex |
| 1033 |
% \end{macro}^^A \tud@xdy@page@wrindex |
| 1034 |
% \end{macro}^^A \tud@xdy@wrindex |
| 1035 |
% |
| 1036 |
% \subsubsection{Erzeugen von Änderungseinträgen} |
| 1037 |
% |
| 1038 |
% \begin{macro}{\changehistoryname} |
| 1039 |
% \begin{macro}{\changes@} |
| 1040 |
% \changes{v2.06o}{2022/07/20}{Anpassungen für \pkg{doc}}^^A |
| 1041 |
% \changes{v2.06o}{2022/07/25}{Prüfen falscher Datumsangaben}^^A |
| 1042 |
% \begin{macro}{\changes@@} |
| 1043 |
% Vor den Änderungen wird geprüft, ob sich an der Definition aus dem Paket |
| 1044 |
% \pkg{doc} etwas geändert hat. Der Befehl \cs{changehistoryname} wird vom |
| 1045 |
% Paket \pkg{hypdoc} verwendet. |
| 1046 |
% \begin{macrocode} |
| 1047 |
\def\changehistoryname{\tud@changes@name} |
| 1048 |
\CheckCommand*\changes@[3]{% |
| 1049 |
\protected@edef\@tempa{% |
| 1050 |
\noexpand\glossary{% |
| 1051 |
#1% |
| 1052 |
\ifdoc@reportchangedates\space -- #2\fi |
| 1053 |
\levelchar |
| 1054 |
\ifx\saved@macroname\@empty |
| 1055 |
\quotechar!% |
| 1056 |
\actualchar |
| 1057 |
\generalname |
| 1058 |
\else |
| 1059 |
\saved@indexname |
| 1060 |
\actualchar |
| 1061 |
\string\verb\quotechar*% |
| 1062 |
\verbatimchar\saved@macroname |
| 1063 |
\verbatimchar |
| 1064 |
\fi |
| 1065 |
:\levelchar #3% |
| 1066 |
}% |
| 1067 |
}% |
| 1068 |
\@tempa\endgroup\@esphack% |
| 1069 |
} |
| 1070 |
% \end{macrocode} |
| 1071 |
% Bei der Erzeugung der Änderungseinträge wird zwischen der Verwendung von |
| 1072 |
% \app{makeindex} und \app{texindy} unterschieden. Für die Reihenfolge des |
| 1073 |
% Erscheinens der einzelnen Einträge wird das in |#2| angegebene Datum zur |
| 1074 |
% Sortierung genutzt. |
| 1075 |
% \begin{macrocode} |
| 1076 |
\renewcommand*\changes@[3]{% |
| 1077 |
\ifnum\@parse@version@1993/01/01\@nil<\expandafter\@parse@version@#2//00\@nil% |
| 1078 |
\expandafter\@gobble% |
| 1079 |
\else% |
| 1080 |
\expandafter\@firstofone% |
| 1081 |
\fi{\ClassWarning{\TUD@Class@Name}{The given date `#2' seems to be invalid}}% |
| 1082 |
\changes@@{#1}{#2}{#3}% |
| 1083 |
} |
| 1084 |
\ifdefined\tudxdyflag |
| 1085 |
\newcommand*\changes@@[3]{% |
| 1086 |
\protected@edef\@tempa{% |
| 1087 |
\noexpand\glossary{% |
| 1088 |
#1\ifdoc@reportchangedates\space -- #2\fi |
| 1089 |
\levelchar |
| 1090 |
% \end{macrocode} |
| 1091 |
% Das an die vorderster Stelle sortierte Zeichen ist |~| bei \app{texindy}. |
| 1092 |
% \begin{macrocode} |
| 1093 |
\ifx\saved@macroname\@empty |
| 1094 |
\string~\actualchar\tud@general@name% |
| 1095 |
% \end{macrocode} |
| 1096 |
% Gilt der Änderungseintrag einem Parameter wird eine zusätzliche Ebene vor dem |
| 1097 |
% eigentlichen Eintrag des Parameters erzeugt und der in \cs{tud@idx@parent} |
| 1098 |
% zuvor gesicherte Elterneintrag~-- Befehl oder Umgebung~-- eingefügt. Weil |
| 1099 |
% ohnehin eine Stildatei für \app{texindy} erzeugt wird, ist das Erzeugen |
| 1100 |
% zusätzlicher Ebenen in der Änderungsliste einfach machbar. Prinzipiell wäre |
| 1101 |
% das mit einer entsprechenden Stildatei auch für \app{makeindex} machbar. |
| 1102 |
% \begin{macrocode} |
| 1103 |
\else |
| 1104 |
\ifx\tud@idx@parent\relax\else |
| 1105 |
\expandafter\@firstoftwo\tud@idx@parent\actualchar |
| 1106 |
\expandafter\@secondoftwo\tud@idx@parent:\levelchar |
| 1107 |
\fi |
| 1108 |
\tud@idx@sortkey\actualchar\tud@idx@format% |
| 1109 |
\fi |
| 1110 |
:\levelchar |
| 1111 |
#2\space\protecting{#3}\actualchar\protecting{#3}% |
| 1112 |
}% |
| 1113 |
}% |
| 1114 |
\@tempa\endgroup\@esphack% |
| 1115 |
}% |
| 1116 |
\else |
| 1117 |
% \end{macrocode} |
| 1118 |
% Für \app{makeindex} wird der Befehl insbesondere für das Listen der Parameter |
| 1119 |
% angepasst. |
| 1120 |
% \begin{macrocode} |
| 1121 |
\renewcommand*\changes@[3]{% |
| 1122 |
\protected@edef\@tempa{% |
| 1123 |
\noexpand\glossary{% |
| 1124 |
#1\ifdoc@reportchangedates\space -- #2\fi |
| 1125 |
\levelchar |
| 1126 |
\ifx\saved@macroname\@empty |
| 1127 |
\quotechar!\actualchar\tud@general@name% |
| 1128 |
\else |
| 1129 |
\ifx\tud@idx@parent\relax\else |
| 1130 |
\expandafter\@firstoftwo\tud@idx@parent\space--\space% |
| 1131 |
\fi |
| 1132 |
\tud@idx@sortkey\actualchar |
| 1133 |
\ifx\tud@idx@parent\relax\else |
| 1134 |
\expandafter\@secondoftwo\tud@idx@parent\noexpand\,--\noexpand\,% |
| 1135 |
\fi |
| 1136 |
\tud@idx@format% |
| 1137 |
\fi |
| 1138 |
:\levelchar |
| 1139 |
#2\space\protecting{#3}\actualchar\protecting{#3}% |
| 1140 |
}% |
| 1141 |
}% |
| 1142 |
\@tempa\endgroup\@esphack% |
| 1143 |
}% |
| 1144 |
\fi |
| 1145 |
% \end{macrocode} |
| 1146 |
% \end{macro}^^A \changes@@ |
| 1147 |
% \end{macro}^^A \changes@ |
| 1148 |
% \end{macro}^^A \changehistoryname |
| 1149 |
% \begin{macro}{\tud@xdy@wrglossary} |
| 1150 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 1151 |
% Die Referenzierung für \app{texindy} wird auch für Änderungseinträge genutzt. |
| 1152 |
% \begin{macrocode} |
| 1153 |
\ifdefined\tudxdyflag |
| 1154 |
\newcommand*\tud@xdy@wrglossary[1]{% |
| 1155 |
% \end{macrocode} |
| 1156 |
% Zunächst wird geprüft, ob eine Eintrag mit Refernz auf eine Seitenzahl oder |
| 1157 |
% eine Codezeile erzeugt werden soll. Letztere werden nur erstellt, wenn im |
| 1158 |
% Index überhaupt Codezeilen verwendet werden und der Änderungseintrag sich |
| 1159 |
% auf ein zuletzt deklariertes Element (\cs{saved@macroname}) bezieht. |
| 1160 |
% \begin{macrocode} |
| 1161 |
\@tud@res@swafalse% |
| 1162 |
\ifx\special@index\@gobble\else\ifcodeline@index |
| 1163 |
\ifx\saved@macroname\@empty\else\@tud@res@swatrue\fi |
| 1164 |
\fi\fi |
| 1165 |
\global\advance\c@CodelineNo\@ne% |
| 1166 |
\protected@write\@glossaryfile{}{% |
| 1167 |
\string\glossaryentry{#1|change}% |
| 1168 |
{\tud@xdy@reference{\if@tud@res@swa\number\c@CodelineNo\else0\fi}}% |
| 1169 |
}% |
| 1170 |
\global\advance\c@CodelineNo\m@ne% |
| 1171 |
\endgroup% |
| 1172 |
\@esphack% |
| 1173 |
} |
| 1174 |
\fi |
| 1175 |
% \end{macrocode} |
| 1176 |
% \end{macro}^^A \tud@xdy@wrglossary |
| 1177 |
% |
| 1178 |
% \subsubsection{Erscheinung von Einträgen in der Änderungsliste} |
| 1179 |
% |
| 1180 |
% \begin{macro}{\tud@lst@def} |
| 1181 |
% \changes{v2.05}{2016/04/25}{neu}^^A |
| 1182 |
% \begin{macro}{\tud@lst@values} |
| 1183 |
% \changes{v2.05}{2016/04/25}{neu}^^A |
| 1184 |
% \begin{macro}{\if@tud@lst@multi} |
| 1185 |
% \changes{v2.05}{2016/04/25}{neu}^^A |
| 1186 |
% \begin{macro}{\tud@lst@init} |
| 1187 |
% \changes{v2.05}{2016/04/25}{neu}^^A |
| 1188 |
% \begin{macro}{\tud@lst@add} |
| 1189 |
% \changes{v2.05}{2016/04/25}{neu}^^A |
| 1190 |
% \begin{macro}{\tud@lst@process} |
| 1191 |
% \changes{v2.05}{2016/04/25}{neu}^^A |
| 1192 |
% \begin{macro}{\tud@lst@@values} |
| 1193 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1194 |
% \begin{macro}{\if@tud@lst@@multi} |
| 1195 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1196 |
% \begin{macro}{\tud@lst@@init} |
| 1197 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1198 |
% \begin{macro}{\tud@lst@@add} |
| 1199 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1200 |
% \begin{macro}{\tud@lst@@process} |
| 1201 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1202 |
% \begin{macro}{\tud@lst@@sub} |
| 1203 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1204 |
% \begin{macro}{\tud@lst@@@sub} |
| 1205 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1206 |
% \begin{macro}{\efil} |
| 1207 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1208 |
% Falls für die Sortierung der Änderungsliste in \cls{tudscrdoc} \app{texindy} |
| 1209 |
% zum Einsatz kommt, wird bei der Beschreibung von Einträgen oder Parametern |
| 1210 |
% nur dann eine Unterebene verwendet, wenn zu einem Eintrag mehrere Angaben |
| 1211 |
% existieren. Sollte nur eine Anmerkung vorhanden sein, wird diese direkt in |
| 1212 |
% der dazugehörigen Ebene nach dem Eintrag selbst ausgegeben. |
| 1213 |
% \begin{macrocode} |
| 1214 |
\newcommand*\tud@lst@@sub{} |
| 1215 |
\newcommand*\tud@lst@@@sub{} |
| 1216 |
\newcommand*\efil{\hfil\nopagebreak}% |
| 1217 |
\newcommand*\tud@lst@def{% |
| 1218 |
\newcommand*\tud@lst@values{}% |
| 1219 |
\tud@newif\if@tud@lst@multi% |
| 1220 |
\newcommand*\tud@lst@init{% |
| 1221 |
\let\tud@lst@values\relax% |
| 1222 |
\let\tud@lst@@sub\relax% |
| 1223 |
\@tud@lst@multifalse% |
| 1224 |
}% |
| 1225 |
\newcommand*\tud@lst@add[1]{% |
| 1226 |
\ifx\tud@lst@values\relax\else% |
| 1227 |
\@tud@lst@multitrue% |
| 1228 |
\def\tud@lst@@sub{\subitem}% |
| 1229 |
\fi% |
| 1230 |
\listadd\tud@lst@values{\tud@lst@@sub ##1}% |
| 1231 |
}% |
| 1232 |
\newcommand*\tud@lst@process{% |
| 1233 |
\if@tud@lst@multi% |
| 1234 |
\preto\tud@lst@values{\efill}% |
| 1235 |
\fi% |
| 1236 |
\forlistloop{}{\tud@lst@values}% |
| 1237 |
\tud@lst@init% |
| 1238 |
}% |
| 1239 |
\newcommand*\tud@lst@@values{}% |
| 1240 |
\tud@newif\if@tud@lst@@multi% |
| 1241 |
\newcommand*\tud@lst@@init{% |
| 1242 |
\let\tud@lst@@values\relax% |
| 1243 |
\def\tud@lst@@sub{\subitem}% |
| 1244 |
\def\tud@lst@@@sub{\space}% |
| 1245 |
\@tud@lst@@multifalse% |
| 1246 |
}% |
| 1247 |
\newcommand*\tud@lst@@add[1]{% |
| 1248 |
\@tud@lst@multitrue% |
| 1249 |
\ifx\tud@lst@@values\relax\else% |
| 1250 |
\@tud@lst@@multitrue% |
| 1251 |
\def\tud@lst@@@sub{\subsubitem}% |
| 1252 |
\fi% |
| 1253 |
\listadd\tud@lst@@values{##1}% |
| 1254 |
}% |
| 1255 |
\newcommand*\tud@lst@@process{% |
| 1256 |
\if@tud@lst@@multi% |
| 1257 |
\appto\tud@lst@values{\efill}% |
| 1258 |
\fi% |
| 1259 |
\protected@edef\tud@reserved####1{% |
| 1260 |
\noexpand\listadd\noexpand\tud@lst@values{% |
| 1261 |
\expandonce\tud@lst@@@sub####1% |
| 1262 |
}% |
| 1263 |
}% |
| 1264 |
\forlistloop{\tud@reserved}{\tud@lst@@values}% |
| 1265 |
\tud@lst@@init% |
| 1266 |
}% |
| 1267 |
} |
| 1268 |
% \end{macrocode} |
| 1269 |
% \end{macro}^^A \efil |
| 1270 |
% \end{macro}^^A \tud@lst@@@sub |
| 1271 |
% \end{macro}^^A \tud@lst@@sub |
| 1272 |
% \end{macro}^^A \tud@lst@@process |
| 1273 |
% \end{macro}^^A \tud@lst@@add |
| 1274 |
% \end{macro}^^A \tud@lst@@init |
| 1275 |
% \end{macro}^^A \if@tud@lst@@multi |
| 1276 |
% \end{macro}^^A \tud@lst@@values |
| 1277 |
% \end{macro}^^A \tud@lst@process |
| 1278 |
% \end{macro}^^A \tud@lst@add |
| 1279 |
% \end{macro}^^A \tud@lst@init |
| 1280 |
% \end{macro}^^A \if@tud@lst@multi |
| 1281 |
% \end{macro}^^A \tud@lst@values |
| 1282 |
% \end{macro}^^A \tud@lst@def |
| 1283 |
% |
| 1284 |
% \subsubsection{Setzen der Anpassungen für Index und Änderungsliste} |
| 1285 |
% |
| 1286 |
% Über den Hook |begindocument/before| erfolgt nun die Zuweisung der zuvor |
| 1287 |
% gemachten Anpassungen an die jeweiligen Befehle, wobei zuvor die Definitionen |
| 1288 |
% der relevanten Befehle geprüft wird. Mit \cs{DeclareHookRule} für das durch |
| 1289 |
% \pkg{doc} verwendete Label |doc/hyperref| wird sichergestellt, dass die |
| 1290 |
% Anpassungen erst nach \pkg{doc} angewendet werden. |
| 1291 |
% \begin{macrocode} |
| 1292 |
\DeclareHookRule{begindocument/before}{doc/hyperref}{<}{.} |
| 1293 |
\AddToHook{begindocument/before}{% |
| 1294 |
\CheckCommand*\@wrindex[1]{% |
| 1295 |
\protected@write\@indexfile{}{\string\indexentry{#1}{\thepage}}% |
| 1296 |
\endgroup |
| 1297 |
\@esphack% |
| 1298 |
} |
| 1299 |
\CheckCommand*\codeline@wrindex[1]{% ltxdoc |
| 1300 |
\if@filesw |
| 1301 |
\begingroup |
| 1302 |
\let\protect\noexpand |
| 1303 |
\immediate\write\@indexfile{% |
| 1304 |
\string\indexentry{#1}{\filesep\number\c@CodelineNo}% |
| 1305 |
}% |
| 1306 |
\endgroup |
| 1307 |
\fi |
| 1308 |
} |
| 1309 |
\@ifpackageloaded{hypdoc}{% |
| 1310 |
\CheckCommand*\filesep{} |
| 1311 |
\CheckCommand*\doc@handleencap[1]{% |
| 1312 |
\encapchar hdclindex{\the\c@HD@hypercount}{#1}% |
| 1313 |
} |
| 1314 |
\CheckCommand*\HD@codeline@wrindex[1]{% |
| 1315 |
\begingroup |
| 1316 |
\let\HDorg@encapchar\encapchar |
| 1317 |
\def\encapchar##1\encapchar##2\@nil{% |
| 1318 |
\HDorg@encapchar |
| 1319 |
hdclindex{\the\c@HD@hypercount}{##1}% |
| 1320 |
}% |
| 1321 |
\codeline@wrindex{#1\encapchar\encapchar\@nil}% |
| 1322 |
\endgroup |
| 1323 |
} |
| 1324 |
\CheckCommand*\HD@page@wrindex[1]{% |
| 1325 |
\begingroup |
| 1326 |
\let\HDorg@encapchar\encapchar |
| 1327 |
\def\encapchar##1\encapchar##2\@nil{% |
| 1328 |
\HDorg@encapchar |
| 1329 |
hdpindex{##1}% |
| 1330 |
}% |
| 1331 |
\HDorg@index{#1\encapchar\encapchar\@nil}% |
| 1332 |
\endgroup |
| 1333 |
} |
| 1334 |
\CheckCommand*\@wrglossary[1]{% |
| 1335 |
\let\HDorg@encapchar\encapchar |
| 1336 |
\def\encapchar##1\encapchar##2\@nil{% |
| 1337 |
\HDorg@encapchar |
| 1338 |
hdpindex{##1}% |
| 1339 |
}% |
| 1340 |
\HDorg@wrglossary{#1\encapchar\encapchar\@nil}% |
| 1341 |
} |
| 1342 |
\CheckCommand*\HDorg@wrglossary[1]{% |
| 1343 |
\protected@write\@glossaryfile{}% |
| 1344 |
{\string\glossaryentry{#1}{\thepage}}% |
| 1345 |
\endgroup |
| 1346 |
\@esphack% |
| 1347 |
} |
| 1348 |
}{% |
| 1349 |
\CheckCommand*\@wrglossary[1]{% |
| 1350 |
\protected@write\@glossaryfile{}% |
| 1351 |
{\string\glossaryentry{#1}{\thepage}}% |
| 1352 |
\endgroup |
| 1353 |
\@esphack% |
| 1354 |
} |
| 1355 |
} |
| 1356 |
% \end{macrocode} |
| 1357 |
% Prüfung beendet, jetzt erfolgt die eigentliche Zuweisung. |
| 1358 |
% \begin{macrocode} |
| 1359 |
\ifdefined\tudxdyflag |
| 1360 |
\ifx\special@index\@gobble\else |
| 1361 |
\ifcodeline@index |
| 1362 |
\let\special@index\tud@xdy@codeline@wrindex |
| 1363 |
\else |
| 1364 |
\let\special@index\tud@xdy@page@wrindex |
| 1365 |
\fi |
| 1366 |
\@ifpackageloaded{hypdoc}{% |
| 1367 |
\let\HD@codeline@wrindex\tud@xdy@codeline@wrindex |
| 1368 |
\let\HD@page@wrindex\tud@xdy@page@wrindex |
| 1369 |
}{}% |
| 1370 |
\fi |
| 1371 |
\let\filesep\tud@xdy@filesep |
| 1372 |
\def\doc@handleencap#1{\encapchar #1} |
| 1373 |
\let\@wrindex\tud@xdy@wrindex |
| 1374 |
\let\@wrglossary\tud@xdy@wrglossary |
| 1375 |
\fi |
| 1376 |
} |
| 1377 |
% \end{macrocode} |
| 1378 |
% |
| 1379 |
% \subsubsection{Verarbeiten der Hilfsdateien von Index und Änderungsliste} |
| 1380 |
% |
| 1381 |
% \begin{macro}{\tud@xdy@write} |
| 1382 |
% \changes{v2.05}{2016/04/21}{neu}^^A |
| 1383 |
% \begin{macro}{\tud@xdy@read} |
| 1384 |
% \changes{v2.05}{2016/04/21}{neu}^^A |
| 1385 |
% \begin{macro}{\tud@line@replace} |
| 1386 |
% \changes{v2.05}{2016/04/21}{neu}^^A |
| 1387 |
% \begin{macro}{\actualchar} |
| 1388 |
% \begin{macro}{\quotechar} |
| 1389 |
% \begin{macro}{\levelchar} |
| 1390 |
% \ToDo{äquivalent zu tudscrmanual.cls; shell-escape raus, via makefile}[v2.07] |
| 1391 |
% \begin{macrocode} |
| 1392 |
%^^A\BeforeClosingMainAux{% |
| 1393 |
%^^A\immediate\closeout\@indexfile% |
| 1394 |
%^^A\immediate\closeout\@glossaryfile% |
| 1395 |
% \end{macrocode} |
| 1396 |
% Damit die erzeugten Dateien für Index und Änderungsliste von \app{texindy} |
| 1397 |
% verarbeitet werden können, müssen einige Steuerzeichen in der originalen |
| 1398 |
% \file{.ind}-Datei getauscht werden. Dafür wird diese zeilenweise eingelesen, |
| 1399 |
% die fraglichen Zeichen ersetzt und in eine weitere Hilfsdatei geschrieben. |
| 1400 |
% \begin{macrocode} |
| 1401 |
\ifdefined\tudxdyflag |
| 1402 |
\tud@newwrite\tud@xdy@write% |
| 1403 |
\tud@newread\tud@xdy@read% |
| 1404 |
% \end{macrocode} |
| 1405 |
% Die Makros für die fraglichen Steuerzeichen werden so angepasst, dass die |
| 1406 |
% Wahrscheinlichkeit für eine Verwendung dieser Kombination in einem Makro- |
| 1407 |
% oder Umgebungsnamen sehr gering ist. Anschließend werden die erzeugten |
| 1408 |
% Hilfsdateien für Index und Änderungsliste für \app{texindy} angepasst. Dabei |
| 1409 |
% werden diese automatisch erzeugt, falls dies möglich ist. |
| 1410 |
% \begin{macrocode} |
| 1411 |
\def\actualchar{<|1|>}% |
| 1412 |
\def\quotechar{<|2|>}% |
| 1413 |
\def\levelchar{<|3|>}% |
| 1414 |
\begingroup% |
| 1415 |
\endlinechar=\m@ne\relax% |
| 1416 |
\def\tud@reserved#1#2{% |
| 1417 |
\IfFileExists{\jobname.#1}{% |
| 1418 |
\immediate\openin\tud@xdy@read=\jobname.#1\relax% |
| 1419 |
\immediate\openout\tud@xdy@write=\jobname-xdy.#1\relax% |
| 1420 |
\@tempswafalse% |
| 1421 |
\loop\unless\ifeof\tud@xdy@read% |
| 1422 |
\readline\tud@xdy@read to\tud@line@replace% |
| 1423 |
% \end{macrocode} |
| 1424 |
% Um potenzielle Dopplungen zu vermeiden, wird \cs{quotechar} vor Zeichen |
| 1425 |
% entfernt, die ohnehin gegebenenfalls manuell behandelt werden müssen. |
| 1426 |
% \begin{macrocode} |
| 1427 |
\expandafter\tud@replace@@in\expandafter\tud@line@replace% |
| 1428 |
\expandafter{\quotechar"}{"}% |
| 1429 |
\expandafter\tud@replace@@in\expandafter\tud@line@replace% |
| 1430 |
\expandafter{\quotechar!}{!}% |
| 1431 |
\expandafter\tud@replace@@in\expandafter\tud@line@replace% |
| 1432 |
\expandafter{\quotechar:}{:}% |
| 1433 |
\expandafter\tud@replace@@in\expandafter\tud@line@replace% |
| 1434 |
\expandafter{\quotechar @}{@}% |
| 1435 |
% \end{macrocode} |
| 1436 |
% Jetzt die manuellen Anpassungen für Zeichen, die eigentlich zur Steuerung |
| 1437 |
% der Indexeinträge genutzt werden. |
| 1438 |
% \begin{macrocode} |
| 1439 |
\tud@replace@@in\tud@line@replace{"}{""}% |
| 1440 |
\tud@replace@@in\tud@line@replace{!}{"!}% |
| 1441 |
\tud@replace@@in\tud@line@replace{:}{":}% |
| 1442 |
\tud@replace@@in\tud@line@replace{@}{"@}% |
| 1443 |
\tud@replace@@in\tud@line@replace{\"@}{"\"@}% |
| 1444 |
% \end{macrocode} |
| 1445 |
% Abschließend erfolgt das Einsetzen der Steuerzeichen. |
| 1446 |
% \begin{macrocode} |
| 1447 |
\expandafter\tud@replace@@in\expandafter\tud@line@replace% |
| 1448 |
\expandafter{\actualchar}{@}% |
| 1449 |
\expandafter\tud@replace@@in\expandafter\tud@line@replace% |
| 1450 |
\expandafter{\quotechar}{"}% |
| 1451 |
\expandafter\tud@replace@@in\expandafter\tud@line@replace% |
| 1452 |
\expandafter{\levelchar}{!}% |
| 1453 |
\tud@replace@@in\tud@line@replace{" @}{}% |
| 1454 |
\ifeof\tud@xdy@read\else% |
| 1455 |
\immediate\write\tud@xdy@write{% |
| 1456 |
\unexpanded\expandafter{\tud@line@replace}% |
| 1457 |
}% |
| 1458 |
\@tempswatrue% |
| 1459 |
\fi% |
| 1460 |
\repeat% |
| 1461 |
\immediate\closein\tud@xdy@read% |
| 1462 |
\immediate\closeout\tud@xdy@write% |
| 1463 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 1464 |
\if@tempswa% |
| 1465 |
\ShellEscape{% |
| 1466 |
texindy\space% |
| 1467 |
-M \@currname-#2.xdy\space% |
| 1468 |
\ifdefvoid{\inputencodingname}{% |
| 1469 |
-C\space utf8% |
| 1470 |
}{% |
| 1471 |
-C\space\inputencodingname% |
| 1472 |
}\space% |
| 1473 |
-t \jobname-#2.xlg\space% |
| 1474 |
-o \jobname.#2\space% |
| 1475 |
\jobname-xdy.#1% |
| 1476 |
}% |
| 1477 |
% \end{macrocode} |
| 1478 |
% Falls nichts geschrieben wurde, wird eine leere Ausgabedatei erzeugt. |
| 1479 |
% \begin{macrocode} |
| 1480 |
\else% |
| 1481 |
\immediate\openout\tud@xdy@write=\jobname.#2\relax% |
| 1482 |
\immediate\closeout\tud@xdy@write% |
| 1483 |
\fi% |
| 1484 |
\fi% |
| 1485 |
}{}% |
| 1486 |
}% |
| 1487 |
\tud@reserved{idx}{ind}% |
| 1488 |
\tud@reserved{glo}{gls}% |
| 1489 |
\endgroup% |
| 1490 |
% \end{macrocode} |
| 1491 |
% Sollte \app{texindy} nicht aktiv sein, werden Index und Änderungsliste mit |
| 1492 |
% \app{makeindex} automatisch erzeugt. |
| 1493 |
% \begin{macrocode} |
| 1494 |
\else |
| 1495 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 1496 |
\ShellEscape{% |
| 1497 |
makeindex -s gglo.ist -t \jobname.glg -o \jobname.gls \jobname.glo% |
| 1498 |
}% |
| 1499 |
\ShellEscape{% |
| 1500 |
makeindex -s gind.ist -t \jobname.ilg -o \jobname.ind \jobname.idx% |
| 1501 |
}% |
| 1502 |
\fi% |
| 1503 |
\fi |
| 1504 |
% \end{macrocode} |
| 1505 |
% \ToDo{äquivalent zu tudscrmanual.cls}[v2.07] |
| 1506 |
% \begin{macrocode} |
| 1507 |
%^^A} |
| 1508 |
% \end{macrocode} |
| 1509 |
% \end{macro}^^A \levelchar |
| 1510 |
% \end{macro}^^A \quotechar |
| 1511 |
% \end{macro}^^A \actualchar |
| 1512 |
% \end{macro}^^A \tud@line@replace |
| 1513 |
% \end{macro}^^A \tud@xdy@read |
| 1514 |
% \end{macro}^^A \tud@xdy@write |
| 1515 |
% |
| 1516 |
% \subsection{Liste anstehender Aufgaben} |
| 1517 |
% |
| 1518 |
% \begin{macro}{\PrintToDos} |
| 1519 |
% \changes{v2.05}{2016/05/19}{neu}^^A |
| 1520 |
% Für ToDo-Notizen wird eine Liste aller anstehender Aufgaben definiert. |
| 1521 |
% \begin{macrocode} |
| 1522 |
\DeclareNewTOC[% |
| 1523 |
listname={\tud@todo@name},% |
| 1524 |
owner=\@currname,% |
| 1525 |
]{tdo} |
| 1526 |
\setuptoc{tdo}{totoc,noindent} |
| 1527 |
\newcommand*\PrintToDos{\ifdefined\tudfinalflag\else\listoftoc{tdo}\fi} |
| 1528 |
% \end{macrocode} |
| 1529 |
% \end{macro}^^A \PrintToDos |
| 1530 |
% \begin{macro}{\ToDo} |
| 1531 |
% \changes{v2.02}{2014/07/25}{neu}^^A |
| 1532 |
% Die Befehle für die ToDo-Notizen. Um in der gleichen Nomenklatur wie beim |
| 1533 |
% Handbuch bleiben zu können, wird die Randnotizmarke als optionales Argument |
| 1534 |
% hinter dem eigentlichen Text angegeben. |
| 1535 |
% \begin{macrocode} |
| 1536 |
\ifdefined\tudfinalflag |
| 1537 |
\NewDocumentCommand\ToDo{mo}{} |
| 1538 |
\else% |
| 1539 |
\NewDocumentCommand\ToDo{mo}{% |
| 1540 |
\begingroup% |
| 1541 |
\csuse{phantomsection}% |
| 1542 |
\IfValueTF{#2}{% |
| 1543 |
\def\tud@reserved{#2}% |
| 1544 |
}{% |
| 1545 |
\def\tud@reserved{??}% |
| 1546 |
}% |
| 1547 |
\endgraf\ifdim\parskip>\z@\else\smallskip\fi\noindent% |
| 1548 |
\hfuzz0.8pt% |
| 1549 |
\leavevmode% |
| 1550 |
\def\@tempa{\raggedleft\fbox{ToDo:\space\tud@reserved\strut}}% |
| 1551 |
\ifundef{\marginnote}{% |
| 1552 |
\expandafter\marginpar\expandafter{\@tempa}% |
| 1553 |
}{% |
| 1554 |
\expandafter\marginnote\expandafter{\@tempa}[% |
| 1555 |
\dimexpr-\fboxsep-\fboxrule\relax% |
| 1556 |
]% |
| 1557 |
}% |
| 1558 |
\fbox{\parbox{\dimexpr\linewidth-\fboxsep*2\relax}{#1\strut}}% |
| 1559 |
\endgraf\ifdim\parskip>\z@\else\bigskip\fi\noindent% |
| 1560 |
% \end{macrocode} |
| 1561 |
% Werden mit \cs{DocInclude} mehrere Dateien in das Dokument eingefügt, so |
| 1562 |
% erhält die ToDo-Notiz einen entsprechenden Hinweis. |
| 1563 |
% \begin{macrocode} |
| 1564 |
\let\@tempa\@empty% |
| 1565 |
\ifdefvoid{\currentfile}{}{% |
| 1566 |
\def\@tempa{\,--\,\texttt{\currentfile}}% |
| 1567 |
}% |
| 1568 |
\addxcontentsline{tdo}{subsection}{\tud@reserved\@tempa:\space#1}% |
| 1569 |
\endgroup% |
| 1570 |
\ignorespaces% |
| 1571 |
} |
| 1572 |
\fi |
| 1573 |
% \end{macrocode} |
| 1574 |
% \end{macro}^^A \ToDo |
| 1575 |
% |
| 1576 |
% |
| 1577 |
% \subsection{Ausgabe des Schlussteils} |
| 1578 |
% |
| 1579 |
% \begin{macro}{\PrintBackMatter} |
| 1580 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 1581 |
% \begin{macro}{\tud@index@heading} |
| 1582 |
% \changes{v2.06o}{2022/07/24}{neu}^^A |
| 1583 |
% Hiermit lassen sich Index, Änderungsliste und die Liste offener Aufgaben |
| 1584 |
% gemeinsam ausgegeben. Dafür werden die Einleitungen für Index und |
| 1585 |
% Änderungsliste angepasst und \cs{tud@index@heading} definiert. Somit lässt |
| 1586 |
% sich das Level der Überschriften dynamisch anpassen ohne die bei der |
| 1587 |
% Verarbeitung des Dokumentes durch \cls{ltxdoc} applizierten Anpassungen |
| 1588 |
% zu beeinflussen. Die Sternversion von \cs{PrintBackMatter} setzt die |
| 1589 |
% Überschriften mit \cs{addpart}, die Standardvariante via \cs{addsec}. |
| 1590 |
% \begin{macrocode} |
| 1591 |
\newcommand*\tud@index@heading{\addsec} |
| 1592 |
\IndexPrologue{\tud@index@heading{\indexname}\tud@index@text} |
| 1593 |
\GlossaryPrologue{\tud@index@heading{\tud@changes@name}} |
| 1594 |
\NewDocumentCommand\PrintBackMatter{s}{% |
| 1595 |
\begingroup% |
| 1596 |
\@ifpackageloaded{bookmark}{\bookmarksetup{startatroot,open=false}}{}% |
| 1597 |
\IfBooleanT{#1}{\renewcommand*\tud@index@heading{\addpart}}% |
| 1598 |
\deftocheading{tdo}{\tud@index@heading{##1}}% |
| 1599 |
\IfBooleanT{#1}{\cleardoublepage}\PrintIndex% |
| 1600 |
\IfBooleanT{#1}{\cleardoublepage}\PrintChanges% |
| 1601 |
\IfBooleanT{#1}{\cleardoublepage}\PrintToDos% |
| 1602 |
\endgroup% |
| 1603 |
} |
| 1604 |
% \end{macrocode} |
| 1605 |
% \end{macro}^^A\tud@index@heading |
| 1606 |
% \end{macro}^^A\PrintBackMatter |
| 1607 |
% \begin{macro}{\@docinclude} |
| 1608 |
% Damit die Liste der anstehenden Aufgaben bei der Erzeugung der gesamten |
| 1609 |
% Dokumentation des Quelltextes einmalig sowie vollständig und nicht nach jeder |
| 1610 |
% Quelldatei einzeln ausgegeben wird, muss \cs{@docinclude} angepasst werden. |
| 1611 |
% \begin{macrocode} |
| 1612 |
\patchcmd\@docinclude{% |
| 1613 |
\let\@ltxdoc@PrintIndex\PrintIndex |
| 1614 |
\let\PrintIndex\relax |
| 1615 |
\let\@ltxdoc@PrintChanges\PrintChanges |
| 1616 |
\let\PrintChanges\relax |
| 1617 |
}{% |
| 1618 |
\let\@ltxdoc@PrintIndex\PrintIndex |
| 1619 |
\let\PrintIndex\relax |
| 1620 |
\let\@ltxdoc@PrintChanges\PrintChanges |
| 1621 |
\let\PrintChanges\relax |
| 1622 |
\let\@ltxdoc@PrintToDos\PrintToDos |
| 1623 |
\let\PrintToDos\relax |
| 1624 |
}{}{\tud@patch@wrn{@docinclude}} |
| 1625 |
\patchcmd\@docinclude{% |
| 1626 |
\let\PrintIndex\@ltxdoc@PrintIndex |
| 1627 |
\let\PrintChanges\@ltxdoc@PrintChanges |
| 1628 |
}{% |
| 1629 |
\let\PrintIndex\@ltxdoc@PrintIndex |
| 1630 |
\let\PrintChanges\@ltxdoc@PrintChanges |
| 1631 |
\let\PrintToDos\@ltxdoc@PrintToDos |
| 1632 |
}{}{\tud@patch@wrn{@docinclude}} |
| 1633 |
% \end{macrocode} |
| 1634 |
% \end{macro}^^A \@docinclude |
| 1635 |
% |
| 1636 |
% \subsection{Schriften und Satzspiegel} |
| 1637 |
% |
| 1638 |
% \begin{macro}{\MacroFont} |
| 1639 |
% \begin{macro}{\AltMacroFont} |
| 1640 |
% Wird das Paket \pkg{mweights} geladen, so soll der passende Schriftschnitt |
| 1641 |
% für die ausgewählten TypeWriter-Schriften genutzt werden. Damit dies mit dem |
| 1642 |
% Paket \pkg{doc} funktioniert, muss der Befehl \cs{MacroFont} angepasst werden. |
| 1643 |
% \begin{macrocode} |
| 1644 |
\AfterPackage*{mweights}{% |
| 1645 |
\CheckCommand*\MacroFont{% |
| 1646 |
\fontencoding\encodingdefault% |
| 1647 |
\fontfamily\ttdefault% |
| 1648 |
\fontseries\mddefault% |
| 1649 |
\fontshape\shapedefault% |
| 1650 |
\small% |
| 1651 |
}% |
| 1652 |
\renewcommand*\MacroFont{% |
| 1653 |
\fontencoding\encodingdefault% |
| 1654 |
\fontfamily\ttdefault% |
| 1655 |
\fontseries\mdseries@tt% |
| 1656 |
\fontshape\shapedefault% |
| 1657 |
\small% |
| 1658 |
}% |
| 1659 |
\CheckCommand*\AltMacroFont{% |
| 1660 |
\fontencoding\encodingdefault% |
| 1661 |
\fontfamily\ttdefault% |
| 1662 |
\fontseries\mddefault% |
| 1663 |
\fontshape\sldefault% |
| 1664 |
\small% |
| 1665 |
}% |
| 1666 |
\renewcommand*\AltMacroFont{% |
| 1667 |
\fontencoding\encodingdefault% |
| 1668 |
\fontfamily\ttdefault% |
| 1669 |
\fontseries\mdseries@tt% |
| 1670 |
\fontshape\sldefault% |
| 1671 |
\small% |
| 1672 |
}% |
| 1673 |
% \end{macrocode} |
| 1674 |
% Am Ende der Präambel wird dafür gesorgt, dass der Befehl \cs{mdseries@tt} in |
| 1675 |
% jedem Fall definiert ist. |
| 1676 |
% \begin{macrocode} |
| 1677 |
\AtEndPreamble{% |
| 1678 |
\ifundef{\mdseries@tt}{\edef\mdseries@tt{\mddefault}}{}% |
| 1679 |
}% |
| 1680 |
} |
| 1681 |
% \end{macrocode} |
| 1682 |
% \end{macro}^^A \AltMacroFont |
| 1683 |
% \end{macro}^^A \MacroFont |
| 1684 |
% |
| 1685 |
% \iffalse |
| 1686 |
%</class&body> |
| 1687 |
%<*class&option> |
| 1688 |
% \fi |
| 1689 |
% |
| 1690 |
% Wird das Paket \pkg{tudscrfonts} genutzt, erscheinen die TypeWriter-Schriften |
| 1691 |
% zur Quelltextdokumentation sowohl für Latin~Modern als auch Roboto etwas zu |
| 1692 |
% schlank. |
| 1693 |
% \begin{macrocode} |
| 1694 |
\PassOptionsToPackage{ttfont=lmtt}{tudscrfonts} |
| 1695 |
\AfterPackage{tudscrfonts}{% |
| 1696 |
\AtEndPreamble{% |
| 1697 |
\ifnum\tud@ttfont@num>\z@\relax% |
| 1698 |
\edef\mdseries@tt{\tud@ttfont@bf}% |
| 1699 |
\fi% |
| 1700 |
}% |
| 1701 |
} |
| 1702 |
% \end{macrocode} |
| 1703 |
% |
| 1704 |
% \iffalse |
| 1705 |
%</class&option> |
| 1706 |
%<*class&body> |
| 1707 |
% \fi |
| 1708 |
% |
| 1709 |
% Um den zur Verfügung stehenden Platz möglichst effektiv zu nutzen, soll der |
| 1710 |
% Satzspiegel dahingehend aufgeteilt werden, dass für die Darstellung jeder |
| 1711 |
% Quelltextzeile genau 80~Zeichen zur Verfügung stehen. Dies ist allerdings |
| 1712 |
% abhängig von der geladenen TypeWriter-Schrift. Deshalb wird die Berechnung |
| 1713 |
% des Satzspiegels erst zum Beginn des Dokumentes ausgeführt, um auf etwaige |
| 1714 |
% Pakete zur Schriftauswahl reagieren zu können. |
| 1715 |
% |
| 1716 |
% \begin{macro}{\tud@setarea} |
| 1717 |
% \changes{v2.05g}{2016/11/10}{neu}^^A |
| 1718 |
% \begin{length}{\topmargin} |
| 1719 |
% \begin{length}{\headheight} |
| 1720 |
% \begin{length}{\headsep} |
| 1721 |
% \begin{length}{\footskip} |
| 1722 |
% \begin{length}{\textheight} |
| 1723 |
% \begin{length}{\textwidth} |
| 1724 |
% \begin{length}{\columnsep} |
| 1725 |
% \begin{length}{\labelsep} |
| 1726 |
% \begin{length}{\marginparsep} |
| 1727 |
% \begin{length}{\marginparwidth} |
| 1728 |
% \begin{length}{\oddsidemargin} |
| 1729 |
% Hiermit wird der Satzspiegel berechnet, wobei \length{labelsep} als Maß für |
| 1730 |
% die Seitenränder sowie den Abstand von Randnotizen und Textkörper dient. |
| 1731 |
% \begin{macrocode} |
| 1732 |
\newcommand*\tud@setarea{% |
| 1733 |
\tud@setdim\topmargin{-1in}% |
| 1734 |
\tud@setdim\headheight{0pt}% |
| 1735 |
\tud@setdim\headsep{3em}% |
| 1736 |
\tud@setdim\footskip{\headsep}% |
| 1737 |
\tud@setdim\textheight{\paperheight-\headsep*5/2-\footskip*3/2}% |
| 1738 |
\@colht=\textheight% |
| 1739 |
\@colroom=\textheight% |
| 1740 |
\vsize=\textheight% |
| 1741 |
\settowidth\MacroIndent{\rmfamily\scriptsize 0000\ }% |
| 1742 |
\begingroup% |
| 1743 |
\MacroFont\selectfont% |
| 1744 |
\settowidth\@tempdima{\space}% |
| 1745 |
\tud@setdim\@tempdima{80\@tempdima}% |
| 1746 |
\tud@addtodim\@tempdima{\MacroIndent}% |
| 1747 |
\edef\@tempa{% |
| 1748 |
\endgroup% |
| 1749 |
\unexpanded{\tud@setdim\textwidth}{\the\@tempdima}% |
| 1750 |
}% |
| 1751 |
\@tempa% |
| 1752 |
\columnwidth=\textwidth% |
| 1753 |
\hsize=\columnwidth% |
| 1754 |
\linewidth=\hsize% |
| 1755 |
\tud@setdim\columnsep{1em}% |
| 1756 |
\tud@setdim\labelsep{1em}% |
| 1757 |
\tud@setdim\marginparsep{\labelsep}% |
| 1758 |
\tud@setdim\oddsidemargin{\paperwidth-\textwidth-\labelsep-1in}% |
| 1759 |
\tud@setdim\marginparwidth{\oddsidemargin+1in-\labelsep-\marginparsep}% |
| 1760 |
} |
| 1761 |
\AtBeginDocument{\tud@setarea} |
| 1762 |
% \end{macrocode} |
| 1763 |
% \end{length}^^A \oddsidemargin |
| 1764 |
% \end{length}^^A \marginparwidth |
| 1765 |
% \end{length}^^A \marginparsep |
| 1766 |
% \end{length}^^A \labelsep |
| 1767 |
% \end{length}^^A \columnsep |
| 1768 |
% \end{length}^^A \textwidth |
| 1769 |
% \end{length}^^A \textheight |
| 1770 |
% \end{length}^^A \footskip |
| 1771 |
% \end{length}^^A \headsep |
| 1772 |
% \end{length}^^A \headheight |
| 1773 |
% \end{length}^^A \topmargin |
| 1774 |
% \end{macro}^^A \tud@setarea |
| 1775 |
% |
| 1776 |
% Sollte das Paket \pkg{tudscrfonts} nicht geladen worden sein, so wird das |
| 1777 |
% Paket \pkg{lmodern} geladen und die fehlenden Befehle zur Schriftauswahl |
| 1778 |
% rudimentär definiert. |
| 1779 |
% \begin{macrocode} |
| 1780 |
\TUD@UnwindPackage{tudscrfonts}{% |
| 1781 |
\RequirePackage{lmodern} |
| 1782 |
\providecommand*\textcdln[1]{\textsf{#1}}% |
| 1783 |
\providecommand*\textcdrn[1]{\textcdln{#1}}% |
| 1784 |
\providecommand*\textcdsn[1]{\textcdln{#1}}% |
| 1785 |
\providecommand*\textcdbn[1]{\textbf{\textcdln{#1}}}% |
| 1786 |
\providecommand*\textcdxn[1]{\textcdbn{#1}}% |
| 1787 |
\providecommand*\textcdli[1]{\textsl{\textcdln{#1}}}% |
| 1788 |
\providecommand*\textcdri[1]{\textcdli{#1}}% |
| 1789 |
\providecommand*\textcdsi[1]{\textcdli{#1}}% |
| 1790 |
\providecommand*\textcdbi[1]{\textbf{\textcdli{#1}}}% |
| 1791 |
\providecommand*\textcdxi[1]{\textcdbi{#1}}% |
| 1792 |
} |
| 1793 |
% \end{macrocode} |
| 1794 |
% |
| 1795 |
% \subsection{Zusätzliche Markup-Befehle} |
| 1796 |
% |
| 1797 |
% \begin{macro}{\app} |
| 1798 |
% \begin{macro}{\bdl} |
| 1799 |
% \begin{macro}{\cls} |
| 1800 |
% \begin{macro}{\pkg} |
| 1801 |
% \begin{macro}{\opt} |
| 1802 |
% \begin{macro}{\val} |
| 1803 |
% \begin{macro}{\default} |
| 1804 |
% \changes{v2.06o}{2022/07/25}{neu}^^A |
| 1805 |
% \begin{macro}{\pgs} |
| 1806 |
% \begin{macro}{\env} |
| 1807 |
% \begin{macro}{\prm} |
| 1808 |
% \changes{v2.05g}{2016/11/02}{neu}^^A |
| 1809 |
% \begin{macro}{\cnt} |
| 1810 |
% \changes{v2.05i}{2017/02/23}{neu}^^A |
| 1811 |
% \begin{macro}{\file} |
| 1812 |
% Zusätzliche Auszeichnungsbefehle. |
| 1813 |
% \ToDo{Befehl \cs{notebox}: siehe \file{svg.dtx}}[v2.07] |
| 1814 |
% \begin{macrocode} |
| 1815 |
\newrobustcmd*\app[1]{\mbox{\textsl{\textbf{#1}}}} |
| 1816 |
\newrobustcmd*\bdl[1]{\mbox{\textsf{\textbf{#1}}}} |
| 1817 |
\newrobustcmd*\cls[1]{\mbox{\textsf{\textbf{#1}}}} |
| 1818 |
\newrobustcmd*\pkg[1]{\mbox{\textsf{\textbf{#1}}}} |
| 1819 |
\newrobustcmd*\opt[1]{\mbox{\texttt{#1}}} |
| 1820 |
\newrobustcmd*\val[1]{\mbox{\texttt{#1}}} |
| 1821 |
\newrobustcmd*\default[1]{\val{\textit{#1}}} |
| 1822 |
\newrobustcmd*\pgs[1]{\mbox{\texttt{#1}}} |
| 1823 |
\newrobustcmd*\env[1]{\mbox{\texttt{#1}}} |
| 1824 |
\newrobustcmd*\prm[1]{\mbox{\texttt{#1}}} |
| 1825 |
\newrobustcmd*\cnt[1]{\mbox{\texttt{#1}}} |
| 1826 |
\newrobustcmd*\file[1]{\mbox{\texttt{#1}}} |
| 1827 |
\AfterPackage*{hyperref}{% |
| 1828 |
\pdfstringdefDisableCommands{% |
| 1829 |
\let\app\@firstofone% |
| 1830 |
\let\bdl\@firstofone% |
| 1831 |
\let\cls\@firstofone% |
| 1832 |
\let\pkg\@firstofone% |
| 1833 |
\let\opt\@firstofone% |
| 1834 |
\let\val\@firstofone% |
| 1835 |
\let\default\@firstofone% |
| 1836 |
\let\pgs\@firstofone% |
| 1837 |
\let\env\@firstofone% |
| 1838 |
\let\prm\@firstofone% |
| 1839 |
\let\file\@firstofone% |
| 1840 |
}% |
| 1841 |
} |
| 1842 |
% \end{macrocode} |
| 1843 |
% \end{macro}^^A \file |
| 1844 |
% \end{macro}^^A \cnt |
| 1845 |
% \end{macro}^^A \prm |
| 1846 |
% \end{macro}^^A \env |
| 1847 |
% \end{macro}^^A \pgs |
| 1848 |
% \end{macro}^^A \default |
| 1849 |
% \end{macro}^^A \val |
| 1850 |
% \end{macro}^^A \opt |
| 1851 |
% \end{macro}^^A \pkg |
| 1852 |
% \end{macro}^^A \cls |
| 1853 |
% \end{macro}^^A \bdl |
| 1854 |
% \end{macro}^^A \app |
| 1855 |
% |
| 1856 |
% \iffalse |
| 1857 |
%</class&body> |
| 1858 |
% \fi |
| 1859 |
% |
| 1860 |
% \PrintBackMatter |
| 1861 |
% |
| 1862 |
\endinput |