| 1 |
% \iffalse meta-comment |
| 2 |
%/GitFileInfo=tudscr-texindy.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-texindy.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 |
% |
| 63 |
% |
| 64 |
% \section{Stildateien für \app{texindy}} |
| 65 |
% |
| 66 |
% Für die Dokumentationsklassen und -pakete wird zur Sortierung \app{texindy} |
| 67 |
% verwendet. Da das Programm die die Dateien nicht in einem |TEXPATH| nach den |
| 68 |
% Stildateien sucht, werden diese zur Laufzeit im Arbeitsverzeichnis erstellt. |
| 69 |
% Nachfolgend werden die erstellten \app{texindy}-Stildateien beschrieben. |
| 70 |
% |
| 71 |
% \begin{macro}{\@hashchar} |
| 72 |
% \changes{v2.05}{2016/04/25}{neu}^^A |
| 73 |
% Das Hash-Zeichen wird bei \cls{tudscrdoc} für die Befehlsdeklarationen in der |
| 74 |
% Stildatei benötigt. Damit dieses beim Erzeugen der Datei nicht als solches |
| 75 |
% interpretiert wird, ist dafür ein separates Makro notwendig. |
| 76 |
% \begin{macrocode} |
| 77 |
\edef\tud@res@a{\catcode`\noexpand\#=\the\catcode`\#\relax}% |
| 78 |
\@makeother\# |
| 79 |
\newcommand*\@hashchar{#} |
| 80 |
\tud@res@a |
| 81 |
% \end{macrocode} |
| 82 |
% \end{macro}^^A \@hashchar |
| 83 |
% \begin{macro}{\tud@xdy@create} |
| 84 |
% \changes{v2.05}{2016/04/24}{neu}^^A |
| 85 |
% \begin{macro}{\tud@xdy@@create} |
| 86 |
% \begin{macro}{\tud@xdy@write} |
| 87 |
% \changes{v2.05}{2016/04/24}{neu}^^A |
| 88 |
% Dies sind die Hilfsmakros für die Erzeugung der nötigen Dateien. Mit dem |
| 89 |
% \cs{tud@xdy@create} wird angegeben, ob die Stildatei für einen Index oder ein |
| 90 |
% Glossar erzeugt wird, was prinzipiell nur für die Klasse \cls{tudscrdoc} |
| 91 |
% notwendig ist. |
| 92 |
% \begin{macrocode} |
| 93 |
%<doc>\ifdefined\tudxdyflag |
| 94 |
%<!doc>\tud@newwrite\tud@xdy@write |
| 95 |
\NewDocumentCommand\tud@xdy@create{s}{% |
| 96 |
\begingroup% |
| 97 |
\edef\tud@res@a{\@currname-\IfBooleanTF{#1}{gls}{ind}.xdy}% |
| 98 |
\expandafter\IfFileExists\expandafter{\tud@res@a}{}{% |
| 99 |
\IfBooleanTF{#1}{\@tud@res@swatrue}{\@tud@res@swafalse}% |
| 100 |
\edef\tud@res@b{the\if@tud@res@swa glossary\else index\fi}% |
| 101 |
\edef\tud@res@a{\noexpand\tud@xdy@@create{\tud@res@b}{\tud@res@a}}% |
| 102 |
\tud@res@a% |
| 103 |
}% |
| 104 |
\endgroup% |
| 105 |
} |
| 106 |
\newcommand*\tud@xdy@@create[2]{% |
| 107 |
\immediate\openout\tud@xdy@write=#2\relax% |
| 108 |
% \end{macrocode} |
| 109 |
% Als erstes wird das \LaTeX-Standardmodul geladen. |
| 110 |
% \begin{macrocode} |
| 111 |
\immediate\write\tud@xdy@write{(require "texindy.xdy")}% |
| 112 |
% \end{macrocode} |
| 113 |
% |
| 114 |
% Für die Klasse \cls{tudscrdoc} werden in den Stildateien die verwendeten |
| 115 |
% Umgebung definiert, welche für die prozessierten Indexdateien zu nutzen sind. |
| 116 |
% \begin{macrocode} |
| 117 |
\immediate\write\tud@xdy@write{% |
| 118 |
(markup-index^^J% |
| 119 |
\@spaces:open^^J% |
| 120 |
"\string\begin{#1}^^J% |
| 121 |
%<*doc> |
| 122 |
\space\space\string\makeatletter\@percentchar^^J% |
| 123 |
\space\space\string\providecommand*\string\lettergroupDefault[1]% |
| 124 |
{\string\lettergroup{\string\tud@symbols@name}}\@percentchar^^J% |
| 125 |
\space\space\string\providecommand*\string\lettergroup[1]{\@percentchar^^J% |
| 126 |
\@spaces\string\belowpdfbookmark% |
| 127 |
{\@hashchar1}{#1/\@hashchar1}\@percentchar^^J% |
| 128 |
\@spaces\string\par\string\centerline% |
| 129 |
{\string\normalsize\string\textbf{\string\textsf{\@hashchar1}}}% |
| 130 |
\@percentchar^^J% |
| 131 |
\@spaces\string\par\string\smallskip\string\nopagebreak\@percentchar^^J% |
| 132 |
\space\space}\@percentchar^^J% |
| 133 |
\space\space\string\scan@allowedfalse\@percentchar^^J% |
| 134 |
% \end{macrocode} |
| 135 |
% Für die Änderungsliste erfolgt die Gruppierung anhand der Versionsnummer. Da |
| 136 |
% diese auf der ersten Ebene angegeben ist (\cs{item}) muss das Ganze mit einem |
| 137 |
% terminierten Befehl erfolgen. Hierfür wird \cs{@lettergroup} definiert. |
| 138 |
% Außerdem werden mit \cs{tud@lst@def} die benötigten Befehle zur selektiven |
| 139 |
% Anzeige der Änderungseinträge erstellt. |
| 140 |
% \begin{macrocode} |
| 141 |
\if@tud@res@swa |
| 142 |
\space\space\string\newcommand*\string\@lettergroup{}\@percentchar^^J% |
| 143 |
\space\space\string\def\string\@lettergroup\@hashchar1\string\relax% |
| 144 |
{\string\lettergroup{\@hashchar1}}\@percentchar^^J% |
| 145 |
\space\space\string\tud@lst@def\@percentchar^^J% |
| 146 |
\fi |
| 147 |
%</doc> |
| 148 |
\space\space\string\providecommand*\string\seesep{/}\@percentchar^^J% |
| 149 |
% \end{macrocode} |
| 150 |
% Der Abschluss der Umgebungsdefinition. |
| 151 |
% \begin{macrocode} |
| 152 |
"^^J% Ende des Umgebungsbeginns |
| 153 |
\@spaces:close "\string~n\string~n\string\end{#1}\string~n"^^J% |
| 154 |
\@spaces:hierdepth 3^^J% |
| 155 |
)^^J% |
| 156 |
% \end{macrocode} |
| 157 |
% Für die Sortierung des Indexes sollen einzelne Zeichen beachtet werden. |
| 158 |
% Hierfür wird |xy-ignore-special| durch |xy-resolve-special| ersetzt. |
| 159 |
% \begin{macrocode} |
| 160 |
%<*doc> |
| 161 |
(define-sort-rule-orientations (forward backward forward forward))^^J% |
| 162 |
(use-rule-set :run 0^^J% |
| 163 |
\@spaces:rule-set ("xy-alphabetize" "xy-resolve-special")^^J% |
| 164 |
)^^J% |
| 165 |
(use-rule-set :run 1^^J% |
| 166 |
\@spaces:rule-set ("xy-resolve-diacritics" "xy-resolve-special")^^J% |
| 167 |
)^^J% |
| 168 |
(use-rule-set :run 2^^J% |
| 169 |
\@spaces:rule-set ("xy-resolve-case" "xy-resolve-special")^^J% |
| 170 |
)^^J% |
| 171 |
% \end{macrocode} |
| 172 |
% Die Seitenzahlenbereiche für die Quelltextdokumentation bestehen aus drei |
| 173 |
% Teilen, um das Verlinken auf Codezeilen zu ermöglichen~-- |
| 174 |
% \meta{Target}|:|\meta{Dateischlüssel}|-|\meta{Codezeile}|:|\meta{Seitenzahl} |
| 175 |
% \begin{macrocode} |
| 176 |
(define-alphabet "AlphaExtended"^^J% |
| 177 |
\@spaces(^^J% |
| 178 |
\@spaces\@spaces"A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M"^^J% |
| 179 |
\@spaces\@spaces"N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z"^^J% |
| 180 |
\@spaces\@spaces"a" "b" "c" "d" "e" "f" "g" "h" "i" "j" "k" "l" "m"^^J% |
| 181 |
\@spaces\@spaces"n" "o" "p" "q" "r" "s" "t" "u" "v" "w" "x" "y" "z"^^J% |
| 182 |
\@spaces\@spaces"?"^^J% |
| 183 |
\@spaces)^^J% |
| 184 |
)^^J% |
| 185 |
(define-location-class "hypdoc"^^J% |
| 186 |
\@spaces(^^J% |
| 187 |
\@spaces\@spaces"arabic-numbers" :sep ":"^^J% |
| 188 |
\@spaces\@spaces"AlphaExtended" \space:sep "-" "arabic-numbers" :sep ":"^^J% |
| 189 |
\@spaces\@spaces"arabic-numbers"^^J% |
| 190 |
\@spaces)^^J% |
| 191 |
\@spaces:min-range-length 2^^J% |
| 192 |
)^^J% |
| 193 |
%</doc> |
| 194 |
% \end{macrocode} |
| 195 |
% Leider lässt sich für Seitenzahlbereiche via |:attr| (noch) kein Markup für |
| 196 |
% angehängte \enquote*{f.} sowie \enquote*{ff.} einstellen. Diese würden deshalb |
| 197 |
% bei kursiven oder fetten Seitenzahlen trotzdem in normaler Schrift erscheinen, |
| 198 |
% weshalb auf die Auszeichnung folgender Seiten verzichtet wird. |
| 199 |
% \begin{macrocode} |
| 200 |
%^^A (require "ff-ranges.xdy")^^J% |
| 201 |
% \end{macrocode} |
| 202 |
% Bereiche mit mehr als zwei Seitenzahlen werden zusammengefasst, wobei als |
| 203 |
% Trennzeichen ein Halbgeviertstrich verwendet wird. |
| 204 |
% \begin{macrocode} |
| 205 |
(define-location-class "arabic-page-numbers"^^J% |
| 206 |
\@spaces("arabic-numbers")^^J% |
| 207 |
\@spaces:min-range-length 2^^J% |
| 208 |
)^^J% |
| 209 |
%<*doc> |
| 210 |
(define-location-class-order ("hypdoc" "arabic-page-numbers"))^^J% |
| 211 |
%</doc> |
| 212 |
(markup-range :sep "--")^^J% |
| 213 |
% \end{macrocode} |
| 214 |
% Alle Argumente in eckigen Klammern werden ignoriert. Dies wird bei einigen |
| 215 |
% Indexbefehlen genutzt, um die nicht beachteten RegExp-Regeln auszugleichen, |
| 216 |
% siehe den nächsten Absatz. In der Klasse \cls{tudscrdoc} werden außerdem im |
| 217 |
% Befehlsnamen enthaltene |@|"~Zeichen für die Sortierung gesondert behandelt. |
| 218 |
% \begin{macrocode} |
| 219 |
%<*doc> |
| 220 |
(merge-rule :again^^J% |
| 221 |
\@spaces"(.*)@(.*)"^^J% |
| 222 |
\@spaces"\string\1\string\2\space\string~e"^^J% |
| 223 |
)^^J% |
| 224 |
%</doc> |
| 225 |
(merge-rule :eregexp^^J% |
| 226 |
\@spaces"\string\[(.*)\string\]"^^J% |
| 227 |
\@spaces""^^J% |
| 228 |
)^^J% |
| 229 |
% \end{macrocode} |
| 230 |
% Innerhalb ausgewählter Auszeichnungs- und Textbefehle sollten die Befehle |
| 231 |
% selbst, nicht jedoch die Argumente verworfen werden. Leider lässt sich dies |
| 232 |
% momentan nicht umsetzen, da die manuell erstellten RegExp-Regeln durch |
| 233 |
% \hrfn{http://sourceforge.net/p/xindy/bugs/22/}{\app{texindy} nicht korrekt} |
| 234 |
% genutzt werden. |
| 235 |
% \begin{macrocode} |
| 236 |
%<*!doc> |
| 237 |
%^^A (merge-rule "\\hologo\{(.*)\}" "/1" :eregexp)^^J% |
| 238 |
%^^A (merge-rule "\\texttt\{(.*)\}" "/1" :eregexp)^^J% |
| 239 |
%^^A (merge-rule "\\textsbn\{(.*)\}" "/1" :eregexp)^^J% |
| 240 |
%^^A (merge-rule "\\textsbi\{(.*)\}" "/1" :eregexp)^^J% |
| 241 |
%</!doc> |
| 242 |
% \end{macrocode} |
| 243 |
% Für die Änderungsliste im Handbuch werden Untereinträge bis zur vierten Ebene |
| 244 |
% unterstützt. |
| 245 |
% \begin{macrocode} |
| 246 |
%<*!doc> |
| 247 |
(markup-indexentry :depth 3^^J% |
| 248 |
\@spaces:open\space\space"\string~n\string\subsubsubitem\space"^^J% |
| 249 |
)^^J% |
| 250 |
%</!doc> |
| 251 |
% \end{macrocode} |
| 252 |
% Für die Änderungsliste von \cls{tudscrdoc} erfolgt die Gruppierung anhand der |
| 253 |
% angegebenen Versionsnummer. Das bedeutet, das das Markup für die eigentliche |
| 254 |
% |letter-group| unterdrückt und die erste Ebene dafür verwendet wird. |
| 255 |
% \begin{macrocode} |
| 256 |
%<*doc> |
| 257 |
\if@tud@res@swa |
| 258 |
(markup-letter-group^^J% |
| 259 |
\@spaces:open-head\space\space"\string~n\space\space\string\@gobble{"^^J% |
| 260 |
\@spaces:close-head "}"^^J% |
| 261 |
)^^J% |
| 262 |
% \end{macrocode} |
| 263 |
% Leider gibt es für die Eintragsebenen keine Schlüssel |open-head| und |
| 264 |
% |close-head|, weshalb für die Änderungsliste etwas getrickst werden muss. |
| 265 |
% Zwischen Einträgen der ersten Ebene soll äquivalent zu |letter-group| etwas |
| 266 |
% Abstand eingefügt werden. |
| 267 |
% \begin{macrocode} |
| 268 |
(markup-indexentry-list :depth 0^^J% |
| 269 |
\@spaces:sep\space\space\space% |
| 270 |
"\string~n\string~n\space\space\string\indexspace\string~n"^^J% |
| 271 |
)^^J% |
| 272 |
% \end{macrocode} |
| 273 |
% Da jeder Eintrag in der Änderungsliste aus mindestens drei Ebenen besteht, |
| 274 |
% wird vor der ersten Ebene der Beginn des Markupbefehls gesetzt\dots |
| 275 |
% \begin{macrocode} |
| 276 |
(markup-indexentry \@spaces\space:depth 0^^J% |
| 277 |
\@spaces:open\space\space% |
| 278 |
"\string~n\space\space\string\@lettergroup\space"^^J% |
| 279 |
)^^J% |
| 280 |
% \end{macrocode} |
| 281 |
% \dots und vor Beginn der zweiten Ebene mit \cs{relax} terminiert. Diese |
| 282 |
% wird mit \cs{item} ausgezeichnet. |
| 283 |
% \begin{macrocode} |
| 284 |
(markup-indexentry-list :depth 1^^J% |
| 285 |
\@spaces:open\space\space"\string\relax"^^J% |
| 286 |
)^^J% |
| 287 |
(markup-indexentry \@spaces\space:depth 1^^J% |
| 288 |
\@spaces:open\space\space"\string~n\space\space\string\item\space"^^J% |
| 289 |
)^^J% |
| 290 |
% \end{macrocode} |
| 291 |
% Eine einzelne, nachfolgende Änderungsnotiz für den aktuellen Eintrag soll |
| 292 |
% direkt ausgegeben werden. Sind jedoch mehrere nachgelagerte Anmerkungen |
| 293 |
% vorhanden, so sollen diese in der nächsten Ebene ausgegeben werden. Da die |
| 294 |
% Anzahl aller Anmerkungen zu einem einzelnen Eintrag zu Beginn noch unbekannt |
| 295 |
% ist, werden alle dazugehörigen Änderungsnotizen zunächst mit \cs{tud@lst@add} |
| 296 |
% in der~-- zuvor mit dem Makro \cs{tud@lst@init} initialisierten~-- Liste |
| 297 |
% \cs{tud@lst@values} gesammelt und diese am Ende des jeweiligen Eintrags durch |
| 298 |
% \cs{tud@lst@process} ausgewertet. Sollte eine weitere Unterebene exisitieren, |
| 299 |
% werden entsprechend die Makros \cs{tud@lst@@init}, \cs{tud@lst@@values} und |
| 300 |
% \cs{tud@lst@@add} sowie \cs{tud@lst@@process} verwendet. |
| 301 |
% \begin{macrocode} |
| 302 |
(markup-indexentry-list :depth 2^^J% |
| 303 |
\@spaces:open\space\space"\string\tud@lst@init"^^J% |
| 304 |
\@spaces:close "\string~n \@spaces\space\string\tud@lst@process"^^J% |
| 305 |
)^^J% |
| 306 |
(markup-indexentry \@spaces\space:depth 2^^J% |
| 307 |
\@spaces:open% |
| 308 |
\space\space"\string~n\@spaces\space\space\string\tud@lst@add{"^^J% |
| 309 |
\@spaces:close "}"^^J% |
| 310 |
)^^J% |
| 311 |
(markup-indexentry-list :depth 3^^J% |
| 312 |
\@spaces:close "\string~n\@spaces\@spaces\string\tud@lst@@process{"^^J% |
| 313 |
\@spaces:open\space\space"}\string\tud@lst@@init"^^J% |
| 314 |
)^^J% |
| 315 |
(markup-indexentry \@spaces\space:depth 3^^J% |
| 316 |
\@spaces:open% |
| 317 |
\space\space"\string~n\@spaces\@spaces\string\tud@lst@@add{"^^J% |
| 318 |
\@spaces:close "}"^^J% |
| 319 |
)^^J% |
| 320 |
% \end{macrocode} |
| 321 |
% Für den Index aller Eintragstypen ist nur auf zu leere \cs{hbox} zu achten. |
| 322 |
% \begin{macrocode} |
| 323 |
\else |
| 324 |
(markup-indexentry-list :open "\string\efil" :depth 1)^^J% |
| 325 |
\fi |
| 326 |
%</doc> |
| 327 |
% \end{macrocode} |
| 328 |
% Punkte zwischen Eintrag und Seitenzahl. Das schließende \cs{relax} wird für |
| 329 |
% die smarte Definition des Befehls \cs{cleversee} benötigt, welcher nach den |
| 330 |
% beiden obligatorischen Argument die nachfolgenden Seitenzahlen sucht und |
| 331 |
% dabei durch \cs{relax} begrenzt wird. Für die Klasse \cls{tudscrdoc} wird in |
| 332 |
% der Änderungsliste der Hyperlink für die Seitenzahl respektive die Codezeile |
| 333 |
% direkt erzeugt. |
| 334 |
% \begin{macrocode} |
| 335 |
(markup-locclass-list^^J% |
| 336 |
%<!doc> \@spaces:open\space\space"\string\,\string\dotfill\string\,"^^J% |
| 337 |
%<doc> \@spaces:open\space\space"\string\pfill\space"^^J% |
| 338 |
\@spaces:close "\string\relax"^^J% |
| 339 |
\@spaces:sep\space\space\space",\space"^^J% |
| 340 |
)^^J% |
| 341 |
% \end{macrocode} |
| 342 |
% Es werden für Handbuch und Tutorials die Attribute \emph{!} für deklarierende |
| 343 |
% sowie \emph{?} für wichtige Einträge zusätzlich zu \emph{default} definiert. |
| 344 |
% |
| 345 |
% Einträge werden hierarchisch unterschieden. Standardeinträge \val{default} |
| 346 |
% werden ggf. von deklarierenden oder wichtigen Einträgen überschrieben bzw. |
| 347 |
% nicht separat gelistet. |
| 348 |
% \begin{macrocode} |
| 349 |
%<*!doc> |
| 350 |
(define-attributes (("!" "default") ("?" "default") ("default")))^^J% |
| 351 |
(markup-attribute-group-list :sep ", ")^^J% |
| 352 |
% \end{macrocode} |
| 353 |
% Hier erfolgt die Definition der Auszeichnugen der Attribute. Deklarationen |
| 354 |
% werden fett gedruckt, wichtige Einträge erscheinen kursiv. Außerdem wird ein |
| 355 |
% entsprechnder Link auf die Seite eingefügt. |
| 356 |
% \begin{macrocode} |
| 357 |
(markup-locref :attr "!"^^J% |
| 358 |
\@spaces:open\space\space"\string\textbf{\string\hyperpage{"^^J% |
| 359 |
\@spaces:close "}}"^^J% |
| 360 |
)^^J% |
| 361 |
(markup-locref :attr "?"^^J% |
| 362 |
\@spaces:open\space\space"\string\textit{\string\hyperpage{"^^J% |
| 363 |
\@spaces:close "}}"^^J% |
| 364 |
)^^J% |
| 365 |
(markup-locref :attr "default"^^J% |
| 366 |
\@spaces:open\space\space"\string\hyperpage{"^^J% |
| 367 |
\@spaces:close "}" ^^J% |
| 368 |
)^^J% |
| 369 |
%</!doc> |
| 370 |
% \end{macrocode} |
| 371 |
% Für \cls{tudscrdoc} erfolgen die Auszeichnungen für den Index im Stile von |
| 372 |
% \pkg{doc} vorallem mit den Attributen \emph{usage} für Erläuterung sowie |
| 373 |
% \emph{main} für Codedefinitionen und \emph{code} für Verweise auf die |
| 374 |
% Verwendung im Quellcode. Zusätzlich wird \emph{change} definiert, um auch |
| 375 |
% Änderungseinträge separat zu erfassen. Diese Attribute dienen \app{texindy} |
| 376 |
% lediglich für die Kategorisierung der Einträge, die Formatierung dieser für |
| 377 |
% die Ausgabe erfolgt mit \cs{tud@xdy@mapping}\marg{Attribut}\marg{Referenz}. |
| 378 |
% \begin{macrocode} |
| 379 |
%<*doc> |
| 380 |
(markup-attribute-group-list :sep ", ")^^J% |
| 381 |
(define-attributes (("usage") ("main") ("code") ("change") ("default")))^^J% |
| 382 |
(markup-locref :attr "change"^^J% |
| 383 |
\@spaces:open"\string\tud@xdy@mapping{change}{"^^J |
| 384 |
\@spaces:close "}"^^J% |
| 385 |
)^^J% |
| 386 |
(markup-locref :attr "code"^^J% |
| 387 |
\@spaces:open "\string\tud@xdy@mapping{code}{"^^J% |
| 388 |
\@spaces:close "}"^^J% |
| 389 |
)^^J% |
| 390 |
(markup-locref :attr "usage"^^J% |
| 391 |
\@spaces:open "\string\tud@xdy@mapping{usage}{"^^J% |
| 392 |
\@spaces:close "}"^^J% |
| 393 |
)^^J% |
| 394 |
(markup-locref :attr "main"^^J% |
| 395 |
\@spaces:open "\string\tud@xdy@mapping{main}{"^^J% |
| 396 |
\@spaces:close "}"^^J% |
| 397 |
)^^J% |
| 398 |
%</doc> |
| 399 |
% \end{macrocode} |
| 400 |
% Im Handbuch prüfen, mit \verb+|see+\marg{Eintrag} erzeugte Querverweise im |
| 401 |
% Index, ob außerdem noch Seitenzahlangaben existent sind. |
| 402 |
% \begin{macrocode} |
| 403 |
%<*!doc> |
| 404 |
(markup-crossref-list :class "see"^^J% |
| 405 |
\@spaces:open\space\space"\string\cleversee\space"^^J% |
| 406 |
\@spaces:sep\space\space\space"; "^^J% |
| 407 |
\@spaces:close "\@backslashchar\@backslashchar"^^J% |
| 408 |
)^^J% |
| 409 |
(markup-crossref-list :class "seealso"^^J% |
| 410 |
\@spaces:open\space\space"\string\cleverseealso\space"^^J% |
| 411 |
\@spaces:sep\space\space\space"; "^^J% |
| 412 |
\@spaces:close "\@backslashchar\@backslashchar"^^J% |
| 413 |
)^^J% |
| 414 |
% \end{macrocode} |
| 415 |
% Um Querverweise ohne Prüfung des Zieleintrags erzeugen zu können, wird der |
| 416 |
% passende Typ |seeunverified| definiert. |
| 417 |
% \begin{macrocode} |
| 418 |
%<*class> |
| 419 |
(define-crossref-class "seeunverified" :unverified)^^J% |
| 420 |
(markup-crossref-list :class "seeunverified"^^J% |
| 421 |
\@spaces:open\space\space"\string\cleversee\space"^^J% |
| 422 |
\@spaces:sep\space\space\space"; "^^J% |
| 423 |
\@spaces:close "\@backslashchar\@backslashchar"^^J% |
| 424 |
)^^J% |
| 425 |
% \end{macrocode} |
| 426 |
% Dieser Querverweistyp wird speziell im allgemeinen Index verwendet, um auf |
| 427 |
% einen Spezialindex zu verweisen. Dabei dient |:unverified| zum Unterdrücken |
| 428 |
% von Warnungen durch \app{texindy} aufgrund eines fehlenden Ziels für den |
| 429 |
% Querverweis. |
| 430 |
% \begin{macrocode} |
| 431 |
(define-crossref-class "seeidx" :unverified)^^J% |
| 432 |
(markup-crossref-list :class "seeidx"^^J% |
| 433 |
\@spaces:open\space\space"\string\seeidx{"^^J% |
| 434 |
\@spaces:sep\space\space\space"; "^^J% |
| 435 |
\@spaces:close "}{}"^^J% |
| 436 |
)^^J% |
| 437 |
%</class> |
| 438 |
% \end{macrocode} |
| 439 |
% Werden mit \verb+|see+\marg{Eintrag!Untereintrag} gezielte Querverweise auf |
| 440 |
% Untereinträge im Index erstellt, so werden diese nicht standardmäßig mit |
| 441 |
% einem Komma sondern mit dem anpassbaren Makro \cs{seesep} getrennt. |
| 442 |
% \begin{macrocode} |
| 443 |
(markup-crossref-layer-list :class "see"% |
| 444 |
\@spaces\space:sep "\string\seesep{}"% |
| 445 |
)^^J% |
| 446 |
(markup-crossref-layer-list :class "seealso"% |
| 447 |
\space:sep "\string\seesep{}"% |
| 448 |
)^^J% |
| 449 |
% \end{macrocode} |
| 450 |
% Damit die Makros \cs{cleversee} und \cs{cleverseealso} sowie \cs{seeidx} auf |
| 451 |
% nachfolgende Seitenzahlen suchen können, müssen diese vor selbigen im Index |
| 452 |
% aufgerufen werden. |
| 453 |
% \begin{macrocode} |
| 454 |
(define-location-class-order^^J% |
| 455 |
\@spaces(^^J% |
| 456 |
%<class> \@spaces"see" "seealso" "seeidx" "seeunverified"^^J% |
| 457 |
%<!class> \@spaces"see" "seealso"^^J% |
| 458 |
\@spaces"roman-page-numbers" "arabic-page-numbers" "alpha-page-numbers"^^J% |
| 459 |
\@spaces"Roman-page-numbers" "Alpha-page-numbers"^^J% |
| 460 |
\@spaces)^^J% |
| 461 |
)^^J% |
| 462 |
%</!doc> |
| 463 |
% \end{macrocode} |
| 464 |
% Damit ist die \app{texindy}-Stildatei fertig und kann mit \cs{tud@xdy@create} |
| 465 |
% erstellt werden. |
| 466 |
% \begin{macrocode} |
| 467 |
}% |
| 468 |
\immediate\closeout\tud@xdy@write% |
| 469 |
} |
| 470 |
\tud@xdy@create |
| 471 |
%<doc>\tud@xdy@create* |
| 472 |
%<doc>\fi |
| 473 |
% \end{macrocode} |
| 474 |
% \end{macro}^^A \tud@xdy@write |
| 475 |
% \end{macro}^^A \tud@xdy@@create |
| 476 |
% \end{macro}^^A \tud@xdy@create |
| 477 |
% |
| 478 |
% \PrintBackMatter |
| 479 |
% |
| 480 |
\endinput |