summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/ngerman/scrbase.tex
blob: b311b53be22dc2429a0c83034aac8e544d31e45b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
% ======================================================================
% scrbase.tex
% Copyright (c) Markus Kohm, 2002-2019
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
% This work may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c of the license.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX 
% version 2005/12/01 or later and of this work.
%
% This work has the LPPL maintenance status "author-maintained".
%
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrbase.tex
% Copyright (c) Markus Kohm, 2002-2019
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
% Die neuste Version dieser Lizenz ist
%   http://www.latex-project.org/lppl.txt
% und Version 1.3c ist Teil aller Verteilungen von LaTeX
% Version 2005/12/01 oder spaeter und dieses Werks.
%
% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
% (allein durch den Autor verwaltet).
%
% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
% 
% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
%
% Package scrbase for Package and Class Authors
% Maintained by Markus Kohm
%
% ----------------------------------------------------------------------
%
% Paket scrbase für Paket- und Klassenautoren
% Verwaltet von Markus Kohm
%
% ======================================================================

\KOMAProvidesFile{scrbase.tex}
                 [$Date: 2019-10-09 15:19:04 +0200 (Wed, 09 Oct 2019) $
                  KOMA-Script package scrbase]

\chapter{Grundlegende Funktionen im Paket \Package{scrbase}}
\labelbase{scrbase}
\BeginIndexGroup
\BeginIndex{Package}{scrbase}%

Das Paket \Package{scrbase} stellt einige grundlegende Funktionen bereit, die
sich an Autoren von Paketen und Klassen richten. Dabei kann es nicht nur für
Wrapper-Klassen genutzt werden, die ihrerseits eine \KOMAScript-Klasse
laden. Auch Autoren von Klassen, die ansonsten nichts mit \KOMAScript{} zu tun
haben, können von der Funktionalität von \Package{scrbase} profitieren.

\section{Laden des Pakets}
\seclabel{loadit}

Während Anwender ein Paket mit Hilfe von \Macro{usepackage} laden, verwenden
Paket- und Klassenautoren
\Macro{RequirePackage}\IndexCmd{RequirePackage}. Autoren von Wrapper-Paketen
nutzen auch
\Macro{RequirePackageWithOptions}\IndexCmd{RequirePackageWithOptions}. Bei
Verwendung von \Macro{RequirePackage} können wie bei
\Macro{usepackage}\IndexCmd{usepackage} Optionen angegeben
werden. Demgegenüber erhält das Paket bei \Macro{RequirePackageWithOptions}
alle Optionen, mit denen zuvor das Wrapper-Paket geladen wurde. Näheres zu
diesen Anweisungen ist \cite{latex:clsguide} zu entnehmen.

Das Paket \Package{scrbase} benötigt intern die Funktionalität des Pakets
\Package{keyval}\IndexPackage{keyval}\important{\Package{keyval}}. Diese kann
auch vom Paket \Package{xkeyval} zur Verfügung gestellt werden. Bei Bedarf
lädt \Package{scrbase} selbst \Package{keyval}.

Das Paket \Package{keyval} erlaubt es, Schlüssel zu definieren und diesen
Werten zuzuweisen.  Auch die Optionen, die \Package{scrbase} bereitstellt,
verwenden die \Package{keyval}-Syntax: \OptionVName{\PName{Schlüssel}}{Wert}%
\important{\OptionVName{\PName{Schlüssel}}{Wert}}.


\section{Schlüssel als Eigenschaften von Familien und deren Mitgliedern}
\seclabel{keyvalue}

Wie bereits in \autoref{sec:scrbase.loadit} erwähnt, setzt \Package{scrbase}
bei Schlüsseln und deren Werten auf das Paket \Package{keyval}. Allerdings
erweitert es dessen Funktionalität. Während bei \Package{keyval} ein Schlüssel
einer Familie gehört, kennt \Package{scrbase} zu jeder Familie auch noch
Familienmitglieder. Ein Schlüssel kann dann sowohl einer Familie als auch
einem oder mehreren Familienmitgliedern gehören. Außerdem kann ein Wert einem
Schlüssel eines Familienmitglieds, einem Schlüssel einer Familie oder einem
Schlüssel aller Familienmitglieder zugewiesen werden.

\begin{Declaration}
  \Macro{DefineFamily}\Parameter{Familienname}
  \Macro{DefineFamilyMember}\OParameter{Mitglied}\Parameter{Familienname}
\end{Declaration}
\Package{scrbase} muss aus verschiedenen Gründen die Mitglieder einer Familie
kennen. Daher ist es notwendig, eine neue Familie zunächst mit
\Macro{DefineFamily} zu definieren und so eine leere Mitgliederliste zu
erzeugen. Ist die Familie bereits definiert, so geschieht schlicht nichts. Es
wird also auch nicht eine bereits existierende Mitgliederliste überschrieben.

Ein neues Mitglied wird der Familie dann mit der Anweisung
\Macro{DefineFamilyMember} bekannt gegeben. Existiert die Familie nicht, so
führt dies zu einer Fehlermeldung. Existiert das Mitglied bereits, so
geschieht nichts. Wird kein Mitglied angegeben, so bleibt das Mitglied nicht
etwa leer, sondern es wird
»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« angenommen. Während
des Ladens einer Klasse oder eines Pakets sind \Macro{@currname} und
\Macro{@currext} zusammen der Dateiname.

Theoretisch wäre es möglich, mit einem leeren optionalen Argument
\PName{Mitglied} auch ein Mitglied ohne Name zu definieren. Dies würde jedoch
der Familie selbst entsprechen. Es wird empfohlen, als \PName{Familienname} nur
Buchstaben und Ziffern zu verwenden und das \PName{Mitglied} immer mit einem
anderen Zeichen, vorzugsweise einem Punkt, zu beginnen. Anderenfalls könnte
es passieren, dass sich Mitglieder einer Familie mit Mitgliedern anderer
Familien überdecken.

\Package{scrbase} definiert selbst bereits die Familie »\PValue{KOMA}« und
fügt ihr das Mitglied »\PValue{.scrbase.sty}« hinzu. Grundsätzlich sind die
Familien »\PValue{KOMA}« und »\PValue{KOMAarg}« \KOMAScript{} vorbehalten. Es
wird empfohlen, für eigene Pakete den Namen des Gesamtpakets als Familie und
den Namen einzelner Pakete im Gesamtpaket als Mitglied zu verwenden.
%
\begin{Example}
  Angenommen, Sie schreiben ein neues Gesamtpaket »Fleischermeister«. Darin
  befinden sich die Pakete \File{Salami.sty}, \File{Mettwurst.sty} und
  \File{Krakauer.sty}. Daher entscheiden Sie sich für den Familienname
  »\PValue{Fleischermeister}« und fügen in jedem der Pakete die Zeilen
% Umbruchoptimierung: listings
\begin{lstcode}[aboveskip=0pt plus \dp\strutbox]
  \DefineFamily{Fleischermeister}
  \DefineFamilyMember{Fleischermeister}
\end{lstcode}
  ein. Dadurch wird beim Laden der drei genannten Pakete der Familie
  »\PValue{Fleischermeister}« je nach Paket eines der drei Mitglieder
  »\PValue{.Salami.sty}«, »\PValue{.Mettwurst.sty}« und
  »\PValue{.Krakauer.sty}« zugefügt. Am Ende sind dann alle drei Mitglieder
  definiert.
\end{Example}
%
\EndIndexGroup


\begin{Declaration}
  \Macro{DefineFamilyKey}\OParameter{Mitglied}\Parameter{Familie}%
                         \Parameter{Schlüssel}
                         \OParameter{Säumniswert}\Parameter{Aktion}
  \Macro{FamilyKeyState}
  \Macro{FamilyKeyStateUnknown}
  \Macro{FamilyKeyStateProcessed}
  \Macro{FamilyKeyStateUnknownValue}
  \Macro{FamilyKeyStateNeedValue}
\end{Declaration}
Mit dieser Anweisung wird ein \PName{Schlüssel} definiert. Ist ein
\PName{Mitglied} angegeben, so ist der \PName{Schlüssel} eine Eigenschaft
dieses Mitglieds der angegebenen \PName{Familie}. Ist\textnote{Hinweis}
\OParameter{Mitglied} nicht angegeben, so wird wieder das Mitglied
»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« angenommen. Ist das
\PName{Mitglied} hingegen leer, so wird ein Familienschlüssel anstelle eines
Mitgliederschlüssels definiert.

Wird später dem \PName{Schlüssel} ein Wert zugewiesen, so wird \PName{Aktion}
ausgeführt, wobei der Wert als Parameter übergeben wird. Innerhalb von
\PName{Aktion} steht also »\lstinline{#1}« für den übergebenen Wert. Wurde
kein Wert übergeben, so wird stattdessen der \PName{Säumniswert}
eingesetzt. Falls kein \PName{Säumniswert} angegeben wird, kann später der
\PName{Schlüssel} nur mit Wertübergabe verwendet werden.

%\begin{Explain}
  \phantomsection\label{explain:scrbase.macro.DefineFamilyKey}%
  Letztlich führt
\begin{lstcode}[escapeinside=><]
  \DefineFamilyKey[>\PName{Mitglied}<]{>\PName{Familie}<}{>\PName{Schlüssel}<}
                  [>\PName{Säumniswert}<]{>\PName{Aktion}<}
\end{lstcode}
  zu dem Aufruf
\begin{lstcode}[moretexcs={define@key},escapeinside=><]
  \define@key{>\PName{Familie\,Mitglied}<}{>\PName{Schlüssel}<}
             [>\PName{Säumniswert}<]{>\PName{erweiterte Aktion}<}
\end{lstcode}
  wobei \Macro{define@key} im \Package{keyval}-Paket\IndexPackage{keyval}
  definiert ist (siehe \cite{package:keyval}). Allerdings kommen zu dem Aufruf
  von \Macro{define@key} noch einige zusätzliche Vorkehrungen und auch die
  \PName{Aktion} wird um zusätzliche Vorkehrungen erweitert.
%\end{Explain}

Erfolg\ChangedAt{v3.12}{\Package{scrbase}} oder Misserfolg der Ausführung der
\PName{Aktion} werden über
\Macro{FamilyKeyState} %\important{\Macro{FamilyKeyState}} % einige davon sind
                                                           % schlicht zu breit!
an \Package{scrbase} zurückgemeldet, damit dieses je nach Bedarf und
Verwendung des Schlüssels weitere Maßnahmen ergreifen kann. Dies kann
beispielsweise eine Fehlermeldung aber auch nur die Signalisierung einer
unbekannten Option sein.

Der Zustand \Macro{FamilyKeyState} ist in der Voreinstellung identisch mit dem
Zustand \Macro{FamilyKeyStateUnknown}. Das bedeutet, dass es nicht sicher ist,
ob der Schlüssel korrekt verarbeitet werden konnte. Findet \Package{scrbase}
nach Ausführung der \PName{Aktion} noch immer diesen Zustand vor, so wird ein
Hinweis in die \File{log}-Datei geschrieben und im weiteren der Zustand
\Macro{FamilyKeyStateProcessed} angenommen.

Der Zustand
\Macro{FamilyKeyStateProcessed} %\important{\Macro{FamilyKeyStateProcessed}}
signalisiert, dass der Schlüssel und die Wertzuweisung an den Schlüssel
vollständig abgeschlossen wurde und alles in Ordnung ist. Auf den Zustand kann
einfach durch Aufruf von \Macro{FamilyKeyStateProcessed} selbst umgeschaltet
werden.

Der Zustand
\Macro{FamilyKeyStateUnknownValue} %\important{\Macro{FamilyKeyStateUnknownValue}}
signalisiert, dass der Schlüssel zwar verarbeitet wurde, ihm jedoch ein Wert
zugewiesen werden sollte, der nicht erlaubt ist. Diesen Zustand meldet
beispielsweise \hyperref[cha:typearea]{\Package{typearea}}, wenn versucht
wird, an Option \DescRef{typearea.option.twoside} den Wert \PValue{unbekannt}
zuzuweisen. Die Umschaltung auf den Zustand erfolgt einfach durch Aufruf von
\Macro{FamilyKeyStateUnknownValue} selbst.

Der Zustand
\Macro{FamilyKeyStateNeedValue} %\important{\Macro{FamilyKeyStateNeedValue}}
signalisiert, dass der Schlüssel nicht verarbeitet werden konnte, weil er
zwingend einen Wert erwartet, er aber ohne Wertzuweisung aufgerufen
wurde. Dieser Zustand wird automatisch gesetzt, wenn ein Schlüssel, der keinen
\PName{Säumniswert} besitzt, ohne Wertzuweisung verwendet wird. Theoretisch
wäre aber auch eine explizite Umschaltung darauf durch Aufruf von
\Macro{FamilyKeyStateNeedValue} selbst möglich.

Des Weiteren können zusätzliche Fehlerzustände definiert werden, indem man
\Macro{FamilyKeyState} auf eine kurze Meldung umdefiniert. In der Regel
sollten jedoch die vier vordefinierten Zustände verwendet werden.

\begin{Example}
  Nehmen wir an, jedes der drei Pakete aus dem letzten Beispiel soll einen
  Schlüssel \PValue{Aufschnitt} erhalten. Wird dieser aufgerufen, so soll in
  jedem der Pakete entsprechend dem Aufrufwert ein Schalter gesetzt
  werden. Für das Paket \Package{Salami} könnte das beispielsweise so
  aussehen:
\begin{lstcode}
  \newif\if@Salami@Aufschnitt
  \DefineFamilyKey{Fleischermeister}%
                  {Aufschnitt}[true]{%
    \expandafter\let
    \expandafter\if@Salami@Aufschnitt
    \csname if#1\endcsname
    \FamilyKeyStateProcessed
  }
\end{lstcode}
  Als Wert ist daher beim Aufruf \PValue{true} oder \PValue{false}
  erlaubt. Ein Test auf unerlaubte Werte existiert in diesem Beispiel
  nicht. Stattdessen wird immer zurückgemeldet, dass der Schlüssel vollständig
  und korrekt verarbeitet wurde. Wird der Schlüssel später verwendet, so muss
  entweder einer der erlaubten Werte zugewiesen oder ein Aufruf ohne
  Wertzuweisung verwendet werden. In letzterem Fall kommt der Säumniswert
  \PName{true} zum Einsatz.

  Für die anderen beiden Pakete kann das fast identisch definiert
  werden. Lediglich die Zeichenfolge »\texttt{Salami}« ist jeweils zu
  ersetzen.
\end{Example}
%
\EndIndexGroup


\begin{Declaration}
  \Macro{RelaxFamilyKey}\OParameter{Mitglied}\Parameter{Familie}
                        \Parameter{Schlüssel}
\end{Declaration}
Wurde\ChangedAt{v3.15}{\Package{scrbase}} \PName{Schlüssel} zuvor als
\PName{Mitglied} der \PName{Familie} definiert, so wird diese Definition
quasi aufgehoben. Der \PName{Schlüssel} ist dann für dieses \PName{Mitglied}
der \PName{Familie} nicht mehr definiert. Die Verwendung für einen
\PName{Schlüssel}, der für dieses \PName{Mitglied} der \PName{Familie} gar
nicht definiert ist, ist ebenfalls zulässig.

Ist kein \PName{Mitglied} angegeben, so wird genau wie bei Anweisung
\DescRef{\LabelBase.cmd.DefineFamilyKey} wieder das Mitglied
»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« angenommen. Allerdings
wird \Macro{RelaxFamilyKey} selten während des Ladens eines Pakets,
sondern häufiger zur Laufzeit verwendet. Daher ist \PName{Mitglied} in der
Regel auch explizit anzugeben.%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyProcessOptions}\OParameter{Mitglied}\Parameter{Familie}
\end{Declaration}
Grundsätzlich ist die Erweiterung der Schlüssel von Familien auf Familien und
Familienmitglieder dazu gedacht, dass Schlüssel beziehungsweise die
Wertzuweisung an Schlüssel als ganz normale Klassen- oder Paketoptionen
verwendet werden können. Diese Anweisung stellt daher eine Erweiterung von
\Macro{ProcessOptions*}\IndexCmd{ProcessOptions*}%
\important{\Macro{ProcessOption*}} aus dem \LaTeX-Kern dar (siehe
\cite{latex:clsguide}). Dabei verarbeitet die Anweisung nicht nur Optionen,
die mit \Macro{DeclareOption}\IndexCmd{DeclareOption}%
\important{\Macro{DeclareOption}} definiert wurden. Es werden auch alle
Schlüssel eines angegebenen Familienmitglieds abgearbeitet. Wird das optionale
Argument \PName{Mitglied} nicht angegeben, so wird wieder das Mitglied
»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« verwendet.

Eine Besonderheit sind Schlüssel, die nicht einem Familienmitglied, sondern
der Familie selbst zugeordnet sind, bei der also das Mitglied leer geblieben
ist. Diese werden ebenfalls gesetzt und zwar noch bevor der Schlüssel des
Mitglieds gesetzt wird.
\begin{Example}
  Wenn in den Paketen aus den zurückliegenden Beispielen nach der Definition
  der Schlüssel die Zeile
\begin{lstcode}
  \FamilyProcessOptions{Fleischermeister}
\end{lstcode}
  ergänzt wird, so kann der Anwender bereits beim Laden der Pakete mit
  \Macro{usepackage} die Eigenschaft \Option{Aufschnitt} als Option
  angeben. Wird die Option global, also bei \Macro{documentclass}, angegeben,
  so wird die Eigenschaft automatisch bei allen drei Paketen gesetzt, wenn
  alle drei Pakete einzeln geladen werden.
\end{Example}
Es\textnote{Achtung!} wird darauf hingewiesen, dass bei Paketen globale
Optionen vor den lokal dem Paket zugewiesenen Optionen ausgeführt
werden. Während bei der Abarbeitung der globalen Optionen unbekannte Werte für
Optionen dazu führen, dass darüber lediglich in der \File{log}-Datei
informiert und die Option ansonsten ignoriert wird, führt dies bei lokalen
Optionen zu einer Fehlermeldung.

Man kann \Macro{FamilyProcessOptions} wahlweise als Erweiterung von
\Macro{ProcessOption*} oder als Erweiterung des
\PName{Schlüssel=Wert}-Mechanismus von \Package{keyval} verstehen. Letztlich
werden mit Hilfe von \Macro{FamilyProcessOptions} aus
\PName{Schlüssel=Wert}-Paaren Optionen.

Wie\textnote{Achtung!} auch \Macro{ProcessOptions} darf
\Macro{FamilyProcessOptions} nicht während der Ausführung von Optionen
verwendet werden. Es ist also insbesondere auch nicht erlaubt, innerhalb der
Ausführung von Optionen Pakete zu laden.%, die selbst
%\Macro{FamilyProcessOptions} verwenden.%
%
\EndIndexGroup


\begin{Declaration}
  \Macro{BeforeFamilyProcessOptions}\OParameter{Mitglied}\Parameter{Familie}%
                                    \Parameter{Code}%
\end{Declaration}
Insbesondere\ChangedAt{v3.18}{\Package{scrbase}} Autoren von Wrapper-Klassen
wünschen manchmal, in ein Paket oder eine Klasse noch vor der Verarbeitung der
Optionen eines zukünftig geladenen Pakets oder einer zukünftig geladenen
Klasse mit \DescRef{\LabelBase.cmd.FamilyProcessOptions} eingreifen zu
können. Dies ist mit \Macro{BeforeFamilyProcessOptions} möglich. Das Paket
\Package{scrbase} bietet dafür einen sogenannten Haken\Index{Haken}
(engl. \emph{hook}). Diesem kann man mit \Macro{BeforeFamilyProcessOptions}
neuen \PName{Code} hinzufügen. Die Parameter \PName{Mitglied} und
\PName{Familie} entsprechen dabei denen von
\Macro{FammilyProcessOptions}. Allerdings kann man auch den Haken von
Familien-Mitgliedern \PName{Code} hinzufügen, wenn bisher die \PName{Familie}
oder das \PName{Mitglied} noch gar nicht definiert ist.

Der Haken eines Familien-Mitglieds wird übrigens nach dessen Ausführung
automatisch gelöscht. Verwendet man hingegen ein leeres \PName{Mitglied}, so
wird dieser Haken\Index{Haken} für alle Mitglieder der \PName{Familie}
ausgeführt und bleibt auch über die Ausführung hinaus erhalten.

\begin{Example}
  Sie schreiben ein Paket \Package{Rauchwurst}, das selbst \Package{Mettwurst}
  lädt. Allerdings wollen Sie nicht, dass für dieses Paket die Option
  \Option{Aufschnitt} gesetzt werden kann. Daher deaktivieren sie die Option
  vor dem Laden des Pakets über \Macro{BeforeFamilyProcessOptions}.
\begin{lstcode}
  \RequirePackage{scrbase}
  \BeforeFamilyProcessOptions[.Mettwurst.sty]%
                             {Fleischermeister}{%
    \RelaxFamilyKey[.Mettwurst.sty]%
                   {Fleischermeister}{Aufschnitt}%
  }
  \RequirePackageWithOptions{Mettwurst}
\end{lstcode}
  Versucht nun jemand Ihr Paket mit Option
  \Option{Aufschnitt} zu laden, so meldet das Paket \Package{Mettwurst}, dass
  diese Option nicht bekannt ist. Wird die Option \Option{Aufschnitt} als
  globale Option angegeben, so ignoriert Paket \Package{Mettwurst}
  diese. Voreinstellungen innerhalb des Pakets \Package{Mettwurst}, die
  beispielsweise mit \DescRef{\LabelBase.cmd.FamilyExecuteOptions} noch vor
  \DescRef{\LabelBase.cmd.FamilyProcessOptions} erfolgen könnten, wären
  allerdings davon unabhängig. Aber natürlich kann man eigene
  Voreinstellungen von \Package{Rauchwurst} aus ebenfalls per
  \Macro{BeforeFamilyProcessOptions} in \Package{Mettwurst} einschleusen.%
\end{Example}
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyExecuteOptions}\OParameter{Mitglied}\Parameter{Familie}%
                              \Parameter{Optionenliste}
\end{Declaration}
Diese Anweisung stellt eine Erweiterung von
\Macro{ExecuteOptions} aus dem \LaTeX-Kern dar (siehe
\cite{latex:clsguide}). Dabei verarbeitet die Anweisung nicht nur Optionen,
die mit \Macro{DeclareOption} definiert wurden. Es werden auch alle Schlüssel
eines angegebenen Familienmitglieds abgearbeitet. Wird das optionale Argument
\PName{Mitglied} nicht angegeben, so wird wieder das Mitglied
»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« verwendet.

Eine Besonderheit sind Schlüssel, die nicht einem Familienmitglied, sondern
der Familie selbst zugeordnet sind, bei der also das Mitglied leer geblieben
ist. Diese werden ebenfalls gesetzt, und zwar noch bevor der Schlüssel des
Mitglieds gesetzt wird.
\begin{Example}
  Angenommen, die Option \Option{Aufschnitt} soll in den zurückliegenden
  Beispielen bereits als Voreinstellung gesetzt werden, so müssen die Pakete
  nur um den Aufruf
\begin{lstcode}
  \FamilyExecuteOptions{Fleischermeister}
                       {Aufschnitt}
\end{lstcode}
  ergänzt werden.
\end{Example}

Wird\ChangedAt{v3.20}{\Package{scrbase}} \Macro{FamilyExecuteOptions} mit
einer nicht definierten Option in der \PName{Optionenliste} aufgerufen, so
wird normalerweise ein Fehler ausgegeben. Eine Ausnahme von dieser Regel ist,
wenn für das \PName{Mitglied} eine Option namens
\Option{@else@}\important{\Option{@else@}} definiert wurde. In diesem Fall
wird statt der unbekannten Option eben diese Option \Option{@else@}
verwendet. Der an \Option{@else@} übergebene Wert ist dabei die nicht
definierte Option mit dem im Aufruf angegebenen Wert.  Innerhalb von
\KOMAScript{} wird das beispielsweise genutzt, um die Stil-Option bei der
Definition von Gliederungsbefehlen vor allen anderen auszuwerten.

Diese Anweisung darf auch innerhalb der Ausführung von Optionen verwendet
werden.%
%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyOptions}\Parameter{Familie}\Parameter{Optionenliste}%
\end{Declaration}
Im Gegensatz zu normalen Optionen, die mit \Macro{DeclareOption} definiert
wurden, können die \PName{Schlüssel} auch noch nach dem Laden der Klasse oder
des Pakets gesetzt werden. Dazu verwendet der Anwender
\Macro{FamilyOptions}. Die \PName{Optionenliste} hat dabei die Form:
%\begin{flushleft}\begin{tabular}{l}
    \PName{Schlüssel}\texttt{=}\PName{Wert}\texttt{,}\linebreak[1]%
    \PName{Schlüssel}\texttt{=}\PName{Wert} \dots{}
%\end{tabular}\vskip\dp\strutbox\end{flushleft}
wobei für \PName{Schlüssel}, für die ein Säumniswert definiert ist, die
Wertzuweisung natürlich auch entfallen kann.

Durch die Anweisung werden die \PName{Schlüssel} aller Mitglieder der
angegebenen \PName{Familie} gesetzt. Existiert ein \PName{Schlüssel} auch als
Eigenschaft der Familie selbst, so wird dieser Familien-Schlüssel zuerst
gesetzt. Danach folgen die Mitglieder-Schlüssel in der Reihenfolge, in der die
Mitglieder definiert wurden. Existiert ein angegebener \PName{Schlüssel} weder
für die Familie noch für ein Mitglied der Familie, so wird von
\Macro{FamilyOptions} ein Fehler ausgegeben. Dies geschieht ebenfalls, wenn
zwar für einige Mitglieder ein Schlüssel existiert, jedoch jedes dieser
Mitglieder über \DescRef{\LabelBase.cmd.FamilyKeyState} einen Fehler
zurückmeldet.
\begin{Example}
  Sie ergänzen das Fleischermeister-Projekt um ein weiteres Paket
  \Package{Wurstsalat}. Wird dieses Paket verwendet, so sollen alle
  Wurstpakete zunächst einmal Aufschnitt produzieren:
\begin{lstcode}
  \ProvidesPackage{Wurstsalat}%
                  [2008/05/06 nonsense package]
  \RequirePackage{scrbase}
  \DefineFamily{Fleischermeister}
  \DefineFamilyMember{Fleischermeister}
  \FamilyProcessOptions{Fleischermeister}\relax
  \FamilyOptions{Fleischermeister}{Aufschnitt}
\end{lstcode}
  Sollte noch kein Wurstpaket geladen sein, so würde nun eine Fehlermeldung
  wegen der nicht definierten Option »\Option{Aufschnitt}« ausgegeben. Das
  kann vermieden werden, indem vor der letzten Zeile für das Paket selbst
  ebenfalls ein entsprechender Schlüssel definiert wird:
\begin{lstcode}
  \DefineFamilyKey{Fleischermeister}%
                  {Aufschnitt}[true]{}%
\end{lstcode}
  Allerdings produzieren so Wurstpakete, die nach Paket
  \Package{Wurstsalat} geladen werden, keinen Aufschnitt. Dies kann man
  ebenfalls ändern:
\begin{lstcode}
  \AtBeginDocument{%
    \DefineFamilyKey[.Wurstsalat.sty]%
                    {Fleischermeister}%
                    {Aufschnitt}[true]{}%
  }
  \DefineFamilyKey{Fleischermeister}%
                  {Aufschnitt}[true]{%
    \AtBeginDocument{%
      \FamilyOptions{Fleischermeister}%
                    {Aufschnitt=#1}%
    }%
  }%
\end{lstcode}
  Somit wird zunächst während \Macro{begin}\PParameter{document} die Option so
  definiert, dass sie für das Paket \Package{Wurstsalat} keine Funktion mehr
  ausübt. Da nach dem Laden von \Package{Wurstsalat}, innerhalb von
  \Macro{begin}\PParameter{document} die beiden Anweisungen \Macro{@currname}
  und \Macro{@currext} nicht mehr den Dateinamen des Pakets enthalten, muss
  zwingend das optionale Argument von \DescRef{\LabelBase.cmd.DefineFamilyKey}
  verwendet werden.

  Bis zu dieser Umdefinierung der Option wird jedoch eine Definition
  verwendet, die während \Macro{begin}\PParameter{document} die Option erneut
  für die Familie und all ihre Mitglieder ausführt und damit auch für andere
  Wurstpakete setzt. Die Verzögerung der Ausführung von \Macro{FamilyOptions}
  ist hier entscheidend. Zum einen werden nur so später geladene Wurstpakete
  erfasst. Zum anderen wird dadurch sichergestellt, dass die eigene Option
  \Option{Aufschnitt} bereits umdefiniert wurde. Dadurch wird eine endlose
  Rekursion vermieden.%
\end{Example}%

Wie\ChangedAt{v3.27}{\Package{scrbase}} schon bei
\DescRef{\LabelBase.cmd.FamilyExecuteOptions} gibt es auch bei
\Macro{FamilyOptions} eine Sonderbehandlung für eine Option Namens
\Option{@else@}\important{\Option{@else@}}. Ist eine solche für ein Mitglied
definiert, so wird sie immer dann ausgeführt, wenn das Mitglied eine
angegebene Option nicht kennt. Ist für die Familie selbst eine Option
\Option{@else@} definiert, so wird sie nur aufgerufen, wenn weder die Familie
noch eines ihrer Mitglieder eine angegebene Option vollständig verarbeiten
konnte und mit \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} quitiert hat.%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyOption}\Parameter{Familie}%
                      \Parameter{Option}\Parameter{Werteliste}%
\end{Declaration}
Neben Optionen, die sich gegenseitig ausschließende Werte besitzen, kann es
auch Optionen geben, die gleichzeitig mehrere Werte annehmen können. Für diese
wäre es bei Verwendung von \DescRef{\LabelBase.cmd.FamilyOptions} notwendig,
der Option mehrfach einen Wert zuzuweisen und dabei die Option selbst mehrfach
anzugeben. Stattdessen kann man einfach mit \Macro{FamilyOption} einer
einzigen \PName{Option} eine ganze \PName{Werteliste} zuweisen. Die
\PName{Werteliste} ist dabei eine durch Komma separierte Liste von Werten:
%\begin{flushleft}\begin{tabular}{l}
    \PName{Wert}\texttt{,}\PName{Wert} \dots{}
%\end{tabular}\end{flushleft}
In diesem Zusammenhang sei darauf hingewiesen, dass die Verwendung eines
Kommas in einem Wert möglich ist, wenn man den Wert in geschweifte Klammern
setzt. Die weitere Funktionsweise ist der vorhergehenden Erklärung zu
\DescRef{\LabelBase.cmd.FamilyOptions} zu entnehmen.
\begin{Example}
  Das Paket \Package{Wurstsalat} soll eine Option bekommen, über die man
  weitere Zutaten bestimmen kann. Für jede Zutat wird dabei wieder ein
  Schalter gesetzt.
\begin{lstcode}
  \newif\if@salatmit@Zwiebeln
  \newif\if@salatmit@Gurken
  \newif\if@salatmit@Peperoni
  \DefineFamilyKey{Fleischermeister}{SalatZusatz}{%
    \csname @salatmit@#1true\endcsname
  }
\end{lstcode}
  Es wurden hier die drei Zutaten »Zwiebeln«, »Gurken« und »Peperoni«
  definiert. Eine Fehlerbehandlung für den Fall, dass der Anwender unbekannte
  Zutaten fordert, existiert nicht.

  Für einen Salat mit Zwiebeln und Gurken kann der Anwender
\begin{lstcode}
  \FamilyOptions{Fleischermeister}{%
    SalatZusatz=Zwiebeln,SalatZusatz=Gurken}
\end{lstcode}
  oder einfach
\begin{lstcode}
  \FamilyOption{Fleischermeister}%
               {SalatZusatz}{Zwiebeln,Gurken}
\end{lstcode}
  verwenden.
\end{Example}

Die\ChangedAt{v3.27}{\Package{scrbase}} Verarbeitung einer Option
\Option{@else@} findet in derselben Weise statt wie bei
\DescRef{\LabelBase.cmd.FamilyOptions}.%
\EndIndexGroup


\begin{Declaration}
  \Macro{AtEndOfFamilyOptions}\Parameter{Aktion}%
  \Macro{AtEndOfFamilyOptions*}\Parameter{Aktion}%
\end{Declaration}
Manchmal\ChangedAt{v3.12}{\Package{scrbase}} ist es vorteilhafter, wenn nicht
jede Wertzuweisung an eine Option unmittelbar eine \PName{Aktion} auslöst,
sondern dies erst geschieht, wenn alle Wertzuweisungen innerhalb eines Aufrufs
von
\DescRef{\LabelBase.cmd.FamilyProcessOptions}\IndexCmd{FamilyProcessOptions}
oder
\DescRef{\LabelBase.cmd.FamilyExecuteOptions}\IndexCmd{FamilyExecuteOptions}
beziehungsweise \DescRef{\LabelBase.cmd.FamilyOptions}\IndexCmd{FamilyOptions}
oder \DescRef{\LabelBase.cmd.FamilyOption}\IndexCmd{FamilyOptions}
abgeschlossen sind. Genau das ist mit Hilfe von \Macro{AtEndOfFamilyOptions}
und dessen Sternvariante\ChangedAt{v3.23}{\Package{scrbase}} möglich. Die
Rückmeldung von Fehlerzuständen ist über diese Anweisung jedoch ebenso wenig
möglich wie die Verwendung dieser Anweisung außerhalb der Ausführung von
Optionen.

Die beiden Variante unterscheiden sich im Falle von verschachtelt definierten
Optionen, wenn also die Ausführung einer Option den Aufruf einer oder mehrerer
anderen Option bedingt. In diesem Fall werden alle per
\Macro{AtEndOfFamilyOptions} festgelegten Aktionen ausgeführt, sobald der
innerste Optionenaufruf endet. Dagegen werden die per
\Macro{AtEndOfFamilyOptions*} festgelegten Aktionen erst mit dem Ende des
äußersten Optionenaufrufs ausgeführt. Die Reihenfolge\textnote{Achtung!} der
Aktionen ist dabei jedoch ausdrücklich unbestimmt! Weder ist sichergestellt,
dass zuerst angeforderte Aktionen auch zuerst ausgeführt werden, noch die
umgekehrte Reihenfolge.%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyBoolKey}\OParameter{Mitglied}\Parameter{Familie}
                       \Parameter{Schlüssel}\Parameter{Schaltername}
  \Macro{FamilySetBool}\Parameter{Familie}
                       \Parameter{Schlüssel}\Parameter{Schaltername}
                       \Parameter{Wert}
\end{Declaration}
In den vorherigen Beispielen wurden schon mehrfach Schalter gesetzt. Im
Beispiel der Option \Option{Aufschnitt} war es dabei notwendig, dass der
Anwender als Wert \PValue{true} oder \PValue{false} angibt. Es existierte
keine Fehlerbehandlung, falls der Anwender einen falschen Wert verwendet. Da
solche booleschen Schalter ein häufiger Anwendungsfall sind, kann man sie bei
\Package{scrbase} einfach mit \Macro{FamilyBoolKey} definieren. Dabei sind die
Argumente \PName{Mitglied}, \PName{Familie} und \PName{Schlüssel} die gleichen
wie bei \DescRef{\LabelBase.cmd.DefineFamilyKey} (siehe
\DescPageRef{scrbase.cmd.DefineFamilyKey}). Das Argument \PName{Schaltername}
ist der Name eines Schalter ohne den Präfix \Macro{if}. Existiert dieser
Schalter noch nicht, so wird er automatisch definiert und mit \PName{false}
voreingestellt. Intern verwendet \Macro{FamilyBoolKey} dann
\Macro{FamilySetBool} als \PName{Aktion} für
\DescRef{\LabelBase.cmd.DefineFamilyKey}. Der Säumniswert für eine solche
Option ist immer \PValue{true}.

\Macro{FamilySetBool} wiederum versteht als \PName{Wert} neben \PValue{true}
auch die Werte \PValue{on} und \PValue{yes} zum Einschalten und neben
\PValue{false} auch die Werte \PValue{off} und \PValue{no} zum
Ausschalten. Wird ein unbekannter Wert übergeben, so wird die Anweisung
\DescRef{\LabelBase.cmd.FamilyUnknownKeyValue} mit den Argumenten
\PName{Familie}, \PName{Schlüssel} und \PName{Wert} aufgerufen und so
\DescRef{\LabelBase.cmd.FamilyKeyState} entsprechend gesetzt. Dadurch wird
dann gegebenenfalls eine Meldung über eine unbekannte Wertzuweisung ausgegeben
(siehe auch \DescPageRef{\LabelBase.cmd.FamilyUnknownKeyValue} und
\DescPageRef{\LabelBase.cmd.FamilyKeyState}).
\begin{Example}
  Der Schlüssel \Option{Aufschnitt} soll in den Wurstpaketen etwas robuster
  definiert werden. Außerdem sollen alle Wurstpakete denselben Schalter
  verwenden, so dass entweder alle Wurstpakete Aufschnitt produzieren oder
  keines.
\begin{lstcode}
  \FamilyBoolKey{Fleischermeister}{Aufschnitt}%
                                  {@Aufschnitt}
\end{lstcode}
  Ein Test, ob Aufschnitt produziert wird, sähe dann so aus:
\begin{lstcode}
  \if@Aufschnitt
     ...
  \else
     ...
  \fi
\end{lstcode}
  Dies wäre in allen drei Wurstpaketen identisch. Damit könnte man
  prinzipiell die Eigenschaft »Aufschnitt« auch als Eigenschaft der Familie
  definieren:
\begin{lstcode}[moretexcs={define@key}]
  \@ifundefined{if@Aufschnitt}{%
    \expandafter\newif
    \csname if@Aufschnitt\endcsname
  }{}%
  \DefineFamilyKey[]{Fleischermeister}%
                    {Aufschnitt}[true]{%
    \FamilySetBool{Fleischermeister}%
                  {Aufschnitt}%
                  {@Aufschnitt}%
                  {#1}%
  }
\end{lstcode}
  oder einfacher
\begin{lstcode}
  \FamilyBoolKey[]{Fleischermeister}%
                  {Aufschnitt}%
                  {@Aufschnitt}
\end{lstcode}
  unter Ausnutzung des Hinweises bezüglich leerer Mitglieder
  \iftrue% Umbruchkorrekturtext
  im Gegensatz zum Weglassen des optionalen Arguments
  \fi%
  auf \autopageref{explain:scrbase.macro.DefineFamilyKey}, der nicht nur für
  \DescRef{\LabelBase.cmd.DefineFamilyKey}, sondern entsprechend auch für
  \Macro{FamilyBoolKey} gilt.

  Da \DescRef{\LabelBase.cmd.FamilyKeyState} bereits von \Macro{FamilySetBool}
  gesetzt wird, kann innerhalb der Definition der Option mit Hilfe von
  \DescRef{\LabelBase.cmd.DefineFamilyKey} der Status gegebenenfalls auch
  abgefragt werden. So könnte man im ersten Fall beispielsweise nach
  \Macro{FamilySetBool} einen Test der Art:
\begin{lstcode}
  \ifx\FamilyKeyState\FamilyKeyStateProcessed
      ...
  \else
      ...
  \fi   
\end{lstcode}
  ergänzen, um zusätzliche Aktionen in Abhängigkeit davon, ob
  \Macro{FamilySetBool} erfolgreich war oder nicht,
  auszuführen. Es\textnote{Achtung!} ist zu beachten, dass an dieser Stelle
  unbedingt ein Test mit Hilfe von \Macro{ifx} vorzunehmen ist. Expandierende
  Tests wie \Macro{ifstr} sind hier zu vermeiden. Sie können abhängig vom
  aktuellen Status und dem Vergleichszustand zu unterschiedlichen
  Fehlermeldungen und auch zu falschen Ergebnissen führen.%
\end{Example}%
\EndIndexGroup

\begin{Declaration}
  \Macro{FamilyInverseBoolKey}\OParameter{Mitglied}\Parameter{Familie}
                              \Parameter{Schlüssel}\Parameter{Schaltername}
  \Macro{FamilySetInverseBool}\Parameter{Familie}
                              \Parameter{Schlüssel}\Parameter{Schaltername}
                              \Parameter{Wert}
\end{Declaration}%
Diese\ChangedAt{v3.27}{\Package{scrbase}} beiden Anweisungen unterscheiden
sich von \DescRef{\LabelBase.cmd.FamilyBoolKey} beziehungsweise
\DescRef{\LabelBase.cmd.FamilySetBool} nur dadurch, dass die Logik invertiert
wird. Das heißt, dass die Werte \PValue{true}, \PValue{yes} und \PValue{on}
den durch \PName{Schaltername} angegebenen Schalter auf \Macro{iffalse} setzen
und damit deaktivieren, während \PValue{false}, \PValue{no} und \PValue{off}
ihn zu \Macro{iftrue} werden lassen, also aktivieren.%
\EndIndexGroup

\begin{Declaration}
  \Macro{FamilyNumericalKey}\OParameter{Mitglied}\Parameter{Familie}
                            \Parameter{Schlüssel}
                            \OParameter{Säumniswert}\Parameter{Makroname}%
                            \Parameter{Werteliste}
  \Macro{FamilySetNumerical}\Parameter{Familie}\Parameter{Schlüssel}
                            \Parameter{Makroname}\Parameter{Werteliste}%
                            \Parameter{Wert}
\end{Declaration}
Während Schalter nur zwei Werte annehmen können, gibt es auch Schlüssel, die
mehrere Werte kennen. So kann beispielsweise eine Ausrichtung nicht nur
entweder links oder nicht links, sondern auch links, mittig oder rechts
sein. Intern unterscheidet man solche Einstellungen dann gerne mit Hilfe von
\Macro{ifcase}\IndexCmd{ifcase}. Diese \TeX-Anweisung erwartet wiederum einen
nummerischen Wert. Daher heißt bei \Package{scrbase} die Anweisung, mit der
man via \PName{Schlüssel} einem Makro eine Definition zuweisen kann,
entsprechend \Macro{FamilyNumericalKey}.

Die \PName{Werteliste} hat dabei die Form:
%\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l}
    \Parameter{Wert}\Parameter{Definition}\texttt{,}\linebreak[1]%
    \Parameter{Wert}\Parameter{Definition}~\dots{}
%\end{tabular}\vskip\dp\strutbox\end{flushleft}
Über diese \PName{Werteliste} werden so nicht nur die erlaubten Werte für den
\PName{Schlüssel} angegeben. Für jeden erlaubten \PName{Wert} wird auch
gleich angegeben, wie bei Verwendung desselben das Makro
\Macro{\PName{Makroname}} definiert werden soll. Üblicherweise werden als
\PName{Definition} schlicht Zahlenwerte angegeben. Es sind zwar auch andere
Angaben möglich, derzeit gibt es aber die Einschränkung, dass
\PName{Definition} voll expandierbar sein muss und bei der Zuweisung auch
expandiert wird.
\begin{Example}
  Die Wurst für den Wurstsalat kann unterschiedlich geschnitten werden. So
  wäre es denkbar, dass der Aufschnitt einfach ungeschnitten bleibt oder in
  grobe oder feine Streifen geschnitten werden soll. Diese Information soll in
  der Anweisung \Macro{Schnitt} gespeichert werden.
\begin{lstcode}
  \FamilyNumericalKey{Fleischermeister}%
                     {SalatSchnitt}{Schnitt}{%
                       {Kein}{Kein},{Nein}{Kein},%
                       {Grob}{Grob},%
                       {Fein}{Fein}%
                     }
\end{lstcode}
  Dass nicht geschnitten werden soll, kann in diesem Fall vom Anwender sowohl
  mit
\begin{lstcode}
  \FamilyOptions{Fleischermeister}{SalatSchnitt=Kein}
\end{lstcode}
  als auch mit
\begin{lstcode}
  \FamilyOptions{Fleischermeister}{SalatSchnitt=Nein}
\end{lstcode}
  angegeben werden. In beiden Fällen würde \Macro{Schnitt} mit dem Inhalt
  \PValue{Kein} definiert. Es kann durchaus sinnvoll sein, dem Anwender wie in
  diesem Beispiel mehrere Werte für denselben Zweck anzubieten.

  Nun ist es sehr wahrscheinlich, dass die Schnittart nicht ausgegeben,
  sondern später ausgewertet werden soll. In diesem Fall sind die textuellen
  Definitionen aber eher unpraktisch. Definiert man den Schlüssel hingegen als
\begin{lstcode}
  \FamilyNumericalKey{Fleischermeister}%
                     {SalatSchnitt}{Schnitt}{%
                       {Kein}{0},{Nein}{0},%
                       {Grob}{1},%
                       {Fein}{2}%
                     }
\end{lstcode}
  so kann später einfach in der Form
\begin{lstcode}
  \ifcase\Schnitt
    % ungeschnitten
  \or
    % grob geschnitten
  \else
    % fein geschnitten
  \fi
\end{lstcode}
  unterschieden werden.
\end{Example}

Intern wird von \Macro{FamilyNumericalKey} dann
\DescRef{\LabelBase.cmd.DefineFamilyKey} mit der Anweisung
\Macro{FamilySetNumerical} verwendet. Wird an einen solchen Schlüssel ein
unbekannter Wert übergeben, so wird von \Macro{FamilySetNumerical} Anweisung
\DescRef{\LabelBase.cmd.FamilyUnknownKeyValue} mit den Argumenten
\PName{Familie}, \PName{Schlüssel} und \PName{Wert} aufgerufen. Dies führt zu
einer Fehlersignalisierung in \DescRef{\LabelBase.cmd.FamilyKeyState} mit
Hilfe des Status \DescRef{\LabelBase.cmd.FamilyKeyStateUnknownValue} und
beispielsweise bei der Verwendung als lokale Option zu einer
Fehlermeldung. Ebenso wird beim Aufruf von \Macro{FamilySetNumerical} auch der
Erfolg via \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} in
\DescRef{\LabelBase.cmd.FamilyKeyState} signalisiert.%
%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyCounterKey}\OParameter{Mitglied}\Parameter{Familie}
                          \Parameter{Schlüssel}
                          \OParameter{Säumniswert}\Parameter{\LaTeX-Zähler}
  \Macro{FamilySetCounter}\Parameter{Familie}
                          \Parameter{Schlüssel}\Parameter{\LaTeX-Zähler}
                          \Parameter{Wert}
\end{Declaration}
Während\ChangedAt{v3.12}{\Package{scrbase}} bei
\DescRef{\LabelBase.cmd.FamilyNumericalKey} ein Makro aufgrund eines
symbolischen Wertes auf einen korrespondierenden nummerischen Wert
gesetzt wurde, gibt es natürlich auch Fälle, in denen ein \PName{Schlüssel}
direkt einen \PName{\LaTeX-Zähler} repräsentiert, dem unmittelbar ein
nummerischer \PName{Wert} zugewiesen werden soll. Dazu dient die Anweisung
\Macro{FamilyCounterKey}, von der intern dann \Macro{FamilySetCounter}
aufgerufen wird. Dabei finden einige grundlegende Prüfungen des
\PName{Wert}-Arguments statt um festzustellen, ob dieses Argument für eine
Zuweisung an einen Zähler in Frage kommt. Die Zuweisung findet nur statt, wenn
diese Prüfungen gelingen. Allerdings können hier nicht alle Fehler erkannt
werden, so dass eine falsche Zuweisung auch zu einer Fehlermeldung von \TeX{}
selbst führen kann. Erkannte Fehler werden hingegen über
\DescRef{\LabelBase.cmd.FamilyKeyStateUnknownValue} signalisiert.

Wurde\ChangedAt{v3.15}{\Package{scrbase}} kein Wert übergeben, so wird
stattdessen der \PName{Säumniswert} eingesetzt. Falls kein \PName{Säumniswert}
angegeben wird, kann später der \PName{Schlüssel} nur mit Wertübergabe
verwendet werden.%
\iffalse% Umbruchkorrekturtext
\ Anderenfalls wir mit
\DescRef{\LabelBase.cmd.FamilyKeyStateNeedValue} ein entsprechender Fehler
signalisiert und beispielsweise innerhalb \Macro{FamilyOptions}  auch als
solcher gemeldet.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyCounterMacroKey}\OParameter{Mitglied}\Parameter{Familie}
                               \Parameter{Schlüssel}
                               \OParameter{Säumniswert}\Parameter{Makro}
  \Macro{FamilySetCounterMacro}\Parameter{Familie}
                               \Parameter{Schlüssel}\Parameter{Makro}
                               \Parameter{Wert}
\end{Declaration}
Diese\ChangedAt{v3.12}{\Package{scrbase}} beiden Anweisungen unterscheiden
sich von den zuvor erklärten \DescRef{\LabelBase.cmd.FamilyCounterKey} und
\DescRef{\LabelBase.cmd.FamilySetCounter} nur dadurch, dass nicht ein
\LaTeX-Zähler auf einen Wert gesetzt wird, sondern ein \PName{Makro} mit
diesem Wert definiert wird. Auch dabei wird \PName{Wert} lokal einem Zähler
zugewiesen und dann dessen expandierter Wert verwendet. Es gilt daher der Wert
zum Zeitpunkt des Aufrufs der Option.%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyLengthKey}\OParameter{Mitglied}\Parameter{Familie}
                         \Parameter{Schlüssel}
                         \OParameter{Säumniswert}\Parameter{Länge}
  \Macro{FamilySetLength}\Parameter{Familie}
                         \Parameter{Schlüssel}\Parameter{Länge}
                         \Parameter{Wert}
  \Macro{FamilyLengthMacroKey}\OParameter{Mitglied}\Parameter{Familie}
                              \Parameter{Schlüssel}
                              \OParameter{Säumniswert}\Parameter{Makro}
  \Macro{FamilySetLengthMacro}\Parameter{Familie}
                              \Parameter{Schlüssel}\Parameter{Makro}
                              \Parameter{Wert}
  \Macro{FamilyUseLengthMacroKey}\OParameter{Mitglied}\Parameter{Familie}
                                 \Parameter{Schlüssel}
                                 \OParameter{Säumniswert}\Parameter{Makro}
  \Macro{FamilySetUseLengthMacro}\Parameter{Familie}
                                 \Parameter{Schlüssel}\Parameter{Makro}
                                 \Parameter{Wert}
\end{Declaration}
Über\ChangedAt{v3.12}{\Package{scrbase}} \Macro{FamilyLengthKey} kann ein
\PName{Schlüssel} definiert werden, der eine \PName{Länge}
repräsentiert. Dabei spielt es keine Rolle, ob eine \LaTeX-Länge, ein
\TeX-Abstand oder eine \TeX-Ausdehnung als \PName{Länge} verwendet
wird. Intern wird die \PName{Länge} über \Macro{FamilySetLength} gesetzt.
Dabei finden einige grundlegende Prüfungen des \PName{Wert}-Arguments statt um
festzustellen, ob dieses Argument für eine Zuweisung an eine \PName{Länge} in
Frage kommt. Die Zuweisung findet nur statt, wenn diese Prüfungen
gelingen. Allerdings können hier nicht alle Fehler erkannt werden, so dass
eine falsche Zuweisung auch zu einer Fehlermeldung von \TeX{} selbst führen
kann. Erkannte Fehler werden hingegen über
\DescRef{\LabelBase.cmd.FamilyKeyStateUnknownValue} signalisiert.

Wurde\ChangedAt{v3.15}{\Package{scrbase}} kein Wert übergeben, so wird
stattdessen der \PName{Säumniswert} eingesetzt. Falls kein \PName{Säumniswert}
angegeben wird, kann später der \PName{Schlüssel} nur mit Wertübergabe
verwendet werden.

Bei Verwendung der Anweisungen \Macro{FamilyLengthMacroKey} und
\Macro{FamilyUseLengthMacroKey} beziehungsweise \Macro{FamilySetLengthMacro}
und \Macro{FamilySetUseLengthMacro} findet die Speicherung des Wertes nicht in
einer \PName{Länge}, sondern in einem \PName{Makro} statt. Dabei wird bei
\Macro{FamilyLengthMacroKey} und \Macro{FamilySetLengthMacro} vergleichbar zu
\Macro{setlength} der aktuelle \PName{Wert} zum Zeitpunkt des Aufrufs der
beiden Anweisungen in \PName{Makro} gespeichert. Dagegen wird bei
\Macro{FamilyUseLengthMacroKey}\ChangedAt{v3.20}{\Package{scrbase}} und
\Macro{FamilySetUseLengthMacro} \PName{Wert} selbst gespeichert. Damit wird
\PName{Wert} dann bei jeder Verwendung von \PName{Makro} neu ausgewertet.%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyStringKey}\OParameter{Mitglied}\Parameter{Familie}
                         \Parameter{Schlüssel}
                         \OParameter{Säumniswert}\Parameter{Makro}
  \Macro{FamilyCSKey}\OParameter{Mitglied}\Parameter{Familie}
                     \Parameter{Schlüssel}
                     \OParameter{Säumniswert}\Parameter{Makronamen}
\end{Declaration}
Hier wird nun\ChangedAt{v3.08}{\Package{scrbase}} ein Schlüssel definiert, der
jeden beliebigen Wert annehmen kann. Der Wert wird in dem angegebenen
\PName{Makro} gespeichert. Wird das optionale Argument für den
\PName{Säumniswert} weggelassen, so entspricht \Macro{FamilyStringKey}:
\begin{lstcode}[escapeinside=><]
  \DefineFamilyKey[>\PName{Mitglied}<]{>\PName{Familie}<}{>\PName{Schlüssel}<}
                  {\def>\PName{Makro}<{#1}}
\end{lstcode}
Existiert
das optionale Argument für den \PName{Säumniswert} so entspricht die Anweisung:
\begin{lstcode}[escapeinside=><]
  \DefineFamilyKey[>\PName{Mitglied}<]{>\PName{Familie}<}{>\PName{Schlüssel}<}
                  [>\PName{Säumniswert}<]
                  {\def>\PName{Makro}<{#1}\FamilyKeyStateProcessed}
\end{lstcode}

\begin{Example}
  In der Voreinstellung sollen 250\,g Wurstsalat erzeugt werden. Die Menge
  soll jedoch einfach per Option geändert werden können. Dazu wird die zu
  erstellende Menge im Makro \Macro{Salatgewicht} gespeichert. Die Option,
  über die das Gewicht geändert werden kann, soll ebenfalls
  \PValue{Salatgewicht} heißen:
\begin{lstcode}
  \newcommand*{\Salatgewicht}{250g}
  \FamilyStringKey{Fleischermeister}%
                  {Salatgewicht}[250g]%
                  {\Salatgewicht}
\end{lstcode}
  Soll nach einer Änderung
  \iffalse% Umbruchkorrekturtext
  wie
\begin{lstcode}
  \FamilyOptions{Fleichermeister}{Salatgewicht=100g}
\end{lstcode}
  \fi%
  wieder die Standardmenge hergestellt
  werden, so kann der Anwender die Option einfach ohne Gewichtsangabe
  aufrufen:
\begin{lstcode}
  \FamilyOptions{Fleischermeister}{Salatgewicht}
\end{lstcode}
  Das ist möglich, weil die Standardmenge bei der Definition auch als
  Säumniswert angegeben wurde.
\end{Example}
In diesem Fall existieren keine unbekannten Werte, da alle Werte schlicht für
eine Makrodefinition verwendet werden. Es ist jedoch zu beachten, dass in der
Wertzuweisung an den Schlüssel keine Absätze enthalten sein dürfen.

Im\ChangedAt{v3.25}{\Package{scrbase}} Unterschied zu \Macro{FamilyStringKey}
erwartet \Macro{FamilyCSKey} kein Makro als letztes Argument, sondern
lediglich den Namen eines Makros, also beispielsweise nicht
\PParameter{\Macro{Salatgewicht}}, sondern \PParameter{Salatgewicht}.%
%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyUnknownKeyValue}\Parameter{Familie}\Parameter{Schlüssel}
                               \Parameter{Wert}\Parameter{Werteliste}
\end{Declaration}
Diese Anweisung signalisiert über \DescRef{\LabelBase.cmd.FamilyKeyState}
einen Fehler aufgrund eines unbekannten oder unerlaubten Wertes. Dabei wird
als \PName{Werteliste} eine durch Komma separierte Liste von erlaubten Werten
der Form:
%\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l}
    `\PName{Wert}'\texttt{,} `\PName{Wert}' \dots{}
%\end{tabular}\vskip\dp\strutbox\end{flushleft}
erwartet. Allerdings\ChangedAt{v3.12}{\Package{scrbase}} wird die
\PName{Werteliste} derzeit nicht ausgewertet.

\begin{Example}
  Für den Aufschnitt soll nun zusätzlich wählbar sein, ob er grob oder
  fein geschnitten werden soll. Dabei ist grob die Voreinstellung, die auch
  dann verwendet werden soll, wenn nicht angegeben wird, wie der Aufschnitt zu
  schneiden ist.
\begin{lstcode}
  \@ifundefined{if@Feinschnitt}{%
    \expandafter
    \newif\csname if@Feinschnitt\endcsname}{}%
  \@ifundefined{if@Aufschnitt}{%
    \expandafter
    \newif\csname if@Aufschnitt\endcsname}{}
  \DefineFamilyKey{Fleischermeister}%
                  {Aufschnitt}[true]{%
    \FamilySetBool{Fleischermeister}{Aufschnitt}%
                                    {@Aufschnitt}%
                                    {#1}%
    \ifx\FamilyKeyState\FamilyKeyStateProcessed
      \@Feinschnittfalse
    \else      
      \ifstr{#1}{fein}{%
        \@Aufschnitttrue
        \@Feinschnittrue
        \FamilyKeyStateProcessed
      }{%
        \FamilyUnknownKeyValue{Fleichermeister}%
                              {Aufschnitt}%
                              {#1}{%
                                `true', `on', `yes',
                                `false`, `off`, `no',
                                `fein'%
                              }%
      }%
    \fi
  }%
\end{lstcode}
  Zunächst wird versucht, den booleschen Schalter für Aufschnitt über
  \DescRef{\LabelBase.cmd.FamilySetBool} zu setzen. Gelingt dies, wurde also
  \DescRef{\LabelBase.cmd.FamilyKeyState} zu
  \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} definiert, wird
  der Feinschnitt abgeschaltet. Anderenfalls wird überprüft, ob anstelle
  eines gültigen Wertes für einen booleschen Schalter %der Wert
  \PValue{fein} übergeben wurde. In diesem Fall wird sowohl der Feinschnitt,
  als auch Aufschnitt aktiviert und mit Hilfe von
  \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} der Erfolgs-Status
  gesetzt. Ist auch das nicht der Fall, wird der von
  \DescRef{\LabelBase.cmd.FamilySetBool} signalisierte Fehler-Zustand
  neu auf \DescRef{\LabelBase.cmd.FamilyKeyStateUnknownValue} gesetzt. Die
  Liste der üblichen erlaubten Werte von
  \DescRef{\LabelBase.cmd.FamilySetBool} wird dabei um \PValue{fein}
  ergänzt. Da diese Liste jedoch inzwischen nicht mehr verwendet wird, hätte
  man auf den Aufruf von \Macro{FamilyUnknownKeyValue} im Beispiel auch
  einfach verzichten und damit den Fehlerstatus von
  \DescRef{\LabelBase.cmd.FamilySetBool} übernehmen können.

  Die bei den Tests verwendete Anweisung \Macro{ifstr}\IndexCmd{ifstr} ist auf
  \DescPageRef{scrbase.cmd.ifstr} in \autoref{sec:scrbase.if} erklärt.
\end{Example}
%
\EndIndexGroup


\begin{Declaration}
  \Macro{FamilyElseValues}
\end{Declaration}
In\ChangedAt{v3.12}{\Package{scrbase}} früheren\textnote{Veraltet!} Versionen
von \Package{scrbase} konnte man über die Anweisung \Macro{FamilyElseValues}
weitere erlaubte Werte für die Bearbeitung durch
\DescRef{\LabelBase.cmd.FamilyUnknownKeyValue}
\iffalse% Umbruchkorrekturtext
in der Form
\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l}
    \texttt{,} `\PName{Wert}'\texttt{,} `\PName{Wert}' \dots
\end{tabular}\vskip\dp\strutbox\end{flushleft}
\fi%
ablegen, die dann ebenfalls in einer Fehlermeldung mit ausgegeben wurden. Seit
Version~3.12 gibt \DescRef{\LabelBase.cmd.FamilyUnknownKeyValue} keine
Fehlermeldungen mehr aus, sondern setzt nur noch
\DescRef{\LabelBase.cmd.FamilyKeyState} entsprechend. Damit ist die Verwendung
von \Macro{FamilyElseValue} ebenfalls überholt. Ihre Verwendung wird jedoch
erkannt und führt dann zu einer Aufforderung, den Code entsprechend
anzupassen.%
\EndIndexGroup


\section{Verzweigungen}
\seclabel{if}

Das Paket \Package{scrbase} stellt eine ganze Reihe von
Verzweigungsanweisungen zur Verfügung. Dabei wird nicht auf die \TeX-Syntax
von Verzweigungen wie beispielsweise
\begin{lstcode}
  \iftrue
    ...
  \else
    ...
  \fi
\end{lstcode}
gebaut, sondern es wird die \LaTeX-Syntax mit Argumenten eingesetzt, wie man
sie auch von \LaTeX-Anweisungen wie \Macro{IfFileExists},
\Macro{@ifundefined}, \Macro{@ifpackageloaded} und vielen weiteren
kennt. Einige Paketautoren ziehen es allerdings vor, die \TeX-Syntax auch für
Anwender in die \LaTeX-Ebene zu bringen. Da es sich bei den Verzweigungen von
\Package{scrbase} um recht grundlegende Möglichkeiten handelt, ist die
Wahrscheinlichkeit gegeben, dass dabei gleichnamige Anwenderanweisungen
verwendet würden. Dies könnte selbst bei eigentlich gleicher Semantik
zu einem Problem aufgrund unterschiedlichen Syntax
führen. \Package{scrbase} geht daher auf Nummer sicher.

\begin{Declaration}
  \OptionVName{internalonly}{Wert}
\end{Declaration}
Von \Package{scrbase} werden einige Verzweigungsanweisungen
bereitgestellt. Dabei verwendet es primär die Bezeichnungen
\Macro{scr@\PName{Name}}\textnote{Paketautoren}. Es handelt sich somit
um interne Anweisungen. Diese werden auch intern von \KOMAScript{}
verwendet. Paket- und Klassenautoren können diese Anweisungen ebenfalls
verwenden, sollten sie aber nicht umdefinieren. Da einige dieser Anweisungen
auch für Benutzer nützlich sein können, werden die gleichen Anweisungen
normalerweise auch als \Macro{\PName{Name}}\textnote{Anwender}
bereitgestellt. Da eventuell andere Pakete gleichnamige Anweisungen mit
anderer Syntax bereitstellen könnten und es so zu Konflikten kommen könnte,
kann der Anwender die Definition von \Macro{\PName{Name}} verhindern. Dazu
gibt er entweder die Option ohne Wertangabe an. In diesem Fall werden nur die
internen Verzweigungsanweisungen definiert. Oder er gibt genau die
Anweisungen, die nicht definiert werden sollen, als Wert an, wobei er
»\Macro{}« durch »\texttt{/}« ersetzt.

Paket- und Klassenautoren sollten diese Option normalerweise nicht verwenden.
Anwender können sie mit oder ohne Wertangabe entweder als globale Option bei
\DescRef{maincls.cmd.documentclass} oder per
\Macro{PassOptionsToPackage}\IndexCmd{PassOptionsToPackage} angeben.
\begin{Example}
  Der Anwender will nicht, dass die Anweisungen
  \DescRef{\LabelBase.cmd.ifVTeX} und
  \DescRef{\LabelBase.cmd.ifundefinedorrelax} von \Package{scrbase} definiert
  werden. Also verwendet er beim Laden der Klasse:
\begin{lstcode}
  \documentclass[%
    internalonly=/ifVTeX/ifundefinedorrelax%
  ]{foo}
\end{lstcode}
  Der Klassenname \Class{foo} wird hier als Platzhalter für irgendeine Klasse
  verwendet.  Die Anweisungen \DescRef{\LabelBase.cmd.ifVTeX}
  und \DescRef{\LabelBase.cmd.ifundefinedorrelax} werden im weiteren Verlauf
  dieses Abschnittes erklärt.%
\end{Example}

Paket- und Klassenautoren sollten wie \KOMAScript{} selbst auch die internen
Namen verwenden. Zur Vollständigkeit sind in den nachfolgenden Erklärungen
aber auch die Anwenderanweisungen angegeben.%
\EndIndexGroup


\begin{Declaration}
  \Macro{scr@ifundefinedorrelax}
  \Parameter{Name}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
  \Macro{ifundefinedorrelax}
  \Parameter{Name}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Diese Anweisung funktioniert prinzipiell wie \Macro{@ifundefined} aus dem
\LaTeX-Kern (siehe \cite{latex:source2e}). Es wird also der \PName{Dann-Teil}
ausgeführt, wenn \PName{Name} der Name einer undefinierten Anweisung oder
\Macro{\PName{Name}} derzeit \Macro{relax} ist. Im Unterschied zu
\Macro{@ifundefined} wird %
\iftrue% Umbruchvarianten
weder Hash-Speicher belegt noch \Macro{\PName{Name}} %
\else%
\Macro{\PName{Name}} nicht %
\fi%
zu \Macro{relax}, wenn \Macro{\PName{Name}} zuvor undefiniert war.%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifnotundefined}\Parameter{Name}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Ist die Anweisung mit dem angegebenen Namen bereits definiert wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Da es bei
\eTeX{} bereits ein Primitiv \Macro{ifdefined} gibt, musste leider diese
etwas unhandliche Bezeichnung gewählt werden. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{scr@ifluatex}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wird\ChangedAt{v3.21}{\Package{scrbase}} mit lua\TeX{} gearbeitet, wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}.
\iftrue% Umbruchkorrekturtext
Diese Unterscheidung ist nur sehr selten wirklich von Nutzen. %
\fi%
In der Regel sollte man besser auf die gewünschte Anweisung
testen. Von\textnote{Achtung!} dieser Anweisung gibt es kein
Benutzeräquivalent. Verwenden Sie stattdessen bei Bedarf das Paket
\Package{ifluatex}\important{\Package{ifluatex}} (siehe
\cite{package:ifluatex}).%
\EndIndexGroup


\iffalse% Es ergibt keinen Sinn, diese Anweisung noch zu dokumentieren
\begin{Declaration}
  \Macro{scr@ifpdforluatex}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Bis lua\TeX~0.85 war es meist unerheblich, ob mit pdf\TeX{} oder lua\TeX{}
gearbeitet wurde. Von daher stammt diese Anweisung, die in beiden Fällen den
\PName{Dann-Teil} ausführt. Wird weder mit pdf\TeX{} noch mit lua\TeX{}
gearbeitet, so wird der \PName{Sonst-Teil} ausgeführt.
Seit Version 0.85 wurde bei lua\TeX{} die Kompatibilität bei vielen der
zusätzlichen Befehle jedoch aufgegeben. Daher ist diese Unterscheidung in der
Praxis nicht mehr von Nutzen und wird von \KOMAScript{} selbst auch nicht mehr
verwendet. Von dieser Anweisung gibt es auch kein Benutzeräquivalent.%
\EndIndexGroup
\fi


\begin{Declaration}
  \Macro{scr@ifpdftex}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
  \Macro{ifpdftex}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wird mit pdf\TeX{} gearbeitet, wird der \PName{Dann-Teil} ausgeführt,
anderenfalls der \PName{Sonst-Teil}. Dabei ist es unerheblich, ob tatsächlich
eine PDF-Datei ausgegeben werden soll oder nicht.
\iftrue% Umbruchkorrekturtext
Diese Unterscheidung ist nur sehr selten wirklich von Nutzen. %
\fi%
In der Regel sollte man besser auf die gewünschte Anweisung testen.%
\EndIndexGroup


\begin{Declaration}
  \Macro{scr@ifVTeX}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
  \Macro{ifVTeX}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wird mit V\TeX{} gearbeitet, wird der \PName{Dann-Teil} ausgeführt,
anderenfalls der \PName{Sonst-Teil}.
\iftrue% Umbruchkorrekturtext
Diese Unterscheidung ist nur sehr selten wirklich von Nutzen. %
\fi%
In der Regel sollte man besser auf die gewünschte Anweisung testen.%
\EndIndexGroup


\begin{Declaration}
  \Macro{scr@ifpdfoutput}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
  \Macro{ifpdfoutput}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wird eine PDF-Datei erzeugt, wird der \PName{Dann-Teil} ausgeführt,
anderenfalls der \PName{Sonst-Teil}. Dabei ist es unerheblich, ob die
PDF-Datei mit Hilfe von lua\TeX{}, pdf\TeX{}, V\TeX{} oder \XeTeX{} erzeugt
wird.%
\EndIndexGroup


\begin{Declaration}
  \Macro{scr@ifpsoutput}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
  \Macro{ifpsoutput}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wird eine PostScript-Datei erzeugt, wird der \PName{Dann-Teil} ausgeführt,
anderenfalls der \PName{Sonst-Teil}. V\TeX{} kann PostScript direkt erzeugen,
was hier erkannt wird. Wird hingegen kein V\TeX{} verwendet, ist aber ein
Schalter \Macro{if@dvips} definiert, so wird die Entscheidung darüber
getroffen. \KOMAScript{} stellt \Macro{if@dvips} in
\hyperref[cha:typearea]{\Package{typearea}}\IndexPackage{typearea}%
\IndexCmd{if@dvips} bereit.%
\EndIndexGroup


\begin{Declaration}
  \Macro{scr@ifdvioutput}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
  \Macro{ifdvioutput}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wird eine DVI-Datei erzeugt, so wird der \PName{Dann-Teil} ausgeführt,
anderenfalls der \PName{Sonst-Teil}. Es wird immer dann davon ausgegangen,
dass eine DVI-Datei erzeugt wird, wenn keine direkte Ausgabe einer PDF- oder
Postscript-Datei erkannt werden kann.%
\EndIndexGroup


\begin{Declaration}
  \Macro{if@atdocument}\ \PName{Dann-Teil}\ %
  \textMacro{else}\ \PName{Sonst-Teil} \textMacro{fi}
\end{Declaration}
Diese Verzweigung existiert ganz bewusst nur als interne Anweisung. Dabei
entspricht \Macro{if@atdocument} in der Dokumentpräambel \Macro{iffalse}, nach
\Macro{begin}\PParameter{document} entspricht \Macro{if@atdocument} hingegen
\Macro{iftrue}. Klassen und Paketautoren können dieses Anweisung manchmal
sinnvoll nutzen, wenn sich Anweisungen in der Dokumentpräambel anders
verhalten sollen als innerhalb des Dokuments. Es\textnote{Achtung!} ist zu
beachten, dass es sich bei dieser Anweisung um eine Verzweigung in \TeX-Syntax
und nicht in \LaTeX-Syntax handelt!
%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifstr}\Parameter{Zeichenfolge}\Parameter{Zeichenfolge}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Die beiden Argumente \PName{Zeichenfolge} werden expandiert und dann
verglichen. Sind sie dabei gleich, so wird der \PName{Dann-Teil} ausgeführt,
anderenfalls der \PName{Sonst-Teil}. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifstrstart}\Parameter{Zeichenfolge}\Parameter{Zeichenfolge}
                    \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Die\ChangedAt{v3.12}{\Package{scrbase}} beiden Argumente \PName{Zeichenfolge}
werden expandiert und dann verglichen. Beginnt die erste Zeichenfolge, von
Leerzeichen abgesehen, mit der zweiten Zeichenfolge, so wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisdimen}\Parameter{Code}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
einem \Macro{dimen}, also einem \TeX-Längenregister, resultiert, wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Die
Anweisung ist nicht voll expandierbar.  %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisdimension}\Parameter{Code}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
etwas resultiert, das syntaktisch dem Wert einer Länge entspricht, wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu
beachten,\textnote{Achtung!} dass derzeit unbekannte Einheiten zu einer
Fehlermeldung führen. Die Anweisung ist nicht voll expandierbar. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifdimen}\Parameter{Zeichenfolge}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Der \PName{Dann-Teil} wird ausgeführt, wenn die einfache Expansion der
\PName{Zeichenfolge} eine gültige Länge mit einer gültigen Längeneinheit
ist. Anderenfalls wird der \PName{Sonst-Teil} verwendet. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisdimexpr}\Parameter{Code}
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
einer \Macro{dimexpr}\IndexCmd{dimexpr}, also einem \eTeX-Längenausdruck
resultiert, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der
\PName{Sonst-Teil}. Es ist zu beachten,\textnote{Achtung!} dass fehlerhafte
Ausdrücke zu Fehlermeldungen führen! Die Anweisung ist nicht voll
expandierbar. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisskip}\Parameter{Code}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
einem \Macro{skip}, also einem \TeX-Abstand, resultiert, wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Die
Anweisung ist nicht voll expandierbar. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisglue}\Parameter{Code}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
etwas resultiert, das syntaktisch dem Wert eines Abstandes entspricht, wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu
beachten,\textnote{Achtung!} dass derzeit unbekannte Einheiten zu einer
Fehlermeldung führen. Die Anweisung ist nicht voll expandierbar. %
\iffalse% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisglueexpr}\Parameter{Code}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
einer \Macro{glueexpr}\IndexCmd{glueexpr}, also einem
\mbox{\eTeX}-Abstandsausdruck resultiert, wird der \PName{Dann-Teil}
ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu
beachten,\textnote{Achtung!} dass fehlerhafte Ausdrücke zu Fehlermeldungen
führen! Die Anweisung ist nicht voll expandierbar. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifiscounter}\Parameter{Zähler}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} \PName{Zähler} ein definierter
\LaTeX-Zähler ist, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der
\PName{Sonst-Teil}. Die Anweisung ist nicht voll expandierbar. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifiscount}\Parameter{Code}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
einem \Macro{count}, also einem \TeX-Zähler, resultiert, wird der
\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Die
Anweisung ist nicht voll expandierbar. Für einen Test auf einen \LaTeX-Zähler
siehe \DescRef{\LabelBase.cmd.ifiscounter}. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisinteger}\Parameter{Code}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
etwas resultiert, das syntaktisch dem Wert eines Zählers entspricht, also eine
negative oder positive ganze Zahl ist, wird der \PName{Dann-Teil} ausgeführt,
anderenfalls der \PName{Sonst-Teil}. Die Anweisung ist nicht voll
expandierbar. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifnumber}\Parameter{Zeichenfolge}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Der \PName{Dann-Teil} wird ausgeführt, wenn die einfache Expansion der
\PName{Zeichenfolge} nur aus Ziffern besteht. In allen anderen Fällen wird der
\PName{Sonst-Teil} verwendet. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{ifisnumexpr}\Parameter{Code}%
  \Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in
einer \Macro{numexpr}\IndexCmd{numexpr}, also einem \eTeX-Zahlenausdruck
resultiert, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der
\PName{Sonst-Teil}. Es ist zu beachten,\textnote{Achtung!} dass fehlerhafte
Ausdrücke zu Fehlermeldungen führen! Die Anweisung ist nicht voll
expandierbar. %
\iftrue% Umbruchvaritanten
Von dieser Anweisung gibt es keine interne Variante.%
\else%
Es gibt keine interne Variante.%
\fi%
\EndIndexGroup


\begin{Declaration}
  \Macro{IfActiveMkBoth}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
Bei\ChangedAt{v3.27}{\Package{scrbase}} der Umschaltung zwischen automatischen
und manuellen Kolumnentiteln, verwendet der \LaTeX-Kern die Anweisung
\DescRef{scrlayer.cmd.@mkboth}\important{\Macro{@mkboth}}\IndexCmd{@mkboth}.
Im Falle automatischer Kolumnentitel setzt diese normalerweise sowohl den
linken als auch rechten Markenanteil. Im Falle manueller Kolumnentiteln setzt
sie keine Marke. Will man wissen, ob \DescRef{scrlayer.cmd.@mkboth} Marken
setzt oder nicht, so verwenden viele Pakete einen Vergleich entweder mit
\DescRef{maincls.cmd.markboth}\IndexCmd{markboth} oder
\Macro{@gobbletwo}. Dies deckt aber nicht alle Fälle von möglichen
Umdefinierungen von \DescRef{scrlayer.cmd.@mkboth} ab. Daher testet
\Macro{IfActiveMkBoth}, ob \DescRef{scrlayer.cmd.@mkboth} tatsächlich zum
Setzen einer Marke führen würde und deckt dabei sogar die Verwendung von
\Macro{marks} für die Definition von \DescRef{scrlayer.cmd.@mkboth} ab. Wird
eine solches aktives \DescRef{scrlayer.cmd.@mkboth} entdeckt, so wird der
\PName{Dann-Teil} ausgeführt. In allen anderen Fällen wird der
\PName{Sonst-Teil} ausgeführt.%
\begin{Example}
  Angenommen, Sie wollen in einem Paket im Fall der Verwendung automatischer
  Kolumnentitel, beispielsweise durch den Seitenstil
  \PageStyle{headings}\IndexPagestyle{headings} nur die rechte Marke setzen
  und die linke unverändert lassen, wohingegen bei Verwendung manueller
  Kolumentitel die Marken unverändert bleiben sollen. In einem ersten Ansatz
  verwenden Sie dafür:
\begin{lstcode}
  \ifx\@mkboth\markboth \markright{Kolumnentitel}\fi
\end{lstcode}
  Etwas später entdecken Sie, dass irgendein Paket nicht wie gewohnt
\begin{lstcode}
  \let\@mkboth\markboth
\end{lstcode}
  sondern
\begin{lstcode}
  \renewcommand{\@mkboth}{\markboth}
\end{lstcode}
  verwendet hat, um automatische Kolumnentitel zu aktivieren. Daher ruft Ihr
  Vergleich niemals die \DescRef{maincls.cmd.markright}-Anweisung auf.  Daher
  ändern Sie den Vergleich oben zu
\begin{lstcode}
  \ifx\@mkboth\@gobbletwo\else \markright{Kolumnentitel}\fi
\end{lstcode}
  Leider wird nun \DescRef{maincls.cmd.markright} auch bei manuellen
  Kolumentiteln aufgerufen, weil irgend jemand für diesen Fall
\begin{lstcode}
  \renewcommand{\@mkboth}[2]{%
    \typeout{DEBUG: ignoring running head setting}%
  }
\end{lstcode}
  definiert hat.

  Beide Probleme sind jedoch mit Hilfe von \Package{scrbase} einfach zu lösen:
\begin{lstcode}
  \IfActiveMKBoth{\markright{Kolumnentitel}}{}
\end{lstcode}%
\end{Example}
Noch einfacher lässt sich das Problem aus dem Beispiel übrigens mit Hilfe von
\DescRef{scrlayer.cmd.@mkright} aus Paket
\hyperref[cha:scrlayer]{\Package{scrlayer}} lösen (siehe
\autoref{sec:scrlayer.pagestyle.content},
\DescPageRef{scrlayer.cmd.@mkright}).%
\EndIndexGroup


\section{Definition sprachabhängiger Bezeichner}
\seclabel{languageSupport}
\BeginIndexGroup
\BeginIndex{}{Sprachdefinition}

\iftrue
Anfänger haben häufig Probleme damit, sprachabhängige Begriffe wie
\Macro{listfigurename}\IndexCmd{listfigurename}, in der Voreinstellung meist
»List of Figures« beziehungsweise in Deutsch: »Abbildungsverzeichnis«, zu
ändern. Werden diese beispielsweise einfach mit \Macro{renewcommand} in der
Dokumentpräambel umdefiniert, so überleben sie eine spätere Umschaltung der
Sprache nicht. Bei Verwendung von \Package{babel}\IndexCmd{babel} wird die
Umdefinierung in der Dokumentpräambel bereits von
\Macro{begin}\PParameter{document} wieder überschrieben.
\fi

Normalerweise muss man zur Definition oder zur Änderung sprachabhängiger
Begriffe Anweisungen wie \Macro{captionsngerman} so umdefinieren, dass
zusätzlich zu den bisherigen Begriffen auch die neuen oder geänderten
definiert werden. Erschwert wird dieses Vorhaben dadurch, dass beim Laden
eines Pakets wie \Package{german}\IndexPackage{german} oder
\Package{ngerman}\IndexPackage{ngerman} diese Anweisungen von den Paketen
erneut definiert werden. Bei den genannten Paketen geschieht dies leider in
einer Form, die alle zuvor gemachten Änderungen zunichte macht. Aus diesem
Grund ist es sinnvoll, die Änderungen mit Hilfe von \Macro{AtBeginDocument} bis
\Macro{begin}\PParameter{document}, also bis nach dem Laden aller Pakete, zu
verzögern.
\iftrue
Auch der Anwender muss entweder von \Macro{AtBeginDocument}
Gebrauch machen oder aber seine Änderungen nicht in die Dokumentpräambel,
sondern hinter \Macro{begin}\PParameter{document} einfügen.
\fi

Darüber hinaus kommt erschwerend hinzu, dass einige Pakete zusätzliche,
sprachabhängige Begriffe in \Macro{captions\PName{Sprache}} definieren,
während andere dafür \Macro{extras\PName{Sprache}} verwenden. So muss der
Anwender sich schon sehr genau auskennen, um die richtige Anweisung auf die
richtige Weise zu ergänzen.

Das Paket \Package{scrbase} bietet dem Anwender daher für die Definition und
Änderung selbst einige zusätzliche Anweisungen, die ihn von vielen dieser
Überlegungen entlasten. Gleichzeitig erlauben diese Befehle, die
sprachabhängigen Begriffe mehrerer Dialekte oder Ausprägungen einer Sprache
gleichzeitig zu definieren oder zu ändern.

\begin{Declaration}
  \Macro{defcaptionname}
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
  \Macro{providecaptionname}
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
  \Macro{newcaptionname}
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
  \Macro{renewcaptionname}
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
  \Macro{defcaptionname*}
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
  \Macro{providecaptionname*}
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
  \Macro{newcaptionname*}
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
  \Macro{renewcaptionname*}%
    \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}
\end{Declaration}
Mit Hilfe dieser vier Anweisungen und ihrer Sternvarianten ist es möglich,
einem \PName{Begriff} in Abhängigkeit der Sprache einen \PName{Inhalt}
zuzuweisen. Mehrere Sprachen können durch Komma voneinander getrennt als
\PName{Sprachliste}\ChangedAt{v3.12}{\Package{scrbase}} angegeben werden.

Der \PName{Begriff} ist immer ein Makro. Die Arbeitsweise der Anweisungen
unterscheidet sich je nachdem, ob eine Sprache und ein \PName{Begriff}
innerhalb der Sprache zum Zeitpunkt des Aufrufs bereits definiert ist.

Ist eine Sprache nicht definiert, so tut \Macro{providecaptionname} nichts
weiter, als dies in der \File{log}-Datei zu vermerken. Dabei wird für jede
Sprache nur einmal eine entsprechende Information in die \File{log}-Datei
geschrieben. Ist die Sprache definiert, enthält aber bisher keinen
entsprechenden \PName{Begriff}, so wird er mit dem angegebenen \PName{Inhalt}
definiert. Ist der \PName{Begriff} hingegen in der Sprache bereits definiert,
so wird er nicht umdefiniert, sondern ebenfalls ein entsprechender Hinweis in
die \File{log}-Datei geschrieben.

Ist dagegen bei \Macro{newcaptionname}
eine Sprache nicht definiert, dann wird diese neu definiert, indem eine
entsprechende Anweisung definiert wird. Für die Sprache
\PValue{ngerman} wäre das beispielsweise \Macro{captionsngerman}. Außerdem
wird darüber auch in der \File{log}-Datei informiert. Ist die Sprache
definiert, der \PName{Begriff} in dieser Sprache aber noch nicht
vorhanden, so wird er mit dem gewünschten \PName{Inhalt} definiert. Ist der
\PName{Begriff} in der Sprache bereits vorhanden, so wird eine
Fehlermeldung ausgegeben.

Die Anweisung \Macro{renewcaptionname} verhält sich noch einmal anders. Ist
eine Sprache nicht definiert, so wird eine Fehlermeldung
ausgegeben. Ist die Sprache definiert, der \PName{Begriff} in dieser
Sprache jedoch nicht, so wird ebenfalls eine Fehlermeldung
ausgegeben. Ist der \PName{Begriff} in der Sprache definiert, so wird
er auf den gewünschten \PName{Inhalt} umdefiniert.

Die\ChangedAt{v3.12}{\Package{scrbase}} Anweisung \Macro{defcaptionname}
definiert einen \PName{Begriff} immer, überschreibt also eventuell vorhandene
Definitionen. Wie bei \Macro{providecaptionname} braucht eine angegebene
Sprache nicht definiert zu sein.

\KOMAScript{} selbst verwendet \Macro{providecaptionname} um die Begriffe aus
\autoref{sec:scrlttr2-experts.languages},
\DescPageRef{scrlttr2-experts.cmd.yourrefname} zu definieren.

\begin{Example}
  Möchten Sie »Abb.« statt »Abbildung« in den Abbildungsunterschriften, so
  erreichen Sie dies mit:
\begin{lstcode}
  \renewcaptionname{ngerman}{\figurename}{Abb.}
\end{lstcode}

  Soll dieselbe Änderung nicht nur für \PValue{ngerman}, sondern
  auch für die Sprachen \PValue{naustrian} und \PValue{nswissgerman}, also für
  Österreichisch und Schweizer Deutsch gelten, so ist
  es nicht notwendig zwei weitere Anweisungen:
\begin{lstcode}
  \renewcaptionname{naustrian}{\figurename}{Abb.}
  \renewcaptionname{nswissgerman}{\figurename}{Abb.}
\end{lstcode}
  hinzuzufügen. Stattdessen kann einfach, die \PName{Sprachliste} erweitert
  werden:
\begin{lstcode}
  \renewcaptionname{ngerman,naustrian,nswissgerman}%
                   {\figurename}{Abb.}
\end{lstcode}
  In gleicher Weise können auch \PValue{german}, \PValue{austrian} und
  \PValue{swissgerman}, also Deutsch, Österreichisch und Schweizer Deutsch
  nach der veralteten Rechtschreibung, hinzugefügt werden.
\end{Example}
\begin{Explain}
  Die Sprachen \PValue{swissgerman} und \PValue{nswissgerman} werden übrigens
  von älteren Versionen von \Package{babel} noch nicht unterstützt. Sie sind
  erst seit Dezember~2013 Bestandteil des deutschen Sprachpakets für
  \Package{babel}. Für die Anweisungen \Macro{defcaptionname},
  \Macro{newcaptionname} und \Macro{providecaptionname} spielt dies kaum eine
  Rolle, da diese auch Begriffe für nicht existierende Sprachen definieren
  können. Da mit \Macro{renewcaptionname} jedoch nur existierende Begriffe von
  existierenden Sprachen umdefiniert werden können, resultiert die
  Umdefinierung für \Option{nswissgerman} und \Option{swissgerman} bei
  Verwendung einer älteren Version von \Package{babel} in einer entsprechenden
  Fehlermeldung.
\end{Explain}

Seit \KOMAScript~3.12\ChangedAt{v3.12}{\Package{scrbase}} ist es auch nicht
mehr erforderlich, die Definierung oder Umdefinierung mit Hilfe von
\Macro{AtBeginDocument} bis \Macro{begin}\PParameter{document} zu
verzögern. Stattdessen erledigt \Package{scrbase} dies selbst, falls die
Anweisungen in der Dokumentpräambel aufgerufen werden. Außerdem prüft
\Package{scrbase} nun auch, ob ein umzudefinierender Begriff statt in
\Macro{captions\PName{Sprache}} in \Macro{extras\PName{Sprache}} zu definieren
ist. Die neuen Sternvarianten der Befehle verwenden grundsätzlich
\Macro{extras\PName{Sprache}}, da dessen Definitionen in der Regel nach
\Macro{captions\PName{Sprache}} Anwendung finden. Damit funktioniert nun in
der Regel auch das Umdefinieren von sprachabhängigen Bezeichnern von Paketen
wie \Package{hyperref}, die dafür \Macro{extras\PName{Sprache}} verwenden.

In \autoref{tab:scrbase.commonNames} ist ein Überblick über die üblicherweise
von Klassen und Sprachpaketen definierten Begriffe und deren Verwendung zu
finden.\iffree{}{ \KOMAScript{} selbst definiert noch einige weitere
  Begriffe. Siehe dazu \autoref{sec:scrlttr2-experts.languages} ab
  \DescPageRef{scrlttr2-experts.cmd.yourrefname}.}

\begin{desclist}
  \renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
  \desccaption[{%
    Überblick über übliche sprachabhängige Begriffe%
  }]{%
    Überblick über sprachabhängige Begriffe in den üblichen
    Sprachpaketen\label{tab:scrbase.commonNames}%
  }{%
    Überblick über übliche sprachabhängige Begriffe
    (\emph{Fortsetzung})%
  }%
  \entry{\Macro{abstractname}}{%
    Überschrift für die Zusammenfassung%
    \IndexCmd{abstractname}%
  }%
  \entry{\Macro{alsoname}}{%
    »Siehe auch« bei ergänzenden Verweisen im Stichwortverzeichnis%
    \IndexCmd{alsoname}%
  }%
  \entry{\Macro{appendixname}}{%
    »Anhang« in der Kapitelüberschrift eines Anhangs%
    \IndexCmd{appendixname}%
  }%
  \entry{\Macro{bibname}}{%
    Überschrift für das Literaturverzeichnis%
    \IndexCmd{bibname}%
  }%
  \entry{\Macro{ccname}}{%
    Spitzmarke für den Verteiler in Briefen%
    \IndexCmd{ccname}%
  }%
  \entry{\Macro{chaptername}}{%
    »Kapitel« in der Kapitelüberschrift%
    \IndexCmd{chaptername}%
  }%
  \entry{\Macro{contentsname}}{%
    Überschrift für das Inhaltsverzeichnis%
    \IndexCmd{contentsname}%
  }%
  \entry{\Macro{enclname}}{%
    Spitzmarke für die Anlagen bei Briefen%
    \IndexCmd{enclname}%
  }%
  \entry{\Macro{figurename}}{%
    Spitzmarke in der Abbildungsunterschrift%
    \IndexCmd{figurename}%
  }%
  \entry{\Macro{glossaryname}}{%
    Überschrift für das Glossar%
    \IndexCmd{glossaryname}%
  }%
  \entry{\Macro{headtoname}}{%
    »An« im Briefkopf%
    \IndexCmd{headtoname}%
  }%
  \entry{\Macro{indexname}}{%
    Überschrift für das Stichwortverzeichnis%
    \IndexCmd{indexname}%
  }%
  \entry{\Macro{listfigurename}}{%
    Überschrift für das Abbildungsverzeichnis%
    \IndexCmd{listfigurename}%
  }%
  \entry{\Macro{listtablename}}{%
    Überschrift für das Tabellenverzeichnis%
    \IndexCmd{listtablename}%
  }%
  \entry{\Macro{pagename}}{%
    »Seite« in der Seitennummer von Briefen%
    \IndexCmd{pagename}%
  }%
  \entry{\Macro{partname}}{%
    »Teil« in der Teileüberschrift%
    \IndexCmd{partname}%
  }%
  \entry{\Macro{prefacename}}{%
    Überschrift für das Vorwort%
    \IndexCmd{prefacename}%
  }%
  \entry{\Macro{proofname}}{%
    Spitzmarke bei Beweisen%
    \IndexCmd{proofname}%
  }%
  \entry{\Macro{refname}}{%
    Überschrift für das Quellenverzeichnis%
    \IndexCmd{refname}%
  }%
  \entry{\Macro{seename}}{%
    »Siehe« bei Verweisen im Stichwortverzeichnis%
    \IndexCmd{seename}%
  }%
  \entry{\Macro{tablename}}{%
    Spitzmarke in der Tabellenunter- bzw. "~überschrift%
    \IndexCmd{tablename}%
  }%
\end{desclist}
%
\EndIndexGroup
%
\EndIndexGroup


\section{Identifikation von \KOMAScript}
\seclabel{identify}

Obwohl -- oder gerade weil -- \Package{scrbase} ganz allgemein als Paket für
Klassen- und Paketautoren konzipiert ist, wird es natürlich von den
\KOMAScript-Klassen und den meisten \KOMAScript-Paketen verwendet. Es enthält
daher auch zwei Anweisungen, die in allen \KOMAScript-Klassen und allen
grundlegenden \KOMAScript-Paketen vorhanden sind.


\begin{Declaration}
  \Macro{KOMAScript}
\end{Declaration}
Diese Anweisung setzt schlicht die Wortmarke »\KOMAScript« in serifenloser
Schrift und mit leichter Sperrung des in Versalien gesetzten
Teils. \Macro{KOMAScript} wird übrigens bei Bedarf von allen
\KOMAScript-Klassen und "~Paketen definiert. Die Definition erfolgt mit
\Macro{DeclareRobustCommand}. Da auch Pakete, die nicht zu \KOMAScript{}
gehören, diese Wortmarke definieren können, sollte man die Anweisung jedoch
nicht als Indiz für die Verwendung eines \KOMAScript-Pakets verstehen.%
\EndIndexGroup


\begin{Declaration}
  \Macro{KOMAScriptVersion}
\end{Declaration}
Bei \KOMAScript{} ist in dieser Anweisung die Hauptversion von \KOMAScript{}
in der Form »\PName{Datum} \PName{Version} \texttt{KOMA-Script}«
abgelegt. Diese Hauptversion ist für alle \KOMAScript-Klassen und alle
\KOMAScript-Pakete, die von den Klassen verwendet werden, gleich. Daher kann
sie auch nach dem Laden von \Package{scrbase} abgefragt werden. Diese
Anleitung wurde beispielsweise mit der \KOMAScript-Version
»\KOMAScriptVersion« erstellt. Das Vorhandensein dieser Anweisung ist ein
starkes Indiz dafür, dass zumindest ein \KOMAScript-Paket verwendet wird.%
\EndIndexGroup


\section{Erweiterungen des \LaTeX-Kerns}
\seclabel{latexkernel}

In einigen Fällen stellt der \LaTeX-Kern selbst Anweisungen zur Verfügung,
lässt aber ganz ähnliche Anweisungen, die ebenfalls häufiger benötigt werden
oder eigentlich nahe liegen, vermissen. Einige wenige solcher Anweisungen
für Klassen- und Paketautoren stellt \Package{scrbase} zur Verfügung.

\begin{Declaration}
  \Macro{ClassInfoNoLine}\Parameter{Klassenname}\Parameter{Information}
  \Macro{PackageInfoNoLine}\Parameter{Paketname}\Parameter{Information}
\end{Declaration}%
Der \LaTeX-Kern bietet dem Klassen- und Paketautor zwar Anweisungen wie
\Macro{PackageInfo} und \Macro{ClassInfo}, um Informationen mit aktueller
Zeilennummer in die Log-Datei zu schreiben. Er bietet neben
\Macro{PackageWarning} und \Macro{ClassWarning}, die Warnungen mit aktueller
Zeilennummer ausgeben, auch die beiden Anweisungen
\Macro{PackageWarningNoLine} und \Macro{ClassWarningNoLine}, um Warnungen ohne
Zeilennummer auszugeben. Die naheliegenden Anweisungen
\Macro{ClassInfoNoLine} und \Macro{PackageInfoNoLine}, um auch Informationen
ohne Zeilennummer in die Log-Datei zu schreiben, fehlen jedoch. Diese werden
von \Package{scrbase} bereit gestellt.
%
\EndIndexGroup


\begin{Declaration}
  \Macro{l@addto@macro}\Parameter{Anweisung}\Parameter{Erweiterung}%
\end{Declaration}%
Der \LaTeX-Kern bietet mit \Macro{g@addto@macro} eine interne Anweisung, um
die Definition eines Makro \PName{Anweisung} global um den Code
\PName{Erweiterung} zu erweitern. Das funktioniert in dieser Form nur für
Makros ohne Argumente. Dennoch könnte man diese Anweisung in einigen Fällen
auch in einer Form benötigen, die lokal zur aktuellen Gruppe arbeitet. Diese
wird mit \Macro{l@addto@macro} von \Package{scrbase} bereit gestellt. Eine
Alternative stellt hier die Verwendung des Pakets
\Package{etoolbox}\IndexPackage{etoolbox} oder
\Package{xpatch}\IndexPackage{xpatch} dar, das eine ganze Reihe solcher
Anweisungen für unterschiedliche Zwecke bietet (siehe
\cite{package:etoolbox} beziehungsweise \cite{package:xpatch}).
%
\EndIndexGroup


\section{Erweiterungen der mathematischen Fähigkeiten von \eTeX}
\seclabel{etex}

Das für \LaTeX{} inzwischen verwendete und von \KOMAScript{} vorausgesetzte
\eTeX{} besitzt mit \Macro{numexpr}\IndexCmd{numexpr} erweiterte Möglichkeiten
zur Berechnung einfacher Ausdrücke mit \TeX-Zählern und ganzen Zahlen. Als
Operationen werden dabei die vier Grundrechenarten und Klammern
unterstützt. Bei der Division wird korrekt gerundet. Manchmal sind weitere
Operationen nützlich.

\begin{Declaration}
  \Macro{XdivY}\Parameter{Dividend}\Parameter{Divisor}
  \Macro{XmodY}\Parameter{Dividend}\Parameter{Divisor}
\end{Declaration}%
\BeginIndex{Cmd}{XdivY}%
\BeginIndex{Cmd}{XmodY}%
Die\ChangedAt{v3.05a}{\Package{scrbase}} Anweisung \Macro{XdivY} liefert den
Wert des ganzzahligen Quotienten, die Anweisung \Macro{XmodY} den Wert des
Rests der Division mit Rest. Diese Art der Division ist nach der Gleichung
\[
\textit{Dividend} = \textit{Divisor} \cdot
\textit{Quotient} + \textit{Rest}
\]
%
definiert, wobei \textit{Dividend}, \textit{Divisor} und \textit{Rest} ganze
Zahlen und \textit{Rest} außerdem größer oder gleich 0 und kleiner als
\textit{Divisor} ist. Der \textit{Divisor} ist eine natürliche Zahl (ohne die
0).

Der Wert kann jeweils zur Zuweisung an einen Zähler oder direkt innerhalb
eines Ausdrucks mit \Macro{numexpr}\IndexCmd{numexpr} verwendet werden. Zur
Ausgabe als arabische Zahl ist \Macro{the} voranzustellen.%
%
\EndIndexGroup


\section[{Allgemeiner Mechanismus für mehrstufige Haken}]
{Allgemeiner Mechanismus für mehrstufige
  Haken\ChangedAt[2019/01]{v3.27}{\Package{scrbase}}}
\seclabel{hooks}

\BeginIndexGroup
\BeginIndex{}{Haken}
Der \LaTeX-Kern bietet selbst bereits einige wenige Stellen in der
Verarbeitung eines Dokuments, an denen die Ausführung zusätzlichen Codes
\emph{eingehakt} werden kann. Klassen- und Paketautoren dürften
\Macro{AtBeginDocument} und \Macro{AtEndDocument} bestens bekannt
sein. \KOMAScript{} bietet an einigen Stellen vergleichbares, beispielsweise
um Code in die Ausführung von
\hyperref[sec:maincls.structure]{Gliederungsbefehlen} einzuhaken. Über die
Jahre zeigten sich dabei zwei Probleme:
\begin{itemize}
\item Es gibt nie genug Haken.
\item Es gibt sowohl Code, der nur einmal ausgeführt werden soll, also quasi
  bei seiner Ausführung wieder vom Haken fällt, als auch Code, der bei jedem
  Durchlaufen des Hakens auszuführen ist, also dauerhaft auf dem Haken bleibt.
\end{itemize}
Üblicherweise muss man zur Definition eines einzelnen Hakens eine Anweisung
definieren, mit der Code für den jeweiligen Haken aufgesammelt wird. Dieser
Code wird dann in einem weiteren internen Makro abgelegt, das man an der
Stelle einfügen muss, an der der aufgesammelte Code auszuführen ist. Je mehr
Haken man einfügt, desto mehr solcher Anweisungen gibt es. Um sowohl
Einmalcode als auch dauerhaften Code zu ermöglichen, benötigt es gegebenfalls
sogar zwei Haken und damit die doppelte Anzahl an zu definierenden
Anweisungen.

Das Beispiel der Gliederungsbefehle zeigt, dass sich das erste Problem
teilweise an einem einzigen Codeausführungspunkt noch verschärfen kann. Hier
benötigt der eine Paketautor lediglich eine Möglichkeit für alle
Gliederungsbefehle denselben Code auszuführen. Ein anderer Paketautor hätte
lieber, dass er nur bei bestimmten Gliederungsbefehlen unterschiedlichen Code
ausführen kann. Es würde also sowohl ein allgemeiner Haken als auch ein Haken
je Gliederungsbefehl benötigt. Das ganze dann wieder wegen des zweiten
Problems verdoppelt.

\KOMAScript{} bietet in \Package{scrbase} daher einen verallgemeinerten
Hakenmechanismus, der mehrstufige Haken sowohl für Einmalcode als auch für
dauerhaften Code bereitstellt. Diese Haken haben aufgrund der Implementierung
den Namen \emph{do-hook} erhalten. Davon leitet sich auch der Name der
Anweisungen ab, mit denen sie gesteuert werden.

\begin{Declaration}
  \Macro{ExecuteDoHook}\Parameter{Spezifikator}
\end{Declaration}
Über\ChangedAt[2019/01]{v3.27}{\Package{scrbase}} diese Anweisung werden Haken
implementiert. Dabei bestimmt der \PName{Spezifikator} den Namen des oder
genauer der Haken. Der \PName{Spezifikator} wird zur Analyse immer vollständig
expandiert.

Der \PName{Spezifikator} besteht allgemein aus durch Querstrichen,
»\texttt{/}«, voneinander getrennten Zeichenfolgen. Von \Macro{ExecuteDoHook}
wird dann zunächst die Zeichenfolge vor dem ersten Querstrich
abgetrennt. Diese ist der Name. Der verbleibende Rest (ohne den Querstrich)
ist das Argument. Dann wird der Code für den Haken mit diesem Namen
ausgeführt. Anschließend wird erneut die vordere Zeichenfolge vom Rest
abgetrennt und mit einem Querstrich hinten an den Namen angefügt und der Code
für den so neu gebildeten Namen ausgeführt. Das geht so lange, bis der Code
für den Haken mit dem Namen \PName{Spezifikator} und leerem Argument
ausgeführt wurde.

Im einfachsten Fall besteht der \PName{Spezifikator} aus einem einzelnen
Namen. In diesem Fall wird zunächst der dauerhafte Code für genau einen durch
diesen Namen festgelegten Haken mit leerem Argument ausgeführt.

In jeder Stufe der Ausführung wird nach dem dauerhaften Code für einen Haken
zusätzlich Einmalcode ausgeführt, bevor der Einmalcode global vom Haken
genommen wird.

\begin{Example}
  Durch Einfügen von \DescRef{\LabelBase.cmd.ExecuteDoHook}%
  \PParameter{heading/begingroup/\PName{Name}} in die Ausführung eines jeden
  mit \DescRef{maincls-experts.cmd.DeclareSectionCommand} definierten
  Gliederungbefehls wurden in den \KOMAScript-Klassen letztlich sechs Haken an
  diesem Codepunkt eingefügt, die in dieser Reihenfolge ausgeführt werden:
  \begin{enumerate}
  \item \PValue{heading} mit Argument \PValue{begingroup/}\PName{Name} für
    dauerhaften Code,
  \item \PValue{heading} mit Argument \PValue{begingroup/}\PName{Name} für
    Einmalcode,
  \item \PValue{heading/begingroup} mit Argument \PName{Name} für
    dauerhaften Code,
  \item \PValue{heading/begingroup} mit Argument \PName{Name} für
    Einmalcode,
  \item \PValue{heading/begingroup/}\PName{Name} mit leerem Argument für
    dauerhaften Code,
  \item \PValue{heading/begingroup/}\PName{Name} mit leerem Argument für
    Einmalcode.
  \end{enumerate}
  \PName{Name} ist dabei der bei
  \DescRef{maincls-experts.cmd.DeclareSectionCommand},
  \DescRef{maincls-experts.cmd.DeclareNewSectionCommand} oder
  \DescRef{maincls-experts.cmd.ProvideSectionCommand} angegebene \PName{Name}
  der Gliederungsebene beziehungsweise des dadurch bestimmten
  Gliederungsbefehls, also beispielsweise \PValue{chapter} oder
  \PValue{subparagraph}. Betrachtet man obige Auflistung unter
  Berücksichtigung der Tatsache, dass es diverse Gliederungsbefehle gibt,
  wird klar, dass die Haken \PValue{heading} und \PValue{heading/begingroup}
  mehrfach, nämlich für jeden Gliederungsbefehl existieren.%
\end{Example}%
%
\EndIndexGroup

\begin{Declaration}
  \Macro{AddtoDoHook}\Parameter{Name}\Parameter{Befehl}
  \Macro{AddtoOneTimeDoHook}\Parameter{Name}\Parameter{Befehl}
\end{Declaration}
Mit\ChangedAt[2019/01]{v3.27}{\Package{scrbase}} \Macro{AddtoDoHook} wird an
dem Haken mit dem Namen \PName{Name} dauerhafter Code aufgehängt. Als Code
dient dabei der \PName{Befehl}, dem das in der Erklärung zu
\DescRef{\LabelBase.cmd.ExecuteDoHook} erwähnte Argument als Parameter
angehängt wird.
\begin{Example}
  Angenommen, es soll innerhalb von \Macro{section} mitgezählt werden, wie oft
  diese Anweisung ausgeführt wird. Dies wäre in Fortführung des obigen
  Beispiels mit
\begin{lstcode}
  \newcounter{sectionZaehler}
  \AddtoDoHook{heading/begingroup/section}
              {\stepcounter{sectionZaehler}}
\end{lstcode}
  sehr einfach möglich. Allerdings würde dann in Wirklichkeit
  \Macro{stepcounter}\PParameter{sectionZaehler}\PParameter{} ausgeführt. Wir
  erinnern uns daran, dass immer ein Argument als Parameter angehängt wird.
  Im Falle des Hakens mit dem Namen \PValue{heading/begingroup/section} ist
  dieses Argument leer. Da ein solcher leerer Parameter hier zur einer leeren
  Gruppe wird, ist es besser, diesen leeren Parameter quasi aufzubrauchen:
\begin{lstcode}
  \newcommand*{\stepcountergobble}[2]{%
    \stepcounter{#1}%
  }
  \AddtoDoHook{heading/begingroup/section}
              {\stepcountergobble{sectionZaehler}}
\end{lstcode}
  Hier wird der angehängte, leere Parameter von \Macro{stepcountergobble}
  gelesen, aber nicht verwendet.

  Sollen nun statt \Macro{section} alle Gliederungsbefehle gezählt werden, so
  muss nur ein anderer Hakenname eingesetzt werden:
\begin{lstcode}
  \AddtoDoHook{heading/begingroup}
              {\stepcountergobble{sectionZaehler}}
\end{lstcode}
  Hier ist übrigens der angehängte Parameter nicht leer, sondern enthält den
  Namen der Gliederungsebene oder des Gliederungsbefehls. Wollte man die
  Gliederungsbefehle einzeln zählen, so könnte man genau dies ausnützen:
\begin{lstcode}
  \newcommand*{\stepZaehler}[1]{%
    \stepcounter{#1Zaehler}%
  }
  \AddtoDoHook{heading/begingroup}
              {\stepZaehler}
\end{lstcode}
  Natürlich müssten dann auch die Zähler \Counter{partZaehler},
  \Counter{chapterZaehler} bis hinunter zu \Counter{subparagraphZaehler}
  definiert werden.
\end{Example}

Die Anweisung \Macro{AddtoOneTimeDoHook} arbeitet vergleichbar, fügt den
\PName{Befehl} aber dem Einmalcode hinzu. Dieser Code wird dann nach der
ersten Ausführung global vom Haken genommen.%
\EndIndexGroup

\begin{Declaration}
  \Macro{ForDoHook}\Parameter{Spezifikator}\Parameter{Befehl}
\end{Declaration}
Während\ChangedAt[2019/01]{v3.27}{\Package{scrbase}}
\DescRef{\LabelBase.cmd.ExecuteDoHook} dazu gedacht ist, die Befehle
auszuführen, die zuvor mit \DescRef{\LabelBase.cmd.AddtoDoHook} oder
\DescRef{\LabelBase.cmd.AddtoOneTimeDoHook} für die durch den
\PName{Spezifikator} bestimmten Haken gespeichert wurden, führt diese Anweisung
den unmittelbar angegebenen \PName{Befehl} aus. Dabei werden an \PName{Befehl}
sogar zwei Parameter angefügt. Der erste Parameter ist der Name des Haken, der
zweite das Argument des Hakens.

Diese Anweisung ist ein Abfallprodukt der Implementierung von
\DescRef{\LabelBase.cmd.ExecuteDoHook}. Normalerweise sollten weder Anwender
noch Paketautoren diese Anweisung benötigen.%
\EndIndexGroup

\begin{Declaration}
  \Macro{SplitDoHook}\Parameter{Spezifikator}\Parameter{Kopf-Makro}
                     \Parameter{Rest-Makro}
\end{Declaration}
Wie\ChangedAt[2019/01]{v3.27}{\Package{scrbase}} aus den vorangegangenen
Erklärungen deutlich wird, kann der Parameter eines mit
\DescRef{\LabelBase.cmd.AddtoDoHook} oder
\DescRef{\LabelBase.cmd.AddtoOneTimeDoHook} hinzugefügten \PName{Befehls}
ebenfalls ein mehrteiliger \PName{Spezifikator} sein. Mit \Macro{SplitDoHook}
kann so ein \PName{Spezifikator} in das vordere Element und den Rest
aufgeteilt werden. Das \PName{Kopf-Makro} wird dabei als das vordere Element
definiert. Das \PName{Rest-Makro} wird als der Rest definiert. Im Falle, dass
kein Rest bleibt, wird das \PName{Rest-Makro} leer definiert. Falls bereits der
\PName{Spezifikator} leer war, wird eine Warnung ausgegeben und sowohl
\PName{Kopf-Makro} als auch \PName{Rest-Makro} leer definiert.

\begin{Example}
  Wollte man am Anfang der Gruppe, in der die Überschrift ausgegeben wird,
  einen Zähler erhöhen, diesen am Ende aber wieder verringern, so könnte man
  dies über zwei Haken tun:
\begin{lstcode}
  \AddtoDoHook{heading/begingroup}
              {\stepZaehler}
  \newcommand*{\restepZaehler}[1]{%
    \addtocounter{#1Zaehler}{-1}%
  }
  \AddtoDoHook{heading/endgroup}
              {\restepcounter}
\end{lstcode}
  Man könnte aber auch mit einem einzigen Haken arbeiten und dessen Parameter
  zerlegen:
\begin{lstcode}
  \newcommand*{\changeZaehler}[1]{%
    \SplitDoHook{#1}{\Gruppe}{\Ebene}%
    \ifstr{\Gruppe}{begingroup}{%
      \stepcounter{\Ebene Zaehler}%
    }{%
      \ifstr{\Gruppe}{endgroup}{%
        \addtocounter{\Ebene Zaehler}{-1}%
      }{}%
    }%
  }
  \AddtoDoHook{heading}
              {\changeZaehler}
\end{lstcode}
  Wie zu sehen ist, ist die erste Lösung um einiges einfacher. Dazu kommt,
  dass man die zweite Fallunterscheidung in der zweiten Lösung gerne
  vergisst. Das wäre allerdings fatal, da es weitere Haken mit Namen
  \PValue{heading} aber abweichendem Argument geben kann.
\end{Example}

Genau genommen ist diese Anweisung ein Abfallprodukt aus der Implementierung
von \DescRef{\LabelBase.cmd.ForDoHook}.%
\EndIndexGroup
%
\EndIndexGroup
\EndIndexGroup

\endinput

%%% Local Variables:
%%% mode: latex
%%% mode: flyspell
%%% coding: utf-8
%%% ispell-local-dictionary: "de_DE"
%%% TeX-master: "../guide.tex"
%%% End:

% LocalWords:  Paketoptionen Familienmitglieder Familienmitglieds Säumniswert
% LocalWords:  Fleischermeister FamilyProcessOptions ProcessOption keyval Cmd
% LocalWords:  documentclass ProcessOptions FamilyExecuteOptions currname
% LocalWords:  Optionenliste ExecuteOptions DeclareOption currext Wurstsalat
% LocalWords:  FamilyOptions FamilyKeyState Wurstpakete nonsense package true
% LocalWords:  Wurstpaket FamilyOption salatmit SalatZusatz scrbase false
% LocalWords:  AtEndOfFamilyOptions FamilyBoolKey FamilySetBool Schaltername
% LocalWords:  FamilyLengthKey FamilySetLength FamilyLengthMacroKey
% LocalWords:  FamilySetLengthMacro Wertübergabe Gliederungsbefehlen
% LocalWords:  Sternvariante Anwenderanweisungen Signalisierung Paketautoren
% LocalWords:  Familienschlüssel Mitgliederschlüssels Vergleichszustand
% LocalWords:  Benutzeräquivalent Dokumentpräambel voranzustellen