| 1 |
% \iffalse meta-comment |
| 2 |
%/GitFileInfo=tudscr-manual.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-manual.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.02}{2014/12/17}{Erstellung der \app{texindy}-Stildatei während |
| 63 |
% der Kompilierung}^^A |
| 64 |
% \changes{v2.02}{2014/11/18}{\pkg{tudscrmanual}: Index für Tutorials}^^A |
| 65 |
% \changes{v2.05}{2015/08/04}{Geteilte Deklarationen für Klasse und Paket}^^A |
| 66 |
% |
| 67 |
% |
| 68 |
% |
| 69 |
% \section{Anwenderdokumentation und Leitfäden zu \TUDScript} |
| 70 |
% |
| 71 |
% Es werden die Klasse \cls{tudscrmanual} (auf Basis von \cls{tudscrreprt}) für |
| 72 |
% die Anwenderdokumentation sowie das Paket \pkg{tudscrmanual} für das Setzen |
| 73 |
% von einigen Anwenderleitfäden bzw. Tutorials erzeugt. Da es zwischen der |
| 74 |
% Klasse und dem Paket es eine große Menge an Überschneidungen gibt, basieren |
| 75 |
% diese auf der gleichen Quelldatei. |
| 76 |
% \ToDo{guards überarbeiten, korrelierenden Quelltext zusammenhalten}[v2.07] |
| 77 |
% \begin{macrocode} |
| 78 |
%<*package&identify> |
| 79 |
\ProvidesPackage{tudscrmanual}[% |
| 80 |
%!TUD@Version |
| 81 |
package (tudscr tutorials)% |
| 82 |
] |
| 83 |
\TUD@Class@Check{tudscrtutorial} |
| 84 |
%</package&identify> |
| 85 |
% \end{macrocode} |
| 86 |
% |
| 87 |
% \iffalse |
| 88 |
%<*package&body> |
| 89 |
% \fi |
| 90 |
% |
| 91 |
% \subsection{Zusätzliche Pakete für das Paket \pkg{tudscrmanual}} |
| 92 |
% |
| 93 |
% Mit dem Paket \pkg{scrwfile} lassen sich Probleme mit zu wenig verfügbaren |
| 94 |
% Streams für das Schreiben externer Datein beheben. Hintergrund ist die |
| 95 |
% Verwendung des Paketes \pkg{glossaries} in einem der Tutorials, welches eine |
| 96 |
% Vielzahl solcher Streams benötigt. Das Paket \pkg{morewrites} hat keinen |
| 97 |
% Einfluss auf \pkg{glossaries}. |
| 98 |
% \begin{macrocode} |
| 99 |
\RequirePackage{scrwfile} |
| 100 |
% \end{macrocode} |
| 101 |
% |
| 102 |
% \iffalse |
| 103 |
%</package&body> |
| 104 |
%<*option> |
| 105 |
% \fi |
| 106 |
% |
| 107 |
% \subsection{% |
| 108 |
% Optionen für die Ausgabe von \cls{tudscrmanual} und \pkg{tudscrmanual}% |
| 109 |
% } |
| 110 |
% |
| 111 |
% \begin{option}{final} |
| 112 |
% \begin{option}{print} |
| 113 |
% \begin{macro}{\tudfinalflag} |
| 114 |
% \begin{macro}{\tudprintflag} |
| 115 |
% Diese beiden Optionen dienen zur finalen und/oder der unbunten Ausgabe. |
| 116 |
% \begin{macrocode} |
| 117 |
\TUD@key{final}[true]{% |
| 118 |
\TUD@set@ifkey{final}{@tempswa}{#1}% |
| 119 |
\ifx\FamilyKeyState\FamilyKeyStateProcessed% |
| 120 |
\if@tempswa% |
| 121 |
\let\tudfinalflag\relax% |
| 122 |
\fi% |
| 123 |
\fi% |
| 124 |
} |
| 125 |
\TUD@key{print}[true]{% |
| 126 |
\TUD@set@ifkey{print}{@tempswa}{#1}% |
| 127 |
\ifx\FamilyKeyState\FamilyKeyStateProcessed% |
| 128 |
\if@tempswa% |
| 129 |
\let\tudprintflag\relax% |
| 130 |
\fi% |
| 131 |
\fi% |
| 132 |
} |
| 133 |
% \end{macrocode} |
| 134 |
% Wurde eine oder beide der Optionen \opt{final} oder \opt{print} gesetzt bzw. |
| 135 |
% vor einem externen \app{pdflatex}-Aufruf die Flags \cs{tudfinalflag} und/oder |
| 136 |
% \cs{tudprintflag} definiert, werden die entsprechenden Einstellungen zur |
| 137 |
% finalen Ausgabe und/oder unbunten Druck vorgenommen und anschließend die |
| 138 |
% entsprechenden Optionen unschädlich gemacht. |
| 139 |
% \begin{macrocode} |
| 140 |
\AtEndPreamble{% |
| 141 |
\ifdef{\tudfinalflag}{% |
| 142 |
\TUDoptions{ToDo=false}% |
| 143 |
\TUD@key{ToDo}{\FamilyKeyStateProcessed}% |
| 144 |
}{% |
| 145 |
\KOMAoptions{overfullrule}% |
| 146 |
}% |
| 147 |
\ifdef{\tudprintflag}{% |
| 148 |
\ifnum\tud@cd@num>\z@\relax% |
| 149 |
\TUDoptions{cd=true}% |
| 150 |
\fi% |
| 151 |
\TUD@key{cd}{\FamilyKeyStateProcessed}% |
| 152 |
\ifundef{\hypersetup}{}{\hypersetup{hidelinks}}% |
| 153 |
}{}% |
| 154 |
} |
| 155 |
% \end{macrocode} |
| 156 |
% \end{macro}^^A \tudprintflag |
| 157 |
% \end{macro}^^A \tudfinalflag |
| 158 |
% \end{option}^^A print |
| 159 |
% \end{option}^^A final |
| 160 |
% |
| 161 |
% \iffalse |
| 162 |
%<*class> |
| 163 |
% \fi |
| 164 |
% |
| 165 |
% \subsection{Standardoptionen der Klasse \cls{tudscrmanual}} |
| 166 |
% |
| 167 |
% Es werden einige Optionen für das Handbuch standardmäßig aktiviert. Dazu |
| 168 |
% werden diese an die entsprechende Elternklasse übergeben. |
| 169 |
% \begin{macrocode} |
| 170 |
\PassOptionsToClass{% |
| 171 |
cdfoot=true,% |
| 172 |
chapterpage=true,% |
| 173 |
chapterprefix=true,% |
| 174 |
headings=optiontoheadandtoc,% |
| 175 |
captions=tableheading,% |
| 176 |
numbers=noenddot,% |
| 177 |
cd=color,% |
| 178 |
}{\TUD@Class@Parent} |
| 179 |
\PassOptionsToPackage{automark}{scrlayer-scrpage} |
| 180 |
% \end{macrocode} |
| 181 |
% |
| 182 |
% \iffalse |
| 183 |
%</class> |
| 184 |
%</option> |
| 185 |
%<*body> |
| 186 |
%<*class> |
| 187 |
% \fi |
| 188 |
% |
| 189 |
% \subsection{Debug-Traces für die Klasse \cls{tudscrmanual}} |
| 190 |
% |
| 191 |
% Ab und an ist es beim Erstellen des Handbuchs recht sinnvoll, verschiedene |
| 192 |
% Dinge direkt im Logfile zu überprüfen. Hierfür werden folgend einige Befehle |
| 193 |
% zur Ablaufkontrolle definiert. |
| 194 |
% |
| 195 |
% \begin{macro}{\tracinglabels} |
| 196 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 197 |
% \begin{macro}{\tud@trace@lbl@created@add} |
| 198 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 199 |
% \begin{macro}{\tud@trace@lbl@missing@add} |
| 200 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 201 |
% \begin{macro}{\tud@trace@lbl@created@list} |
| 202 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 203 |
% \begin{macro}{\tud@trace@lbl@missing@list} |
| 204 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 205 |
% Mit \cs{tracinglabels} wird die Nachverfolgung aller erstellten Labels in der |
| 206 |
% Dokumentation aktiviert werden. Die Label werden zum einen direkt im Logfile |
| 207 |
% ausgegeben und am Ende des selbigen in einer sortierten Liste ausgegeben. Die |
| 208 |
% Sternversion des Befehls erzeugt keine sortierte Liste. Über das optionale |
| 209 |
% Argument kann mit verschiedenen Schlüsseln zudem eingestellt werden, ob alle |
| 210 |
% Label (\val{all}) oder nur die erstellten (\val{created}) beziehungsweise die |
| 211 |
% fehlenden (\val{missing}) nachverfolgt werden sollen. |
| 212 |
% \begin{macrocode} |
| 213 |
\newcommand*\tud@trace@lbl@created@add[1]{} |
| 214 |
\newcommand*\tud@trace@lbl@missing@add[1]{} |
| 215 |
\NewDocumentCommand\tracinglabels{!s !O{missing}}{% |
| 216 |
\newcommand*\tud@trace@lbl@created@list{}% |
| 217 |
\newcommand*\tud@trace@lbl@missing@list{}% |
| 218 |
\@tempswafalse% |
| 219 |
\tud@if@strequal{#2}{created}{\@tempswatrue}{}% |
| 220 |
\tud@if@strequal{#2}{all}{\@tempswatrue}{}% |
| 221 |
\if@tempswa% |
| 222 |
\renewcommand*\tud@trace@lbl@created@add[1]{% |
| 223 |
\typeout{% |
| 224 |
+++++ label created: ##1 on page \thepage% |
| 225 |
}% |
| 226 |
\xifinlist{##1}{\tud@trace@lbl@created@list}{}{% |
| 227 |
\listxadd\tud@trace@lbl@created@list{##1}% |
| 228 |
}% |
| 229 |
}% |
| 230 |
\IfBooleanF{#1}{% |
| 231 |
\AfterEndDocument{% |
| 232 |
\typeout{+++++ labels created (sorted) +++++}% |
| 233 |
\tud@list@sort\tud@trace@lbl@created@list% |
| 234 |
\forlistloop\typeout{\tud@trace@lbl@created@list}% |
| 235 |
}% |
| 236 |
}% |
| 237 |
\fi% |
| 238 |
\@tempswafalse% |
| 239 |
\tud@if@strequal{#2}{missing}{\@tempswatrue}{}% |
| 240 |
\tud@if@strequal{#2}{all}{\@tempswatrue}{}% |
| 241 |
\if@tempswa% |
| 242 |
\renewcommand*\tud@trace@lbl@missing@add[1]{% |
| 243 |
\typeout{% |
| 244 |
+++++ label missing: ##1 on page \thepage% |
| 245 |
}% |
| 246 |
\xifinlist{##1}{\tud@trace@lbl@missing@list}{}{% |
| 247 |
\listxadd\tud@trace@lbl@missing@list{##1}% |
| 248 |
}% |
| 249 |
}% |
| 250 |
\IfBooleanF{#1}{% |
| 251 |
\AfterEndDocument{% |
| 252 |
\typeout{+++++ labels missing (sorted) +++++}% |
| 253 |
\tud@list@sort\tud@trace@lbl@missing@list% |
| 254 |
\forlistloop\typeout{\tud@trace@lbl@missing@list}% |
| 255 |
}% |
| 256 |
}% |
| 257 |
\fi% |
| 258 |
} |
| 259 |
\@onlypreamble\tracinglabels |
| 260 |
% \end{macrocode} |
| 261 |
% \end{macro}^^A \tud@trace@lbl@missing@list |
| 262 |
% \end{macro}^^A \tud@trace@lbl@created@list |
| 263 |
% \end{macro}^^A \tud@trace@lbl@missing@add |
| 264 |
% \end{macro}^^A \tud@trace@lbl@created@add |
| 265 |
% \end{macro}^^A \tracinglabels |
| 266 |
% \begin{macro}{\tracingmarkup} |
| 267 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 268 |
% \begin{macro}{\tud@trace@markup} |
| 269 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 270 |
% Mit \cs{tracinglabels} wird die Nachverfolgung aller Aufrufe von |
| 271 |
% \cs{Process@@MarkupDeclare} und \cs{Process@@MarkupInline} durch |
| 272 |
% \cs{Process@Markup} inklusive all ihrer Argumente aktiviert. Dies ist für die |
| 273 |
% Kontrolle des erzeugten Markups sinnvoll. |
| 274 |
% \begin{macrocode} |
| 275 |
\newcommand*\tud@trace@markup[2]{} |
| 276 |
\newcommand*\tracingmarkup{% |
| 277 |
\renewcommand*\tud@trace@markup[2]{% |
| 278 |
\typeout{+++++ markup ##1 on page \thepage^^J##2}% |
| 279 |
}% |
| 280 |
} |
| 281 |
\@onlypreamble\tracingmarkup |
| 282 |
% \end{macrocode} |
| 283 |
% \end{macro}^^A \tud@trace@markup |
| 284 |
% \end{macro}^^A \tracingmarkup |
| 285 |
% \begin{macro}{\tracingbundle} |
| 286 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 287 |
% \begin{macro}{\tud@trace@bdl@add} |
| 288 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 289 |
% \begin{macro}{\tud@trace@bdl@list} |
| 290 |
% \changes{v2.05}{2015/10/29}{neu}^^A |
| 291 |
% Wird \cs{tracingbundle} in der Präambel verwendet, werden alle direkt oder |
| 292 |
% indirekt durch \cs{Process@Markup} im Handbuch erzeugten Querverweise auf |
| 293 |
% Klassen oder Pakete aus dem \TUDScript-Bundle nachverfolgt und am Ende des |
| 294 |
% Logfiles ausgegeben. Damit kann im Zweifel übeprüft werden, ob eventuell eine |
| 295 |
% falsche Referenz genutzt wurde, wodurch u.\,U. Querverweise oder Einträge in |
| 296 |
% Index und Änderungsliste fehlerhaft werden oder erst gar nicht erscheinen. |
| 297 |
% \begin{macrocode} |
| 298 |
\newcommand*\tud@trace@bdl@add[1]{} |
| 299 |
\newcommand*\tud@trace@bdl@list{} |
| 300 |
\newcommand*\tracingbundle{% |
| 301 |
\renewcommand*\tud@trace@bdl@add[1]{% |
| 302 |
\begingroup% |
| 303 |
\def\Class####1{class:####1}% |
| 304 |
\def\Package####1{package:####1}% |
| 305 |
\xifinlist{##1}{\tud@trace@bdl@list}{}{% |
| 306 |
\listxadd\tud@trace@bdl@list{##1}% |
| 307 |
}% |
| 308 |
\endgroup% |
| 309 |
}% |
| 310 |
\AfterEndDocument{% |
| 311 |
\typeout{+++++ bundle list +++++}% |
| 312 |
\forlistloop\typeout{\tud@trace@bdl@list}% |
| 313 |
}% |
| 314 |
} |
| 315 |
\@onlypreamble\tracingbundle |
| 316 |
% \end{macrocode} |
| 317 |
% \end{macro}^^A \tud@trace@bdl@list |
| 318 |
% \end{macro}^^A \tud@trace@bfundle |
| 319 |
% \end{macro}^^A \tracingbundle |
| 320 |
% |
| 321 |
% \iffalse |
| 322 |
%</class> |
| 323 |
% \fi |
| 324 |
% |
| 325 |
% \subsection{Anpassungen für das Paket \pkg{hyperref} und Querverweise} |
| 326 |
% |
| 327 |
% Die Bezeichner für die Abschnittsebenen werden umbenannt. |
| 328 |
% \begin{macrocode} |
| 329 |
\AfterPackage*{hyperref}{% |
| 330 |
\renewcaptionname{ngerman}{\sectionautorefname}{Unterkapitel}% |
| 331 |
\renewcaptionname{ngerman}{\subsectionautorefname}{Abschnitt}% |
| 332 |
\renewcaptionname{ngerman}{\subsubsectionautorefname}{Unterabschnitt}% |
| 333 |
% \end{macrocode} |
| 334 |
% \begin{macro}{\tudhyperdef} |
| 335 |
% \changes{v2.02}{2014/10/27}{neu}^^A |
| 336 |
% \begin{macro}{\tudhyperref} |
| 337 |
% \changes{v2.02}{2014/10/27}{neu}^^A |
| 338 |
% \begin{macro}{\tud@manualname} |
| 339 |
% \changes{v2.05}{2015/11/19}{neu}^^A |
| 340 |
% Diese Befehle dienen sowohl zum Definieren von Textankern im Handbuch als |
| 341 |
% auch zum Referenzieren auf diese. Bei der Erstellung des Ankers mit |
| 342 |
% \cs{tudhyperdef} wird zusätzlich auch noch ein Label (\cs{label}) erzeugt. |
| 343 |
% Der Anker wird mit \cs{Hy@raisedlink}~-- wie es auch bei pkg{hyperref}-Labels |
| 344 |
% geschieht~-- über die Grundlinie gehoben. Die Sternversion sollte nach |
| 345 |
% Überschriften verwendet werden und verschiebt die vertikale Position des |
| 346 |
% Ankers noch weiter nach oben. |
| 347 |
% \begin{macrocode} |
| 348 |
\newcommand*\tud@manualname{tudscr}% |
| 349 |
%<*class> |
| 350 |
\NewDocumentCommand\tudhyperdef{s t' m}{% |
| 351 |
\@tempswafalse% |
| 352 |
\IfBooleanT{#1}{\@tempswatrue\tud@setdim\@tempdima{3\baselineskip}}% |
| 353 |
\IfBooleanT{#2}{\@tempswatrue\tud@setdim\@tempdima{15\baselineskip}}% |
| 354 |
\if@tempswa% |
| 355 |
\raisebox{\@tempdima}[0pt][0pt]{\hyperdef{\tud@manualname}{#3}{}}% |
| 356 |
\par\nobreak\vskip-\parskip\vskip-\baselineskip% |
| 357 |
\@afterindentfalse\@afterheading% |
| 358 |
\else% |
| 359 |
\Hy@raisedlink{\hyperdef{\tud@manualname}{#3}{}}\ignorespaces% |
| 360 |
\fi% |
| 361 |
\label{#3}% |
| 362 |
\tud@trace@lbl@created@add{#3}% |
| 363 |
}% |
| 364 |
\newcommand*\tudhyperref[2]{\hyperref{}{\tud@manualname}{#1}{#2}}% |
| 365 |
%</class> |
| 366 |
% \end{macrocode} |
| 367 |
% Aus einem Tutorial erfolgen alle Querverweise mit \cs{tudhyperref} auf das |
| 368 |
% Anwenderhandbuch \enquote*{tudscr} im übergeordneten Ordner. |
| 369 |
% \begin{macrocode} |
| 370 |
%<*package> |
| 371 |
\newcommand*\tudhyperref[2]{% |
| 372 |
\hyperref{../\[email protected]}{\tud@manualname}{#1}{#2}% |
| 373 |
}% |
| 374 |
%</package> |
| 375 |
% \end{macrocode} |
| 376 |
% \end{macro}^^A \tud@manualname |
| 377 |
% \end{macro}^^A \tudhyperref |
| 378 |
% \end{macro}^^A \tudhyperdef |
| 379 |
% \begin{macro}{\autorefname} |
| 380 |
% \begin{macro}{\auto@refname} |
| 381 |
% \begin{macro}{\auto@@refname} |
| 382 |
% Der Befehl \cs{autorefname} dient dazu, den Verweistyp beziehungsweise den |
| 383 |
% Bezeichner des aktuellen~-- oder optional eines speziellen~-- Labels ohne die |
| 384 |
% dazugehörige Nummerierung zu erhalten. Das zugrunde liegende Funktionsprinzip |
| 385 |
% wurde bei \hrfn{http://tex.stackexchange.com/q/33776/}{LaTeX Stack Exchange} |
| 386 |
% vorgestellt und hier übernommen. |
| 387 |
% \begin{macrocode} |
| 388 |
\newcommand*\autorefname[1][current]{% |
| 389 |
\tud@if@strequal{#1}{current}{% |
| 390 |
\expandafter\HyPsd@@autorefname\@currentHref\@nil% |
| 391 |
}{% |
| 392 |
\auto@refname\HyPsd@@autorefname{#1}% |
| 393 |
}% |
| 394 |
\unskip\xspace% |
| 395 |
}% |
| 396 |
\newcommand*\auto@refname[2]{% |
| 397 |
\expandafter\ifx\csname r@#2\endcsname\relax% |
| 398 |
??% |
| 399 |
\else% |
| 400 |
\expandafter\expandafter\expandafter\auto@@refname% |
| 401 |
\csname r@#2\endcsname{}{}{}{}\@nil#1\@nil% |
| 402 |
\fi% |
| 403 |
}% |
| 404 |
\newcommand*\auto@@refname{}% |
| 405 |
\def\auto@@refname#1#2#3#4#5\@nil#6\@nil{#6#4.\@nil}% |
| 406 |
% \end{macrocode} |
| 407 |
% \end{macro}^^A \auto@@refname |
| 408 |
% \end{macro}^^A \auto@refname |
| 409 |
% \end{macro}^^A \autorefname |
| 410 |
% |
| 411 |
% Das war's. Damit sind die Ausführungen für das Paket \pkg{hyperref} beendet. |
| 412 |
% \begin{macrocode} |
| 413 |
} |
| 414 |
% \end{macrocode} |
| 415 |
% Sollte das Paket \pkg{hyperref} nicht geladen werden, wird eine Rückfallebene |
| 416 |
% definiert, wodurch die Klasse dennoch verwendet werden kann. |
| 417 |
% \begin{macrocode} |
| 418 |
\TUD@UnwindPackage{hyperref}{% |
| 419 |
% \end{macrocode} |
| 420 |
% Zunächst die direkt innerhalb der Dokumentation verwendeten Befehle nebst |
| 421 |
% dazugehöriger Warnung. |
| 422 |
% \begin{macrocode} |
| 423 |
%<*class> |
| 424 |
\ClassWarningNoLine{tudscrmanual}% |
| 425 |
%</class> |
| 426 |
%<*package> |
| 427 |
\PackageWarningNoLine{tudscrmanual}% |
| 428 |
%</package> |
| 429 |
{% |
| 430 |
It is strongly recommended to load package `hyperref'. \MessageBreak% |
| 431 |
Nevertheless, essential commands are rudimentarily\MessageBreak% |
| 432 |
defined. At least the package `url' is loaded% |
| 433 |
}% |
| 434 |
% \end{macrocode} |
| 435 |
% |
| 436 |
% \begin{macro}{\hyperpage} |
| 437 |
% \begin{macro}{\autoref} |
| 438 |
% Der Befehl \cs{autoref} wird auch in der Sternversion genutzt. |
| 439 |
% \begin{macrocode} |
| 440 |
\providecommand*\hyperpage[1]{#1}% |
| 441 |
\providecommand*\autoref{??\xspace\kernel@ifstar{\ref}{\ref}}% |
| 442 |
% \end{macrocode} |
| 443 |
% \end{macro}^^A \autoref |
| 444 |
% \end{macro}^^A \hyperpage |
| 445 |
% \begin{macro}{\hyperdef} |
| 446 |
% \begin{macro}{\hyperref} |
| 447 |
% \begin{macro}{\tud@hyperref@a} |
| 448 |
% \begin{macro}{\tud@hyperref@b} |
| 449 |
% Mit \cs{hyperdef} wird ein ein Label direkt vor dem Text eingefügt. |
| 450 |
% \begin{macrocode} |
| 451 |
\providecommand*\hyperdef[3]{\label{#1.#2}#3}% |
| 452 |
% \end{macrocode} |
| 453 |
% Der Befehl \cs{hyperref} existiert in zwei Varianten. Entweder mit einem |
| 454 |
% optionalen und einem obligatorischen Argument oder mit vier Argumenten. |
| 455 |
% \begin{macrocode} |
| 456 |
\providerobustcmd*\hyperref{% |
| 457 |
\kernel@ifnextchar[{\tud@hyperref@a}{\tud@hyperref@b}% |
| 458 |
} |
| 459 |
\newcommand*\tud@hyperref@a[2][]{#2} |
| 460 |
\newcommand*\tud@hyperref@b[4]{#4} |
| 461 |
% \end{macrocode} |
| 462 |
% \end{macro}^^A \tud@hyperref@b |
| 463 |
% \end{macro}^^A \tud@hyperref@a |
| 464 |
% \end{macro}^^A \hyperref |
| 465 |
% \end{macro}^^A \hyperdef |
| 466 |
% \begin{macro}{\partautorefname} |
| 467 |
% \begin{macro}{\chapterautorefname} |
| 468 |
% \begin{macro}{\sectionautorefname} |
| 469 |
% \begin{macro}{\subsectionautorefname} |
| 470 |
% \begin{macro}{\subsubsectionautorefname} |
| 471 |
% Die notwendigen, lokalen Bezeichner der Gliederungsebenen. |
| 472 |
% \begin{macrocode} |
| 473 |
\tud@localization@german{\partautorefname}{Teil}% |
| 474 |
\tud@localization@german{\chapterautorefname}{Kapitel}% |
| 475 |
\tud@localization@german{\sectionautorefname}{Unterkapitel}% |
| 476 |
\tud@localization@german{\subsectionautorefname}{Abschnitt}% |
| 477 |
\tud@localization@german{\subsubsectionautorefname}{Unterabschnitt}% |
| 478 |
\tud@localization@english{\partautorefname}{Part}% |
| 479 |
\tud@localization@english{\chapterautorefname}{chapter}% |
| 480 |
\tud@localization@english{\sectionautorefname}{section}% |
| 481 |
\tud@localization@english{\subsectionautorefname}{subsection}% |
| 482 |
\tud@localization@english{\subsubsectionautorefname}{subsubsection}% |
| 483 |
% \end{macrocode} |
| 484 |
% \end{macro}^^A \subsubsectionautorefname |
| 485 |
% \end{macro}^^A \subsectionautorefname |
| 486 |
% \end{macro}^^A \sectionautorefname |
| 487 |
% \end{macro}^^A \chapterautorefname |
| 488 |
% \end{macro}^^A \partautorefname |
| 489 |
% Anschließend folgen die für Anwenderdokumentation eigens definierten Befehle. |
| 490 |
% \begin{macrocode} |
| 491 |
%<*class> |
| 492 |
\ProvideDocumentCommand\tudhyperdef{st'm}{\label{#3}}% |
| 493 |
%</class> |
| 494 |
\providecommand*\tudhyperref[2]{#2}% |
| 495 |
\providecommand*\autorefname[1][]{??\xspace}% |
| 496 |
} |
| 497 |
% \end{macrocode} |
| 498 |
% |
| 499 |
% \begin{macro}{\fullref} |
| 500 |
% Verbesserte Referenzierungen auf Seiten. |
| 501 |
% \begin{macrocode} |
| 502 |
\RequirePackage{varioref} |
| 503 |
\renewcommand*\fullref[1]{\hyperref[{#1}]{\autoref*{#1} \vpageref{#1}}} |
| 504 |
% \end{macrocode} |
| 505 |
% \end{macro}^^A \fullref |
| 506 |
% |
| 507 |
% \iffalse |
| 508 |
%<*class> |
| 509 |
% \fi |
| 510 |
% |
| 511 |
% \subsection{Deklarationsumgebungen für die Klasse \cls{tudscrmanual}} |
| 512 |
% |
| 513 |
% Die Umgebungen beiden \env{Declaration} und \env{Declaration*} sowie |
| 514 |
% \env{Obsolete} und \env{Bundle} werden für die Beschreibung von Optionen, |
| 515 |
% Umgebungen, Befehlen etc. verwendet, welche von \TUDScript dem Anwender zur |
| 516 |
% Verfügung gestellt werden. |
| 517 |
% |
| 518 |
% \begin{macro}{\if@tud@declare} |
| 519 |
% \begin{macro}{\if@openindex} |
| 520 |
% \begin{macro}{\tud@declare@num} |
| 521 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 522 |
% Dies sin ein paar Hilfsmakros zur Steuerung des Markup sowie der Ausgabe von |
| 523 |
% Deklarationen, Index und Änderungsliste, welche bei den nächsten Befehlen und |
| 524 |
% Umgebungen genutzt werden. Mit \cs{if@tud@declare} wird festgelegt, ob die |
| 525 |
% Befehle für das Markup in der Ausgabe als Deklaration oder anderweiteig |
| 526 |
% erfolgt. Der Schalter \cs{if@openindex} wird zu Beginn einer Deklaration auf |
| 527 |
% \val{true} gesetzt und vor dem Beenden auf \val{false}. Damit wird bestimmt, |
| 528 |
% ob ein öffnender oder ein schließender Indexeintrag erzeugt werden soll. |
| 529 |
% \begin{macrocode} |
| 530 |
\tud@newif\if@tud@declare |
| 531 |
\tud@newif\if@openindex |
| 532 |
% \end{macrocode} |
| 533 |
% Das Makro \cs{tud@declare@num} bestimmt innerhalb einer Deklaration, wie |
| 534 |
% das Markup erfolgen soll. Die möglichen Werte sind bei der Beschreibung von |
| 535 |
% \cs{Process@@MarkupDeclare} zu finden. |
| 536 |
% \begin{macrocode} |
| 537 |
\newcommand*\tud@declare@num{0} |
| 538 |
% \end{macrocode} |
| 539 |
% \end{macro}^^A \tud@declare@num |
| 540 |
% \end{macro}^^A \if@openindex |
| 541 |
% \end{macro}^^A \if@tud@declare |
| 542 |
% \begin{environment}{Declaration} |
| 543 |
% \begin{environment}{Obsolete} |
| 544 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 545 |
% \begin{macro}{\tud@declaration@list} |
| 546 |
% \begin{macro}{\if@tud@obsolete} |
| 547 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 548 |
% Es werden einige Hilfsmakros für die Ausgabe einer Deklaration sowie der |
| 549 |
% dazugehörigen Änderungsliste initialisiert. |
| 550 |
% \begin{macrocode} |
| 551 |
\newcommand*\tud@declaration@list{} |
| 552 |
\let\tud@declaration@list\relax |
| 553 |
% \end{macrocode} |
| 554 |
% Die \env{Declaration}-Umgebung dient zur Deklaration von Optionen, Umgebungen, |
| 555 |
% Befehlen, Parametern, Bezeichnern, Längen, Schriftelementen und Farben. Diese |
| 556 |
% werden mit den entsprechenden Auszeichnungsbefehlen als obligatorisches |
| 557 |
% Argument übergeben. Zuvor kann noch vorher im ersten optionalen Argument eine |
| 558 |
% Beschreibung für die Änderungsliste in der Form \oarg{Verison!Beschreibung} |
| 559 |
% angegeben werden. Danach kann im dritten Argument~-- das zweite optionale~-- |
| 560 |
% die Voreinstellung für eine Option oder dergleichen angegeben werden. Das |
| 561 |
% nächste optionale Argument erlaubt die Angabe einer bedingten Voreinstellung, |
| 562 |
% also einer anderen Voreinstellung als der zuerst angegeben unter bestimmten |
| 563 |
% Voraussetzungen. Diese wird in der Form \oarg{Bedingung:Voreinstellung} |
| 564 |
% angegeben. Das letzte Argument ist ebenfalls optional, wird aber in der Form |
| 565 |
% \marg{Zusatz} angegeben und enthält ggf. zusätzliche Informationen. |
| 566 |
% |
| 567 |
% Die Umgebung \env{Obsolete} hat eine ganz ähnliche Funktion, wird allerdings |
| 568 |
% für die Deklaration veralteter Befehle, Umgebungen, Optionen etc. verwendet. |
| 569 |
% Da sich beide Umgebungen stark ähneln, werden zum Start bzw. zum Abschluss |
| 570 |
% die Makros \cs{tud@declare@start} bzw. \cs{tud@declare@end} aufgerufen. Zu |
| 571 |
% Beginn wird nichts weiter ausgegeben sondern lediglich alle übergebenen |
| 572 |
% Argumente in jeweiligen Listen gesammelt. Die eigentliche Ausgabe der |
| 573 |
% Deklaration erfolgt mit dem Befehl \cs{printdeclarationlist} bezieungsweise |
| 574 |
% \cs{printobsoletelist}. |
| 575 |
% \begin{macrocode} |
| 576 |
\NewDocumentEnvironment{Declaration}{omoog}{% |
| 577 |
\listadd\tud@declaration@list{#2}% |
| 578 |
\tud@declare@start[#1]{#2}[#3][#4]{#5}% |
| 579 |
}{% |
| 580 |
\tud@declare@end{#2}{\printdeclarationlist}% |
| 581 |
} |
| 582 |
% \end{macrocode} |
| 583 |
% Für die Umgebung \env{Obsolete} sieht die Eingabe etwas anders aus. Das erste |
| 584 |
% obligatorische Argument sollte eine Versionsnummer enthalten, ab wann die |
| 585 |
% Deklaration veraltet ist. Das erste optionale Argument wird genutzt, wenn |
| 586 |
% für eine weiterhin gültige Deklaration lediglich ein bestimmter Wert |
| 587 |
% entfällt. Wird das erste Argument leer gelassen, erfolgt lediglich die |
| 588 |
% Ausgabe der Deklaration ohne einen Eintrag in die Änderungsliste. Dies ist |
| 589 |
% für Umgebungen und Befehle gedacht, bei denen lediglich ein oder mehrere |
| 590 |
% Parameter geändert wurden bzw. entfallen. |
| 591 |
% \begin{macrocode} |
| 592 |
\tud@newif\if@tud@obsolete |
| 593 |
\NewDocumentEnvironment{Obsolete}{momoog}{% |
| 594 |
\@tud@obsoletetrue% |
| 595 |
\tud@if@strblank{#1}{% |
| 596 |
% \end{macrocode} |
| 597 |
% Ohne Versionsnummer erfolgt die Ausgabe ohne Label. Für den Eintrag wird auch |
| 598 |
% keine Änderungsnotiz erzeugt. |
| 599 |
% \begin{macrocode} |
| 600 |
\listadd\tud@declaration@list{% |
| 601 |
\def\tud@declare@num{1}% |
| 602 |
#3% |
| 603 |
\def\tud@declare@num{0}% |
| 604 |
}% |
| 605 |
\tud@declare@start{#3}[#4][#5]{#6}% |
| 606 |
}{% |
| 607 |
\listadd\tud@declaration@list{#3}% |
| 608 |
% \end{macrocode} |
| 609 |
% Wurde ein optionales Argument angegeben, bezieht sich der Änderungseintrag |
| 610 |
% auf ebendieses Argument, die eigentliche, obsolete Deklaration wird als |
| 611 |
% Untereintrag genutzt. |
| 612 |
% \begin{macrocode} |
| 613 |
\IfValueTF{#2}{% |
| 614 |
\Changed@At@CreateList[#2]{#1!#3}% |
| 615 |
}{% |
| 616 |
\Changed@At@CreateList[#3]{#1}% |
| 617 |
}% |
| 618 |
\IfValueTF{#6}{% |
| 619 |
\tud@declare@start{#3}[#4][#5]{#6}% |
| 620 |
% \end{macrocode} |
| 621 |
% Ohne eine zusätzliche Angabe imletzten optionalen Argument wird standardmäßig |
| 622 |
% der Entfall der Deklaration angegeben. Alternativ dazu kann im ersten |
| 623 |
% Argument der Versionsangabe mit einem Dopppelpunkt von dieser getrennt eine |
| 624 |
% neue bzw. aktuell gültige Deklaration als Querverweis angegeben werden. |
| 625 |
% \begin{macrocode} |
| 626 |
}{% |
| 627 |
\toks@{\tud@declare@start{#3}[#4][#5]}% |
| 628 |
\def\@tempa{\emph{entf\"allt}}% |
| 629 |
\in@{:}{#1}% |
| 630 |
\ifin@% |
| 631 |
\def\@tempb##1:##2\@nil{% |
| 632 |
\IfArgIsEmpty{##2}{}{% |
| 633 |
\def\@tempa{\seeref{##2'page'}}% |
| 634 |
}% |
| 635 |
}% |
| 636 |
\@tempb#1\@nil% |
| 637 |
\fi% |
| 638 |
\addto@hook@expandafter\toks@{\expandafter{\@tempa}}% |
| 639 |
\the\toks@% |
| 640 |
}% |
| 641 |
}% |
| 642 |
\@tud@obsoletefalse% |
| 643 |
}{% |
| 644 |
\@tud@obsoletetrue% |
| 645 |
\tud@declare@end{#3}{\printobsoletelist}% |
| 646 |
\@tud@obsoletefalse% |
| 647 |
} |
| 648 |
% \end{macrocode} |
| 649 |
% \end{macro}^^A \if@tud@obsolete |
| 650 |
% \end{macro}^^A \tud@declaration@list |
| 651 |
% \end{environment}^^A Obsolete |
| 652 |
% \end{environment}^^A Declaration |
| 653 |
% \begin{macro}{\tud@preset@list} |
| 654 |
% \begin{macro}{\if@tud@preset@list} |
| 655 |
% \begin{macro}{\tud@additional@list} |
| 656 |
% \begin{macro}{\if@tud@additional@list} |
| 657 |
% Dies sind die temporären listen, die für alle Deklarationen verwendet werden. |
| 658 |
% \begin{macrocode} |
| 659 |
\newcommand*\tud@preset@list{} |
| 660 |
\let\tud@preset@list\relax |
| 661 |
\tud@newif\if@tud@preset@list |
| 662 |
\newcommand*\tud@additional@list{} |
| 663 |
\let\tud@additional@list\relax |
| 664 |
\tud@newif\if@tud@additional@list |
| 665 |
% \end{macrocode} |
| 666 |
% \end{macro}^^A \if@tud@additional@list |
| 667 |
% \end{macro}^^A \tud@additional@list |
| 668 |
% \end{macro}^^A \if@tud@preset@list |
| 669 |
% \end{macro}^^A \tud@preset@list |
| 670 |
% \begin{macro}{\tud@declare@start} |
| 671 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 672 |
% \begin{macro}{\tud@declare@end} |
| 673 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 674 |
% Dies sind die Makros für die eigentliche Abarbeitung der Deklarationsbefehle |
| 675 |
% zu Beginn und Ende der Umgebungen \env{Declaration} und \env{Obsolete}. |
| 676 |
% \begin{macrocode} |
| 677 |
\NewDocumentCommand\tud@declare@start{omr[]r[]m}{% |
| 678 |
% \end{macrocode} |
| 679 |
% Die optional angegebenen Änderungen werden mit \cs{Changed@At@CreateList} in |
| 680 |
% der Liste \cs{tud@changedat@list} gesichert und später sowohl für die |
| 681 |
% Randnotiz als auch die Änderungsliste verarbeitet. |
| 682 |
% \begin{macrocode} |
| 683 |
\Changed@At@CreateList[#2]{#1}% |
| 684 |
% \end{macrocode} |
| 685 |
% Hier noch die Listen für Voreinstellungen\dots |
| 686 |
% \begin{macrocode} |
| 687 |
\IfValueTF{#3}{% |
| 688 |
\@tud@preset@listtrue% |
| 689 |
\def\@tempa{Voreinstellung: \PValue{#3}}% |
| 690 |
\IfValueT{#4}{% |
| 691 |
\def\@tempb[##1:##2]{##1: \PValue{##2}}% |
| 692 |
\eappto\@tempa{ | \expandonce{\@tempb[#4]}}% |
| 693 |
}% |
| 694 |
\listeadd\tud@preset@list{\expandonce\@tempa}% |
| 695 |
}{% |
| 696 |
\listadd\tud@preset@list{\relax}% |
| 697 |
}% |
| 698 |
% \end{macrocode} |
| 699 |
% \dots sowie zusätliche Informationen. |
| 700 |
% \begin{macrocode} |
| 701 |
\IfValueTF{#5}{% |
| 702 |
\@tud@additional@listtrue% |
| 703 |
\listadd\tud@additional@list{(#5)}% |
| 704 |
\in@{\Environment}{#2}% |
| 705 |
\ifin@\listadd\tud@additional@list{\tabularnewline}\fi% |
| 706 |
}{% |
| 707 |
\listadd\tud@additional@list{\relax}% |
| 708 |
\in@{\Environment}{#2}% |
| 709 |
\ifin@% |
| 710 |
\listadd\tud@additional@list{\relax}% |
| 711 |
\listadd\tud@additional@list{\relax}% |
| 712 |
\fi% |
| 713 |
}% |
| 714 |
} |
| 715 |
% \end{macrocode} |
| 716 |
% Am Ende der Umgebungen wird das übergebenen Hauptargument erneut ausgeführt, |
| 717 |
% was zum Beenden der Indexeinträge für die jeweilige Deklaration führt |
| 718 |
% (\cs{@openindexfalse}, siehe \cs{Process@Index}). Dafür werden die Makros für |
| 719 |
% die Angabe obligatorischer und optionaler Parameter lokal umdefiniert. |
| 720 |
% \begin{macrocode} |
| 721 |
\newcommand*\tud@declare@end[2]{% |
| 722 |
\ifx\tud@declaration@list\relax\else% |
| 723 |
\ClassError{tudscrmanual}{\string#2\space is missing}{% |
| 724 |
\string\tud@declaration@list\space is not empty. Did you\MessageBreak% |
| 725 |
forget to print this list with\MessageBreak% |
| 726 |
\string#2?% |
| 727 |
}% |
| 728 |
\fi% |
| 729 |
\vskip-\lastskip% |
| 730 |
\@tud@declaretrue\@openindexfalse#1\@tud@declarefalse% |
| 731 |
\pagebreak[1]% |
| 732 |
} |
| 733 |
% \end{macrocode} |
| 734 |
% \end{macro}^^A \tud@declare@end |
| 735 |
% \end{macro}^^A \tud@declare@start |
| 736 |
% \begin{environment}{Declaration*} |
| 737 |
% \changes{v2.02}{2014/10/09}{neu}^^A |
| 738 |
% \changes{v2.05}{2015/08/04}{Indexaufteilung/-markup für Klassen und Pakete}^^A |
| 739 |
% Die Sternversion der Umgebung \env{Declaration*} ist für die vereinfachte |
| 740 |
% Deklaration von Klassen, Paketen etc. gedacht, bei denen keine Ausgabe |
| 741 |
% sondern lediglich Hyperlink, Indexeintrag und Änderungsnotiz erzeugt werden |
| 742 |
% sollen. Hierbei werden die beiden Befehle \cs{tud@declare@special@start} und |
| 743 |
% \cs{tud@declare@special@end} genutzt, wobei der Anker des erzeugten Labels |
| 744 |
% nicht erhöht sondern auf der aktuellen Grundlinie erzeugt wird. |
| 745 |
% \begin{macrocode} |
| 746 |
\NewDocumentEnvironment{Declaration*}{om}{% |
| 747 |
\tud@declare@special@start[#1]{#2}{2}% |
| 748 |
}{% |
| 749 |
\tud@declare@special@end{#2}% |
| 750 |
} |
| 751 |
% \end{macrocode} |
| 752 |
% \end{environment}^^A Declaration* |
| 753 |
% \begin{environment}{Bundle*} |
| 754 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 755 |
% Die Umgebung \env{Bundle*} wird verwendet, wenn ein zusätzliches Paket oder |
| 756 |
% eine weitere Klasse in Ergänzung zu den Hauptklassen dokumentiert wird. |
| 757 |
% Hierfür wird die Umgebung \env{Bundle} erst geöffnet, nachdem mit dem Makro |
| 758 |
% \cs{tud@declare@special@start} das obligatorische Argument~-- sprich die |
| 759 |
% Klasse oder das Paket~-- deklariert wird. Die Umgebung \env{Bundle*} sollte |
| 760 |
% dabei direkt nach einer Gliederungsüberschrift genutzt werden, in welcher das |
| 761 |
% zu deklarierende Element (Klasse, Paket etc.) genannt wird, da der Anker des |
| 762 |
% erzeugten Labels weiter nach oben auf die Höhe der Überschirft verschoben |
| 763 |
% wird. Zum Abschluss der Deklaration wird \cs{tud@declare@special@end} nach |
| 764 |
% dem Schließen der Umgebung \env{Bundle} genutzt. |
| 765 |
% \begin{macrocode} |
| 766 |
\NewDocumentEnvironment{Bundle*}{om}{% |
| 767 |
\tud@declare@special@start[#1]{#2}{3}% |
| 768 |
\Bundle{#2}% |
| 769 |
}{% |
| 770 |
\endBundle% |
| 771 |
\tud@declare@special@end{#2}% |
| 772 |
} |
| 773 |
% \end{macrocode} |
| 774 |
% \end{environment}^^A Bundle* |
| 775 |
% \begin{macro}{\tud@declare@special@start} |
| 776 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 777 |
% \begin{macro}{\tud@declare@special@end} |
| 778 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 779 |
% Die beiden dienen zur vereinfachten Deklaration. Es wird keine Ausgabe |
| 780 |
% sondern lediglich Hyperlink, Indexeintrag und Änderungsnotiz erzeugt. Das |
| 781 |
% optionale Argument dient einem Änderungseintrag, das erste obligaotrische |
| 782 |
% gilt der eigentlichen Deklaration, das zweite zur Einstellung des Makros |
| 783 |
% \cs{tud@declare@num}, mit welchem das Verhalten für das Erzeugen der Labels |
| 784 |
% gesteuert wird. |
| 785 |
% \begin{macrocode} |
| 786 |
\NewDocumentCommand\tud@declare@special@start{omm}{% |
| 787 |
\Changed@At@CreateList(#2){#1}% |
| 788 |
\def\tud@declare@num{#3}% |
| 789 |
\@tud@declaretrue\@openindextrue#2\@tud@declarefalse% |
| 790 |
\def\tud@declare@num{0}% |
| 791 |
} |
| 792 |
\newcommand*\tud@declare@special@end[1]{% |
| 793 |
\ifx\tud@changedat@list\relax\else% |
| 794 |
\ClassError{tudscrmanual}{\string\printchangedatlist\space is missing}{% |
| 795 |
\string\tud@changedat@list\space is not empty. Did you\MessageBreak% |
| 796 |
forget to print this list with \string\printchangedatlist?% |
| 797 |
}% |
| 798 |
\fi% |
| 799 |
\@tud@declaretrue\@openindexfalse#1\@tud@declarefalse% |
| 800 |
} |
| 801 |
% \end{macrocode} |
| 802 |
% \end{macro}^^A \tud@declare@special@end |
| 803 |
% \end{macro}^^A \tud@declare@special@start |
| 804 |
% \begin{macro}{\printdeclarationlist} |
| 805 |
% \begin{length}{\tud@lastskip} |
| 806 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 807 |
% \begin{macro}{\index} |
| 808 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 809 |
% \begin{macro}{\label} |
| 810 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 811 |
% Mit dem Befehl \cs{printdeclarationlist} erfolgt die eingentliche Ausgabe |
| 812 |
% aller Deklarationen. Zweck ist es, mehrere \env{Declaration}-Umgebungen |
| 813 |
% ineinander verschachteln zu können und eine Ausgabe aller auf einmal zu |
| 814 |
% erzeugen. Die durch die ggf. nacheinander folgenden Deklarationen wurden in |
| 815 |
% entsprechenden Listen gesammelt und werden hier jetzt formatiert ausgegben. |
| 816 |
% |
| 817 |
% Da die Verwendung der Befehle \cs{index} und \cs{label} nach Überschriften |
| 818 |
% dazu führt, dass \cs{addvspace} nicht mehr richtig verendet werden kann, |
| 819 |
% wird hier etwas gebastelt, damit das trotzdem funktioniert. Dabei wird |
| 820 |
% einfach bei der verwendung der genannten Befehle der zuvor gesetzte vertikale |
| 821 |
% Abstand in \cs{tud@lastskip} gesichert. |
| 822 |
% \begin{macrocode} |
| 823 |
\tud@newglue\tud@lastskip |
| 824 |
\pretocmd\index{% |
| 825 |
\tud@lastskip=\lastskip% |
| 826 |
}{}{\tud@patch@wrn{index}} |
| 827 |
\pretocmd\label{% |
| 828 |
\tud@lastskip=\lastskip% |
| 829 |
}{}{\tud@patch@wrn{label}} |
| 830 |
\NewDocumentCommand\printdeclarationlist{!s !d()}{% |
| 831 |
\ifx\tud@declaration@list\relax\else% |
| 832 |
\ifhmode% |
| 833 |
\vskip\medskipamount% |
| 834 |
\else% |
| 835 |
% \end{macrocode} |
| 836 |
% Im vertikalen modus wird dann einfach vom eigentlich gewünschten Abstand der |
| 837 |
% durch \cs{label} bzw. \cs{index} erzwungene vertikale Freiraum abgezogen. |
| 838 |
% Sollte dann noch ein positiver Wert bestehen, wird dieser einfach zusätzlich |
| 839 |
% gesetzt. |
| 840 |
% \begin{macrocode} |
| 841 |
\tud@setglue\@tempskipa{\medskipamount-\tud@lastskip}% |
| 842 |
\ifdim\@tempskipa>\z@\relax% |
| 843 |
\addpenalty{\@beginparpenalty}% |
| 844 |
\addvspace{\@tempskipa}% |
| 845 |
\fi% |
| 846 |
\fi% |
| 847 |
% \end{macrocode} |
| 848 |
% Anschließend wird die Länge auf jeden Fall zurückgesetzt. |
| 849 |
% \begin{macrocode} |
| 850 |
\global\tud@lastskip=\z@% |
| 851 |
\@afterindentfalse\@afterheading% |
| 852 |
\@tud@declaretrue\@openindextrue% |
| 853 |
% \end{macrocode} |
| 854 |
% Die deklarierten Optionen, Umgebungen, Befehle etc. werden umrahmt. Dabei |
| 855 |
% erfolgt die Ausgabe mithilfe einer Box, um die Größe des Deklarationsrahmens |
| 856 |
% zu speichern und die Änderungsmarkierung am Seitenrand auf die richtige Höhe |
| 857 |
% zu platzieren. Da innerhalb von Tabellen der Wert von \cs{baselineskip} auf |
| 858 |
% \makeatletter\the\z@\makeatother~gesetzt wird, muss für einen richtig |
| 859 |
% platzierten Link dieser in \cs{HyperRaiseLinkDefault} gesichert werden. |
| 860 |
% \begin{macrocode} |
| 861 |
\def\@tempa##1{\ignorespaces##1\tabularnewline}% |
| 862 |
\edef\HyperRaiseLinkDefault{\the\baselineskip}% |
| 863 |
\sbox\z@{% |
| 864 |
\begin{tabular}{|l|}% |
| 865 |
\hline% |
| 866 |
\forlistloop\@tempa{\tud@declaration@list}% |
| 867 |
\hline% |
| 868 |
\end{tabular}% |
| 869 |
}\usebox\z@% |
| 870 |
\@tud@declarefalse% |
| 871 |
% \end{macrocode} |
| 872 |
% Danach werden ggf. die Voreinstellungen und Zusatzinformationen in etwas |
| 873 |
% kleinerer Schrift gesetzt. |
| 874 |
% \begin{macrocode} |
| 875 |
\ifboolexpr{bool {@tud@preset@list} or bool {@tud@additional@list}}{% |
| 876 |
\def\@tempa##1{\small\ignorespaces##1\tabularnewline}% |
| 877 |
\hskip1.2em% |
| 878 |
\if@tud@preset@list% |
| 879 |
\begin{tabular}{@{}l@{}}% |
| 880 |
\forlistloop\@tempa{\tud@preset@list}% |
| 881 |
\end{tabular}% |
| 882 |
\hspace{\tabcolsep}% |
| 883 |
\fi% |
| 884 |
\if@tud@additional@list% |
| 885 |
\begin{tabular}{@{}l@{}}% |
| 886 |
\forlistloop\@tempa{\tud@additional@list}% |
| 887 |
\end{tabular}% |
| 888 |
\fi% |
| 889 |
}{}% |
| 890 |
% \end{macrocode} |
| 891 |
% Alle für die Deklaration verwendeten Listen werden nach ihrer Abarbeitung |
| 892 |
% zurückgesetzt. |
| 893 |
% \begin{macrocode} |
| 894 |
\global\let\tud@declaration@list\relax% |
| 895 |
\global\let\tud@preset@list\relax% |
| 896 |
\global\let\tud@additional@list\relax% |
| 897 |
\global\@tud@preset@listfalse% |
| 898 |
\global\@tud@additional@listfalse% |
| 899 |
% \end{macrocode} |
| 900 |
% Die Einträge in der Änderungsliste sowie die dazugehörige Randnotiz werden |
| 901 |
% innerhalb der Deklaration mit \cs{printchangedatlist} erzeugt. Das optionale |
| 902 |
% Argument sorgt für die Verschiebung der Randnotiz auf die richtige Höhe, um |
| 903 |
% den Höhenversatz zwischen Randnotiz und Deklarationsrahmen auszugleichen. |
| 904 |
% \begin{macrocode} |
| 905 |
\print@changedatlist{#1}{% |
| 906 |
\dimexpr.5\ht\strutbox+.5\dp\strutbox-.5\ht0-.5\dp0\relax% |
| 907 |
}% |
| 908 |
% \end{macrocode} |
| 909 |
% Zum Schluss wird das optionale Argument (in runden Klammern) neben der |
| 910 |
% Deklarationsbox ausgegeben. |
| 911 |
% \begin{macrocode} |
| 912 |
\IfValueT{#2}{#2}% |
| 913 |
\par\nobreak% |
| 914 |
\vskip\medskipamount% |
| 915 |
\@afterindentfalse\@afterheading% |
| 916 |
\fi% |
| 917 |
} |
| 918 |
% \end{macrocode} |
| 919 |
% \end{macro}^^A \label |
| 920 |
% \end{macro}^^A \index |
| 921 |
% \end{length}^^A \tud@lastskip |
| 922 |
% \end{macro}^^A \printdeclarationlist |
| 923 |
% \begin{macro}{\printobsoletelist} |
| 924 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 925 |
% Damit werden Deklarationen der Umgebung \env{Obsolete} ausgegeben. |
| 926 |
% \begin{macrocode} |
| 927 |
\newcommand*\printobsoletelist{% |
| 928 |
\@tud@obsoletetrue% |
| 929 |
\printdeclarationlist*% |
| 930 |
\@tud@obsoletefalse% |
| 931 |
} |
| 932 |
% \end{macrocode} |
| 933 |
% \end{macro}^^A \printobsoletelist |
| 934 |
% \begin{macro}{\printchangedatlist} |
| 935 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 936 |
% Damit werden Änderungsnotizen der Umgebungen \env{Declaration*}, \env{Bundle} |
| 937 |
% und \env{Bundle*} ausgegeben. |
| 938 |
% \begin{macrocode} |
| 939 |
\NewDocumentCommand\printchangedatlist{!s !O{\z@}}{% |
| 940 |
\print@changedatlist{#1}{#2}% |
| 941 |
} |
| 942 |
% \end{macrocode} |
| 943 |
% \end{macro}^^A \printchangedatlista |
| 944 |
% |
| 945 |
% \iffalse |
| 946 |
%</class> |
| 947 |
% \fi |
| 948 |
% |
| 949 |
% \subsection{Markup von Klassen, Paketen, Optionen und weiteren Elementen} |
| 950 |
% |
| 951 |
% Es folgen die Definitionen für Befehle und Umgebungen für Klasse und Paket, |
| 952 |
% welche sich überschneidenden und für beide benötigt werden. Allerdings sind |
| 953 |
% diese für Klasse und Paket in ihrer Implementierung teilweise unterschiedlich. |
| 954 |
% |
| 955 |
% Als erstes werden für Klasse und Paket einige Hilfmakros definiert. |
| 956 |
% |
| 957 |
% \begin{macro}{\bsc} |
| 958 |
% \changes{v2.02}{2014/07/22}{\cs{newrobustcmd} aus \pkg{etoolbox} anstatt |
| 959 |
% \cs{DeclareRobustCommand}}^^A |
| 960 |
% \begin{macro}{\txb} |
| 961 |
% \changes{v2.06o}{2022/08/03}{neu}^^A |
| 962 |
% Eine einfacher zu verwendende Kurzform für den Backslash sowie eine |
| 963 |
% mikrotypografisch angepasste Version von \cs{textbar}. |
| 964 |
% \begin{macrocode} |
| 965 |
\newrobustcmd*\bsc{\@backslashchar} |
| 966 |
\newrobustcmd*\txb{{\raise.05em\hbox{\kern.05em\textbar\kern.05em}}} |
| 967 |
% \end{macrocode} |
| 968 |
% \end{macro}^^A \txb |
| 969 |
% \end{macro}^^A \bsc |
| 970 |
% \begin{macro}{\suffix} |
| 971 |
% \changes{v2.05}{2015/10/27}{neu}^^A |
| 972 |
% Für alle möglichen, zusätzlichen Informationen bei Deklarationen, im Index |
| 973 |
% oder der normalen in Ausgabe im Fließtext wird eine etwas kleinere Schrift |
| 974 |
% verwendet. |
| 975 |
% \begin{macrocode} |
| 976 |
\newrobustcmd*\suffix[1]{\begingroup~\scriptsize(#1)\endgroup} |
| 977 |
% \end{macrocode} |
| 978 |
% \end{macro}^^A \suffix |
| 979 |
% \begin{macro}{\NewExpandableDocumentCommand} |
| 980 |
% \changes{v2.02}{2014/11/04}{neu}^^A |
| 981 |
% \changes{v2.05i}{2017/03/12}{wird mittlerweile von \pkg{xparse} definiert}^^A |
| 982 |
% Für Labels, Index- und Änderungs- sowie PDF-Outline-Einträge etc. müssen ganz |
| 983 |
% bestimmte Markup-Befehle durch eine expandierbare Version ersetzt werden. Um |
| 984 |
% dies möglichst einfach zu gestalten, wird \cs{NewExpandableDocumentCommand} |
| 985 |
% definiert. |
| 986 |
% \begin{macrocode} |
| 987 |
\providecommand*\NewExpandableDocumentCommand[3]{% |
| 988 |
\NewDocumentCommand#1{#2}{}% |
| 989 |
\DeclareExpandableDocumentCommand#1{#2}{#3}% |
| 990 |
} |
| 991 |
% \end{macrocode} |
| 992 |
% \end{macro}^^A \NewExpandableDocumentCommand |
| 993 |
% |
| 994 |
% \subsubsection{Definition der Markup-Befehle} |
| 995 |
% |
| 996 |
% \changes{v2.05}{2015/11/02}{Markup-Befehle komplett überarbeitet}^^A |
| 997 |
% |
| 998 |
% Im Folgenden werden allerhand Befehle mit Hilfe des Paketes \pkg{xparse} |
| 999 |
% definiert, um bestimmte Begriffe, Klassen, Pakete, Optionen, Umgebungen, |
| 1000 |
% Befehle, Parameter, Bezeichner, Längen, Schriftelemente und Farben speziell |
| 1001 |
% auszuzeichnen. Diese Befehle lauten für Klasse und Paket aus Gründen der |
| 1002 |
% Konsistenz zwar gleich, unterschieden sich jedoch ein klein wenig in der |
| 1003 |
% Implementierung. |
| 1004 |
% |
| 1005 |
% Die Sternversion all dieser Befehlen tragen nichts in den Index ein. Für |
| 1006 |
% (fast) alle der folgenden Befehle gilt, dass diese mit zwei optionalen |
| 1007 |
% Argumenten am Ende genutzt werden können. Sollte ein Label existieren, wird |
| 1008 |
% automatisch ein Hyperlink erzeugt, welcher mit der optionalen Angabe von |
| 1009 |
% |'|\meta{Referenzvariante}|'| um einen textuellen Querverweis ergänzt werden |
| 1010 |
% kann. Mit \verb+|+\meta{Indexmarkup}\verb+|+ kann die Erscheinung im Index |
| 1011 |
% angepasst werden. Bei einigen Befehlen kann zusätzlich zuvor im Markup mit |
| 1012 |
% dem optionalen Argument \parg{Bundleelement} die Zuweisung auf ein bestimmtes |
| 1013 |
% Paket oder eine Klasse aus dem \TUDScript-Bundle erfolgen. |
| 1014 |
% |
| 1015 |
% Die eigentliche Behandlung erfolgt mit dem Befehl \cs{Process@Markup}, |
| 1016 |
% welcher die tatsächliche Auszeichnung im Fließtext bzw. als Deklaration |
| 1017 |
% übernimmt. Das Auszeichnungsformat wird dafür zuvor mit \cs{Markup@SetFormat} |
| 1018 |
% festgelegt. Ein Eintrag in den Index wird mit \cs{Process@Index} realisiert. |
| 1019 |
% Für die Änderungsliste wird der Befehl \cs{Process@ChangedAt} genutzt, um die |
| 1020 |
% entsprechende Formatierung zu gewährleisten, wobei dies nur für die Klasse |
| 1021 |
% \cls{tudscrmanual} und nicht für das Paket \pkg{tudscrmanual} gilt. |
| 1022 |
% |
| 1023 |
% \begin{macro}{\ProcessorKeyVal} |
| 1024 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 1025 |
% \begin{macro}{\tud@keyval@error} |
| 1026 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 1027 |
% Bei Optionen und Parametern können spezielle Werte einfach im Hauptargument |
| 1028 |
% durch |=| getrennt angegeben werden. Um diese auszuwerten, wird dieser Befehl |
| 1029 |
% definiert, welcher als Argumentprozessor verwendet wird. |
| 1030 |
% \begin{macrocode} |
| 1031 |
\newcommand*\ProcessorKeyVal[1]{% |
| 1032 |
\begingroup% |
| 1033 |
\in@{=}{#1}% |
| 1034 |
% \end{macrocode} |
| 1035 |
% Wird im Argument ein |=| gefunden, so wird alles Darauffolgende als Wert |
| 1036 |
% erkannt und dem eigentlichen Hauptargument bei der Ausgabe angehangen. Das |
| 1037 |
% Makro, welches diesen Argumentprozessor verwendet, erhält als Ausgabe also |
| 1038 |
% entweder \marg{Schlüssel} oder \marg{Schlüssel}|=|\meta{Wert}|=| falls |
| 1039 |
% \cs{ProcessorKeyVal} mit \marg{Schlüssel=Wert} verwendet wurde. |
| 1040 |
% \begin{macrocode} |
| 1041 |
\ifin@% |
| 1042 |
\def\@tempa##1=##2\@nil{\toks@{{##1}=##2=}}% |
| 1043 |
\else% |
| 1044 |
\def\@tempa##1\@nil{\toks@{{##1}}}% |
| 1045 |
\fi% |
| 1046 |
\@tempa#1\@nil% |
| 1047 |
\edef\tud@reserved{% |
| 1048 |
\noexpand\endgroup% |
| 1049 |
\def\noexpand\ProcessedArgument{\the\toks@}% |
| 1050 |
}% |
| 1051 |
\tud@reserved% |
| 1052 |
} |
| 1053 |
% \end{macrocode} |
| 1054 |
% Es gibt auch noch eine interne Variante für ein optioneles Werte-Argument. |
| 1055 |
% Dabei sollte vermieden werden, dass im Markup das Argument für einen Wert |
| 1056 |
% doppelt angegeben wird. In diesem Fall wird dieser Fehler ausgegeben. |
| 1057 |
% \begin{macrocode} |
| 1058 |
\newcommand*\tud@keyval@error{% |
| 1059 |
%<*class> |
| 1060 |
\ClassError{tudscrmanual}% |
| 1061 |
%</class> |
| 1062 |
%<*package> |
| 1063 |
\PackageError{tudscrmanual}% |
| 1064 |
%</package> |
| 1065 |
{Wrong usage of optional argument for value}% |
| 1066 |
{There are two optional arguments for a value given!}% |
| 1067 |
} |
| 1068 |
% \end{macrocode} |
| 1069 |
% \end{macro}^^A \tud@keyval@error |
| 1070 |
% \end{macro}^^A \ProcessorKeyVal |
| 1071 |
% \begin{environment}{Bundle} |
| 1072 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 1073 |
% \begin{macro}{\tud@bdl@curr} |
| 1074 |
% \changes{v2.05}{2015/08/04}{neu}^^A |
| 1075 |
% \begin{macro}{\tud@bdl@dflt} |
| 1076 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 1077 |
% \begin{macro}{\tud@if@bdl} |
| 1078 |
% \changes{v2.05}{2015/08/04}{neu}^^A |
| 1079 |
% Die Umgebung \env{Bundle} kann nicht verschachtelt werden und prüft zuerst |
| 1080 |
% dementsprechend die Verwendung. Anschließend wird lediglich das Makro |
| 1081 |
% \cs{tud@bdl@curr} auf das übergebene Argument gesetzt, um innerhalb der |
| 1082 |
% Umgebung erstellte Label und Indexeinträge zu beeinflussen. |
| 1083 |
% \begin{macrocode} |
| 1084 |
\newenvironment{Bundle}[1]{% |
| 1085 |
\tud@if@bdl{% |
| 1086 |
%<*class> |
| 1087 |
\ClassError{tudscrmanual}% |
| 1088 |
%</class> |
| 1089 |
%<*package> |
| 1090 |
\PackageError{tudscrmanual}% |
| 1091 |
%</package> |
| 1092 |
{Nested environment `Bundle'}{% |
| 1093 |
It is not possible to nest this environment, when\MessageBreak% |
| 1094 |
a cross-label was given before.% |
| 1095 |
}% |
| 1096 |
}{% |
| 1097 |
\gdef\tud@bdl@curr{#1}% |
| 1098 |
}% |
| 1099 |
\ignorespaces% |
| 1100 |
}{% |
| 1101 |
\global\let\tud@bdl@curr\tud@bdl@dflt% |
| 1102 |
\aftergroup\ignorespaces% |
| 1103 |
} |
| 1104 |
% \end{macrocode} |
| 1105 |
% Diese Makros werden für das Definieren eines Bundle-Elements und ggf. das |
| 1106 |
% Prüfen des selbigen benötigt. |
| 1107 |
% \ToDo{Suffixe wie Klasse, Paket etc. lokalisieren (locale)}[v2.??] |
| 1108 |
% \begin{macrocode} |
| 1109 |
\newcommand*\tud@bdl@curr{} |
| 1110 |
\newcommand*\tud@bdl@dflt{tudscr} |
| 1111 |
\let\tud@bdl@curr\tud@bdl@dflt |
| 1112 |
\newcommand*\tud@if@bdl[2]{% |
| 1113 |
\tud@if@strequal{\tud@bdl@curr}{\tud@bdl@dflt}{#2}{#1}% |
| 1114 |
} |
| 1115 |
% \end{macrocode} |
| 1116 |
% \end{macro}^^A \tud@if@bdl |
| 1117 |
% \end{macro}^^A \tud@bdl@dflt |
| 1118 |
% \end{macro}^^A \tud@bdl@curr |
| 1119 |
% \end{environment}^^A Bundle |
| 1120 |
% \begin{macro}{\Application} |
| 1121 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1122 |
% \begin{macro}{\@Application} |
| 1123 |
% Die Auszeichnung und der Indexeintrag einer Anwendungssoftware. |
| 1124 |
% \begin{macrocode} |
| 1125 |
\NewExpandableDocumentCommand\@Application{sm}{#2} |
| 1126 |
\NewDocumentCommand\Application{s m !d() !d<> !d||}{% |
| 1127 |
\Markup@SetFormat{\sbifont}% |
| 1128 |
\IfValueTF{#4}{% |
| 1129 |
\Process@Markup{\Application{#2}}(#3)<#4>% |
| 1130 |
}{% |
| 1131 |
\Process@Markup{\Application{#2}}(#3)% |
| 1132 |
}% |
| 1133 |
\Process@Index{#1}{\Application{#2}}[Anwendungssoftware](#3)|#5|% |
| 1134 |
} |
| 1135 |
% \end{macrocode} |
| 1136 |
% \end{macro}^^A \@Application |
| 1137 |
% \end{macro}^^A \Application |
| 1138 |
% \begin{macro}{\Distribution} |
| 1139 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1140 |
% \begin{macro}{\@Distribution} |
| 1141 |
% Die Auszeichnung und der Indexeintrag einer \LaTeX-Distribution. Das |
| 1142 |
% optionale Argument kann für das Anhängen einer Versionsnummer o.\,ä. im |
| 1143 |
% Fließtext genutzt werden. |
| 1144 |
% \begin{macrocode} |
| 1145 |
\NewExpandableDocumentCommand\@Distribution{sm}{#2} |
| 1146 |
\NewDocumentCommand\Distribution{s m !o !d() !d||}{% |
| 1147 |
\Markup@SetFormat{\sbnfont}% |
| 1148 |
\IfValueTF{#3}{% |
| 1149 |
\Process@Markup{\Distribution{#2}}[~#3](#4)% |
| 1150 |
}{% |
| 1151 |
\Process@Markup{\Distribution{#2}}(#4)% |
| 1152 |
}% |
| 1153 |
\Process@Index{#1}{\Distribution{#2}}[Distribution](#4)|#5|% |
| 1154 |
} |
| 1155 |
% \end{macrocode} |
| 1156 |
% \end{macro}^^A \@Distribution |
| 1157 |
% \end{macro}^^A \Distribution |
| 1158 |
% \begin{macro}{\Engine} |
| 1159 |
% \changes{v2.05}{2015/11/04}{neu}^^A |
| 1160 |
% \begin{macro}{\@Engine} |
| 1161 |
% \changes{v2.05}{2015/11/04}{neu}^^A |
| 1162 |
% Die Auszeichnung und der Indexeintrag für ein bestimmtes Textsatzsystem. |
| 1163 |
% \begin{macrocode} |
| 1164 |
\NewExpandableDocumentCommand\@Engine{sm}{#2} |
| 1165 |
\NewDocumentCommand\Engine{s m !d() !d||}{% |
| 1166 |
\Markup@SetFormat{\sbnfont}% |
| 1167 |
\Process@Markup{\Engine{\hologo{#2}}}(#3)% |
| 1168 |
\Process@Index{#1}{\Engine{#2}}[Textsatzsystem](#3)|#4|% |
| 1169 |
} |
| 1170 |
% \end{macrocode} |
| 1171 |
% \end{macro}^^A \@Engine |
| 1172 |
% \end{macro}^^A \Engine |
| 1173 |
% \begin{macro}{\Path} |
| 1174 |
% Pfade werden ohne zusätzliches Markup ausgegeben. |
| 1175 |
% \begin{macrocode} |
| 1176 |
\newrobustcmd*\Path[1]{\mbox{\texttt{#1}}} |
| 1177 |
% \end{macrocode} |
| 1178 |
% \end{macro}^^A \Path |
| 1179 |
% \begin{macro}{\File} |
| 1180 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1181 |
% \begin{macro}{\@File} |
| 1182 |
% Die Auszeichnung und der Indexeintrag einer Datei. |
| 1183 |
% \begin{macrocode} |
| 1184 |
\NewExpandableDocumentCommand\@File{sm}{#2} |
| 1185 |
\NewDocumentCommand\File{s m !d() !d||}{% |
| 1186 |
\Markup@SetFormat{\sbnfont}% |
| 1187 |
\Process@Markup{\File{#2}}(#3)% |
| 1188 |
\Process@Index{#1}{\File{#2}}[Datei](#3)|#4|% |
| 1189 |
} |
| 1190 |
% \end{macrocode} |
| 1191 |
% \end{macro}^^A \@File |
| 1192 |
% \end{macro}^^A \File |
| 1193 |
% \begin{macro}{\Class} |
| 1194 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1195 |
% \begin{macro}{\@Class} |
| 1196 |
% Die Auszeichnung und der Indexeintrag einer Klasse. Das optionale Argument |
| 1197 |
% zwischen Apostrophen kann für die Formatierung eines Querverweises im Text |
| 1198 |
% genutzt werden, das optionale Argument zwischen senkrechten Strichen dient |
| 1199 |
% der Formatierung des Indexeintrages. |
| 1200 |
% \begin{macrocode} |
| 1201 |
\NewExpandableDocumentCommand\@Class{sm}{#2} |
| 1202 |
\NewDocumentCommand\Class{s m !d() !d'' !d||}{% |
| 1203 |
%<*class> |
| 1204 |
\if@tud@changedat% |
| 1205 |
\Process@ChangedAt{\Class{#2}}[Klasse]% |
| 1206 |
\else% |
| 1207 |
%</class> |
| 1208 |
\Markup@SetFormat{\sbnfont}% |
| 1209 |
\Process@Markup{\Class{#2}}(#3)'#4'% |
| 1210 |
\Process@Index{#1}{\Class{#2}}[Klasse](#3)|#5|% |
| 1211 |
%<*class> |
| 1212 |
\fi% |
| 1213 |
%</class> |
| 1214 |
} |
| 1215 |
% \end{macrocode} |
| 1216 |
% \end{macro}^^A \@Class |
| 1217 |
% \end{macro}^^A \Class |
| 1218 |
% \begin{macro}{\Package} |
| 1219 |
% \changes{v2.02}{2014/07/10}{Ausgabe für Änderungsliste hinzugefügt}^^A |
| 1220 |
% \begin{macro}{\@Package} |
| 1221 |
% Für die Auszeichnungen von Paketen gelten vorherigen Aussagen äquivalent. |
| 1222 |
% Für Pakete wird ergänzend ein Hyperlink auf CTAN erzeugt, wenn für dieses |
| 1223 |
% kein Label im Dokument besteht. Genaueres ist der Beschreibung und Definition |
| 1224 |
% von \cs{Process@Markup} zu entnehmen. Das optionale Argument in einfachen |
| 1225 |
% Guillemets dient zum Anpassen des CTAN-Links, welcher normalerweise aus |
| 1226 |
% obligatorischen Argument generiert wird. |
| 1227 |
% \begin{macrocode} |
| 1228 |
\NewExpandableDocumentCommand\@Package{sm}{#2} |
| 1229 |
\NewDocumentCommand\Package{s m !d() !d<> !d'' !d||}{% |
| 1230 |
%<*class> |
| 1231 |
\if@tud@changedat% |
| 1232 |
\Process@ChangedAt{\Package{#2}}[Paket]% |
| 1233 |
\else% |
| 1234 |
%</class> |
| 1235 |
\Markup@SetFormat{\sbnfont}% |
| 1236 |
\IfValueTF{#4}{% |
| 1237 |
\Process@Markup{\Package{#2}}(#3)<#4>'#5'% |
| 1238 |
}{% |
| 1239 |
\Process@Markup{\Package{#2}}(#3)<#2>'#5'% |
| 1240 |
}% |
| 1241 |
\Process@Index{#1}{\Package{#2}}[Paket](#3)|#6|% |
| 1242 |
%<*class> |
| 1243 |
\fi% |
| 1244 |
%</class> |
| 1245 |
} |
| 1246 |
% \end{macrocode} |
| 1247 |
% \end{macro}^^A \@Package |
| 1248 |
% \end{macro}^^A \Package |
| 1249 |
% \begin{macro}{\Option} |
| 1250 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1251 |
% \begin{macro}{\Option@Value} |
| 1252 |
% \changes{v2.05}{2015/11/02}{neu}^^A |
| 1253 |
% \begin{macro}{\@Option} |
| 1254 |
% \changes{v2.02}{2014/11/02}{neu}^^A |
| 1255 |
% Im Gegensatz zu den vorherigen Befehlen, kann im Hauptargument ein spezieller |
| 1256 |
% Wert für eine Option optional durch ein |=| getrennt angegeben werden. Durch |
| 1257 |
% den Argumentprozessor \cs{ProcessorKeyVal} wird dieses vom eigentlichen |
| 1258 |
% Schlüssel getrennt. Dabei wird der gegebene Schlüssel immer in der Form |
| 1259 |
% \marg{Schlüssel} ausgegeben. Sollte ein optionaler Wert gegeben worden sein, |
| 1260 |
% wird dieser in der Form |=|\meta{Wert}|=| einfach angehängt und als optionales |
| 1261 |
% Argument von \cs{Option@Value} weiter verarbeitet. Mit dem optionalen Argument |
| 1262 |
% in runden Klammern kann ggf. auf eine Option aus einem \TUDScript-Paket |
| 1263 |
% verwiesen werden. |
| 1264 |
% \begin{macrocode} |
| 1265 |
\NewExpandableDocumentCommand\@Option{sm}{#2} |
| 1266 |
\NewDocumentCommand\Option{s >{\ProcessorKeyVal}m !d== !d() !d'' !d||}{% |
| 1267 |
\Option@Value{#1}#2=#3=(#4)'#5'|#6|% |
| 1268 |
} |
| 1269 |
% \end{macrocode} |
| 1270 |
% Für die interne Verwendung kann das optionale Argument für den Wert auch |
| 1271 |
% direkt mit |=|\meta{Wert}|=| angehangen werden. Um die gleichzeitige |
| 1272 |
% Verwendung beider Varianten zu unterdrücken, wird in diesem Fall ein Fehler |
| 1273 |
% erzeugt. |
| 1274 |
% \ToDo{% |
| 1275 |
% Eigentlich sollte der Wert hier formatiert werden. Wünschenswert wäre die |
| 1276 |
% Angabe von \val{Option=Wert} und \val{Option=<Spezialwert>}, damit das |
| 1277 |
% Gezerre mit der Spezialbehandlung von \cs{PSet} etc. wegfallen könnte, |
| 1278 |
% siehe \cs{tud@declare@start} |
| 1279 |
% }[v2.??]% |
| 1280 |
% \begin{macrocode} |
| 1281 |
\NewDocumentCommand\Option@Value{mmd==d==d()d''d||}{% |
| 1282 |
\IfValueT{#4}{\tud@keyval@error}% |
| 1283 |
%<*class> |
| 1284 |
\if@tud@changedat% |
| 1285 |
\Process@ChangedAt{\Option{#2}}=#3=[Option](#5)% |
| 1286 |
\else% |
| 1287 |
%</class> |
| 1288 |
\Markup@SetFormat{\ttfamily}% |
| 1289 |
\Process@Markup{\Option{#2}}=#3=(#5)'#6'% |
| 1290 |
\Process@Index{#1}{\Option{#2}}=#3=(#5)|#7|% |
| 1291 |
%<*class> |
| 1292 |
\fi% |
| 1293 |
%</class> |
| 1294 |
} |
| 1295 |
% \end{macrocode} |
| 1296 |
% \end{macro}^^A \@Option |
| 1297 |
% \end{macro}^^A \Option@Value |
| 1298 |
% \end{macro}^^A \Option |
| 1299 |
% \begin{macro}{\Environment} |
| 1300 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1301 |
% \begin{macro}{\@Environment} |
| 1302 |
% \changes{v2.02}{2014/11/02}{neu}^^A |
| 1303 |
% Bei diesem Makro dient das optionale Argument für die Ausgabe der möglichen |
| 1304 |
% Umgebungsargumente bzw. -parameter \emph{bei der Deklaration}. |
| 1305 |
% \begin{macrocode} |
| 1306 |
\NewExpandableDocumentCommand\@Environment{sm}{#2} |
| 1307 |
\NewDocumentCommand\Environment{s m !o !d() !d'' !d||}{% |
| 1308 |
%<*class> |
| 1309 |
\if@tud@changedat% |
| 1310 |
\Process@ChangedAt{\Environment{#2}}[Umgebung](#4)% |
| 1311 |
\else% |
| 1312 |
%</class> |
| 1313 |
% \end{macrocode} |
| 1314 |
% Außerdem wird für den Fall, dass der \cs{Environment}-Befehl innerhalb der |
| 1315 |
% Umgebung \env{Declaration} verwendet wird, eine spezielle Ausgabe erzeugt. |
| 1316 |
% Nur hier kommt das optionale Argument von \cs{Markup@SetFormat} nach dem |
| 1317 |
% Hauptargument zum Tragen. Die resultierende Ausgabe hat die Gesatlt: |
| 1318 |
% |
| 1319 |
% \begin{tabular}{l}% |
| 1320 |
% \cs{begin}\marg{Umgebung}\tabularnewline |
| 1321 |
% \dots\tabularnewline |
| 1322 |
% \cs{end}\marg{Umgebung}\tabularnewline |
| 1323 |
% \end{tabular}% |
| 1324 |
% \begin{macrocode} |
| 1325 |
\Markup@SetFormat{\ttfamily}(% |
| 1326 |
\ttfamily\bsc{}begin\textbraceleft#2\textbraceright\IfValueT{#3}{#3}% |
| 1327 |
\tabularnewline\ttfamily\dots% |
| 1328 |
\tabularnewline\ttfamily\bsc{}end\textbraceleft#2\textbraceright% |
| 1329 |
)% |
| 1330 |
\Process@Markup{\Environment{#2}}[#3](#4)'#5'% |
| 1331 |
\Process@Index{#1}{\Environment{#2}}[Umgebung](#4)|#6|% |
| 1332 |
%<*class> |
| 1333 |
\fi% |
| 1334 |
%</class> |
| 1335 |
} |
| 1336 |
% \end{macrocode} |
| 1337 |
% \end{macro}^^A \@Environment |
| 1338 |
% \end{macro}^^A \Environment |
| 1339 |
% \begin{macro}{\Macro} |
| 1340 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1341 |
% \begin{macro}{\@Macro} |
| 1342 |
% \changes{v2.02}{2014/11/02}{neu}^^A |
| 1343 |
% Die Auszeichnung und der Indexeintrag eines Befehls. Das ordinäre optionale |
| 1344 |
% Argument ist für das Anhängen von Parametern o.\,ä. nach dem eigentlichen |
| 1345 |
% Makro zu verwenden. Das optionale Argument in runden Klammern dient dem |
| 1346 |
% Hyperlink zu einem Befehl aus einem anderen Paket oder einer anderen Klasse |
| 1347 |
% aus dem \TUDScript-Bundle. |
| 1348 |
% \begin{macrocode} |
| 1349 |
\NewExpandableDocumentCommand\@Macro{sm}{#2} |
| 1350 |
\NewDocumentCommand\Macro{s m !o !d() !d'' !d||}{% |
| 1351 |
%<*class> |
| 1352 |
\if@tud@changedat% |
| 1353 |
\Process@ChangedAt{\Macro{#2}}[Befehl](#4)% |
| 1354 |
\else% |
| 1355 |
%</class> |
| 1356 |
\Markup@SetFormat[\bsc]{\ttfamily}% |
| 1357 |
\Process@Markup{\Macro{#2}}[#3](#4)'#5'% |
| 1358 |
\Process@Index{#1}{\Macro{#2}}(#4)|#6|% |
| 1359 |
%<*class> |
| 1360 |
\fi% |
| 1361 |
%</class> |
| 1362 |
} |
| 1363 |
% \end{macrocode} |
| 1364 |
% \end{macro}^^A \@Macro |
| 1365 |
% \end{macro}^^A \Macro |
| 1366 |
% \begin{macro}{\Length} |
| 1367 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1368 |
% \begin{macro}{\@Length} |
| 1369 |
% Die Auszeichnung und der Indexeintrag einer \LaTeX-Länge. |
| 1370 |
% \begin{macrocode} |
| 1371 |
\NewExpandableDocumentCommand\@Length{sm}{#2} |
| 1372 |
\NewDocumentCommand\Length{s m !d() !d'' !d||}{% |
| 1373 |
%<*class> |
| 1374 |
\if@tud@changedat% |
| 1375 |
\Process@ChangedAt{\Length{#2}}[L\"ange](#3)% |
| 1376 |
\else% |
| 1377 |
%</class> |
| 1378 |
\Markup@SetFormat[\bsc]{\ttfamily}[L\"ange]% |
| 1379 |
\Process@Markup{\Length{#2}}(#3)'#4'% |
| 1380 |
\Process@Index{#1}{\Length{#2}}[L\"ange](#3)|#5|% |
| 1381 |
%<*class> |
| 1382 |
\fi% |
| 1383 |
%</class> |
| 1384 |
} |
| 1385 |
% \end{macrocode} |
| 1386 |
% \end{macro}^^A \@Length |
| 1387 |
% \end{macro}^^A \Length |
| 1388 |
% \begin{macro}{\Counter} |
| 1389 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1390 |
% Die Auszeichnung und der Indexeintrag einer \LaTeX-Zählers. |
| 1391 |
% \begin{macrocode} |
| 1392 |
\NewExpandableDocumentCommand\@Counter{sm}{#2} |
| 1393 |
\NewDocumentCommand\Counter{s m !d() !d'' !d||}{% |
| 1394 |
%<*class> |
| 1395 |
\if@tud@changedat% |
| 1396 |
\Process@ChangedAt{\Counter{#2}}[Z\"ahler](#3)% |
| 1397 |
\else% |
| 1398 |
%</class> |
| 1399 |
\Markup@SetFormat{\ttfamily}[Z\"ahler]% |
| 1400 |
\Process@Markup{\Counter{#2}}(#3)'#4'% |
| 1401 |
\Process@Index{#1}{\Counter{#2}}[Z\"ahler](#3)|#5|% |
| 1402 |
%<*class> |
| 1403 |
\fi% |
| 1404 |
%</class> |
| 1405 |
} |
| 1406 |
% \end{macrocode} |
| 1407 |
% \end{macro}^^A \Counter |
| 1408 |
% |
| 1409 |
% \iffalse |
| 1410 |
%<*class> |
| 1411 |
% \fi |
| 1412 |
% |
| 1413 |
% \minisec{Exklusive Auszeichnungen für die Klasse} |
| 1414 |
% Alle weiteren Befehle werden ausschließlich für die Klasse \cls{tudscrmanual} |
| 1415 |
% definiert. |
| 1416 |
% |
| 1417 |
% \begin{macro}{\Key} |
| 1418 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1419 |
% \begin{macro}{\Key@Value} |
| 1420 |
% \changes{v2.05}{2015/11/02}{neu}^^A |
| 1421 |
% \begin{macro}{\@Key} |
| 1422 |
% Die Auszeichnung und der Indexeintrag eines Parameters für Umgebungen und |
| 1423 |
% Befehle. Das erste Argument ist die Umgebung oder der Befehl, wofür der |
| 1424 |
% Parameter gültig ist. Das zweite Argument ist der Parameter selbst. Die |
| 1425 |
% optionale Zuweisung eines Wertes kann äquivalent zu \cs{Option} mit dem |
| 1426 |
% Trennzeichen~|=| im Hauptargument erfolgen. |
| 1427 |
% \ToDo{% |
| 1428 |
% Eigentlich sollte der Wert hier formatiert werden. Die Angabe von |
| 1429 |
% \val{Parameter=Wert} und \val{Parameter=<Spezialwert>} wäre gut, damit |
| 1430 |
% das Gezerre mit der Spezialbehandlung von \cs{PSet} etc. wegfallen könnte, |
| 1431 |
% siehe \cs{tud@declare@start} |
| 1432 |
% }[v2.??]% |
| 1433 |
% \begin{macrocode} |
| 1434 |
\NewExpandableDocumentCommand\@Key{smm}{#2!#3} |
| 1435 |
\NewDocumentCommand\Key{s m >{\ProcessorKeyVal}m !d== !d() !d'' !d||}{% |
| 1436 |
\Key@Value{#1}{#2}#3=#4=(#5)'#6'|#7|% |
| 1437 |
} |
| 1438 |
\NewDocumentCommand\Key@Value{mmmd==d==d()d''d||}{% |
| 1439 |
\IfValueT{#5}{\tud@keyval@error}% |
| 1440 |
\if@tud@changedat% |
| 1441 |
\Process@ChangedAt{\Key{#2}{#3}}=#4=[Parameter](#6)% |
| 1442 |
\else% |
| 1443 |
\Markup@SetFormat{\ttfamily}[Parameter]% |
| 1444 |
\Process@Markup{\Key{#2}{#3}}=#4=(#6)'#7'% |
| 1445 |
\Process@Index{#1}{\Key{#2}{#3}}=#4=(#6)|#8|% |
| 1446 |
\fi% |
| 1447 |
} |
| 1448 |
% \end{macrocode} |
| 1449 |
% \end{macro}^^A \@Key |
| 1450 |
% \end{macro}^^A \Key@Value |
| 1451 |
% \end{macro}^^A \Key |
| 1452 |
% \begin{macro}{\Term} |
| 1453 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1454 |
% \begin{macro}{\@Term} |
| 1455 |
% Die Auszeichnung und der Indexeintrag eines sprachabhängigen Bezeichners. |
| 1456 |
% \begin{macrocode} |
| 1457 |
\NewExpandableDocumentCommand\@Term{sm}{#2} |
| 1458 |
\NewDocumentCommand\Term{s m !d() !d'' !d||}{% |
| 1459 |
\if@tud@changedat% |
| 1460 |
\Process@ChangedAt{\Term{#2}}[Bezeichner](#3)% |
| 1461 |
\else% |
| 1462 |
\Markup@SetFormat[\bsc]{\ttfamily}[Bezeichner]% |
| 1463 |
\Process@Markup{\Term{#2}}(#3)'#4'% |
| 1464 |
\Process@Index{#1}{\Term{#2}}(#3)|#5|% |
| 1465 |
\fi% |
| 1466 |
} |
| 1467 |
% \end{macrocode} |
| 1468 |
% \end{macro}^^A \@Term |
| 1469 |
% \end{macro}^^A \Term |
| 1470 |
% \begin{macro}{\PageStyle} |
| 1471 |
% \changes{v2.02}{2014/07/25}{neu}^^A |
| 1472 |
% \begin{macro}{\@PageStyle} |
| 1473 |
% Die Auszeichnung und der Indexeintrag eines Seitenstils. |
| 1474 |
% \begin{macrocode} |
| 1475 |
\NewExpandableDocumentCommand\@PageStyle{sm}{#2} |
| 1476 |
\NewDocumentCommand\PageStyle{s m !d() !d'' !d||}{% |
| 1477 |
\if@tud@changedat% |
| 1478 |
\Process@ChangedAt{\PageStyle{#2}}[Seitenstil](#3)% |
| 1479 |
\else% |
| 1480 |
\Markup@SetFormat{\ttfamily}[Seitenstil]% |
| 1481 |
\Process@Markup{\PageStyle{#2}}(#3)'#4'% |
| 1482 |
\Process@Index{#1}{\PageStyle{#2}}[Seitenstil](#3)|#5|% |
| 1483 |
\fi% |
| 1484 |
} |
| 1485 |
% \end{macrocode} |
| 1486 |
% \end{macro}^^A \@PageStyle |
| 1487 |
% \end{macro}^^A \PageStyle |
| 1488 |
% \begin{macro}{\Font} |
| 1489 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1490 |
% \begin{macro}{\@Font} |
| 1491 |
% Die Auszeichnung und der Indexeintrag eines Schriftelementes. |
| 1492 |
% \begin{macrocode} |
| 1493 |
\NewExpandableDocumentCommand\@Font{sm}{#2} |
| 1494 |
\NewDocumentCommand\Font{s m !d() !d'' !d||}{% |
| 1495 |
\if@tud@changedat% |
| 1496 |
\Process@ChangedAt{\Font{#2}}[Schriftelement](#3)% |
| 1497 |
\else% |
| 1498 |
\Markup@SetFormat{\ttfamily}[Schriftelement]% |
| 1499 |
\Process@Markup{\Font{#2}}(#3)'#4'% |
| 1500 |
\Process@Index{#1}{\Font{#2}}[Schriftelement](#3)|#5|% |
| 1501 |
\fi% |
| 1502 |
} |
| 1503 |
% \end{macrocode} |
| 1504 |
% \end{macro}^^A \@Font |
| 1505 |
% \end{macro}^^A \Font |
| 1506 |
% \begin{macro}{\Color} |
| 1507 |
% \changes{v2.02}{2014/10/08}{überarbeitet}^^A |
| 1508 |
% \begin{macro}{\@Color} |
| 1509 |
% Die Auszeichnung und der Indexeintrag einer Farbe des \CDs. Das optionale |
| 1510 |
% Argument kann sowohl bei der Deklaration als auch im Fließtext für das |
| 1511 |
% Anhängen eines Suffix verwendet werden. Alle mit \cs{Color} ausgezeichneten |
| 1512 |
% Farben referenzieren standardmäßig auf das Paket \pkg{tudscrcolor}. |
| 1513 |
% \begin{macrocode} |
| 1514 |
\NewExpandableDocumentCommand\@Color{sm}{#2} |
| 1515 |
\NewDocumentCommand\Color{s m !o !D(){\Package{tudscrcolor}} !d'' !d||}{% |
| 1516 |
\if@tud@changedat% |
| 1517 |
\Process@ChangedAt{\Color{#2}}[Farbe](#4)% |
| 1518 |
\else% |
| 1519 |
\Markup@SetFormat{\ttfamily}[Farbe](% |
| 1520 |
\begingroup\ttfamily{#2\IfValueT{#3}{~(#3)}}\endgroup% |
| 1521 |
)% |
| 1522 |
\Process@Markup{\Color{#2}}[#3](#4)'#5'% |
| 1523 |
\Process@Index{#1}{\Color{#2}}[Farbe](#4)|#6|% |
| 1524 |
\fi% |
| 1525 |
} |
| 1526 |
% \end{macrocode} |
| 1527 |
% \end{macro}^^A \@Color |
| 1528 |
% \end{macro}^^A \Color |
| 1529 |
% |
| 1530 |
% \iffalse |
| 1531 |
%</class> |
| 1532 |
% \fi |
| 1533 |
% |
| 1534 |
% \subsubsection{Zuordnung der Markup-Befehle für Label und Index} |
| 1535 |
% |
| 1536 |
% \begin{macro}{\tud@attr@get} |
| 1537 |
% \changes{v2.05}{2015/11/03}{neu}^^A |
| 1538 |
% Der Befehl \cs{tud@attr@get} ordnet den einzelnen Markup-Befehlen ihren |
| 1539 |
% spezifischen Präfix für ein Label oder in der Sternversion den passenden |
| 1540 |
% Index zu. Im ersten obligatorischen Argument wird ein Makro angegeben, |
| 1541 |
% welches die Zuordnung enthalten soll, das zweite ist der Markup-Befehl selbst. |
| 1542 |
% \begin{macrocode} |
| 1543 |
\NewDocumentCommand\tud@attr@get{smm}{% |
| 1544 |
\begingroup% |
| 1545 |
% \end{macrocode} |
| 1546 |
% Das temporäre Makro \cs{@tempa} definiert zunächst alle Markup-Befehle in |
| 1547 |
% einer Gruppe neu und expandiert beim Aufruf jedes dieser lokal umdefinierten |
| 1548 |
% Markup-Befehle~-- abhängig vom Aufruf von \cs{tud@attr@get} mit oder ohne |
| 1549 |
% Stern~-- entweder zum Markup-Befehl passenden Index oder zum entsprechenden |
| 1550 |
% Labelpräfix in \cs{@tempb}. |
| 1551 |
% \begin{macrocode} |
| 1552 |
\def\@tempa##1##2##3{% |
| 1553 |
\def##1####1{% |
| 1554 |
\edef\@tempb{\IfBooleanTF{#1}{##2}{##3}}% |
| 1555 |
}% |
| 1556 |
}% |
| 1557 |
\@tempa\Application{\jobname}{app}% |
| 1558 |
\@tempa\Distribution{\jobname}{dst}% |
| 1559 |
\@tempa\Engine{\jobname}{eng}% |
| 1560 |
\@tempa\File{files}{fle}% |
| 1561 |
\@tempa\Class{files}{cls}% |
| 1562 |
\@tempa\Package{files}{pkg}% |
| 1563 |
\@tempa\Option{options}{opt}% |
| 1564 |
\@tempa\Environment{macros}{env}% |
| 1565 |
\@tempa\Macro{macros}{cmd}% |
| 1566 |
\@tempa\Length{misc}{len}% |
| 1567 |
\@tempa\Counter{misc}{cnt}% |
| 1568 |
% \end{macrocode} |
| 1569 |
% Da \cs{Key} mit zwei Hauptargumenten aufgerufen wird, ist nur die Expansion |
| 1570 |
% des ersten Argumentes in \cs{@tempb} notwendig. |
| 1571 |
% \begin{macrocode} |
| 1572 |
%<*class> |
| 1573 |
\def\Key##1##2{% |
| 1574 |
\edef\@tempb{\IfBooleanTF{#1}{macros}{key}}% |
| 1575 |
}% |
| 1576 |
\@tempa\Term{terms}{term}% |
| 1577 |
\@tempa\PageStyle{elements}{pgs}% |
| 1578 |
\@tempa\Font{elements}{font}% |
| 1579 |
\@tempa\Color{elements}{clr}% |
| 1580 |
%</class> |
| 1581 |
% \end{macrocode} |
| 1582 |
% Nachdem alle Markup-Befehle lokal redefiniert wurden, wird der nun angegebene |
| 1583 |
% Befehl ausgeführt, was zum eigentlichen Definieren von \cs{@tempb} führt. |
| 1584 |
% \begin{macrocode} |
| 1585 |
#3% |
| 1586 |
% \end{macrocode} |
| 1587 |
% Damit alle Änderungen der temporären Makros lokal bleiben, wird das Ergebnis |
| 1588 |
% nach der Gruppe in das erste obligatorische Argument expandiert. |
| 1589 |
% \begin{macrocode} |
| 1590 |
\edef\tud@reserved{% |
| 1591 |
\noexpand\endgroup% |
| 1592 |
\def\noexpand#2{\@tempb}% |
| 1593 |
}% |
| 1594 |
\tud@reserved% |
| 1595 |
} |
| 1596 |
% \end{macrocode} |
| 1597 |
% \end{macro}^^A \tud@attr@get |
| 1598 |
% |
| 1599 |
% \subsubsection{Markup von Variablen, Parametern etc.} |
| 1600 |
% |
| 1601 |
% \ToDo{% |
| 1602 |
% Verwendung der Befehle überprüfen, evtl. umbennenen. Wozu \cs{PValueName}?% |
| 1603 |
% Evtl. sollte \cs{PValue} innerhalb von \cs{PName} lokal geändert werden? |
| 1604 |
% Was passiert, wenn auch \cs{PName} von \cs{tud@doifPValue} akzeptiert? |
| 1605 |
% Zeile 542--546 in tudscr-hints, 294 in tudscr-packages |
| 1606 |
% }[v2.??]% |
| 1607 |
% \ToDo{% |
| 1608 |
% nach '=\cs{P(Value)?Name}' in *.tex suchen und ggf. |
| 1609 |
% überarbeiten; \cs{PValueName} umbenennen% |
| 1610 |
% }[v2.??]% |
| 1611 |
% \ToDo{% |
| 1612 |
% bei der Deklaration evtl. ein Hilfsmakro erstellen und den |
| 1613 |
% Default-Eintrag hinterlegen, um ggf. darauf zu prüfen% |
| 1614 |
% }[v2.??]% |
| 1615 |
% \ToDo{% |
| 1616 |
% neues Makro \cs{PLength} mit \cs{PName}\marg{Längenwert} |
| 1617 |
% }[v2.??]% |
| 1618 |
% \begin{macro}{\PValue} |
| 1619 |
% \begin{macro}{\PName} |
| 1620 |
% \begin{macro}{\PValueName} |
| 1621 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 1622 |
% \begin{macro}{\PSet} |
| 1623 |
% \begin{macro}{\PBoolean} |
| 1624 |
% \begin{macro}{\PBName} |
| 1625 |
% \changes{v2.02}{2014/11/12}{neu}^^A |
| 1626 |
% \begin{macro}{\Parameter} |
| 1627 |
% \begin{macro}{\OParameter} |
| 1628 |
% \begin{macro}{\LParameter} |
| 1629 |
% \begin{macro}{\OLParameter} |
| 1630 |
% \begin{macro}{\PParameter} |
| 1631 |
% \begin{macro}{\POParameter} |
| 1632 |
% \changes{v2.03}{2015/01/25}{neu}^^A |
| 1633 |
% \begin{macro}{\textOR} |
| 1634 |
% Diese Befehle dienen zum Auszeichnen von obligatorischen und optionalen |
| 1635 |
% Parametern und Befehlen oder bestimmten Wertzuweisungen. |
| 1636 |
% \begin{macrocode} |
| 1637 |
\newrobustcmd*\PValue[1]{\mbox{\texttt{#1}}} |
| 1638 |
\newrobustcmd*\PName[1]{\PValue{\textsl{<#1>}}} |
| 1639 |
\newrobustcmd*\PValueName[1]{\PName{#1}} |
| 1640 |
\newrobustcmd*\PSet{\PName{Einstellung}} |
| 1641 |
\newrobustcmd*\PBoolean{\PName{Ein-Aus-Wert}} |
| 1642 |
\newrobustcmd*\PBName[1]{\PBoolean\textOR\PName{#1}} |
| 1643 |
\newrobustcmd*\Parameter[1]{% |
| 1644 |
\mbox{\texttt{\textbraceleft}\PName{#1}\texttt{\textbraceright}}% |
| 1645 |
} |
| 1646 |
\newrobustcmd*\OParameter[1]{\mbox{\texttt{[}\PName{#1}\texttt{]}}} |
| 1647 |
\newrobustcmd*\LParameter{\mbox{\texttt{[}\PName{Parameterliste}\texttt{]}}} |
| 1648 |
\newrobustcmd*\OLParameter[1]{% |
| 1649 |
\mbox{\texttt{[}\PName{#1}\textOR\PName{Parameterliste}\texttt{]}}% |
| 1650 |
} |
| 1651 |
\newrobustcmd*\PParameter[1]{\mbox{\texttt{\textbraceleft#1\textbraceright}}} |
| 1652 |
\newrobustcmd*\POParameter[1]{\mbox{\texttt{[#1]}}} |
| 1653 |
\newrobustcmd*\textOR{\PValue{\,\textbardbl\,}} |
| 1654 |
% \end{macrocode} |
| 1655 |
% \end{macro}^^A \textOR |
| 1656 |
% \end{macro}^^A \POParameter |
| 1657 |
% \end{macro}^^A \PParameter |
| 1658 |
% \end{macro}^^A \OLParameter |
| 1659 |
% \end{macro}^^A \LParameter |
| 1660 |
% \end{macro}^^A \OParameter |
| 1661 |
% \end{macro}^^A \Parameter |
| 1662 |
% \end{macro}^^A \PBName |
| 1663 |
% \end{macro}^^A \PBoolean |
| 1664 |
% \end{macro}^^A \PSet |
| 1665 |
% \end{macro}^^A \PValueName |
| 1666 |
% \end{macro}^^A \PName |
| 1667 |
% \end{macro}^^A \PValue |
| 1668 |
% \begin{macro}{\tud@doifPValue} |
| 1669 |
% \changes{v2.05}{2015/11/14}{neu}^^A |
| 1670 |
% Der Befehl wird von den Makros \cs{tud@lbl@get@curr} und \cs{tud@idx@get} |
| 1671 |
% genutzt, um bedingten Quelltext auszuführen, falls im ersten obligatorischen |
| 1672 |
% Argument entweder Parameter entweder direkt oder aber mit einem der beiden |
| 1673 |
% Parameter-Markup-Befehle \cs{PValue} oder \cs{PValueName} angegeben wurde. |
| 1674 |
% Alle anderen Auszeichnungsbefehle für Parameter sollen ingnoriert werden. |
| 1675 |
% \begin{macrocode} |
| 1676 |
\newcommand*\tud@doifPValue[3][]{% |
| 1677 |
\IfValueT{#2}{% |
| 1678 |
\begingroup% |
| 1679 |
% \end{macrocode} |
| 1680 |
% Zunächst wird der Inhalt fast aller ausgezeichneten Parameter unterdrückt. |
| 1681 |
% Lediglich das Argument der beiden Makros \cs{PValue} und \cs{PValueName} wird |
| 1682 |
% durchgereicht.Dies wird bei der Generierung von Labeln sowie der Erstellung |
| 1683 |
% für Einträge im Index und der Änderungsliste benötigt, um die Angabe von |
| 1684 |
% speziellen Werten bei Schlüsseln zu erhalten. |
| 1685 |
% \begin{macrocode} |
| 1686 |
\let\PValue\@firstofone% |
| 1687 |
\let\PName\@gobble% |
| 1688 |
\let\PValueName\@firstofone% |
| 1689 |
\let\PSet\@empty% |
| 1690 |
\let\PBoolean\@empty% |
| 1691 |
\let\PBName\@gobble% |
| 1692 |
\let\Parameter\@gobble% |
| 1693 |
\let\OParameter\@gobble% |
| 1694 |
\let\LParameter\@empty% |
| 1695 |
\let\OLParameter\@gobble% |
| 1696 |
\let\PParameter\@gobble% |
| 1697 |
\let\POParameter\@gobble% |
| 1698 |
\let\textOR\relax% |
| 1699 |
\let\emph\@firstofone% |
| 1700 |
% \end{macrocode} |
| 1701 |
% Im optionalen Argument können weitere Angaben gemacht werden, um zum Beispiel |
| 1702 |
% weitere lokale Redefinitionen vorzunehmen. |
| 1703 |
% \begin{macrocode} |
| 1704 |
#1% |
| 1705 |
% \end{macrocode} |
| 1706 |
% Falls tatsächlich ein passendes Argument angegeben wurde, wird der Quelltext |
| 1707 |
% des zweiten obligatorischen Argumentes ausgeführt. Es ist zu beachten, dass |
| 1708 |
% dieser \emph{expandiert} wird! |
| 1709 |
% \begin{macrocode} |
| 1710 |
\tud@if@strblank{#2}{% |
| 1711 |
\let\tud@reserved\endgroup% |
| 1712 |
}{% |
| 1713 |
\protected@edef\tud@reserved{\noexpand\endgroup#3}% |
| 1714 |
}% |
| 1715 |
\tud@reserved% |
| 1716 |
}% |
| 1717 |
} |
| 1718 |
% \end{macrocode} |
| 1719 |
% \end{macro}^^A \tud@doifPValue |
| 1720 |
% \begin{macro}{\Markup@Gobble} |
| 1721 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 1722 |
% Dieser Befehl definiert alle Markup-Befehle in der Form um, dass diese nur |
| 1723 |
% noch das eigentliche Hauptargument unformatiert durchreichen. Dies wird für |
| 1724 |
% die Erstellung von Label und Indexeinträgen benötigt. Die Sternversion führt |
| 1725 |
% dies auch noch für die Auszeichnung von Parametern etc. durch. |
| 1726 |
% \begin{macrocode} |
| 1727 |
\NewDocumentCommand\Markup@Gobble{s}{% |
| 1728 |
\let\Application\@Application% |
| 1729 |
\let\Distribution\@Distribution% |
| 1730 |
\let\Engine\@Engine% |
| 1731 |
\let\File\@File% |
| 1732 |
\let\Class\@Class% |
| 1733 |
\let\Package\@Package% |
| 1734 |
\let\Option\@Option% |
| 1735 |
\let\Environment\@Environment% |
| 1736 |
\let\Macro\@Macro% |
| 1737 |
\let\Length\@Length% |
| 1738 |
\let\Counter\@Counter% |
| 1739 |
%<*class> |
| 1740 |
\let\Key\@Key% |
| 1741 |
\let\Term\@Term% |
| 1742 |
\let\PageStyle\@PageStyle% |
| 1743 |
\let\Font\@Font% |
| 1744 |
\let\Color\@Color% |
| 1745 |
%</class> |
| 1746 |
\IfBooleanF{#1}{% |
| 1747 |
\let\PValue\@firstofone% |
| 1748 |
\let\PName\@firstofone% |
| 1749 |
\let\PValueName\@firstofone% |
| 1750 |
\let\PSet\relax% |
| 1751 |
\let\PBoolean\relax% |
| 1752 |
\let\PBName\@firstofone% |
| 1753 |
\let\Parameter\@firstofone% |
| 1754 |
\let\OParameter\@firstofone% |
| 1755 |
\let\LParameter\relax% |
| 1756 |
\let\OLParameter\@firstofone% |
| 1757 |
\let\PParameter\@firstofone% |
| 1758 |
\let\POParameter\@firstofone% |
| 1759 |
\let\textOR\relax% |
| 1760 |
\let\hologoRobust\@firstofone% |
| 1761 |
\def\_{-}% |
| 1762 |
\protected\def~{~}% |
| 1763 |
}% |
| 1764 |
} |
| 1765 |
% \end{macrocode} |
| 1766 |
% Mit dem zuvor definierten Makro \cs{Markup@Gobble} wird gleich dafür Sorge |
| 1767 |
% getragen, dass die Auszeichnungsbefehle für PDF-Outline-Einträge korrekt |
| 1768 |
% funktionieren. |
| 1769 |
% \begin{macrocode} |
| 1770 |
\AfterPackage*{hyperref}{% |
| 1771 |
\expandafter\pdfstringdefDisableCommands\expandafter{\Markup@Gobble}% |
| 1772 |
} |
| 1773 |
% \end{macrocode} |
| 1774 |
% \end{macro}^^A \Markup@Gobble |
| 1775 |
% |
| 1776 |
% \subsubsection{Erstellung und Validierung von Labeln} |
| 1777 |
% |
| 1778 |
% \begin{macro}{\tud@lbl@tmp} |
| 1779 |
% \changes{v2.05}{2015/11/03}{neu}^^A |
| 1780 |
% \begin{macro}{\tud@lbl@fmt} |
| 1781 |
% \changes{v2.05}{2015/11/03}{neu}^^A |
| 1782 |
% In \cs{tud@lbl@tmp} werden nachfolgend die durch \cs{tud@lbl@get@curr} oder |
| 1783 |
% \cs{tud@attr@get} erzeugten (Sub-)Label gespeichert. Mit dem Hilfsmakro |
| 1784 |
% \cs{tud@lbl@fmt} wird innerhalb der beiden Befehle \cs{tud@lbl@@create} und |
| 1785 |
% \cs{tud@lbl@get@@curr} dafür gesorgt, dass geschützte Leerzeichen sowie |
| 1786 |
% eingabekodierungsabhängige Zeichen korrekt für ein Label umgesetzt werden. |
| 1787 |
% Auch durch \cs{NoCaseChange} in Überschriften geschützte Inhalte werden |
| 1788 |
% direkt übernommen. |
| 1789 |
% \begin{macrocode} |
| 1790 |
\newcommand*\tud@lbl@tmp{} |
| 1791 |
\newcommand*\tud@lbl@fmt{% |
| 1792 |
\def~{-}% |
| 1793 |
\let\IeC\@firstofone% |
| 1794 |
\def\"##1{##1e}% |
| 1795 |
\def\ss{ss}% |
| 1796 |
\def\dots{...}% |
| 1797 |
\let\NoCaseChange\@firstofone% |
| 1798 |
} |
| 1799 |
% \end{macrocode} |
| 1800 |
% \end{macro}^^A \tud@lbl@fmt |
| 1801 |
% \end{macro}^^A \tud@lbl@tmp |
| 1802 |
% \begin{macro}{\tud@lbl@get@curr} |
| 1803 |
% \changes{v2.05}{2015/11/03}{neu}^^A |
| 1804 |
% \begin{macro}{\tud@lbl@get@@curr} |
| 1805 |
% \changes{v2.05}{2015/11/03}{neu}^^A |
| 1806 |
% Für den Befehl \cs{tud@lbl@get@curr} wird das zweite obligatorische |
| 1807 |
% Argument (|#3|) für gewöhnlich in der Form |
| 1808 |
% |{\Bundle|\marg{Klasse/Paket}|:\Markup|\marg{Element}|}| angegeben. Dieses |
| 1809 |
% wird beim Einlesen direkt an die beiden Argumentprozessoren |
| 1810 |
% \cs{SplitArgument}|{2}{:}| gefolgt von \cs{tud@lbl@create} übergeben. Danach |
| 1811 |
% enthält das zweite obligatorische Argument ein Label der Form |
| 1812 |
% \meta{Bundlepräfix}|:|\meta{Labelpräfix}|:|\meta{Element}. Auch die Angabe |
| 1813 |
% eines Makros als zweites obligatorische Argument, welches das Label in der |
| 1814 |
% richtigen Formatierung enthält, ist möglich. |
| 1815 |
% \begin{macrocode} |
| 1816 |
\NewDocumentCommand\tud@lbl@get@curr{% |
| 1817 |
sm>{\tud@lbl@create}>{\SplitArgument{2}{:}}md==% |
| 1818 |
}{% |
| 1819 |
% \end{macrocode} |
| 1820 |
% Mit \cs{tud@lbl@get@@curr} wird das im zweiten obligatorischen Argument |
| 1821 |
% (|#3|) generierte Label in das im ersten obligatorischen Argument |#2| |
| 1822 |
% angegebenen Makro gespeichert und ggf. diesem das letzte optionale Argument |
| 1823 |
% für einen speziellen Wert zu einem Schlüssel angehangen. |
| 1824 |
% \begin{macrocode} |
| 1825 |
\tud@lbl@get@@curr#2{#3}=#4=% |
| 1826 |
% \end{macrocode} |
| 1827 |
% Die Sternversion von \cs{tud@lbl@get@curr} wird für das Definieren von Labeln |
| 1828 |
% bei Deklarationen etc. genutzt. Sollte diese verwendet worden sein, ist die |
| 1829 |
% Generierung beendet. |
| 1830 |
% \begin{macrocode} |
| 1831 |
%<*class> |
| 1832 |
\IfBooleanF{#1}{% |
| 1833 |
% \end{macrocode} |
| 1834 |
% Andernfalls wird geprüft, ob das erstellte Label überhaupt existiert. Sollte |
| 1835 |
% dies nicht der Fall sein wird ein passendes Label für den gegebenen Schlüssel |
| 1836 |
% ohne speziellen Wert gesucht. |
| 1837 |
% \begin{macrocode} |
| 1838 |
\@tempswafalse% |
| 1839 |
\tud@if@lbl@exists{#2}{% |
| 1840 |
\@tempswatrue% |
| 1841 |
}{% |
| 1842 |
\IfValueT{#4}{% |
| 1843 |
\tud@lbl@get@@curr\tud@reserved{#3}% |
| 1844 |
\tud@if@lbl@exists{\tud@reserved}{% |
| 1845 |
\let#2\tud@reserved% |
| 1846 |
\@tempswatrue% |
| 1847 |
}{}% |
| 1848 |
}% |
| 1849 |
}% |
| 1850 |
% \end{macrocode} |
| 1851 |
% Wurde auch danach noch kein passendes Label gefunden, gibt es u.\,U. eine |
| 1852 |
% letzte Möglichkeit, ein passendes Label zu finden. Wird in der Dokumentation |
| 1853 |
% gerade ein Paket oder eine sich von den Hauptklassen unterscheidende Klasse |
| 1854 |
% aus dem \TUDScript-Bundle erläutert (Umgebungen \env{Bundle}, \env{Bundle*}), |
| 1855 |
% so wird eventuell auf ein Element aus ebendiesen Hauptklassen referenziert. |
| 1856 |
% In diesem Fall wird \cs{tud@lbl@get@dflt} aufgerufen, um den Bundlepräfix |
| 1857 |
% für das Label entsprechend zu setzen. |
| 1858 |
% \begin{macrocode} |
| 1859 |
\if@tempswa\else% |
| 1860 |
\tud@if@bdl{\tud@lbl@get@dflt#2{#3}=#4=}{}% |
| 1861 |
\fi% |
| 1862 |
}% |
| 1863 |
%</class> |
| 1864 |
} |
| 1865 |
% \end{macrocode} |
| 1866 |
% Mit \cs{tud@lbl@get@@curr} wird das generierte Label in Makro gespeichert, |
| 1867 |
% welches beim Aufruf von \cs{tud@lbl@get@curr} angegebenen wurde. |
| 1868 |
% \begin{macrocode} |
| 1869 |
\NewDocumentCommand\tud@lbl@get@@curr{mmd==}{% |
| 1870 |
\def#1{#2}% |
| 1871 |
% \end{macrocode} |
| 1872 |
% Sollte optional mit \cs{PValue} bzw. \cs{PValueName} ein spezieller Wert für |
| 1873 |
% einen Schlüssel übergeben worden sein, wird dieser ggf. angehängt. |
| 1874 |
% \begin{macrocode} |
| 1875 |
\tud@doifPValue[\tud@lbl@fmt]{#3}{\noexpand\appto\noexpand#1{=#3}}% |
| 1876 |
} |
| 1877 |
% \end{macrocode} |
| 1878 |
% \end{macro}^^A \tud@lbl@get@@curr |
| 1879 |
% \end{macro}^^A \tud@lbl@get@curr |
| 1880 |
% \begin{macro}{\tud@lbl@get@dflt} |
| 1881 |
% \changes{v2.05}{2015/11/04}{neu}^^A |
| 1882 |
% \begin{macro}{\tud@lbl@get@@dflt} |
| 1883 |
% \changes{v2.05}{2015/11/04}{neu}^^A |
| 1884 |
% Diese beiden Makros werden genutzt, um mit \cs{tud@lbl@get@curr} innerhalb |
| 1885 |
% der Umgebungen \env{Bundle} und \env{Bundle*} für den Fall, dass ein |
| 1886 |
% gesuchtes Label für das aktuelle Bundle-Element nicht existiert, nach diesem |
| 1887 |
% Element in den existierenden Labels der Hauptklassen zu suchen. |
| 1888 |
% |
| 1889 |
% Dabei wird das bereits generierte Label durch \cs{tud@lbl@get@dflt} in |
| 1890 |
% seine drei Hauptbestandteile zur WEiterverarbeitung zerlegt. |
| 1891 |
% \begin{macrocode} |
| 1892 |
\NewDocumentCommand\tud@lbl@get@dflt{m>{\SplitArgument{2}{:}}mr==}{% |
| 1893 |
\tud@lbl@get@@dflt{#1}#2=#3=% |
| 1894 |
} |
| 1895 |
% \end{macrocode} |
| 1896 |
% Durch \cs{tud@lbl@get@@dflt} wird als erstes geprüft, ob der Bundlepräfix |
| 1897 |
% bereits dem Standardpräfix für die Hauptklassen entspricht. Nur wenn dies |
| 1898 |
% nicht der Fall ist, wird die Labelgenerierung abermals ausgeführt. |
| 1899 |
% \begin{macrocode} |
| 1900 |
\NewDocumentCommand\tud@lbl@get@@dflt{mmmmr==}{% |
| 1901 |
\tud@if@strequal{#2}{\tud@bdl@dflt}{}{% |
| 1902 |
% \end{macrocode} |
| 1903 |
% Dabei erfolgt der Aufruf logischerweise mit dem richtigen Bundlepräfix. |
| 1904 |
% \begin{macrocode} |
| 1905 |
\tud@lbl@get@curr#1{\tud@bdl@dflt:#3:#4}=#5=% |
| 1906 |
}% |
| 1907 |
} |
| 1908 |
% \end{macrocode} |
| 1909 |
% \end{macro}^^A \tud@lbl@get@@dflt |
| 1910 |
% \end{macro}^^A \tud@lbl@get@dflt |
| 1911 |
% \begin{macro}{\tud@if@lbl@exists} |
| 1912 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 1913 |
% Mit dem Befehl \cs{tud@if@lbl@exists} wird eine Fallunterscheidung bezüglich |
| 1914 |
% der Existenz eines Labels in der Form |
| 1915 |
% \meta{Bundlepräfix}|:|\meta{Labelpräfix}|:|\meta{Element} durchgeführt. Das |
| 1916 |
% zu prüfende Label ist in gleicher Weise wie beim Makro \cs{tud@lbl@get@curr} |
| 1917 |
% anzugeben. Je nachdem, ob ein existierendes Label gefunden wird oder nicht, |
| 1918 |
% wird das zweite oder das dritte obligatorische Argument ausgeführt. |
| 1919 |
% \begin{macrocode} |
| 1920 |
%<*class> |
| 1921 |
\NewDocumentCommand\tud@if@lbl@exists{% |
| 1922 |
>{\tud@lbl@create}>{\SplitArgument{2}{:}}m% |
| 1923 |
}{% |
| 1924 |
\ifcsundef{r@#1}{% |
| 1925 |
\expandafter\@secondoftwo% |
| 1926 |
}{% |
| 1927 |
\expandafter\@firstoftwo% |
| 1928 |
}% |
| 1929 |
} |
| 1930 |
%</class> |
| 1931 |
% \end{macrocode} |
| 1932 |
% \end{macro}^^A \tud@if@lbl@exists |
| 1933 |
% \begin{macro}{\tud@lbl@create} |
| 1934 |
% \changes{v2.05}{2015/11/03}{neu}^^A |
| 1935 |
% \begin{macro}{\tud@lbl@@create} |
| 1936 |
% \changes{v2.05}{2015/11/03}{neu}^^A |
| 1937 |
% Das Makro \cs{tud@lbl@@create} ist ein Argumentprozessor, welcher als Eingabe |
| 1938 |
% genau drei Argumente für das Erstellen eines gültigen Labels erwartet. Er |
| 1939 |
% wird sowohl von \cs{tud@lbl@get@curr} als auch von \cs{tud@if@lbl@exists} |
| 1940 |
% verwendet. Vor der Nutzung von \cs{tud@lbl@create} muss das Argument zuvor |
| 1941 |
% bereits mit \cs{SplitArgument}|{2}{:}| aufgerufen worden sein. Diese |
| 1942 |
% Eigenheit macht die Definition von \cs{tud@lbl@create} notwendig, um das |
| 1943 |
% Ergebnis der zuvor vorgenommenen Argumentaufspaltung verarbeiten zu können, |
| 1944 |
% in dem dieses an \cs{tud@lbl@@create} durchgereicht wird. Eine Integration |
| 1945 |
% der Spaltung des Argumentes in \cs{tud@lbl@create} ist aufgrund des |
| 1946 |
% mehrmaligen rekursiven Aufrufs von \cs{tud@lbl@create} nicht möglich. |
| 1947 |
% |
| 1948 |
% Mit dem Argumentprozessor \cs{tud@lbl@create} wird es ermöglicht, an die |
| 1949 |
% beiden Befehle \cs{tud@lbl@get@curr} und \cs{tud@if@lbl@exists} sowohl ein |
| 1950 |
% einzelnes Makro, welches das Label bereits beinhaltet als auch einen |
| 1951 |
% Markup-Befehl ggf. mit einem Bundlepräfix zu übergeben. In beiden Fällen |
| 1952 |
% wird aus dem übergebenen Argument ein eindeutiges Label in der Form |
| 1953 |
% \meta{Bundlepräfix}|:|\meta{Labelpräfix}|:|\meta{Element} generiert und als |
| 1954 |
% resultierendes Argument an das aufrufenden Makro übergeben. |
| 1955 |
% \begin{macrocode} |
| 1956 |
\NewDocumentCommand\tud@lbl@create{m}{\tud@lbl@@create#1} |
| 1957 |
% \end{macrocode} |
| 1958 |
% Es gibt insgesamt vier verschiedene Varianten der Argumentenübergabe an den |
| 1959 |
% Argumentprozessor \cs{tud@lbl@@create}. |
| 1960 |
% \begin{description}\let\itshape\slshape |
| 1961 |
% \item[\cs{tud@lbl@@create}]\ignorespaces% |
| 1962 |
% |{\LabelMakro}{-NoValue-}{-NoValue-}|\strut\newline% |
| 1963 |
% Das Label ist bereits in \cs{LabelMakro} enthalten und soll expandiert |
| 1964 |
% werden. Dabei spielt es keine Rolle, ob die durch |:| getrennten |
| 1965 |
% Bestandteile innerhalb des Labels schon als einfacher String oder in der |
| 1966 |
% Markupform gegeben sind. |
| 1967 |
% \item[\cs{tud@lbl@@create}]\ignorespaces% |
| 1968 |
% |{-NoValue-}{\Markup|\marg{Element}|}{-NoValue-}|\strut\newline% |
| 1969 |
% Das Label soll für ein Markupelement generiert werden, wobei in jedem |
| 1970 |
% Fall der Inhalt aus \cs{tud@bdl@curr} als Bundlepräfix genutzt wird. |
| 1971 |
% \item[\cs{tud@lbl@@create}]\ignorespaces% |
| 1972 |
% |{\Class/\Package|\marg{\dots}|}|\ignorespaces% |
| 1973 |
% |{\Markup|\marg{Element}|}{-NoValue-}|\strut\newline% |
| 1974 |
% Das Label soll für ein Markupelement generiert werden. |
| 1975 |
% Dabei wurde explizit ein Paket oder eine Klasse aus dem Bundle angegeben |
| 1976 |
% oder implizit das Makro \cs{tud@bdl@curr} als Argument verwendet, |
| 1977 |
% welches innerhalb der Umgebungen \env{Bundle} und \env{Bundle*} auf |
| 1978 |
% das/die aktuell beschriebene Paket/Klasse gesetzt wurde. |
| 1979 |
% \item[\cs{tud@lbl@@create}]\ignorespaces% |
| 1980 |
% \marg{Bundlepräfix}\marg{Labelpräfix}\marg{Element}\strut\newline |
| 1981 |
% Das Label ist bereits vollständig bestimmt und die Argumente werden |
| 1982 |
% entweder als String oder als Markup übergeben. Auch Mischformen sind |
| 1983 |
% möglich. In diesem Fall wird es einfach wieder zusammengesetzt. Diese |
| 1984 |
% Variante tritt durch rekursiven Aufruf des Argumentprozessors auf. |
| 1985 |
% \end{description} |
| 1986 |
% \begin{macrocode} |
| 1987 |
\NewDocumentCommand\tud@lbl@@create{mmm}{% |
| 1988 |
\begingroup% |
| 1989 |
% \end{macrocode} |
| 1990 |
% Zu Beginn werden die Markup-Befehle auf ihre expandierbaren Varianten gesetzt |
| 1991 |
% und die zusätzlichen Redefinitionen für die Labelgenerierung aktiviert. |
| 1992 |
% \begin{macrocode} |
| 1993 |
\Markup@Gobble% |
| 1994 |
\tud@lbl@fmt% |
| 1995 |
% \end{macrocode} |
| 1996 |
% Sind alle drei Bestandteile bereits vorhanden, wird das Label einfach wieder |
| 1997 |
% zusammengesetzt. |
| 1998 |
% \begin{macrocode} |
| 1999 |
\IfValueTF{#3}{% |
| 2000 |
\edef\@tempa{#1:#2:#3}% |
| 2001 |
}{% |
| 2002 |
% \end{macrocode} |
| 2003 |
% Hier geschieht die eigentliche Erzeugung der Labels. Dabei wird mit |
| 2004 |
% \cs{tud@attr@get} der für den jeweiligen Markup-Befehl aus dem zweiten |
| 2005 |
% obligatorischen Argument spezifische Labelpräfix generiert. Abhängig davon, |
| 2006 |
% ob im ersten obligatorischen Argument ein spezieller Bundlepräfix angegeben |
| 2007 |
% wurde, wird dieser entweder verwendet oder aber implizit auf den Inhalt aus |
| 2008 |
% \cs{tud@bdl@dflt} zurückgegriffen. |
| 2009 |
% \begin{macrocode} |
| 2010 |
\IfValueTF{#2}{% |
| 2011 |
\tud@attr@get\@tempb{#2}% |
| 2012 |
\IfValueTF{#1}{% |
| 2013 |
\tud@if@strblank{#1}{% |
| 2014 |
\edef\@tempa{\tud@bdl@dflt:\@tempb:#2}% |
| 2015 |
}{% |
| 2016 |
\edef\@tempa{#1:\@tempb:#2}% |
| 2017 |
}% |
| 2018 |
}{% |
| 2019 |
\edef\@tempa{\tud@bdl@curr:\@tempb:#2}% |
| 2020 |
}% |
| 2021 |
}{% |
| 2022 |
% \end{macrocode} |
| 2023 |
% Wurde lediglich ein Makro angegeben, wird dieses einfach expandiert. |
| 2024 |
% \begin{macrocode} |
| 2025 |
\edef\@tempa{#1}% |
| 2026 |
}% |
| 2027 |
}% |
| 2028 |
% \end{macrocode} |
| 2029 |
% Das Ergebnis der Labelgenrierung wurde für alle der behandelten Fälle in |
| 2030 |
% \cs{@tempa} geschrieben. Abschließnd wird \cs{ProcessedArgument} nach der |
| 2031 |
% Gruppe mit dessen Inhalt definiert. Dabei werden bei der Expansion die |
| 2032 |
% catcodes aller Zeichen in Tokens der Klasse \val{other} gewandelt, um diese |
| 2033 |
% später sicher vergleichen zu können. |
| 2034 |
% \begin{macrocode} |
| 2035 |
\edef\@tempc{% |
| 2036 |
\noexpand\endgroup% |
| 2037 |
\def\noexpand\ProcessedArgument{% |
| 2038 |
\expandafter\detokenize\expandafter{\@tempa}% |
| 2039 |
}% |
| 2040 |
}% |
| 2041 |
\@tempc% |
| 2042 |
} |
| 2043 |
% \end{macrocode} |
| 2044 |
% \end{macro}^^A \tud@lbl@@create |
| 2045 |
% \end{macro}^^A \tud@lbl@create |
| 2046 |
% |
| 2047 |
% \subsubsection{Abarbeitung der Markup-Befehle} |
| 2048 |
% |
| 2049 |
% Die Festlegung des individuellen Markups der Einzelnen Elemente erfolgt bei |
| 2050 |
% der Definition mit \cs{Markup@SetFormat}. Bei der Nutztung der Markup-Befehle |
| 2051 |
% im Fließtext wird zum einen das in \cs{Markup@Format} individuell definierte |
| 2052 |
% Markup umgesetzt und zum anderen wird dabei gleich automatisch ein Eintrag |
| 2053 |
% für das Element im Index erzeugt. |
| 2054 |
% |
| 2055 |
% \begin{macro}{\ifdisposition} |
| 2056 |
% \changes{v2.06}{2018/08/02}{neu}^^A |
| 2057 |
% \begin{macro}{\if@tud@disposition} |
| 2058 |
% \begin{macro}{\tud@sec@format} |
| 2059 |
% Für Markup oder andere Inhalte, die lediglich im Fließtext jedoch nicht in |
| 2060 |
% Überschriften ausgegeben werden, wird der Schalter \cs{if@tud@disposition} |
| 2061 |
% und der dazugehörige auswertende Befehl \cs{ifdisposition} definiert. Das |
| 2062 |
% Setzen des Schalters wird in \cs{tud@sec@format} gepatcht. |
| 2063 |
% \ToDo{besser nur als internen Befehl definieren \cs{tud@if@...}?!}[v2.06] |
| 2064 |
% \begin{macrocode} |
| 2065 |
\tud@newif\if@tud@disposition |
| 2066 |
\newcommand*\ifdisposition{% |
| 2067 |
\if@tud@disposition% |
| 2068 |
\expandafter\@firstoftwo% |
| 2069 |
\else% |
| 2070 |
\expandafter\@secondoftwo% |
| 2071 |
\fi% |
| 2072 |
} |
| 2073 |
\pretocmd\tud@sec@format{% |
| 2074 |
\@tud@dispositiontrue% |
| 2075 |
}{}{\tud@patch@wrn{tud@sec@format}} |
| 2076 |
% \end{macrocode} |
| 2077 |
% \end{macro}^^A \tud@sec@format |
| 2078 |
% \end{macro}^^A \if@tud@disposition |
| 2079 |
% \end{macro}^^A \tud@if@disposition |
| 2080 |
% |
| 2081 |
% In der Klasse \cls{tudscrmanual} werden die Markup-Befehle zusätzlich auch |
| 2082 |
% als Argument der Umgebung \env{Declaration} genutzt. Für diese Verwendung |
| 2083 |
% kommt die Definition von \cs{Markup@Declare} und ggf. \cs{Markup@Suffix} zum |
| 2084 |
% Einsatz. |
| 2085 |
% |
| 2086 |
% \begin{macro}{\Process@Markup} |
| 2087 |
% \changes{v2.02}{2014/10/08}{Markup für Index und Fließtext getrennt}^^A |
| 2088 |
% \changes{v2.02}{2014/10/09}{Anpassung für Umgebung \env{Declaration*}}^^A |
| 2089 |
% \changes{v2.05}{2015/11/05}{Neuimplementierung}^^A |
| 2090 |
% \begin{macro}{\Markup@Suppress} |
| 2091 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2092 |
% \begin{macro}{\Markup@@Suppress} |
| 2093 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2094 |
% Der Befehl \cs{Process@Markup} ist das Herzstück der Auszeichnungen aller |
| 2095 |
% Elemente. Das obligatorische Argument ist das auszuzeichnende Element selbst, |
| 2096 |
% welches im weiteren Verlauf der Abarbeitung expandiert wird. Darauf folgen |
| 2097 |
% mehrere optionale Argumente. Mit |=|\meta{Wert}|=| kann ein Wert für einen |
| 2098 |
% Schlüssel angegeben werden, was aktuell von \cs{Option} und \cs{Key} genutzt |
| 2099 |
% wird. Darauf folgend kann in einem ordinären optionalen Argument ein Suffix |
| 2100 |
% für die Fließtextausgabe angegeben werden, was von \cs{Distribution} sowie |
| 2101 |
% \cs{Environment}, \cs{Macro} und \cs{Color} verwendet wird. |
| 2102 |
% |
| 2103 |
% Mit dem optionalen Argument in runden Klammern kann eine Klasse oder ein |
| 2104 |
% Paket aus dem \TUDScript-Bundle angegeben werden, auf welche sich das |
| 2105 |
% aktuelle auszuzeichnende Element bezieht und ggf. das Label und der |
| 2106 |
% Indexeintrag dementsprechend erzeugt werden sollen. Verwendet wird es mit: |
| 2107 |
% |(\Class|\marg{Klasse}|)| oder |(\Package|\marg{Paket}|)| |
| 2108 |
% |
| 2109 |
% Das optionale Argument in Guillemets wird von \cs{Package} benötigt, um ggf. |
| 2110 |
% die automatisch generierten Links auf CTAN anzupassen. Zuletzt kann mit |
| 2111 |
% |'|\meta{Referenzvariante}|'| der automatisch erzeugte Querverweis in |
| 2112 |
% verschiedenen Varianten formatiert werden. Der vollständige Funktionsaufruf: |
| 2113 |
% \newline\begingroup\scriptsize |
| 2114 |
% \cs{Process@Markup}\marg{Element}|=|\meta{Wert}|=|\ignorespaces% |
| 2115 |
% \oarg{Ausgabesuffix}\parg{Bundleelement}\ignorespaces% |
| 2116 |
% |<|\meta{CTAN-Paket}|>||'|\meta{Referenzvariante}|'|\ignorespaces% |
| 2117 |
% \endgroup |
| 2118 |
% |
| 2119 |
% In eingen Fällen ist es beim Aufruf eines Markup-Befehls nicht erwünscht, |
| 2120 |
% dass dieser auch tatsächlich ausgegeben wird. Für diesen Fall wird gleich zu |
| 2121 |
% Beginn der Befehl \cs{Markup@Suppress} definiert, der dies ermöglicht. |
| 2122 |
% \begin{macrocode} |
| 2123 |
\newcommand*\Markup@Suppress{\let\Process@Markup\Markup@@Suppress} |
| 2124 |
\NewDocumentCommand\Markup@@Suppress{md==od()d<>d''}{} |
| 2125 |
% \end{macrocode} |
| 2126 |
% Nun folgt die eigentliche Befehlsdefinition. |
| 2127 |
% \begin{macrocode} |
| 2128 |
\NewDocumentCommand\Process@Markup{md==od()d<>d''}{% |
| 2129 |
% \end{macrocode} |
| 2130 |
% Zu Beginn wird mit dem Schalter \cs{if@tud@declare} geprüft, ob die der |
| 2131 |
% Markup-Befehl in einer der Deklarationsumgebungen oder anderweitig genutzt |
| 2132 |
% wird. Für den ersten Fall erfolgt die Weiterverarbeitung der Argumente mit |
| 2133 |
% \cs{Process@@MarkupDeclare}, andernfalls kommt \cs{Process@@MarkupInline} zum |
| 2134 |
% Einsatz. Da beide Makros die gleiche Reihenfolge der Argumente verlangen, |
| 2135 |
% wird der jeweilige Befehlsaufruf über ein Token-Register realisiert, womit |
| 2136 |
% das Zusammensetzen der notwendigen Übergabewerte erleichtert wird. |
| 2137 |
% |
| 2138 |
% Die Fallunterscheidung betrifft des Weiteren die Erzeugung des Labels. Für |
| 2139 |
% eine Deklaration wird die Sternversion von \cs{tud@lbl@get@curr} verwendet, |
| 2140 |
% welche ein Label aus den gegebenen Argumenten zusammensetzt. Ist keine |
| 2141 |
% Deklaration aktiv, versucht \cs{tud@lbl@get@curr} ein gültiges, schon |
| 2142 |
% vorhandenes Label zu verwenden. Das generierte Label wird anschließend als |
| 2143 |
% erstes Argument für das weiterverabeitende Makro genutzt. |
| 2144 |
% \begin{macrocode} |
| 2145 |
%<*class> |
| 2146 |
\if@tud@declare% |
| 2147 |
\tud@toks@{\Process@@MarkupDeclare}% |
| 2148 |
\IfValueTF{#4}{% |
| 2149 |
\tud@lbl@get@curr*\tud@lbl@tmp{#4:#1}=#2=% |
| 2150 |
}{% |
| 2151 |
\tud@lbl@get@curr*\tud@lbl@tmp{\tud@bdl@curr:#1}=#2=% |
| 2152 |
}% |
| 2153 |
\else% |
| 2154 |
%</class> |
| 2155 |
\tud@toks@{\Process@@MarkupInline}% |
| 2156 |
\tud@lbl@get@curr\tud@lbl@tmp{#4:#1}=#2=% |
| 2157 |
%<*class> |
| 2158 |
\fi% |
| 2159 |
%</class> |
| 2160 |
\addto@hook@expandafter\tud@toks@{\expandafter{\tud@lbl@tmp}}% |
| 2161 |
% \end{macrocode} |
| 2162 |
% Danach wird der Inhalt des im ersten Argument übergebenen Markup-Befehls in |
| 2163 |
% einer Gruppe ein temporäres Makro expandiert und als zweites Argument für die |
| 2164 |
% Weiterverarbeitung genutzt. |
| 2165 |
% \begin{macrocode} |
| 2166 |
\begingroup% |
| 2167 |
\Markup@Gobble*% |
| 2168 |
\protected@edef\tud@reserved{% |
| 2169 |
\noexpand\endgroup% |
| 2170 |
\def\noexpand\tud@reserved{#1}% |
| 2171 |
}% |
| 2172 |
\tud@reserved% |
| 2173 |
\addto@hook@expandafter\tud@toks@{\expandafter{\tud@reserved}}% |
| 2174 |
% \end{macrocode} |
| 2175 |
% Es folgen gegebenenfalls die optionalen Argument |=|\meta{Wert}|=| sowie |
| 2176 |
% \oarg{Ausgabesuffix}~-- falls diese angegeben wurden. |
| 2177 |
% \begin{macrocode} |
| 2178 |
\IfValueT{#2}{\addto@hook\tud@toks@{=#2=}}% |
| 2179 |
\IfValueT{#3}{\addto@hook\tud@toks@{[#3]}}% |
| 2180 |
% \end{macrocode} |
| 2181 |
% Erfolgt gerade eine Deklaration, wird mit dem Schalter \cs{if@openindex} |
| 2182 |
% eigentlich unterschieden, ob ein öffnender oder ein schließender Indexeintrag |
| 2183 |
% erzeugt werden soll. Dieser wird mit \cs{Process@@Index} erstellt. Um den |
| 2184 |
% schließenden Indexeintrag zu erzeugen, ist die Ausführung des Hauptargumentes |
| 2185 |
% der Deklarationsumgebung am Ende dieser notwendig. Dabei soll allerdings das |
| 2186 |
% Markup nicht noch ein weiteres Mal ausgegeben werden. Deshalb wird der |
| 2187 |
% Schalter hier genutzt, um lediglich zu Beginn einer Deklaration das Markup |
| 2188 |
% auszuführen. Dabei Angaben für eine |'|\meta{Referenzvariante}|'| nicht |
| 2189 |
% erlaubt. |
| 2190 |
% \begin{macrocode} |
| 2191 |
%<*class> |
| 2192 |
\if@tud@declare% |
| 2193 |
\if@openindex% |
| 2194 |
\IfValueT{#6}{% |
| 2195 |
\ClassWarning{tudscrmanual}{% |
| 2196 |
It is not possible to use any cross-reference\MessageBreak% |
| 2197 |
shorthand like '#6' within the arguments of\MessageBreak% |
| 2198 |
the environment `Declaration'% |
| 2199 |
}% |
| 2200 |
}% |
| 2201 |
% \end{macrocode} |
| 2202 |
% Für ein eventuell notwendiges Debugging, wird \cs{Process@@MarkupDeclare} mit |
| 2203 |
% seinen Argumenten ggf. in das Log-File geschrieben. |
| 2204 |
% \begin{macrocode} |
| 2205 |
\tud@trace@markup{declare}{\the\tud@toks@}% |
| 2206 |
\else% |
| 2207 |
\tud@toks@{\relax}% |
| 2208 |
\fi% |
| 2209 |
% \end{macrocode} |
| 2210 |
% Findet der Auszeichnungsbefehl außerhalb einer Umgebung für Deklarationen |
| 2211 |
% Verwendung, werden die optionalen Argumente für einen CTAN-Link |
| 2212 |
% |<|\meta{CTAN-Paketname}|>| sowie die Formatierung des Querverweise |
| 2213 |
% |'|\meta{Referenzvariante}|'| hinzugefügt~-- falls vorhanden. Dies geschieht |
| 2214 |
% jedoch nur, wenn das Markup nicht innerhalb eines Index erfolgt, da hier |
| 2215 |
% URL-Hyperlinks und formatierte Querverweise unerwünscht sind. Mit der Angabe |
| 2216 |
% eines leeren Argumentes |<>| wird gar kein Hyperlink erstellt. |
| 2217 |
% \begin{macrocode} |
| 2218 |
\else% |
| 2219 |
%</class> |
| 2220 |
\if@tud@index\else% |
| 2221 |
\IfValueT{#5}{% |
| 2222 |
\tud@if@strblank{#5}% |
| 2223 |
{}% |
| 2224 |
{\addto@hook\tud@toks@{<http://www.ctan.org/pkg/#5>}}% |
| 2225 |
}% |
| 2226 |
\IfValueT{#6}{\addto@hook\tud@toks@{'#6'}}% |
| 2227 |
\fi% |
| 2228 |
%<*class> |
| 2229 |
% \end{macrocode} |
| 2230 |
% Auch hier wird ggf. ein Debug-Eintrag ins Log-File geschrieben. |
| 2231 |
% \begin{macrocode} |
| 2232 |
\tud@trace@markup{output}{\the\tud@toks@}% |
| 2233 |
\fi% |
| 2234 |
% \end{macrocode} |
| 2235 |
% Ganz zum Schluss wird noch für beide Fälle geprüft, ob \parg{Bundleelement} |
| 2236 |
% angegeben wurde. Ist dies der Fall, wird zum einen das \meta{Bundleelement} |
| 2237 |
% zur Überprüfung ggf. in das Log-File geschrieben, zum anderen wird geprüft, |
| 2238 |
% ob für das \meta{Element} überhaupt ein Link definiert wurde, der verwendet |
| 2239 |
% werden soll. Ist dies nicht der Fall, wird eine Warnung ausgegeben. Dies ist |
| 2240 |
% möglich, da durch die automatische Labelgenerierung normalerweise alle nicht |
| 2241 |
% existierenden Labels mit \meta{Bundlepräfix} auf \cs{tud@bdl@dftl} verweisen |
| 2242 |
% müssten. Für die wenigen Fälle, in denen gezielt auf einen Querverweis |
| 2243 |
% verzichtet werden soll, kann ein leeres Argument \parg{} angegeben werden. |
| 2244 |
% \begin{macrocode} |
| 2245 |
\if@tud@index\else% |
| 2246 |
\IfValueT{#4}{% |
| 2247 |
\tud@if@strblank{#4}{}{% |
| 2248 |
\tud@trace@bdl@add{#4}% |
| 2249 |
\tud@if@strequal{#6}{none}{}{% |
| 2250 |
\tud@if@lbl@exists{\tud@lbl@tmp}{}{% |
| 2251 |
\ClassWarning{tudscrmanual}{% |
| 2252 |
No existing label \tud@lbl@tmp\space for #4% |
| 2253 |
}% |
| 2254 |
}% |
| 2255 |
}% |
| 2256 |
}% |
| 2257 |
}% |
| 2258 |
\fi% |
| 2259 |
% \end{macrocode} |
| 2260 |
% Nun erfolgt mit \cs{Process@@MarkupDeclare} bzw. \cs{Process@@MarkupInline} |
| 2261 |
% die Ausführung der eigentlichen Auszeichnung. |
| 2262 |
% \begin{macrocode} |
| 2263 |
%</class> |
| 2264 |
\the\tud@toks@% |
| 2265 |
} |
| 2266 |
% \end{macrocode} |
| 2267 |
% \end{macro}^^A \Markup@@Suppress |
| 2268 |
% \end{macro}^^A \Markup@Suppress |
| 2269 |
% \end{macro}^^A \Process@Markup |
| 2270 |
% \begin{macro}{\Process@@MarkupDeclare} |
| 2271 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2272 |
% Mit \cs{Process@@MarkupDeclare} wird die formatierte Ausgabe der Deklaration |
| 2273 |
% realisiert. Wie diese genau gestaltet ist, wird durch \cs{tud@declare@num} |
| 2274 |
% bestimmt. Folgende Werte sind möglich: |
| 2275 |
% \begin{description} |
| 2276 |
% \item[\val{0}:] Ausgabe von Markup, Erzeugen eines Labels |
| 2277 |
% \item[\val{1}:] Ausgabe von Markup, kein Label |
| 2278 |
% \item[\val{2}:] keine Ausgabe, aber Erzeugen eines Labels |
| 2279 |
% \item[\val{3}:] keine Ausgabe, Erzeugen eines nach oben verschobenen Labels |
| 2280 |
% \end{description} |
| 2281 |
% Normalerweise kommt die erste Variante zum Einsatz. Die zweite Variante wird |
| 2282 |
% genutzt, wenn mit mit der Umgebung \env{Obsolete} zwar eine Ausgabe aber kein |
| 2283 |
% Label erstellt werden soll. Dies wird verwendet, um bei der Beschreibung |
| 2284 |
% veralteter Werte oder Parameter diese im Kontext ihrer Option oder Umgebung |
| 2285 |
% bzw. ihres Befehls anzugeben. |
| 2286 |
% |
| 2287 |
% Die dritte Version kommt bei Erklärungen mit der Umgebung \env{Declaration*} |
| 2288 |
% zum Einsatz, welche im Fließtext verwendet wird und kein Markup, wohl aber |
| 2289 |
% eine Label für das beschriebene Element erzeugt werden soll. Für die vierte |
| 2290 |
% Variante, welche die Umgebung \env{Bundle*} betrifft, gilt dies im Prinzip |
| 2291 |
% gleichermaßen. Allerdings wird diese Umgebung zu Beginn der Deklarationen |
| 2292 |
% eines Bundleelements direkt nach einer Überschrift verwendet. Hier soll der |
| 2293 |
% erzeugte Link direkt auf der Höhe der Überschrift platziert werden. |
| 2294 |
% |
| 2295 |
% Das erste Argument enthält das zu definierende Label, gefolgt vom Element, |
| 2296 |
% welches ausgezeichnet werden soll. Die tatsächliche Ausgabe erfolgt mit dem |
| 2297 |
% Makro \cs{Markup@Output}. An dieses werden die beiden optionalen Argumente |
| 2298 |
% |=|\meta{Wert}|=| und \oarg{Ausgabesuffix} direkt weitergereicht. |
| 2299 |
% |
| 2300 |
% Vor der eigentlichen Ausführung wird mit \cs{Markup@CheckFormat} geprüft, ob |
| 2301 |
% für das auszuzeichnende Element mit \cs{Markup@SetFormat} überhaupt eine |
| 2302 |
% Ausgabeformatierung defineirt wurde. Nach der Ausgabe wird diese Formatierung |
| 2303 |
% mit \cs{Markup@ClearFormat} zurückgesetzt. |
| 2304 |
% \begin{macrocode} |
| 2305 |
%<*class> |
| 2306 |
\NewDocumentCommand\Process@@MarkupDeclare{mmd==o}{% |
| 2307 |
\Markup@CheckFormat% |
| 2308 |
\ifcase\tud@declare@num\relax% |
| 2309 |
\tudhyperdef{#1}% |
| 2310 |
\Markup@Output{#2}=#3=[#4]% |
| 2311 |
\or% |
| 2312 |
\Markup@Output{#2}=#3=[#4]% |
| 2313 |
\or% |
| 2314 |
\tudhyperdef{#1}% |
| 2315 |
\or% |
| 2316 |
\tudhyperdef*{#1}% |
| 2317 |
\def\@tempa##1:##2:##3\@nil{\tudhyperdef*{##3:##2:##3}}% |
| 2318 |
\@tempa#1\@nil% |
| 2319 |
\fi% |
| 2320 |
\Markup@ClearFormat% |
| 2321 |
} |
| 2322 |
%</class> |
| 2323 |
% \end{macrocode} |
| 2324 |
% \end{macro}^^A \Process@@MarkupDeclare |
| 2325 |
% \begin{macro}{\Process@@MarkupInline} |
| 2326 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2327 |
% Mit \cs{Process@@MarkupInline} wird die formatierte Ausgabe außerhalb der |
| 2328 |
% Deklarationsumgebungen umgesetzt. Die ersten vier Argument entsprechen denen |
| 2329 |
% des Befehls \cs{Process@@MarkupDeclare} und werden bis auf das Label ebenso an |
| 2330 |
% \cs{Markup@Output} übergeben, nachdem mit dem Befehl \cs{Markup@CheckFormat} |
| 2331 |
% auf eine existierende Markup-Definition geprüft wurde. |
| 2332 |
% \ToDo{% |
| 2333 |
% Hyperlinks auf erläuterte Element innerhalb der Umgenung \env{Declaration} |
| 2334 |
% unterbinden? Könnte \cs{tud@declaration@list} genutzt werden?% |
| 2335 |
% }[v2.07]% |
| 2336 |
% \begin{macrocode} |
| 2337 |
\NewDocumentCommand\Process@@MarkupInline{mmd==od<>d''}{% |
| 2338 |
\Markup@CheckFormat% |
| 2339 |
% \end{macrocode} |
| 2340 |
% Um die aktuelle Definition der temporären Makros nicht zu ändern, erfolgt die |
| 2341 |
% formatierte Ausgabe in einer Gruppe. Dabei wird in \cs{@tempc} die minimale |
| 2342 |
% Variante gesichert. |
| 2343 |
% \begin{macrocode} |
| 2344 |
\begingroup% |
| 2345 |
\def\@tempc{\Markup@Output{#2}=#3=[#4]}% |
| 2346 |
% \end{macrocode} |
| 2347 |
% Danach wird eine Fallunterscheidung anhand des im ersten Argument übergebenen |
| 2348 |
% Labels getroffen. Existiert dieses, soll das Element als Hyperlink ausgegeben |
| 2349 |
% werden. Die Definition dafür wird in \cs{@tempa} gespeichert. |
| 2350 |
% \begin{macrocode} |
| 2351 |
%<*class> |
| 2352 |
\tud@if@lbl@exists{#1}{% |
| 2353 |
\def\@tempa{\hyperref{}{\tud@manualname}{#1}{\@tempc}}% |
| 2354 |
% \end{macrocode} |
| 2355 |
% Anschließend wird \cs{@tempb} ggf. für den erweiterten Querverweis verwendet. |
| 2356 |
% Wurde ein Format für den Querverweis gesetzt, muss dieses validiert werden. |
| 2357 |
% Gültige Kürzel sind |'|\val{auto}|'|, |'|\val{page}|'| und |'|\val{full}|'|. |
| 2358 |
% Damit werden die erzeugten Querverweise um den Gliederungsabschnitt, die |
| 2359 |
% Seite oder beides ergänzt. Außerdem kann mit |'|\val{none}|'| der Hyperlink |
| 2360 |
% komplett unterbunden werden. Für den Befehl \cs{Package} kann mit zusätzlich |
| 2361 |
% |'|\val{url}|'| noch der CTAN-Link forciert werden, auch wenn eigentlich ein |
| 2362 |
% Label für das Paket existiert. |
| 2363 |
% \begin{macrocode} |
| 2364 |
\let\@tempb\relax% |
| 2365 |
\IfValueT{#6}{% |
| 2366 |
\def\@tempb{% |
| 2367 |
\ClassWarning{tudscrmanual}{% |
| 2368 |
You've used the unknown cross-reference\MessageBreak% |
| 2369 |
shorthand '#6'. Only 'auto', 'page' and 'full'\MessageBreak% |
| 2370 |
as well as 'none' \IfValueT{#5}{or 'url' }are valid% |
| 2371 |
}% |
| 2372 |
}% |
| 2373 |
\tud@if@strequal{#6}{auto} {\def\@tempb{ in \autoref{#1}}}{% |
| 2374 |
\tud@if@strequal{#6}{page} {\def\@tempb{ \vpageref{#1}}}{% |
| 2375 |
\tud@if@strequal{#6}{ppage}{\def\@tempb{ \reftextfaraway{#1}}}{% |
| 2376 |
\tud@if@strequal{#6}{full} {\def\@tempb{ in \fullref{#1}}}{% |
| 2377 |
\tud@if@strequal{#6}{none} {\let\@tempa\@tempc\let\@tempb\relax}{}}}}}% |
| 2378 |
\IfValueT{#5}{% |
| 2379 |
\tud@if@strequal{#6}{url}% |
| 2380 |
{\def\@tempa{\href{#5}{\@tempc}}\let\@tempb\relax}% |
| 2381 |
{}% |
| 2382 |
}% |
| 2383 |
}% |
| 2384 |
}{% |
| 2385 |
%</class> |
| 2386 |
% \end{macrocode} |
| 2387 |
% Existiert kein Label, so wird einfach die minimale Markup-Variante verwendet. |
| 2388 |
% Für Pakete wird ein CTAN-Link erzeugt. |
| 2389 |
% \begin{macrocode} |
| 2390 |
\let\@tempa\@tempc% |
| 2391 |
\IfValueT{#5}{\def\@tempa{\href{#5}{\@tempc}}}% |
| 2392 |
% \end{macrocode} |
| 2393 |
% Ein Querverweis kann logischerweise nicht erstellt werden. Wurde dennoch im |
| 2394 |
% letzten optionalen Argument eine |'|\meta{Referenzvariante}|'| für den |
| 2395 |
% Querverweis angegeben, wird eine Warnung erzeugt. |
| 2396 |
% \begin{macrocode} |
| 2397 |
\let\@tempb\relax% |
| 2398 |
\IfValueT{#6}{% |
| 2399 |
\tud@if@strequal{#6}{none}{\let\@tempa\@tempc}{% |
| 2400 |
%<*package> |
| 2401 |
\tud@if@strequal{#6}{manual}{\def\@tempa{\tudhyperref{#1}{\@tempc}}}{% |
| 2402 |
%</package> |
| 2403 |
\def\@tempb{% |
| 2404 |
%<*class> |
| 2405 |
\ClassWarning{tudscrmanual}% |
| 2406 |
%</class> |
| 2407 |
%<*package> |
| 2408 |
\PackageWarning{tudscrmanual}% |
| 2409 |
%</package> |
| 2410 |
{% |
| 2411 |
%<*class> |
| 2412 |
Label #1\MessageBreak% |
| 2413 |
is missing, no cross-reference created% |
| 2414 |
%</class> |
| 2415 |
%<*package> |
| 2416 |
You've used the unknown cross-reference\MessageBreak% |
| 2417 |
shorthand '#6'. Only 'none' and 'manual'\MessageBreak% |
| 2418 |
are valid% |
| 2419 |
%</package> |
| 2420 |
}% |
| 2421 |
}% |
| 2422 |
%<package> }% |
| 2423 |
}% |
| 2424 |
}% |
| 2425 |
% \end{macrocode} |
| 2426 |
% Um im Zweifel nach allen fehlenden Labels im Log-File prüfen zu können, gibt |
| 2427 |
% es den passenden Debug-Befehl. |
| 2428 |
% \begin{macrocode} |
| 2429 |
%<*class> |
| 2430 |
\tud@trace@lbl@missing@add{#1}% |
| 2431 |
}% |
| 2432 |
%</class> |
| 2433 |
% \end{macrocode} |
| 2434 |
% Ganz zum Schluss erfolgt die Ausgabe als Hyperlink mit optional erweitertem |
| 2435 |
% Querverweis nicht, wenn gerade eine Überschrift gesetzt wird. |
| 2436 |
% \begin{macrocode} |
| 2437 |
\ifdisposition{\@tempc}{\@tempa\@tempb}% |
| 2438 |
% \end{macrocode} |
| 2439 |
% Zum Schluss wird die Formatierung mit \cs{Markup@ClearFormat} zurückgesetzt. |
| 2440 |
% \begin{macrocode} |
| 2441 |
\endgroup% |
| 2442 |
\Markup@ClearFormat% |
| 2443 |
} |
| 2444 |
% \end{macrocode} |
| 2445 |
% \end{macro}^^A \Process@@MarkupInline |
| 2446 |
% \begin{macro}{\Markup@Output} |
| 2447 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2448 |
% \begin{macro}{\Markup@@Output} |
| 2449 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2450 |
% Der Befehl \cs{Markup@Output} wird für die formatierte Markup-Ausgabe von den |
| 2451 |
% beiden Makros \cs{Process@@MarkupDeclare} sowie \cs{Process@@MarkupInline} |
| 2452 |
% aufgerufen. Das erste Argument enthält dabei das auszuzeichnende Element. |
| 2453 |
% Dabei ist die Besonderheit des Makros \cs{Key}\marg{Makro}\marg{Parameter} zu |
| 2454 |
% beachten, dessen beiden Argumente hier in der Form \marg{Makro!Parameter} |
| 2455 |
% übergeben werden. Deshalb wird das erste Argument mit dem Argumentprozessor |
| 2456 |
% \cs{SplitArgument}|{1}{!}| getrennt und dann weiter verarbeitet. |
| 2457 |
% \begin{macrocode} |
| 2458 |
\NewDocumentCommand\Markup@Output{>{\SplitArgument{1}{!}}mr==r[]}{% |
| 2459 |
\Markup@@Output#1=#2=[#3]% |
| 2460 |
} |
| 2461 |
% \end{macrocode} |
| 2462 |
% Anschließend wird entweder \cs{Markup@Declare} oder \cs{Markup@Inline} |
| 2463 |
% aufgerufen~-- abermals abhängig vom Schalter \cs{if@tud@declare}. Auch hier |
| 2464 |
% wird für den Befehlsaufruf mit dem dazugehörigen Argument zur Vereinfachung |
| 2465 |
% ein Token-Register verwendet. |
| 2466 |
% \begin{macrocode} |
| 2467 |
\NewDocumentCommand\Markup@@Output{mmr==r[]}{% |
| 2468 |
%<*class> |
| 2469 |
\if@tud@declare% |
| 2470 |
\tud@toks@{\Markup@Declare}% |
| 2471 |
\else% |
| 2472 |
%</class> |
| 2473 |
\tud@toks@{\Markup@Inline}% |
| 2474 |
%<*class> |
| 2475 |
\fi% |
| 2476 |
%</class> |
| 2477 |
% \end{macrocode} |
| 2478 |
% Ist das aktuelle Element \cs{Key} wird nur das zweite Argument ausgegeben. |
| 2479 |
% Das erste wird lediglich für Label und Indexeintrag benötigt. |
| 2480 |
% \begin{macrocode} |
| 2481 |
\IfValueTF{#2}{% |
| 2482 |
\def\@tempa{#2}% |
| 2483 |
}{% |
| 2484 |
\def\@tempa{#1}% |
| 2485 |
}% |
| 2486 |
% \end{macrocode} |
| 2487 |
% Die beiden optionalen Argumente werden ggf. in der gleichen Formatierung |
| 2488 |
% ausgegeben. |
| 2489 |
% \begin{macrocode} |
| 2490 |
\IfValueT{#3}{\appto\@tempa{=#3}}% |
| 2491 |
\IfValueT{#4}{\appto\@tempa{#4}}% |
| 2492 |
\addto@hook@expandafter\tud@toks@{\expandafter{\@tempa}}% |
| 2493 |
\the\tud@toks@% |
| 2494 |
} |
| 2495 |
% \end{macrocode} |
| 2496 |
% \end{macro}^^A \Markup@@Output |
| 2497 |
% \end{macro}^^A \Markup@Output |
| 2498 |
% \begin{macro}{\Markup@Inline} |
| 2499 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2500 |
% \begin{macro}{\Markup@Declare} |
| 2501 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2502 |
% \begin{macro}{\Markup@@Declare} |
| 2503 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2504 |
% Die Ausgabe selbst ist alles andere als spektakulär. Die zur Formatierung |
| 2505 |
% verwendeten Makros \cs{Markup@Format} und \cs{Markup@Suffix} werden durch |
| 2506 |
% \cs{Markup@SetFormat} für jedes Markup-Element individuell definiert. |
| 2507 |
% \begin{macrocode} |
| 2508 |
\newcommand*\Markup@Inline[1]{\mbox{\Markup@Format{#1}}} |
| 2509 |
%<*class> |
| 2510 |
\newcommand*\Markup@Declare{} |
| 2511 |
\newcommand*\Markup@@Declare[1]{\Markup@Format{#1}\Markup@Suffix} |
| 2512 |
%</class> |
| 2513 |
% \end{macrocode} |
| 2514 |
% \end{macro}^^A \Markup@@Declare |
| 2515 |
% \end{macro}^^A \Markup@Declare |
| 2516 |
% \end{macro}^^A \Markup@Inline |
| 2517 |
% \begin{macro}{\Markup@SetFormat} |
| 2518 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2519 |
% \begin{macro}{\Markup@CheckFormat} |
| 2520 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2521 |
% \begin{macro}{\Markup@ClearFormat} |
| 2522 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2523 |
% \begin{macro}{\Markup@Format} |
| 2524 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2525 |
% \begin{macro}{\Markup@Suffix} |
| 2526 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2527 |
% Der Befehl \cs{Markup@SetFormat} setzt das gewünschte Format für die jeweilge |
| 2528 |
% Ausgabe. Dieses wird im ersten Argument angegeben. Das ordinäre optionale |
| 2529 |
% Argument kann genutzt werden, wenn bei der Deklaration noch eine genauere |
| 2530 |
% Beschreibung oder Spezifizierung erscheinen soll, beispielsweise etwas wie |
| 2531 |
% \enquote{Umgebung} oder \enquote{Parameter}. Mit dem optionalen Argument in |
| 2532 |
% runden Klammern wird es möglich, die Definition von \cs{Markup@Declare}, die |
| 2533 |
% ohne eine Angabe der von \cs{Markup@@Declare} entspricht, zu ändern. Dies |
| 2534 |
% wird insbesondere von \cs{Environment} genutzt, um bei der Deklaration eine |
| 2535 |
% Tabelle zu erzeugen. |
| 2536 |
% \begin{macrocode} |
| 2537 |
\newcommand*\Markup@Format{} |
| 2538 |
\undef\Markup@Format |
| 2539 |
\newcommand*\Markup@Suffix{} |
| 2540 |
\NewDocumentCommand\Markup@SetFormat{omod()}{% |
| 2541 |
\def\Markup@Format##1{\begingroup#2{\IfValueT{#1}{#1}##1}\endgroup}% |
| 2542 |
\IfValueT{#3}{\def\Markup@Suffix{\suffix{#3}}}% |
| 2543 |
%<*class> |
| 2544 |
\IfValueT{#4}{\renewcommand*\Markup@Declare[1]{#4\Markup@Suffix}}% |
| 2545 |
%</class> |
| 2546 |
} |
| 2547 |
% \end{macrocode} |
| 2548 |
% Nach der formatierten Ausgabe wird \cs{Markup@ClearFormat} aufgerufen, um die |
| 2549 |
% aktuell definierte Formatierung zurückzusetzen und bei einem neuen Aufruf |
| 2550 |
% eines der Markup-Befehle mit \cs{Markup@CheckFormat} auf die Verwendung von |
| 2551 |
% \cs{Markup@SetFormat} prüfen zu können. |
| 2552 |
% \begin{macrocode} |
| 2553 |
\newcommand*\Markup@ClearFormat{% |
| 2554 |
\undef\Markup@Format% |
| 2555 |
\let\Markup@Declare\Markup@@Declare% |
| 2556 |
\let\Markup@Suffix\relax% |
| 2557 |
} |
| 2558 |
\Markup@ClearFormat |
| 2559 |
\newcommand*\Markup@CheckFormat{% |
| 2560 |
\ifundef\Markup@Format{% |
| 2561 |
%<*class> |
| 2562 |
\ClassError{tudscrmanual}% |
| 2563 |
%</class> |
| 2564 |
%<*package> |
| 2565 |
\PackageError{tudscrmanual}% |
| 2566 |
%</package> |
| 2567 |
{\string\Markup@SetFormat\space unused}% |
| 2568 |
{It seems you have forgotten to use \string\Markup@SetFormat.}% |
| 2569 |
}{}% |
| 2570 |
} |
| 2571 |
% \end{macrocode} |
| 2572 |
% \end{macro}^^A \Markup@Suffix |
| 2573 |
% \end{macro}^^A \Markup@Format |
| 2574 |
% \end{macro}^^A \Markup@ClearFormat |
| 2575 |
% \end{macro}^^A \Markup@SetFormat |
| 2576 |
% \end{macro}^^A \Markup@CheckFormat |
| 2577 |
% |
| 2578 |
% \subsection{Index} |
| 2579 |
% |
| 2580 |
% Hier erscheint alles, was für Erstellen und Ausgabe der einzelnen Indexe |
| 2581 |
% notwendig ist. Hierfür wird das Paket \pkg{imakeidx} in Verbindung mit |
| 2582 |
% \app{texindy} verwendet. Diese können sowohl mit dem Paket als auch mit der |
| 2583 |
% Klasse erzeugt werden. |
| 2584 |
% \begin{macrocode} |
| 2585 |
\PassOptionsToPackage{xindy,splitindex}{imakeidx} |
| 2586 |
\RequirePackage{imakeidx} |
| 2587 |
% \end{macrocode} |
| 2588 |
% Zuerst ein paar kleinere Einstellungen für das Layout\dots |
| 2589 |
% \begin{macrocode} |
| 2590 |
\indexsetup{% |
| 2591 |
%<*class> |
| 2592 |
level=\addsec,% |
| 2593 |
%</class> |
| 2594 |
%<*package> |
| 2595 |
level=\subsection*,% |
| 2596 |
%</package> |
| 2597 |
noclearpage,firstpagestyle=headings,headers={\indexname}{\indexname},% |
| 2598 |
othercode={\renewcommand*\subitem{\@idxitem\hspace*{15\p@}}}% |
| 2599 |
} |
| 2600 |
% \end{macrocode} |
| 2601 |
% \begin{environment}{theindex} |
| 2602 |
% \dots gefolgt von einem Patch für die Umgebung \env{theindex}, um unschöne |
| 2603 |
% Seitenumbrüche direkt nach Überschriften zu vermeiden. Diese treten auf, das |
| 2604 |
% das Paket \pkg{imakeidx} meiner Meinung nach die Überschriften zusammen mit |
| 2605 |
% der \env{multicols}-Umgebung falsch setzt. Der Patch sorgt dafür, dass die |
| 2606 |
% Überschriften (\cs{imki@indexlevel}|{|\cs{indexname}|}|) nicht |
| 2607 |
% vor der Umgebung sondern~-- wie für \pkg{multicol} auch dokumentiert~-- im |
| 2608 |
% optionalen Argument von \env{multicols} aufgerufen werden. |
| 2609 |
% \begin{macrocode} |
| 2610 |
\ifimki@original\else% |
| 2611 |
\CheckCommand\theindex{% |
| 2612 |
\imki@maybeaddtotoc |
| 2613 |
\imki@indexlevel{\indexname}\imki@indexheaders |
| 2614 |
\thispagestyle{\imki@firstpagestyle}% |
| 2615 |
\ifnum\imki@columns>\@ne |
| 2616 |
\columnsep \imki@columnsep |
| 2617 |
\ifx\imki@idxprologue\relax |
| 2618 |
\begin{multicols}{\imki@columns} |
| 2619 |
\else |
| 2620 |
\begin{multicols}{\imki@columns}[\imki@idxprologue] |
| 2621 |
\fi |
| 2622 |
\else |
| 2623 |
\imki@idxprologue |
| 2624 |
\fi |
| 2625 |
\global\let\imki@idxprologue\relax |
| 2626 |
\parindent\z@ |
| 2627 |
\parskip\z@ \@plus .3\p@\relax |
| 2628 |
\columnseprule \ifKV@[email protected]\p@\else\z@\fi |
| 2629 |
\raggedright |
| 2630 |
\let\item\@idxitem |
| 2631 |
\imki@othercode% |
| 2632 |
}% |
| 2633 |
\patchcmd\theindex{% |
| 2634 |
\imki@indexlevel{\indexname}\imki@indexheaders% |
| 2635 |
}{% |
| 2636 |
\imki@indexheaders% |
| 2637 |
}{}{\tud@patch@wrn{theindex}}% |
| 2638 |
\patchcmd\theindex{% |
| 2639 |
\ifnum\imki@columns>\@ne |
| 2640 |
\columnsep \imki@columnsep |
| 2641 |
\ifx\imki@idxprologue\relax |
| 2642 |
\begin{multicols}{\imki@columns} |
| 2643 |
\else |
| 2644 |
\begin{multicols}{\imki@columns}[\imki@idxprologue] |
| 2645 |
\fi |
| 2646 |
\else |
| 2647 |
\imki@idxprologue |
| 2648 |
\fi |
| 2649 |
}{% |
| 2650 |
\ifnum\imki@columns>\@ne\relax% |
| 2651 |
\columnsep \imki@columnsep% |
| 2652 |
\ifx\imki@idxprologue\relax% |
| 2653 |
\begin{multicols}{\imki@columns}[\imki@indexlevel{\indexname}]% |
| 2654 |
\else% |
| 2655 |
\begin{multicols}{\imki@columns}[% |
| 2656 |
\imki@indexlevel{\indexname}% |
| 2657 |
\imki@idxprologue% |
| 2658 |
]% |
| 2659 |
\fi% |
| 2660 |
\else% |
| 2661 |
\imki@indexlevel{\indexname}\imki@idxprologue% |
| 2662 |
\fi% |
| 2663 |
}{}{\tud@patch@wrn{theindex}}% |
| 2664 |
\fi% |
| 2665 |
% \end{macrocode} |
| 2666 |
% \end{environment}^^A theindex |
| 2667 |
% \begin{macro}{\makexdyindex} |
| 2668 |
% \changes{v2.05}{2015/11/01}{neu}^^A |
| 2669 |
% Um die einzelnen Indexe erstellen zu können, wird das Makro \cs{makexdyindex} |
| 2670 |
% definiert. Die Sternversion dieses Befehle erstellt dabei neben dem normalen |
| 2671 |
% Spezialindex einen weiteren, welcher explizit für Deklarationen genutzt wird. |
| 2672 |
% Dieser wird anschließen als erstes an \app{texindy} weitergereicht, um die |
| 2673 |
% richtige Formatierung der einzelnen Einträge gewährleisten zu können. Erst |
| 2674 |
% danach wird die Datei mit den normalen Einträgen verarbeitet. Siehe hierzu |
| 2675 |
% auch \cs{Process@@Index}. |
| 2676 |
% \begin{macrocode} |
| 2677 |
\newcommand*\tud@xdy@settings{} |
| 2678 |
\edef\tud@xdy@settings{-M \@currname-ind.xdy -L german-din} |
| 2679 |
\NewDocumentCommand\makexdyindex{s o m !o}{% |
| 2680 |
\let\@tempb\@empty% |
| 2681 |
%<*class> |
| 2682 |
\IfBooleanT{#1}{% |
| 2683 |
\def\@tempc{\jobname-#4-declare.idx}% |
| 2684 |
\makeindex[name=#4-declare]% |
| 2685 |
\IfFileExists{\@tempc}{% |
| 2686 |
\edef\@tempb{-o \jobname-#4.ind \@tempc}% |
| 2687 |
}{% |
| 2688 |
\ClassWarning{tudscrmanual}{File \@tempc\space not found}% |
| 2689 |
}% |
| 2690 |
}% |
| 2691 |
%</class> |
| 2692 |
\ifundef{\inputencodingname}{}{% |
| 2693 |
\eappto\tud@xdy@settings{\space-C\space\inputencodingname}% |
| 2694 |
}% |
| 2695 |
\protected@edef\@tempa{% |
| 2696 |
title={#3},% |
| 2697 |
columnsep=\noexpand\f@size\noexpand\p@,% |
| 2698 |
\IfValueTF{#4}{% |
| 2699 |
name={#4},% |
| 2700 |
options={\tud@xdy@settings\space-t \jobname-#4.xlg \@tempb},% |
| 2701 |
}{% |
| 2702 |
options={\tud@xdy@settings\space-t \jobname.xlg},% |
| 2703 |
}% |
| 2704 |
\IfValueT{#2}{#2}% |
| 2705 |
}% |
| 2706 |
\expandafter\makeindex\expandafter[\@tempa]% |
| 2707 |
} |
| 2708 |
% \end{macrocode} |
| 2709 |
% \end{macro}^^A \makexdyindex |
| 2710 |
% Nun können mit \cs{makexdyindex} die einzelnen Indexe erstellt werden. |
| 2711 |
% \begin{macrocode} |
| 2712 |
\makexdyindex{Allgemeiner Index} |
| 2713 |
\makexdyindex*{Klassen- und Paketoptionen}[options] |
| 2714 |
\makexdyindex*{Befehle und Umgebungen mit zugeh\"origen Parametern}[macros] |
| 2715 |
%<*class> |
| 2716 |
\makexdyindex*{Sprachabh\"angige Bezeichner}[terms] |
| 2717 |
\makexdyindex*{Seitenstile, Schriftelemente und Farben}[elements] |
| 2718 |
%</class> |
| 2719 |
\makexdyindex{L\"angen und Z\"ahler}[misc] |
| 2720 |
\makexdyindex*{Klassen, Pakete und Dateien}[files] |
| 2721 |
%<*class> |
| 2722 |
\makexdyindex[columns=1]{\"Anderungsliste}[changelog] |
| 2723 |
%</class> |
| 2724 |
\undef\makexdyindex |
| 2725 |
% \end{macrocode} |
| 2726 |
% \begin{macro}{\if@tud@index} |
| 2727 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2728 |
% Dieser Schalter wird zwei unterschiedliche Aufgaben verwendet. Zum einen wird |
| 2729 |
% er bei der Ausgabe von Verzeichnissen auf \val{true} gesetzt, um das Setzen |
| 2730 |
% von Indexeinträgen durch Markup-Befehle in den Verzeichnissen selbst zu |
| 2731 |
% unterbinden. Weiterhin verhindert der aktivierte Schalter bei der Ausführung |
| 2732 |
% von \cs{Process@Markup} das Erstellen von erweiterten Querverweisen sowie das |
| 2733 |
% Setzen von CTAN-Links bei Paketen (\cs{Package}), was weder in Verzeichnissen |
| 2734 |
% noch im Index erwünscht ist, weshalb vom Makro \cs{@printindex} ebenfalls |
| 2735 |
% \cs{@tud@indextrue} gesetzt wird. |
| 2736 |
% \begin{macrocode} |
| 2737 |
\tud@newif\if@tud@index |
| 2738 |
\addtoeachtocfile{\protect\@tud@indextrue} |
| 2739 |
% \end{macrocode} |
| 2740 |
% \end{macro}^^A \if@tud@index |
| 2741 |
% |
| 2742 |
% \subsubsection{Formatierung von Indexeinträgen} |
| 2743 |
% |
| 2744 |
% \begin{macro}{\tud@idx@get} |
| 2745 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2746 |
% \begin{macro}{\tud@idx@key} |
| 2747 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2748 |
% \begin{macro}{\tud@idx@fmt} |
| 2749 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2750 |
% \begin{macro}{\tud@idx@val} |
| 2751 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2752 |
% \begin{macro}{\tud@idx@bdl} |
| 2753 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 2754 |
% Mit dem Makro \cs{tud@idx@get} wird die Formatierung eines Indexeintrags für |
| 2755 |
% einen Markup-Befehl realisiert. Für das Sortieren der Indexeinträge kommt |
| 2756 |
% \app{texindy} zum Einsatz. Um die Indexeinträge wie gewünscht zu Formatieren, |
| 2757 |
% gibt es zwei Möglichkeit. |
| 2758 |
% |
| 2759 |
% Bei der ersten Variante würde der Indexeintrag einfach direkt mit den |
| 2760 |
% Markup-Befehlen erstellt und in der \app{texindy}-Stildatei wird für alle |
| 2761 |
% Auszeichnungsbefehle die passende |merge-rule| erstellt, um die korrekte |
| 2762 |
% Sortierung zu gewährleisten. Tatsächlich war in einer früheren Version genau |
| 2763 |
% das der Ansatz. Allerdings werden die manuell erstellten RegExp-Regeln durch |
| 2764 |
% \hrfn{http://sourceforge.net/p/xindy/bugs/22/}{\app{texindy} nicht korrekt} |
| 2765 |
% genutzt werden, weshalb der Ansatz verworfen wurde. |
| 2766 |
% |
| 2767 |
% Damit das Sortieren verlässlich funktioniert, werden die Einträge für den |
| 2768 |
% Index deshalb in der gewohnten Syntax von \app{makeindex} in der Form |
| 2769 |
% \meta{Schlüsselwort}|@|\meta{Markup} erstellt. Diese Syntax kann auch mit |
| 2770 |
% \app{texindy} genutzt werden. |
| 2771 |
% |
| 2772 |
% An \cs{tud@idx@get} werden vier obligatorische gefolgt von vier optionalen |
| 2773 |
% Argumenten übergeben. Die ersten beiden Argumente sind die Makros, in welche |
| 2774 |
% \meta{Schlüsselwort}~-- für gewöhnlich \cs{tud@idx@key}~-- sowie die |
| 2775 |
% Formatierung \meta{Markup}~-- normalerweise \cs{tud@idx@fmt}~-- expandiert |
| 2776 |
% werden. Mit dem Makro im dritten Argument wird es möglich, Untereinträge zu |
| 2777 |
% einem \meta{Schlüsselwort} für beispielsweise Parameter von Umgebungen oder |
| 2778 |
% Befehlen (\cs{Key}) sowie spezielle Schlüsselwerte von Optionen zu erzeugen. |
| 2779 |
% Dabei wird vor der Erstellung des Untereintrages der direkt zuvor generierte |
| 2780 |
% Indexhaupteintrag ins dritte Argument~-- normalerweise \cs{tud@idx@val}~-- |
| 2781 |
% gesichert. Das vierte und letzte obligatorische Argument enthält schließlich |
| 2782 |
% den eigentlichen Markup-Befehl, für welchen der Indexeintrag erzeugt werden |
| 2783 |
% soll. |
| 2784 |
% |
| 2785 |
% Daran schließen sich vier optionale Argumente an, mit denen die Formatierung |
| 2786 |
% des Indexeintrags differenziert werden kann. Das erste optionale Argument |
| 2787 |
% |=|\meta{Wert}|=| kann wie bereits gewohnt für das Hinzufügen eines |
| 2788 |
% Schlüsselwertes genutzt werden. Das zweite, ordinäre optionale Argument |
| 2789 |
% \oarg{Anmerkung} fügt dem Eintrag in den Index eine zusätzliche Anmerkung |
| 2790 |
% hinzu. Soll der Indexeintrag für ein spezifisches Paket oder eine Klasse aus |
| 2791 |
% dem \TUDScript-Bundle erstellt werden, wird das optionale Argument in runden |
| 2792 |
% Klammern \parg{\string\Class\marg{Klasse}/\string\Package\marg{Paket}} für |
| 2793 |
% einen Verweis auf das \parg{Bundleelement} verwendet, der in \cs{@idxbundle} |
| 2794 |
% gespeichert wird. Das Argument \verb+|+\meta{Indexmarkup}\verb+|+ wird bei |
| 2795 |
% Deklarationen zur Unterdrückung von Untereinträgen verwendet. |
| 2796 |
% Der vollständige Funktionsaufruf lautet: |
| 2797 |
% \newline\begingroup\scriptsize |
| 2798 |
% \cs{tud@idx@get}\cs{tud@idx@key}\cs{tud@idx@fmt}\ignorespaces% |
| 2799 |
% \cs{tud@idx@val}\marg{Elem.}|=|\meta{Wert}|=|\oarg{Anm.}\ignorespaces% |
| 2800 |
% \parg{Bundleelem.}\verb+|+\meta{Indexmark.}\verb+|+\ignorespaces% |
| 2801 |
% \endgroup |
| 2802 |
% \begin{macrocode} |
| 2803 |
\newcommand*\tud@idx@key{} |
| 2804 |
\newcommand*\tud@idx@fmt{} |
| 2805 |
\newcommand*\tud@idx@val{} |
| 2806 |
\newcommand*\tud@idx@bdl{} |
| 2807 |
\NewDocumentCommand\tud@idx@get{smmmmr==r[]r()d||}{% |
| 2808 |
% \end{macrocode} |
| 2809 |
% Die Änderungen an allerhand temporären Makros sollen lokal bleibens. |
| 2810 |
% \begin{macrocode} |
| 2811 |
\begingroup% |
| 2812 |
% \end{macrocode} |
| 2813 |
% In einer weiteren Gruppe wird der Markup-Befehl des vierten obligatorischen |
| 2814 |
% Arguments ausgewertet. Es wird eine Fallunterschiedung durchgeführt, ob es |
| 2815 |
% sich dabei um einen Parameter (\cs{Key}) handelt oder nicht. Ist dies der |
| 2816 |
% Fall, wird für diesen Parameter der hier nachfolgend formatierte Indexeintrag |
| 2817 |
% als Untereintrag verwendet. Dafür wird zuvor ein Haupteintrag aus dem ersten |
| 2818 |
% Argument von \cs{Key} generiert und in das dritte obligatorische Argument |
| 2819 |
% gespeichert (\cs{tud@idx@val}). |
| 2820 |
% \begin{macrocode} |
| 2821 |
\begingroup% |
| 2822 |
%<*class> |
| 2823 |
\let#4\@empty% |
| 2824 |
\in@{\Key}{#5}% |
| 2825 |
% \end{macrocode} |
| 2826 |
% Um den Haupteintrag zu extrahieren, wird mit \cs{Markup@Suppress} die Ausgabe |
| 2827 |
% des Markups deaktiviert und das erste Argument von \cs{Key} ausgeführt. Dies |
| 2828 |
% führt über \cs{Process@Index} zum rekursiven Aufruf von \cs{tud@idx@get}. Als |
| 2829 |
% Ergebnis sind im zweiten und dritten Argument~-- sprich in \cs{tud@idx@key} |
| 2830 |
% und \cs{tud@idx@fmt}~-- \meta{Markup} und \meta{Schlüsselwort} für den |
| 2831 |
% Elterneintrag enthalten. Diese werden in das vierte Argument (\cs{idxentry}) |
| 2832 |
% gespeichert. |
| 2833 |
% \begin{macrocode} |
| 2834 |
\ifin@% |
| 2835 |
\Markup@Suppress% |
| 2836 |
\let\Key\@firstoftwo% |
| 2837 |
#5% |
| 2838 |
% \end{macrocode} |
| 2839 |
% Da der Inhalt des vierten Arguments am Ende der Gruppe expandiert wird, wird |
| 2840 |
% mit \cs{expandonce} dafür gesorgt, dass die Expansion nur einmalig erfolgt. |
| 2841 |
% Zu beachten ist außerdem, dass der Hauptindexeintrag bereits in der Form |
| 2842 |
% \meta{Schlüsselwort}|@|\meta{Markup}|!| zusammengefügt wird. Die Sternversion |
| 2843 |
% wird für die Änderungsnotizen verwendet. Für diese wird eine kleine Anmerkung |
| 2844 |
% im Haupteintrag ergänzt. |
| 2845 |
% \begin{macrocode} |
| 2846 |
\let\@tempa\@empty% |
| 2847 |
\IfBooleanT{#1}{\def\@tempa{: Parameter angepasst}}% |
| 2848 |
\def#4{% |
| 2849 |
\expandonce#2\expandonce\@tempa{}@% |
| 2850 |
\expandonce#3\expandonce\@tempa{}!% |
| 2851 |
}% |
| 2852 |
\fi% |
| 2853 |
%</class> |
| 2854 |
% \end{macrocode} |
| 2855 |
% Nachdem ein möglicher Haupteintrag für Parameter erzeugt wurde, folgt nun |
| 2856 |
% der formatierte Indexeintrag für das aktuelle Markup-Element. Um diesen zu |
| 2857 |
% erstellen, wird für \meta{Schlüsselwort} zunächst nur der Inhalt des |
| 2858 |
% Hauptargumentes benötigt. Dieser wird hier in das zweite Argument |
| 2859 |
% expandiert, der ggf. erzeugte Haupteintrag in das vierte. Für \cs{Key} ist |
| 2860 |
% hier nur noch das zweite Argument relevant. |
| 2861 |
% \begin{macrocode} |
| 2862 |
\Markup@Gobble% |
| 2863 |
%<class> \let\Key\@secondoftwo% |
| 2864 |
\edef\tud@reserved{% |
| 2865 |
\noexpand\endgroup% |
| 2866 |
\def\noexpand#2{#5}% |
| 2867 |
%<class> \def\noexpand#4{#4}% |
| 2868 |
}% |
| 2869 |
\tud@reserved% |
| 2870 |
% \end{macrocode} |
| 2871 |
% Die Auszeichnung für den Indexeintrag besteht in erster Linie aus dem |
| 2872 |
% Markup-Befehl selbst. Damit ein |@|"~Zeichen beispielsweise in einem |
| 2873 |
% Makronamen korrekt verarbeitet wird, wird dieses im Stil von \app{makeindex} |
| 2874 |
% mit |"| maskiert. |
| 2875 |
% \begin{macrocode} |
| 2876 |
\def#3{#5}% |
| 2877 |
\tud@replace@@in#2{@}{"@}% |
| 2878 |
\tud@replace@@in#3{@}{"@}% |
| 2879 |
% \end{macrocode} |
| 2880 |
% In \cs{@idxbundle} wird ggf. das Paket oder die Klasse gespeichert, für die |
| 2881 |
% der aktuelle Eintrag erzeugt werden soll. Eine explizite Angabe wird in jedem |
| 2882 |
% Fall genutzt,\dots |
| 2883 |
% \begin{macrocode} |
| 2884 |
\let\tud@idx@bdl\tud@bdl@dflt% |
| 2885 |
\IfValueTF{#8}{% |
| 2886 |
\def\tud@idx@bdl{#8}% |
| 2887 |
}{% |
| 2888 |
% \end{macrocode} |
| 2889 |
% \dots eine implizite nur, wenn auch tatsächlich das passende Label existiert, |
| 2890 |
% da sonst mit Sicherheit falsche Einträge im Index erscheinen würden. |
| 2891 |
% \begin{macrocode} |
| 2892 |
%<*class> |
| 2893 |
\tud@if@bdl{% |
| 2894 |
\tud@if@lbl@exists{\tud@bdl@curr:#5}{% |
| 2895 |
\edef\tud@idx@bdl{\expandonce\tud@bdl@curr}% |
| 2896 |
% \end{macrocode} |
| 2897 |
% Sollte der Eintrag selbst dem Suffix für Paket oder Klasse entsprechen, wird |
| 2898 |
% dieser ignoriert. |
| 2899 |
% \begin{macrocode} |
| 2900 |
\def\tud@reserved{#5}% |
| 2901 |
\ifx\tud@reserved\tud@idx@bdl% |
| 2902 |
\let\tud@idx@bdl\tud@bdl@dflt% |
| 2903 |
\fi% |
| 2904 |
}{}% |
| 2905 |
}{}% |
| 2906 |
%</class> |
| 2907 |
}% |
| 2908 |
% \end{macrocode} |
| 2909 |
% Nachfolgend wird für den zu erzeugenden Indexeintrag die Zugehörigkeit des |
| 2910 |
% aktuellen Elements zu einem Paket oder einer Klasse aus dem \TUDScript-Bundle |
| 2911 |
% durch das Anhängen des jeweiligen \TUDScript-Bundle-Elements signalisiert. |
| 2912 |
% Dabei werden für die Anpassung von Schlüssel und Formatierung des Eintrags |
| 2913 |
% die temporären Makros \cs{@tempa}~(Schlüssel) und \cs{@tempb}~(Formatierung) |
| 2914 |
% gespeichert. In \cs{@tempc} wird der Inhalt von \cs{@tempb} zwischenzeitlich |
| 2915 |
% zur späteren Verwendung gesichert. |
| 2916 |
% \begin{macrocode} |
| 2917 |
\let\@tempa\@empty% |
| 2918 |
\let\@tempb\@empty% |
| 2919 |
\let\@tempc\@empty% |
| 2920 |
% \end{macrocode} |
| 2921 |
% Der temporäre Schalter \cs{@tempswa} wird genutzt, um das Hinzufügen der |
| 2922 |
% Ergänzungen zu steuern. Diese sollen nur für Elemente, welche nicht zu den |
| 2923 |
% Hauptklassen gehören, erfolgen. |
| 2924 |
% \begin{macrocode} |
| 2925 |
\@tempswatrue% |
| 2926 |
\ifx\tud@idx@bdl\tud@bdl@dflt% |
| 2927 |
\@tempswafalse% |
| 2928 |
% \end{macrocode} |
| 2929 |
% Ebenso werden die Anmerkungen für \cs{Key}-Elemente unterdrückt, da diese |
| 2930 |
% sowieso als Untereintrag erzeugt werden. Einträge in der Änderungsliste |
| 2931 |
% werden ohnehin separat für jedes \TUDScript-Bundle-Element ausgegeben. In |
| 2932 |
% jedem Fall ist jedoch Formatierung beim Markup für das Erzeugen des richtigen |
| 2933 |
% Querverweises notwendig und wird in \cs{@tempb} und \cs{@tempc} abgelegt. |
| 2934 |
% \begin{macrocode} |
| 2935 |
\else% |
| 2936 |
%<class> \in@{\Key}{#5}\ifin@\@tempswafalse\fi% |
| 2937 |
\IfBooleanT{#1}{\@tempswafalse}% |
| 2938 |
\edef\@tempb{(\expandonce\tud@idx@bdl)}% |
| 2939 |
\fi% |
| 2940 |
\let\@tempc\@tempb% |
| 2941 |
% \end{macrocode} |
| 2942 |
% Der Indexeintrag kann zur besseren Kenntnisnahme außerdem standardmäßig mit |
| 2943 |
% einer Beschreibung versehen werden. |
| 2944 |
% \begin{macrocode} |
| 2945 |
\IfValueT{#7}{% |
| 2946 |
\appto\@tempa{ #7}% |
| 2947 |
\appto\@tempb{\suffix{#7}}% |
| 2948 |
}% |
| 2949 |
% \end{macrocode} |
| 2950 |
% Wird die Anmerkung gesetzt, ist für den Schlüssel nur der Inhalt des in |
| 2951 |
% \cs{@idxbundle} gesicherten Markup-Befehls relevant. Dieser wird in der |
| 2952 |
% folgenden Gruppe extrahiert und \cs{@tempa} angehangen. Für die Formatierung |
| 2953 |
% bleibt das Markup erhalten und wird \cs{tempb} hinzugefügt. |
| 2954 |
% \begin{macrocode} |
| 2955 |
\if@tempswa% |
| 2956 |
\begingroup% |
| 2957 |
\Markup@Gobble% |
| 2958 |
\edef\tud@reserved{% |
| 2959 |
\noexpand\endgroup% |
| 2960 |
\noexpand\appto\noexpand\@tempa{ \tud@idx@bdl}% |
| 2961 |
}% |
| 2962 |
\tud@reserved% |
| 2963 |
\eappto\@tempb{\suffix{\expandonce\tud@idx@bdl}}% |
| 2964 |
\fi% |
| 2965 |
% \end{macrocode} |
| 2966 |
% Sollte mit |=|\meta{Wert}|=| ein spezieller Schlüsselwert angegeben worden |
| 2967 |
% sein, wird für diesen normalerweise ein separater Untereintrag erstellt. Der |
| 2968 |
% Schalter \cs{@tempswa} wird genutzt, um das Erzeugen dieses Untereintrages im |
| 2969 |
% Zweifel zu unterdrücken und diesen stattdessen als normalen Eintrag zu |
| 2970 |
% setzen. Dies ist zum einen bei Deklarationen und zum anderen in der |
| 2971 |
% Änderungsliste notwendig. Außerdem kann dies auch mit der Angabe von |
| 2972 |
% \val{default} als Indexargument erzwungen werden. |
| 2973 |
% \begin{macrocode} |
| 2974 |
\@tempswafalse% |
| 2975 |
\IfBooleanT{#1}{\@tempswatrue}% |
| 2976 |
\IfValueT{#9}{% |
| 2977 |
\tud@if@strequal{#9}{declare}{\@tempswatrue}{}% |
| 2978 |
\tud@if@strequal{#9}{default}{\@tempswatrue}{}% |
| 2979 |
}% |
| 2980 |
% \end{macrocode} |
| 2981 |
% In diesem Fall werden die Ergänzungen für Schlüssel und Formatierung ggf. um |
| 2982 |
% die speziellen Schlüsselwerte für das Element ergänzt. |
| 2983 |
% \begin{macrocode} |
| 2984 |
\if@tempswa% |
| 2985 |
\protected@eappto#2{\expandonce\@tempa}% |
| 2986 |
\tud@doifPValue{#6}{\noexpand\appto\noexpand#2{=#6}}% |
| 2987 |
\protected@eappto#3{\IfValueT{#6}{=#6=}\expandonce\@tempb}% |
| 2988 |
% \end{macrocode} |
| 2989 |
% Andernfalls wird geprüft, ob ein verwertbarer Schlüsselwert angegeben wurde. |
| 2990 |
% \begin{macrocode} |
| 2991 |
\else% |
| 2992 |
\tud@doifPValue{#6}{\noexpand\@tempswatrue}% |
| 2993 |
% \end{macrocode} |
| 2994 |
% Ist dies der Fall, wird aus den bisherigen Eingaben der Haupteintrag und |
| 2995 |
% daran anschließend der dazugehörige Untereintrag erstellt\dots |
| 2996 |
% \begin{macrocode} |
| 2997 |
\if@tempswa% |
| 2998 |
\eappto#4{% |
| 2999 |
\expandonce#2\expandonce\@tempa{}@% |
| 3000 |
\expandonce#3\expandonce\@tempb{}!% |
| 3001 |
}% |
| 3002 |
\appto#2{=#6}% |
| 3003 |
\appto#3{=#6=}% |
| 3004 |
\protected@eappto#3{\expandonce\@tempc}% |
| 3005 |
% \end{macrocode} |
| 3006 |
% \dots andernfalls bleibt es bei einem normalem Eintrag in den Index. |
| 3007 |
% \begin{macrocode} |
| 3008 |
\else% |
| 3009 |
\protected@eappto#2{\expandonce\@tempa}% |
| 3010 |
\protected@eappto#3{\expandonce\@tempb}% |
| 3011 |
\fi% |
| 3012 |
\fi% |
| 3013 |
% \end{macrocode} |
| 3014 |
% Die Erzeugung eines formatierten Indexeintrages ist beendet, das Resultat |
| 3015 |
% wird nach der letzten Gruppe definiert. |
| 3016 |
% \begin{macrocode} |
| 3017 |
\let\emph\@firstofone% |
| 3018 |
\protected@edef\tud@reserved{% |
| 3019 |
\noexpand\endgroup% |
| 3020 |
\def\noexpand#2{#2}% |
| 3021 |
\def\noexpand#3{#3}% |
| 3022 |
\def\noexpand#4{#4}% |
| 3023 |
}% |
| 3024 |
\tud@reserved% |
| 3025 |
} |
| 3026 |
% \end{macrocode} |
| 3027 |
% \end{macro}^^A \tud@idx@bdl |
| 3028 |
% \end{macro}^^A \tud@idx@val |
| 3029 |
% \end{macro}^^A \tud@idx@fmt |
| 3030 |
% \end{macro}^^A \tud@idx@key |
| 3031 |
% \end{macro}^^A \tud@idx@get |
| 3032 |
% \begin{macro}{\cleversee} |
| 3033 |
% \changes{v2.05}{2015/11/02}{neu}^^A |
| 3034 |
% \begin{macro}{\cleverseealso} |
| 3035 |
% \changes{v2.05}{2015/11/02}{neu}^^A |
| 3036 |
% \begin{macro}{\tud@cleversee} |
| 3037 |
% \changes{v2.05}{2015/11/02}{neu}^^A |
| 3038 |
% \changes{v2.05k}{2017/03/20}{neu}^^A |
| 3039 |
% Diese Befehle dienen zum smarten Setzen von Hinweisen im Index. Existiert |
| 3040 |
% lediglich dieser Hinweis im Index, wird dieser mit dem Präfix \cs{seename} |
| 3041 |
% ausgegeben. Sind jedoch für einen Indexeintrag auch Seitenzahlen vorhanden, |
| 3042 |
% so werden diese zuerst ausgegeben, danach folgt der Querverweis mit dem |
| 3043 |
% Präfix \cs{seealsoname}. Der Befehl \cs{cleverseealso} verwendet letzteren |
| 3044 |
% Präfix in jedem Fall. |
| 3045 |
% \begin{macrocode} |
| 3046 |
\newrobustcmd*\cleversee{\tud@cleversee{\seename}} |
| 3047 |
\newrobustcmd*\cleverseealso{% |
| 3048 |
%<*class> |
| 3049 |
\ClassWarning{tudscrmanual}% |
| 3050 |
%</class> |
| 3051 |
%<*package> |
| 3052 |
\PackageWarning{tudscrmanual}% |
| 3053 |
%</package> |
| 3054 |
{You should use `|see' instead of `|seealso'}% |
| 3055 |
\tud@cleversee{\alsoname}% |
| 3056 |
} |
| 3057 |
% \end{macrocode} |
| 3058 |
% Diese Makro übernimmt die eigentliche Arbeit. Es ist darauf angewiesen, dass |
| 3059 |
% die angegebene Seitenzahlen eines Indexeintrages erst \emph{nach} den |
| 3060 |
% Hinweisen ausgegeben und mit \cs{relax} abgeschlossen werden. Dies wird mit |
| 3061 |
% der später definierten Stildatei für \app{texindy} sichergestellt. So wird es |
| 3062 |
% möglich, dass das Makro \cs{tud@cleversee} auf alles ihm bis \cs{relax} |
| 3063 |
% nachfolgende parsen kann und abhängig davon die Ausgabe gestaltet. Das zweite |
| 3064 |
% obligatorische Argument beinhaltet dabei den Querverweis, das dritte Argument |
| 3065 |
% ist alles nachfolgende bis \cs{relax}. |
| 3066 |
% \begin{macrocode} |
| 3067 |
\newcommand*\tud@cleversee{} |
| 3068 |
\def\tud@cleversee#1#2\relax{% |
| 3069 |
\begingroup% |
| 3070 |
\let\cleversee\@empty% |
| 3071 |
\let\cleverseealso\@empty% |
| 3072 |
\let\tud@res@a\@empty% |
| 3073 |
\def\tud@res@b{#2}% |
| 3074 |
\def\tud@res@c##1\\##2\@nil{% |
| 3075 |
\appto\tud@res@a{##1}% |
| 3076 |
\def\tud@res@b{##2}% |
| 3077 |
\trim@spaces@in\tud@res@b% |
| 3078 |
\in@{\\}{##2}% |
| 3079 |
}% |
| 3080 |
\in@true% |
| 3081 |
\@whilesw\ifin@\fi{% |
| 3082 |
\expandafter\tud@res@c\tud@res@b\@nil% |
| 3083 |
}% |
| 3084 |
\ifx\tud@res@b\@empty% |
| 3085 |
\mbox{\emph{#1}}% |
| 3086 |
\else% |
| 3087 |
\def\tud@res@c##1 ##2\@nil{% |
| 3088 |
##2##1\space\mbox{\emph{\alsoname}}% |
| 3089 |
}% |
| 3090 |
\expandafter\tud@res@c\tud@res@b\@nil% |
| 3091 |
\fi% |
| 3092 |
\space\tud@res@a% |
| 3093 |
\endgroup% |
| 3094 |
} |
| 3095 |
% \end{macrocode} |
| 3096 |
% \end{macro}^^A \tud@cleversee |
| 3097 |
% \end{macro}^^A \cleverseealso |
| 3098 |
% \end{macro}^^A \cleversee |
| 3099 |
% \begin{macro}{\seesep} |
| 3100 |
% \changes{v2.06o}{2022/08/03}{neu}^^A |
| 3101 |
% \begin{macro}{\seeref} |
| 3102 |
% \changes{v2.05}{2015/11/02}{neu}^^A |
| 3103 |
% \begin{macro}{\seeidx} |
| 3104 |
% Der Befehl \cs{seeref} kann anstelle von \cs{see} bzw. in der Sternversion |
| 3105 |
% statt \cs{alsosee} genutzt werden. Das Makro \cs{seeidx} verweist auf die |
| 3106 |
% Seite eines Indexes. |
| 3107 |
% \begin{macrocode} |
| 3108 |
\newrobustcmd*\seesep{\txb}% |
| 3109 |
\NewDocumentCommand\seeref{s m}{% |
| 3110 |
\emph{\IfBooleanTF{#1}{\alsoname}{\seename}}\space#2% |
| 3111 |
} |
| 3112 |
%<*class> |
| 3113 |
\newrobustcmd*\seeidx[2]{\pageref{idx:#1}} |
| 3114 |
%</class> |
| 3115 |
% \end{macrocode} |
| 3116 |
% \end{macro}^^A \seeidx |
| 3117 |
% \end{macro}^^A \seeref |
| 3118 |
% \end{macro}^^A \seesep |
| 3119 |
% |
| 3120 |
% \subsubsection{Erstellen von Indexeinträgen} |
| 3121 |
% |
| 3122 |
% \begin{macro}{\Process@Index} |
| 3123 |
% \changes{v2.05}{2015/11/15}{neu}^^A |
| 3124 |
% \begin{macro}{\Process@@Index} |
| 3125 |
% \changes{v2.05}{2015/11/15}{neu}^^A |
| 3126 |
% Mit \cs{Process@Index} wird geprüft, ob mit dem im zweiten obligatorischen |
| 3127 |
% Argument enthaltenen Markup-Befehl ein Indexeintrag erzeugt werden soll. |
| 3128 |
% Ein Indexeintrag kann mit der Sternversion eines Markup-Befehls explizit |
| 3129 |
% unterdrückt werden, wobei der boolesche Wert im ersten obligatorischen |
| 3130 |
% Argument an \cs{Process@Index} zu Prüfung übergeben wird. Außerdem wird für |
| 3131 |
% obsolete Deklarationen ebenso wie bei aktiviertem Schalter \cs{if@tud@index} |
| 3132 |
% kein Eintrag erstellt. In allen genannten Fällen passiert beim Aufruf von |
| 3133 |
% \cs{Process@Index} nichts, andernfalls wird \cs{Process@@Index} ausgeführt. |
| 3134 |
% |
| 3135 |
% Die auf die zwei obligatorischen Argumente folgenden optionalen sind in der |
| 3136 |
% Nomenklatur identisch zu den bisherigen Erläuterungen, der vollständige |
| 3137 |
% Funktionsaufruf lautet: |
| 3138 |
% \newline\begingroup\scriptsize |
| 3139 |
% \cs{Process@Index}\marg{Stern?}\marg{Element}\ignorespaces% |
| 3140 |
% |=|\meta{Wert}|=|\oarg{Anmerkung}\parg{Bundleelement}\ignorespaces% |
| 3141 |
% \verb+|+\meta{Indexmarkup}\verb+|+\ignorespaces% |
| 3142 |
% \endgroup |
| 3143 |
% \begin{macrocode} |
| 3144 |
\NewDocumentCommand\Process@Index{mmd==od()d||}{% |
| 3145 |
\ifboolexpr{% |
| 3146 |
%<class> bool {@tud@index} or bool {@tud@obsolete}% |
| 3147 |
%<package> bool {@tud@index}% |
| 3148 |
}{}{% |
| 3149 |
\IfBooleanTF{#1}{% |
| 3150 |
\IfValueT{#6}{% |
| 3151 |
%<*class> |
| 3152 |
\ClassWarning{tudscrmanual}% |
| 3153 |
%</class> |
| 3154 |
%<*package> |
| 3155 |
\PackageWarning{tudscrmanual}% |
| 3156 |
%</package> |
| 3157 |
{% |
| 3158 |
You've used the starred version. No index entry\MessageBreak% |
| 3159 |
for #2 is created. The\MessageBreak% |
| 3160 |
optional argument |#6| will be ignored% |
| 3161 |
}% |
| 3162 |
}% |
| 3163 |
}{% |
| 3164 |
\Process@@Index{#2}=#3=[#4](#5)|#6|% |
| 3165 |
}% |
| 3166 |
}% |
| 3167 |
} |
| 3168 |
% \end{macrocode} |
| 3169 |
% Mit \cs{Process@@Index} erfolgt die eigentliche Erzeugung des Indexeintrages. |
| 3170 |
% \begin{macrocode} |
| 3171 |
\NewDocumentCommand\Process@@Index{mr==r[]r()r||}{% |
| 3172 |
% \end{macrocode} |
| 3173 |
% Dabei erledigt \cs{tud@idx@get} einen Großteil der Aufgabe. Mit besagtem |
| 3174 |
% Makro werden Schlüssel und Format für den gewünschten Indexeintrag erzeugt. |
| 3175 |
% Sollte optional ein spezieller |=|\meta{Wert}|=| für einen Schlüssel gegeben |
| 3176 |
% sein, so wird ggf. auch der passende Haupteintrag erstellt. |
| 3177 |
% \begin{macrocode} |
| 3178 |
%<*class> |
| 3179 |
\if@tud@declare% |
| 3180 |
\tud@idx@get\tud@idx@key\tud@idx@fmt\tud@idx@val{#1}=#2=[#3](#4)|declare|% |
| 3181 |
\else% |
| 3182 |
%</class> |
| 3183 |
\tud@idx@get\tud@idx@key\tud@idx@fmt\tud@idx@val{#1}=#2=[#3](#4)|#5|% |
| 3184 |
%<*class> |
| 3185 |
\fi% |
| 3186 |
%</class> |
| 3187 |
% \end{macrocode} |
| 3188 |
% Mit der Sternversion \cs{tud@attr@get*} wird der Zielindex für das im |
| 3189 |
% ersten Argument übergebene \marg{Element} ermittelt. |
| 3190 |
% \begin{macrocode} |
| 3191 |
\tud@attr@get*\tud@lbl@tmp{#1}% |
| 3192 |
% \end{macrocode} |
| 3193 |
% Markup-Befehle, welche in Deklarationen verwendet wurden, werden für eine |
| 3194 |
% höhere Priorisierung in einem speziellen Index angelegt, wobei hier die |
| 3195 |
% Formatierung dieses Eintrags fest vorgegeben ist. |
| 3196 |
% \begin{macrocode} |
| 3197 |
%<*class> |
| 3198 |
\if@tud@declare% |
| 3199 |
\if@openindex% |
| 3200 |
\IfValueT{#5}{% |
| 3201 |
\ClassWarning{tudscrmanual}{% |
| 3202 |
It is not possible to use any indexing format\MessageBreak% |
| 3203 |
like |#5| within the arguments of the\MessageBreak% |
| 3204 |
environments `Declaration' or `Declaration*'% |
| 3205 |
}% |
| 3206 |
}% |
| 3207 |
% \end{macrocode} |
| 3208 |
% Jetzt folgt~-- abhängig vom Schalter \cs{if@openindex}~-- der öffnende oder |
| 3209 |
% schließende Indexeintrag der Deklaration. Für den schließenden ist dabei eine |
| 3210 |
% Formatierung des Schlüssels nicht notwendig. |
| 3211 |
% \begin{macrocode} |
| 3212 |
\index[\tud@lbl@tmp-declare]{% |
| 3213 |
\tud@idx@val\tud@idx@key{}@\tud@idx@fmt|(declare% |
| 3214 |
}% |
| 3215 |
\else% |
| 3216 |
\index[\tud@lbl@tmp-declare]{\tud@idx@val\tud@idx@key|declare)}% |
| 3217 |
\fi% |
| 3218 |
% \end{macrocode} |
| 3219 |
% Für Markup-Befehle außerhalb von Deklarationsumgebungen wird ein einfacher |
| 3220 |
% Eintrag in den Index erzeugt, wobei auch im Fließtext über das Indexmarkup |
| 3221 |
% \verb+|+\val{declare}\verb+|+ eine Quasi-Deklaration verwendet werden kann. |
| 3222 |
% Dies wird beispielsweise für \KOMAScript-Optionen genutzt, um diese in der |
| 3223 |
% gewünschten Formatierung im Index erscheinen zu lassen. |
| 3224 |
% \begin{macrocode} |
| 3225 |
\else% |
| 3226 |
%</class> |
| 3227 |
\IfValueT{#5}{% |
| 3228 |
%<*class> |
| 3229 |
\tud@if@strequal{#5}{declare}{% |
| 3230 |
\appto\tud@lbl@tmp{-declare}% |
| 3231 |
\appto\tud@idx@fmt{|declare}% |
| 3232 |
}{% |
| 3233 |
\appto\tud@idx@fmt{|#5}% |
| 3234 |
}% |
| 3235 |
%</class> |
| 3236 |
%<*package> |
| 3237 |
\appto\tud@idx@fmt{|#5}% |
| 3238 |
%</package> |
| 3239 |
}% |
| 3240 |
\index[\tud@lbl@tmp]{\tud@idx@val\tud@idx@key{}@\tud@idx@fmt}% |
| 3241 |
%<*class> |
| 3242 |
\fi% |
| 3243 |
%</class> |
| 3244 |
} |
| 3245 |
% \end{macrocode} |
| 3246 |
% \end{macro}^^A \Process@@Index |
| 3247 |
% \end{macro}^^A \Process@Index |
| 3248 |
% |
| 3249 |
% \iffalse |
| 3250 |
%<*class> |
| 3251 |
% \fi |
| 3252 |
% |
| 3253 |
% \begin{macro}{\CrossIndex} |
| 3254 |
% Der Befehl \cs{CrossIndex} dient zum Eintragen eines Schlagwortes, welches im |
| 3255 |
% ersten obligatorischen Argument angegeben wird, in den allgemeinen Index und |
| 3256 |
% verweist auf den im zweiten obligatorischen Argument, zum Schlagwort gehörigen |
| 3257 |
% Spezialindex. Das ordinäre optionale Argument kann verwendet werden, um ggf. |
| 3258 |
% den Eintrag in den allgemeinen Index, der normalerweise mit dem jeweiligen |
| 3259 |
% Schlagwort erfolgt, zu überschrieben. |
| 3260 |
% |
| 3261 |
% Wird die Sternversion von \cs{CrossIndex} genutzt, so wird der Querverweis |
| 3262 |
% als Eintrag in der obersten Ebene gesetzt, andernfalls wird ein Untereintrag |
| 3263 |
% gesetzt. Mit der normalen Variante können so zu einem Schlagwort weitere |
| 3264 |
% Verweise im allgemeinen Index erscheinen. Das zweite obligatorische Argument |
| 3265 |
% kann eine kommagetrennte Liste enthalten. |
| 3266 |
% \begin{macrocode} |
| 3267 |
\NewDocumentCommand\CrossIndex{s m o m}{% |
| 3268 |
\def\@tempa##1##2##3{% |
| 3269 |
\index{% |
| 3270 |
\IfBooleanTF{#1}{##3@##3}{##3!"|@}% |
| 3271 |
\,\textrightarrow\,% |
| 3272 |
\tudhyperref{idx:##2}{\IfValueTF{##1}{##1}{Index der ##3}}|seeidx{##2}% |
| 3273 |
}% |
| 3274 |
}% |
| 3275 |
\forcsvlist{\@tempa{#3}{#4}}{#2}% |
| 3276 |
} |
| 3277 |
% \end{macrocode} |
| 3278 |
% \end{macro}^^A \CrossIndex |
| 3279 |
% \begin{macro}{\SeeRef} |
| 3280 |
% \changes{v2.05}{2015/11/05}{neu}^^A |
| 3281 |
% Mit \cs{SeeRef} wird unter dem im ersten Argument gegebenen Schlagwort ein |
| 3282 |
% Indexuntereintrag erzeugt, der wiederum auf einen Indexeintrag des zweiten |
| 3283 |
% Argumentes verweist. Dabei kann im zweiten Argument ein normaler Begriff oder |
| 3284 |
% ein Markup-Befehl verwendet werden. Normalerweise wird für den Querverweis |
| 3285 |
% die Referenzklasse \verb+|see+ verwendet, die Sternversion des Befehls |
| 3286 |
% hingegen nutzt \verb+|seeunverified+, um auf eine Prüfung des verwiesenen |
| 3287 |
% Eintrags zu verzichten. |
| 3288 |
% \begin{macrocode} |
| 3289 |
\NewDocumentCommand\SeeRef{s m m}{% |
| 3290 |
\sbox\z@{% |
| 3291 |
\let\tud@idx@fmt\relax% |
| 3292 |
#3% |
| 3293 |
% \end{macrocode} |
| 3294 |
% Wurde im zweiten Argument ein Markup-Befehl angegeben, so wurde durch das |
| 3295 |
% Erstellen der Box das dazugehörige Indexformat in \cs{tud@idx@fmt} für den |
| 3296 |
% Eintrag erstellt. Andernfalls wurde die Definition von \cs{tud@idx@fmt} nicht |
| 3297 |
% geändert und das Argument wird nach der Box direkt in den Index eingetragen. |
| 3298 |
% \begin{macrocode} |
| 3299 |
\ifx\tud@idx@fmt\relax% |
| 3300 |
\gdef\tud@reserved{#3}% |
| 3301 |
\else% |
| 3302 |
\global\let\tud@reserved\tud@idx@fmt% |
| 3303 |
\fi% |
| 3304 |
}% |
| 3305 |
\IfBooleanTF{#1}{\def\tud@idx@fmt{seeunverified}}{\def\tud@idx@fmt{see}}% |
| 3306 |
\index{#2!#3|\tud@idx@fmt{\tud@reserved}}% |
| 3307 |
} |
| 3308 |
% \end{macrocode} |
| 3309 |
% \end{macro}^^A \SeeRef |
| 3310 |
% |
| 3311 |
% \iffalse |
| 3312 |
%</class> |
| 3313 |
% \fi |
| 3314 |
% |
| 3315 |
% \subsubsection{Indexausgabe} |
| 3316 |
% |
| 3317 |
% Dies sind alle Befehle, die zur Ausgabe der erzeugten Indexe benötigt werden. |
| 3318 |
% \begin{macro}{\PrintIndex} |
| 3319 |
% \changes{v2.02}{2014/08/20}{neu}^^A |
| 3320 |
% \begin{macro}{\tud@indexprologue} |
| 3321 |
% \changes{v2.02}{2014/08/20}{neu}^^A |
| 3322 |
% Mit \cs{PrintIndex} erfolgt die Ausgabe aller erstellten Indexe. Dabei wird |
| 3323 |
% für bestimmte Spezialindexe das Makro \cs{tud@indexprologue} neu gesetzt, um |
| 3324 |
% für diese vor der eigentlichen Ausgabe einige Anmerkungen machen zu können. |
| 3325 |
% Mit \cs{tud@indexprologue} kann der einleitende Teil für einen Index gesetzt |
| 3326 |
% werden. |
| 3327 |
% \begin{macrocode} |
| 3328 |
%<*class> |
| 3329 |
\newcommand*\tud@indexprologue{} |
| 3330 |
%</class> |
| 3331 |
\newcommand*\PrintIndex{% |
| 3332 |
\begingroup% |
| 3333 |
\providecommand*\lettergroup[1]{% |
| 3334 |
\par\textbf{\textsf{##1}}\par% |
| 3335 |
\nopagebreak% |
| 3336 |
}% |
| 3337 |
%<*class> |
| 3338 |
\renewcommand\tud@indexprologue{% |
| 3339 |
Die im Folgenden aufgelisteten Schlagworte sollen f\"ur den Umgang mit |
| 3340 |
\hologo{LaTeXe} im Allgemeinen sowie dem \TUDScript-Bundle im Speziellen |
| 3341 |
sowohl Antworten bei generellen Fragen liefern als auch L\"osungen f\"ur |
| 3342 |
typische Probleme bereitstellen. Falls ein gesuchter Begriff hier nicht |
| 3343 |
auftaucht oder trotz vorhandener Hinweise kein zufriedenstellendes |
| 3344 |
Ergebnis erzielt werden kann, sollte das \Forum* erster Anlaufpunkt sein, |
| 3345 |
um weitere Hilfe bei der Nutzung von \TUDScript zu erhalten.% |
| 3346 |
}% |
| 3347 |
%</class> |
| 3348 |
%<*package> |
| 3349 |
\begingroup% |
| 3350 |
\let\lettergroup\@gobble% |
| 3351 |
\let\indexspace\relax% |
| 3352 |
%</package> |
| 3353 |
\print@index% |
| 3354 |
%<*package> |
| 3355 |
\endgroup% |
| 3356 |
%</package> |
| 3357 |
%<*class> |
| 3358 |
\clearpage% |
| 3359 |
\renewcommand\tud@indexprologue{% |
| 3360 |
Dies ist der Index aller im Handbuch erl\"auterten sowie erw\"ahnten |
| 3361 |
Optionen, wobei bei den meisten auch Untereintr\"age mit Seitenangaben |
| 3362 |
f\"ur spezielle Wertzuweisungen existieren.% |
| 3363 |
}% |
| 3364 |
%</class> |
| 3365 |
\print@index[options]% |
| 3366 |
%<*class> |
| 3367 |
\renewcommand\tud@indexprologue{% |
| 3368 |
Dies ist die Auflistung aller im Handbuch erl\"auterten sowie erw\"ahnten |
| 3369 |
Befehle und Umgebungen. Bei einigen existieren auch Untereintr\"age f\"ur |
| 3370 |
Schl\"ussel-Wert-Parameter, welche im optionalen Argument der jeweiligen |
| 3371 |
Anweisung verwendet werden k\"onnen. In der dritten Unterebene sind |
| 3372 |
gegebenenfalls Seitenverweise f\"ur explizite Wertzuweisungen an diese |
| 3373 |
Parameter zu finden.% |
| 3374 |
}% |
| 3375 |
%</class> |
| 3376 |
\print@index[macros]% |
| 3377 |
%<*class> |
| 3378 |
\renewcommand\tud@indexprologue{% |
| 3379 |
Dies sind alle von \TUDScript definierten, sprachabh\"angigen Bezeichner. |
| 3380 |
Informationen zur Verwendung sowie den Anpassungsm\"oglichkeiten sind in |
| 3381 |
\autoref{sec:localization} zu finden.% |
| 3382 |
}% |
| 3383 |
\print@index[terms]% |
| 3384 |
\print@index[elements]% |
| 3385 |
%</class> |
| 3386 |
%<*package> |
| 3387 |
\begingroup% |
| 3388 |
\let\lettergroup\@gobble% |
| 3389 |
\let\indexspace\relax% |
| 3390 |
%</package> |
| 3391 |
\print@index[misc]% |
| 3392 |
%<*package> |
| 3393 |
\endgroup% |
| 3394 |
%</package> |
| 3395 |
\print@index[files]% |
| 3396 |
\endgroup% |
| 3397 |
} |
| 3398 |
% \end{macrocode} |
| 3399 |
% \end{macro}^^A \tud@indexprologue |
| 3400 |
% \end{macro}^^A \PrintIndex |
| 3401 |
% \begin{macro}{\print@index} |
| 3402 |
% \changes{v2.02}{2014/07/25}{neu}^^A |
| 3403 |
% \begin{macro}{\tud@idx@skip} |
| 3404 |
% \changes{v2.02}{2014/09/02}{neu}^^A |
| 3405 |
% Mit \cs{@printindex} erfolgt die Ausgabe der einzelnen Indexe. Dabei wird in |
| 3406 |
% der Klasse \cls{tudscrmanual} zuvor für jeden Index ein referenzierbares |
| 3407 |
% Label erstellt und ggf. der Prolog gesetzt. |
| 3408 |
% |
| 3409 |
% Aufgrund der Verwendung der \env{multicols}-Umgebung durch das Paket |
| 3410 |
% \pkg{imakeidx} werden normalerweise ohne einen Prolog zu große vertikale |
| 3411 |
% Abstände gesetzt. Dies wird mit \cs{tud@idx@skip} behoben. |
| 3412 |
% \begin{macrocode} |
| 3413 |
\newcommand*\tud@idx@skip{% |
| 3414 |
\ifnum\imki@columns>\@ne\relax\vspace{-\multicolsep}\fi% |
| 3415 |
} |
| 3416 |
\newcommand*\print@index[1][]{% |
| 3417 |
% \end{macrocode} |
| 3418 |
% Falls ein Seitenumbruch notwendig ist, sollte dieser vor dem Index und nicht |
| 3419 |
% unmittelbar nach dem Beginn erfolgen. |
| 3420 |
% \begin{macrocode} |
| 3421 |
\pagebreak[3]% |
| 3422 |
\@tud@indextrue% |
| 3423 |
%<*class> |
| 3424 |
% \end{macrocode} |
| 3425 |
% Das zu erstellende Label wird in \cs{tud@reserved} gespeichert. Dabei wird |
| 3426 |
% die Sternversion von \cs{tudhyperdef} genutzt, um das Label auf die Höhe der |
| 3427 |
% Überschrift zu setzen. |
| 3428 |
% \begin{macrocode} |
| 3429 |
\tud@if@strblank{#1}{% |
| 3430 |
\def\tud@reserved{\tudhyperdef*{idx:main}}% |
| 3431 |
}{% |
| 3432 |
\def\tud@reserved{\tudhyperdef*{idx:#1}}% |
| 3433 |
}% |
| 3434 |
% \end{macrocode} |
| 3435 |
% Ohne Prolog wird der fehlerhafte vertikale Abstand behoben. |
| 3436 |
% \begin{macrocode} |
| 3437 |
\ifx\tud@indexprologue\@empty% |
| 3438 |
\indexprologue[\tud@idx@skip]{\tud@reserved}% |
| 3439 |
% \end{macrocode} |
| 3440 |
% Mit Prolog wird der fehlerhafte vertikale Abstand nach diesem korrigiert. |
| 3441 |
% \begin{macrocode} |
| 3442 |
\else% |
| 3443 |
\indexprologue{% |
| 3444 |
\tud@reserved% |
| 3445 |
\tud@indexprologue% |
| 3446 |
\tud@idx@skip% |
| 3447 |
}% |
| 3448 |
\fi% |
| 3449 |
%</class> |
| 3450 |
% \end{macrocode} |
| 3451 |
% Fur das Paket \pkg{tudscrmanual} erfolgt eine einfache Ausgabe der Indexe. |
| 3452 |
% \begin{macrocode} |
| 3453 |
%<package> \indexprologue[\tud@idx@skip]{}% |
| 3454 |
% \end{macrocode} |
| 3455 |
% Die Ausgabe des gewünschten Index und des leeren des Prologs. |
| 3456 |
% \begin{macrocode} |
| 3457 |
\tud@if@strblank{#1}{\printindex}{\printindex[{#1}]}% |
| 3458 |
\ifnum\imki@columns>\@ne\relax\vspace{-\multicolsep}\fi% |
| 3459 |
%<class> \let\tud@indexprologue\@empty% |
| 3460 |
} |
| 3461 |
% \end{macrocode} |
| 3462 |
% \end{macro}^^A \tud@idx@skip |
| 3463 |
% \end{macro}^^A \print@index |
| 3464 |
% |
| 3465 |
% \iffalse |
| 3466 |
%<*class> |
| 3467 |
% \fi |
| 3468 |
% |
| 3469 |
% \subsection{Änderungsliste} |
| 3470 |
% |
| 3471 |
% Um dem Anwender einen schnellen Überblick zu Änderungen der aktuellen Version |
| 3472 |
% bereitstellen zu können, werden Befehle zur automatisierten Erzeugung einer |
| 3473 |
% solchen Liste definiert. Die Änderungsliste ist der Klasse \cls{tudscrmanual} |
| 3474 |
% vorbehalten. |
| 3475 |
% |
| 3476 |
% Änderungsnotizen lassen sich auf zwei unterschiedlichen Wegen generieren. |
| 3477 |
% Entweder über die Nutzung von \cs{ChangedAt} oder über das optionale Argument |
| 3478 |
% einer der Deklarationsumgebungen. Diese sind in der Form |
| 3479 |
% \meta{Versionsnummer}|:|\meta{Änderungsnotiz} anzugeben. Die alleinige Angabe |
| 3480 |
% der Versionsnummer ohne Änderungsnotiz ist ebenso möglich. |
| 3481 |
% |
| 3482 |
% Wird die Änderungsnotiz für ein bestimmtes Element wie eine Option oder ein |
| 3483 |
% Befehl erstellt, wie es bei den Deklarationsumgebungen implizit oder bei der |
| 3484 |
% Verwendung von \cs{ChangedAt} mit optionalem Argument geschieht, gibt es die |
| 3485 |
% zusätzliche Möglichkeit, einen Untereintrag zu erstellen. Dabei ist dieser |
| 3486 |
% nach Versionsnummer und vor Änderungsnotiz in folgender Form anzugeben: |
| 3487 |
% \meta{Versionsnummer}|!|\meta{Untereintrag}|:|\meta{Änderungsnotiz}. Der |
| 3488 |
% Untereintrag ist für die explizite Angabe eines Schlüssel-Wert-Paares gedacht. |
| 3489 |
% \begin{macro}{\if@tud@changedat} |
| 3490 |
% \begin{macro}{\Process@ChangedAt} |
| 3491 |
% \changes{v2.02}{2014/07/25}{erweitert}^^A |
| 3492 |
% \changes{v2.02}{2014/10/08}{Sternversion ergänzt}^^A |
| 3493 |
% Der Schalter \cs{if@tud@changedat} wird im weiteren Verlauf dazu verwendet, |
| 3494 |
% das Standardverhalten der einzelnen Markup-Befehle kurzeitig zu ändern und |
| 3495 |
% anstelle der Makros \cs{Process@Markup} und \cs{Process@Index} den Befehl |
| 3496 |
% \cs{Process@ChangedAt} auszuführen, mit welchem die Formatierung der Einträge |
| 3497 |
% der Änderungsliste erfolgt. |
| 3498 |
% \begin{macrocode} |
| 3499 |
\tud@newif\if@tud@changedat |
| 3500 |
% \end{macrocode} |
| 3501 |
% Die Formatierung der Änderungseinträge erfolgt~-- wie auch für den Index~-- |
| 3502 |
% mit dem Makro \cs{tud@idx@get}, wobei die Sternversion für die Identifikation |
| 3503 |
% als Änderungseintrag fungiert. Aufgerufen wird \cs{Process@ChangedAt} während |
| 3504 |
% der Erstellung der Änderungseinträge mit \cs{Changed@At@CreateEntry}. Der |
| 3505 |
% Aufruf des Makros erfolgt dabei in gewohnter Form mit einem obligatorischen |
| 3506 |
% gefolgt von drei optionalen Argumenten: |
| 3507 |
% \newline\begingroup\scriptsize |
| 3508 |
% \cs{Process@ChangedAt}\marg{Element}|=|\meta{Wert}|=|\ignorespaces% |
| 3509 |
% \oarg{Ausgabesuffix}\parg{Bundleelement}\ignorespaces% |
| 3510 |
% \endgroup |
| 3511 |
% \begin{macrocode} |
| 3512 |
\NewDocumentCommand\Process@ChangedAt{md==od()}{% |
| 3513 |
\tud@idx@get*\tud@idx@key\tud@idx@fmt\tud@idx@val{#1}=#2=[#3](#4)% |
| 3514 |
} |
| 3515 |
% \end{macrocode} |
| 3516 |
% \end{macro}^^A \Process@ChangedAt |
| 3517 |
% \end{macro}^^A \if@tud@changedat |
| 3518 |
% \begin{macro}{\ChangedAt} |
| 3519 |
% \changes{v2.02}{2014/07/25}{erweitert}^^A |
| 3520 |
% \changes{v2.02}{2014/10/15}{Sternversion neu (keine Randnotiz)}^^A |
| 3521 |
% \changes{v2.06}{2018/09/03}{optionale Angabe des Bundles}^^A |
| 3522 |
% \begin{macro}{\@ChangedAt} |
| 3523 |
% \changes{v2.06}{2019/06/24}{neu}^^A |
| 3524 |
% \begin{length}{\changedatskip} |
| 3525 |
% \changes{v2.04}{2015/06/08}{neu}^^A |
| 3526 |
% Der Befehl \cs{ChangedAt} kann im Fließtext für das Erstellen einer freien |
| 3527 |
% Änderungsnotiz genutzt werden. Das obligatorische Argument sollt wie kurz |
| 3528 |
% zuvor beschrieben verwendet werden. |
| 3529 |
% |
| 3530 |
% Eine Änderungsnotiz wird für die angegebene Versionsnummer normalerweise im |
| 3531 |
% Abschnitt \enquote{Allgemein} aufgeführt. Soll jedoch eine Notiz explizit für |
| 3532 |
% eine Option, eine Umgebung, einen Befehlt etc. erstellt werden, kann dieses |
| 3533 |
% Element vor dem obligatorischen im optionalen Argument angegeben werden. Der |
| 3534 |
% Eintrag erfolgt dann im Abschnitt \enquote{Implementierung} für das gegebene |
| 3535 |
% Element. Im obligatorischen Argument können auch mehrere Änderungsnotizen |
| 3536 |
% gleichzeitig erzeugt werden. hierfür sind diese mit Semikolon voneinander zu |
| 3537 |
% trennen. Das Erzeugen der Liste erfolgt mit \cs{Changed@At@CreateList}. |
| 3538 |
% |
| 3539 |
% Normalerweise wird bei der Nutzung von \cs{ChangedAt} zusätzlich zum Eintrag |
| 3540 |
% in die Änderungsliste eine Randnotiz mit den angegebenen Versionsnummern |
| 3541 |
% erzeugt. Mit dem letzten optionalen Argument nach dem obligatorischen kann |
| 3542 |
% ein vertikaler Versatz dieser angegeben werden. Die Sternversion des Befehls |
| 3543 |
% unterdrückt die Ausgabe der Randnotiz. |
| 3544 |
% \begin{macrocode} |
| 3545 |
\tud@newdim\changedatskip |
| 3546 |
\NewDocumentCommand\ChangedAt{s o d() m !O{\changedatskip}}{% |
| 3547 |
\IfValueTF{#2}{% |
| 3548 |
\Changed@At@CreateList[#2](#3){#4}% |
| 3549 |
}{% |
| 3550 |
\Changed@At@CreateList(#3){#4}% |
| 3551 |
}% |
| 3552 |
% \end{macrocode} |
| 3553 |
% Nach dem Erstellen der Liste wird diese abgearbeitet und ggf. die Randnotiz |
| 3554 |
% ausgegeben. |
| 3555 |
% \begin{macrocode} |
| 3556 |
\print@changedatlist{#1}{#5}% |
| 3557 |
} |
| 3558 |
% \end{macrocode} |
| 3559 |
% Die expandierbare Version des Befehls ist innerhalb von Überschriften nötig. |
| 3560 |
% \begin{macrocode} |
| 3561 |
\NewExpandableDocumentCommand\@ChangedAt{s o d() m}{} |
| 3562 |
\AfterPackage*{hyperref}{% |
| 3563 |
\pdfstringdefDisableCommands{% |
| 3564 |
\let\ChangedAt\@ChangedAt% |
| 3565 |
}% |
| 3566 |
} |
| 3567 |
\BeforeStartingTOC{\let\ChangedAt\@ChangedAt} |
| 3568 |
% \end{macrocode} |
| 3569 |
% \end{length}^^A \changedatskip |
| 3570 |
% \end{macro}^^A \@ChangedAt |
| 3571 |
% \end{macro}^^A \ChangedAt |
| 3572 |
% |
| 3573 |
% \subsubsection{Sukzessive Erstellung der Einträge für die Änderungsliste} |
| 3574 |
% |
| 3575 |
% Das Erstellen von Änderungsnotizen erfolgt in zwei Schritten. Diese werden |
| 3576 |
% zuerst mit dem Befehl \cs{Changed@At@CreateList} in einer standardisierten |
| 3577 |
% Form in der temporären Liste \cs{tud@changedat@list} gespeichert und später |
| 3578 |
% mit dem Makro \cs{Changed@At@CreateEntry} verarbeitet. Dieses Vorgehen liegt |
| 3579 |
% in den Umgebungen für Deklarationen begründet, welche verschachtelt werden |
| 3580 |
% können, jedoch einmalig mit \cs{printdeclarationlist} abgearbeitet werden. |
| 3581 |
% |
| 3582 |
% \begin{macro}{\tud@changedat@list} |
| 3583 |
% \changes{v2.02}{2014/07/25}{neu}^^A |
| 3584 |
% \begin{macro}{\forssvlist} |
| 3585 |
% \changes{v2.05}{2015/11/17}{neu}^^A |
| 3586 |
% Hier werden die Liste \cs{tud@changedat@list} sowie das Makro \cs{forssvlist} |
| 3587 |
% für die Aufspaltung der semikolongetrennten Änderungsnotizen definiert. |
| 3588 |
% \begin{macrocode} |
| 3589 |
\newcommand*\tud@changedat@list{} |
| 3590 |
\let\tud@changedat@list\relax |
| 3591 |
\DeclareListParser*{\forssvlist}{;} |
| 3592 |
% \end{macrocode} |
| 3593 |
% \end{macro}^^A \forssvlist |
| 3594 |
% \end{macro}^^A \tud@changedat@list |
| 3595 |
% \begin{macro}{\Changed@At@CreateList} |
| 3596 |
% \changes{v2.02}{2014/09/02}{neu}^^A |
| 3597 |
% \begin{macro}{\Changed@At@@CreateList} |
| 3598 |
% \changes{v2.02}{2014/10/09}{neu}^^A |
| 3599 |
% \begin{macro}{\Changed@At@@@CreateList} |
| 3600 |
% \begin{macro}{\Changed@At@@@@CreateList} |
| 3601 |
% Mit diesen Befehlen wird eine Liste im Format von \pkg{etoolbox} erzeugt, |
| 3602 |
% welche alle notwendigen Angaben für das Erzeugen der Änderungshistorie in |
| 3603 |
% Form eines Indexes mit \cs{Changed@At@CreateEntry} enthält. |
| 3604 |
% |
| 3605 |
% Der Befehl \cs{Changed@At@CreateList} kann vor dem obligatorischen Argument |
| 3606 |
% mit einem ordinären optionalen Argument verwendet werden, in welchem ein |
| 3607 |
% Makro, eine Umgebung, eine Option etc. angegeben wird. Ist dies der Fall, so |
| 3608 |
% wird der Eintrag in die Änderungsliste für dieses Element generiert, sonst |
| 3609 |
% wird eine allgemeiner Eintrag erzeugt. Das optionale Argument in runden |
| 3610 |
% Klammern wird lediglich verwendet, wenn für eine der beiden Spezialumgebungen |
| 3611 |
% \env{Declaration*} bzw. \env{Bundle*} eine Änderungsnotiz erstellt wird, um |
| 3612 |
% diese für das jeweilige \TUDScript-Bundle-Element in den entsprechenden |
| 3613 |
% Abschnitt der Änderungsliste einzutragen. Das Hauptargument verarbeitet |
| 3614 |
% schließlich eine semikolongetrennte Liste und reicht jeden Bestandteil |
| 3615 |
% zusammen mit den beiden optionalen Argumenten an \cs{Changed@At@@CreateList} |
| 3616 |
% weiter. |
| 3617 |
% \begin{macrocode} |
| 3618 |
\NewDocumentCommand\Changed@At@CreateList{od()m}{% |
| 3619 |
\IfValueT{#3}{\forssvlist{\Changed@At@@CreateList[#1](#2)}{#3}}% |
| 3620 |
} |
| 3621 |
% \end{macrocode} |
| 3622 |
% Mit \cs{Changed@At@@CreateList} wird lediglich die Versionsnummer von der |
| 3623 |
% eigentlichen Änderungsnotiz getrennt. |
| 3624 |
% \begin{macrocode} |
| 3625 |
\NewDocumentCommand\Changed@At@@CreateList{r[]r()>{\SplitArgument{1}{:}}m}{% |
| 3626 |
\Changed@At@@@CreateList[#1](#2)#3% |
| 3627 |
} |
| 3628 |
% \end{macrocode} |
| 3629 |
% Zuletzt wird durch \cs{Changed@At@@@CreateList} ein möglicher Untereintrag |
| 3630 |
% in ein separates Argument abgetrennt und \cs{Changed@At@@@@CreateList} mit |
| 3631 |
% allen Argumenten aufgerufen. |
| 3632 |
% \begin{macrocode} |
| 3633 |
\NewDocumentCommand\Changed@At@@@CreateList{r[]r()>{\SplitArgument{1}{!}}mm}{% |
| 3634 |
\Changed@At@@@@CreateList[#1](#2)#3{#4}% |
| 3635 |
} |
| 3636 |
% \end{macrocode} |
| 3637 |
% Der Befehl \cs{Changed@At@@@@CreateList} übernimmt nun die Erstellung des |
| 3638 |
% Eintrags in die Liste \cs{tud@changedat@list}. Wie bereits erwähnt, enthalten |
| 3639 |
% die beiden ersten Argumente ggf. Markup-Befehl und \TUDScript-Bundle-Element. |
| 3640 |
% Danach folgt die Versionsnummer der Änderungsnotiz, der mögliche Untereintrag |
| 3641 |
% für einen Markup-Befehl sowie die Änderungsnotiz selbst. |
| 3642 |
% |
| 3643 |
% Die oberste Gliederungsebene der Änderungshistorie ist die Versionsnummer. |
| 3644 |
% Unter dieser werden für jedes \TUDScript-Bundle-Element die Änderungsnotizen |
| 3645 |
% separat ausgegeben, wobei diese nochmal in einen allgemeinen Teil und einen |
| 3646 |
% zur Implementierung getrennt werden. |
| 3647 |
% |
| 3648 |
% Der im Folgenden erzeugte Eintrag für die Liste \cs{tud@changedat@list} wird |
| 3649 |
% in zwei unterschiedlichen Varianten generiert. In der Form |
| 3650 |
% \newline\begingroup\scriptsize |
| 3651 |
% \meta{Versionsnummer}|!Allgemein!|\meta{Änderungsnotiz}\ignorespaces% |
| 3652 |
% \endgroup\newline |
| 3653 |
% werden allgemeine Änderungsnotizen erstellt, für Einträge bezüglich der |
| 3654 |
% Implementierung wird die folgende Form genutzt: |
| 3655 |
% \newline\begingroup\scriptsize |
| 3656 |
% \meta{Versionsnummer}|!Implementierung!|\meta{Markup-Befehl}\ignorespaces% |
| 3657 |
% |!|\meta{Untereintrag}|!|\meta{Änderungsnotiz}\ignorespaces% |
| 3658 |
% \endgroup |
| 3659 |
% \begin{macrocode} |
| 3660 |
\NewDocumentCommand\Changed@At@@@@CreateList{r[]r()mmm}{% |
| 3661 |
% \end{macrocode} |
| 3662 |
% Die Aufteilung der Änderungsliste in die einzelnen \TUDScript-Bundle-Elemente |
| 3663 |
% erfolgt entweder anhand des explizit angegebenen optionalen Argumentes in |
| 3664 |
% runden Klammern oder aber implizit über den gegenwärtigen Inhalt des Makros |
| 3665 |
% \cs{tud@bdl@curr}. Dafür wird das Makro \cs{@tempa} so definiert, dass es |
| 3666 |
% das angegebene Argument in einer Box ausführt und das gesuchte Bundle-Element |
| 3667 |
% in \cs{@tempb} gespeichert ist. |
| 3668 |
% \begin{macrocode} |
| 3669 |
\def\@tempa##1{% |
| 3670 |
\sbox\z@{% |
| 3671 |
\let\tud@idx@fmt\relax% |
| 3672 |
\@tud@changedattrue% |
| 3673 |
##1% |
| 3674 |
\@tud@changedatfalse% |
| 3675 |
\ifx\tud@idx@fmt\relax% |
| 3676 |
\gdef\@tempb{##1}% |
| 3677 |
\else% |
| 3678 |
\global\let\@tempb\tud@idx@fmt% |
| 3679 |
\fi% |
| 3680 |
}% |
| 3681 |
}% |
| 3682 |
\let\@tempb\@empty% |
| 3683 |
\IfValueTF{#2}{% |
| 3684 |
\@tempa{#2}% |
| 3685 |
}{% |
| 3686 |
\tud@if@bdl{\@tempa{\tud@bdl@curr}}{}% |
| 3687 |
}% |
| 3688 |
% \end{macrocode} |
| 3689 |
% Nachdem klar ist, für welches Bundle-Element ggf. der Änderungslisteneintrag |
| 3690 |
% erzeugt werden soll, wird nun bestimmt, ob dieser im allgemeinen Teil oder in |
| 3691 |
% den zur Implementierung erscheinen soll. Dies wird an der Existenz des ersten |
| 3692 |
% Argumentes entschieden. Ist es vorhanden, handelt es sich um einen Eintrag |
| 3693 |
% für den Implementierungsteil, welcher in \cs{tud@changedat@list} in der Form |
| 3694 |
% \newline\begingroup\scriptsize |
| 3695 |
% \meta{Versionsnummer}|!Implementierung!|\meta{Markup-Befehl}\ignorespaces% |
| 3696 |
% |!|\meta{Untereintrag}|!|\meta{Änderungsnotiz}\ignorespaces% |
| 3697 |
% \endgroup\newline |
| 3698 |
% gespeichert wird, wobei der Untereintrag auch leer bleiben kann. |
| 3699 |
% \begin{macrocode} |
| 3700 |
\IfValueTF{#1}{% |
| 3701 |
\toks@{#3!Implementierung }% |
| 3702 |
% \end{macrocode} |
| 3703 |
% Hier erfolgt ggf. der Eintrag des \TUDScript-Bundle-Elements, danach folgt |
| 3704 |
% der Markup-Befehl. |
| 3705 |
% \begin{macrocode} |
| 3706 |
\addto@hook@expandafter\toks@{\@tempb}% |
| 3707 |
\addto@hook\toks@{!#1!}% |
| 3708 |
% \end{macrocode} |
| 3709 |
% Wurde ein Untereintrag angegeben, wird dieser hier gefolgt von der |
| 3710 |
% eigentlichen Änderungsnotiz eingefügt. Für obsolete Deklarationen für die |
| 3711 |
% Änderungsnotiz in jedem Fall ignoriert, da beim späteren Aufruf des Makros |
| 3712 |
% \cs{Changed@At@CreateEntry} eine Standardmeldung ausgegeben wird. |
| 3713 |
% \begin{macrocode} |
| 3714 |
\IfValueT{#4}{\addto@hook\toks@{#4}}% |
| 3715 |
\addto@hook\toks@{!}% |
| 3716 |
\if@tud@obsolete\else% |
| 3717 |
\IfValueT{#5}{\addto@hook\toks@{#5}}% |
| 3718 |
\fi% |
| 3719 |
}{% |
| 3720 |
% \end{macrocode} |
| 3721 |
% Handelt es sich um einen allgemeinen Änderungseintrag, wird dieser in der Form |
| 3722 |
% \newline\begingroup\scriptsize |
| 3723 |
% \meta{Versionsnummer}|!Allgemein!|\meta{Änderungsnotiz}\ignorespaces% |
| 3724 |
% \endgroup\newline |
| 3725 |
% in der Liste \cs{tud@changedat@list} gespeichert. Für den allgemeinen Teil |
| 3726 |
% wird mit der Angabe eines \TUDScript-Bundle-Elements etwas anders verfahren. |
| 3727 |
% Wurde dieses~-- wenn auch nur indirekt über eine der beiden Spezialumgebungen |
| 3728 |
% \env{Declaration*} bzw. \env{Bundle*}~-- angegeben, so wird der Eintrag in |
| 3729 |
% den allgemeinen Hauptteil als Untereintrag erzeugt. Erfolgte die Verwendung |
| 3730 |
% jedoch innerhalb einer \TUDScript-Bundle-Deklaration, so erscheint der |
| 3731 |
% Eintrag im allgemeinen Teil für das explizite Bundle-Element. |
| 3732 |
% \begin{macrocode} |
| 3733 |
\toks@{#3!Allgemein }% |
| 3734 |
\IfValueTF{#2}{% |
| 3735 |
\addto@hook\toks@{!}% |
| 3736 |
\addto@hook@expandafter\toks@{\@tempb:\space}% |
| 3737 |
\IfValueTF{#5}{% |
| 3738 |
\addto@hook\toks@{#5}% |
| 3739 |
}{% |
| 3740 |
\addto@hook\toks@{\emph{neu}}% |
| 3741 |
}% |
| 3742 |
}{% |
| 3743 |
\addto@hook@expandafter\toks@{\@tempb}% |
| 3744 |
\addto@hook\toks@{!}% |
| 3745 |
\addto@hook\toks@{#5}% |
| 3746 |
}% |
| 3747 |
\IfValueT{#4}{% |
| 3748 |
\ClassError{tudscrmanual}{Using !#4 isn't allowed for a change notice}{% |
| 3749 |
At least, it has to be implemented!% |
| 3750 |
}% |
| 3751 |
}% |
| 3752 |
}% |
| 3753 |
\listeadd\tud@changedat@list{\the\toks@}% |
| 3754 |
} |
| 3755 |
% \end{macrocode} |
| 3756 |
% \end{macro}^^A \Changed@At@@@@CreateList |
| 3757 |
% \end{macro}^^A \Changed@At@@@CreateList |
| 3758 |
% \end{macro}^^A \Changed@At@@CreateList |
| 3759 |
% \end{macro}^^A \Changed@At@CreateList |
| 3760 |
% |
| 3761 |
% \subsubsection{Erzeugen der Änderungseinträge} |
| 3762 |
% |
| 3763 |
% Mit den nachfolgenden Makros erfolgt das eigentliche Eintragen der |
| 3764 |
% Änderungseinträge aus der Liste \cs{tud@changedat@list} in den entsprechenden |
| 3765 |
% Index~\val{changelog}. |
| 3766 |
% |
| 3767 |
% \begin{macro}{\Changed@At@CreateEntry} |
| 3768 |
% \changes{v2.02}{2014/09/02}{neu}^^A |
| 3769 |
% \begin{macro}{\Changed@At@@CreateEntry} |
| 3770 |
% \changes{v2.02}{2014/09/02}{neu}^^A |
| 3771 |
% Der Befehl \cs{Changed@At@CreateEntry} wird durch \cs{@printchangedatlist} |
| 3772 |
% aufgerufen und teilt die gegebene Liste am Delimiter Ausrufezeichen |!| in |
| 3773 |
% fünf Argumente auf und reicht sie an \cs{Changed@At@@CreateEntry} weiter. |
| 3774 |
% Sind weniger als vier Ausrufezeichen vorhanden, so werden die ungenutzten |
| 3775 |
% Argumente mit dem~-- durch das Paket \pkg{xparse} definierten~-- leeren Wert |
| 3776 |
% \val{-NoValue-} an den Befehl \cs{Changed@At@@CreateEntry} übergeben. |
| 3777 |
% \begin{macrocode} |
| 3778 |
\NewDocumentCommand\Changed@At@CreateEntry{>{\SplitArgument{4}{!}}m}{% |
| 3779 |
\Changed@At@@CreateEntry#1% |
| 3780 |
} |
| 3781 |
% \end{macrocode} |
| 3782 |
% Mit \cs{Changed@At@@CreateEntry} wird der Eintrag in die Änderungshistorie |
| 3783 |
% erzeugt, falls denn überhaupt ein Eintrag generiert werden soll. Dies wird |
| 3784 |
% daran erkannt, ob das dritte Argument dew Wert \val{-NoValue-} entspricht |
| 3785 |
% oder eben nicht. Der zweite Fall tritt auf, wenn lediglich eine Randnotiz |
| 3786 |
% gesetzt werden soll. Die in \cs{tud@changedat@list} gespeicherten Einträge |
| 3787 |
% haben die Form |
| 3788 |
% \newline\begingroup\scriptsize |
| 3789 |
% \meta{Versionsnummer}|!Allgemein!|\meta{Änderungsnotiz}\ignorespaces% |
| 3790 |
% \endgroup\newline |
| 3791 |
% oder |
| 3792 |
% \newline\begingroup\scriptsize |
| 3793 |
% \meta{Versionsnummer}|!Implementierung!|\meta{Markup-Befehl}\ignorespaces% |
| 3794 |
% |!|\meta{Untereintrag}|!|\meta{Änderungsnotiz}\ignorespaces% |
| 3795 |
% \endgroup |
| 3796 |
% \begin{macrocode} |
| 3797 |
\newcommand*\Changed@At@@CreateEntry[5]{% |
| 3798 |
\IfValueT{#3}{% |
| 3799 |
% \end{macrocode} |
| 3800 |
% Bei der Deklaration von Optionen, Befehlen etc. werden diese automatisch in |
| 3801 |
% der Liste der Änderungen im Bereich \enquote{Implementierung} vor der |
| 3802 |
% gegebenen Erklärung selbst ausgegeben. Hierfür wird die Existenz des vierten |
| 3803 |
% Arguments geprüft. Ist dieses vorhanden\dots |
| 3804 |
% \begin{macrocode} |
| 3805 |
\IfValueTF{#4}{% |
| 3806 |
% \end{macrocode} |
| 3807 |
% \dots befindet sich im dritten Argument der Markup-Befehl für den Eintrag im |
| 3808 |
% Implementierungsteil. Mit dem zwischenzeitlichen Aktivieren des Schalters |
| 3809 |
% \cs{if@tud@changedat} wird beim nachfolgenden Aufruf des Markup-Befehls das |
| 3810 |
% Makro \cs{Process@ChangedAt} ausgeführt und dadurch auch \cs{tud@idx@get*} |
| 3811 |
% aufgerufen, wodurch in den Makros \cs{tud@idx@key}, \cs{tud@idx@fmt} und |
| 3812 |
% \cs{tud@idx@val} die passend formatierten Indexeinträge enthalten sind. |
| 3813 |
% \begin{macrocode} |
| 3814 |
\@tud@changedattrue% |
| 3815 |
#3% |
| 3816 |
\@tud@changedatfalse% |
| 3817 |
% \end{macrocode} |
| 3818 |
% Das vierte Argument erstellt in der Änderungsliste einen Untereintrag für den |
| 3819 |
% im dritten Argument gegebenen Markup-Befehl. Dies wird für Anmerkungen zu |
| 3820 |
% expliziten Schlüssel-Wert-Paaren bei Optionen oder Parametern genutzt. |
| 3821 |
% \begin{macrocode} |
| 3822 |
\tud@if@strblank{#4}{}{% |
| 3823 |
% \end{macrocode} |
| 3824 |
% Hierfür wird die zuvor erhaltene Formatierung des Markup-Befehls des dritten |
| 3825 |
% Argumentes an den Haupteintrag \cs{tud@idx@val} mit der zusätzlichen |
| 3826 |
% Anmerkung \enquote{Werte angepasst} angehängt. |
| 3827 |
% \begin{macrocode} |
| 3828 |
\eappto\tud@idx@val{% |
| 3829 |
\expandonce\tud@idx@key: Werte angepasst@% |
| 3830 |
\expandonce\tud@idx@fmt: Werte angepasst!% |
| 3831 |
}% |
| 3832 |
% \end{macrocode} |
| 3833 |
% Anschließend werden die Formatierungsbefehle des vierten Arguments genutzt, |
| 3834 |
% wobei vom Befehl \cs{suffix} nur das Argument selbst benötigt wird. Um den |
| 3835 |
% Inhalt von \cs{tud@idx@val} zu schützen, erfolgt das ganze in einer Gruppe. |
| 3836 |
% \begin{macrocode} |
| 3837 |
\begingroup% |
| 3838 |
\@tud@changedattrue% |
| 3839 |
#4% |
| 3840 |
\@tud@changedatfalse% |
| 3841 |
\let\suffix\@gobble% |
| 3842 |
\protected@edef\tud@reserved{% |
| 3843 |
\noexpand\endgroup% |
| 3844 |
\def\noexpand\tud@idx@key{\tud@idx@key}% |
| 3845 |
\def\noexpand\tud@idx@fmt{\tud@idx@fmt}% |
| 3846 |
}% |
| 3847 |
\tud@reserved% |
| 3848 |
}% |
| 3849 |
% \end{macrocode} |
| 3850 |
% Nachdem die Formatierung der Haupt- und Untereinträge soweit zusammengebaut |
| 3851 |
% wurden, wird die eigentliche Änderungsnotiz des fünften Arguments angehangen. |
| 3852 |
% Dabei wird für den Fall, dass \emph{keine} Erklärung angegeben wurde, in der |
| 3853 |
% Änderungsliste vermerkt, ob es sich bei dem Markup-Befehl respektive dessen |
| 3854 |
% Untereintrag um eine \emph{neue} bzw. eine \emph{obsolete} Variante handelt. |
| 3855 |
% \begin{macrocode} |
| 3856 |
\tud@if@strblank{#5}{% |
| 3857 |
\if@tud@obsolete% |
| 3858 |
\appto\tud@idx@fmt{: \emph{entf\"allt}}% |
| 3859 |
\else% |
| 3860 |
\appto\tud@idx@fmt{: \emph{neu}}% |
| 3861 |
\fi% |
| 3862 |
% \end{macrocode} |
| 3863 |
% Existiert ein Eintrag, wird dieser für Schlüssel und Format verwendet. |
| 3864 |
% \begin{macrocode} |
| 3865 |
}{% |
| 3866 |
\appto\tud@idx@key{: #5}% |
| 3867 |
\appto\tud@idx@fmt{: #5}% |
| 3868 |
}% |
| 3869 |
% \end{macrocode} |
| 3870 |
% Nachdem alles abgearbeitet wurde, wird der Indexeintrag erstellt. |
| 3871 |
% \begin{macrocode} |
| 3872 |
\index[changelog]{#1!#2!\tud@idx@val\tud@idx@key @\tud@idx@fmt}% |
| 3873 |
% \end{macrocode} |
| 3874 |
% Existiert das vierte Argument nicht, handelt es sich um einen allgemeinen |
| 3875 |
% Eintrag in der Änderungshistorie. Dieser wird direkt ausgeführt. |
| 3876 |
% \begin{macrocode} |
| 3877 |
}{% |
| 3878 |
\index[changelog]{#1!#2!#3}% |
| 3879 |
}% |
| 3880 |
}% |
| 3881 |
% \end{macrocode} |
| 3882 |
% Außerdem wird der Liste \cs{tud@templist} die aktuelle Version einmalig |
| 3883 |
% hinzugefügt, um alle Versionsangaben in einer Randnotiz ausgeben zu können. |
| 3884 |
% \begin{macrocode} |
| 3885 |
\ifinlist{#1}{\tud@templist}{}{\listadd\tud@templist{#1}}% |
| 3886 |
} |
| 3887 |
% \end{macrocode} |
| 3888 |
% \end{macro}^^A \Changed@At@@CreateEntry |
| 3889 |
% \end{macro}^^A \Changed@At@CreateEntry |
| 3890 |
% |
| 3891 |
% \subsubsection{Ausgabe der Änderungsliste} |
| 3892 |
% |
| 3893 |
% Ähnlich wie für den Index wird auch für die Änderungsliste bei der Ausgabe |
| 3894 |
% verfahren. |
| 3895 |
% |
| 3896 |
% \begin{macro}{\PrintChangelog} |
| 3897 |
% \begin{environment}{theindex} |
| 3898 |
% Mit \cs{PrintChangelog} erfolgt die Ausgabe der Änderungsliste. Dabei ist zu |
| 3899 |
% beachten, dass die Einträge im Index bis zur vierten Ebene erfolgen. |
| 3900 |
% \begin{macrocode} |
| 3901 |
\newcommand*\PrintChangelog{% |
| 3902 |
\begingroup% |
| 3903 |
% \end{macrocode} |
| 3904 |
% Die oberste Ebene enthält die Versionsnummer mit dem Präfix |v|. Diese Ebene |
| 3905 |
% soll nicht als Indexeintrag selber sondern vielmehr als Überschrift der Ebene |
| 3906 |
% \cs{subsection} genutzt werden. Dafür wird zum einen das durch das Paket |
| 3907 |
% \pkg{imakeidx} definierte Makro \cs{lettergroup} \emph{unschädlich} gemacht, |
| 3908 |
% zum anderen wird der Befehl \cs{item} so umdefiniert, dass dieser alles bis |
| 3909 |
% zum nächsten Zeilenumbruch als Argument einliest. Alle darunter liegenden |
| 3910 |
% \cs{item}-Befehle werden eine Ebene nach oben gehoben. |
| 3911 |
% \begin{macrocode} |
| 3912 |
\let\lettergroup\@gobble% |
| 3913 |
\apptocmd\theindex{% |
| 3914 |
\let\subsubsubitem\subsubitem% |
| 3915 |
\let\subsubitem\subitem% |
| 3916 |
\let\subitem\item% |
| 3917 |
\renewcommand*\item{% |
| 3918 |
\begingroup% |
| 3919 |
\escapechar=`\\% |
| 3920 |
\catcode\endlinechar=\active% |
| 3921 |
\csname\string\item\endcsname% |
| 3922 |
}% |
| 3923 |
\begingroup% |
| 3924 |
\escapechar=`\\% |
| 3925 |
\lccode`\~=\endlinechar% |
| 3926 |
\lowercase{% |
| 3927 |
\expandafter\endgroup% |
| 3928 |
\expandafter\def\csname\string\item\endcsname##1~% |
| 3929 |
}{% |
| 3930 |
\endgroup% |
| 3931 |
\addsec[{##1}]{\TUDScript ##1}% |
| 3932 |
\tudhyperdef*{idx:changelog:##1}% |
| 3933 |
\def\@tempa{\indexname: \TUDScript ##1}% |
| 3934 |
\@mkboth{\@tempa}{\@tempa}% |
| 3935 |
}% |
| 3936 |
}{}{\tud@patch@wrn{theindex}}% |
| 3937 |
% \end{macrocode} |
| 3938 |
% Mit der so angepassten \env{theindex}-Umgebung erfolgt die Ausgabe der |
| 3939 |
% Änderungshistorie. |
| 3940 |
% \begin{macrocode} |
| 3941 |
\clearpage% |
| 3942 |
\def\imki@indexlevel{\addchap}% |
| 3943 |
\print@index[changelog]% |
| 3944 |
\endgroup% |
| 3945 |
} |
| 3946 |
% \end{macrocode} |
| 3947 |
% \end{environment}^^A theindex |
| 3948 |
% \end{macro}^^A \PrintChangelog |
| 3949 |
% \begin{macro}{\print@changedatlist} |
| 3950 |
% \changes{v2.02}{2014/10/09}{neu}^^A |
| 3951 |
% Die Einträge in der Liste der Änderungen \cs{tud@changedat@list} werden mit |
| 3952 |
% dem Makro \cs{Changed@At@CreateList} abgearbeitet, sortiert und erstellt. Das |
| 3953 |
% zweite obligatorische Argument von \cs{@printchangedatlist} steurrt den |
| 3954 |
% vertikalen Versatz der Randnotiz. Wird im ersten Argument das boolesche Flag |
| 3955 |
% zu \cs{BooleanTrue} gesetzt, wird die Randnotiz unterdrückt. |
| 3956 |
% \begin{macrocode} |
| 3957 |
\NewDocumentCommand\print@changedatlist{mm}{% |
| 3958 |
\ifx\tud@changedat@list\relax\else% |
| 3959 |
\let\tud@templist\relax% |
| 3960 |
\forlistloop\Changed@At@CreateEntry{\tud@changedat@list}% |
| 3961 |
\global\let\tud@changedat@list\relax% |
| 3962 |
% \end{macrocode} |
| 3963 |
% Nach der Verarbeitung der Einräge sind in \cs{tud@templist} alle angegebenen |
| 3964 |
% Versionsnummern genau einmal enthalten. Mit \cs{tud@list@sort} werden diese |
| 3965 |
% in die richtige Reihenfolge sortiert und anschließend als Randnotiz in einer |
| 3966 |
% Tabelle ausgegeben, falls nicht die Sternversion verwendet wurde. |
| 3967 |
% \begin{macrocode} |
| 3968 |
\IfBooleanF{#1}{% |
| 3969 |
\tud@list@sort\tud@templist% |
| 3970 |
\strut% |
| 3971 |
\marginnote{% |
| 3972 |
\def\@tempa####1{% |
| 3973 |
\ignorespaces% |
| 3974 |
\tudhyperref{idx:changelog:####1}{####1}% |
| 3975 |
\tabularnewline% |
| 3976 |
}% |
| 3977 |
\begin{tabular}{|l|}% |
| 3978 |
\hline% |
| 3979 |
\forlistloop\@tempa{\tud@templist}% |
| 3980 |
\hline% |
| 3981 |
\end{tabular}% |
| 3982 |
}[{#2}]% |
| 3983 |
\ignorespaces% |
| 3984 |
}% |
| 3985 |
\fi% |
| 3986 |
} |
| 3987 |
% \end{macrocode} |
| 3988 |
% \end{macro}^^A \print@changedatlist |
| 3989 |
% |
| 3990 |
% \subsection{Erweiterte Listen für Erläuterungen im Handbuch} |
| 3991 |
% |
| 3992 |
% Es folgen einige Umgebungen, mit welchen bestimmte Aspekte oder Pakete im |
| 3993 |
% Handbuch erläutert werden. |
| 3994 |
% |
| 3995 |
% Das Paket \pkg{enumitem} erlaubt das Beeinflussen der Standardlisten und die |
| 3996 |
% Ableitung neuer Listen aus diesen. Mit \cs{setlist}|{noitemsep}| werden die |
| 3997 |
% zusätzlichen Zwischenräume innerhalb der Listen beseitigt. Weiterhin wird |
| 3998 |
% linksbündiger Flattersatz für die Standardlisten aktiviert. |
| 3999 |
% \begin{macrocode} |
| 4000 |
\RequirePackage{enumitem} |
| 4001 |
\setlist{before*={\endgraf\tud@RaggedRight},partopsep=0pt,noitemsep} |
| 4002 |
% \end{macrocode} |
| 4003 |
% \begin{macro}{\stditem} |
| 4004 |
% \begin{macro}{\tud@before@item} |
| 4005 |
% Mit den Möglichkeiten des Paketes \pkg{enumitem} werden folgend Listen für |
| 4006 |
% das Aufführen von möglichen Werten einer Option sowie der Beschreibung von |
| 4007 |
% nützlichen Paketen erstellt. Für beide Listen soll dabei die originale |
| 4008 |
% Definition von \cs{item} in \cs{stditem} gesichert und anschließend angepasst |
| 4009 |
% werden. Die Sicherung und Redefinition von \cs{item} erfolgt dabei über das |
| 4010 |
% Makro \cs{tud@before@item} über einen bereitgestellten \emph{hook} zu Beginn |
| 4011 |
% der jeweiligen Liste. |
| 4012 |
% \begin{macrocode} |
| 4013 |
\newcommand*\stditem{} |
| 4014 |
\newcommand*\tud@before@item[1]{% |
| 4015 |
\ifdefvoid{\stditem}{% |
| 4016 |
\let\stditem\item% |
| 4017 |
\letcs\item{tud@item@#1}% |
| 4018 |
% \end{macrocode} |
| 4019 |
% Damit die Änderungsnotizen in der passenden vertikalen Position erscheinen, |
| 4020 |
% wird die Länge \cs{changedatskip} entsprechend angepasst. |
| 4021 |
% \begin{macrocode} |
| 4022 |
\tud@setdim\changedatskip{-1\baselineskip}% |
| 4023 |
}{}% |
| 4024 |
} |
| 4025 |
% \end{macrocode} |
| 4026 |
% \end{macro}^^A \tud@before@item |
| 4027 |
% \end{macro}^^A \stditem |
| 4028 |
% |
| 4029 |
% \subsubsection{Listen für gültige Werte von Optionen} |
| 4030 |
% |
| 4031 |
% \begin{environment}{values} |
| 4032 |
% \begin{environment}{@values} |
| 4033 |
% \begin{macro}{\tud@values} |
| 4034 |
% Die Liste \env{@values} dient zum Benennen der möglichen Werte für einen |
| 4035 |
% bestimmten Schlüssel. Im Handbuch kommt diese Liste vor allem bei Optionen |
| 4036 |
% aber ggf. auch bei bestimmten Befehls- und Optionsparametern zum Einsatz. |
| 4037 |
% Diese wird in der Umgebung \env{values} eingebettet, damit zum einen ein |
| 4038 |
% \emph{obligatorisches} Argument verwendet werden kann und zum anderen |
| 4039 |
% \emph{nach} diesem ein optionales für die Liste selbst verwendbar ist. Das |
| 4040 |
% obligatorische Argument wird in \cs{tud@values} gesichert und sollte die |
| 4041 |
% genauer zu beschreibende Option bzw. das Makro etc. enthalten. |
| 4042 |
% \begin{macrocode} |
| 4043 |
\newcommand*\tud@values{} |
| 4044 |
\NewDocumentEnvironment{values}{mo}{% |
| 4045 |
\def\tud@values{#1}% |
| 4046 |
\IfValueTF{#2}{\@values[{#2}]}{\@values}% |
| 4047 |
}{% |
| 4048 |
\end@values% |
| 4049 |
} |
| 4050 |
\newlist{@values}{description}{1} |
| 4051 |
\setlist[@values]{% |
| 4052 |
topsep=\smallskipamount,labelwidth=\linewidth,labelsep=0pt,% |
| 4053 |
font=\normalfont,parsep=\parskip,listparindent=\parindent,% |
| 4054 |
before=\tud@before@item{values}% |
| 4055 |
} |
| 4056 |
% \end{macrocode} |
| 4057 |
% \end{macro}^^A \tud@values |
| 4058 |
% \end{environment}^^A @values |
| 4059 |
% \end{environment}^^A values |
| 4060 |
% \begin{macro}{\tud@item@values} |
| 4061 |
% \begin{macro}{\forslashlist} |
| 4062 |
% Das Makro \cs{tud@item@values} ersetzt in der Umgebung \env{values} die |
| 4063 |
% originale Definition von \cs{item}. Die Sternversion kann dabei verwendet |
| 4064 |
% werden, um die Einstellung für den Säumniswert hervorzuheben. Im ersten |
| 4065 |
% optionalen Argument können die möglichen Werte einer Option oder eines |
| 4066 |
% Parameters angegeben werden. Sind mehrere Werte gleichbedeutende Werte |
| 4067 |
% verwendbar, so sind diese durch |/| zu trennen. Dabei wird der als erstes |
| 4068 |
% angegebene Wert für den Untereintrag in den Index verwendet. Das zweite |
| 4069 |
% optionale Argument kann genutzt werden, falls beispielsweise für |
| 4070 |
% unterschiedliche Klassen sich der Säumniswert unterscheidet. Das letzte |
| 4071 |
% optionale Argument in runden Klammern fügt zum Schluss einen ergänzenden |
| 4072 |
% Eintrag hinzu. |
| 4073 |
% \begin{macrocode} |
| 4074 |
\DeclareListParser*{\forslashlist}{/} |
| 4075 |
\NewDocumentCommand\tud@item@values{sood()}{% |
| 4076 |
% \end{macrocode} |
| 4077 |
% Alle Auszeichnungen kommen nur zum Tragen, wenn ein optionales Argument für |
| 4078 |
% die Werte angegeben wurde. |
| 4079 |
% \begin{macrocode} |
| 4080 |
\IfValueTF{#2}{% |
| 4081 |
% \end{macrocode} |
| 4082 |
% Die durch Schrägstrich getrennte Liste im optionalen Argument wird mit |
| 4083 |
% \cs{forslashlist} durchlaufen. Der erste Eintrag wird für den Indexeintrag |
| 4084 |
% benötigt und in \cs{@tempc} gesichert, alle weiteren Einträge werden in |
| 4085 |
% \cs{@tempb} gespeichert und lediglich im Fließtext aufgelistet. |
| 4086 |
% \begin{macrocode} |
| 4087 |
\let\@tempc\@empty% |
| 4088 |
\def\tud@reserved##1{% |
| 4089 |
\if@tempswa% |
| 4090 |
\appto\@tempb{/##1}% |
| 4091 |
\else% |
| 4092 |
\@tempswatrue% |
| 4093 |
\let\@tempb\@empty% |
| 4094 |
\def\@tempc{##1}% |
| 4095 |
\fi% |
| 4096 |
}% |
| 4097 |
\@tempswafalse% |
| 4098 |
\forslashlist\tud@reserved{#2}% |
| 4099 |
% \end{macrocode} |
| 4100 |
% Jetzt beginnt die Formatierung der Ausgabe. Zuerst wird die zu beschreibende |
| 4101 |
% Option in \cs{@tempa} expandiert. Danach wird der erste Wert angehangen, |
| 4102 |
% wobei dieser für die Sternversion als Säumniswert mit \cs{emph} hervorgehoben |
| 4103 |
% wird. Zuletzt wird dafür Sorge getragen, dass auf den anschließend erzeugten |
| 4104 |
% Eintrag selbst kein Hyperlink erzeugt wird und dieser im passenden Index als |
| 4105 |
% fettmarkierter Eintrag erscheint. |
| 4106 |
% \begin{macrocode} |
| 4107 |
\edef\@tempa{\expandonce\tud@values}% |
| 4108 |
\protected@eappto\@tempa{% |
| 4109 |
=\IfBooleanTF{#1}{\noexpand\emph}{\@firstofone}{\@tempc}=% |
| 4110 |
}% |
| 4111 |
\appto\@tempa{'none'|!|}% |
| 4112 |
% \end{macrocode} |
| 4113 |
% Danach werden alle weiteren möglichen Werte angegeben, wobei auch diese im |
| 4114 |
% Zweifelsfall mit \cs{emph} hervorzuheben sind. |
| 4115 |
% \begin{macrocode} |
| 4116 |
\edef\@tempb{% |
| 4117 |
\IfBooleanTF{#1}{\noexpand\emph}{\@firstofone}{% |
| 4118 |
\noexpand\PValue{\@tempb}% |
| 4119 |
}% |
| 4120 |
}% |
| 4121 |
% \end{macrocode} |
| 4122 |
% Zuletzt erfolgt die Auszeichnung, ob es sich bei den gelisteten Werten um |
| 4123 |
% Säumniswerte handelt, gefolgt vom optionael Suffix. |
| 4124 |
% \begin{macrocode} |
| 4125 |
\IfBooleanTF{#1}{% |
| 4126 |
\appto\@tempb{\suffix{S\"aumniswert}}% |
| 4127 |
}{% |
| 4128 |
\IfValueT{#3}{\appto\@tempb{\suffix{S\"aumniswert f\"ur #3}}}% |
| 4129 |
}% |
| 4130 |
\IfValueT{#4}{\appto\@tempb{\suffix{#4}}}% |
| 4131 |
% \end{macrocode} |
| 4132 |
% Die in \cs{tud@values} gespeicherte, zu beschreibende Option bzw. Makro etc. |
| 4133 |
% und der erste im optionalen Argument angegebene Wert werden verwendet, um ein |
| 4134 |
% Label zu erstellen. |
| 4135 |
% \begin{macrocode} |
| 4136 |
\tud@lbl@get@curr*\tud@lbl@tmp{\tud@bdl@curr:\tud@values}=\@tempc=% |
| 4137 |
% \end{macrocode} |
| 4138 |
% Abschließend erfolgt wird die Ausgabe des generierten Eintrags mit dem |
| 4139 |
% originalen Makro \cs{stditem}. |
| 4140 |
% \begin{macrocode} |
| 4141 |
\stditem[\tudhyperdef{\tud@lbl@tmp}\@tempa\@tempb]% |
| 4142 |
}{% |
| 4143 |
\stditem% |
| 4144 |
}% |
| 4145 |
} |
| 4146 |
% \end{macrocode} |
| 4147 |
% \end{macro}^^A \forslashlist |
| 4148 |
% \end{macro}^^A \tud@item@values |
| 4149 |
% \begin{macro}{\itemtrue} |
| 4150 |
% \begin{macro}{\itemfalse} |
| 4151 |
% \begin{macro}{\tud@item@bool} |
| 4152 |
% Die folgenden beiden Befehle sind äquivalent zu \cs{tud@item@values} genutzt |
| 4153 |
% werden. Diese enthalten allerdings im optionalen Argument zumindest die |
| 4154 |
% Standardwerte für positive bzw. negative boolesche Schalter. Diese werden |
| 4155 |
% durch den Befehl \cs{item@bool} gesetzt. |
| 4156 |
% \begin{macrocode} |
| 4157 |
\NewDocumentCommand\itemtrue{!s !o !o !d()}{% |
| 4158 |
\item@bool{#1}{true/on/yes}[#2][#3](#4)% |
| 4159 |
} |
| 4160 |
\NewDocumentCommand\itemfalse{!s !o !o !d()}{% |
| 4161 |
\item@bool{#1}{false/off/no}[#2][#3](#4)% |
| 4162 |
} |
| 4163 |
% \end{macrocode} |
| 4164 |
% Der Befehl \cs{item@bool} setzt je nach angegebenen Argumenten über ein |
| 4165 |
% token-Register den auszuführenden \cs{item}-Befehl zusammen. |
| 4166 |
% \begin{macrocode} |
| 4167 |
\NewDocumentCommand\item@bool{mmr[]r[]r()}{% |
| 4168 |
\toks@{\item}% |
| 4169 |
\IfBooleanT{#1}{\addto@hook\toks@{*}}% |
| 4170 |
% \end{macrocode} |
| 4171 |
% Die optionalen Werte werden im Zweifel den booleschen Standardwerten |
| 4172 |
% angehängt und als einziges optionales Argument an \cs{item} übergeben. |
| 4173 |
% \begin{macrocode} |
| 4174 |
\protected@edef\@tempa{#2\IfValueT{#3}{/#3}}% |
| 4175 |
\addto@hook@expandafter\toks@{\expandafter[\@tempa]}% |
| 4176 |
\IfValueT{#4}{\addto@hook\toks@{[#4]}}% |
| 4177 |
\IfValueT{#5}{\addto@hook\toks@{(#5)}}% |
| 4178 |
\the\toks@% |
| 4179 |
} |
| 4180 |
% \end{macrocode} |
| 4181 |
% \end{macro}^^A \itemfalse |
| 4182 |
% \end{macro}^^A \itemtrue |
| 4183 |
% \end{macro}^^A \tud@item@bool |
| 4184 |
% |
| 4185 |
% \subsubsection{Listen für die Beschreibung von Paketen} |
| 4186 |
% |
| 4187 |
% \begin{environment}{packages} |
| 4188 |
% \begin{macro}{\tud@item@packages} |
| 4189 |
% \changes{v2.02}{2014/10/09}{optionales Argument für CTAN-Link}^^A |
| 4190 |
% \changes{v2.04}{2015/03/12}{optionales Argument für weitere Pakete}^^A |
| 4191 |
% Ähnlich wie für die Auflistung von Werten eines Schlüssels wird auch mit der |
| 4192 |
% Charakterisierung von Paketen verfahren. Diese werden in der Auflistung |
| 4193 |
% speziell gekennzeichnet. |
| 4194 |
% \begin{macrocode} |
| 4195 |
\newlist{packages}{description}{2} |
| 4196 |
\setlist[packages]{% |
| 4197 |
topsep=\smallskipamount,labelwidth=\linewidth,labelsep=0pt,% |
| 4198 |
font=\normalfont,parsep=\parskip,listparindent=\parindent,% |
| 4199 |
before=\tud@before@item{packages}% |
| 4200 |
} |
| 4201 |
% \end{macrocode} |
| 4202 |
% Hiermit können ein oder mehrere Pakete erläutert werden. Des Weiteren werden |
| 4203 |
% Textanker definiert, auf die im Zweifelsfall in der Dokumentation verlinkt |
| 4204 |
% wird. |
| 4205 |
% \begin{macrocode} |
| 4206 |
\NewDocumentCommand\tud@item@packages{od<>d()}{% |
| 4207 |
% \end{macrocode} |
| 4208 |
% Die kommagetrennte Liste im optionalen Argument wird verwendet, um jedes |
| 4209 |
% einzelnen Paket aufzulisten und einen dazugehörigen Textanker zu erzeugen. |
| 4210 |
% Das optionale Argument in Guillemets kann genutzt werden, um \emph{alle} |
| 4211 |
% gelisteten Pakete auf den gleichen CTAN-Link zielen zu lassen. Dies ist |
| 4212 |
% beispielsweise für mehrere Pakete aus dem gleichen Bundle sinnvoll. |
| 4213 |
% \begin{macrocode} |
| 4214 |
\def\@tempa##1{% |
| 4215 |
\@tempc% |
| 4216 |
\tud@lbl@get@curr*\tud@lbl@tmp{\tud@bdl@curr:\Package{##1}}% |
| 4217 |
\tudhyperdef{\tud@lbl@tmp}% |
| 4218 |
\begingroup% |
| 4219 |
\Package{##1}<#2>'url'|!|% |
| 4220 |
\endgroup% |
| 4221 |
\def\@tempc{, }% |
| 4222 |
}% |
| 4223 |
\stditem[{% |
| 4224 |
\IfValueT{#1}{% |
| 4225 |
\let\@tempc\relax% |
| 4226 |
\forcsvlist\@tempa{#1}% |
| 4227 |
% \end{macrocode} |
| 4228 |
% Wird im dritten optionalen Argument in runden Klammern ein Paket angegeben, |
| 4229 |
% so wird ebenfalls ein Textanker erzeugt, allerdings auf einen Hyperlink zu |
| 4230 |
% CTAN verzichtet. |
| 4231 |
% \begin{macrocode} |
| 4232 |
\IfValueT{#3}{% |
| 4233 |
\tud@lbl@get@curr*\tud@lbl@tmp{\tud@bdl@curr:\Package{#3}}% |
| 4234 |
\quad(\tudhyperdef{\tud@lbl@tmp}\Package{#3}'none'|!|)% |
| 4235 |
}% |
| 4236 |
}% |
| 4237 |
}]% |
| 4238 |
} |
| 4239 |
% \end{macrocode} |
| 4240 |
% \end{macro}^^A \tud@item@packages |
| 4241 |
% \end{environment}^^A packages |
| 4242 |
% |
| 4243 |
% \subsection{Erläuterungen und weiterführende Ergänzungen im Handbuch} |
| 4244 |
% \subsubsection{Tabelle mit automatisch berechneter Mehrspaltenzellenbreite} |
| 4245 |
% |
| 4246 |
% \begin{environment}{tabularm} |
| 4247 |
% \begin{macro}{\tabularm@allcolumnpar} |
| 4248 |
% \begin{macro}{\tabularm@box} |
| 4249 |
% \begin{macro}{\tabularm@num} |
| 4250 |
% \begin{length}{\tabularm@wd} |
| 4251 |
% \begin{length}{\tempdim} |
| 4252 |
% \changes{v2.02}{2014/08/16}{neu}^^A |
| 4253 |
% Die Umgebung \env{tabularm} ist eine Erweiterung der \env{tabular}-Umgebung. |
| 4254 |
% In dieser wird die Breite der zu setzenden Tabelle mit Hilfe der Box |
| 4255 |
% \cs{tabularm@box} in \cs{tabularm@wd} gespeichert. Anschließend kann mit dem |
| 4256 |
% Befehl \cs{allcolumnpar} eine Zeile über alle Spalten der Tabelle ausgegeben |
| 4257 |
% werden. Dabei ist das zu übergebende Argument die Anzahl der zu erzeugenden, |
| 4258 |
% linksbündigen Spalten. |
| 4259 |
% \begin{macrocode} |
| 4260 |
\tud@newglue\tempdim |
| 4261 |
\newsavebox\tabularm@box |
| 4262 |
\tud@newdim\tabularm@wd |
| 4263 |
\newcommand*\tabularm@num{1} |
| 4264 |
\NewEnviron{tabularm}[1]{% |
| 4265 |
\begin{lrbox}{\tabularm@box}% |
| 4266 |
\let\allcolumnpar\@gobble% |
| 4267 |
\begin{tabular}{*{#1}l}\BODY\end{tabular}% |
| 4268 |
\end{lrbox}% |
| 4269 |
\tud@setdim\tabularm@wd{\wd\tabularm@box}% |
| 4270 |
\def\tabularm@num{#1}% |
| 4271 |
\let\allcolumnpar\tabularm@allcolumnpar% |
| 4272 |
\begin{tabular}{*{#1}l}\BODY\end{tabular}% |
| 4273 |
} |
| 4274 |
\newcommand*\tabularm@allcolumnpar[1]{% |
| 4275 |
\multicolumn{\tabularm@num}{@{}p{\tabularm@wd}@{}}{#1}% |
| 4276 |
} |
| 4277 |
% \end{macrocode} |
| 4278 |
% \end{length}^^A \tempdim |
| 4279 |
% \end{length}^^A \tabularm@wd |
| 4280 |
% \end{macro}^^A \tabularm@box |
| 4281 |
% \end{macro}^^A \tabularm@num |
| 4282 |
% \end{macro}^^A \tabularm@allcolumnpar |
| 4283 |
% \end{environment}^^A tabularm |
| 4284 |
% |
| 4285 |
% \subsubsection{Tabelle für mehrsprachigen Bezeichner} |
| 4286 |
% |
| 4287 |
% Mit Hilfe von \pkg{tabularx} können Tabellen bestimmter Breite und |
| 4288 |
% automatisch berechneten Spaltenbreiten gesetzt werden. |
| 4289 |
% \begin{macrocode} |
| 4290 |
\RequirePackage{tabularx} |
| 4291 |
% \end{macrocode} |
| 4292 |
% \begin{macro}{\TermTable} |
| 4293 |
% \begin{macro}{\Term@Table} |
| 4294 |
% \begin{macro}{\Term@@Table} |
| 4295 |
% Für sprachabhängige Bezeichner wird zusätzlich der Befehl \cs{TermTable} |
| 4296 |
% definiert, dem eine kommaseparierte Liste übergeben werden kann. Anhand |
| 4297 |
% dieser Liste werden die enthalten Begriffe für die Sprachen Deutsch und |
| 4298 |
% English in einer Tabelle ausgegeben. Die Sternversion dieses Befehls nutzt |
| 4299 |
% dafür die \env{tabularx}-Umgebung. Für diese kann ein zweites Argument |
| 4300 |
% angegeben werden, welches die gewünschte Breite der Tabelle angibt. |
| 4301 |
% \begin{macrocode} |
| 4302 |
\NewDocumentCommand\TermTable{s m !g}{% |
| 4303 |
\let\tud@templist\relax% |
| 4304 |
\forcsvlist{\listadd\tud@templist}{#2}% |
| 4305 |
\ifhmode\par\fi% |
| 4306 |
\vskip\medskipamount% |
| 4307 |
\@afterindentfalse\@afterheading% |
| 4308 |
\IfBooleanTF{#1}{% |
| 4309 |
\tud@setdim\@tempdima{\IfValueTF{#3}{#3}{\linewidth}}% |
| 4310 |
\tud@setdim\@tempdimc{-.7\baselineskip}% |
| 4311 |
\begin{tabularx}{\@tempdima}{lXX}\Term@Table\end{tabularx}% |
| 4312 |
}{% |
| 4313 |
\tud@setdim\@tempdimc{\z@}% |
| 4314 |
\begin{tabular}{lll}\Term@Table\end{tabular}% |
| 4315 |
}% |
| 4316 |
\par\addvspace{\medskipamount}% |
| 4317 |
} |
| 4318 |
\newcommand*\Term@Table{% |
| 4319 |
\toprule% |
| 4320 |
\textbf{Bezeichner} & \textbf{Deutsch} & \textbf{Englisch}\tabularnewline% |
| 4321 |
\midrule% |
| 4322 |
\forlistloop\Term@@Table{\tud@templist}% |
| 4323 |
\bottomrule% |
| 4324 |
} |
| 4325 |
\newcommand*\Term@@Table[1]{% |
| 4326 |
\Term{#1}'none' & % |
| 4327 |
\tud@if@strempty{\csuse{#1}}{\PName{leer}}{\csuse{#1}} & % |
| 4328 |
\selectlanguage{english}\vspace*{\@tempdimc}% |
| 4329 |
\tud@if@strempty{\csuse{#1}}{\PName{empty}}{\csuse{#1}}\tabularnewline% |
| 4330 |
} |
| 4331 |
% \end{macrocode} |
| 4332 |
% \end{macro}^^A \Term@@Table |
| 4333 |
% \end{macro}^^A \Term@Table |
| 4334 |
% \end{macro}^^A \TermTable |
| 4335 |
% |
| 4336 |
% \subsubsection{Umgebung für die Angabe eines Beispiels} |
| 4337 |
% |
| 4338 |
% \begin{environment}{Example} |
| 4339 |
% \begin{environment}{Example*} |
| 4340 |
% Diese Umgebung wird für die exemplarische Erläuterung von bestimmten Aspekten |
| 4341 |
% im Handbuch verwendet. Wenn dafür ein Quelltextauszug nötig ist, kann |
| 4342 |
% innerhalb dieser die \env{Code}-Umgebung genutzt werden. Die Sternversion |
| 4343 |
% unterdrückt dabei das Zurücksetzen des eigentlich entfernten vertikalen |
| 4344 |
% Abstandes. |
| 4345 |
% \begin{macrocode} |
| 4346 |
\newenvironment{Example}{\csuse{Example*}}{% |
| 4347 |
\csuse{endExample*}% |
| 4348 |
\addvspace{-\topsep}% |
| 4349 |
} |
| 4350 |
\newenvironment{Example*}{% |
| 4351 |
\labeling{{\usekomafont{disposition}{Beispiel:\nobreakspace}}}% |
| 4352 |
\item[{\usekomafont{disposition}{Beispiel:\nobreakspace}}]% |
| 4353 |
}{% |
| 4354 |
\endlabeling% |
| 4355 |
} |
| 4356 |
% \end{macrocode} |
| 4357 |
% \end{environment}^^A Example* |
| 4358 |
% \end{environment}^^A Example |
| 4359 |
% |
| 4360 |
% \iffalse |
| 4361 |
%</class> |
| 4362 |
% \fi |
| 4363 |
% |
| 4364 |
% \subsection{Lesen und Schreiben von Hilfsdateien} |
| 4365 |
% |
| 4366 |
% Für den Anwender werden im \TUDScript-Bundle einige Tutorials mit Hinweisen |
| 4367 |
% zur Nutzung von \LaTeXe{} bereitgestellt. Innerhalb dieser werden Auszüge von |
| 4368 |
% Quelltexten verwendet und erläutert. Zum einen soll die Möglichkeit |
| 4369 |
% geschaffen werden, diese gesammelt am Ende eines Tutorials für ein |
| 4370 |
% Copy"~\&"~Paste"~Beispiel zu verwenden. Andererseits soll auch das sofortige |
| 4371 |
% Ausführen des beschriebenen Quelltextauszuges direkt im Tutorial möglich |
| 4372 |
% sein. |
| 4373 |
% |
| 4374 |
% Dafür werden im Folgenden die Umgebungen \env{Preamble}, \env{Trunk} und |
| 4375 |
% \env{Hint} sowie daraus abgeleitet Varianten definiert, womit sich die Angabe |
| 4376 |
% und Erläuterung der Quelltexte im Tutorial logisch strukturieren lässt und |
| 4377 |
% dennoch die notwendige Ordnung dieser für das Copy"~\&"~Paste"~Beispiel |
| 4378 |
% aufrechterhalten werden kann. Hierfür zeichnen die beiden Umgebungen |
| 4379 |
% \env{Preamble} und \env{Trunk} und deren Derivate verantwortlich. Die |
| 4380 |
% Umgebung \env{Hint} steht für zusätzliche Erläuterungen bereit, welche jedoch |
| 4381 |
% nicht in das Copy"~\&"~Paste"~Beispiel übernommen werden. |
| 4382 |
% |
| 4383 |
% \begin{macro}{\tud@write@a} |
| 4384 |
% \changes{v2.02}{2014/10/22}{neu}^^A |
| 4385 |
% \begin{macro}{\tud@write@b} |
| 4386 |
% \changes{v2.02}{2014/11/02}{neu}^^A |
| 4387 |
% \begin{macro}{\tud@read} |
| 4388 |
% \changes{v2.02}{2014/08/19}{neu}^^A |
| 4389 |
% Für die Erstellung der Indexe wird zum Sortieren das Programm \app{texindy} |
| 4390 |
% genutzt. Für dieses wird eine eigene Stildatei verwendet, welche zur Laufzeit |
| 4391 |
% erzeugt wofür zuerst ein Ausgabestream reserviert wird. |
| 4392 |
% \begin{macrocode} |
| 4393 |
\tud@newwrite\tud@write@a |
| 4394 |
% \end{macrocode} |
| 4395 |
% Für die Tutorials werden später zusätzlich noch ein weiterer Ausgabe- sowie |
| 4396 |
% ein Eingabestream benötigt, die hier gleich mit initialisiert werden. |
| 4397 |
% \begin{macrocode} |
| 4398 |
%<*package> |
| 4399 |
\tud@newwrite\tud@write@b |
| 4400 |
\tud@newread\tud@read |
| 4401 |
%</package> |
| 4402 |
% \end{macrocode} |
| 4403 |
% \end{macro}^^A \tud@read |
| 4404 |
% \end{macro}^^A \tud@write@b |
| 4405 |
% \end{macro}^^A \tud@write@a |
| 4406 |
% |
| 4407 |
% \subsection{Einbinden von Quelltextauszügen} |
| 4408 |
% |
| 4409 |
% Sowohl im Handbuch als auch in den Tutorials werden Quelltextauszüge für das |
| 4410 |
% bessere Verständnis des Anwenders angegeben. Um diese darzustellen wird das |
| 4411 |
% Paket \pkg{listings} verwendet. |
| 4412 |
% \begin{macrocode} |
| 4413 |
\RequirePackage{listings} |
| 4414 |
\lstdefinestyle{tudscr}{% |
| 4415 |
basicstyle=\ttfamily\ifundef{\setstretch}{}{\setstretch{1}},% |
| 4416 |
keywordstyle=,% |
| 4417 |
columns=fullflexible,keepspaces,% |
| 4418 |
aboveskip=\smallskipamount,% |
| 4419 |
belowskip=\smallskipamount,% |
| 4420 |
language=[LaTeX]TeX,% |
| 4421 |
texcl,% |
| 4422 |
} |
| 4423 |
% \end{macrocode} |
| 4424 |
% |
| 4425 |
% \iffalse |
| 4426 |
%<*class> |
| 4427 |
% \fi |
| 4428 |
% |
| 4429 |
% \begin{environment}{Code} |
| 4430 |
% \begin{macro}{\tud@currentHref} |
| 4431 |
% Folgend werden Befehle und Umgebungen für die Darstellung von Quelltexten im |
| 4432 |
% Handbuch definiert. Mit dieser Umgebung können kurze Quelltextbeispiele |
| 4433 |
% ausgegeben werden. Sicherlich sinnvoll ist, die \env{Code}-Umgebung innerhalb |
| 4434 |
% von \env{Example} oder \env{quoting} zu verwenden, um den Quelltext etwas |
| 4435 |
% abzuheben. |
| 4436 |
% \begin{macrocode} |
| 4437 |
\lstnewenvironment{Code}[1][]{\lstset{style=tudscr,#1}}{} |
| 4438 |
% \end{macrocode} |
| 4439 |
% Innerhalb der Umgebung \env{Code} wird \cs{@currentHref} unerwünschter Weise |
| 4440 |
% geändert. Um dies zu vermeiden, wird dieser Befehl gesichert und anschließend |
| 4441 |
% zurückgesetzt. |
| 4442 |
% \begin{macrocode} |
| 4443 |
\newcommand*\tud@currentHref{} |
| 4444 |
\BeforeBeginEnvironment{Code}{\global\let\tud@currentHref\@currentHref} |
| 4445 |
\AfterEndEnvironment{Code}{\global\let\@currentHref\tud@currentHref} |
| 4446 |
% \end{macrocode} |
| 4447 |
% \end{macro}^^A \tud@currentHref |
| 4448 |
% \end{environment}^^A Code |
| 4449 |
% |
| 4450 |
% \iffalse |
| 4451 |
%</class> |
| 4452 |
% \fi |
| 4453 |
% |
| 4454 |
% \subsection{Kompilieren von externen Dateien und Querverweise auf diese} |
| 4455 |
% |
| 4456 |
% Das Paket \pkg{filemod} wird genutzt, um externer Dateien nur zu kompilieren, |
| 4457 |
% wenn dies aufgrund einer Änderung auch notwendig ist. |
| 4458 |
% \begin{macrocode} |
| 4459 |
\RequirePackage{filemod} |
| 4460 |
% \end{macrocode} |
| 4461 |
% Um \cs{ShellEscape} sowohl für Windows als auch für unixoide Betriebssysteme |
| 4462 |
% nutzen zu können, wird das Paket \pkg{ifplatform} geladen. |
| 4463 |
% \begin{macrocode} |
| 4464 |
\RequirePackage{ifplatform} |
| 4465 |
% \end{macrocode} |
| 4466 |
% \begin{macro}{\tud@shellescape@wrn} |
| 4467 |
% \changes{v2.02}{2014/10/14}{neu}^^A |
| 4468 |
% Dieses Makro wird verwendet, wenn eine gesuchte Datei nicht gefunden wurde, |
| 4469 |
% weil das Dokument noch nicht mit dem Schalter \file{-{}-shell-escape} |
| 4470 |
% kompiliert wurde. |
| 4471 |
% \begin{macrocode} |
| 4472 |
\newcommand*\tud@shellescape@wrn[1]{% |
| 4473 |
%<*class> |
| 4474 |
\ClassWarning{tudscrmanual}% |
| 4475 |
%</class> |
| 4476 |
%<*package> |
| 4477 |
\PackageWarning{tudscrmanual}% |
| 4478 |
%</package> |
| 4479 |
{% |
| 4480 |
File `#1' is missing!\MessageBreak% |
| 4481 |
You have to recompile this document with\MessageBreak% |
| 4482 |
activated shell escape option% |
| 4483 |
}% |
| 4484 |
} |
| 4485 |
% \end{macrocode} |
| 4486 |
% \end{macro}^^A \tud@shellescape@wrn |
| 4487 |
% \begin{macro}{\tud@latex@ext} |
| 4488 |
% \changes{v2.06}{2019/06/21}{neu}^^A |
| 4489 |
% Für das verschachtelte Aufrufen von \app{pdflatex} bzw. \app{lualatex}. |
| 4490 |
% \begin{macrocode} |
| 4491 |
\newcommand*\tud@latex@ext{pdflatex\space} |
| 4492 |
\iftutex |
| 4493 |
\ifxetex |
| 4494 |
\renewcommand*\tud@latex@ext{xelatex\space} |
| 4495 |
\else |
| 4496 |
\renewcommand*\tud@latex@ext{lualatex\space} |
| 4497 |
\fi |
| 4498 |
\fi |
| 4499 |
% \end{macrocode} |
| 4500 |
% \end{macro}^^A \tud@latex@ext |
| 4501 |
% \begin{macro}{\Tutorial} |
| 4502 |
% \changes{v2.02}{2014/08/22}{neu}^^A |
| 4503 |
% \changes{v2.02}{2014/10/22}{Reimplementierung}^^A |
| 4504 |
% \begin{macro}{\hypertut} |
| 4505 |
% \changes{v2.02}{2014/09/02}{neu}^^A |
| 4506 |
% Die gegebenenfalls notwendige Kompilierung und die Referenzierung eines |
| 4507 |
% Tutorials aus dem Handbuch erfolgt mit \cs{Tutorial}. Außerdem erfolgt mit |
| 4508 |
% \cs{hypertut} ein verlinkter Eintrag in den Index. |
| 4509 |
% \begin{macrocode} |
| 4510 |
%<*class> |
| 4511 |
\newrobustcmd*\hypertut[2]{% |
| 4512 |
\hyperref{tutorials/#1.pdf}{#1}{tutorials:#1}{\File*{#1.pdf}#2}% |
| 4513 |
} |
| 4514 |
\NewDocumentCommand\Tutorial{s m !d||}{% |
| 4515 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 4516 |
% \end{macrocode} |
| 4517 |
% Um mit den verschachtelten Aufrufen von \app{pdflatex} umgehen zu können, |
| 4518 |
% wird das ganze Prozedere in ein Skript ausgelagert. Somit können die Aufrufe |
| 4519 |
% von \app{pdflatex} für die Tutorials aus dem entsprechenden Ordner und mit |
| 4520 |
% den notwendigen Optionen erfolgen. |
| 4521 |
% \begin{macrocode} |
| 4522 |
\filemodCmp{tutorials/#2.pdf}{tutorials/#2.tex}{}{% |
| 4523 |
\let\@tempa\@empty% |
| 4524 |
\ifdef{\tudfinalflag}{\appto\@tempa{\def\noexpand\tudfinalflag{}}}{}% |
| 4525 |
\ifdef{\tudprintflag}{\appto\@tempa{\def\noexpand\tudprintflag{}}}{}% |
| 4526 |
\appto\@tempa{\noexpand\input{#2.tex}}% |
| 4527 |
\def\@tempb##1{% |
| 4528 |
\immediate\openout\tud@write@a=tutorials.sh\relax% |
| 4529 |
\immediate\write\tud@write@a{cd tutorials^^J##1}% |
| 4530 |
\immediate\closeout\tud@write@a% |
| 4531 |
% \end{macrocode} |
| 4532 |
% Hier erfolgt die Unterscheidung der Befehle für die unterschiedlichen OS. |
| 4533 |
% \begin{macrocode} |
| 4534 |
\ifwindows% |
| 4535 |
\ShellEscape{rename tutorials.sh tutorials.bat}% |
| 4536 |
\ShellEscape{tutorials.bat}% |
| 4537 |
\ShellEscape{del tutorials.bat}% |
| 4538 |
\else% |
| 4539 |
\ShellEscape{bash tutorials.sh}% |
| 4540 |
\ShellEscape{rm tutorials.sh}% |
| 4541 |
\fi% |
| 4542 |
}% |
| 4543 |
\@tempb{\tud@latex@ext -shell-escape "\@tempa"}% |
| 4544 |
\IfFileExists{tutorials/#2.bcf}{\@tempb{biber #2}}{}% |
| 4545 |
\@tempb{% |
| 4546 |
\tud@latex@ext "\@tempa"^^J% |
| 4547 |
\tud@latex@ext -shell-escape "\@tempa"^^J% |
| 4548 |
\tud@latex@ext -shell-escape "\@tempa"% |
| 4549 |
}% |
| 4550 |
}% |
| 4551 |
\fi% |
| 4552 |
% \end{macrocode} |
| 4553 |
% Hyperlink und Indexeintrag. |
| 4554 |
% \begin{macrocode} |
| 4555 |
\IfFileExists{tutorials/#2.pdf}{% |
| 4556 |
\hypertut{#2}{}% |
| 4557 |
}{% |
| 4558 |
\File*{#2.pdf}% |
| 4559 |
\tud@shellescape@wrn{tutorials/#2.pdf}% |
| 4560 |
}% |
| 4561 |
\IfBooleanF{#1}{% |
| 4562 |
\index[files]{\hypertut{#2}{\suffix{Tutorial}}\IfValueT{#3}{|#3}}% |
| 4563 |
}% |
| 4564 |
} |
| 4565 |
%</class> |
| 4566 |
% \end{macrocode} |
| 4567 |
% Der Befehl für die Querverweise innerhalb von Tutorials. |
| 4568 |
% \begin{macrocode} |
| 4569 |
%<*package> |
| 4570 |
\newcommand*\Tutorial[1]{\href{#1.pdf}{\textsbn{#1.pdf}}} |
| 4571 |
%</package> |
| 4572 |
% \end{macrocode} |
| 4573 |
% \end{macro}^^A \hypertut |
| 4574 |
% \end{macro}^^A \Tutorial |
| 4575 |
% \begin{macro}{\IncludeExample} |
| 4576 |
% \changes{v2.02}{2014/07/25}{Skalierung der eingefügten Seiten}^^A |
| 4577 |
% Mit diesem Befehl wird eine \LaTeX-Datei ggf. übersetzt und anschließend als |
| 4578 |
% PDF"~Datei wieder eingebunden. Zuvor wird der dazugehörige Quelltext mittels |
| 4579 |
% \cs{lstinputlisting} im Dokument ausgegeben. Dieser Befehl wird lediglich für |
| 4580 |
% die Klasse \cls{tudscrmanual} benötigt. |
| 4581 |
% \begin{macrocode} |
| 4582 |
%<*class> |
| 4583 |
\newcommand*\IncludeExample[1]{% |
| 4584 |
\lstinputlisting[style=tudscr]{examples/#1}% |
| 4585 |
% \end{macrocode} |
| 4586 |
% Die Beispiele werden nur erneut kompiliert, wenn sich diese geändert haben |
| 4587 |
% oder noch gar kein entsprechendes PDF"~Dokument existiert. |
| 4588 |
% \begin{macrocode} |
| 4589 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 4590 |
\filemodCmp{examples/#1.pdf}{examples/#1.tex}{}{% |
| 4591 |
\ShellEscape{% |
| 4592 |
\tud@latex@ext -output-directory examples examples/#1.tex^^J% |
| 4593 |
\tud@latex@ext -output-directory examples examples/#1.tex% |
| 4594 |
}% |
| 4595 |
}% |
| 4596 |
% \end{macrocode} |
| 4597 |
% Sollte es eine spezielle Version eines beispiels für die Druckausgabe geben, |
| 4598 |
% wird auch dieses kompiliert. |
| 4599 |
% \begin{macrocode} |
| 4600 |
\filemodCmp{examples/#1_print.pdf}{examples/#1_print.tex}{}{% |
| 4601 |
\ShellEscape{% |
| 4602 |
\tud@latex@ext -output-directory examples examples/#1_print.tex^^J% |
| 4603 |
\tud@latex@ext -output-directory examples examples/#1_print.tex% |
| 4604 |
}% |
| 4605 |
}% |
| 4606 |
\fi% |
| 4607 |
% \end{macrocode} |
| 4608 |
% Ist die gesuchte Datei vorhanden, wird diese auch eingebunden. Andernfalls |
| 4609 |
% wird eine Warnung mit dem Hinweis auf die notwendige Verwendung von |
| 4610 |
% \app{pdflatex} mit dem Schalter \file{-{}-shell-escape} erzeugt. |
| 4611 |
% \begin{macrocode} |
| 4612 |
\def\@tempa{examples/#1.pdf}% |
| 4613 |
\ifdef{\tudprintflag}{% |
| 4614 |
\IfFileExists{examples/#1_print.pdf}{\def\@tempa{examples/#1_print.pdf}}{}% |
| 4615 |
}{}% |
| 4616 |
\IfFileExists{\@tempa}{% |
| 4617 |
\edef\@tempa{% |
| 4618 |
\noexpand\includepdf[% |
| 4619 |
pages=-,noautoscale,frame,keepaspectratio,pagecommand={},% |
| 4620 |
height=\noexpand\textheight,width=\noexpand\textwidth,offset=5mm 0mm% |
| 4621 |
]{\@tempa}% |
| 4622 |
}% |
| 4623 |
\@tempa% |
| 4624 |
}{% |
| 4625 |
\tud@shellescape@wrn{\@tempa}% |
| 4626 |
}% |
| 4627 |
} |
| 4628 |
%</class> |
| 4629 |
% \end{macrocode} |
| 4630 |
% \end{macro}^^A \IncludeExample |
| 4631 |
% |
| 4632 |
% \iffalse |
| 4633 |
%<*package> |
| 4634 |
% \fi |
| 4635 |
% |
| 4636 |
% \begin{macro}{\tud@tut@temp} |
| 4637 |
% \changes{v2.05}{2016/05/01}{neu}^^A |
| 4638 |
% \begin{macro}{\tud@tut@readtostream} |
| 4639 |
% \changes{v2.02}{2014/12/16}{neu}^^A |
| 4640 |
% \begin{macro}{\tud@tut@append} |
| 4641 |
% \changes{v2.02}{2014/08/19}{neu}^^A |
| 4642 |
% Bei den Tutorials soll zum Schluss ein komplett kompilierbares Beispiel für |
| 4643 |
% Copy~\&~Paste gegeben werden. Um dieses zusammenzubauen, werden alle im |
| 4644 |
% Dokument innerhalb der Varianten der \env{Trunk}-Umgebungen gegebenen |
| 4645 |
% Codefragmente zusammengesetzt. Um die Quelltexte einlesen und verarbeiten zu |
| 4646 |
% können, werden zwei Eingabe- sowie ein Ausgabestream benötigt, welche bereits |
| 4647 |
% zuvor initialisiert wurden. |
| 4648 |
% |
| 4649 |
% Mit \cs{tud@tut@readtostream} wird der Inhalt der Datei im ersten Argument |
| 4650 |
% in den Ausgabestream des zweiten Argumentes geschrieben. Dies wird durch |
| 4651 |
% \cs{tud@tut@append} genutzt. |
| 4652 |
% \begin{macrocode} |
| 4653 |
\newcommand*\tud@tut@temp{} |
| 4654 |
\edef\tud@tut@temp{\@currname-temp} |
| 4655 |
\newcommand*\tud@tut@readtostream[2]{% |
| 4656 |
\begingroup% |
| 4657 |
\endlinechar=\m@ne\relax% |
| 4658 |
\openin\tud@read=#1% |
| 4659 |
% \end{macrocode} |
| 4660 |
% Der Schalter \cs{if@tempswa} wird verwendet, um unnötige Leerzeilen in der |
| 4661 |
% Ausgabedatei zu entfernen. Wurde eine nicht leere Zeile gefunden, wird diese |
| 4662 |
% auf jeden Fall geschrieben, indem \cs{@tempswatrue} gesetzt wird. Eine leere |
| 4663 |
% Zeile wird~-- bis auf den Sonderfall, dass es sich um die letzte Zeile in der |
| 4664 |
% Datei handelt~-- zunächst nicht weiter beachtet. Im Zweifelsfall wird diese |
| 4665 |
% (erste) Leerzeile geschrieben. |
| 4666 |
% \begin{macrocode} |
| 4667 |
\@tempswafalse% |
| 4668 |
\loop\unless\ifeof\tud@read% |
| 4669 |
\readline\tud@read to\tud@reserved% |
| 4670 |
\ifx\tud@reserved\@empty% |
| 4671 |
\ifeof\tud@read\@tempswafalse\fi% |
| 4672 |
\else% |
| 4673 |
\@tempswatrue% |
| 4674 |
\fi% |
| 4675 |
% \end{macrocode} |
| 4676 |
% Hier erfolgt das eigentliche Schreiben im selektierten Stream. |
| 4677 |
% \begin{macrocode} |
| 4678 |
\if@tempswa% |
| 4679 |
\immediate\write#2{\expandonce\tud@reserved}% |
| 4680 |
\fi% |
| 4681 |
% \end{macrocode} |
| 4682 |
% Im Nachgang wird überprüft, ob die aktuell geschriebene Zeile leer war. Ist |
| 4683 |
% dies der Fall, so wird \cs{@tempswafalse} gesetzt, um eine etwaig folgende |
| 4684 |
% Leerzeile nicht in die Ausgabedatei zu schrieben. |
| 4685 |
% \begin{macrocode} |
| 4686 |
\ifx\tud@reserved\@empty\@tempswafalse\fi% |
| 4687 |
\repeat% |
| 4688 |
\closein\tud@read% |
| 4689 |
\endgroup% |
| 4690 |
} |
| 4691 |
% \end{macrocode} |
| 4692 |
% Der innerhalb der Umgebungen \env{Preamble} und \env{Trunk}~-- sowie deren |
| 4693 |
% Derivaten~-- angegebene Inhalt wird beim Schließen dieser Umgebungen in die |
| 4694 |
% Hilfsdatei \cs{tud@[email protected]} zwischengespeichert. Mit \cs{tud@tut@append} |
| 4695 |
% wird der Inhalt dieser Datei ausgelesen und den Hilfsdateien |
| 4696 |
% \cs{tud@[email protected]} respektive \cs{tud@[email protected]} |
| 4697 |
% angehangen und damit gesichert, um die jeweiligen Quelltextauszüge aus dem |
| 4698 |
% Tutorial für die Präambel sowie den Dokumentteil trennen beziehungsweise |
| 4699 |
% sortieren zu können. |
| 4700 |
% \begin{macrocode} |
| 4701 |
\newcommand*\tud@tut@append[1]{% |
| 4702 |
\tud@if@strequal{#1}{preamble}{% |
| 4703 |
\tud@tut@readtostream{\tud@[email protected]}{\tud@write@a}% |
| 4704 |
}{% |
| 4705 |
\tud@if@strequal{#1}{trunk}{% |
| 4706 |
\tud@tut@readtostream{\tud@[email protected]}{\tud@write@b}% |
| 4707 |
}{% |
| 4708 |
\tud@tut@readtostream{\tud@[email protected]}{#1}% |
| 4709 |
}% |
| 4710 |
}% |
| 4711 |
} |
| 4712 |
% \end{macrocode} |
| 4713 |
% \end{macro}^^A \tud@tut@append |
| 4714 |
% \end{macro}^^A \tud@tut@readtostream |
| 4715 |
% \end{macro}^^A \tud@tut@temp |
| 4716 |
% \begin{macro}{\StartTutorial} |
| 4717 |
% \changes{v2.02}{2014/08/21}{neu}^^A |
| 4718 |
% \begin{macro}{\FinishTutorial} |
| 4719 |
% \changes{v2.02}{2014/08/21}{neu}^^A |
| 4720 |
% Mit \cs{StartTutorial} wird ein Hyperlink für den Querverweis aus dem |
| 4721 |
% Handbuch definiert. Außerdem wird gleich der Titel und~-- falls im optionalen |
| 4722 |
% Argument angegeben~-- eine Zusammenfassung gesetzt. Die Sternversion gibt |
| 4723 |
% nach der optionalen Beschreibung einen einleitenden Satz zur Dokumnentklasse |
| 4724 |
% und sinnvollen Paketen an. Diese sollten direkt nach \cs{StartTutorial} in |
| 4725 |
% der \env{Preamble}-Umgebung angegeben werden. |
| 4726 |
% \begin{macrocode} |
| 4727 |
\TUDoptions{headingsvskip=-6ex} |
| 4728 |
\newcommand\StartTutorial[1][]{% |
| 4729 |
\immediate\openout\tud@write@a=\tud@[email protected]\relax% |
| 4730 |
\immediate\openout\tud@write@b=\tud@[email protected]\relax% |
| 4731 |
\immediate\write\tud@write@b{^^J\string\begin{document}^^J}% |
| 4732 |
\Hy@raisedlink{\hyperdef{\jobname}{tutorials:\jobname}{}}% |
| 4733 |
\faculty{}% |
| 4734 |
\maketitle% |
| 4735 |
\IfArgIsEmpty{#1}{}{% |
| 4736 |
\noindent% |
| 4737 |
\begin{abstract}% |
| 4738 |
\noindent#1% |
| 4739 |
\end{abstract}% |
| 4740 |
\medskip% |
| 4741 |
}% |
| 4742 |
\noindent\ignorespaces% |
| 4743 |
} |
| 4744 |
% \end{macrocode} |
| 4745 |
% Der Befehl \cs{FinishTutorial} schleißt den noch offenen Ausgabestream und |
| 4746 |
% gibt den vorgestellten Quelltext vollständig aus. |
| 4747 |
% \begin{macrocode} |
| 4748 |
\newcommand\FinishTutorial[1][]{% |
| 4749 |
\immediate\write\tud@write@b{^^J\string\end{document}^^J}% |
| 4750 |
\immediate\closeout\tud@write@b% |
| 4751 |
\immediate\closeout\tud@write@a% |
| 4752 |
\immediate\openout\tud@write@a\jobname-example.tex\relax% |
| 4753 |
\tud@tut@readtostream{\tud@[email protected]}{\tud@write@a}% |
| 4754 |
\tud@tut@readtostream{\tud@[email protected]}{\tud@write@a}% |
| 4755 |
\immediate\closeout\tud@write@a% |
| 4756 |
\clearpage% |
| 4757 |
\addsec{Copy\nobreakspace\&\nobreakspace{}Paste}% |
| 4758 |
\thispagestyle{empty}% |
| 4759 |
\pagestyle{empty}% |
| 4760 |
Zum Ende des Dokumentes wird das vorgestellte Tutorial als \"ubersetzbarer |
| 4761 |
Quelltext ausgegeben, um dieses via Copy~\&~Paste verwenden und alle Punkte |
| 4762 |
nachvollziehen zu k\"onnen. Bitte beachten Sie, dass~-- abh\"angig vom |
| 4763 |
genutzten PDF-Betrachter~-- beim Kopieren die dargestellten Einz\"uge und |
| 4764 |
Abs\"atze m\"oglicherweise verloren gehen k\"onnen. Dies kann insbesondere |
| 4765 |
aufgrund fehlender Leerzeilen zu einem unvorteilhaften Ausgabeergebnis |
| 4766 |
f\"uhren. Alternativ finden Sie den folgenden \hologo{LaTeX}-Quelltext auch |
| 4767 |
im Pfad \Path{\PName{texmf}/source/latex/tudscr/doc/examples/} als Datei |
| 4768 |
\File{\jobname-example.tex}. \par #1% |
| 4769 |
% |
| 4770 |
\begin{quoting}[rightmargin=0pt]% |
| 4771 |
\lstinputlisting[style=tudscr]{\jobname-example.tex}% |
| 4772 |
\end{quoting}% |
| 4773 |
% |
| 4774 |
% \end{macrocode} |
| 4775 |
% Falls es möglich ist, werden nach dem Durchlauf alle nicht mehr benötigten |
| 4776 |
% Hilfsdateien gelöscht. |
| 4777 |
% \begin{macrocode} |
| 4778 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 4779 |
\ifwindows% |
| 4780 |
\def\@tempa{del}% |
| 4781 |
\else% |
| 4782 |
\def\@tempa{rm}% |
| 4783 |
\fi% |
| 4784 |
\ShellEscape{\@tempa\space\tud@tut@temp*.*}% |
| 4785 |
\fi% |
| 4786 |
} |
| 4787 |
% \end{macrocode} |
| 4788 |
% \end{macro}^^A \FinishTutorial |
| 4789 |
% \end{macro}^^A \StartTutorial |
| 4790 |
% \begin{macro}{\CodePreamble} |
| 4791 |
% \changes{v2.02}{2014/08/20}{neu}^^A |
| 4792 |
% \begin{macro}{\Code@Preamble} |
| 4793 |
% \changes{v2.02}{2014/10/22}{neu}^^A |
| 4794 |
% \begin{macro}{\CodeHook} |
| 4795 |
% \changes{v2.02}{2014/10/11}{neu}^^A |
| 4796 |
% \begin{macro}{\Code@Hook} |
| 4797 |
% \changes{v2.02}{2014/10/11}{neu}^^A |
| 4798 |
% Bereitstellung von Hilfsmakros für die formatierte Ausgabe von Quelltexten. |
| 4799 |
% \begin{macrocode} |
| 4800 |
\newcommand\Code@Preamble{} |
| 4801 |
\let\Code@Preamble\relax |
| 4802 |
\newcommand\CodePreamble[1]{% |
| 4803 |
\long\gdef\Code@Preamble{% |
| 4804 |
\hskip.5\leftmargin\textit{Die resultierende Ausgabe:}\space#1% |
| 4805 |
}% |
| 4806 |
} |
| 4807 |
\newcommand*\Code@Hook{} |
| 4808 |
\let\Code@Hook\relax |
| 4809 |
\newcommand*\CodeHook[1]{\gdef\Code@Hook{#1}} |
| 4810 |
% \end{macrocode} |
| 4811 |
% \end{macro}^^A \Code@Hook |
| 4812 |
% \end{macro}^^A \CodeHook |
| 4813 |
% \end{macro}^^A \Code@Preamble |
| 4814 |
% \end{macro}^^A \CodePreamble |
| 4815 |
% \begin{macro}{\StandaloneFile} |
| 4816 |
% \changes{v2.02}{2014/08/19}{neu}^^A |
| 4817 |
% \begin{macro}{\StandaloneDate} |
| 4818 |
% \changes{v2.05}{2015/11/18}{neu}^^A |
| 4819 |
% Die Umgebungen \env{Trunk!} und \env{Hint!} erzeugen nach der Ausgabe des |
| 4820 |
% Quelltextes mit dem Makro \cs{tud@tut@pdf} eine PDF-Datei, welche mit |
| 4821 |
% \cs{IncludeStandalone} in das Tutorial eingebunden werden kann. |
| 4822 |
% \begin{macrocode} |
| 4823 |
\newcommand*\StandaloneFile{} |
| 4824 |
\let\StandaloneFile\relax |
| 4825 |
\newcommand*\StandaloneDate{} |
| 4826 |
% \end{macrocode} |
| 4827 |
% \end{macro}^^A \StandaloneDate |
| 4828 |
% \end{macro}^^A \StandaloneFile |
| 4829 |
% \begin{macro}{\filec@ntents@silent} |
| 4830 |
% \changes{v2.06e}{2019/10/10}{neu}^^A |
| 4831 |
% Die Umgebungen \env{Preamble}, \env{Trunk} und \env{Hint} sowie deren |
| 4832 |
% Varianten nutzen die Umgebung \env{filecontents}, um ihren Inhalt in eine |
| 4833 |
% temporäre Datei zu schreiben und diese direkt mit dem Paket \pkg{listings} |
| 4834 |
% darzustellen sowie ggf. den Quelltext auszuführen. Beim Überschreiben einer |
| 4835 |
% Datei wird für gewöhnlich eine Warnung erzeugt. Dies wird mit dem eigens |
| 4836 |
% definierten Parameter \prm{silent} unterbunden. |
| 4837 |
% \begin{macrocode} |
| 4838 |
\providecommand*\filec@ntents@silent{% |
| 4839 |
\let\@latex@warning@no@line\@gobble% |
| 4840 |
} |
| 4841 |
% \end{macrocode} |
| 4842 |
% \end{macro}^^A \filec@ntents@silent |
| 4843 |
% \begin{macro}{\tud@tut@pre} |
| 4844 |
% \changes{v2.02}{2014/08/19}{neu}^^A |
| 4845 |
% \begin{macro}{\tud@tut@post} |
| 4846 |
% \changes{v2.02}{2014/08/19}{neu}^^A |
| 4847 |
% Dies sind Hilfsmakros, welche zu Beginn und Ende der Quelltextumgebungen |
| 4848 |
% \env{Preamble}, \env{Trunk} und \env{Hint} für das Sichern der Inhalte in |
| 4849 |
% eine Hilfsdatei verantwortlich sind, wofür die \env{filecontents}-Umgebung |
| 4850 |
% genutzt wird. |
| 4851 |
% \begin{macrocode} |
| 4852 |
\newcommand*\tud@tut@pre{% |
| 4853 |
\csuse{filecontents*}[force,silent,nosearch]{\tud@[email protected]}% |
| 4854 |
} |
| 4855 |
\newcommand*\tud@tut@post{% |
| 4856 |
\csuse{endfilecontents*}% |
| 4857 |
} |
| 4858 |
% \end{macrocode} |
| 4859 |
% \end{macro}^^A \tud@tut@post |
| 4860 |
% \end{macro}^^A \tud@tut@pre |
| 4861 |
% Die nachfolgenden Umgebungen verwenden die beiden, gerade zuvor eingeführten |
| 4862 |
% Hilfsmakros \cs{tud@tut@pre} und \cs{tud@tut@post}, welche den gegebenen |
| 4863 |
% Inhalt in die temporäre Datei \file{\string\tud@[email protected]} schreiben. Die |
| 4864 |
% im Dokument in den Umgebungen gesetzten Quelltextauszüge werden mit dem Makro |
| 4865 |
% \cs{tud@tut@append}~-- abhängig vom gegebenen Argument~-- zusätzlich für ein |
| 4866 |
% Copy"~\&"~Paste"~Beispiel in \file{\string\tud@[email protected]} oder |
| 4867 |
% \file{\string\tud@[email protected]} gepsiechert. Die damit gesammelten |
| 4868 |
% Inhalte werden am Ende mit \cs{FinishTutorial} ausgegeben. |
| 4869 |
% \begin{environment}{Preamble} |
| 4870 |
% \changes{v2.02}{2014/11/02}{neu}^^A |
| 4871 |
% \begin{environment}{Preamble*} |
| 4872 |
% \changes{v2.02}{2014/11/03}{neu}^^A |
| 4873 |
% \begin{environment}{Preamble+} |
| 4874 |
% \changes{v2.02}{2014/11/03}{neu}^^A |
| 4875 |
% Die Umgebung \env{Preamble} dient für die Ausgabe von Quelltextauszügenen, |
| 4876 |
% welche in einem \LaTeXe-Dokument in der Präambel verwendet werden müssen oder |
| 4877 |
% sollten. Die in ihr gesetzten Inhalte werden für das Copy"~\&"~Paste-Beispiel |
| 4878 |
% vor den Inhalten aus der Umgebung \env{Trunk} ausgegeben. Die Sternversion |
| 4879 |
% führt den Inhalt zusätzlich im Dokument aus. Die Pluszechen"=Version fügt dem |
| 4880 |
% Ausgabestream ihren Inhalt hinzu, ohne das dieser ausgegeben oder ausgeführt |
| 4881 |
% wird. |
| 4882 |
% \begin{macrocode} |
| 4883 |
\newenvironment{Preamble}{\tud@tut@pre}{% |
| 4884 |
\tud@tut@post% |
| 4885 |
\tud@tut@append{preamble}% |
| 4886 |
\gdef\@tempa{% |
| 4887 |
\tud@tut@lst% |
| 4888 |
\global\let\Code@Preamble\relax% |
| 4889 |
}% |
| 4890 |
\aftergroup\@tempa% |
| 4891 |
} |
| 4892 |
\newenvironment{Preamble*}{\tud@tut@pre}{% |
| 4893 |
\tud@tut@post% |
| 4894 |
\tud@tut@append{preamble}% |
| 4895 |
\gdef\@tempa{% |
| 4896 |
\tud@tut@lst% |
| 4897 |
\tud@tut@input% |
| 4898 |
\global\let\Code@Preamble\relax% |
| 4899 |
}% |
| 4900 |
\aftergroup\@tempa% |
| 4901 |
} |
| 4902 |
\newenvironment{Preamble+}{\tud@tut@pre}{% |
| 4903 |
\tud@tut@post% |
| 4904 |
\tud@tut@append{preamble}% |
| 4905 |
\gdef\@tempa{% |
| 4906 |
\global\let\Code@Preamble\relax% |
| 4907 |
}% |
| 4908 |
\aftergroup\@tempa% |
| 4909 |
} |
| 4910 |
% \end{macrocode} |
| 4911 |
% \end{environment}^^A Preamble+ |
| 4912 |
% \end{environment}^^A Preamble* |
| 4913 |
% \end{environment}^^A Preamble |
| 4914 |
% \begin{environment}{Trunk} |
| 4915 |
% \changes{v2.02}{2014/08/16}{neu}^^A |
| 4916 |
% \begin{environment}{Trunk*} |
| 4917 |
% \changes{v2.02}{2014/08/19}{neu}^^A |
| 4918 |
% \begin{environment}{Trunk+} |
| 4919 |
% \changes{v2.02}{2014/11/03}{neu}^^A |
| 4920 |
% \begin{environment}{Trunk!} |
| 4921 |
% \changes{v2.02}{2014/10/07}{neu}^^A |
| 4922 |
% Die Umgebung \env{Trunk} dient zur Ausgabe von exemplarischen Quelltexten, |
| 4923 |
% welche in einem \LaTeXe-Dokument innerhalb der \env{document}-Umgebung |
| 4924 |
% verwendet werden müssen oder sollten. Für das Copy"~\&"~Paste-Beispiel werden |
| 4925 |
% die gegebenen Inhalte nach den Inhalten aus der Umgebung \env{Preamble} |
| 4926 |
% ausgegeben. Die Sternversion der Umgebung führt ihren Inhalt zusätzlich im |
| 4927 |
% Dokument aus. Die Pluszeichen"=Version fügt dem Ausgabestream ihren Inhalt |
| 4928 |
% hinzu, ohne diesen auszugeben oder auszuführen. Die Ausrufezeichen"=Version |
| 4929 |
% fügt den Quelltext im Dokument ein und führt diesen zusätzlich in einer |
| 4930 |
% separaten Datei mit einem minimalen Dokumentkörper aus, um daraus eine |
| 4931 |
% PDF-Datei zu erzeugen, welche im Nachhinein mit \cs{IncludeStandalone} als |
| 4932 |
% Grafik eingebunden werden kann. Dies ist für Quelltextabschnitte gedacht, |
| 4933 |
% deren Ausgabe zu groß ist, um diese direkt anzuzeigen und dennoch dargestellt |
| 4934 |
% werden sollen. |
| 4935 |
% \begin{macrocode} |
| 4936 |
\newenvironment{Trunk}{\tud@tut@pre}{% |
| 4937 |
\tud@tut@post% |
| 4938 |
\tud@tut@append{trunk}% |
| 4939 |
\gdef\@tempa{% |
| 4940 |
\tud@tut@lst% |
| 4941 |
\global\let\Code@Preamble\relax% |
| 4942 |
}% |
| 4943 |
\aftergroup\@tempa% |
| 4944 |
} |
| 4945 |
\newenvironment{Trunk*}{\tud@tut@pre}{% |
| 4946 |
\tud@tut@post% |
| 4947 |
\tud@tut@append{trunk}% |
| 4948 |
\gdef\@tempa{% |
| 4949 |
\tud@tut@lst% |
| 4950 |
\tud@tut@input% |
| 4951 |
\global\let\Code@Preamble\relax% |
| 4952 |
}% |
| 4953 |
\aftergroup\@tempa% |
| 4954 |
} |
| 4955 |
\newenvironment{Trunk+}{\tud@tut@pre}{% |
| 4956 |
\tud@tut@post% |
| 4957 |
\tud@tut@append{trunk}% |
| 4958 |
\gdef\@tempa{% |
| 4959 |
\global\let\Code@Preamble\relax% |
| 4960 |
}% |
| 4961 |
\aftergroup\@tempa% |
| 4962 |
} |
| 4963 |
\newenvironment{Trunk!}[1]{% |
| 4964 |
\gdef\StandaloneFile{#1}% |
| 4965 |
\tud@tut@pre% |
| 4966 |
}{% |
| 4967 |
\tud@tut@post% |
| 4968 |
\tud@tut@append{trunk}% |
| 4969 |
\gdef\@tempa{% |
| 4970 |
\tud@tut@lst% |
| 4971 |
\tud@tut@pdf% |
| 4972 |
\global\let\Code@Preamble\relax% |
| 4973 |
}% |
| 4974 |
\aftergroup\@tempa% |
| 4975 |
} |
| 4976 |
% \end{macrocode} |
| 4977 |
% \end{environment}^^A Trunk! |
| 4978 |
% \end{environment}^^A Trunk+ |
| 4979 |
% \end{environment}^^A Trunk* |
| 4980 |
% \end{environment}^^A Trunk |
| 4981 |
% \begin{environment}{Hint} |
| 4982 |
% \changes{v2.02}{2014/09/16}{neu}^^A |
| 4983 |
% \begin{environment}{Hint*} |
| 4984 |
% \changes{v2.02}{2014/10/13}{neu}^^A |
| 4985 |
% \begin{environment}{Hint?} |
| 4986 |
% \changes{v2.02}{2014/12/09}{neu}^^A |
| 4987 |
% \begin{environment}{Hint!} |
| 4988 |
% \changes{v2.02}{2014/11/13}{neu}^^A |
| 4989 |
% Um Quelltextausschnitte zur weiterführenden Information anzugeben, wird die |
| 4990 |
% Umgebung \env{Hint} definiert. Der Inhalt wird ausgegben und~-- falls die |
| 4991 |
% Sternversion genutzt wurde~-- auch ausgeführt, allerdings nicht in das |
| 4992 |
% Copy"~\&"~Paste"~Beispiel übernommen. Ansonsten entsprechen alle Umgebungen |
| 4993 |
% in ihren Eigenschaften den äquivalenten \env{Trunk}-Umgebungen. Die Version |
| 4994 |
% mit Fragezeichen ist für Quelltextauszüge gedacht, die ungeprüft \emph{vor} |
| 4995 |
% dessen Ausgabe ausgeführt werden sollen. |
| 4996 |
% \begin{macrocode} |
| 4997 |
\newenvironment{Hint}{\tud@tut@pre}{% |
| 4998 |
\tud@tut@post% |
| 4999 |
\gdef\@tempa{% |
| 5000 |
\tud@tut@lst% |
| 5001 |
\global\let\Code@Preamble\relax% |
| 5002 |
}% |
| 5003 |
\aftergroup\@tempa% |
| 5004 |
} |
| 5005 |
\newenvironment{Hint*}{\tud@tut@pre}{% |
| 5006 |
\tud@tut@post% |
| 5007 |
\gdef\@tempa{% |
| 5008 |
\tud@tut@lst% |
| 5009 |
\tud@tut@input% |
| 5010 |
\global\let\Code@Preamble\relax% |
| 5011 |
}% |
| 5012 |
\aftergroup\@tempa% |
| 5013 |
} |
| 5014 |
\newenvironment{Hint?}{\tud@tut@pre}{% |
| 5015 |
\tud@tut@post% |
| 5016 |
\gdef\@tempa{% |
| 5017 |
\InputCode% |
| 5018 |
\tud@tut@lst% |
| 5019 |
\global\let\Code@Preamble\relax% |
| 5020 |
}% |
| 5021 |
\aftergroup\@tempa% |
| 5022 |
} |
| 5023 |
\newenvironment{Hint!}[1]{% |
| 5024 |
\gdef\StandaloneFile{#1}% |
| 5025 |
\tud@tut@pre% |
| 5026 |
}{% |
| 5027 |
\tud@tut@post% |
| 5028 |
\gdef\@tempa{% |
| 5029 |
\tud@tut@lst% |
| 5030 |
\tud@tut@pdf% |
| 5031 |
\global\let\Code@Preamble\relax% |
| 5032 |
}% |
| 5033 |
\aftergroup\@tempa% |
| 5034 |
} |
| 5035 |
% \end{macrocode} |
| 5036 |
% \end{environment}^^A Hint! |
| 5037 |
% \end{environment}^^A Hint? |
| 5038 |
% \end{environment}^^A Hint* |
| 5039 |
% \end{environment}^^A Hint |
| 5040 |
% \begin{macro}{\tud@tut@lst} |
| 5041 |
% \changes{v2.02}{2014/10/07}{neu}^^A |
| 5042 |
% Damit wird der Quelltext eingezogen ausgegeben. |
| 5043 |
% \begin{macrocode} |
| 5044 |
\newcommand*\tud@tut@lst{% |
| 5045 |
\begin{quoting}[rightmargin=0pt]% |
| 5046 |
\lstinputlisting[style=tudscr]{\tud@[email protected]}% |
| 5047 |
\end{quoting}% |
| 5048 |
} |
| 5049 |
% \end{macrocode} |
| 5050 |
% \end{macro}^^A \tud@tut@lst |
| 5051 |
% \begin{macro}{\tud@tut@input} |
| 5052 |
% \changes{v2.02}{2014/10/13}{neu}^^A |
| 5053 |
% Für die Ausgabe des Quelltextergebnisses erfolgt ein linker Einzug. Außerdem |
| 5054 |
% werden unter anderem abhängig von der Verwendung eines erklärenden Textes die |
| 5055 |
% eingefügten vertikalen Abstände angepasst. |
| 5056 |
% \begin{macrocode} |
| 5057 |
\newcommand*\tud@tut@input{% |
| 5058 |
% \end{macrocode} |
| 5059 |
% Nach dem Ausführen des ersten Argumentes von \cs{@tempa} wird geprüft, ob |
| 5060 |
% dieses überhaupt eine sichtbare Ausgabe erzeugt hat. Nur für diesen Fall wird |
| 5061 |
% nach dieser vertikaler Leerraum eingefügt. Der Anfang entspricht prinzipiell |
| 5062 |
% dem Standardbefehl \cs{settoheight}, jedoch wird im Inneren zusätzlich eine |
| 5063 |
% \cs{vbox} verwendet, um damit auch mathematische Umgebungen testen zu können. |
| 5064 |
% Das Ganze findet innerhalb einer Gruppierung statt, um keine Änderungen zu |
| 5065 |
% erzeugen. |
| 5066 |
% \begin{macrocode} |
| 5067 |
\def\@tempa##1##2{% |
| 5068 |
##1% |
| 5069 |
\begingroup% |
| 5070 |
##2% |
| 5071 |
\setbox\@tempboxa\hbox{\vbox{##1}}% |
| 5072 |
\@tempdima=\ht\@tempboxa% |
| 5073 |
\setbox\@tempboxa\box\voidb@x% |
| 5074 |
\ifdim\@tempdima>\z@\relax% |
| 5075 |
\endgraf% |
| 5076 |
\vspace{\medskipamount}% |
| 5077 |
\noindent\ignorespaces% |
| 5078 |
\fi% |
| 5079 |
\endgroup% |
| 5080 |
}% |
| 5081 |
% \end{macrocode} |
| 5082 |
% Da aufgrund der Verwendung der \env{filecontents}-Umgebung ein optionales |
| 5083 |
% Argument für alle Abwandlungen der Quelltextumgebungen nicht möglich ist, |
| 5084 |
% wird \cs{CodePreamble} bereitgestellt, womit der Ausgabe ein erläuternder |
| 5085 |
% Text vorangestellt werden kann. |
| 5086 |
% \begin{macrocode} |
| 5087 |
\@tempa{\Code@Preamble}{}% |
| 5088 |
\tud@setdim\@tempdimc{\leftskip}% |
| 5089 |
\tud@setdim\leftskip{\leftmargin}% |
| 5090 |
% \end{macrocode} |
| 5091 |
% Durch die zweimalige Verwendung von \file{\string\tud@[email protected]}~-- einmal |
| 5092 |
% direkt und einmal innerhalb einer Box~-- können darin verwendete Befehle wie |
| 5093 |
% \cs{newcommand} zu Fehler führen. Mit dem Makro \cs{CodeHook} lassen sich |
| 5094 |
% diese Konflikte durch eine lokale Redefinition ebensolcher Befehle auflösen |
| 5095 |
% (bspw. \cs{let}\cs{newcommand}\cs{renewcommand}). |
| 5096 |
% \begin{macrocode} |
| 5097 |
\@tempa{\input{\tud@[email protected]}}{\Code@Hook}% |
| 5098 |
\global\let\Code@Hook\relax% |
| 5099 |
\tud@setdim\leftskip{\@tempdimc}% |
| 5100 |
\noindent\ignorespaces% |
| 5101 |
} |
| 5102 |
% \end{macrocode} |
| 5103 |
% \end{macro}^^A \tud@tut@input |
| 5104 |
% \begin{macro}{\InputCode} |
| 5105 |
% \changes{v2.02}{2014/10/21}{neu}^^A |
| 5106 |
% Mit \cs{InputCode} kann der Inhalt der letzen \env{Trunk}-Umgebung |
| 5107 |
% direkt ausgeführt werden, ohne diesen zuvor mit \cs{tud@tut@input} zu prüfen |
| 5108 |
% und zu formatieren. |
| 5109 |
% \begin{macrocode} |
| 5110 |
\newcommand*\InputCode{\input{\tud@[email protected]}} |
| 5111 |
% \end{macrocode} |
| 5112 |
% \end{macro}^^A \InputCode |
| 5113 |
% \begin{macro}{\tud@tut@pdf} |
| 5114 |
% \changes{v2.02}{2014/10/22}{neu}^^A |
| 5115 |
% Die Umgebungen \env{Trunk!} und \env{Hint!} verwenden nach der Ausgabe des |
| 5116 |
% Quelltextes diesen abermals, um daraus eine PDF-Datei zu erzeugen. Dafür wird |
| 5117 |
% eine temporäre \LaTeX-Datei mithilfe einer \env{filecontents}-Umgebung |
| 5118 |
% erzeugt. Diese bindet die mit \env{Trunk!} erzeugte Datei ein und wird |
| 5119 |
% anschließend via \cs{ShellEscape} kompiliert. Dabei sollte man sich nicht von |
| 5120 |
% der doppelten Verwendung von \cs{jobname} verwirren lassen. Der Dateiname der |
| 5121 |
% temporär erzeugten \LaTeX-Datei ist abhängig vom gesetzten Tutorial. Beim |
| 5122 |
% Aufruf dieser wird über die Optionen von \app{pdflatex} der verwendete |
| 5123 |
% \cs{jobname} angepasst (siehe \cs{tud@tut@pdf}). |
| 5124 |
% \begin{macrocode} |
| 5125 |
\IfFileExists{\tud@[email protected]}{\@tempswafalse}{\@tempswatrue} |
| 5126 |
\if@tempswa% |
| 5127 |
\begin{filecontents*}{\tud@[email protected]} |
| 5128 |
\documentclass[english,ngerman]{tudscrreprt} |
| 5129 |
\iftutex |
| 5130 |
\usepackage{fontspec} |
| 5131 |
\else |
| 5132 |
\usepackage[T1]{fontenc} |
| 5133 |
\usepackage[ngerman=ngerman-x-latest]{hyphsubst} |
| 5134 |
\fi |
| 5135 |
\usepackage{babel} |
| 5136 |
\usepackage{tudscrsupervisor} |
| 5137 |
\usepackage{isodate} |
| 5138 |
\usepackage{enumitem} |
| 5139 |
\setlist{noitemsep} |
| 5140 |
\begin{document} |
| 5141 |
\ifdefvoid{\StandaloneDate}{}{\date{\StandaloneDate}}% |
| 5142 |
\input{\jobname.tex}% |
| 5143 |
\end{document} |
| 5144 |
\end{filecontents*} |
| 5145 |
\fi |
| 5146 |
% \end{macrocode} |
| 5147 |
% Der Quelltext aus den Umgebungen \env{Trunk!} und \env{Hint!} wird~-- wie bei |
| 5148 |
% allen anderen \env{Trunk}-Derivaten~-- in \file{\string\tud@[email protected]} |
| 5149 |
% gesichert. Beim Aufruf von \app{pdflatex} wird durch die Nutzung der Option |
| 5150 |
% \file{-jobname=\string\tud@tut@temp} die Definition von \cs{jobname} in der |
| 5151 |
% aufgerufenen Datei \file{\string\tud@[email protected]} überschrieben |
| 5152 |
% und der Inhalt von \file{\string\tud@[email protected]} wie gewünscht eingebunden |
| 5153 |
% und kompiliert. Damit die so erstellte PDF-Datei mit \cs{IncludeStandalone} |
| 5154 |
% im weiteren Verlauf in das Tutorial eingebunden werden kann, wird diese |
| 5155 |
% außerdem noch in \file{\meta{Argument}-temp.pdf} umbenannt. Das Makro |
| 5156 |
% \cs{StandaloneDate} wird auf das Datum der Master-Datei gesetzt, damit das |
| 5157 |
% voreingestellte Datum der erzeugten Datei angepasst werden kann. |
| 5158 |
% \begin{macrocode} |
| 5159 |
\newcommand*\tud@tut@pdf{% |
| 5160 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 5161 |
\filemodCmp{\jobname-standalone-\StandaloneFile.pdf}{\jobname.tex}{}{% |
| 5162 |
\begingroup% |
| 5163 |
\let\printdate\@firstofone% |
| 5164 |
\edef\@tempa{\expandonce\@date}% |
| 5165 |
\def\@tempb{\today}% |
| 5166 |
\ifx\@tempa\@tempb\relax% |
| 5167 |
\let\@tempb\@empty% |
| 5168 |
\else% |
| 5169 |
\edef\@tempb{\unexpanded{\def\StandaloneDate}{\@date}}% |
| 5170 |
\fi% |
| 5171 |
\edef\@tempa{% |
| 5172 |
\tud@latex@ext -jobname=\tud@tut@temp\space% |
| 5173 |
"\noexpand\unexpanded{\expandonce\@tempb\noexpand\input}% |
| 5174 |
{\tud@[email protected]}"% |
| 5175 |
}% |
| 5176 |
\ShellEscape{\@tempa^^J\@tempa^^J\@tempa}% |
| 5177 |
\ifwindows% |
| 5178 |
\def\@tempa{rename}% |
| 5179 |
\else% |
| 5180 |
\def\@tempa{mv}% |
| 5181 |
\fi% |
| 5182 |
\ShellEscape{% |
| 5183 |
\@tempa\space\tud@[email protected]\space% |
| 5184 |
\jobname-standalone-\StandaloneFile.pdf% |
| 5185 |
}% |
| 5186 |
\endgroup% |
| 5187 |
}% |
| 5188 |
\fi% |
| 5189 |
\global\let\StandaloneFile\relax% |
| 5190 |
} |
| 5191 |
% \end{macrocode} |
| 5192 |
% \end{macro}^^A \tud@tut@pdf |
| 5193 |
% \begin{macro}{\IncludeStandalone} |
| 5194 |
% \changes{v2.02}{2014/09/10}{neu}^^A |
| 5195 |
% Der Befehl \cs{IncludeStandalone} bindet die durch \env{Trunk!} generierten |
| 5196 |
% PDF-Dateien ein. Das angehängte optionale Argument dient zur Angabe der |
| 5197 |
% einzubindenden Seiten der PDF-Datei, wobei diese automatisch auf die passende |
| 5198 |
% Breite skaliert werden. |
| 5199 |
% \begin{macrocode} |
| 5200 |
\NewDocumentCommand\IncludeStandalone{o m !O{1}}{% |
| 5201 |
\IfFileExists{\jobname-standalone-#2.pdf}{% |
| 5202 |
\@tempcnta\z@% |
| 5203 |
\@for\@tempa:=#3\do{\advance\@tempcnta\@ne}% |
| 5204 |
\ifnum\@tempcnta>\z@\relax% |
| 5205 |
\tud@setdim\@tempdima{\textwidth}% |
| 5206 |
\divide\@tempdima\@tempcnta% |
| 5207 |
\advance\@tempcnta\m@ne% |
| 5208 |
\multiply\@tempcnta 2% |
| 5209 |
\tud@addtodim\@tempdima{-\@tempcnta\tabcolsep}% |
| 5210 |
\@for\@tempa:=#3\do{% |
| 5211 |
\advance\@tempcnta\m@ne% |
| 5212 |
\edef\@tempb{% |
| 5213 |
keepaspectratio,page=\@tempa,width=\the\@tempdima,% |
| 5214 |
\IfValueT{#1}{#1}% |
| 5215 |
}% |
| 5216 |
\fbox{% |
| 5217 |
\expandafter\includegraphics\expandafter[\@tempb]{% |
| 5218 |
\jobname-standalone-#2.pdf% |
| 5219 |
}% |
| 5220 |
}% |
| 5221 |
\ifnum\@tempcnta>\z@\relax\hfill\fi% |
| 5222 |
}% |
| 5223 |
\fi% |
| 5224 |
}{% |
| 5225 |
\tud@shellescape@wrn{\jobname-standalone-#2.pdf}% |
| 5226 |
}% |
| 5227 |
} |
| 5228 |
% \end{macrocode} |
| 5229 |
% \end{macro}^^A \IncludeStandalone |
| 5230 |
% |
| 5231 |
% \iffalse |
| 5232 |
%</package> |
| 5233 |
% \fi |
| 5234 |
% |
| 5235 |
% \subsection{Automatische Erstellung von \pkg{pstricks}-Grafiken} |
| 5236 |
% |
| 5237 |
% Falls innerhalb eines Tutorials das Paket \pkg{pstricks} verwendet wird, muss |
| 5238 |
% dafür Sorge getragen werden, dass die automatische Kompilierung reibungslos |
| 5239 |
% mit \pkg{auto-pst-pdf} funktioniert. |
| 5240 |
% \begin{macrocode} |
| 5241 |
%<*package> |
| 5242 |
\AfterPackage*{pstricks}{% |
| 5243 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 5244 |
\filemodCmp{\jobname-pics.pdf}{\jobname.tex}{% |
| 5245 |
\PassOptionsToPackage{off}{auto-pst-pdf}% |
| 5246 |
}{}% |
| 5247 |
\else% |
| 5248 |
\PassOptionsToPackage{off}{auto-pst-pdf}% |
| 5249 |
\fi% |
| 5250 |
\RequirePackage{auto-pst-pdf} |
| 5251 |
% \end{macrocode} |
| 5252 |
% Nach dem Paket \pkg{auto-pst-pdf} seine Arbeit verrichtet hat, werden alle |
| 5253 |
% etwaigen temporär erzeugten Dateien radikal gelöscht. |
| 5254 |
% \begin{macrocode} |
| 5255 |
\ifnum\pdf@shellescape=\@ne\relax% |
| 5256 |
\edef\@tempa{\app@exe{\app@rm "*\app@suffix*"}}% |
| 5257 |
\@tempa% |
| 5258 |
\fi% |
| 5259 |
} |
| 5260 |
%</package> |
| 5261 |
% \end{macrocode} |
| 5262 |
% |
| 5263 |
% \subsection{ToDo-Liste} |
| 5264 |
% |
| 5265 |
% Für Klasse und Paket besteht die Möglichkeit, Änderungsnotizen zu nutzen, |
| 5266 |
% wofür das Paket \pkg{todonotes} geladen wird. |
| 5267 |
% \begin{macrocode} |
| 5268 |
\PassOptionsToPackage{obeyFinal}{todonotes} |
| 5269 |
% \end{macrocode} |
| 5270 |
% Für den Druck wird die farbige Ausgabe der ToDo-Notizen deaktiviert. |
| 5271 |
% \begin{macrocode} |
| 5272 |
\ifdef{\tudprintflag}{% |
| 5273 |
\PassOptionsToPackage{color=white}{todonotes}% |
| 5274 |
}{% |
| 5275 |
\PassOptionsToPackage{colorinlistoftodos,color=HKS92!10}{todonotes}% |
| 5276 |
} |
| 5277 |
\RequirePackage{todonotes} |
| 5278 |
\AtEndPreamble{% |
| 5279 |
\ifdim\marginparwidth<2cm\relax% |
| 5280 |
\tud@setdim\marginparwidth{2cm}% |
| 5281 |
\fi% |
| 5282 |
} |
| 5283 |
% \end{macrocode} |
| 5284 |
% |
| 5285 |
% \iffalse |
| 5286 |
%</body> |
| 5287 |
%<*option> |
| 5288 |
% \fi |
| 5289 |
% |
| 5290 |
% \begin{option}{ToDo} |
| 5291 |
% \changes{v2.02}{2014/07/10}{neu}^^A |
| 5292 |
% \changes{v2.05}{2015/10/27}{Nutzung von Positiv- und Negativ-Liste}^^A |
| 5293 |
% \begin{macro}{\if@tud@todo} |
| 5294 |
% \changes{v2.02}{2014/07/10}{neu}^^A |
| 5295 |
% \begin{macro}{\tud@todo@type@pos} |
| 5296 |
% \changes{v2.05}{2015/10/27}{neu}^^A |
| 5297 |
% \begin{macro}{\tud@todo@type@neg} |
| 5298 |
% \changes{v2.05}{2015/10/27}{neu}^^A |
| 5299 |
% Diese Option ist verantwortlich für den Schalter \cs{if@tud@todo}. Über |
| 5300 |
% diesen wird gesteuert, ob ToDo-Notizen ausgegeben werden sollen. |
| 5301 |
% \begin{macrocode} |
| 5302 |
\tud@newif\if@tud@todo |
| 5303 |
\newcommand*\tud@todo@type@pos{} |
| 5304 |
\let\tud@todo@type@pos\relax |
| 5305 |
\newcommand*\tud@todo@type@neg{} |
| 5306 |
\let\tud@todo@type@neg\relax |
| 5307 |
\TUD@key{ToDo}[true]{% |
| 5308 |
\TUD@set@ifkey{ToDo}{@tud@todo}{#1}% |
| 5309 |
% \end{macrocode} |
| 5310 |
% Wird der Option ein boolescher Wert übergeben, sind sowohl die Positiv- als |
| 5311 |
% auch die Negativ-Liste hinfällig. |
| 5312 |
% \begin{macrocode} |
| 5313 |
\ifx\FamilyKeyState\FamilyKeyStateProcessed% |
| 5314 |
\let\tud@todo@type@pos\relax% |
| 5315 |
\let\tud@todo@type@neg\relax% |
| 5316 |
\else% |
| 5317 |
% \end{macrocode} |
| 5318 |
% Wird die Option nicht mit einem booleschen Wert verwendet, so kann über diese |
| 5319 |
% gezielt der Typ einer (nicht) auszugebenden ToDo-Notiz angegeben werden. So |
| 5320 |
% können bestimmte Typen von Notizen entweder ausschließlich ausgegeben oder |
| 5321 |
% aber unterdrückt werden, wobei für letztere Variante das Suffix \val{not} |
| 5322 |
% vor dem eigentlichen Typen verwendet werden muss. |
| 5323 |
% \begin{macrocode} |
| 5324 |
\def\@tempa not##1##2##3##4\@nil{% |
| 5325 |
\tud@if@strequal{##1##2##3}{not}{% |
| 5326 |
\IfArgIsEmpty{##4}{}{% |
| 5327 |
\listeadd\tud@todo@type@neg{##4}% |
| 5328 |
\@tud@todotrue% |
| 5329 |
\FamilyKeyStateProcessed% |
| 5330 |
}% |
| 5331 |
}{% |
| 5332 |
\IfArgIsEmpty{##1}{}{% |
| 5333 |
\listeadd\tud@todo@type@pos{##1##2##3##4}% |
| 5334 |
\@tud@todotrue% |
| 5335 |
\FamilyKeyStateProcessed% |
| 5336 |
}% |
| 5337 |
}% |
| 5338 |
}% |
| 5339 |
\edef\@tempb{not\trim@spaces{#1}}% |
| 5340 |
\expandafter\@tempa\@tempb\@empty\@empty\@empty\@nil% |
| 5341 |
\fi% |
| 5342 |
} |
| 5343 |
% \end{macrocode} |
| 5344 |
% \end{macro}^^A \tud@todo@type@neg |
| 5345 |
% \end{macro}^^A \tud@todo@type@pos |
| 5346 |
% \end{macro}^^A \if@tud@todo |
| 5347 |
% \end{option}^^A ToDo |
| 5348 |
% |
| 5349 |
% \iffalse |
| 5350 |
%</option> |
| 5351 |
%<*body> |
| 5352 |
% \fi |
| 5353 |
% |
| 5354 |
% \begin{macro}{\ToDo} |
| 5355 |
% \changes{v2.02}{2014/07/10}{Verwendung von \pkg{todonotes}}^^A |
| 5356 |
% \changes{v2.03}{2015/01/25}{Ausgabe auf bestimmten Typ beschränkbar}^^A |
| 5357 |
% \changes{v2.05}{2015/11/02}{Farbkodierung durch optionale Versionsnummer}^^A |
| 5358 |
% \changes{v2.06}{2018/08/02}{farbige Ausgabe abhängig von Versionsnummer}^^A |
| 5359 |
% \begin{macro}{\tud@todo@type@use} |
| 5360 |
% \changes{v2.06}{2018/08/02}{neu}^^A |
| 5361 |
% \begin{macro}{\ListOfToDo} |
| 5362 |
% \changes{v2.02}{2014/07/10}{neu}^^A |
| 5363 |
% Mit dem Befehl \cs{ToDo}\oarg{Option}\marg{ToDo-Notiz}\oarg{Versionsnummer} |
| 5364 |
% kann bei aktivierter Option \opt{ToDo} eine Notiz mit einer offenen Aufgabe |
| 5365 |
% erstellt werden. Das erste optionale Argument kann die Kategorisierungstypen |
| 5366 |
% \val{doc}, \val{imp} und \val{rls} beinhalten, welche für eine spezifische |
| 5367 |
% farbliche Kodierung sorgen, um die Aufgaben zu kategorisieren. |
| 5368 |
% \begin{macrocode} |
| 5369 |
\AfterPackage*{todonotes}{% |
| 5370 |
\newcommand*\tud@todo@type@use{}% |
| 5371 |
% \end{macrocode} |
| 5372 |
% Nun folgt die Definition des eigentlichen Befehls. Dabei wird zu Beginn |
| 5373 |
% \cs{@currentHref} gesichert und am Ende wiederhergestellt. |
| 5374 |
% \begin{macrocode} |
| 5375 |
\NewDocumentCommand\ToDo{s o m !o}{% |
| 5376 |
\if@tud@todo% |
| 5377 |
\global\let\tud@currentHref\@currentHref% |
| 5378 |
\begingroup% |
| 5379 |
% \end{macrocode} |
| 5380 |
% In \cs{tud@todo@type@use} werden alle im optionalen Argument angegeben Werte |
| 5381 |
% gesischer, welche entweder über die Liste \cs{tud@todo@type@pos} explizit |
| 5382 |
% angefordert oder nicht über die Liste \cs{tud@todo@type@neg} ausgeschlossen |
| 5383 |
% wurden. |
| 5384 |
% \begin{macrocode} |
| 5385 |
\let\tud@todo@type@use\@empty% |
| 5386 |
% \end{macrocode} |
| 5387 |
% Das optionale Argument enthält die gewüscnhten Kategorisierungstypen. |
| 5388 |
% \begin{macrocode} |
| 5389 |
\IfValueTF{#2}{% |
| 5390 |
\IfArgIsEmpty{#2}{}{% |
| 5391 |
% \end{macrocode} |
| 5392 |
% Die Ausgabe erfolgt entweder für alle ToDo-Notizen oder nur für die per |
| 5393 |
% Option festgelegten Typen. Dabei wird in einer Schleife geprüft, ob der in |
| 5394 |
% der aktuellen Notiz angegebene Kategorisierungstyp entweder in der Positv- |
| 5395 |
% oder aber in der Negativ-Liste enthalten ist. |
| 5396 |
% \begin{macrocode} |
| 5397 |
\let\tud@todo@type@use\relax% |
| 5398 |
\ifx\tud@todo@type@pos\relax% |
| 5399 |
\def\tud@res@a##1{% |
| 5400 |
\ifinlist{##1}{\tud@todo@type@use}{}{% |
| 5401 |
\ifinlist{##1}{\tud@todo@type@neg}{}{% |
| 5402 |
\listadd\tud@todo@type@use{##1}% |
| 5403 |
}% |
| 5404 |
}% |
| 5405 |
}% |
| 5406 |
\else% |
| 5407 |
\def\tud@res@a##1{% |
| 5408 |
\ifinlist{##1}{\tud@todo@type@use}{}{% |
| 5409 |
\ifinlist{##1}{\tud@todo@type@pos}{% |
| 5410 |
\listadd\tud@todo@type@use{##1}% |
| 5411 |
}{}% |
| 5412 |
}% |
| 5413 |
}% |
| 5414 |
\fi% |
| 5415 |
\forcsvlist\tud@res@a{#2}% |
| 5416 |
}% |
| 5417 |
}{}% |
| 5418 |
% \end{macrocode} |
| 5419 |
% Nur wenn mindestens ein aktiver Kategorisierungstyp gefunden wurde oder aber |
| 5420 |
% gar keine Angabe gemacht wurde, erfolgt die Ausgabe. |
| 5421 |
% \begin{macrocode} |
| 5422 |
\ifx\tud@todo@type@use\relax\else% |
| 5423 |
% \end{macrocode} |
| 5424 |
% In den temporären Makros werden die Einstellungen für die farbige Ausprägung |
| 5425 |
% von Randnotiz (\cs{tud@res@a}) und der Textbox im Fließtex(\cs{tud@res@b}) |
| 5426 |
% sowie das Label der Randnotiz (\cs{tud@res@c}) gespeichert. |
| 5427 |
% \begin{macrocode} |
| 5428 |
\let\tud@res@a\@empty% |
| 5429 |
\let\tud@res@b\@empty% |
| 5430 |
\let\tud@res@c\@empty% |
| 5431 |
% \end{macrocode} |
| 5432 |
% Der Kategorisierungstyp für Releases \val{rls} ist quasi vorkonfiguriert. |
| 5433 |
% Sind weitere Kategorisierungstypen angegeben, werden diese ignoriert. Der Typ |
| 5434 |
% für Implemtierung \val{imp} wird vorangig zur Dokumentation \val{doc} |
| 5435 |
% behandelt. |
| 5436 |
% \begin{macrocode} |
| 5437 |
\ifinlist{rls}{\tud@todo@type@use}{% |
| 5438 |
\def\tud@res@a{color=HKS44!30,}% |
| 5439 |
\def\tud@res@b{color=HKS44!30,}% |
| 5440 |
\edef\tud@res@c{v\TUDScriptVersionNumber}% |
| 5441 |
}{% |
| 5442 |
\ifinlist{imp}{\tud@todo@type@use}{% |
| 5443 |
\def\tud@res@a{color=HKS57!50,}% |
| 5444 |
}{% |
| 5445 |
\ifinlist{doc}{\tud@todo@type@use}{% |
| 5446 |
\def\tud@res@a{color=HKS41!30,}% |
| 5447 |
}{}% |
| 5448 |
}% |
| 5449 |
% \end{macrocode} |
| 5450 |
% Das angestellte optionale Argument erzeugt zusätzlich eine Notiz am Rand, in |
| 5451 |
% welcher vorzugsweise die angedachte Version eingetragen werden kann. Sollte |
| 5452 |
% dieser angegeben sein, wird auf eine gültige Versionsnummer geprüft. Dabei |
| 5453 |
% wird ein möglicherweise vorangestelltes |v| entfernt. |
| 5454 |
% \begin{macrocode} |
| 5455 |
\def\tud@res@c{ToDo}% |
| 5456 |
\IfValueT{#4}{% |
| 5457 |
\begingroup% |
| 5458 |
% \end{macrocode} |
| 5459 |
% Die angegebene Versionsnummer wird geprüft, ob bereits zu einer vergangenen |
| 5460 |
% Version gehört. In diesem Fall wird die ToDo-Notiz entsprechend als dringlich |
| 5461 |
% gekennzeichnet. Entspricht die angegebene Versionsnummer einer späteren |
| 5462 |
% Version, so wird ToDo-Notiz ebenfalls für diese gekennzeichnet. |
| 5463 |
% \begin{macrocode} |
| 5464 |
\tud@v@get\tud@res@a{#4}% |
| 5465 |
\def\tud@res@c##1.##2##3##4\@nil{##1##2##3}% |
| 5466 |
\edef\tud@res@b{\expandafter\tud@res@c\tud@[email protected]\@nil}% |
| 5467 |
\Ifnumber{\tud@res@b}{% |
| 5468 |
\edef\tud@res@c{% |
| 5469 |
\expandafter\tud@res@c\TUDScriptVersionNumber.000\@nil% |
| 5470 |
}% |
| 5471 |
\ifnum\tud@res@b>\tud@res@c\relax% |
| 5472 |
\def\tud@res@b{color=HKS92!30,}% |
| 5473 |
\else% |
| 5474 |
\ifnum\tud@res@b<\tud@res@c\relax% |
| 5475 |
\def\tud@res@b{color=HKS07!50,}% |
| 5476 |
\else% |
| 5477 |
\def\tud@res@b{color=HKS41!30,}% |
| 5478 |
\fi% |
| 5479 |
\fi% |
| 5480 |
\def\tud@res@c{v\tud@res@a}% |
| 5481 |
}{% |
| 5482 |
\let\tud@res@b\@empty% |
| 5483 |
\def\tud@res@c{#4}% |
| 5484 |
}% |
| 5485 |
\edef\tud@res@c{% |
| 5486 |
\endgroup% |
| 5487 |
\def\noexpand\tud@res@b{\tud@res@b}% |
| 5488 |
\def\noexpand\tud@res@c{\tud@res@c}% |
| 5489 |
}% |
| 5490 |
\tud@res@c% |
| 5491 |
}% |
| 5492 |
}% |
| 5493 |
% \end{macrocode} |
| 5494 |
% Vor der Ausgabe wird ein kleiner vertikaler Abstand eingefügt. |
| 5495 |
% \begin{macrocode} |
| 5496 |
\ifhmode\par\fi% |
| 5497 |
\let\par\relax% |
| 5498 |
\vskip\medskipamount% |
| 5499 |
\noindent% |
| 5500 |
% \end{macrocode} |
| 5501 |
% Dann erfolgt die Ausgabe der eigentlichen ToDo-Notiz im Textbereich. Die |
| 5502 |
% Sternversion von \cs{ToDo} unterdrückt dabei die Aufnahme in die ToDo-Liste. |
| 5503 |
% \begin{macrocode} |
| 5504 |
\toks@\expandafter{\tud@res@b inline}% |
| 5505 |
\IfBooleanT{#1}{\addto@hook\toks@{,nolist}}% |
| 5506 |
\sbox\z@{% |
| 5507 |
\expandafter\todo\expandafter[\the\toks@]{\trim@spaces{#3}\strut}% |
| 5508 |
}\usebox\z@% |
| 5509 |
% \end{macrocode} |
| 5510 |
% Es folgt die dazugehörige Randnotiz. Damit diese nicht verrutscht, wird |
| 5511 |
% \cs{marginnote} anstelle von \cs{marginpar} verwendet. Wurde das angestellte |
| 5512 |
% optionale Argument verwendet, wird dieses für die Randnotiz genutzt. |
| 5513 |
% Andernfalls erscheint im Rand die Anmerkung \emph{ToDo}. |
| 5514 |
% \begin{macrocode} |
| 5515 |
\renewcommand*\marginpar[2][]{% |
| 5516 |
\marginnote[{##1}]{##2}[\dimexpr-\ht\z@+1.6ex+1.75pt\relax]% |
| 5517 |
}% |
| 5518 |
\toks@\expandafter{\tud@res@a noline,nolist}% |
| 5519 |
\settowidth\marginparwidth{\tud@res@c}% |
| 5520 |
\tud@addtodim\marginparwidth{1.6ex+1pt}% |
| 5521 |
\expandafter\todo\expandafter[\the\toks@]{\tud@res@c\strut}% |
| 5522 |
\aftergroup\par\aftergroup\noindent% |
| 5523 |
% \end{macrocode} |
| 5524 |
% Wurden im ersten optionalen Argument unbekannte Werte gefunden, werden diese |
| 5525 |
% mit einer Warnung gemeldet. |
| 5526 |
% \begin{macrocode} |
| 5527 |
\listremove{\tud@todo@type@use}{rls}% |
| 5528 |
\listremove{\tud@todo@type@use}{imp}% |
| 5529 |
\listremove{\tud@todo@type@use}{doc}% |
| 5530 |
\ifx\tud@todo@type@use\@empty\else% |
| 5531 |
\begingroup% |
| 5532 |
\let\tud@res@c\@empty% |
| 5533 |
\def\do##1{\appto\tud@res@c{,##1}}% |
| 5534 |
\dolistloop{\tud@todo@type@use}% |
| 5535 |
\edef\tud@res@c{% |
| 5536 |
\endgroup% |
| 5537 |
\edef\noexpand\tud@res@c{\expandafter\@gobble\tud@res@c}% |
| 5538 |
}% |
| 5539 |
\tud@res@c% |
| 5540 |
\ClassWarning{tudscrmanual}{% |
| 5541 |
Unknown key(s) `\string\ToDo[\tud@res@c]'% |
| 5542 |
}% |
| 5543 |
\fi% |
| 5544 |
\fi% |
| 5545 |
\endgroup% |
| 5546 |
\global\let\@currentHref\tud@currentHref% |
| 5547 |
\fi% |
| 5548 |
\ignorespaces% |
| 5549 |
}% |
| 5550 |
% \end{macrocode} |
| 5551 |
% Zum Schluss wird der Befehl \cs{ListOfToDo} definiert, der die Liste der noch |
| 5552 |
% zu erledigenden Punkte ausgibt. |
| 5553 |
% \begin{macrocode} |
| 5554 |
\newcommand*\ListOfToDo{\if@tud@todo\clearpage\listoftodos\fi}% |
| 5555 |
} |
| 5556 |
% \end{macrocode} |
| 5557 |
% Sollte das Paket \pkg{todonotes} nicht geladen werden, erfolgt ein Definition |
| 5558 |
% der beiden notwendigen Befehle als Dummy. |
| 5559 |
% \begin{macrocode} |
| 5560 |
\TUD@UnwindPackage{todonotes}{% |
| 5561 |
\NewDocumentCommand\ToDo{s o m !o}{}% |
| 5562 |
\newcommand*\ListOfToDo{}% |
| 5563 |
} |
| 5564 |
% \end{macrocode} |
| 5565 |
% \end{macro}^^A \ListOfToDo |
| 5566 |
% \end{macro}^^A \tud@todo@type@use |
| 5567 |
% \end{macro}^^A \ToDo |
| 5568 |
% |
| 5569 |
% \subsection{Verschiedenes für die Dokumentationsklassen und -pakete} |
| 5570 |
% |
| 5571 |
% Für die Klasse \cls{tudscrmanual} werden ein paar Befehle zur komfortablen |
| 5572 |
% Verwendung im Fließtext definiert. Außerdem erfolgen mittels einiger Pakete |
| 5573 |
% verschiedene Formateinstellungen. |
| 5574 |
% |
| 5575 |
% \subsubsection{Ergänzend geladene Pakete} |
| 5576 |
% |
| 5577 |
% Für den Fließtext werden Pfeile u.\,ä. durch \pkg{textcomp} bereitgestellt. |
| 5578 |
% \begin{macrocode} |
| 5579 |
\RequirePackage{textcomp} |
| 5580 |
% \end{macrocode} |
| 5581 |
% Vergrößerung des Durchschusses. |
| 5582 |
% \begin{macrocode} |
| 5583 |
\RequirePackage{setspace} |
| 5584 |
\setstretch{1.1} |
| 5585 |
% \end{macrocode} |
| 5586 |
% Verbesserte Zitate. |
| 5587 |
% \begin{macrocode} |
| 5588 |
\PassOptionsToPackage{vskip=\smallskipamount}{quoting} |
| 5589 |
\RequirePackage{quoting} |
| 5590 |
% \end{macrocode} |
| 5591 |
% Automatisierte Datumsformatierung. |
| 5592 |
% \begin{macrocode} |
| 5593 |
\RequirePackage{isodate} |
| 5594 |
% \end{macrocode} |
| 5595 |
% Verschiedenste Symbole aus dem \LaTeX-Universum. |
| 5596 |
% \begin{macrocode} |
| 5597 |
\RequirePackage{hologo} |
| 5598 |
% \end{macrocode} |
| 5599 |
% |
| 5600 |
% \iffalse |
| 5601 |
%<*class> |
| 5602 |
% \fi |
| 5603 |
% |
| 5604 |
% Mit dem Paket \pkg{ragged2e} wird~-- falls benötigt~-- die Silbentrennung im |
| 5605 |
% Flattersatz aktiviert. |
| 5606 |
% \begin{macrocode} |
| 5607 |
\RequirePackage{ragged2e} |
| 5608 |
% \end{macrocode} |
| 5609 |
% Die Fußnoten werden nicht mit jedem Kapitel zurückgesetzt\dots |
| 5610 |
% \begin{macrocode} |
| 5611 |
\@removefromreset{footnote}{chapter} |
| 5612 |
% \end{macrocode} |
| 5613 |
% \dots und im Flattersatz ausgegeben. |
| 5614 |
% \begin{macrocode} |
| 5615 |
\renewcommand*\raggedfootnote{\tud@RaggedRight}% |
| 5616 |
% \end{macrocode} |
| 5617 |
% Das Paket wird für die Erstellung von Tabellen verwendet. |
| 5618 |
% \begin{macrocode} |
| 5619 |
\RequirePackage{booktabs} |
| 5620 |
% \end{macrocode} |
| 5621 |
% Die Formatierung von Gleitobjekten. |
| 5622 |
% \begin{macrocode} |
| 5623 |
\RequirePackage{caption} |
| 5624 |
\RequirePackage{floatrow} |
| 5625 |
\DeclareCaptionSubType[alph]{figure} |
| 5626 |
\DeclareCaptionSubType[alph]{table} |
| 5627 |
\captionsetup{font=sf,labelfont=bf,labelsep=space} |
| 5628 |
\captionsetup{singlelinecheck=off,format=hang,justification=raggedright} |
| 5629 |
\captionsetup[subfloat]{labelformat=brace,list=off} |
| 5630 |
\KOMAoption{captions}{tableheading,figuresignature} |
| 5631 |
\floatsetup[table]{style=plaintop} |
| 5632 |
% \end{macrocode} |
| 5633 |
% Erstellen von Grafiken. |
| 5634 |
% \begin{macrocode} |
| 5635 |
\RequirePackage{tikz} |
| 5636 |
% \end{macrocode} |
| 5637 |
% Einbinden von ganzseitigen PDF"~Dokumenten als Beispiel im Handbuch. |
| 5638 |
% \begin{macrocode} |
| 5639 |
\RequirePackage{pdfpages} |
| 5640 |
% \end{macrocode} |
| 5641 |
% Typographisch saubere Einheiten. |
| 5642 |
% \begin{macrocode} |
| 5643 |
\RequirePackage{units} |
| 5644 |
% \end{macrocode} |
| 5645 |
% Das Paket \pkg{ellipsis} sorgt für korrekte Auslassungpunkte. |
| 5646 |
% \begin{macrocode} |
| 5647 |
\AtEndPreamble{% |
| 5648 |
\RequirePackage{ellipsis} |
| 5649 |
\let\ellipsispunctuation\relax% |
| 5650 |
} |
| 5651 |
% \end{macrocode} |
| 5652 |
% |
| 5653 |
% \iffalse |
| 5654 |
%</class> |
| 5655 |
% \fi |
| 5656 |
% |
| 5657 |
% \subsubsection{Zusätzliche Markup-Befehle} |
| 5658 |
% |
| 5659 |
% \begin{macro}{\notudscrartcl} |
| 5660 |
% \begin{macro}{\scrguide} |
| 5661 |
% \changes{v2.02}{2014/09/04}{neu}^^A |
| 5662 |
% \changes{v2.05}{2015/07/23}{Hyperlinktext über optionales Argument}^^A |
| 5663 |
% Für die Anwenderdokumentation werden weitere Auszeichnungsbefehle definiert. |
| 5664 |
% \begin{macrocode} |
| 5665 |
\newcommand*\notudscrartcl{% |
| 5666 |
F\"ur die Klassen \Class{tudscrartcl} sowie \Class{tudscrposter} ist diese |
| 5667 |
Option nicht verf\"ugbar.% |
| 5668 |
} |
| 5669 |
\NewDocumentCommand\scrguide{!s !O{\KOMAScript-Handbuch}}{% |
| 5670 |
\IfBooleanTF{#1}{\toks@{\href}}{\toks@{\hrfn}}% |
| 5671 |
\addto@hook\toks@{% |
| 5672 |
{http://mirrors.ctan.org/macros/latex/contrib/koma-script/doc/scrguide.pdf}% |
| 5673 |
}% |
| 5674 |
\addto@hook\toks@{{#2}}% |
| 5675 |
\the\toks@\xspace% |
| 5676 |
} |
| 5677 |
% \end{macrocode} |
| 5678 |
% \end{macro}^^A \scrguide |
| 5679 |
% \end{macro}^^A \notudscrartcl |
| 5680 |
% |
| 5681 |
% \iffalse |
| 5682 |
%</body> |
| 5683 |
% \fi |
| 5684 |
% |
| 5685 |
% \PrintBackMatter |
| 5686 |
% |
| 5687 |
\endinput |