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
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
|
% ======================================================================
% scrbookreportarticle.tex
% Copyright (c) Markus Kohm, 2001-2014
%
% 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.
% ----------------------------------------------------------------------
% scrbookreportarticle.tex
% Copyright (c) Markus Kohm, 2001-2014
%
% 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.
% ======================================================================
%
% Chapter about scrbook, scrreprt, and scrartcl of the KOMA-Script guide
% Maintained by Markus Kohm
%
% ----------------------------------------------------------------------
%
% Kapitel ueber scrbook, scrreprt und scrartcl in der KOMA-Script-Anleitung
% Verwaltet von Markus Kohm
%
% ============================================================================
\KOMAProvidesFile{scrbookreportarticle.tex}
[$Date: 2014-12-22 08:58:28 +0100 (Mon, 22 Dec 2014) $
KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm\and
Krickette Murabayashi\and Jana Schubert\and Jens H\"uhne}
% Date of translated german file: 2014-06-26
\chapter{The Main Classes: \Class{scrbook}, \Class{scrreprt}, and
\Class{scrartcl}}
\labelbase{maincls}
\BeginIndex{Class}{scrbook}%
\BeginIndex{Class}{scrreprt}%
\BeginIndex{Class}{scrartcl}%
%\AddSeeIndex{command}{gen}{\GuidecmdIndexShort}{cmd}% <-- set automatically
\AddSeeIndex{macro}{gen}{\GuidecmdIndexShort}{cmd}%
\AddSeeIndex{instruction}{gen}{\GuidecmdIndexShort}{cmd}%
The main classes of the {\KOMAScript} bundle are designed as counterparts to
the standard {\LaTeX} classes. This means that the {\KOMAScript} bundle
contains replacements for the three standard classes:
\Class{book}\IndexClass{book}, \Class{report}\IndexClass{report}, and
\Class{article}\IndexClass{article}. There is also a replacement for the
standard class \Class{letter}\IndexClass{letter}. The document class for
letters is described in a separate chapter, because it is fundamentally
different from the three main classes (see \autoref{cha:scrlttr2}).
\iffalse% Umbruchkorrekturtext
The names of the {\KOMAScript} classes are composed of the prefix
``\texttt{scr}'' and the abbreviated name of the corresponding standard
class. In order to restrict the length of the names to eight letters, the
vowels, starting with the last one, are left off as necessary. The
\autoref{tab:maincls.overview} shows an overview of the correspondence
between the standard classes and the {\KOMAScript} classes.
\fi
The simplest way to use a {\KOMAScript} class instead of a standard one is to
substitute the class name in the \verb|\documentclass| command according to
\autoref{tab:maincls.overview}. For example, you may replace
\Macro{documentclass}\PParameter{book} by
\Macro{documentclass}\PParameter{scrbook}. Normally, the document should be
processed without errors by {\LaTeX}, just like before the substitution. The
look, however, should be different. Additionally, the {\KOMAScript} classes
provide new possibilities and options that are described in the following
sections.
\begin{table}
% \centering
\KOMAoptions{captions=topbeside}
\setcapindent{0pt}
% \caption
\begin{captionbeside}
[Class correspondence]{\label{tab:maincls.overview}Correspondence between
standard classes and {\KOMAScript} classes}% and \Script{} styles.}
[l]
\begin{tabular}[t]{ll}
\toprule
standard class & {\KOMAScript} class \\%& \Script-Stil (\LaTeX2.09)\\
\midrule
\Class{article} & \Class{scrartcl} \\%& \File{script\textunderscore s} \\
\Class{report} & \Class{scrreprt} \\%& \File{script} \\
\Class{book} & \Class{scrbook} \\%& \File{script} \\
\Class{letter} & \Class{scrlttr2} \\%& \File{script\textunderscore l} \\
\bottomrule
\end{tabular}
\end{captionbeside}
\end{table}
Allow me an observation before proceeding with the descriptions of the
options. It is often the case that at the beginning of a document one is often
unsure which options to choose for that specific document. Some options, for
instance the choice of paper size, may be fixed from the beginning. But
already the question of the size of the text area and the margins could be
difficult to answer initially. On the other hand, the main business of an
author\,---\,planning the document structure, writing the text, preparing
figures, tables, lists, index, and other data\,---\,should be almost
independent of those settings. As an author you should concentrate initially
on this work. When that is done, you can concentrate on the fine points of
presentation. Besides the choice of options, this means correcting
hyphenation, optimizing page breaks, and the placement of tables and figures.
\LoadCommon{0}% \section{Early or Late Selection of Options}
\LoadCommon{1}% \section{Compatibility with Earlier Versions of KOMA-Script}
\LoadCommon{2}% \section{Draft Mode}
\LoadCommon{3}% \section{Page Layout}
\begin{Declaration}
\Macro{flushbottom}\\
\Macro{raggedbottom}
\end{Declaration}
\BeginIndex{Cmd}{raggedbottom}%
\BeginIndex{Cmd}{flushbottom}%
\begin{Explain}
In double-sided documents, it's preferred to have the same visual baseline
in not only the first lines of the text areas in a double-side spread, but
also in the last lines. If pages consist of text without paragraphs or
headlines only, this is the result in general. But a paragraph distance of
half of a line would be enough to prevent achieving this, if the difference
in the number of paragraphs on each page of the double-page spread is
odd-numbered. In this case at least some of the paragraph distances need to
be shrunk or stretched to fit the rule again. \TeX{} knows shrinkable and
stretchable distances for this purpose. \LaTeX{} provides an automatism for
this kind of vertical adjustment\Index{adjustment>vertical}.
\end{Explain}
Using double-sided typesetting with option \Option{twoside} (see
\autoref{sec:typearea.options},
\autopageref{desc:typearea.option.twoside}) switches on vertical
adjustment also. Alternatively, vertical adjustment may be switched on
at any time valid from the current page using
\Macro{flushbottom}. \Macro{raggedbottom} would have the opposite
effect, switching off vertical adjustment from the current page
on. This is also the default at one-sided typesetting.
By the way, \KOMAScript{} uses a slightly modified kind of abdication of
vertical adjustment. This has been done to move footnotes to the bottom of the
text area instead of having them close to the last used text line.\iffree{}{
More information about this may be found at
\autoref{sec:maincls-experts.addInfos},
\autopageref{desc:maincls-experts.cmd.footnoterule}.}%
%
\EndIndex{Cmd}{flushbottom}%
\EndIndex{Cmd}{raggedbottom}%
%
\EndIndex{}{page>layout}
\section{Selection of the Document Font Size}
\LoadCommon{4}
The default at \Class{scrbook}, \Class{scrreprt}, and \Class{scrartcl} is
\OptionValue{fontsize}{11pt}.\textnote{\KOMAScript{} vs. standard classes} In
contrast, the default of the standard classes would be \Option{10pt}. You
may attend to this if you switch from a standard class to a \KOMAScript{}
class.%
%
\EndIndex{Option}{fontsize~=\PName{size}}%
%
\EndIndex{}{font>size}
\LoadCommon{5}% \section{Text Markup}
\LoadCommon{14} %\section{Document Titles}
\section{Abstract}
\label{sec:maincls.abstract}
\BeginIndex{}{summary}%
\BeginIndex{}{abstract}%
Particularly\OnlyAt{\Class{scrartcl}\and\Class{scrreprt}} with
articles, more rarely with reports, there is a summary\Index{summary}
directly under the title and before the table of contents. When using an in-page
title, this summary is normally a kind of left- and right-indented block. In
contrast to this, a kind of chapter or section is printed using title pages.
\begin{Declaration}
\KOption{abstract}\PName{simple switch}
\end{Declaration}%
\BeginIndex{Option}{abstract~=\PName{simple switch}}%
\ChangedAt{v3.00}{\Class{scrreprt}\and \Class{scrartcl}}%
In\OnlyAt{\Class{scrreprt}\and\Class{scrartcl}} the standard classes the
\Environment{abstract} environment sets the text ``\abstractname'' centered
before the summary text\Index[indexmain]{summary}. This was normal practice in
the past. In the meantime, newspaper reading has trained readers to recognize
a displayed text at the beginning of an article or report as the
abstract. This is even more true when the text comes before the table of
contents. It is also surprising when precisely this title appears small and
centered. {\KOMAScript} provides the possibility of including or excluding the
abstract's title with the options \Option{abstract}. For \PName{simple
switch}, any value from
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch} may be used.
Books typically use another type of summary. In that case there is usually a
dedicated summary chapter at the beginning or end of the book. This chapter is
often combined with the introduction or a description of wider
prospects. Therefore, the class \Class{scrbook} has no \Environment{abstract}
environment. A\textnote{Hint!} summary chapter is also recommended for reports in a wider
sense, like a Master's or Ph.D. thesis.%
%
\EndIndex{Option}{abstract~=\PName{simple switch}}%
\begin{Declaration}
\XMacro{begin}\PParameter{\Environment{abstract}}\\
\quad\dots\\
\XMacro{end}\PParameter{abstract}
\end{Declaration}%
\BeginIndex{Env}{abstract}%
\OnlyAt{\Class{scrartcl}\and \Class{scrreprt}}%
Some {\LaTeX} classes offer a special environment for this summary, the
\Environment{abstract} environment. This is output directly, as it is not a
component of the titles set by \Macro{maketitle}. Please\textnote{Attention!}
note that \Environment{abstract} is an environment, not a command. Whether the
summary has a heading or not is determined by the option \Option{abstract}
(see above).
With books (\Class{scrbook}) the summary is frequently a component of the
introduction or a separate chapter at the end of the document. Therefore no
\Environment{abstract} environment is provided. When using the class
\Class{scrreprt} it is surely worth considering whether one should not proceed
likewise. See commands \Macro{chapter*}\IndexCmd{chapter*} and
\Macro{addchap}\IndexCmd{addchap} or \Macro{addchap*} at
\autoref{sec:maincls.structure} from \autopageref{desc:maincls.cmd.chapter*}
onwards.
When using an in-page title\Index{title>in-page} (see option \Option{titlepage},
\autoref{sec:maincls.titlepage}, \autopageref{desc:maincls.option.titlepage}),
the abstract is set using the environment
\Environment{quotation}\IndexEnv{quotation} (see \autoref{sec:maincls.lists},
\autopageref{desc:maincls.env.quotation}) internally. Thereby paragraphs will
be set with indentation of the first line. If that first paragraph of the
abstract should not be indented, this indent may be disabled using
\Macro{noindent}\IndexCmd{noindent}\important{\Macro{noindent}} \iffree{just
after \Macro{begin}\PParameter{abstract}}{at the begin of the environment}.%
%
\EndIndex{Env}{abstract}%
%
\EndIndex{}{summary}%
\EndIndex{}{abstract}
\section{Table of Contents}
\label{sec:maincls.toc}
\BeginIndex{}{table of contents}
The table of contents is normally set after the document title and an
optional existing abstract. Often one may find additional lists of
floating environments, e.\,g., the list of tables and the list of
figures, after the table of contents (see
\autoref{sec:maincls.floats}).
\begin{Declaration}
\KOption{toc}\PName{selection}
\end{Declaration}
\BeginIndex{Option}{toc~=\PName{selection}}%
\label{desc:maincls.option.toc.listof}%
\label{desc:maincls.option.toc.nolistof}%
\label{desc:maincls.option.toc.listofnumbered}\nobreak
It is becoming increasingly common to find entries in the table of contents
for the lists of tables and figures, for the bibliography, and, sometimes,
even for the index. This is surely also related to the recent trend of putting
lists of figures and tables at the end of the document. Both lists are
similiar to the table of contents in structure and intention. I'm therefore
sceptical of this evolution. Since\important{\OptionValue{toc}{listof}} it
makes no sense to include only one of the lists of tables and figures in the
table of contents, there exists only one
\PName{selection}\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} \PValue{listof}\IndexOption{toc~=\PValue{listof}} that
causes entries for both types of lists to be included. This also includes any
lists produced with version~1.2e or later of the
\Package{float}\IndexPackage{float} package (see \cite{package:float}) or the
\Package{floatrow} (see \cite{package:floatrow}).
All\important{\OptionValue{toc}{listofnumbered}} these lists are unnumbered,
since they contain entries that reference other sections of the document. If
one wants to ignore this general agreement, one may use \PName{selection}
\PValue{listofnumbered}%
\IndexOption{toc~=\PValue{listofnumbered}}.
\leavevmode\phantomsection\nobreak
\label{desc:maincls.option.toc.index}\nobreak
The\important{\OptionValue{toc}{index}} option \OptionValue{index}{totoc}
causes an entry for the index to be included in the table of contents. The
index is unnumbered since it too only includes references to the contents of
the other sectional units. \KOMAScript{} does not have support to ignore this
general agreement.
\leavevmode\phantomsection\nobreak
\label{desc:maincls.option.toc.bibliography}\nobreak
The bibliography is a different kind of listing. It does not list the contents
of the present document but refers instead to external
documents. For\important{\begin{tabular}{@{}r@{}}
\multicolumn{1}{@{}l@{}}{\Option{toc=}}\\
~\PValue{bibliographynumbered}\\
\end{tabular}} that
reason, it could be argued that it qualifies as a chapter (or section) and, as
such, should be numbered. The option \OptionValue{toc}{bibliographynumbered}%
\IndexOption{toc~=\PValue{bibliographynumbered}}
has this effect, including the generation of the corresponding entry in the
table of contents. I personally think that this reasoning would lead us to
consider a classical list of sources also to be a separate chapter. On the
other hand, the bibliography is finally not something that was written by the
document's author. In\important{\OptionValue{toc}{bibliography}} view of this, the bibliography merits nothing more than
an unnumbered entry in the table of contents, and that can be achieved with
\OptionValue{toc}{bibliography}\IndexOption{toc~=\PValue{bibliography}}.
\leavevmode\phantomsection\nobreak
\label{desc:maincls.option.toc.graduated}\nobreak
The table of contents is normally\ChangedAt{v2.8q}{%
\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}%
\important{\OptionValue{toc}{graduated}} set up so that different sectional
units have different indentations. The section number is set left-justified in
a fixed-width field. This default setup is selected with the option
\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}
\OptionValue{toc}{graduated}\IndexOption{toc~=\PValue{graduated}}.
\leavevmode\phantomsection\nobreak
\label{desc:maincls.option.toc.flat}\nobreak
When there are many sections, the corresponding numbering tends to become very
wide, so that the reserved field overflows. The German FAQ \cite{DANTE:FAQ}
suggests that the table of contents should be redefined in such a
case. {\KOMAScript}\important{\OptionValue{toc}{flat}} offers an alternative
format that avoids the problem completely. If the option
\OptionValue{toc}{flat}\IndexOption{toc~=\PValue{flat}} is selected, then no variable indentation is applied
to the titles of the sectional units. Instead, a table-like organisation is
used, where all unit numbers and titles, respectively, are set in a
left-justified column. The space necessary for the unit numbers is thus
determined automatically.%
The \autoref{tab:maincls.toc} shows an overview of possible values for
\PName{selection} of \Option{toc}.
\begin{desclist}
\desccaption[{Possible values of option \Option{toc}}]{%
Possible values of option \Option{toc} to set form and contents of the
table of contents\label{tab:maincls.toc}%
}{%
Possible values of option \Option{toc} (\emph{continuation})%
}%
\entry{\PValue{bibliography}, \PValue{bib}}{%
The bibliography will be represented by an entry at the table of contents,
but will not be numbered.%
\IndexOption{toc~=\PValue{bibliography}}}%
\entry{\PValue{bibliographynumbered}, \PValue{bibnumbered},
\PValue{numberedbibliography}, \PValue{numberedbib}}{%
The bibliography will be represented by an entry at the table of contents
and will be numbered.%
\IndexOption{toc~=\PValue{bibliographynumbered}}}%
\entry{\PValue{chapterentrywithdots}, \PValue{chapterentrydotfill}}{%
\ChangedAt[2014/12]{v3.15}{\Class{scrbook}\and \Class{scrreprt}}%
The chapter entries of classes \Class{scrbook} and \Class{scrreprt} also
use dots to separate the headings text from the page number.%
\IndexOption{toc~=\PValue{chapterentrywithdots}}}%
\entry{\PValue{chapterentrywithoutdots}, \PValue{chapterentryfill}}{%
\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}}%
The chapter entries of classes \Class{scrbook} and \Class{scrreprt}
use white space to separate the headings text from the page number.%
\IndexOption{toc~=\PValue{chapterentrywithoutdots}}}%
\entry{\PValue{flat}, \PValue{left}}{%
The table of contents will be set in table form. The numbers of the
headings will be at the first column, the heading text at the second
column, and the page number at the third column. The amount of space
needed for the numbers of the headings will be determined by the detected
needed amount of space at the previous \LaTeX{} run.%
\IndexOption{toc~=\PValue{flat}}}%
\entry{\PValue{graduated}, \PValue{indent}, \PValue{indented}}{%
The table of contents will be set in hierarchical form. The amount of
space for the heading numbers is limited.%
\IndexOption{toc~=\PValue{graduated}}}%
\entry{\PValue{index}, \PValue{idx}}{%
The index will be represented by an entry at the table of contents, but
will not be numbered.%
\IndexOption{toc~=\PValue{index}}}%
\pventry{listof}{%
The lists of floating environments, e.\,g., the list of figures and the
list of tables, will be represented by entries at the table of contents,
but will not be numbered.%
\IndexOption{toc~=\PValue{listof}}}%
\entry{\PValue{listofnumbered}, \PValue{numberedlistof}}{%
The lists of floating environments, e.\,g., the list of figures and the
list of tables, will be represented by entries at the table of contents
and will be numbered.%
\IndexOption{toc~=\PValue{listofnumbered}}}%
\entry{\PValue{nobibliography}, \PValue{nobib}}{%
The bibliography will not be represented by an entry at the table of
contents.%
\IndexOption{toc~=\PValue{nobibliography}}}%
\entry{\PValue{noindex}, \PValue{noidx}}{%
The index will not be represented by an entry at the table of
contents.%
\IndexOption{toc~=\PValue{noindex}}}%
\pventry{nolistof}{%
The lists of floating environments, e.\,g., the list of figures and the
list of tables, will not be represented by entries at the table of
contents.%
\IndexOption{toc~=\PValue{nolistof}}}%
\entry{\PValue{sectionentrywithdots}, \PValue{sectionentrydotfill}}{%
\ChangedAt[2014/12]{v3.15}{\Class{scrartcl}}%
The section entries of class \Class{scrartcl} also
use dots to separate the headings text from the page number.%
\IndexOption{toc~=\PValue{sectionentrywithdots}}}%
\entry{\PValue{sectionentrywithoutdots}, \PValue{sectionentryfill}}{%
\ChangedAt{v3.15}{\Class{scrartcl}}%
The section entries of class \Class{scrartcl}
use white space to separate the headings text from the page number.%
\IndexOption{toc~=\PValue{sectionentrywithoutdots}}}%
\end{desclist}
%
\EndIndex{Option}{toc~=\PName{selection}}%
\begin{Declaration}
\KOption{chapterentrydots}\PName{simple switch}\\
\KOption{sectionentrydots}\PName{simple switch}
\end{Declaration}
\BeginIndex{Option}{chapterentrydots~=\PName{simple switch}}%
\BeginIndex{Option}{sectionentrydots~=\PName{simple switch}}%
These\ChangedAt[2014/12]{v3.15}{\Class{scrbook}\and \Class{scrreprt}} options
configure a dotted separation line between the text and the page number of the
chapter entries of classes \Class{scrbook} and
\Class{scrreprt}\OnlyAt{\Class{scrbook}\and \Class{scrreprt}}, or of the
section entries of class \Class{scrartcl}\OnlyAt{\Class{scrartcl}} in the
table of contents. For \PName{simple switch}, any value from
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch} may be
used. The default is \PValue{false}. It selects an empty gap instead of
dots.
If a dotted line is selected, you can change their font using element
\FontElement{chapterentrydots}\IndexFontElement{chapterentrydots}%
\important[i]{\FontElement{chapterentrydots}\\
\FontElement{sectionentrydots}} or
\FontElement{sectionentrydots}\IndexFontElement{sectionentrydots}. The font
also depends on the element of the page number of the entry (see also
\autoref{sec:maincls.textmarkup}, \autopageref{desc:maincls.cmd.setkomafont}
and \autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}). The defaults of the elements
are shown in \autoref{tab:maincls.tocelements}. Please
note\textnote{Attention!} that the dots of all entries are equally aligned
only if all dots use the same font.%
\EndIndex{Option}{sectionentrydots~=\PName{simple switch}}%
\EndIndex{Option}{chapterentrydots~=\PName{simple switch}}%
\begin{Declaration}
\Macro{tableofcontents}
\end{Declaration}%
\BeginIndex{Cmd}{tableofcontents}%
The production of the table of contents is done by the \Macro{tableofcontents}
command. To get a correct table of contents, at least two {\LaTeX} runs are
necessary after every change. The contents and the form of the table of
contents may be influenced with the above described option \Option{toc}. After
changing the settings of this option, at least two \LaTeX{} runs are needed
again.
The entry for the highest sectional unit below \Macro{part}, i.\,e.,
\Macro{chapter} with \Class{scrbook}\IndexClass{scrbook} and
\Class{scrreprt}\IndexClass{scrreprt} or \Macro{section} with
\Class{scrartcl}\IndexClass {scrartcl} is not indented. There are no dots
between the text of the sectional unit heading and the page number. The
typographic reasons for this are that the font is usually different, and the
desire for appropriate emphasis. The table of contents of this manual is a
good example of these considerations. The font
style\ChangedAt{v2.97c}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}\important[i]{\FontElement{partentry}\\
\FontElement{chapterentry}\\
\FontElement{sectionentry}} is, however, affected by the settings of the
element \FontElement{partentry}\IndexFontElement{partentry}, and for classes
\Class{scrbook} and \Class{scrreprt} by
\FontElement{chapterentry}\IndexFontElement{chapterentry}, and for class
\Class{scrartcl} by
\FontElement{sectionentry}\IndexFontElement{sectionentry}. The font style of
the page numbers may be set dissenting from these elements using
\FontElement{partentrypagenumber}\IndexFontElement{partentrypagenumber} and
\FontElement{chapterentrypagenumber}\IndexFontElement{chapterentrypagenumber}
respectively
\FontElement{sectionentrypagenumber}\IndexFontElement{sectionentrypagenumber}
(see \autoref{sec:maincls.textmarkup},
\autopageref{desc:maincls.cmd.setkomafont}, and
\autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}). If the optional dots of the
entries of \Macro{chapter} or \Macro{section} are used, you can change their
font using element
\FontElement{chapterentrydots}\IndexFontElement{chapterentrydots}%
\important[i]{\FontElement{chapterentrydots}\\
\FontElement{sectionentrydots}} or
\FontElement{sectionentrydots}\IndexFontElement{sectionentrydots}. The font
also depends on the element of the page number of the entry (see also
\autoref{sec:maincls.textmarkup}, \autopageref{desc:maincls.cmd.setkomafont}
and \autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}). The defaults of the elements
are shown in \autoref{tab:maincls.tocelements}. Please
note\textnote{Attention!} that the dots of all entries are aligned same only
if all dots use the same font.%
\begin{table}
% \centering
% \caption
\KOMAoptions{captions=topbeside}%
\setcapindent{0pt}%
\begin{captionbeside}
[Font style defaults of the elements of the table of contents]
{\label{tab:maincls.tocelements}%
Font style defaults of the elements of the table of contents}%
[l]
\setlength{\tabcolsep}{.9\tabcolsep}% Umbruchoptimierung!
\begin{tabular}[t]{ll}
\toprule
Element & Default font style \\
\midrule
\FontElement{partentry} &
\Macro{usekomafont}\PParameter{disposition}\Macro{large} \\
\FontElement{partentrypagenumber} & \\
\FontElement{chapterentry} & \Macro{usekomafont}\PParameter{disposition}\\
\FontElement{chapterentrydots} & \Macro{normalfont} \\
\FontElement{chapterentrypagenumber} & \\
\FontElement{sectionentry} & \Macro{usekomafont}\PParameter{disposition}\\
\FontElement{sectionentrydots} & \Macro{normalfont} \\
\FontElement{sectionentrypagenumber} & \\
\bottomrule
\end{tabular}
\end{captionbeside}
\end{table}
%
\EndIndex{Cmd}{tableofcontents}%
\begin{Declaration}
\Counter{tocdepth}
\end{Declaration}%
\BeginIndex{Counter}{tocdepth}%
Normally, the units included in the table of contents are all the units from
\Macro{part} to \Macro{subsection} for the classes \Class{scrbook} and
\Class{scrreprt} or from \Macro{part} to \Macro{subsubsection} for the class
\Class{scrartcl}. The inclusion of a sectional unit in the table of contents
is controlled by the counter \Counter{tocdepth}. This has the value \(-\)1 for
\Macro{part}, 0 for \Macro{chapter}, and so on. By incrementing
or decrementing the counter, one can choose the lowest sectional unit level to
be included in the table of contents. The same happens with the standard
classes.
Please note\textnote{Attention!} that for \Macro{part} the values of
\Counter{tocdepth} and \Counter{secnumdepth}\IndexCounter{secnumdepth} (see
\autoref{sec:maincls.structure},
\autopageref{desc:maincls.counter.secnumdepth}) are not the same in
\Class{scrartcl}\OnlyAt{\Class{scrartcl}}. Therefore, you should not use
\Macro{partnumdepth}\IndexCmd{partnumdepth} to set the value of
\Counter{tocdepth}.%
\begin{Example}
Assume that you are preparing an article that uses the sectional
unit \Macro{subsubsection}. However, you do not want this sectional
unit to appear in the table of contents. The preamble of your
document might contain the following:
\begin{lstcode}
\documentclass{scrartcl}
\setcounter{tocdepth}{2}
\end{lstcode}
You set the counter \Counter{tocdepth} to 2 because you know that
this is the value for \Macro{subsection}. If you know that
\Class{scrartcl} normally includes all levels down to
\Macro{subsubsection} in the table of contents, you can simply
decrement the counter \Counter{tocdepth} by one:
\begin{lstcode}
\documentclass{scrartcl}
\addtocounter{tocdepth}{-1}
\end{lstcode}
How much you should add to or subtract from the \Counter{tocdepth} counter
can also be found by looking at the table of contents after the first
{\LaTeX} run.
\end{Example}
A\textnote{Hint!} small hint in order that you do not need to remember which
sectional unit has which number: in the table of contents count the number of
units required extra or less and then, as in the above example, use
\Macro{addtocounter} to add or subtract that number to or from
\Counter{tocdepth}.%
%
\EndIndex{Counter}{tocdepth}%
%
\EndIndex{}{table of contents}
\LoadCommon{6}% \section{Paragraph Markup}
\LoadCommon{7}% \section{Detection of Odd and Even Pages}
\section{Head and Foot Using Predefined Page Styles}
\label{sec:maincls.pagestyle}
\BeginIndex{}{page>style}
One of the general characteristics of a document is the page style. In
{\LaTeX} this means mostly the contents of headers and footers.
\begin{Declaration}
\KOption{headsepline}\PName{simple switch}\\
\KOption{footsepline}\PName{simple switch}
\end{Declaration}%
\BeginIndex{Option}{headsepline~=\PName{simple switch}}%
\BeginIndex{Option}{footsepline~=\PName{simple switch}}%
In\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}
order to have or not to have a rule separating the header from the text body,
use the option \Option{headsepline} with any value shown in
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. Activation
of the option will result in such a separation line. Similarly, activation of
option \Option{footsepline} switches on a rule above the foot
line. Deactivation of any of the options will deactivate the corresponding
rule.
These options have no effect with the page styles \PValue{empty} and
\PValue{plain}, because there is no header in this case. Such a line always
has the effect of visually bringing header and text body closer together. That
does not mean that the header must now be moved farther from the text
body. Instead, the header should be considered as belonging to the text body
for the purpose of page layout calculations. {\KOMAScript} takes this into
account by automatically passing the option \Option{headinclude} to the
\Package{typearea} package whenever the \Option{headsepline} option is
used. \KOMAScript{} behaves similar to \Option{footinclude} using
\Option{footsepline}. Package \Package{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage}) adds additional features to this.%
%
\EndIndex{Option}{headsepline~=\PName{simple switch}}%
\EndIndex{Option}{footsepline~=\PName{simple switch}}%
\begin{Declaration}
\Macro{pagestyle}\PParameter{page style}\\
\Macro{thispagestyle}\Parameter{local page style}
\end{Declaration}%
\BeginIndex{Cmd}{pagestyle}%
\BeginIndex{Cmd}{thispagestyle}%
Usually one distinguishes four different page styles:
\begin{description}
\item[empty\BeginIndex{Pagestyle}{empty}] is the page
style with entirely empty headers and footers. In {\KOMAScript} this is
completely identical to the standard classes.
\item[headings\BeginIndex{Pagestyle}{headings}] is the page style with running
headings in the header. These are headings for which titles are
automatically inserted into the header.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}With the classes
\Class{scrbook}\IndexClass{scrbook} and
\Class{scrreprt}\IndexClass{scrreprt} the titles of chapters and sections
are repeated in the header for double-sided layout\,---\,with {\KOMAScript}
on the outer side, with the standard classes on the inner side. The page
number is set on the outer side of the footer with {\KOMAScript}; with the
standard classes it is set on the inner side of the header. In one-sided
layouts only the titles of the chapters are used and are, with
{\KOMAScript}, centered in the header. The page numbers are set centered in
the footer with {\KOMAScript}.
\OnlyAt{\Class{scrartcl}}\Class{scrartcl}\IndexClass{scrartcl} behaves
similarly, but starting a level deeper in the section hierarchy with
sections and subsections, because the chapter level does not exist in this
case.
While the standard classes automatically set running headings always
in capitals, {\KOMAScript} applies the style of the title. This has
several typographic reasons. Capitals as a decoration are actually
far too strong. If one applies them nevertheless, they should be set
in a one point smaller type size and with tighter spacing. The
standard classes do not take these points into consideration.
Beyond this {\KOMAScript} classes support rules below the head and above the
foot using options \Option{headsepline} and \Option{footsepline} which are
described above.
\item[myheadings\BeginIndex{Pagestyle}{myheadings}] corresponds mostly to the
page style \PValue{headings}, but the running headings are not automatically
produced\,---\,they have to be defined by the user. The commands \Macro
{markboth}\IndexCmd{markboth} and \Macro{markright}\IndexCmd{markright} can
be used for that purpose (see below).
\item[plain\BeginIndex{Pagestyle}{plain}] is the page style with empty header
and only a page number in the footer. With the standard classes this page
number is always centered in the footer. With {\KOMAScript} the page number
appears on double-sided\Index {double-sided} layout on the outer side of the
footer. The one-sided page style behaves like the standard setup.
\end{description}
The page style can be set at any time with the help of the \Macro{pagestyle}
command and takes effect with the next page that is output. If\textnote{Hint!}
one uses \Macro{pagestyle} just before a command, that results in an
implicit page break and if the new page style should be used at the resulting
new page first, a \Macro{cleardoublepage} just before \Macro{pagestyle} will
be useful. But usually one sets the page style only once at the beginning of
the document or in the preamble.
To\important{\Macro{thispagestyle}} change the page style of the current page
only, one uses the \Macro{thispagestyle} command. This also happens
automatically at some places in the document. For example, the instruction
\Macro{thispagestyle}\PParameter{\Macro{chapterpagestyle}} is issued
implicitly on the first page of a chapter.
Please\textnote{Attention!} note that the change between automatic and manual
running headings is no longer performed by page style changes when using the
\Package{scrlayer-scrpage} package, but instead via special instructions. The
page styles \PValue{headings} and \PValue{myheadings} should not be used
together with this package.%
%
\EndIndex{Pagestyle}{empty}% Darueber erfahren wir nun nichts mehr
\BeginIndex[indexother]{}{font>style}%
\BeginIndex{FontElement}{pageheadfoot}%
\BeginIndex{FontElement}{pagefoot}%
\BeginIndex{FontElement}{pagenumber}%
In order to change the font style used in the header, footer, or for the page
number\ChangedAt{v2.8p}{%
\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}%
, please use the interface described in \autoref{sec:maincls.textmarkup},
\autopageref{desc:maincls.cmd.setkomafont}. The same element is used for
header and footer, which you can designate with
\FontElement{pageheadfoot}\IndexFontElement{pageheadfoot}%
\important{\FontElement{pageheadfoot}}. The element for the page number within
the header or footer is called
\FontElement{pagenumber}\IndexFontElement{pagenumber}%
\important{\FontElement{pagenumber}}. The element
\FontElement{pagefoot}\IndexFontElement{pagefoot}, that is additionally
supported by the \KOMAScript{} classes, will be used only if a page style has
been defined that has text at the foot line, using package
\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage},
\autopageref{desc:scrlayer-scrpage.fontelement.pagefoot}).
The default settings can be found in
\autoref{tab:maincls.defaultFontsHeadFoot}.%
%
\begin{table}
% \centering%
\KOMAoptions{captions=topbeside}%
\setcapindent{0pt}%
% \caption
\begin{captionbeside}
[{Default values for the elements of a page style}]
{\label{tab:maincls.defaultFontsHeadFoot}%
Default values for the elements of a page style}
[l]
\begin{tabular}[t]{ll}
\toprule
Element & Default value \\
\midrule
\FontElement{pagefoot}\IndexFontElement{pagefoot} &
\\
\FontElement{pageheadfoot}\IndexFontElement{pagefoothead} &
\Macro{normalfont}\Macro{normalcolor}\Macro{slshape} \\
\FontElement{pagenumber}\IndexFontElement{pagenumber} &
\Macro{normalfont}\Macro{normalcolor}\\
\bottomrule
\end{tabular}
\end{captionbeside}
\end{table}
%
\begin{Example}
\leavevmode\phantomsection\label{sec:maincls.pagestyle.example}%
Assume that you want to set header and footer in a smaller type size
and in italics. However, the page number should not be set in
italics but bold. Apart from the fact that the result will look
horrible, you can obtain this as follows:
\begin{lstcode}
\setkomafont{pageheadfoot}{%
\normalfont\normalcolor\itshape\small
}
\setkomafont{pagenumber}{\normalfont\bfseries}
\end{lstcode}
If you want only that, in addition to the default slanted variant, a smaller
type size is used, it is sufficient to use the following:
\begin{lstcode}
\addtokomafont{pagehead}{\small}
\end{lstcode}
As you can see, the last example uses the element
\FontElement{pagehead}\important{\FontElement{pagehead}}. You can achieve
the same result using \PValue{pageheadfoot} instead (see
\autoref{tab:maincls.elementsWithoutText} on
\autopageref{tab:maincls.elementsWithoutText}).
\end{Example}
It is not possible to use these methods to force capitals to be used
automatically for the running headings. For that, please use the
\Package{scrlayer-scrpage} package (see \autoref{cha:scrlayer-scrpage},
\autopageref{desc:scrlayer-scrpage.option.markcase}).
If you define your own page styles, the commands
\Macro{usekomafont}\PParameter{pageheadfoot}, \Macro{usekomafont}\PParameter
{pagenumber}, and \Macro{usekomafont}\PParameter{pagefoot} can be useful. If
you do not use the {\KOMAScript} package \Package{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage}) for that, but, for example, the package
\Package{fancyhdr}\IndexPackage{fancyhdr} (see \cite{package:fancyhdr}), you
can use these commands in your definitions. Thereby you can remain compatible
with {\KOMAScript} as much as possible. If you do not use these commands in
your own definitions, changes like those shown in the previous examples have
no effect. The package
\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage} takes care to keep
the maximum possible compatibility with other packages itself.
%
\EndIndex{FontElement}{pagenumber}%
\EndIndex{FontElement}{pagefoot}%
\EndIndex{FontElement}{pageheadfoot}%
\EndIndex{Pagestyle}{plain}%
\EndIndex{Cmd}{pagestyle}%
\EndIndex{Cmd}{thispagestyle}%
%
\EndIndex[indexother]{}{font>style}%
\begin{Declaration}
\Macro{markboth}\Parameter{left mark}\Parameter{right mark}\\
\Macro{markright}\Parameter{right mark}
\end{Declaration}
\BeginIndex{Cmd}{markboth}%
\BeginIndex{Cmd}{markright}%
With page style \Pagestyle{myheadings}\important{\Pagestyle{myheadings}}%
\IndexPagestyle{myheadings}, there's no automatic setting of the running head.
Instead of this one would set it with the help of commands \Macro{markboth}
and \Macro{markright}. Thereby \PName{left mark} normally will be used at the
head of even pages and \PName{right mark} at the heads of odd pages. With
one-sided printing, only the \PName{right mark} exists. Using package
\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}\important{\Package{scrlayer-scrpage}},
the additional command
\Macro{markleft}\IndexCmd{markleft}\important{\Macro{markleft}} exists.
The commands may be used with other page styles too. Combination with automatic
running head, e.\,g., with page style \Pagestyle{headings}, limits the effect
of the commands until the next automatic setting of the corresponding marks.%
%
\EndIndex{Cmd}{markright}%
\EndIndex{Cmd}{markboth}%
%
\EndIndex{Pagestyle}{myheadings}%
\EndIndex{Pagestyle}{headings}%
\begin{Declaration}
\Macro{titlepagestyle}\\
\Macro{partpagestyle}\\
\Macro{chapterpagestyle}\\
\Macro{indexpagestyle}
\end{Declaration}%
\BeginIndex{Cmd}{titlepagestyle}\Index{title>page style}%
\BeginIndex{Cmd}{partpagestyle}\Index{part>page style}%
\BeginIndex{Cmd}{chapterpagestyle}\Index{chapter>page style}%
\BeginIndex{Cmd}{indexpagestyle}\Index{index>page style}%
For some pages, a different page style is chosen with the help of the
command \Macro{thispagestyle}. Which page style this actually is, is
defined by these four macros, of which \Macro{partpagestyle} and
\Macro{chapterpagestyle}\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}
are found only with classes \Class{scrbook} and \Class{scrreprt}, but
not in \Class{scrartcl}. The default value for all four cases is
\PValue{plain}. The meaning of these macros can be taken from
\autoref{tab:specialpagestyles}.
%
\begin{table}
\centering
\caption{Macros to set up page style of special pages}
\label{tab:specialpagestyles}
\begin{desctabular}
\mentry{titlepagestyle}{Page style for a title page when using
\emph{in-page} titles.}%
\mentry{partpagestyle}{Page style for the pages with \Macro{part}
titles.}%
\mentry{chapterpagestyle}{Page style for the first page of a chapter.}%
\mentry{indexpagestyle}{Page style for the first page of the index.}%
\end{desctabular}
\end{table}
%
The page styles can be redefined with the \Macro{renewcommand} macro.
\begin{Example}
Assume that you want the pages with a \Macro{part} heading to have
no number. Then you can use the following command, for example in
the preamble of your document:
\begin{lstcode}
\renewcommand*{\partpagestyle}{empty}
\end{lstcode}
As mentioned previously on \autopageref{desc:maincls.pagestyle.empty},
the page style \PValue{empty} is exactly what is required in this
example. Naturally you can also use a user-defined page style.
Assume you have defined your own page style for initial chapter pages
with the package \Package{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage}). You have given to this page style the
fitting name \PValue{chapter}. To actually use this style, you must
redefine the macro \Macro{chapterpagestyle} accordingly:
\begin{lstcode}
\renewcommand*{\chapterpagestyle}{chapter}
\end{lstcode}
Assume that you want the table of contents\Index{table of
contents}\textnote{table of contents} of a book to have no page
numbers. However, everything after the table of contents should work again
with the page style \PValue{headings}, as well as with \PValue{plain} on
every first page of a chapter. You can use the following commands:
\begin{lstcode}
\clearpage
\pagestyle{empty}
\renewcommand*{\chapterpagestyle}{empty}
\tableofcontents
\clearpage
\pagestyle{headings}
\renewcommand*{\chapterpagestyle}{plain}
\end{lstcode}
Instead of the above you may do a local redefinition using a group. The
advantage will be that you do not need to know the current page style before
the change to switch back at the end.
\begin{lstcode}
\clearpage
\begingroup
\pagestyle{empty}
\renewcommand*{\chapterpagestyle}{empty}
\tableofcontents
\clearpage
\endgroup
\end{lstcode}
But\important{Attention!} notice that you never should put a numbered head
into a group. Otherwise you may get funny results with commands like
\Macro{label}.
\end{Example}
\begin{Explain}
Whoever thinks that it is possible to put running headings on the
first page of a chapter by using the command
\begin{lstcode}
\renewcommand*{\chapterpagestyle}{headings}
\end{lstcode}
should read more about the background of \Macro{rightmark} at
\autoref{sec:maincls-experts.addInfos},
\autopageref{desc:maincls-experts.cmd.rightmark}.
\end{Explain}
%
\EndIndex{Cmd}{titlepagestyle}%
\EndIndex{Cmd}{partpagestyle}%
\EndIndex{Cmd}{chapterpagestyle}%
\EndIndex{Cmd}{indexpagestyle}%
\begin{Declaration}
\Macro{pagenumbering}\Parameter{numbering style}
\end{Declaration}
\BeginIndex{Cmd}{pagenumbering}%
This command works the same way in {\KOMAScript} as in the standard
classes. More precisely it is a feature neither of the standard classes nor of
the \KOMAScript{} classes but of the {\LaTeX} kernel. You can specify with
this command the \PName{numbering style} of page numbers.
The changes take effect immediately, hence starting with the
page that contains the command. It is recommended to use
\Macro{cleardoubleoddpage} to close the last page and start a new odd page
before. The possible settings can be found in
\autoref{tab:numberKind}.
Using\textnote{Attention!} the command \Macro{pagenumbering} also resets the
page counter\Index{page>counter}\Index{page>number}. Thus the page number of
the next page which {\TeX} outputs will have the number 1 in the style
\PName{numbering style}.
%
\begin{table}
% \centering
\KOMAoptions{captions=topbeside}%
\setcapindent{0pt}%
% \caption
\begin{captionbeside}
{\label{tab:numberKind}%
Available numbering styles of page numbers}
\begin{tabular}[t]{lll}
\toprule
numbering style & example & description \\
\midrule
\PValue{arabic} & 8 & Arabic numbers \\
\PValue{roman} & viii & lower-case Roman numbers \\
\PValue{Roman} & VIII & upper-case Roman numbers \\
\PValue{alph} & h & letters \\
\PValue{Alph} & H & capital letters \\
\bottomrule
\end{tabular}
\end{captionbeside}
\end{table}
%
\EndIndex{Cmd}{pagenumbering}%
%
\EndIndex{}{page>style}
\LoadCommon{8}% \section{Interleaf Pages}
\LoadCommon{9}% \section{Footnotes}
\section[Demarcation]{Demarcation\protect\OnlyAt{\Class{scrbook}}}
\label{sec:maincls.separation}
\BeginIndex{}{front matter}%
\BeginIndex{}{main matter}%
\BeginIndex{}{back matter}%
\BeginIndex{}{matter>front}%
\BeginIndex{}{matter>main}%
\BeginIndex{}{matter>back}%
Sometimes books are roughly separated into front matter, main matter, and
back matter. \KOMAScript{} provides this for \Class{scrbook} also.
\begin{Declaration}
\Macro{frontmatter}\\
\Macro{mainmatter}\\
\Macro{backmatter}
\end{Declaration}%
\BeginIndex{Cmd}{frontmatter}%
\BeginIndex{Cmd}{mainmatter}%
\BeginIndex{Cmd}{backmatter}%
The macro \Macro{frontmatter}\important{\Macro{frontmatter}} introduces the
front matter in which roman numerals are used for the page numbers. Chapter
headings in a front matter are not numbered. The section titles which would be
numbered start at chapter 0, and would be consecutively numbered across
chapter boundaries. However, this is of no import, as the front matter is used
only for the title pages, table of contents\Index{table of contents}, lists of
figures\Index{list of>figures}\Index{figures>list of} and
tables\Index{tables>list of}, and a foreword\Index{foreword}. The foreword can
thus be set as a normal chapter. A foreword should never be divided into
sections but kept as short as possible. Therefore, in the foreword there is no
need for a deeper structuring than the chapter level.
In case the user sees things differently and wishes to use numbered
sections\Index{section>number} in the chapters of the front matter, as of
version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}}%
\important{\OptionValue{version}{2.97e}} the section numbering no longer
contains the chapter number. This change only takes effect when the
compatibility option is set to at least version~2.97e (see option
\Option{version}, \autoref{sec:maincls.compatibilityOptions},
\autopageref{desc:maincls.option.version}). It is explicity noted that this
creates a confusion with chapter numbers! The use of \Macro{addsec} and
\Macro{section*} (see \autoref{sec:maincls.structure},
\autopageref{desc:maincls.cmd.section*} and
\autopageref{desc:maincls.cmd.addsec}) are thus, in the author's opinion, far
more preferable.
As of version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}} the numbering
of float environments, such as tables\Index{table>number} and
figures\Index{figure>number}, and equation
numbers\Index{equation>number} in the front matter also contain no
chapter number part. To take effect this too requires the
corresponding compatibility setting (see option \Option{version},
\autoref{sec:maincls.compatibilityOptions},
\autopageref{desc:maincls.option.version}).
\Macro{mainmatter}\important{\Macro{mainmatter}} introduces the main matter
with the main text. If there is no front matter, then this command can be
omitted. The default page numbering in the main matter uses Arabic numerals
(re)starting in the main matter at 1.
The back matter is introduced with
\Macro{backmatter}\important{\Macro{backmatter}}. Opinions differ in what
should be part of the back matter. So in some cases you will find only the
bibliography\Index{bibliography}, in some cases only the index\Index{index},
and in other cases both of these as well as the appendices. The chapters in
the back matter are similar to the chapters in the front matter, but page
numbering is not reset. If you do require separate page numbering you may use
the command \Macro{pagenumbering} from \autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.cmd.pagenumbering}.
%
\EndIndex{Cmd}{frontmatter}%
\EndIndex{Cmd}{mainmatter}%
\EndIndex{Cmd}{backmatter}%
%
\EndIndex{}{front matter}%
\EndIndex{}{main matter}%
\EndIndex{}{back matter}%
\EndIndex{}{matter>front}%
\EndIndex{}{matter>main}%
\EndIndex{}{matter>back}%
\section{Structuring of Documents}
\label{sec:maincls.structure}
Structuring of documents means to divide them into parts, chapters, sections,
and several other structural elements.
\begin{Declaration}
\KOption{open}\PName{method}
\end{Declaration}%
\BeginIndex{Option}{open~=\PName{method}}%
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}%
\KOMAScript{} classes \Class{scrbook} and \Class{scrreprt} give you
the choice of where to start\Index{chapter>start} a new chapter with
double-sided printing. By default \Class{scrreprt} starts a new
chapter at the next page. This is like \PName{method}
\PValue{any}. However, \Class{scrbook} starts new chapters at the next
right-hand page. This is like \PName{method} \PValue{right} and is
usually used in books. But sometimes chapters should start at the
left-hand page of a double-page spread. This would be accomplished
with \PName{method} \PValue{left}\ChangedAt{v3.00}{\Class{scrbook}\and
\Class{scrreprt}}. An overview of the supported methods may be found
at \autoref{tab:maincls.open}.
\begin{table}
\caption[{Available values for option \Option{open}}]{Available values for
option \Option{open} to select page breaks with interleaf pages}
\begin{desctabular}
\pventry{any}{Commands
\Macro{cleardoublepageusingstyle},
\Macro{cleardoublestandardpage},
\Macro{cleardoubleplainpage},
\Macro{cleardoubleemptypage},
and
\Macro{cleardoublepage}
result in a single page break and therefor are same like
\Macro{clearpage}.%
\IndexOption{open~=\PValue{any}}}%
\pventry{left}{Commands
\Macro{cleardoublepageusingstyle},
\Macro{cleardoublestandardpage},
\Macro{cleardoubleplainpage},
\Macro{cleardoubleemptypage},
and
\Macro{cleardoublepage}
result in a page break and add an interleaf page\Index{page>interleaf}
if needed to reach the next left-hand page.%
\IndexOption{open~=\PValue{left}}}%
\pventry{right}{Commands
\Macro{cleardoublepageusingstyle},
\Macro{cleardoublestandardpage},
\Macro{cleardoubleplainpage},
\Macro{cleardoubleemptypage},
and
\Macro{cleardoublepage}
result in a page break and add an interleaf page\Index{page>interleaf}
if needed to reach the next right-hand page.%
\IndexOption{open~=\PValue{right}}}%
\end{desctabular}
\label{tab:maincls.open}
\end{table}
Besides the implicit usage of \Macro{cleardoublepage} at chapter
starts, the option influences also the explicit usage of the commands
\Macro{cleardoublepage}, \Macro{cleardoublepageusingstyle},
\Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, and
\Macro{cleardoubleemptypage}. See \autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.cmd.cleardoublepage} for more information
about these. Since \LaTeX{} does not differentiate between left-hand
and right-hand pages in single-sided printing, the option does not have
any influence in that case.
In class \Class{scrartcl} the section is the first structural element below
the part. Because of this, \Class{scrartcl} does not support this option.
%
\EndIndex{Option}{open~=\PName{method}}%
\begin{Declaration}
\KOption{chapterprefix}\PName{simple switch}\\
\KOption{appendixprefix}\PName{simple switch}
\end{Declaration}%
\BeginIndex{Option}{chapterprefix~=\PName{simple switch}}%
\BeginIndex{Option}{appendixprefix~=\PName{simple switch}}%
With\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} the standard classes
\Class{book} and \Class{report}, a chapter
title\Index[indexmain]{chapter>title} consists of a line with the word
``Chapter''\footnote{When using another language the word ``Chapter''
is naturally translated to the appropriate language.} followed by
the chapter number. The title itself is set left-justified on the
following lines. The same effect is obtained in {\KOMAScript} with the
option \Option{chapterprefix}. Any value from table
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch} may
be used as \PName{simple switch}. The default, however, is
\OptionValue{chapterprefix}{false}, which is opposite of the behaviour
of the standard classes, which would correspond to
\OptionValue{chapterprefix}{true}.
These options also affect the automatic
running titles in the headers (see \autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.pagestyle.headings}).
Sometimes one wishes to have the
chapter titles in simplified form according to
\OptionValue{chapterprefix}{false}. But at the same time, one wishes a title
of an appendix\Index{appendix} to be preceded by a line with ``Appendix''
followed by the appendix letter. This is achieved by using the
\Option{appendixprefix} option (see \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}). Since this results in an inconsistent
document layout, I advise against using this option.
The font style of the chapter number line using
\OptionValue{chapterprefix}{true} or \OptionValue{appendixprefix}{true} may be
changed with element
\FontElement{chapterprefix}\IndexFontElement{chapterprefix}%
\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}} using commands
\Macro{setkomafont} and \Macro{addtokomafont} (see
\autoref{sec:maincls.textmarkup},
\autopageref{desc:maincls.cmd.setkomafont}). Default is the usage of element
\FontElement{chapter}\IndexFontElement{chapter} (see
\autopageref{desc:maincls.cmd.chapter}, as well as
\autoref{tab:maincls.structureElementsFont},
\autopageref{tab:maincls.structureElementsFont}).%
%
\EndIndex{Option}{appendixprefix~=\PName{simple switch}}%
\EndIndex{Option}{chapterprefix~=\PName{simple switch}}%
\begin{Declaration}
\KOption{headings}\PName{selection}
\end{Declaration}%
\BeginIndex{Option}{headings~=\PName{selection}}%
The font size used for the titles\index{title}\index{document structure} is
relatively big, both with the standard classes and with {\KOMAScript}. Not
everyone likes this choice; moreover it is especially problematic for small
paper sizes. Consequently, {\KOMAScript} provides, besides the large title
font size defined by the
\OptionValue{headings}{big}\IndexOption{headings~=\PValue{big}}%
\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}%
\important[i]{\OptionValue{headings}{big}\\
\OptionValue{headings}{normal}\\
\OptionValue{headings}{small}} option, the two options
\OptionValue{headings}{normal}\IndexOption{headings~=\PValue{normal}} and
\OptionValue{headings}{small}\IndexOption{headings~=\PValue{small}}, that
allow for smaller title font sizes. The font sizes for headings resulting from
these options for \Class{scrbook} and \Class{scrreprt} are shown in
\autoref{tab:maincls.structureElementsFont},
\autopageref{tab:maincls.structureElementsFont}. For \Class{scrartcl}, smaller
font sizes are generally used. \OnlyAt{\Class{scrbook}\and
\Class{scrreprt}}The spacing before and after chapter titles is also
influenced by these options.
Chapter\important[i]{\begin{tabular}[t]{@{}l@{}}
\Option{headings=}\\ \quad\PValue{twolinechapter}\end{tabular}\\
\begin{tabular}[t]{@{}l@{}}
\Option{headings=}\\ \quad\PValue{onelinechapter}\end{tabular}\\
\begin{tabular}[t]{@{}l@{}}
\Option{headings=}\\ \quad\PValue{twolineappendix}\end{tabular}}
titles are also influenced by the options
\OptionValue{headings}{twolinechapter} and
\OptionValue{headings}{onelinechapter}, that are same as \OptionValue{chapterprefix}{true} and
\OptionValue{chapterprefix}{false} (see above). The appendix titles are
influenced by \OptionValue{headings}{twolineappendix} and
\OptionValue{headings}{onelineappendix}\important[i]{%
\begin{tabular}[b]{@{}l@{}}
\Option{headings=}\\ \quad\PValue{onelineappendix}
\end{tabular}}, that are the same as the options
\OptionValue{appendixprefix}{true} and \OptionValue{appendixprefix}{false}
(see also above).
The\OnlyAt{\Class{scrbook}\and \Class{scrreprt}} method of beginning new
chapters may be switched by \OptionValue{headings}{openany}\important[i]{%
\OptionValue{headings}{openany}\\
\OptionValue{headings}{openright}\\
\OptionValue{headings}{openleft}}, \OptionValue{headings}{openright}, and
\OptionValue{headings}{openleft} alternatively to option \Option{open} with
the values \PValue{any},
\PValue{right}, and \PValue{left} (see above).
Another\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} special feature of \KOMAScript{} is the handling of the
optional argument of the structural commands \Macro{part}, \Macro{chapter},
etc., down to \Macro{subparagraph}. Function and meaning\important[i]{\begin{tabular}[t]{@{}l@{}}
\Option{headings=}\\\quad\PValue{optiontohead}\end{tabular}\\
\OptionValue{headings}{optiontotoc}\\
\begin{tabular}[t]{@{}l@{}}
\Option{headings=}\\\quad\PValue{optiontoheadandtoc}\end{tabular}} may be
influenced by the options \OptionValue{headings}{optiontohead}%
\IndexOption{headings~=\PValue{optiontohead}},
\OptionValue{headings}{optiontotoc}\IndexOption{headings~=\PValue{optiontotoc}},
and \OptionValue{headings}{optiontoheadandtoc}%
\IndexOption{headings~=\PValue{optiontoheadandtoc}}.
A summary of all the available selections of option \Option{headings} may be found in \autoref{tab:maincls.headings}. Examples are at the following
description of the structural commands.
\begin{desclist}
\renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
\desccaption[{Available values for option \Option{headings}}]{%
Available values for option \Option{headings} to select different kinds of
structural headings%
\label{tab:maincls.headings}%
}{%
Available values for option \Option{headings} (\emph{continuation})%
}%
\pventry{big}{%
Use very large headings with large distances above and below.
\IndexOption{headings~=\PValue{big}}}%
\pventry{normal}{%
Use mid-size headings with medium distances above and below.
\IndexOption{headings~=\PValue{normal}}}%
\entry{\PValue{onelineappendix}, \PValue{noappendixprefix},
\PValue{appendixwithoutprefix}, \PValue{appendixwithoutprefixline}%
\IndexOption{headings~=\PValue{onelineappendix}}}{%
Chapter headings at the appendix will be set like other headings too.%
}%
\entry{\PValue{onelinechapter}, \PValue{nochapterprefix},
\PValue{chapterwithoutprefix}, \PValue{chapterwithoutprefixline}%
\IndexOption{headings~=\PValue{onelinechapter}}}{%
Chapter headings will be set like other headings too.%
}%
\pventry{openany}{%
Parts, chapter, index, and back matter use \Macro{clearpage} instead of
\Macro{cleardoublepage}.%
\IndexOption{headings~=\PValue{openany}}}%
\pventry{openleft}{%
The commands \Macro{cleardoublepageusingstyle},
\Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage},
\Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} generate a page
break and if needed insert an interleaf page to reach the next left-hand
page at double-page printing. Part, chapter, index and back matter use
\Macro{cleardoublepage}.%
\IndexOption{headings~=\PValue{openleft}}}%
\pventry{openright}{%
The commands \Macro{cleardoublepageusingstyle},
\Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage},
\Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} generate a page
break and if needed insert an interleaf page to reach the next right-hand
page at double-page printing. Part, chapter, index and back matter use
\Macro{cleardoublepage}.%
\IndexOption{headings~=\PValue{openright}}}%
\pventry{optiontohead}{%
The\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} advanced functionality of the optional argument of the
structural commands \Macro{part} down to \Macro{subparagraph} will be
activated. By default the optional argument will be used for the running
head only.%
\IndexOption{headings~=\PValue{optiontohead}}%
}%
\entry{\PValue{optiontoheadandtoc}, \PValue{optiontotocandhead}%
\IndexOption{headings~=\PValue{optiontoheadandtoc}}}{%
The\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} advanced functionality of the optional argument of the
structural commands \Macro{part} down to \Macro{subparagraph} will be
activated. By default the optional argument will be used for the running
head and the table of contents.%
}%
\pventry{optiontotoc}{%
The\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} advanced functionality of the optional argument of the
structural commands \Macro{part} down to \Macro{subparagraph} will be
activated. By default the optional argument will be used for the table of
contents only.%
\IndexOption{headings~=\PValue{optiontohead}}%
}%
\pventry{small}{%
Use small headings with small distances above and below.%
\IndexOption{headings~=\PValue{small}}}%
\entry{\PValue{twolineappendix}, \PValue{appendixprefix},
\PValue{appendixwithprefix}, \PValue{appendixwithprefixline}%
\IndexOption{headings~=\PValue{twolineappendix}}}{%
Chapters at the appendix will be set with a number line with the contents
of \Macro{chapterformat}\IndexCmd{chapterformat}.%
}%
\entry{\PValue{twolinechapter}, \PValue{chapterprefix},
\PValue{chapterwithprefix}, \PValue{chapterwithprefixline}%
\IndexOption{headings~=\PValue{twolinechapter}}}{%
Chapters will be set with a number line with the contents
of \Macro{chapterformat}\IndexCmd{chapterformat}.%
}%
\end{desclist}
%
\EndIndex{Option}{headings~=\PName{selection}}%
\begin{Declaration}
\KOption{numbers}{selection}
\end{Declaration}%
\BeginIndex{Option}{numbers~=\PName{selection}}%
\begin{Explain}%
In German, according to {\small DUDEN}, the numbering of sectional
units should have no period at the end if only arabic numbers are used
(see \cite[R\,3]{DUDEN}). On the other hand, if roman numerals or
letters are appear in the numbering, then a period should appear at the
end of the numbering (see \cite[R\,4]{DUDEN}). {\KOMAScript} has an
internal mechanism that tries to implement this somewhat complex
rule. The resulting effect is that, normally, after the sectional
commands \Macro{part} and \Macro{appendix} a switch is made to
numbering with an ending period. The information is saved in the
\File{aux} file and takes effect on the next {\LaTeX} run.
\end{Explain}
In some cases the mechanism for placing or leaving off the ending period may
fail, or other languagues may have different
rules. Therefore\important[i]{\OptionValue{numbers}{endperiod}\\
\OptionValue{numbers}{noendperiod}} it is possible to activate the use of
the ending period manually with the option
\OptionValue{numbers}{endperiod}\IndexOption{numbers~=\PValue{endperiod}} or
to deactivate it with
\OptionValue{numbers}{noendperiod}\IndexOption{numbers~=\PValue{noendperiod}}.
Default is \OptionValue{numbers}{autoendperiod}%
\IndexOption{numbers~=\PValue{autoendperiod}} with auto detection whether to
set the period or not.
Please\textnote{Attention!} note that the mechanism only takes effect on the
next {\LaTeX} run. Therefore, before trying to use these options to forcibly
control the numbering format, a further run without changing any options
should be made.
The\textnote{Attention!} available values are summarized in
\autoref{tab:maincls.numbers}. Unlike most other selections, this
option may be changed at the document preamble, before
\Macro{begin}\PParameter{document}, only.
\begin{table}
\caption[{Available values of option \Option{numbers}}]{Available values of
option \Option{numbers} for selection of the period at the end of numbers
of structural headings}
\label{tab:maincls.numbers}
\begin{desctabular}
\entry{\PValue{autoendperiod}, \PValue{autoenddot}, \PValue{auto}}{%
\KOMAScript{} decides, whether or not to set the period at the end of
the numbers. The numbers consists in Arabic digits only, the period will
be omitted. If there are alphabetic characters or roman numbers the
period will always be set. References to numbers will be set without
ending period always.%
\IndexOption{numbers~=\PValue{autoendperiod}}}%
\entry{\PValue{endperiod}, \PValue{withendperiod}, \PValue{periodatend},
\PValue{enddot}, \PValue{withenddot}, \PValue{dotatend}}{%
All numbers of structural commands and all dependent numbers will be set
with ending period. Only references will be set without the ending
period.%
\IndexOption{numbers~=\PValue{endperiod}}}%
\entry{\PValue{noendperiod}, \PValue{noperiodatend},
\PValue{noenddot}, \PValue{nodotatend}}{%
All the numbers are without ending period.%
\IndexOption{numbers~=\PValue{noendperiod}}}%
\end{desctabular}
\end{table}
%
\EndIndex{Option}{numbers~=\PName{selection}}%
\begin{Declaration}
\Option{chapteratlists}\\
\XOption{chapteratlists}=\PName{value}
\end{Declaration}%
\BeginIndex{Option}{chapteratlists}%
\BeginIndex{Option}{chapteratlists~=\PName{value}}%
As mentioned in \autoref{sec:maincls.floats},
\autopageref{desc:maincls.option.listof}\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}}, normally, every chapter entry generated with
\Macro{chapter} introduces vertical spacing into the lists of floats. Since
version~2.96a\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}} this
applies also for the command \Macro{addchap}, if no compatibility option to an
earlier version was chosen (see option \Option{version} in
\autoref{sec:maincls.compatibilityOptions},
\autopageref{desc:maincls.option.version}).
Furthermore, now the option \Option{chapteratlists} can be used to change the
spacing, by passing the desired distance as \PName{value}. The default setting
with \OptionValue{listof}{chaptergapsmall}%
\IndexOption{listof~=\PValue{chaptergapsmall}} %
is 10\,pt. If \OptionValue{chapteratlists}{entry}%
\IndexOption{chapteratlists~=\PValue{entry}}%
\important{\OptionValue{chapteratlists}{entry}} or \Option{chapteratlists}
without value is specified, then instead of a vertical distance, the chapter
entry itself will be entered into the lists. This will be done even if
there's no floating environment inside of the chapter.
Please\textnote{Attention!} note that changes to the option will only become
effective in the lists following two more {\LaTeX} runs.%
%
\EndIndex{Option}{chapteratlists~=\PName{value}}%
\EndIndex{Option}{chapteratlists}%
\begin{Declaration}
\Macro{part}\OParameter{short version}\Parameter{heading}\\
\Macro{chapter}\OParameter{short version}\Parameter{heading}\\
\Macro{section}\OParameter{short version}\Parameter{heading}\\
\Macro{subsection}\OParameter{short version}\Parameter{heading}\\
\Macro{subsubsection}\OParameter{short version}\Parameter{heading}\\
\Macro{paragraph}\OParameter{short version}\Parameter{heading}\\
\Macro{subparagraph}\OParameter{short version}\Parameter{heading}
\end{Declaration}%
\BeginIndex{Cmd}{part}\Index[indexmain]{part}%
\BeginIndex{Cmd}{chapter}\Index[indexmain]{chapter}%
\BeginIndex{Cmd}{section}\Index[indexmain]{section}%
\BeginIndex{Cmd}{subsection}%
\BeginIndex{Cmd}{subsubsection}%
\BeginIndex{Cmd}{paragraph}%
\BeginIndex{Cmd}{subparagraph}%
The standard sectioning commands in {\KOMAScript} work in a similar
fashion to those of the standard classes. Thus, an alternative entry
for the table of contents and running headings can be specified as an
optional argument to the sectioning commands.
In addition to this, with\ChangedAt{v3.10}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}}\textnote{\KOMAScript{} vs. standard
classes} option \important{\Option{headings}}
\OptionValue{headings}{optiontohead}%
\IndexOption[indexmain]{headings~=\PValue{optiontohead}}, \KOMAScript{}
does not use
the optional argument \PName{short version} at the table of
contents, but for the running head only. Nevertheless, such a running head
needs an appropriate page style. See \autoref{sec:maincls.pagestyle} and
\autoref{cha:scrlayer-scrpage} about this. With option
\OptionValue{headings}{optiontotoc}%
\IndexOption[indexmain]{headings~=\PValue{optiontotoc}}, \KOMAScript{} does not
use the
optional argument \PName{short version} for the running head, but
at the table of contents. Nevertheless, the entry will be shown only if
counter \Counter{tocdepth} (see \autoref{sec:maincls.toc},
\autopageref{desc:maincls.counter.tocdepth}) is great enough. With option
\OptionValue{headings}{optiontoheadandtoc}%
\IndexOption[indexmain]{headings~=\PValue{optiontoheadandtoc}}, \KOMAScript{}
uses the optional argument \PName{short version} in both the table of contents
and running head. All these three selections will also activate the extended
interpretation of the optional argument \PName{short version}, which is not
active by default.
The \ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} extended interpretation of the optional argument
determines whether there's an equality sign in
\PName{short version}. If so, the optional argument will be interpreted as
\PName{option list} instead of simple \PName{short version}. Thereby the two
options \KOption{head}\PName{running head}\important{\Option{head}} and
\KOption{tocentry}\PName{table of contents entry} are supported. Commas or
equality signs inside of the values of those options will be accepted only if
they are enclosed by braces.
Please\textnote{Attention!} note that this mechanism is only
functional as long as \KOMAScript{} controls the described
commands. From using a package that controls the sectioning commands
or the internal \LaTeX{} kernel commands for sectioning commands,
\KOMAScript{} can no longer provide this extended mechanism. This is
also valid for the always active extension of \KOMAScript{} to not
create entries to the table of contents % if the heading text
if the text of the
entry is empty. If you really want an entry with empty heading text,
you may use an invisible entry like \lstinline|\mbox{}| instead.
\begin{Example}
Assume you're writing a document with some very extensive chapter
headings. These headings should be shown in the table of contents too. But
for the running head you want only single-line short headings. You will do
this using the optional argument of \Macro{chapter}.
\begin{lstcode}
\chapter[short version of chapter heading]
{The Structural Sectioning Command
for Chapters Supports not only the
Heading Text itself but also a
Short Version with Selectable
Usage}
\end{lstcode}
Sometimes later you become aware that the automatic line breaking of this
heading is somehow inappropriate. Therefore you want to make the breaking
yourself. Nevertheless, the automatic line breaking should be still used at
the table of contents. With
\begin{lstcode}
\chapter[head={short version of chapter heading},
tocentry={The Structural Sectioning
Command for Chapters Supports not
only the Heading Text itself but
also a Short Version with
Selectable Usage}]
{The Structural\\
Sectioning Command for Chapters\\
Supports not only\\
the Heading Text itself\\
but also\\
a Short Version\\
with Selectable Usage}
\end{lstcode}
you use independent entries for table of contents, running head, and the
chapter heading itself. The arguments of the options \Option{head} and
\Option{tocentry} have been enclosed into braces, so the contents of the
options cannot influence the interpretation of the optional argument.
The recommendation of the braces in the example above will make more sense
with one more example. Assume you're using option
\OptionValue{headings}{optiontotoc} and now have a heading:
\begin{lstcode}
\section[head=\emph{value}]
{Option head=\emph{value}}
\end{lstcode}
This would result in the entry ``Option head=\emph{value}'' at the table of
contents but ``\emph{value}'' at the running head. But surely you wanted the
entry ``head=\emph{value}'' at the table of contents and the complete
heading text at the running head. You may do this using braces:
\begin{lstcode}
\section[head{=}\emph{value}]
{Option head=\emph{value}}
\end{lstcode}
A similar case would be a comma. With the same \Option{headings} option like
before:
\begin{lstcode}
\section[head=0, 1, 2, 3, \dots]
{Natural Numbers Including the Zero}
\end{lstcode}
would result in an error, because the comma would be interpreted as the
separator between the single options of the option list %
``\lstinline|0, 1, 2, 3, \dots|''. But writing
\begin{lstcode}
\section[head={0, 1, 2, 3, \dots}]
{Natural Numbers Including the Zero}
\end{lstcode}
will change ``\lstinline|0, 1, 2, 3, \dots|'' into the argument of
option \Option{head}.
\end{Example}
The title of the level part\important{\Macro{part}} (\Macro{part}) is
distinguished from other sectioning levels by being numbered independently
from the other parts. This means that the chapter level (in \Class{scrbook} or
\Class{scrreprt}), or the section level (in \Class{scrartcl}) is numbered
consecutively over all parts. Furthermore, for classes
\Class{scrbook}\OnlyAt{\Class{scrbook}\and \Class{scrreprt}} and
\Class{scrreprt}, the title of the part level together with the corresponding
preamble (see \Macro{setpartpreamble},
\autopageref{desc:maincls.cmd.setpartpreamble}) is set on a separate page.
\Macro{chapter}\important{\Macro{chapter}}\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}} only exists in book or report classes, that is, in classes
\Class{book}, \Class{scrbook}, \Class{report} and \Class{scrreport}, but not
in the article classes \Class{article} and \Class{scrartcl}. In addition to
this, the command \Macro{chapter} in {\KOMAScript} differs substantially from
the version in the standard class. In the standard classes the chapter number
is used together with the prefix ``Chapter'', or the corresponding word in the
appropriate language, on a separate line above the actual chapter title
text. This overpowering\important[i]{\Option{chapterprefix}\\
\Option{appendixprefix}} style is replaced in {\KOMAScript} by a simple
chapter number before the chapter heading text, but can be reverted by the
option \Option{chapterprefix} (see
\autopageref{desc:maincls.option.chapterprefix}).
Please\textnote{Attention!} note that \Macro{part} and \Macro{chapter} in
classes \Class{scrbook} and \Class{scrreprt}
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} change the page style for one
page. The applied page style in {\KOMAScript} is defined in the macros
\Macro{partpagestyle} and \Macro{chapterpagestyle} (see
\autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.cmd.titlepagestyle}).
\BeginIndex[indexother]{}{font}%
\BeginIndex[indexother]{}{font>style}%
\BeginIndex[indexother]{}{font>size}%
The font of all headings\ChangedAt{v2.8p}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} can be changed with the commands
\Macro{setkomafont}\IndexCmd{setkomafont} and
\Macro{addtokomafont}\IndexCmd{addtokomafont} (see
\autoref{sec:maincls.textmarkup},
\autopageref{desc:maincls.cmd.setkomafont}). In doing this, generally the
element \FontElement{disposition}\IndexFontElement{disposition}%
\important{\FontElement{disposition}} is used, followed by a specific
element\important[s]{%
\FontElement{part}\\
\FontElement{chapter}\\
\FontElement{section}\\
\FontElement{subsection}\\
\FontElement{paragraph}\\
\FontElement{subparagraph}} for every section level (see
\autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}). The font for the element
\FontElement{disposition}\IndexFontElement{disposition} is predefined as
\Macro{normalcolor}\linebreak[2]\Macro{sffamily}\linebreak[2]\Macro{bfseries}.
The default font size for the specific elements depends on the options
\OptionValue{headings}{big}, \OptionValue{headings}{normal} and
\OptionValue{headings}{small} (see
\autopageref{desc:maincls.option.headings}). The defaults are listed in
\autoref{tab:maincls.structureElementsFont}.
%
\begin{table}
% \centering%
\KOMAoptions{captions=topbeside}%
\setcapindent{0pt}%
% \caption
\begin{captionbeside}[{Default font sizes for different levels of document
structuring}]{Default font sizes for different levels of document
structuring in \Class{scrbook} and \Class{scrreprt}}[l]
\begin{tabular}[t]{lll}
\toprule
class option & element & default\\
\midrule
\OptionValue{headings}{big}
& \FontElement{part}\IndexFontElement{part}
& \Macro{Huge} \\
& \FontElement{partnumber}\IndexFontElement{partnumber}
& \Macro{huge} \\
& \FontElement{chapter}\IndexFontElement{chapter}
& \Macro{huge} \\
& \FontElement{section}\IndexFontElement{section}
& \Macro{Large} \\
& \FontElement{subsection}\IndexFontElement{subsection}
& \Macro{large} \\
& \FontElement{subsubsection}%
\IndexFontElement{subsubsection}
& \Macro{normalsize} \\
& \FontElement{paragraph}\IndexFontElement{paragraph}
& \Macro{normalsize} \\
& \FontElement{subparagraph}\IndexFontElement{subparagraph}
& \Macro{normalsize} \\[1ex]
\OptionValue{headings}{normal}
& \FontElement{part} & \Macro{huge} \\
& \FontElement{partnumber} & \Macro{huge} \\
& \FontElement{chapter} & \Macro{LARGE} \\
& \FontElement{section} & \Macro{Large} \\
& \FontElement{subsection} & \Macro{large} \\
& \FontElement{subsubsection} & \Macro{normalsize} \\
& \FontElement{paragraph} & \Macro{normalsize} \\
& \FontElement{subparagraph} & \Macro{normalsize} \\[1ex]
\OptionValue{headings}{small}
& \FontElement{part} & \Macro{LARGE} \\
& \FontElement{partnumber} & \Macro{LARGE} \\
& \FontElement{chapter} & \Macro{Large} \\
& \FontElement{section} & \Macro{large} \\
& \FontElement{subsection} & \Macro{normalsize} \\
& \FontElement{subsubsection} & \Macro{normalsize} \\
& \FontElement{paragraph} & \Macro{normalsize} \\
& \FontElement{subparagraph} & \Macro{normalsize}\\
\bottomrule
\end{tabular}
\end{captionbeside}
\label{tab:maincls.structureElementsFont}
\end{table}
\begin{Example}
Suppose you are using the class option \OptionValue{headings}{big} and
notice that the very big headings of document parts are too
bold. You could change this as follows:
\begin{lstcode}
\setkomafont{disposition}{\normalcolor\sffamily}
\part{Appendices}
\addtokomafont{disposition}{\bfseries}
\end{lstcode}
Using the command above you only switch off the font attribute
\textbf{bold} for a heading ``Appendices''. A much more comfortable
and elegant solution is to change all \Macro{part} headings at once.
This is done either by:
\begin{lstcode}
\addtokomafont{part}{\normalfont\sffamily}
\addtokomafont{partnumber}{\normalfont\sffamily}
\end{lstcode}
or simply using:
\begin{lstcode}
\addtokomafont{part}{\mdseries}
\addtokomafont{partnumber}{\mdseries}
\end{lstcode}
The last version is to be preferred because it gives you the correct
result even when you make changes to the \FontElement{disposition}
element\IndexFontElement{disposition}, for instance:
\begin{lstcode}
\setkomafont{disposition}{\normalcolor\bfseries}
\end{lstcode}
With this change it is possible to set all section levels at once to no
longer use sans serif fonts.
\end{Example}
Please be warned of misusing the possibilities of font switching to
mix fonts, font sizes and font attributes excessively. Picking the
most suitable font for a given task is a hard task even for
professionals and has almost nothing to do with the personal tastes of
non-experts. Please refer to the citation at the end of
\autoref{sec:typearea.tips}, \autopageref{sec:typearea.tips.cite} and
to the following explanation.
\begin{Explain}
It is possible to use different font types for different section
levels in {\KOMAScript}. Non-experts in typography should for very
good typographical reasons refrain absolutely from using these
possibilities.
There is a rule in typography which states that one should mix as
few fonts as possible. Using sans serif for headings already seems
to be a breach of this rule. However, one should know that bold,
large serif letters are much too heavy for headings. Strictly
speaking, one would then have to at least use a normal instead of a
bold or semi-bold font. However, in deeper levels of the structuring,
a normal font may then appear too lightly weighted. On the other
hand, sans serif fonts in headings have a very pleasant appearance
and in fact find acceptance almost solely for headings. That is why
sans serif is the carefully chosen default in {\KOMAScript}.
More variety should, however, be avoided. Font mixing is only for
professionals. In case you want to use other fonts than the standard
{\TeX} fonts\,---\,regardless of whether these are CM\Index{CM
fonts}, EC\Index{EC fonts}, or LM fonts\Index{LM fonts}\,---\,you
should consult an expert, or for safety's sake redefine the font for
the element \FontElement{disposition}\IndexFontElement{disposition}
as seen in the example above. The author of this documentation
considers the commonly encountered combinations Times and Helvetica
or Palatino with Helvetica as unfavourable.
\end{Explain}
\EndIndex[indexother]{}{font>style}%
\EndIndex[indexother]{}{font}%
\EndIndex[indexother]{}{font>size}%
%
\EndIndex{Cmd}{part}%
\EndIndex{Cmd}{chapter}%
\EndIndex{Cmd}{section}%
\EndIndex{Cmd}{subsection}%
\EndIndex{Cmd}{subsubsection}%
\EndIndex{Cmd}{paragraph}%
\EndIndex{Cmd}{subparagraph}%
\begin{Declaration}
\Macro{part*}\Parameter{Heading}\\
\Macro{chapter*}\Parameter{Heading}\\
\Macro{section*}\Parameter{Heading}\\
\Macro{subsection*}\Parameter{Heading}\\
\Macro{subsubsection*}\Parameter{Heading}\\
\Macro{paragraph*}\Parameter{Heading}\\
\Macro{subparagraph*}\Parameter{Heading}
\end{Declaration}%
\BeginIndex{Cmd}{part*}%
\BeginIndex{Cmd}{chapter*}%
\BeginIndex{Cmd}{section*}%
\BeginIndex{Cmd}{subsection*}%
\BeginIndex{Cmd}{subsubsection*}%
\BeginIndex{Cmd}{paragraph*}%
\BeginIndex{Cmd}{subparagraph*}%
All disposition commands have starred versions, which are
unnumbered\Index{numbering}, and produce section headings which do not
show up in the table of contents\Index{table>of contents}\Index{contents>table
of} or in the
running heading\Index{header}. The absence of a running heading often
has an unwanted side effect. For example, if a chapter which is set
using \Macro{chapter*} spans several pages, then the running heading
of the previous chapter suddenly reappears. {\KOMAScript} offers a
solution for this which is described
below. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}\Macro{chapter*}
only exists in book and report classes, that is, \Class{book},
\Class{scrbook}, \Class{report} and \Class{scrreport}, but not the
article classes \Class{article} and \Class{scrartcl}.
Please\textnote{Attention!} note that \Macro{part} and \Macro{chapter} change
the page style for one page. The applied style is defined in the macros
\Macro{partpagestyle} and \Macro{chapterpagestyle} in {\KOMAScript} (see
\autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.cmd.titlepagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
the same explanations apply as were given above for the unstarred
variants. The structuring elements are named the same since they do
not indicate variants but structuring levels.%
%
\EndIndex{Cmd}{part*}%
\EndIndex{Cmd}{chapter*}%
\EndIndex{Cmd}{section*}%
\EndIndex{Cmd}{subsection*}%
\EndIndex{Cmd}{subsubsection*}%
\EndIndex{Cmd}{paragraph*}%
\EndIndex{Cmd}{subparagraph*}%
\iftrue% Umbruchkorrekturtext
In the standard classes\textnote{\KOMAScript{} vs. standard classes} there are
no further structuring commands. In particular, there are no commands which
can produce unnumbered chapters or sections which show up in the table of
contents and in the running heading.%
\fi
\begin{Declaration}
\Macro{addpart}\OParameter{Short version}\Parameter{Heading}\\
\Macro{addpart*}\Parameter{Heading}\\
\Macro{addchap}\OParameter{Short version}\Parameter{Heading}\\
\Macro{addchap*}\Parameter{Heading}\\
\Macro{addsec}\OParameter{Short version}\Parameter{Heading}\\
\Macro{addsec*}\Parameter{Heading}\textnote[n]{\KOMAScript{} vs. standard classes}
\end{Declaration}%
\BeginIndex{Cmd}{addpart}%
\BeginIndex{Cmd}{addpart*}%
\BeginIndex{Cmd}{addchap}%
\BeginIndex{Cmd}{addchap*}%
\BeginIndex{Cmd}{addsec}%
\BeginIndex{Cmd}{addsec*}%
In addition to the commands of the standard classes, {\KOMAScript}
offers the new commands \Macro{addsec} and \Macro{addchap}. They are
similar to the standard commands \Macro{chapter} and
\Macro{section}, except that they are unnumbered. They thus produce
both a running heading and an entry in the table of contents.
The starred variants \Macro{addchap*} and \Macro{addsec*} are similar to the
standard commands \Macro{chapter*} and \Macro{section*} except for a tiny but
important difference: The running headings are deleted. This eliminates the
side effect of obsolete headers mentioned above. Instead, the running headings
on following pages remain empty. \OnlyAt{\Class{book}\and
\Class{scrreprt}}\Macro{addchap} and \Macro{addchap*} of course only exist
in book and report classes, namely \Class{book}, \Class{scrbook},
\Class{report} and \Class{scrreport}, but not in the article classes
\Class{article} and \Class{scrartcl}.
Similarly, the command \Macro{addpart} produces an unnumbered document
part with an entry in the table of contents. Since the running
headings are already deleted by \Macro{part} and \Macro{part*} the
problem of obsolete headers does not exist. The starred version
\Macro{addpart*} is thus identical to \Macro{part*} and is only
defined for consistency reasons.
Please note\textnote{Attention!} that \Macro{addpart} and \Macro{addchap} and
their starred versions change the page style for one page. The particular page
style is defined in the macros \Macro{partpagestyle} and
\Macro{chapterpagestyle} (see \autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.cmd.titlepagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
the same explanations apply as given above for the normal structuring
commands. The elements are named the same since they describe not
variants but structuring levels.%
%
\EndIndex{Cmd}{addpart}%
\EndIndex{Cmd}{addpart*}%
\EndIndex{Cmd}{addchap}%
\EndIndex{Cmd}{addchap*}%
\EndIndex{Cmd}{addsec}%
\EndIndex{Cmd}{addsec*}%
\begin{Declaration}
\Macro{minisec}\Parameter{Heading}
\end{Declaration}%
\BeginIndex{Cmd}{minisec}%
Sometimes a heading\Index{heading} is wanted which is highlighted but
also closely linked to the following text. Such a heading should not
be separated by a large vertical skip.
The command \Macro{minisec} is designed for this situation. This
heading is not associated with any structuring level. Such a
\emph{mini section} does not produce an entry in the table of contents
nor does it receive any numbering.
\BeginIndex{FontElement}{minisec}%
\BeginIndex{FontElement}{disposition}%
The font type of the structuring command \Macro{minisec} can be changed using
the element \FontElement{disposition}\IndexFontElement{disposition} (see
\autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}) and
\FontElement{minisec}\ChangedAt{v2.96a}{%
\Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}}. Default setting
of element \FontElement{minisec} is empty, so the default of the element
\FontElement{disposition} is active.
%
\EndIndex{FontElement}{disposition}%
\EndIndex{FontElement}{minisec}%
\begin{Example}
You have developed a kit for building a mouse trap and want the
documentation separated into a list of necessary items and an
assembly description. You could write the following:
\begin{lstcode}
\minisec{Items needed}
\begin{flushleft}
1 plank ($100\times 50 \times 12$)\\
1 spring-plug of a beer-bottle\\
1 spring of a ball-point pen\\
1 drawing pin\\
2 screws\\
1 hammer\\
1 knife
\end{flushleft}
\minisec{Assembly}
At first one searches the mouse-hole and puts the drawing pin
directly behind the hole. Thus the mouse cannot escape during the
following actions.
Then one knocks the spring-plug with the hammer into the mouse-hole.
If the spring-plug's size is not big enough in order to shut the
mouse-hole entirely, then one can utilize the plank instead and
fasten it against the front of the mouse-hole utilizing the two
screws and the knife. Instead of the knife one can use a
screw-driver instead.
\end{lstcode}
Which gives:
\begin{ShowOutput}[\baselineskip]\setlength{\parindent}{1em}
\minisec{Items needed}
\begin{flushleft}
1 plank ($100\times 50 \times 12$)\\
1 spring-plug of a beer-bottle\\
1 spring of a ball-point pen\\
1 drawing pin\\
2 screws\\
1 hammer\\
1 knife
\end{flushleft}
\minisec{Assembly}
At first one searches the mouse-hole and puts the drawing pin
directly behind the hole. Thus the mouse cannot escape during the
following actions.
Then one knocks the spring-plug with the hammer into the
mouse-hole. If the spring-plug's size is not big enough in order
to shut the mouse-hole entirely, then one can utilize the plank
instead and fasten it against the front of the mouse-hole
utilizing the two screws and the knife. Instead of the knife one
can use a screw-driver instead.
\end{ShowOutput}
\end{Example}
%
\EndIndex{Cmd}{minisec}%
\begin{Declaration}
\Macro{raggedsection}\\
\Macro{raggedchapter}\\
\Macro{raggedpart}
\end{Declaration}%
\BeginIndex{Cmd}{raggedsection}%
\BeginIndex{Cmd}{raggedchapter}%
\BeginIndex{Cmd}{raggedpart}%
In the standard classes\textnote{\KOMAScript{} vs. standard classes}, headings
are set as justified text. That means that hyphenated words can occur and
headings with more than one line are stretched up to the text border. This is
a rather uncommon approach in typography. {\KOMAScript} therefore formats the
headings left aligned with hanging indentation using \Macro{raggedsection}
with the definition:
\begin{lstcode}[belowskip=\dp\strutbox]
\newcommand*{\raggedsection}{\raggedright}
\end{lstcode}
This command can be redefined with \Macro{renewcommand}.
\begin{Example}
You prefer justified headings, so you write in the preamble of your document:
\begin{lstcode}
\renewcommand*{\raggedsection}{}
\end{lstcode}
or more compactly:
\begin{lstcode}
\let\raggedsection\relax
\end{lstcode}
You will get a formatting of the headings which is very close to that
of the standard classes. It will become even closer when you combine
this change with the change of the element
\FontElement{disposition}\IndexFontElement{disposition} mentioned
above.
\end{Example}
Because\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}} some users want
for \Macro{chapter} another alignment than for all other sections, you can
change only \Macro{chapter} redefining \Macro{raggedchapter}. The default of
this command is usage of \Macro{raggedsection}. So every change of
\Macro{raggedsection} will also change the alignment of chapter headings.
Unlike all others, the headings of parts (\Macro{part}) will be
horizontally centered instead of set ragged right. This is because command
\Macro{raggedpart} is defined as
\begin{lstcode}[belowskip=\dp\strutbox]
\let\raggedpart\centering
\end{lstcode}
You may also redefine this using \Macro{renewcommand} too.
\begin{Example}
You do not want different alignment at headings of \Macro{part}. So you
put
\begin{lstcode}
\renewcommand*{\raggedpart}{\raggedsection}
\end{lstcode}
into the preamble of your document. In\textnote{Hint!} this case,
and unlike in the example above, \Macro{let} has not been used, because
\Macro{let} would give \Macro{raggedpart} the current meaning of
\Macro{raggedsection}. Further changes of \Macro{raggedsection} would then
stay disregarded at the usage of \Macro{raggedpart}. Doing the redefinition
using \Macro{renewcommand} gives \Macro{raggedpart} the meaning of
\Macro{raggedsection} not at definition time, but each time
\Macro{raggedpart} will be used.
\end{Example}%
%
\EndIndex{Cmd}{raggedpart}%
\BeginIndex{Cmd}{raggedchapter}%
\EndIndex{Cmd}{raggedsection}%
\begin{Declaration}
\Macro{partformat}\\
\Macro{chapterformat}\\
\Macro{othersectionlevelsformat}\Parameter{sectioning
name}\Parameter{}\Parameter{counter output}\\
\Macro{autodot}
\end{Declaration}%
\BeginIndex{Cmd}{partformat}\Index{part>number}%
\BeginIndex{Cmd}{chapterformat}\Index{chapter>number}%
\BeginIndex{Cmd}{othersectionlevelsformat}\Index{section>number}%
\BeginIndex{Cmd}{autodot}%
{\KOMAScript} has added a further logical level on top of
\Macro{the\PName{sectioning name}} to the output of the sectioning
numbers. The counters for the respective heading are not merely output. They
are formatted using the commands \Macro{partformat}, \Macro{chapterformat},
and the command \Macro{othersectionlevelsformat} that expect three
arguments. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course the command
\Macro{chapterformat} like \Macro{thechapter} does not exist in the class
\Class{scrartcl} but only in the classes \Class{scrbook} and \Class{scrreprt}.
As described for option \Option{numbers}\important{\Option{numbers}} at the
beginning of this section (see \autopageref{desc:maincls.option.numbers}),
periods in section numbers should be handled for the German-speaking region
according to the rules given in \cite{DUDEN}. The command \Macro{autodot} in
{\KOMAScript} ensures that these rules are being followed. In all levels
except for \Macro{part}, a dot is followed by a further \Macro{enskip}. This
corresponds to a horizontal skip of 0.5\Unit{em}.
The command \Macro{othersectionlevelsformat} takes as first parameter the
name of the section level, such as \PValue{section},
\PValue{subsection}, \PValue{subsection},
\PValue{subsubsection}, \PValue{paragraph}, and \PValue{subparagraph}. The
third parameter should be the output of the corresponding counter, usually
\Macro{thesection}, \Macro{thesubsection}, \Macro{thesubsubsection},
\Macro{theparagraph}, or \Macro{thesubparagraph}.
Per default, therefore, only the levels
\Macro{part} and \Macro{chapter} have formatting commands of their
own, while all other section levels are covered by one general
formatting command. This has historical reasons. At the time that
Werner Lemberg suggested a suitable extension of {\KOMAScript} for his
\Package{CJK} package, only this differentiation was needed. Users should
ignore the third argument of \Macro{othersectionlevelsformat} completely.
The formatting commands can be redefined using \Macro{renewcommand} to
fit them to your personal needs. The following original definitions
are used by the {\KOMAScript} classes:
\begin{lstcode}
\newcommand*{\partformat}{\partname~\thepart\autodot}
\newcommand*{\chapterformat}{%
\chapappifchapterprefix{\ }\thechapter\autodot\enskip}
\newcommand*{\othersectionlevelsformat}[3]{%
#3\autodot\enskip}
\end{lstcode}
\begin{Example}
Assume that when using \Macro{part} you do not want the word
``Part'' written in front of the part number. You could use the
following command in the preamble of your document:
\begin{lstcode}
\renewcommand*{\partformat}{\thepart\autodot}
\end{lstcode}
Strictly speaking, you could do without \Macro{autodot} at this point and
insert a fixed dot instead. As \Macro{part} is numbered with roman numerals,
according to \cite{DUDEN} a period has to be applied. However, you thereby
give up the possibility to use one of the options
\OptionValue{numbers}{endperiod} and \OptionValue{numbers}{noendperiod} and
optionally depart from the rules. More details concerning class options can
be found at \autopageref{desc:maincls.option.numbers}.
An additional possibility could be to place the section numbers in the
left margin in such a way that the heading text is left aligned with
the surrounding text. This can be accomplished with:
\begin{lstcode}
\renewcommand*{\othersectionlevelsformat}[3]{%
\llap{\#3\autodot\enskip}}
\end{lstcode}
The little known {\TeX} command \Macro{llap} in the definition above
puts its argument left of the current position without changing the
position thereby. A much better {\LaTeX} solution would be:
\begin{lstcode}
\renewcommand*{\othersectionlevelsformat}[3]{%
\makebox[0pt][r]{%
#3\autodot\enskip}}
\end{lstcode}
See \cite{latex:usrguide} for more information about the optional arguments
of \Macro{makebox}.
\end{Example}
%
\EndIndex{Cmd}{partformat}%
\EndIndex{Cmd}{chapterformat}%
\EndIndex{Cmd}{othersectionlevelsformat}%
\EndIndex{Cmd}{autodot}%
\begin{Declaration}
\Macro{chapappifchapterprefix}\Parameter{additional text}\\
\Macro{chapapp}
\end{Declaration}%
\BeginIndex{Cmd}{chapappifchapterprefix}%
\BeginIndex{Cmd}{chapapp}%
These\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}%
\ChangedAt{v2.8o}{\Class{scrbook}\and\Class{scrreprt}} two commands
are not only used internally by {\KOMAScript} but are also provided to
the user. Later it will be shown how they can be used, for example, to
redefine other commands.
Using the layout option
\OptionValue{chapterprefix}{true}\important{\Option{chapterprefix}} (see
\autopageref{desc:maincls.option.chapterprefix})
\Macro{chapappifchapterprefix} outputs the word
``Chapter''\Index{chapter>heading} in the main part of the document in the
current language, followed by \PName{additional text}. In the
appendix\Index{appendix}, the word ``Appendix'' in the current
language is output instead, followed by \PName{additional text}. If the
option \OptionValue{chapterprefix}{false} is set, then nothing is output.
The command \Macro{chapapp} always outputs the word ``Chapter'' or
``Appendix''. In this case the selection of option \Option{chapterprefix} has
no effect.
Since chapters only exist in the classes \Class{scrbook} and
\Class{scrreprt}, these commands only exist in these classes.%
%
\EndIndex{Cmd}{chapappifchapterprefix}%
\EndIndex{Cmd}{chapapp}%
\begin{Declaration}
\Macro{chaptermark}\Parameter{running head}\\
\Macro{addchapmark}\Parameter{running head}\\
\Macro{sectionmark}\Parameter{running head}\\
\Macro{addsecmark}\Parameter{running head}\\
\Macro{subsectionmark}\Parameter{running head}\\
\Macro{chaptermarkformat}\\
\Macro{sectionmarkformat}\\
\Macro{subsectionmarkformat}
\end{Declaration}%
\BeginIndex{Cmd}{addchapmark}%
\BeginIndex{Cmd}{addsecmark}%
\BeginIndex{Cmd}{chaptermark}%
\BeginIndex{Cmd}{sectionmark}%
\BeginIndex{Cmd}{subsectionmark}%
\BeginIndex{Cmd}{chaptermarkformat}%
\BeginIndex{Cmd}{sectionmarkformat}%
\BeginIndex{Cmd}{subsectionmarkformat}%
\begin{Explain}%
As mentioned in \autoref{sec:maincls.pagestyle} the page style
\PValue{headings} works with automatic running
heads\Index{running head}. For this, the commands
\Macro{chaptermark} and \Macro{sectionmark}, or \Macro{sectionmark}
and \Macro{subsectionmark}, respectively, are defined. Every
structuring command (\Macro{chapter}, \Macro{section}, etc.)
automatically carries out the respective \Macro{\dots mark} command.
The parameter passed contains the text of the section
heading\Index{heading}. The respective section number is added
automatically in the \Macro{\dots mark} command. The formatting is
done according to the section level with one of the three commands
\Macro{chaptermarkformat}, \Macro{sectionmarkformat}, or
\Macro{subsectionmarkformat}.
Because\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} \KOMAScript{} provides additional commands
\Macro{addchap} and \Macro{addsec} to make headings without numbers, there
also exist corresponding commands for making the running heads of those.
Please note\textnote{Attention!}, that the predefined \Macro{addchapmark}
and \Macro{addsecmark} use \Macro{chaptermark} and \Macro{sectionmark} while
they set counter \Counter{secnumdepth} to -1 locally. You should pay
attention for this exspecially if you redefine \Macro{chaptermark} or
\Macro{sectionmark} (see \Macro{ifnumbered} on
\autopageref{desc:maincls.cmd.ifnumbered}) or you should also redefine
\Macro{addchapmark} and \Macro{addsecmark} suitable.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course there is no command
\Macro{chaptermark} or \Macro{chaptermarkformat} in
\Class{scrartcl}. \OnlyAt{\Class{scrartcl}}Accordingly,
\Macro{subsectionmark} and \Macro{subsectionmarkformat} exist only in
\Class{scrartcl}. This changes when you use the \Package{scrlayer-scrpage}
package (see \autoref{cha:scrlayer-scrpage}).\par
\end{Explain}
Similar to \Macro{chapterformat} and \Macro{othersectionlevelsformat},
the commands \Macro{chaptermarkformat} (not in \Class{scrartcl}),
\Macro{sectionmarkformat}, and \Macro{subsectionmarkformat} (only in
\Class{scrartcl}) define the formatting of the sectioning numbers in
the automatic running heads. They can be adapted to your personal
needs with \Macro{renewcommand}. The original definitions for the
{\KOMAScript} classes are:
\begin{lstcode}
\newcommand*{\chaptermarkformat}{%
\chapappifchapterprefix{\ }\thechapter\autodot\enskip}
\newcommand*{\sectionmarkformat}{\thesection\autodot\enskip}
\newcommand*{\subsectionmarkformat}{%
\thesubsection\autodot\enskip}
\end{lstcode}
\begin{Example}
Suppose you want to prepend the word ``Chapter'' to the chapter
number in the running heading. For example you could insert the
following definition in the preamble of your document:
\begin{lstcode}
\renewcommand*{\chaptermarkformat}{%
\chapapp~\thechapter\autodot\enskip}
\end{lstcode}
\end{Example}
As you can see, both the commands \Macro{chapappifchapterprefix} and
\Macro{chapapp} explained above are used here.%
%
\EndIndex{Cmd}{chaptermark}%
\EndIndex{Cmd}{sectionmark}%
\EndIndex{Cmd}{subsectionmark}%
\EndIndex{Cmd}{chaptermarkformat}%
\EndIndex{Cmd}{sectionmarkformat}%
\EndIndex{Cmd}{subsectionmarkformat}%
\EndIndex{Cmd}{addsecmark}%
\EndIndex{Cmd}{addchapmark}%
\begin{Declaration}
\Counter{secnumdepth}\\
\Macro{partnumdepth}\\
\Macro{chapternumdepth}\\
\Macro{sectionnumdepth}\\
\Macro{subsectionnumdepth}\\
\Macro{subsubsectionnumdepth}\\
\Macro{paragraphnumdepth}\\
\Macro{subparagraphnumdepth}
\end{Declaration}%
\BeginIndex{Counter}{secnumdepth}\BeginIndex{}{numbering}%
\BeginIndex{Cmd}{partnumdepth}%
\BeginIndex{Cmd}{chapternumdepth}%
\BeginIndex{Cmd}{sectionnumdepth}%
\BeginIndex{Cmd}{subsectionnumdepth}%
\BeginIndex{Cmd}{subsubsectionnumdepth}%
\BeginIndex{Cmd}{paragraphnumdepth}%
\BeginIndex{Cmd}{subparagraphnumdepth}%
Section levels in the classes \Class{scrbook}\IndexClass{scrbook} and
\Class{scrreport}\IndexClass{scrreprt} are, by default, numbered from
\Macro{part}\IndexCmd{part}\IndexCmd{chapter}\IndexCmd{section} down to
\Macro{subsection}\IndexCmd{subsection}. In class
\Class{scrartcl}\IndexClass{scrartcl} the default numbering is from
\Macro{part} down to \Macro{subsubsection}\IndexCmd{subsubsection}. The
actual depth to which headings will be numbered is controlled by the \LaTeX{}
counter \Counter{secnumdepth}. Since version~3.12 \KOMAScript{} provides the
commands \Macro{partnumdepth} to \Macro{subparagraphnumdepth} which return the
number that corresponds to the level they bear in their name. This saves users
the trouble of having to remember abstract numbers and allows them to define
the depth to which headings should be numbered with relative ease.
\KOMAScript{} provides the commands \Macro{partnumdepth} to
\Macro{subparagraphnumdepth} so\ChangedAt{v3.12}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} users do not have to remember
abstract numbers, to be able to define the section level down to which
headings should be numbered. These commands stand for the corresponding
numbers of the section levels.%
\begin{Example}
For a book project you want the section levels from part down to the section
to be numbered. To achieve this, you have to set counter
\Counter{secnumdepth} to the value represented by \Macro{sectionnumdepth} in
the preamble of your document:
\begin{lstcode}
\setcounter{secnumdepth}{\sectionnumdepth}
\end{lstcode}
\end{Example}
Redefining these commands is not allowed. Doing so could lead to unexpected
results not only with \KOMAScript{} but also with third party packages. Thus,
it is recommended to never redefine any of them.
Do not confuse the counters \Counter{secnumdepth} and \Counter{tocdepth},
please refer to the explanation concerning the counter \Counter{tocdepth} in
\autoref{sec:maincls.toc},
\autopageref{desc:maincls.counter.tocdepth}. Actually, depending on the class
you are using, the meaning of the values of the counters \Counter{secnumdepth}
and \Counter{tocdepth} may deviate from one another for the same section
level.%
\EndIndex{Cmd}{subparagraphnumdepth}%
\EndIndex{Cmd}{paragraphnumdepth}%
\EndIndex{Cmd}{subsubsectionnumdepth}%
\EndIndex{Cmd}{subsectionnumdepth}%
\EndIndex{Cmd}{sectionnumdepth}%
\EndIndex{Cmd}{chapternumdepth}%
\EndIndex{Cmd}{partnumdepth}%
\EndIndex{Counter}{secnumdepth}\EndIndex{}{numbering}%
\begin{Declaration}
\Macro{ifnumbered}\Parameter{section level}%
\Parameter{then code}\Parameter{else code}\\
\Macro{ifunnumbered}\Parameter{section level}%
\Parameter{then code}\Parameter{else code}
\end{Declaration}
\BeginIndex{Cmd}{ifnumbered}%
\BeginIndex{Cmd}{ifunnumbered}%
After\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} describing above how to define down to which section level
headings are numbered, the commands \Macro{ifnumbered} and
\Macro{ifunnumbered} can be used to execute code depending on whether a
\PName{section level} is numbered or not. If the current setting of
\Counter{secnumdepth} stipulates that a \PName{section level} will be
numbered, the \PName{then code} after \Macro{ifnumbered} gets executed. If it
is not numbered, the \PName{else code} gets executed. The \Macro{ifunnumbered}
command behaves in exactly the opposite manner, executing the \PName{then
code} if the current level is not numbered and the \PName{else code} if it
is. The \PName{section level} parameter is simply the \LaTeX{} name of a
section like \PValue{part}, \PValue{chapter}, \PValue{section},
\PValue{subsection}, \PValue{subsubsection}, \PValue{paragraph} oder
\PValue{subparagraph}.\PValue{part}, \PValue{chapter}, \PValue{section},
\PValue{subsection}, \PValue{subsubsection}, \PValue{paragraph}, or
\PValue{subparagraph}.
\KOMAScript{} itself uses these tests, for example, in the definition of
\Macro{chaptermark}\IndexCmd{chaptermark} within page style
\Pagestyle{headings}\IndexPagestyle{headings}. This indirectly guarantees that
headings inserted by \Macro{addchap} do not set a number inside the running
head (see also \Macro{addchapmark},
\autopageref{desc:maincls.cmd.addchapmark}).%
\EndIndex{Cmd}{ifnumbered}%
\EndIndex{Cmd}{ifunnumbered}%
\begin{Declaration}
\Macro{setpartpreamble}%
\OParameter{position}\OParameter{width}\Parameter{preamble}\\
\Macro{setchapterpreamble}%
\OParameter{position}\OParameter{width}\Parameter{preamble}
\end{Declaration}%
\BeginIndex{Cmd}{setpartpreamble}%
\BeginIndex{Cmd}{setchapterpreamble}%
Parts\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}}\Index{part>preamble}\Index{chapter>preamble} and chapters
in {\KOMAScript} can be started with a \PName{preamble}. This is particularly
useful when you are using a two column layout with the class option
\Option{twocolumn}\IndexOption{twocolumn}, since the heading together with the
\PName{preamble} is always set in a one column layout. The \PName{preamble}
can comprise more than one paragraph. The command to output the
\PName{preamble} has to be placed before the respective \Macro{part},
\Macro{addpart}, \Macro{chapter}, or \Macro{addchap} command.
\begin{Example}
You are writing a report about the condition of a company. You
organize the report in such a way that every department gets its own
partial report. Every one of these parts should be introduced by an
abstract on the corresponding title page. You could write the
following:
\begin{lstcode}
\setpartpreamble{%
\begin{abstract}
This is a filler text. It serves merely to demonstrate the
capabilities of {\KOMAScript}. If you read this text, you will
get no information.
\end{abstract}
}
\part{Department for Word Processing}
\end{lstcode}
Depending on the settings for the heading font size\Index{heading}
(see \autopageref{desc:maincls.option.headings}) and the options for
the \Environment{abstract} environment\IndexEnv{abstract} (see
\autoref{sec:maincls.abstract},
\autopageref{desc:maincls.option.abstract}), the result would look
similar to:
\begin{ShowOutput}\centering
{\LARGE\usekomafont{disposition} Part III.\par\vspace{20pt}}
{\LARGE\usekomafont{disposition} Department for Word Processing\strut\par}
\begin{quote}\small
\vspace{4ex}
\begin{center}
\usekomafont{disposition}\abstractname
\end{center}
\vspace{2ex}
This is a filler text. It serves merely to demonstrate the
capabilities of {\KOMAScript}. If you read this text, you will
get no information.
\end{quote}
\end{ShowOutput}
\end{Example}
Please\textnote{Attention!} note that it is \emph{you} who is responsible for
the spaces between the heading, preamble and the following text. Please note
also that there is no \Environment{abstract} environment in the class
\Class{scrbook} (see \autoref{sec:maincls.abstract},
\autopageref{desc:maincls.env.abstract}).
The\ChangedAt{v2.8p}{\Class{scrbook}\and\Class{scrreprt}} first
optional argument \PName{position} determines the position at which
the preamble is placed with the help of one or two letters. For the
vertical placement there are two possibilities at present:
\begin{labeling}[~--]{\quad\PValue{o}}\itemsep=0pt
\item [\quad\texttt{o}] above the heading
\item [\quad\texttt{u}] below the heading
\end{labeling}
You can insert one preamble above and another below a heading. For the
horizontal placement you have the choice between three alignments:
\begin{labeling}[~--]{\quad\PValue{o}}\itemsep=0pt
\item [\quad\texttt{l}] left-aligned
\item [\quad\texttt{r}] right-aligned
\item [\quad\texttt{c}] centered
\end{labeling}
However, this does not output the text of the \PName{preamble} in such
a manner, but inserts a box whose width is determined by the second
optional argument \PName{width}. If you leave out this second argument
the whole text width is used. In that case the option for horizontal
positioning will have no effect. You can combine exactly one letter
from the vertical with one letter from the horizontal positioning.
A more often usage of \Macro{setchapterpreamble} would be something like a
smart slogan or dictum to a heading. The command
\Macro{dictum}\IndexCmd{dictum}, that may be used for this, will be described
at the next section. You will also find an example there.
Please note\textnote{Attention!} that a \PName{preamble} placed above
the chapter headings will be set into the already existing vertical
space above the heading. The heading will not be moved down. It is
you who is responsible for ensuring that the preamble is small enough and the
space is sufficient. See also \Macro{chapterheadstartvskip} in
\autoref{sec:maincls-experts.experts},
\autopageref{desc:maincls-experts.cmd.chapterheadstartvskip} for
this.%
%
\EndIndex{Cmd}{setpartpreamble}%
\EndIndex{Cmd}{setchapterpreamble}%
\LoadCommon{15}% \section{Dicta}
\LoadCommon{12}% \section{Lists}
\section{Math}
\label{sec:maincls.math}%
\BeginIndex{}{equations}%
\BeginIndex{}{formulas}%
\BeginIndex{}{mathematics}%
There are no math environments implemented in the \KOMAScript{}
classes. Instead of this, the math features of the \LaTeX{} kernel have been
supported. With this also, the options \Option{leqno} and \Option{fleqn} are
available.
You will not find a description of the math environments of the \LaTeX{} kernel
here. If you want to use \Environment{displaymath}\IndexEnv{displaymath},
\Environment{equation}\IndexEnv{equation}, and
\Environment{eqnarray}\IndexEnv{eqnarray} you should read a short introduction
into \LaTeX{} like \cite{lshort}. But\textnote{Hint!} if you want more than
very simple mathematics, usage of package \Package{amsmath} would be
recommended (see \cite{package:amsmath}).
\begin{Declaration}
\Option{leqno}
\end{Declaration}%
\BeginIndex{Option}{leqno}%
Equations are normally numbered\Index{equation>number} on the right. The
standard option \Option{leqno} causes the standard option file
\File{leqno.clo} to be loaded. The equations are then numbered on the
left. This\textnote{Attention!} option has to be used as an optional argument
of \Macro{documentclass}. Usage as an argument of \Macro{KOMAoptions} or
\Macro{KOMAoption} is not supported. This would not make sense, because the
recommended math package \Package{amsmath} supports the option at loading
time only too and would not react on run-time changes of the option.
%
\EndIndex{Option}{leqno}%
\begin{Declaration}
\Option{fleqn}
\end{Declaration}%
\BeginIndex{Option}{fleqn}%
Displayed equations\Index{equation>alignment} are normally centered. The
standard option \Option{fleqn} causes the standard option file
\File{fleqn.clo} to be loaded. Displayed equations are then
left-justified. This option may be used as an optional argument of
\Macro{documentclass} but not as an argument of \Macro{KOMAoptions} or
\Macro{KOMAoption}. The latter would not make sense, because the recommended
math package \Package{amsmath} supports the option at loading time only too
and would not react on run-time changes of the option.
%
\EndIndex{Option}{fleqn}%
%
\EndIndex{}{mathematics}%
\EndIndex{}{formulas}%
\EndIndex{}{equations}%
\section{Floating Environments of Tables and Figures}
\label{sec:maincls.floats}
\BeginIndex{}{floats}%
\BeginIndex{}{tables}%
\BeginIndex{}{figures}%
With the floating environments, {\LaTeX} offers a very capable and comfortable
mechanism for automatic placement of figures\Index{figure} and
tables\Index{table}.
% Im Deutschen ist hier ein Absatz, den wir nicht uebernehmen!
But\textnote{Attention!} often these floating environments\Index[indexmain]
{floating environments} are slightly misunderstood by beginners. They often
ask for a fixed position of a table or figure within the text. However, since
these floating environments are being referenced in the text this is not
necessary in most cases. It is also not sensible because such an object can
only be set on the page if there is enough space left for it. If this is not
the case the object would have to be shifted onto the next page, thereby
possibly leaving a huge blank space on the page before.
Often\textnote{Attention!} one finds in a document for every floating object
the same optional argument for positioning the object. This also makes no
sense. In such cases one should rather change the standard parameter
globally. For more details refer to \cite{DANTE:FAQ}.
One\textnote{Attention!} last important note before starting this section:
most mechanisms described here which extend the capabilities of the standard
classes no longer work correctly when used together with packages which modify
the typesetting of captions of figures and tables. This should be self
evident, but it is often not understood.
\begin{Declaration}
\KOption{captions}\PName{selection}
\end{Declaration}
\BeginIndex{Option}{captions~=\PName{selection}}%
The standard classes format titles of floating environments, which are placed
with \Macro{caption}\IndexCmd{caption} (see below), like signatures. They
differentiate between one-line and multi-line table or figure
captions. One-line captions are centered while multi-line captions are
left-justified.
\leavevmode\phantomsection\nobreak
\label{desc:maincls.option.captions.tableheading}\nobreak
For tables, however, headings are often used. That's because there may
be tables that span several pages. Surely the reader wants to know the
purpose of the table at the first page already. Furthermore tables
will be read row by row from top down to bottom. So there are at least
two good reasons to generally use table
headings. \KOMAScript{}\important{\OptionValue{captions}{tableheading}}
therefor supports option \OptionValue{captions}{tableheading}%
\IndexOption{captions~=\PValue{tableheading}}, which changes the
caption format into headings at tables only.
Please note\textnote{Attention!} that multi-page tabulars may not use any
floating environment. To have an automatic page break at any kind of tabular you
also need additional packages like \Package{longtable}\IndexPackage{longtable}
(see \cite{package:longtable}) or \Package{tabu}\IndexPackage{tabu} (see
\cite{package:tabu}).
You may switch back\important[i]{\begin{tabular}[t]{@{}l@{}}
\Option{captions=}\\
\quad\PValue{tablesignature}
\end{tabular}} to the default table signatures using
\OptionValue{captions}{tablesignature}%
\IndexOption{captions~=\PValue{tablesignature}}.
Note\textnote{Attention!} that using any of these options does not change the position of
the caption from above the top of the table to below the bottom of the
table or vice versa. It only affects whether the text is formatted as
a caption for use above or below a table. Whether the text is in fact
placed above or below a table is set through the position of the
\Macro{caption} command inside the \Environment{table} environment. This may
change using package \Package{float}\IndexPackage{float} and command
\Macro{restylefloats} (see \cite{package:float}).
Of course similar features exist\ChangedAt{v3.09}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} for figures using options
\OptionValue{captions}{figureheading}%
\IndexOption{captions~=\PValue{figureheading}} and
\OptionValue{captions}{figuresignature}%
\IndexOption{captions~=\PValue{figuresignature}}. Nevertheless,
figures like photos will be viewed as a whole, and a diagram or graph
will mostly be examined from left bottom to the right. Therefore, in
general, signatures should be used and it would not be useful to change
the caption format from signatures to headings.
Nevertheless sometimes all floating environments shall use headings. For this
\KOMAScript{} supports\ChangedAt{v3.09}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}}
options\important[i]{\OptionValue{captions}{heading}\\
\OptionValue{captions}{signature}}
\OptionValue{captions}{heading}\IndexOption{captions~=\PValue{heading}} and
\OptionValue{captions}{signature}\IndexOption{captions~=\PValue{signature}} to
switch the format of every floating environment. These options may be used
also inside a floating environment but before using \Macro{caption}.
Note\textnote{Attention!}\OnlyAt{\Package{float}}\IndexPackage{float} that
when using the \Package{float} package, the options
\OptionValue{captions}{tablesignature} and
\OptionValue{captions}{tableheading} cease to act correctly when
\Macro{restylefloat} is applied to tables. More details of the \Package{float}
package and \Macro{restylefloat} can be found in
\cite{package:float}. Additional support in {\KOMAScript} for the
\Package{float} package may be found at the explanation of \PValue{komaabove}
(see \autopageref{desc:maincls.floatstyle.komaabove}).
\leavevmode\phantomsection\nobreak
\label{desc:maincls.option.captions.nooneline}\nobreak
\label{desc:maincls.option.captions.oneline}\nobreak
Furthermore, \KOMAScript{} supports to switch off the distinguish of captions
with only one line or more than one line using option
\OptionValue{captions}{nooneline}\IndexOption{captions~=\PValue{nooneline}}%
\important{\OptionValue{captions}{nooneline}}. This may be useful, if one-line
captions should not be centered. The default of centering one-line captions
corresponds to \OptionValue{captions}{oneline}.
Another special feature of \KOMAScript{} is to alternatively put the caption
neither above nor below the floating object but beside
it. For this you need Environment\important{\Environment{captionbeside}}
\Environment{captionsbeside}\IndexEnv{captionbeside}, that will be described
from \autopageref{desc:maincls.env.captionbeside}. Several settings
for this environment may be done also using \Option{caption}. You may find all
the available \PName{settings} at \autoref{tab:maincls.captions}.
%
\begin{desclist}
\desccaption[{Available values for option \Option{captions}}]{%
Available values for option \Option{captions} to select formation of
captions as headings or signatures at floating environments%
\label{tab:maincls.captions}%
}{%
Available values for option \Option{captions} (\emph{continuation})%
}%
\entry{\PValue{bottombeside}, \PValue{besidebottom}}{%
Captions and contents of environment \Environment{captionsbeside} (see
\autoref{sec:maincls.floats},
\autopageref{desc:maincls.env.captionbeside}) will be vertically align
depending on the bottommost base lines.%
\IndexOption{captions~=\PValue{bottombeside}}}%
\entry{\PValue{centeredbeside}, \PValue{besidecentered},
\PValue{middlebeside}, \PValue{besidemiddle}}{%
Captions and contents of environment \Environment{captionsbeside} (see
\autoref{sec:maincls.floats},
\autopageref{desc:maincls.env.captionbeside}) will be vertically centered%
\IndexOption{captions~=\PValue{centeredbeside}}}%
\entry{\PValue{figureheading}, \PValue{figureabove}, \PValue{abovefigure},
\PValue{topatfigure}%
\IndexOption{captions~=\PValue{figureheading}}}{%
\ChangedAt{v3.09}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}%
Captions of figures will use heading formation\,---\,maybe in discrepancy
to \OptionValue{captions}{signature}.%
}%
\entry{\PValue{figuresignature}, \PValue{belowfigure},
\PValue{bottomatfiggure}%
\IndexOption{captions~=\PValue{figuresignature}}}{%
\ChangedAt{v3.09}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}%
Captions of figures will use signature formation\,---\,maybe in
discrepancy to \OptionValue{captions}{headings}.%
}%
\entry{\PValue{heading}, \PValue{above}, \PValue{top}%
\IndexOption{captions~=\PValue{heading}}}{%
\ChangedAt{v3.09}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} Captions of floating environments will use heading
formation. Nevertheless this does not influence whether they are really
placed at the top or at the bottom of the object. This options also
implies \OptionValue{captions}{tableheading} and
\OptionValue{captions}{figureheading}.%
}%
\entry{\PValue{innerbeside},
\PValue{besideinner}\IndexOption{captions~=\PValue{innerbeside}}}{%
Captions of environment \Environment{captionsbeside} (siehe
\autoref{sec:maincls.floats},
\autopageref{desc:maincls.env.captionbeside})
will be placed innermost beside the contents of the environment at
double-side printing. At single-side printing
\OptionValue{captions}{leftbeside} will be used.%
}%
\entry{\PValue{leftbeside},
\PValue{besideleft}\IndexOption{captions~=\PValue{leftbeside}}}{%
Captions of environment \Environment{captionsbeside} (siehe
\autoref{sec:maincls.floats},
\autopageref{desc:maincls.env.captionbeside}) will be placed left beside
the contents of the environment.%
}%
\pventry{nooneline}{%
Captions with only one line will not be handled different from captions
with more than one line.%
\IndexOption{captions~=\PValue{nooneline}}}%
\pventry{oneline}{%
Captions with only one line will be centered horizontally.%
\IndexOption{captions~=\PValue{oneline}}}%
\entry{\PValue{outerbeside}, \PValue{besideouter}%
\IndexOption{captions~=\PValue{outerbeside}}}{%
Captions of environment \Environment{captionsbeside} (siehe
\autoref{sec:maincls.floats},
\autopageref{desc:maincls.env.captionbeside})
will be placed outermost beside the contents of the environment at
double-side printing. At single-side printing
\OptionValue{captions}{rightbeside} will be used.%
}%
\entry{\PValue{rightbeside}, \PValue{besideright}%
\IndexOption{captions~=\PValue{rightbeside}}}{%
Captions of environment \Environment{captionsbeside} (siehe
\autoref{sec:maincls.floats},
\autopageref{desc:maincls.env.captionbeside}) will be placed right beside
the contents of the environment.%
}%
\entry{\PValue{signature}, \PValue{below}, \PValue{bot}, \PValue{bottom}%
\IndexOption{captions~=\PValue{signature}}}{%
\ChangedAt{v3.09}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}%
Captions of floating environments will use signature
formation. Nevertheless this does not influence whether they are really
placed at the top or at the bottom of the object. This options also
implies \OptionValue{captions}{tablesignature} and
\OptionValue{captions}{figuresignature}.%
}%
\entry{\PValue{tableheading}, \PValue{tableabove}, \PValue{abovetable},
\PValue{abovetabular}, \PValue{topattable}%
\IndexOption{captions~=\PValue{tableheading}}}{%
Captions of tables will use heading formation\,---\,maybe in discrepancy
to \OptionValue{captions}{signature}.%
}%
\entry{\PValue{tablesignature}, \PValue{belowtable}, \PValue{belowtabular},
\PValue{bottomattable}%
\IndexOption{captions~=\PValue{tablesignature}}}{%
Captions of tables will use signature formation\,---\,maybe in discrepancy
to \OptionValue{captions}{heading}.%
}%
\entry{\PValue{topbeside}, \PValue{besidetop}}{%
Captions and contents of environment \Environment{captionsbeside} (see
\autoref{sec:maincls.floats},
\autopageref{desc:maincls.env.captionbeside}) will be vertically align
depending on the topmost base lines.%
\IndexOption{captions~=\PValue{topbeside}}}%
\end{desclist}%
%
\EndIndex{Option}{captions~=\PName{selection}}%
\begin{Declaration}
\Macro{caption}\OParameter{entry}\Parameter{title}\\
\Macro{captionbelow}\OParameter{entry}\Parameter{title}\\
\Macro{captionabove}\OParameter{entry}\Parameter{title}
\end{Declaration}%
\BeginIndex{Cmd}{caption}%
\BeginIndex{Cmd}{captionabove}%
\BeginIndex{Cmd}{captionbelow}%
In the standard classes caption text \PName{title} of tables and
figures is inserted with the \Macro{caption} command below the table
or figure. In general this is correct for figures. Opinions differ as
to whether captions of tables are to be placed above or, consistent
with captions of figures\Index{caption>of figure}, below the
table\Index{caption>of table}. That is the reason why
{\KOMAScript}\textnote{\KOMAScript{} vs. standard classes},
unlike the standard classes, offers \Macro{captionbelow} for captions
below and \Macro{captionabove} for captions above tables or
figures.
Not only for tables but also for figures or all kind of floating environments
the behaviour of \Macro{caption} may be modified using option
\Option{captions}\IndexOption{captions} described at the beginning of this
section. For
compatibility reasons the default behaviour of \Macro{caption} used
with all kinds of floating environments is similar to
\Macro{captionbelow}. Nevertheless it
is recommended\textnote{Hint!} to use table headings and therefor switch
behaviour of \Macro{caption} inside table environments into
\Macro{captionabove} using option
\OptionValue{captions}{tableheading}. Alternatively you may use
\Macro{captionabove} instead of \Macro{caption} inside of every
\Environment{table} environment.
%
\begin{Example}
Instead of using captions below a table you want to place your
captions above it\Index{table>caption}, because you have tables
which span more then one page. In the standard classes you could
only write:
\begin{lstcode}
\begin{table}
\caption{This is an example table}
\begin{tabular}{llll}
This & is & an & example.\\\hline
This & is & an & example.\\
This & is & an & example.
\end{tabular}
\end{table}
\end{lstcode}
Then you would get the unsatisfying result:
\begin{ShowOutput}\centering
{\usekomafont{caption}{\usekomafont{captionlabel}\tablename~30.2:}
This is an example table.}\\
\begin{tabular}{llll}
This & is & an & example.\\\hline
This & is & an & example.\\
This & is & an & example.
\end{tabular}
\end{ShowOutput}
Using {\KOMAScript} you write instead:
\begin{lstcode}
\begin{table}
\captionabove{This is just an example table}
\begin{tabular}{llll}
This & is & an & example.\\\hline
This & is & an & example.\\
This & is & an & example.
\end{tabular}
\end{table}
\end{lstcode}
Then you get:
\begin{ShowOutput}\centering
{\usekomafont{caption}{\usekomafont{captionlabel}\tablename~30.2:}
This is just an example table}\\\vskip\abovecaptionskip
\begin{tabular}{llll}
This & is & an & example.\\\hline
This & is & an & example.\\
This & is & an & example.
\end{tabular}
\end{ShowOutput}
Since you want all your tables typeset with captions above, you could
of course use the option \OptionValue{captions}{tableheading} instead (see
\autopageref{desc:maincls.option.captions.tableheading}). Then you can use
\Macro{caption} as you would in the standard classes. You will get
the same result as with \Macro{captionabove}.
\end{Example}
\BeginIndex[indexother]{}{font>style}%
\BeginIndex{FontElement}{caption}%
\BeginIndex{FontElement}{captionlabel}%
The font style\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} for the
description and the label\,---\,``Figure'' or ``Table'', followed by
the number and the delimiter\,---\,can be changed with the commands
\Macro{setkomafont}
and \Macro{addtokomafont} (see \autoref{sec:maincls.textmarkup},
\autopageref{desc:maincls.cmd.setkomafont}). The respective elements for
this are \FontElement{caption}\important{\FontElement{caption}} and
\FontElement{captionlabel}\important{\FontElement{captionlabel}} (see
\autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}). First the font style
for the element \FontElement{caption} is applied to the element
\FontElement{captionlabel} too. After this the font style of
\FontElement{captionlabel} is applied on the respective element. The
default settings are listed in \autoref{tab:maincls.captionFont}.
%
\begin{table}
% \centering%
\KOMAoptions{captions=topbeside}%
\setcapindent{0pt}
% \caption
\begin{captionbeside}
{Font defaults for the elements of figure or table captions}
[l]
\begin{tabular}[t]{ll}
\toprule
element & default \\
\midrule
\FontElement{caption} & \Macro{normalfont} \\
\FontElement{captionlabel} & \Macro{normalfont}\\
\bottomrule
\end{tabular}
\end{captionbeside}
\label{tab:maincls.captionFont}
\end{table}
%
\begin{Example}
You want the table and figure descriptions typeset in a smaller font
size. Thus you could write the following in the preamble of your
document:
\begin{lstcode}
\addtokomafont{caption}{\small}
\end{lstcode}
Furthermore, you would like the labels to be printed in sans serif and
bold. You add:
\begin{lstcode}
\setkomafont{captionlabel}{\sffamily\bfseries}
\end{lstcode}
As you can see, simple extensions of the default definitions are
possible.
\end{Example}
%
\EndIndex{FontElement}{captionlabel}%
\EndIndex{FontElement}{caption}%
\EndIndex[indexother]{}{font>style}%
%
\EndIndex{Cmd}{caption}%
\EndIndex{Cmd}{captionabove}%
\EndIndex{Cmd}{captionbelow}%
\begin{Declaration}
\Macro{captionof}\Parameter{float type}\OParameter{entry}%
\Parameter{title}\\
\Macro{captionbelowof}\Parameter{float type}\OParameter{entry}%
\Parameter{title}\\
\Macro{captionaboveof}\Parameter{float type}\OParameter{entry}%
\Parameter{title}
\end{Declaration}%
\BeginIndex{Cmd}{captionof}%
\BeginIndex{Cmd}{captionaboveof}%
\BeginIndex{Cmd}{captionbelowof}%
\KOMAScript{} supports a command
\Macro{captionof}\ChangedAt{v3.05}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} similar to packages
\Package{caption}\IndexPackage{caption} and
\Package{capt-of}\IndexPackage{capt-of}. You may use this command to place a
floating environment caption with corresponding entry into the list of that
kind of floating environment but even inside a another floating environment or
outside any floating environment. In difference to \Macro{caption} the kind of
floating environment has to be set as first parameter.
Furthermore, \KOMAScript{} provides the additional commands
\Macro{captionaboveof}\ChangedAt{v3.09}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} and \Macro{captionbelowof}. These are
like \Macro{captionabove} and \Macro{captionbelow} but with the additional
features and parameter of \Macro{captionof}.
Of course \KOMAScript\ChangedAt{v3.09a}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} takes care of the \PValue{heading}
and \PValue{signature} setting of option
\Option{captions}. But this feature may be lost, loading package
\Package{capt-of} or \Package{caption}. Please note the manual of package
\Package{caption} for this!
%
\begin{Example}
Assumed you want to create a floating object with a table and a figure side
by side. As you know, there are now mixed floating environment. Therefor you
use a \Environment{figure} environment primarily:
\begin{lstcode}
\begin{figure}
\begin{minipage}{.5\linewidth}
\centering
\rule{4cm}{3cm}
\caption{A rectangle}\label{fig:rechteck}
\end{minipage}%
\begin{minipage}{.5\linewidth}
\centering
\captionaboveof{table}
[Measure of the rectangle in
figure~\ref{fig:rechteck}]%
{Measure of the rectangle}
\label{tab:rechteck}
\begin{tabular}{ll}
Width: & 4\,cm\\
Height: & 3\,cm
\end{tabular}
\end{minipage}
\end{figure}
\end{lstcode}
Two \Environment{minipage} environments have been used to have figure and
table side by side. The\textnote{Attention!} percent char after the end of
the first \Environment{minipage} is important. Without an additional
inter-word distance would be made between the \Environment{minipage}
environments.
The figure signature has been done using \Macro{caption}. The table heading
has been done using \Macro{captionaboveof} with first argument
\PValue{table}. Because of this \KOMAScript{} knows, that despite the
\Environment{figure} environment a table caption should be made.
The optional argument of \Macro{captionaboveof} does make the entry into the
list of tables. Without the optional argument, the last mandatory argument
would have been used for the list of tables too. Although this caption text
is sufficient for the environment itself, it would be very useful at the
list of tables. Therefor a somehow more detailed description has been used
for the list of tables using the optional argument. The
\autoref{fig:maincls.captionaboveof} shows the result of the example code.%
\begin{figure}
% \centering
% \caption
\KOMAoptions{captions=bottombeside}%
\setcapindent{0pt}%
\begin{captionbeside}
[{Example: Usage of \Macro{captionaboveof} inside another floating
environment}]
{Example: Usage of \Macro{captionaboveof} inside another floating
environment\label{fig:maincls.captionaboveof}}
[l]
\begin{minipage}[b]{.66\linewidth}%
\raisebox{\depth}{\fbox{\KOMAoptions{captions=oneline}%
\begin{minipage}{.5\dimexpr\linewidth-2\fboxsep-2\fboxrule\relax}
\centering
\rule{4cm}{3cm}
\caption[Example: A rectangle]{A rectangle}\label{fig:maincls.rechteck}
\end{minipage}%
\begin{minipage}{.5\dimexpr\linewidth-2\fboxsep-2\fboxrule\relax}
\centering
\captionaboveof{table}[Example: Measure of the rectangle in
figure~\ref{fig:maincls.rechteck}]{Rectangle size}
\label{tab:maincls.rechteck}
\begin{tabular}{ll}
Width: & 4\,cm\\
Height: & 3\,cm
\end{tabular}
\end{minipage}}}%
\end{minipage}%
\end{captionbeside}%
\end{figure}%
\end{Example}%
A non-floating table with a caption may be produced in the same kind like the
table inside a figure environment in the example above. In such a case also a
\Environment{minipage} environment should be used, to avoid page breaks
between table caption an tabular. An additional \Environment{flushleft}
environment around the \Environment{minipage} environment may be used, to have
a pleasing distance above and below is and to avoid the paragraph indentation
of the \Environment{minipage} environment.%
%
\EndIndex{Cmd}{captionof}%
\EndIndex{Cmd}{captionaboveof}%
\EndIndex{Cmd}{captionbelowof}%
\begin{Declaration}
\XMacro{begin}\PParameter{\Environment{captionbeside}}%
\OParameter{entry}\Parameter{title}\texttt{\%}\\
\hphantom{\XMacro{begin}\PParameter{captionbeside}}%
\OParameter{placement}\OParameter{width}%
\OParameter{offset}\\%
\quad\dots\\
\XMacro{end}\PParameter{captionbeside}\\
\XMacro{begin}\PParameter{captionbeside}\OParameter{entry}%
\Parameter{title}\texttt{\%}\\
\hphantom{\XMacro{begin}\PParameter{captionbeside}}%
\OParameter{placement}\OParameter{width}%
\OParameter{offset}\PValue{*}\\
\quad\dots\\
\XMacro{end}\PParameter{captionbeside}
\end{Declaration}
\BeginIndex{Env}{captionbeside}%
Apart\ChangedAt{v2.8q}{%
\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} from
captions above and below the figure, one often finds captions, in
particular with small figures, which are placed beside the figure. In
general in this case both the baseline of the figure and of the
caption are aligned at the bottom. With some fiddling and the use of
two \Macro{parbox} commands this could also be achieved in the
standard classes. However, {\KOMAScript} offers a special environment
for this which can be used within the floating environment. The first
optional parameter \PName{entry} and the obligatory parameter
\PName{title} mean the same as the corresponding parameters of
\Macro{caption}, \Macro{captionabove} or \Macro{captionbelow}. The
caption text \PName{title} is placed beside the content of the
environment in this case.
Whether the caption text \PName{title} is placed on the left or the
right can be determined by the parameter \PName{placement}. Exactly
one of the following letters is allowed:
\begin{labeling}[~--]{\quad\PValue{o}}\setlength{\itemsep}{0pt}%
\item[\PValue{l}] left
\item[\PValue{r}] right
\item[\PValue{i}] inner margin in two-sided layout
\item[\PValue{o}] outer margin in two-sided layout
\end{labeling}
Default setting is to the right of the content of the environment. This
default\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} my be changed using option
\Option{captions}\IndexOption{captions}\important{\Option{captions}} (see
\autopageref{desc:maincls.option.captions}) with values like
\PValue{innerbeside}\IndexOption[indexmain]{captions~=\PValue{innerbeside}},
\PValue{leftbeside}\IndexOption[indexmain]{captions~=\PValue{leftbeside}},
\PValue{outerbeside}\IndexOption[indexmain]{captions~=\PValue{outerbeside}},
and
\PValue{rightbeside}\IndexOption[indexmain]{captions~=\PValue{rightbeside}}.
If either \PValue{o} or \PValue{i} are used you may need to run {\LaTeX} twice
to obtain the correct placement.
Per default the content of the environment and the caption text
\PName{title} fill the entire available text width. However, using the
optional parameter \PName{width}, it is possible to adjust the width
used. This width could even be larger than the current text width.
When supplying a \PName{width} the used width is usually centered with
respect to the text width. Using the optional parameter
\PName{offset}, you can shift the environment relative to the left
margin. A positive value corresponds to a shift to the right, whereas
a negative value corresponds to a shift to the left. An \PName{offset}
of 0\Unit{pt} gives you a left-aligned output.
Adding a star to the optional parameter \PName{offset} makes the the
value mean a shift relative to the right margin on left hand pages in
two-sided layout. A positive value corresponds to a shift towards the
outer margin, whereas a negative value corresponds to a shift towards
the inner margin. An \PName{offset} of 0\Unit{pt} means alignment with
the inner margin. As mentioned before, in some cases it takes two
{\LaTeX} runs for this to work correctly.
The default vertical alignment is bottom. This means that the bottommost base
lines of the contents of the environment and of the caption are aligned. This
setting\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} may be changed using option
\Option{captions}\IndexOption{captions} (see
\autopageref{desc:maincls.option.captions}) with value
\PValue{topbeside}\IndexOption[indexmain]{captions~=\PValue{topbeside}},
\PValue{centeredbeside}%
\IndexOption[indexmain]{captions~=\PValue{centeredbeside}}, or
\PValue{bottombeside}\IndexOption[indexmain]{captions~=\PValue{bottombeside}}. With
setting \PValue{topbeside} the topmost base lines of the environment contents
and caption will be aligned. With \PValue{centeredbeside} they will be
centered vertically. In this context it should be known, that the base line of
a pictures is mostly at the bottom of the picture. This may be changed,
e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
\begin{Example}
An example for the usage of the \Environment{captionbeside} environment
can be found in \autoref{fig:maincls.captionbeside}.
This figure was typeset with:
\begin{lstcode}
\begin{figure}
\begin{captionbeside}[Example: Figure beside description]%
{A figure description which is neither above nor
below, but beside the figure}[i][\linewidth][%
[i][\linewidth][%
\dimexpr\marginparwidth+\marginparsep\relax]*
\fbox{%
\parbox[b][5\baselineskip][c]{.25\textwidth}
{%
\hspace*{\fill}\KOMAScript
\hspace*{\fill}\par
}%
}
\end{captionbeside}
\label{fig:maincls.captionbeside}
\end{figure}
\end{lstcode}
\begin{figure}
\begin{captionbeside}[Example: Figure beside description]%
{A figure description which is neither above nor
below, but beside the figure}[i][\linewidth][2em]*
\fbox{%
\parbox[b][5\baselineskip][c]{.25\textwidth}{%
\hspace*{\fill}\KOMAScript\hspace*{\fill}\par}}
\end{captionbeside}
\label{fig:maincls.captionbeside}
\end{figure}
The total width is thus the currently available width
\PValue{\Macro{linewidth}}. However, this width is shifted
\PValue{2em} to the outside. The caption text or description is
placed on the inner side beside the figure. The figure itself is
shifted 2\Unit{em} into the outer margin.
With \Macro{dimexp} a \eTeX{} command has been used. This should not be a
problem at all, because \KOMAScript{} itself needs \eTeX{} and every almost
up-to-date \LaTeX{} distribution uses \eTeX already.
\hyperref[fig:maincls.captionbesidecentered]%
{Figure~\ref*{fig:maincls.captionbesidecentered}}
shows a centered caption with:
\begin{lstcode}
\KOMAoption{captions}{centeredbeside}
\end{lstcode}
Even if you are not a typographer you may see, that this is not a
recommended suggestion.
\begin{figure}
\begin{captionbeside}[Example: Description centered beside figure]%
{A figure description which is neither above nor
below, but centered beside the figure}[i][\linewidth][2em]*
\fbox{%
\parbox[b][5\baselineskip][c]{.25\textwidth}{%
\hspace*{\fill}\KOMAScript\hspace*{\fill}\par}}
\end{captionbeside}
\label{fig:maincls.captionbesidecentered}
\end{figure}
In opposite to the centered example, the top aligned from
\autoref{fig:maincls.captionbesidetop} may be used. To show how to change
the baseline using \Macro{raisebox}, the complete example code follows:
\begin{lstcode}
\documentclass[captions=topbeside]{scrbook}
\usepackage[english]{babel}
\usepackage{graphics}
\begin{document}
\chapter{An Example}
\begin{figure}
\begin{captionbeside}%
[Example: Figure title top beside]%
{A figure description which is neither above nor
below, but top beside the figure}%
[i][\linewidth][%
\dimexpr\marginparwidth+\marginparsep\relax
]*
\raisebox{%
\dimexpr\baselineskip-\totalheight\relax
}{%
\includegraphics{examplepicture}%
}%
\end{captionbeside}
\label{fig:maincls.captionbesidetop}
\end{figure}
\end{document}
\end{lstcode}
\begin{figure}
\KOMAoption{captions}{topbeside}
\begin{captionbeside}[Example: Figure title top beside]%
{A figure description which is neither above nor
below, but top beside the figure}%
[i][\linewidth]
\raisebox{\dimexpr\baselineskip-\totalheight}{%
\fbox{%
\parbox[b][5\baselineskip][c]{.25\textwidth}{%
\hspace*{\fill}\KOMAScript\hspace*{\fill}\par}}%
}%
\end{captionbeside}
\label{fig:maincls.captionbesidetop}
\end{figure}
You may use such a movement not only at graphics replacements like show, but
also using \Macro{includegraphics} (see \cite{package:graphics}).
\end{Example}
%
\EndIndex{Env}{captionbeside}
\begin{Declaration}
\XMacro{begin}\PParameter{\Environment{captionofbeside}}%
\Parameter{float type}%
\OParameter{entry}\Parameter{title}\texttt{\%}\\
\hphantom{\XMacro{begin}\PParameter{captionofbeside}}%
\OParameter{placement}\OParameter{width}%
\OParameter{offset}\\%
\quad\dots\\
\XMacro{end}\PParameter{captionofbeside}\\
\XMacro{begin}\PParameter{captionofbeside}\Parameter{float type}%
\OParameter{entry}%
\Parameter{title}\texttt{\%}\\
\hphantom{\XMacro{begin}\PParameter{captionofbeside}}%
\OParameter{placement}\OParameter{width}%
\OParameter{offset}\PValue{*}\\
\quad\dots\\
\XMacro{end}\PParameter{captionofbeside}
\end{Declaration}
\BeginIndex{Env}{captionofbeside}%
This\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} environment corresponds to \Environment{captionbeside}
in the same manner like \Macro{captionof} corresponds to
\Macro{caption}. The float type is not defined by a floating environment but
by the first mandatory argument.%
%
\EndIndex{Env}{captionofbeside}%
\begin{Declaration}
\FloatStyle{komaabove}\\
\FloatStyle{komabelow}
\end{Declaration}%
\BeginIndex{Floatstyle}{komaabove}%
\BeginIndex{Floatstyle}{komabelow}%
If you use\OnlyAt{\Package{float}} the \Package{float}\IndexPackage{float}
package the appearance of the float environments is solely defined by the
\emph{float} style. This includes whether captions above or below are used. In
the \Package{float} package there is no predefined style which gives you the
same output and offers the same setting options (see below) as {\KOMAScript}.
Therefore {\KOMAScript} defines the two additional styles \PValue{komaabove}
and \PValue{komabelow}. When using the \Package{float} package these styles
can be activated just like the styles \PValue{plain}\IndexFloatstyle{plain},
\PValue{boxed}\IndexFloatstyle{boxed} or \PValue{ruled}\IndexFloatstyle{ruled}
defined in \Package{float}. For details refer to \cite{package:float}. The
style \PValue{komaabove} inserts \Macro{caption}, \Macro{captionabove} and
\Macro{captionbelow} above, whereas \PValue{komabelow} inserts them below the
float content.
%
\EndIndex{Floatstyle}{komaabove}%
\EndIndex{Floatstyle}{komabelow}%
\begin{Declaration}
\Macro{captionformat}
\end{Declaration}%
\BeginIndex{Cmd}{captionformat}%
In {\KOMAScript} there are different ways to change the formatting of
the caption text. The definition of different font styles was already
explained above. This or the caption delimiter between the label and
the label text itself is specified in the macro \Macro{captionformat}.
In contrast to all other \Macro{\dots}format commands, in this case it
does not contain the counter but only the items which follow it. The
original definition is:
\begin{lstcode}
\newcommand*{\captionformat}{:\ }
\end{lstcode}
This too can be changed with \Macro{renewcommand}.
\begin{Example}
For some inexplicable reasons you want a dash with spaces before and
after instead of a colon followed by a space as label delimiter. You
define:
\begin{lstcode}
\renewcommand*{\captionformat}{~--~}
\end{lstcode}
This definition should be put in the preamble of your document.
\end{Example}
%
\EndIndex{Cmd}{captionformat}%
\begin{Declaration}
\Macro{figureformat}\\
\Macro{tableformat}
\end{Declaration}%
\BeginIndex{Cmd}{figureformat}%
\BeginIndex{Cmd}{tableformat}%
It was already mentioned that \Macro{captionformat} does not contain
formatting for the label itself. This situation should under no
circumstances be changed using redefinitions of the commands for the
output of counters, \Macro{thefigure} or \Macro{thetable}. Such a
redefinition would have unwanted side effects on the output of
\Macro{ref} or the table of contents, list of figures and list of
tables. To deal with the situation, {\KOMAScript} offers two
\Macro{\dots format} commands instead. These are predefined as
follows:
% Umbruchkorrektur: listings
\begin{lstcode}[belowskip=\dp\strutbox]
\newcommand*{\figureformat}{\figurename~\thefigure\autodot}
\newcommand*{\tableformat}{\tablename~\thetable\autodot}
\end{lstcode}
They also can be adapted to your personal preferences with
\Macro{renewcommand}.
\begin{Example}
From time to time captions without any label and of course without
delimiter are desired. In {\KOMAScript} it takes only the following
definitions to achieve this:
\begin{lstcode}
\renewcommand*{\figureformat}{}
\renewcommand*{\tableformat}{}
\renewcommand*{\captionformat}{}
\end{lstcode}
It should be noted, however, that although no numbering is output, the
internal counters are nevertheless incremented. This becomes important
especially if this redefinition is applied only to selected
\Environment{figure} or \Environment{table} environments.
\end{Example}
%
\EndIndex{Cmd}{figureformat}%
\EndIndex{Cmd}{tableformat}%
\begin{Declaration}
\Macro{setcapindent}\Parameter{indent}\\
\Macro{setcapindent*}\Parameter{xindent}\\
\Macro{setcaphanging}
\end{Declaration}%
\BeginIndex{Cmd}{setcapindent}%
\BeginIndex{Cmd}{setcapindent*}%
\BeginIndex{Cmd}{setcaphanging}%
As mentioned previously, in the standard classes the captions are set
in a non-hanging style, that is, in multi-line captions the second and
subsequent lines start directly beneath the label. The standard
classes provide no direct mechanism to change this behaviour. In
{\KOMAScript}, on the contrary, beginning at the second line all lines
are indented by the width of the label so that the caption text is
aligned.
This behaviour, which corresponds to the usage of \Macro{setcaphanging}, can
easily be changed by using the command \Macro{setcapindent} or
\Macro{setcapindent*}. Here the parameter \PName{indent} determines the
indentation of the second and subsequent lines. If you want a line break after
the label and before the caption text, then you can define the indentation
\PName{xindent} of the caption text with the starred version of the command
instead: \Macro{setcapindent*}.
Using a negative value of \PName{indent} instead, a line break is also
inserted before the caption text and only the first line of the
caption text but not subsequent lines are indented by
the absolute value of \PName{indent}.
Whether one-line captions are set as captions with more than one line or are
treated separately is specified with the option \Option{captions}. For details
please refer to the explanations of these option at
\autopageref{desc:maincls.option.captions.oneline}.
\begin{Example}
For the examples please refer to
figures~\ref{fig:maincls.caption.first} to
\ref{fig:maincls.caption.last}. As you can see the usage of a fully
hanging indentation is not advantageous when combined with narrow
column width. To illustrate, the source code for the second figure
is given here with a modified caption text:
\begin{lstcode}
\begin{figure}
\setcapindent{1em}
\fbox{\parbox{.95\linewidth}{\centering{\KOMAScript}}}
\caption{Example with slightly indented caption
starting at the second line}
\end{figure}
\end{lstcode}
As can be seen the formatting can also be changed locally within the
\Environment{figure} environment\IndexEnv{figure}. The change then
affects only the current figure. Following figures once again use the
default settings or global settings set, for example, in the preamble
of the document. This also of course applies to tables.
\begin{figure}
\typeout{^^J--- Ignore underfull and overfull \string\hbox:}
\addtokomafont{caption}{\small}
\addtokomafont{captionlabel}{\bfseries}
\centering%
\begin{minipage}{.9\linewidth}
\begin{minipage}[t]{.48\linewidth}\sloppy
\fbox{\parbox{.95\linewidth}{\centering{\KOMAScript}}}
\caption[Example: Default figure caption]%
{\sloppy Equivalent to the standard setting, similar to the
usage of \Macro{setcaphanging}}
\label{fig:maincls.caption.first}
\end{minipage}
\hspace{.02\linewidth}
\begin{minipage}[t]{.48\linewidth}\sloppy
\setcapindent{1em}
\fbox{\parbox{.95\linewidth}{\centering{\KOMAScript}}}
\caption[Example: Figure caption with slightly hanging indention]%
{With slightly hanging indentation starting at the second line
using \Macro{setcapindent}\PParameter{1em}}
\end{minipage}
\end{minipage}
\vspace*{2ex}\noindent%
\begin{minipage}{.9\linewidth}
\begin{minipage}[t]{.48\linewidth}\sloppy
\setcapindent*{1em}
\fbox{\parbox{.95\linewidth}{\centering{\KOMAScript}}}
\caption[Example: Figure caption with hanging indention and line
break]%
{With hanging indentation starting at the second line and line
break before the description using
\Macro{setcapindent*}\PParameter{1em}}
\end{minipage}
\hspace{.02\linewidth}
\begin{minipage}[t]{.48\linewidth}\sloppy
\setcapindent{-1em}
\fbox{\parbox{.95\linewidth}{\centering{\KOMAScript}}}
\caption[Example: Figure caption with hanging indention at the second
line]%
{With indentation in the second line only and line break
before the description using
\Macro{setcapindent}\PParameter{-1em}}
\label{fig:maincls.caption.last}
\end{minipage}
\end{minipage}
\typeout{^^J--- Don't ignore underfull and overfull
\string\hbox:^^J}
\end{figure}
\end{Example}
%
\EndIndex{Cmd}{setcapindent}%
\EndIndex{Cmd}{setcapindent*}%
\EndIndex{Cmd}{setcaphanging}%
\begin{Declaration}
\Macro{setcapwidth}\OParameter{justification}\Parameter{width}\\
\Macro{setcapmargin}\OParameter{margin left}\Parameter{margin}\\
\Macro{setcapmargin*}\OParameter{margin inside}\Parameter{margin}
\end{Declaration}
\BeginIndex{Cmd}{setcapwidth}%
\BeginIndex{Cmd}{setcapmargin}%
\BeginIndex{Cmd}{setcapmargin*}%
Using\ChangedAt{v2.8q}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} these three
commands you can specify the width and justification of the caption
text. In general the whole text width or column width is available
for the caption.
With\important{\Macro{setcapwidth}} the command \Macro{setcapwidth} you can
decrease this \PName{width}. The obligatory argument determines the maximum
\PName{width} of the caption. As an optional argument you can supply exactly
one letter which specifies the horizontal justification. The possible
justifications are given in the following list.
\begin{labeling}[~--]{\quad\PValue{o}}\rightskip=1em
\item[\PValue{l}] left-aligned
\item[\PValue{c}] centered
\item[\PValue{r}] right-aligned
\item[\PValue{i}] alignment at the inner margin in double-sided output
\item[\PValue{o}] alignment at the outer margin in double-sided output
\end{labeling}
The justification inside and outside corresponds to left-aligned and
right-aligned, respectively, in single-sided
output. Within\textnote{Attention!}
\Package{longtable}\IndexPackage{longtable}%
\important{\Package{longtable}} tables the justification inside or outside
does not work correctly. In particular, the captions on subsequent pages of
such tables are aligned according to the format of the caption on the first
page of the table. This is a conceptual problem in the implementation of
\Package{longtable}.
With\important{\Macro{setcapmargin}} the command \Macro{setcapmargin} you can
specify a \PName{margin} which is to be left free next to the description in
addition to the normal text margin. If you want margins with different widths
at the left and right side you can specify these using the optional argument
\PName{margin left}. The starred version \Macro{setcapmargin*} defines instead
of a \PName{margin left} a \PName{margin inside} in a double-sided layout. In
case of \Package{longtable}\IndexPackage{longtable}%
\important{\Package{longtable}} tables you have to deal with the same problem
with justification inside or outside as mentioned with the macro
\Macro{setcapwidth}. Furthermore, the usage of \Macro{setcapmargin} or
\Macro{setcapmargin*} switches on the option \OptionValue{captions}{nooneline}
(see \autopageref{desc:maincls.option.captions.nooneline}) for the captions
which are typeset with this margin setting.
You\textnote{Hint!} can also submit negative values for \PName{margin} and
\PName{margin left} or \PName{margin inside}. This has the effect of the
caption expanding into the margin.
Experts\textnote{Hint!} and advanced users may find a tricky usage of
\Macro{setcapwidth} in
\iffree{\cite{book:komascript}}{\autoref{cha:floattricks},
\autopageref{cha:floattricks}}.%
%
\EndIndex{Cmd}{setcapwidth}%
\EndIndex{Cmd}{setcapmargin}%
\EndIndex{Cmd}{setcapmargin*}%
\begin{Declaration}
\Option{origlongtable}
\end{Declaration}%
\BeginIndex{Option}{origlongtable}%
\BeginIndex{Package}{longtable}%
If the table captions produced by the \Package{longtable} package (see
\cite{package:longtable}) should not be redefined by the {\KOMAScript}
classes, activate the \Option{origlongtable} option. This\textnote{Attention!}
option has to be used at the optional argument of \Macro{documentclass}. It
may not be used as a setting of \Macro{KOMAoptions} or \Macro{KOMAoptions}.
%
\EndIndex{Package}{longtable}%
\EndIndex{Option}{origlongtable}%
\begin{Declaration}
\KOption{listof}\PName{setting}
\end{Declaration}
\BeginIndex{}{tables>list of}\BeginIndex{}{list of>tables}%
\BeginIndex{}{figures>list of}\BeginIndex{}{list of>figures}%
\BeginIndex{Option}{listof~=\PName{setting}}%
Normally\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} lists of floating environments\,---\,like list of
tables or list of
figures will neither get an
entry at the table of contents nor have a number at the heading. More
information about that may be found in \autoref{sec:maincls.toc}. Alternative
to the view from the table of contents to the lists of floating environments,
you may reconsider a view from the lists of floating environments into the
table of contents. Because of this, there are not only the options
\OptionValue{toc}{nolistof}\IndexOption{toc~=\PValue{nolistof}},
\OptionValue{toc}{listof}\IndexOption{toc~=\PValue{listof}}, and
\OptionValue{toc}{listofnumbered}\IndexOption{toc~=\PValue{listofnumbered}}
described in \autoref{sec:maincls.toc},
\autopageref{desc:maincls.option.toc.listof}, but also
\OptionValue{listof}{notoc}, \OptionValue{listof}{totoc}, and
\OptionValue{listof}{numbered} with the same meaning.
By default the headings of the lists of floating environments use the topmost
level below \Macro{part}. This is the chapter level at \Class{scrbook} and
\Class{scrreprt} and the section level at
\Class{scrartcl}. With\ChangedAt{v3.06}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}}
\OptionValue{listof}{leveldown}\important{\OptionValue{listof}{leveldown}} a
one step lower level will be used instead.
\begin{Example}
At a book you want to move the list of figures and the list of tables as
sub-lists into a common list named ``Figures and Tables''. With
\begin{lstcode}
\KOMAoption{listof}{leveldown}
\end{lstcode}
you first declare to use the section instead of the chapter level for both
lists and then you use:
\begin{lstcode}
\addchap*{Figures and Tables}
\listoffigures
\listoftables
\end{lstcode}
for the new list, that contains the list of figures and the list of
tables. More information about the command \Macro{addchap*} may be found in
\autoref{sec:maincls.structure} at \autopageref{desc:maincls.cmd.addchap*}.
\end{Example}
Normally\ChangedAt{v2.8q}{%
\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} the lists of
floating environments use a constant with to place the caption number of the
entries. Additionally all entries will be indented a little bit. This
corresponds to setting
\OptionValue{listof}{graduated}\IndexOption{listof~=\PValue{graduated}}.
If the numbers of the figures or tables, become very wide\,---\,i.\,e., if you
have a lot of tables or figures\,---\, their may be not enough width
predefined. There's\important{\OptionValue{listof}{flat}} a setting
\OptionValue{listof}{flat}\IndexOption{listof~=\PValue{flat}} for the lists of
floating environment similar to
\OptionValue{toc}{flat}\IndexOption{toc~=\PValue{flat}} for the table of
contents. Thereby the needed with for printing the number will be determined
at each \LaTeX{} run. See option \OptionValue{toc}{flat},
\autoref{sec:maincls.toc}, \autopageref{desc:maincls.option.toc.flat} for
information about how it works. Please\textnote{Attention!} note again, that
you need more than one \LaTeX{} runs until the lists of floating environments
will become their final result.
Setting \OptionValue{listof}{entryprefix}\ChangedAt{v3.06}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} will automatically activate
\OptionValue{listof}{flat}
too. Normally\important{\OptionValue{listof}{entryprefix}} it would not make
sense to add the prefix ``figure'' to each entry of the list of figures and
the prefix ``table'' to each entry of the list of tables, because nothing else
than figures would be and should be expected at the list of figures and
nothing else than tables would be and should be expected at the list of
tables. So this prefixes would not give any additional information and for this
would not be useful. Nevertheless, such prefixes may be added using option
\OptionValue{listof}{entryprefix}. With this all entries of the same list will
get the same prefix. The prefix will depend on the file extension of the
helper file, that will be used for the corresponding list. For the list of
figures the file extension would be ``\File{lof}'' and therefor
\Macro{listoflofentryname} would be used. For the list of tables, the file
extension would be ``\File{lot}'' and \Macro{listoflotentryname} would be
used.
Within classes \Class{scrbook} and \Class{scrreprt}\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}} \KOMAScript{} adds a vertical gap to the lists of floating
environments whenever a new chapter starts. This behaviour, that is same at
the standard classes, structures the lists by chapters. At \KOMAScript{} it
corresponds to setting \ChangedAt{v3.00}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}}
\OptionValue{listof}{chaptergapsmall}%
\IndexOption{listof~=\PValue{chaptergapsmall}}. In this case a gap of width
10\Unit{pt} will be used. With\important{\OptionValue{listof}{chaptergapline}}
option \OptionValue{listof}{chaptergapline}%
\IndexOption{listof~=\PValue{chaptergapline}} a gap of the height of one
standard text line will be
used. The\important{\OptionValue{listof}{nochaptergap}} gap may be switched of
with \OptionValue{listof}{nochaptergap}%
\IndexOption{listof~=\PValue{nochaptergap}}. Option\important{\OptionValue{listof}{chapterentry}}
\OptionValue{listof}{chapterentry}%
\IndexOption{listof~=\PValue{chapterentry}} is somehow special. Instead of a
gap it adds the table of contents entry for the chapter additionally to the
lists of floating environments. Please\textnote{Attention!} note, that this
would also happen, if the chapter does not have any floating
environment. Additional influence of chapters to the lists of floating
environments is available with option \Option{chapteratlists}. See
\autoref{sec:maincls.structure},
\autopageref{desc:maincls.option.chapteratlists} for more information about
that.
An overview about all settings to option \Option{listof} may be found at
\autoref{tab:maincls.listof}.
\begin{desclist}
\desccaption[{Available values for option \Option{listof}}]{%
Available values for option \Option{listof} to modify contents and
formation of the lists of floating environments\label{tab:maincls.listof}%
}{%
Available values for option \Option{listof} (\emph{continuation})%
}%
\entry{\PValue{chapterentry}, \PValue{withchapterentry}}{%
Marks chapter starts at the lists of floating environments by a copy of
their entries to the table of contents.%
\IndexOption{listof~=\PValue{chapterentry}}}%
\entry{\PValue{chaptergapline}, \PValue{onelinechaptergap}}{%
Marks chapter starts at the lists of floating environments by a vertical
gap of the height of one standard text line.%
\IndexOption{listof~=\PValue{chaptergapline}}}%
\entry{\PValue{chaptergapsmall}, \PValue{smallchaptergap}}{%
Marks chapter starts at the lists of floating environments by a small
vertical gap.%
\IndexOption{listof~=\PValue{chaptergapsmall}}}%
\entry{\PValue{entryprefix}}{%
\ChangedAt{v3.06}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}%
Adds a prefix depending on the file extension of the list to each entry of
the lists of floating environments. The prefix additionally depends on the
language, e.\,g., in English ``Figure'' would be used for the entries to
the list of figures and ``Table'' for the entries to the list of
tables. Both prefixes will be followed by a white space.%
\IndexOption{listof~=\PValue{entryprefix}}}%
\entry{\PValue{flat}, \PValue{left}}{%
The lists of floating environments will be printed like a kind of
table. The caption numbers will be the first column, the caption texts the
second column, and the page numbers the last column. The width of the first
column depends on the previous \LaTeX{} run.%
\IndexOption{listof~=\PValue{flat}}}%
\entry{\PValue{graduated}, \PValue{indent}, \PValue{indented}}{%
The lists of floating environments will be printed in hierarchical
form. The width for the caption numbers will be limited.%
\IndexOption{listof~=\PValue{graduated}}}%
\entry{\PValue{leveldown}}{%
The lists of floating environments will use a heading of one step lower
sectioning level than default.%
\IndexOption{listof~=\PValue{leveldown}}}%
\entry{\PValue{nochaptergap}, \PValue{ignorechapter}}{%
Chapter starts are not marked at the lists of floating environments.%
\IndexOption{listof~=\PValue{nochaptergap}}}%
\entry{\PValue{notoc}, \PValue{plainheading}}{%
The lists of floating environments, e.\,g., list of figures and list of
tables do not generate an entry at the table of contents.%
\IndexOption{listof~=\PValue{notoc}}}%
\entry{\PValue{numbered}, \PValue{totocnumbered}, \PValue{tocnumbered},
\PValue{numberedtotoc}}{%
The lists of floating environments, e.\,g., list of figures and list of
tables, would get a numbered heading and therefor generate an entry at the
table of contents.%
\IndexOption{listof~=\PValue{numbered}}}%
\entry{\PValue{totoc}, \PValue{toc}, \PValue{notnumbered}}{%
The lists of floating environments, e.\,g., list of figures and list of
tables, would generate an entry at the table of contents, but their
headings are not numbered.%
\IndexOption{listof~=\PValue{totoc}}}%
\end{desclist}
%
\EndIndex{Option}{listof~=\PName{setting}}%
\begin{Declaration}
\Macro{listoftables}\\
\Macro{listoffigures}
\end{Declaration}
\BeginIndex{Cmd}{listoftables}%
\BeginIndex{Cmd}{listoffigures}%
These commands generate a list of tables or figures. Changes in the document
that modify these lists will require two {\LaTeX} runs in order to take
effect. The layout of the lists can be influenced by the option
\Option{listof}\important{\Option{listof}} with values \PValue{graduated} or
\PValue{flat} (see \autopageref{desc:maincls.option.listof}). Moreover, the
values \PValue{listof} and \PValue{listofnumbered} of option
\Option{toc}\important{\Option{toc}} (see \autoref{sec:maincls.toc}) as well
as the values \PValue{totoc} and \PValue{numbered} of the previous described
option \Option{listof} have influence to the lists of floating environments.
Mostly\textnote{Hint!} the lists of floating environment may be found after
the table of contents. But some publishers like to have these lists at the
appendix. Nevertheless the author of this guide prefers to find them
immediately after the table of contents.%
\EndIndex{Cmd}{listoftables}%
\EndIndex{Cmd}{listoffigures}%
%
\EndIndex{}{figures>list of}\EndIndex{}{list of>figures}%
\EndIndex{}{tables>list of}\EndIndex{}{list of>tables}%
%
\EndIndex{}{figures}%
\EndIndex{}{tables}%
\EndIndex{}{floats}
\LoadCommon{13}% \section{Margin Notes}
\section{Appendix}
\label{sec:maincls.appendix}
\BeginIndex{}{appendix}
The appendix of a document contains mainly the enclosures to the
document. These are typically bibliography, index, glossary. But only for this
parts nobody would and should start an appendix, because the formation of
these already distinguishes them from the main document. But if there are
additional elements at the appendix, i.\,e., cited third party documents,
endnotes, figures or tabulars, the standard elements like the bibliography
should also be part of the appendix.
\begin{Declaration}
\Macro{appendix}
\end{Declaration}%
\BeginIndex{Cmd}{appendix}%
The appendix in the standard as well as the {\KOMAScript} classes is
introduced with \Macro{appendix}. This command switches, among other things,
the chapter numbering to upper case letters, also ensuring that the rules
according to \cite{DUDEN} are followed (for German-speaking regions). These
rules are explained in more detail in the description of the option
\Option{numbers} in \autoref{sec:maincls.structure},
\autopageref{desc:maincls.option.numbers}.
Die output of the chapter headings\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}} in the appendix are influenced by the options
\Option{chapterprefix} and \Option{appendixprefix}. See
\autoref{sec:maincls.structure},
\autopageref{desc:maincls.option.appendixprefix} for more information.
Please\textnote{Attention!} note that \Macro{appendix} is a command,
\emph{not} an environment! This command does not expect any
argument. Chapters and sections in the appendix uses \Macro{chapter} and
\Macro{section} just as does the main text.%
%
\EndIndex{Cmd}{appendix}%
%
\EndIndex{}{appendix}
\section{Bibliography}
\label{sec:maincls.bibliography}
\BeginIndex{}{bibliography}
The bibliography opens up external resources. Mainly bibliographies will be
made by program \BibTeX{} or biber using an external file in database like
structure. Thereby \BibTeX{} style influences not only the formation of the
bibliography entries but also their sorting. Using an additional bibliography
style like \Package{natbib}\IndexPackage{natbib},
\Package{babelbib}\IndexPackage{babelbib}, or
\Package{biblatex}\IndexPackage{bublatex} limits the influence of
\KOMAScript{} to the bibliography hardly. In such cases it is important so see
the manual of the bibliography package! General information about bibliography
may be found in \cite{lshort}.
\begin{Declaration}
\KOption{bibliography}\PName{selection}
\end{Declaration}
\BeginIndex{Option}{bibliography~=\PName{selection}}%
For a start, \PName{selection}\ChangedAt{v3.00}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} may be any already defined
bibliography formation style. There are two predefined formation styles at
\KOMAScript{}. You should not misconceive them with the styles used by
\BibTeX\Index{BibTeX=\BibTeX} which you may select using
\Macro{bibstyle}. While \BibTeX{} influences not only the sorting but also the
contents of the bibliography, \KOMAScript{} influences only some basic
features of the bibliography or a tiny amount of formation features of the
entries to the bibliography.
Option\important{\OptionValue{bibliography}{oldstyle}}
\OptionValue{bibliography}{oldstyle}%
\IndexOption{bibliography~=\PValue{oldstyle}} selects a compact formation of
the bibliography entries. In this case command
\Macro{newblock}\IndexCmd{newblock} inside of the entries will only result in
a small horizontal distance. The name is a result of the fact, that this is
the mostly used classic kind of bibliography. In opposite to
this\important[i]{\begin{tabular}[t]{@{}l@{}}
\Option{bibliography=}\\
\quad\PValue{openstyle}\end{tabular}}%
\OptionValue{bibliography}{openstyle}%
\IndexOption{bibliography~=\PValue{openstyle}}. selects a more modern and open
kind of bibliography. The name is a result of the fact, that command
\Macro{newblock} inserts a paragraph break. The entries will be more
structured by this. They are less compact and seem more relaxed or
open. Information about definition of new formation styles may be found in
description of command \Macro{newbibstyle} in
\autoref{sec:maincls-experts.experts} at
\autopageref{desc:maincls-experts.cmd.newbibstyle}.
Beside the formation style one more feature may be selected using
\PName{selection}. The bibliography is a kind of contents list. But instead of
listing contents of the document itself, it references to external
contents. Because of this, someone may say, that
the\important[i]{\begin{tabular}[t]{@{}l@{}}
\Option{bibliography=}\\
\quad\PValue{totocnumbered}
\end{tabular}} bibliography is a chapter
or section on its own and should have a chapter or section number. You may
select this with option \OptionValue{bibliography}{totocnumbered}%
\IndexOption{bibliography~=\PValue{totocnumbered}} which will therefor also
generate an entry to the table of contents.In my opinion the bibliography is
nothing you've written on your own and so does not merits a numbered entry to
the table of contents. A entry without number may be set with option
\OptionValue{bibliography}{totoc}%
\IndexOption{bibliography~=\PValue{totoc}}. Nevertheless, the default would be
neither a number nor an entry to the table of contents and corresponds to
\OptionValue{bibliography}{nottotoc}%
\IndexOption{bibliography~=\PValue{nottotoc}}. For more information see option
\Option{toc} in \autoref{sec:maincls.toc}, especially values
\PValue{bibliographynumbered}, \PValue{bibliography}, and
\PValue{nobibliography} to this option at
\autopageref{desc:maincls.option.toc.bibliography}.
Sometimes\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} it is not usefull to have one bibliography for the whole
document but a bibliography at every chapter of a document made using
\Class{scrbook} or \Class{scrreprt}. In that case
you'd\important{\OptionValue{bibliography=leveldown}} need the bibliography
itself not to be a chapter but one level below, a section. You may achieve
this using Option \OptionValue{bibliography}{leveldown}%
\IndexOption{bibliography~=\PValue{leveldown}}. You may use this also if you'd
combine several lists and the bibliography together below one heading. So this
option is also available with \Class{scrartcl}.
A summary of all available values for option \Option{bibliography} may be
found in \autoref{tab:maincls.bibliography}. Nevertheless you should note,
that additional values may be generated using
\Macro{newbibstyle}\IndexCmd{newbibstyle}.
\begin{table}
\caption[{Available values of option \Option{bibliography}}]{%
Predefined values of option \Option{bibliography} to select the formation
of the bibliography}
\label{tab:maincls.bibliography}
\begin{desctabular}
\pventry{leveldown}{%
\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}%
The bibliography will use a heading of one step lower section level than
default.%
\IndexOption{bibliography~=\PValue{leveldown}}}%
\pventry{nottotoc}{%
The bibliography will neither have an entry at the table of contents nor
a number,%
\IndexOption{bibliography~=\PValue{nottotoc}}}%
\pventry{oldstyle}{%
The bibliography will use the classic, compact formation, where
\Macro{newblock}\IndexCmd{newblock} generates an expandable
horizontal distance only.%
\IndexOption{bibliography~=\PValue{oldstyle}}}%
\pventry{openstyle}{%
The bibliography will use the structured, open formation, where
\Macro{newblock}\IndexCmd{newblock} generates a paragraph break.%
\IndexOption{bibliography~=\PValue{openstyle}}}%
\pventry{totoc}{%
The bibliography will have an entry at the table of contents but no
number.%
\IndexOption{bibliography~=\PValue{totoc}}}%
\pventry{totocnumbered}{%
The bibliography will have an entry at the table of contents and a
number at the heading.%
\IndexOption{bibliography~=\PValue{totocnumbered}}}%
\end{desctabular}
\end{table}
%
\EndIndex{Option}{bibliography~=\PName{selection}}%
\begin{Declaration}
\Macro{setbibpreamble}\Parameter{preamble}
\end{Declaration}%
\BeginIndex{Cmd}{setbibpreamble}%
The command \Macro{setbibpreamble} can be used to set a preamble for the
bibliography\Index{bibliography}. This can be achieved by placing the preamble
before the command for issuing the bibliography. However, it need not be
directly in front of it. For example, it could be placed at the beginning of
the document. Similar\textnote{Attention!} to the options
\OptionValue{bibliography}{totoc} and
\OptionValue{bibliography}{totocnumbered}, this command can only be successful
if you have not loaded a package which prevents this by redefining the
\Environment{thebibliography} environment. Even though the \Package{natbib}
package\IndexPackage{natbib} makes unauthorized use of internal macros of
{\KOMAScript} it could be achieved that \Macro{setbibpreamble} works with the
current version of \Package{natbib} (see \cite{package:natbib}).
\begin{Example}
You want to point out that the sorting of the references in the
bibliography is not according to their occurrence in the text, but
in alphabetical order. You use the following command:
\begin{lstcode}
\setbibpreamble{References are in alphabetical order.
References with more than one author are sorted
according to the first author.\par\bigskip}
\end{lstcode}
The \Macro{bigskip}\IndexCmd{bigskip} command makes sure that the
preamble and the first reference are separated by a large vertical
space.%
\end{Example}%
%
\EndIndex{Cmd}{setbibpreamble}
\begin{Declaration}
\Macro{BreakBibliography}\Parameter{interruption code}
\end{Declaration}
\BeginIndex{Cmd}{BreakBibliography}%
This\textnote{Attention!}\ChangedAt{v3.00}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} command exists only if the
environment \Environment{thebibliography} has not been redefined by another
package. It provides a break at the bibliography. The \PName{interruption
code} will be expanded inside a group. Such a break may be, e.\,g., a
heading using \Macro{minisec}. Unfortunately it is not possible to add this
command to the \BibTeX{} database using, e.\,g., a special kind of \BibTeX{}
entry. Because of this, users may use is currently only if they make the
bibliography on their own. Because of this usage is very limited.%
%
\EndIndex{Cmd}{BreakBibliography}%
\begin{Declaration}
\Macro{AfterBibliographyPreamble}\Parameter{code}\\
\Macro{AtEndBibliography}\Parameter{code}
\end{Declaration}
\BeginIndex{Cmd}{AfterBibliographyPreamble}%
\BeginIndex{Cmd}{AtEndBibliography}%
In\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}
some cases it may be useful to add some \PName{code} after the bibliography
preamble or just before the end of the bibliography. This may be achieved
using one of this instructions.
\begin{Example}
You want to set the bibliography not justified but ragged right. This may be
achieved using:
\begin{lstcode}
\AfterBibliographyPreamble{\raggedright}
\end{lstcode}
You may place this instruction anywhere before the
bibliography. Nevertheless it is recommended to do so at the preamble of the
document or inside your own package.
\end{Example}
The\textnote{Attention!} functionality of this instruction depends on
cooperation with packages modifying the bibliography, if such a package should
be used (see \autoref{sec:maincls-experts.coexistence},
\autopageref{desc:maincls-experts.cmd.AfterBibliographyPreamble}).%
%
\EndIndex{Cmd}{AtEndBibliography}%
\EndIndex{Cmd}{AfterBibliographyPreamble}%
%
\EndIndex{}{bibliography}
\section{Index}
\label{sec:maincls.index}
\BeginIndex{}{index}
For general information about making an index see \cite{lshort},
\cite{makeindex}, and \cite{xindy}. Using a package, that redefines commands
or environments for the index, may limit the influence of \KOMAScript{} to the
index hardly. This would be valid, e.\,g., for usage of package
\Package{index}\IndexPackage{index} but not for usage of package
\Package{splitidx}\IndexPackage{splitidx} (see \cite{package:splitindex}).
\begin{Declaration}
\KOption{index}\PName{selection}%
\end{Declaration}
\BeginIndex{Option}{index~=\PName{selection}}%
\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}%
The index is chapter (\Class{scrbook} or \Class{scrreprt}) or section
(\Class{scrartcl}) without heading number or entry at the table of contents by
default or option
\OptionValue{index}{default}\IndexOption{index~=\PValue{default}}.
The\important{\OptionValue{index}{totoc}} index does not need an entry at the
table of contents, because it should always be the last element of a
document. Nevertheless, such an entry may be achieved using option
\OptionValue{index}{totoc}\IndexOption{index~=\PValue{totoc}}. See also option
\Option{toc} with value \PValue{index} in \autoref{sec:maincls.toc} from
\autopageref{desc:maincls.option.toc.index} onward.
A summary of all available values for option \Option{index} may be found in
\autoref{tab:maincls.index}.
\begin{table}
\caption{Available values of option \Option{index}}%
\label{tab:maincls.index}
\begin{desctabular}
\entry{\PValue{totoc}, \PValue{toc}, \PValue{notnumbered}}{%
The index will have an entry at the table of contents, but will not have
a heading number.%
\IndexOption{index~=\PValue{totoc}}}%
\entry{\PValue{default}, \PValue{nottotoc}, \PValue{plainheading}}{%
The index will not have an entry at the table of contents.%
\IndexOption{index~=\PValue{default}}}%
\end{desctabular}
\end{table}
%
\EndIndex{Option}{index~=\PName{selection}}%
\begin{Declaration}
\Macro{setindexpreamble}\Parameter{preamble}
\end{Declaration}%
\BeginIndex{Cmd}{setindexpreamble}%
Similarly to the bibliography you can use a preamble to the
index. This is often the case if you have more than one index or if
you use different kinds of referencing by highlighting the page
numbers in different ways.
\begin{Example}
You have a document in which terms are both defined and used. The
page numbers of definitions are in bold. Of course you want to make
your reader aware of this fact. Thus you insert a preamble for the
index:
\begin{lstcode}
\setindexpreamble{In \textbf{bold} printed page numbers are
references to the definition of terms. Other page numbers
indicate the use of a term.\par\bigskip}
\end{lstcode}
\end{Example}
Please note that the page style of the first page of the index is
changed. The applied page style is defined in the macro
\Macro{indexpagestyle} (see \autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.cmd.titlepagestyle}).
The production, sorting and output of the index is done by the
standard {\LaTeX} packages and additional programs. Similar to the
standard classes {\KOMAScript} only provides the basic macros and
environments.%
%
\EndIndex{Cmd}{setindexpreamble}%
%
\EndIndex{}{index}
%
%
\EndIndex{Class}{scrbook}%
\EndIndex{Class}{scrreprt}%
\EndIndex{Class}{scrartcl}%
\endinput
%%% Local Variables:
%%% mode: latex
%%% mode: flyspell
%%% coding: us-ascii
%%% ispell-local-dictionary: "english"
%%% TeX-master: "../guide"
%%% End:
% LocalWords: endnotes
|