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
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
|
<?xml version="1.0" encoding="utf-8"?>
<!--
This file is part of groff, the GNU roff type-setting system.
Copyright (C) 2004-2020 Free Software Foundation, Inc.
Written by Peter Schaffter (peter@schaffter.ca).
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.
A copy of the Free Documentation License is included as a file called
FDL in the main directory of the groff source package.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
<title>Mom -- Document processing, element tags</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" />
</head>
<body style="background-color: #f5faff;">
<!-- ==================================================================== -->
<div id="top" class="page">
<!-- Navigation links -->
<table style="width: 100%;">
<tr>
<td><a href="toc.html">Back to Table of Contents</a></td>
<td style="text-align: right;"><a href="images.html#top">Next: Graphics, floats, preprocessor support</a></td>
</tr>
</table>
<h1 class="docs">The document element tags</h1>
<div style="width: 460px; margin: auto;">
<ul class="no-enumerator">
<li><a href="#docelement-intro">Introduction to the document element tags</a></li>
<li><a href="#docelement-control">Control macros – changing the tag defaults</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
<li><a href="#control-macro-args">Arguments to the control macros</a>
<ul style="margin-left: -.5em; list-style-type: circle;">
<li><a href="#family-and-font">family and font</a></li>
<li><a href="#point-size">point size</a></li>
<li><a href="#color">colour</a></li>
<li><a href="#quad">quad/justification</a></li>
<li><a href="#underline">underline style, rule weight</a></li>
</ul></li>
<li><a href="#grouping">Grouping control macros</a></li>
</ul></li>
</ul>
</div>
<div class="rule-medium"><hr/></div>
<h2 id="toc-doc-element" class="docs" style="text-align: center;">Document element tags table of contents</h2>
<div id="docelement-mini-toc" style="font-size: 100%; line-height: 150%; margin-top: .5em;">
<div class="mini-toc-col-1" style="margin-left: 0;">
<h3 class="toc toc-docproc-header" style="margin-top: 1em;"><a class="header-link" href="#epigraph-intro">Epigraphs</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#epigraph">EPIGRAPH</a></li>
<li><a href="#epigraph-control">Epigraph control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#pp-intro">Paragraphs</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#pp">PP</a></li>
<li><a href="#pp-control">Paragraph control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#heading-intro">Headings</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#heading">HEADING</a></li>
<li><a href="#heading-control">Heading control</a></li>
<li><a href="#oldstyle-headings-intro">Oldstyle headings</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#linebreak-intro">Linebreaks (section breaks)</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#linebreak">LINEBREAK</a></li>
<li><a href="#linebreak-control">Linebreak control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#quote-intro">Quotes (line for line; poetry or code)</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#quote">QUOTE</a></li>
<li><a href="#quote-control">Quote control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#blockquote-intro">Blockquotes (cited material)</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#blockquote">BLOCKQUOTE</a></li>
<li><a href="#blockquote-control">Blockquote control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#code-intro">Inserting code snippets</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#code">CODE</a></li>
<li><a href="#code-control">Code control</a></li>
</ul>
</div>
<div class="mini-toc-col-2" style="margin-top: 1.5em;">
<h3 class="toc toc-docproc-header"><a class="header-link" href="#list-intro">Nested lists</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#list">LIST</a></li>
<li><a href="#item">ITEM</a></li>
<li><a href="#list-control">List control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#number-lines-intro">Line numbering</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#number-lines">NUMBER_LINES</a></li>
<li><a href="#number-lines-control">Line numbering control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#footnote-intro">Footnotes</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#footnote">FOOTNOTE</a></li>
<li><a href="#footnote-control">Footnote control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#endnote-intro">Endnotes</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#endnote">ENDNOTE</a></li>
<li><a href="#endnote-control">Endnote control</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#margin-notes-intro">Margin notes</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#mn-init">MN_INIT (set margin notes parameters)</a></li>
<li><a href="#mn">MN</a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#finis-intro">Document termination string</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#finis">FINIS</a></li>
<li><a href="#finis-control">Finis control</a></li>
</ul>
</div>
</div>
<div class="rule-medium" style="clear: both;"><hr/></div>
<h2 id="docelement-intro" class="docs">Introduction to the document element tags</h2>
<p>
Once you’ve completed the setup for a document (see
<a href="docprocessing.html#docprocessing-tut">Setting up a mom document</a>),
formatting it is a snap. Simply invoke the appropriate tag for
each document element as you need it. The tags are macros that
tell mom: “This is a paragraph; this is a heading; this is a
footnote,” and so on.
</p>
<p>
Generally, for each tag, there are
<a href="definitions.html#controlmacro">control macros</a>
for the tag’s family, font and point size. Where appropriate,
there are macros to control leading, indents, quad and special
features as well.
Mom has tasteful defaults for all the tags, hence you only use the
control macros when you want to change the way she does things.
This is usually done prior to
<a href="docprocessing.html#start">START</a>,
but can, in fact, be done at any time in the course of a document.
Any change to a tag’s style affects all subsequent invocations
of the tag.
</p>
<h2 id="docelement-control" class="docs">Control macros – changing the tag defaults</h2>
<p>
The control macros for document processing tags let you design the
look of all the parts of your documents—should you wish. At
a bare minimum, all tags have macros to change mom’s defaults
for family, font, point size and colour. Where appropriate, there
are macros to control leading, indents and quad as well.
</p>
<p>
In addition, many tags have special macros to control features that
are pertinent to those tags alone. Have a look at the section
dealing with any particular tag to find out what macros control the
tag, and what mom’s defaults for the tag are.
</p>
<p>
The control macros may be used at any time during the course of a
document (i.e. before or after
<a href="docprocessing.html#start">START</a>).
The changes you make alter all subsequent invocations of the
affected tag until you make another change, either by passing new
arguments to the tag’s control macro, or toggling a particular
feature of the tag on or off.
</p>
<p>
And don’t forget: the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>
can be used at any time, including inside
<a href="definitions.html#toggle">toggle</a>
tags (affecting only that particular invocation of the tag).
Equally,
<a href="definitions.html#inlines">inline escapes</a>
can be used in tags that take
<a href="definitions.html#stringargument">string arguments.</a>
</p>
<div class="box-tip">
<p class="tip">
<span class="tip">Tip:</span>
Get familiar with mom at her default settings before exploring the
control macros. Put her through her paces. See how she behaves.
Get to know what she feels like and how she looks, both in your
text editor and on the printed page. Then, if you don’t like
something, use this documentation to find the precise macro you need
to change it. There are tons of control macros. Reading up on them
and trying to remember them all might lead you to think that mom is
complex and unwieldy, which is not only untrue, but would offend her
mightily.
</p>
</div>
<div class="box-important">
<p class="tip-top">
<span class="important">Important:</span>
The family, font, point size, colour and leading control macros have
no effect in
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>,
except where noted throughout this documentation.
</p>
<p class="tip-bottom">
Please also note that the defaults listed with the control macros
apply only to
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>
unless a default for <kbd>TYPEWRITE</kbd> is also given.
</p>
</div>
<h3 id="control-macro-args" class="docs">Arguments to the control macros</h3>
<h4 id="family-and-font" class="docs" style="margin-top: 1em; margin-bottom: -.75em;">Family and font</h4>
<p>
The arguments to the control macros that end in _FAMILY or _FONT are
the same as for
<a href="typesetting.html#family">FAMILY</a>
and
<a href="typesetting.html#font">FT</a>.
</p>
<h4 id="point-size" class="docs" style="margin-top: -.5em; margin-bottom: -.75em;">Point size</h4>
<p>
Control macros that end in _SIZE always take
the form <kbd>+<n></kbd> or <kbd>-<n></kbd> where
<n> is the number of
<a href="definitions.html#picaspoints">points</a>
larger (+) or smaller (-) than the point size of paragraphs
you want the document element to be. For example, to set
blockquotes 2 points smaller than the type in paragraphs, do
<br/>
<span class="pre-in-pp">
.BLOCKQUOTE_SIZE -2
</span>
There’s no need for a
<a href="definitions.html#unitofmeasure">unit of measure</a>
with the _SIZE control macros; points is assumed.
</p>
<h4 id="color" class="docs" style="margin-top: -.5em; margin-bottom: -.75em;">Colour</h4>
<p>
Control macros that end in _COLOR take as their argument a colour
name pre-defined (or “initialized”) with
<a href="color.html#newcolor">NEWCOLOR</a>
or
<a href="color.html#xcolor">XCOLOR</a>.
For example, if you want your
<a href="#linebreak">author linebreaks</a>
to be red, once you’ve defined or initialized the colour, red,
<br/>
<span class="pre-in-pp">
.LINEBREAK_COLOR red
</span>
will turn them red.
</p>
<h4 id="lead" class="docs" style="margin-top: -.5em; margin-bottom: -.75em;">Lead / linespacing</h4>
<p>
Control macros that end in _AUTOLEAD take the same argument as
<a href="typesetting.html#autolead">AUTOLEAD</a>,
<i>viz.</i> a digit that represents the number of points to add to
the tag’s point size to arrive at its
<a href="definitions.html#leading">leading</a>.
For example, to set footnotes
<a href="definitions.html#solid">solid</a>, do
<br/>
<span class="pre-in-pp">
.FOOTNOTE_AUTOLEAD 0
</span>
To set footnotes with a 1-point lead (i.e. with the line spacing
one point greater than the footnote’s point size), do
<br/>
<span class="pre-in-pp">
.FOOTNOTE_AUTOLEAD 1
</span>
</p>
<div class="box-tip" style="margin-top: -1.25em;">
<p class="tip">
<span class="note">Note:</span>
_AUTOLEAD control macros do not have a <kbd>FACTOR</kbd> argument.
</p>
</div>
<h4 id="control-indents" class="docs" style="margin-top: -.75em; margin-bottom: -.75em;">Indents</h4>
<p>
Except for
<a href="#para-indent">PARA_INDENT</a>,
the argument to control macros that end in _INDENT can take
either a single numeral (whole numbers only, no decimal fractions)
<i>without</i> a
<a href="definitions.html#unitofmeasure">unit of measure</a>
appended to it, or a digit (including decimal fractions) <i>with</i>
a unit of measure appended.
</p>
<p>
A digit <i>without</i> a unit of measure appended represents by
how much you want your paragraph first-line indents (set with
PARA_INDENT) multiplied to achieve the correct indent for a
particular tag. For example,
<br/>
<span class="pre-in-pp">
.PARA_INDENT 2m
.BLOCKQUOTE_INDENT 2
</span>
means that blockquotes will be indented from the left and right
margins by twice the size of the paragraph indent, or 4
<a href="definitions.html#em">ems</a>.
</p>
<p>
A digit <i>with</i> a unit of measure appended defines an absolute
indent, relative to nothing. In the following, blockquotes will be
indented by 3
<a href="definitions.html#picaspoints">picas</a>
and 6
<a href="definitions.html#picaspoints">points</a>,
regardless of the paragraph indent.
<br/>
<span class="pre-in-pp">
.PARA_INDENT 2m
.BLOCKQUOTE_INDENT 3P+6p
</span>
</p>
<h4 id="quad" class="docs" style="margin-top: -1em; margin-bottom: -.75em;">Quad / justification style</h4>
<p>
Control macros that end in _QUAD take the same arguments as
<a href="typesetting.html#quad">QUAD</a>.
</p>
<h4 id="underscore" class="docs" style="margin-bottom: -.75em;">Underscore style, rule weight</h4>
<p>
If mom gives the option to underscore a document element, the weight
of the underline and its distance from the
<a href="definitions.html#baseline">baseline</a>
are controlled by macros that end in _UNDERSCORE or _UNDERLINE, the
two being synonymous. These macros take the following arguments:
<br/>
<span class="pre-in-pp">
DOUBLE - double underscore
<weight> - the underscore weight (in points, no unit of measure required
<distance> - distance from baseline (unit of measure required)
<rule gap> - distance between double underscore rules (unit of measure required)
</span>
<kbd>DOUBLE</kbd> by itself will double-underscore the element. The
remaining arguments must be entered in the order given. You may not
skip over any of them, which means that if you only wish to change
<kbd><rule gap></kbd>, you must still enter a
<kbd><weight></kbd> and <kbd><distance></kbd> argument.
</p>
<p>
Page elements that are separated from
<a href="definitions.html#running">running text</a>
by a rule (i.e. page headers, page footers, and footnotes) are
controlled by macros that end in _RULE_WEIGHT.
</p>
<p>
The weight argument to _UNDERSCORE macros is the same as the
argument to
<a href="inlines.html#rule-weight">RULE_WEIGHT</a>,
as is the argument to _RULE_WEIGHT macros.
</p>
<h3 id="grouping" class="docs">Grouping control macros</h3>
<p>
As of version 2.1, it is possible to group control macros for a
particular tag into a single <kbd><element>_STYLE</kbd> macro.
For example, rather than setting the family, size, and indent of
<a href="#blockquote-intro">BLOCKQUOTES</a>
with
<br/>
<span class="pre-in-pp">
.BLOCKQUOTE_FAMILY H
.BLOCKQUOTE_SIZE -2
.BLOCKQUOTE_INDENT 4P
</span>
you can enter the same style parameter changes with
<br/>
<span class="pre-in-pp">
.BLOCKQUOTE_STYLE \
FAMILY H \
SIZE -2 \
INDENT 4P
</span>
<kbd><element>_STYLE</kbd> macros use
“keyword/value” pairs (<kbd>FAMILY</kbd> is a keyword,
<kbd>H</kbd> is a value), and may be entered entirely on one line,
or, as the example shows, broken into several readable lines using
the backslash. The macro itself and all but the last keyword/value
pair require the backslash when this style is used.
</p>
<p>
Not all the control macros for a particular tag may be available
with an <kbd><element>_STYLE</kbd> macro. Generally speaking,
though, if a tag has control macros for
</p>
<table style="font-family: monospace; font-weight: bold; margin-left: 5em; margin-top: -1em">
<tr>
<td style="padding-right: 1em">FAMILY</td>
<td style="padding-right: 1em">LEAD</td>
<td style="padding-right: 1em">INDENT</td>
<td style="padding-right: 1em">SMALLCAPS</td>
</tr>
<tr>
<td style="padding-right: 1em">FONT</td>
<td style="padding-right: 1em">AUTOLEAD</td>
<td style="padding-right: 1em">COLOR</td>
<td style="padding-right: 1em">UNDERSCORE or UNDERLINE</td>
</tr>
<tr>
<td style="padding-right: 1em">SIZE</td>
<td style="padding-right: 1em">QUAD</td>
<td style="padding-right: 1em">CAPS</td>
</tr>
</table>
<p style="margin-top: .5em">
those parameters may be used within an
<kbd><element>_STYLE</kbd> macro.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If you need to reverse the sense of <kbd>CAPS</kbd>,
<kbd>SMALLCAPS</kbd> or <kbd>UNDERSCORE/UNDERLINE</kbd>, which
do not take a value after the keyword, use <kbd>NO_CAPS</kbd>,
<kbd>NO_SMALLCAPS</kbd>, and <kbd>NO_UNDERSCORE/NO_UNDERLINE</kbd>.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="epigraph-intro" class="macro-group">Epigraphs</h2>
<ul style="margin-left: -.5em;">
<li><a href="#epigraph">Tag: EPIGRAPH</a></li>
<li><a href="#epigraph-control">Epigraph control macros and defaults</a></li>
</ul>
<p>
<a href="definitions.html#epigraph">Epigraphs</a>
colour, flavour, or comment on the document they precede.
Typically, they are centred at the top of a document’s first page
(underneath the title) and set in a smaller point size than that of
paragraph text.
</p>
<p>
By default, mom sets epigraphs centred and
<a href="definitions.html#filled">unfilled</a>;
this lets you input them on a line for line basis. This behaviour
can be changed to accommodate
<a href="definitions.html#filled">filled</a>
epigraph “blocks.”
</p>
<!-- -EPIGRAPH- -->
<div class="macro-id-overline">
<h3 id="epigraph" class="macro-id">EPIGRAPH</h3>
</div>
<div class="box-macro-args">
Macro: <b>EPIGRAPH</b> <kbd class="macro-args"><toggle> | [ BLOCK ]</kbd>
</div>
<p>
EPIGRAPH is a toggle, used like this:
<br/>
<span class="pre-in-pp">
.EPIGRAPH
<text of epigraph>
.EPIGRAPH OFF
</span>
<kbd>OFF</kbd>, above, could be anything—say, <kbd>Q</kbd> or
<kbd>X</kbd>—since any argument other than <kbd>BLOCK</kbd>
turns it off.
</p>
<p>
If given the argument, <kbd>BLOCK</kbd>, EPIGRAPH sets epigraphs
<a href="definitions.html#filled">filled</a>,
justified or quadded in the same direction as paragraphs, indented
equally from both the left and right margins.
</p>
<p>
If a block-style epigraph runs to more than one paragraph (unlikely,
but conceivable), you must introduce every paragraph—including
the first—with the
<a href="#pp">PP</a>
tag.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
EPIGRAPH should only be used at the top of a document (i.e. just
after
<a href="docprocessing.html#start">START</a>)
or after headings. The latter is not especially recommended, but it
does work. In all other places where you want quotes or cited text,
use
<a href="#quote">QUOTE</a>
or
<a href="#blockquote">BLOCKQUOTE</a>.
</p>
</div>
<div class="box-tip">
<p class="tip">
<span class="tip">Tips on vertical spacing around epigraphs:</span>
If you wish to change the vertical position of an epigraph with
<a href="typesetting.html#space">SPACE</a>,
<a href="typesetting.html#ald">ALD</a>, or
<a href="typesetting.html#rld">RLD</a>,
do so before invoking <kbd>.EPIGRAPH</kbd>, like this:
<br/>
<span class="pre-in-pp">
.SP -6p
.EPIGRAPH
A notable quote.
.EPIGRAPH OFF
</span>
If you’re setting a document in
<a href="docprocessing.html#columns">columns</a>
and you’d like to add or subtract space <i>after</i> the
epigraph, which is centred over the top of both columns, the place
to do it is inside the epigraph, like this:
<br/>
<span class="pre-in-pp">
.EPIGRAPH
A notable quote.
.SP 1v
.EPIGRAPH OFF
</span>
If you were to add the <kbd>.SP 1v</kbd> outside the epigraph, the
space would be added to the top of the leftmost column only,
resulting in unbalanced columns.
</p>
</div>
<div class="defaults-container" style="padding-bottom: 8px;">
<h3 id="epigraph-control" class="docs defaults" style="margin-top: -.25em;">EPIGRAPH control macros and defaults</h3>
<p class="defaults">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following EPIGRAPH control macros may also be
<a href="#grouping">grouped</a>
using EPIGRAPH_STYLE.
</p>
<span class="pre defaults">
.EPIGRAPH_FAMILY default = prevailing document family; default is Times Roman
.EPIGRAPH_FONT default = roman
.EPIGRAPH_SIZE default = -1.5 (points)
.EPIGRAPH_COLOR default = black
.EPIGRAPH_AUTOLEAD default = 2 points
(The next two apply to “block” style epigraphs only)
.EPIGRAPH_INDENT* (see Note on EPIGRAPH_INDENT, below)
*Indent here refers to the indent from both the left and right margins
that centres block style epigraphs on the page.
</span>
</div>
<div class="box-notes">
<h3 id="epigraph-indent" class="docs notes" style="margin-bottom: -.75em;">Note on EPIGRAPH_INDENT</h3>
<p style="margin-top: .5em;">
If you pass EPIGRAPH_INDENT an integer with no unit of measure
appended, the integer represents the amount by which to multiply
PARA_INDENT to arrive at an indent for block style epigraphs. If
you append a unit of measure to the argument, the indent will be
precisely the amount specified.
</p>
<p>
Please also note that if your PARA_INDENT is <kbd>0</kbd> (i.e.
no indenting of the first line of paragraphs), you must set an
EPIGRAPH_INDENT yourself, with a unit of measure appended to the
argument. Mom has no default for EPIGRAPH_INDENT if paragraph first
lines are not being indented.
</p>
<p class="tip-bottom">
The default value for EPIGRAPH_INDENT is <kbd>3</kbd> (for
<a href="docprocessing.html#printstyle">PRINTSTYLE TYPESET</a>)
and <kbd>2</kbd> (for
<a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>).
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="pp-intro" class="macro-group">Paragraphs</h2>
<ul style="margin-left: -.5em;">
<li><a href="#pp">Tag: PP</a></li>
<li><a href="#pp-control">Paragraph control macros and defaults</a></li>
</ul>
<p>
The paragraph macro is the one you use most often. Consequently,
it’s one of most powerful, yet simplest to use—just the
letters PP. No arguments, nothing. Just <kbd>.PP</kbd> on a line
by itself any time, in any document element, tells mom you want to
start a new paragraph. The spacing and indent appropriate to where
you are in your document are taken care of automatically.
</p>
<p>
By default, mom does not indent the first paragraph of a document,
nor paragraphs that fall immediately after headings. The first
paragraphs of blockquotes and block-style epigraphs are also not
indented. This behaviour can be changed with the control macro
<kbd><a href="#para-indent-first">INDENT_FIRST_PARAS</a></kbd>.
</p>
<p>
Mom does not deposit a blank line between paragraphs. If you want
her to do so, use the control macro
<a href="#pp-space">PARA_SPACE</a>.
(I don’t recommend using this macro with
<a href="typesetting.html#printstyle">PRINTSTYLE TYPEWRITE</a>.)
</p>
<p>
Note that mom does not provide widow or orphan control for
paragraphs (i.e., even if only one line of a paragraph fits at the
bottom of a page, she will set it on that page). The reason for
this is that writers of fiction often have single-line paragraphs
(e.g. in dialogue). Groff’s simplistic orphan control will
break these one-liners—if they fall at the bottom of the
page—to a new page, which is not what you want.
</p>
<!-- -PP- -->
<div class="macro-id-overline">
<h3 id="pp" class="macro-id">PP</h3>
</div>
<div class="box-macro-args">
Macro: <b>PP</b>
</div>
<p>
<kbd>.PP</kbd> (on a line by itself, of course) tells mom to start a
new paragraph. See
<a href="#pp-intro">above</a>
for more details. In addition to regular text paragraphs, you can
use PP in
<a href="#epigraph-intro">epigraphs</a>,
<a href="#blockquote-intro">blockquotes</a>,
<a href="#endnote-intro">endnotes</a>
and
<a href="#footnote-intro">footnotes</a>.
</p>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="pp-control" class="docs defaults">PP control macros and defaults</h3>
<p class="defaults">
The PP macro being so important, and representing, as it were, the
basis of everything that goes on in a document, its control is
managed in a manner somewhat different from other document element
tags. As a result, the control macros for PP may not be
<a href="#grouping">grouped</a>
within a <kbd>_STYLE</kbd> macro.
</p>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#pp-family">Family control</a></li>
<li><a href="#pp-font">Font control</a></li>
<li><a href="#pp-color">Paragraph colour</a></li>
<li><a href="#pp-leading">Leading/linespacing control</a></li>
<li><a href="#pp-just-quad">Justification/quad control</a></li>
<li><a href="#para-indent">First-line indent control</a></li>
<li><a href="#para-indent-first">Initial paragraphs indent control</a></li>
<li><a href="#pp-space">Inter-paragraph spacing</a></li>
</ol>
</div>
<h4 id="pp-family" class="docs" style="margin-top: -1.5em;">1. Family control</h4>
<p>
The paragraph
<a href="definitions.html#family">family</a>
is set with
<a href="typesetting.html#family">FAMILY</a>
prior to
<a href="docprocessing.html#start">START</a>,
or
<a href="docprocessing.html#doc-family">DOC_FAMILY</a>
afterwards. Please note that both globally affect the family of
every element in the document.
</p>
<p>
If you wish to change the family for regular text paragraphs only,
invoke <kbd>.FAMILY</kbd> immediately after <kbd>.PP</kbd> in every
paragraph whose family you wish to differ from the prevailing
document family. Alternatively, set the family and font for
paragraphs with PP_FONT, giving it a complete family+font name, e.g.
<br/>
<span class="pre-in-pp">
PP_FONT TI
</span>
which would make the font used in paragraphs Times Roman Italic.
</p>
<p>
Mom’s default paragraph (and document) family is Times Roman.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Neither FAMILY nor DOC_FAMILY has any effect when the PRINTSTYLE is
<kbd>TYPEWRITE</kbd>.
</p>
</div>
<h4 id="pp-font" class="docs" style="margin-top: -.25em;">2. Font control</h4>
<p>
To change the
<a href="definitions.html#font">font</a>
used in regular text paragraphs, use PP_FONT, which takes the same
argument as
<a href="typesetting.html#font">FT</a>.
PP_FONT may be used before or after
<a href="docprocessing.html#start">START</a>.
Only regular text paragraphs are affected; paragraphs in
<a href="#epigraph-intro">epigraphs</a>,
<a href="#blockquote-intro">blockquotes</a>,
<a href="#endnote-intro">endnotes</a>,
and
<a href="#footnote-intro">footnotes</a>
remain at their default setting (medium roman) unless you change
them with the appropriate control macros.
</p>
<p>
Mom’s default paragraph font is medium roman.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
PP_FONT has no effect when the PRINTSTYLE is <kbd>TYPEWRITE</kbd>.
If you wish to set whole typewritten paragraphs in italic, invoke
<kbd>.FT I</kbd> immediately after <kbd>.PP</kbd>. Depending
on which of
<a href="docprocessing.html#printstyle-italics">UNDERLINE_ITALIC</a>
or
<a href="docprocessing.html#printstyle-italics">ITALIC_MEANS_ITALIC</a>
is currently enabled, the paragraph will be set underlined or in
italic. Neither persists past the end of the paragraph.
</p>
</div>
<h4 id="pp-color" class="docs" style="margin-top: -.25em;">3. Paragraph colour</h4>
<p>
Mom has no special control macro for colourising paragraphs. If you
wish a colourised paragraph, you must use the macro
<a href="color.html#color">COLOR</a>
or the
<a href="definitions.html#inline">inline escape</a>,
<a href="color.html#color-inline"><kbd><span class="nobr">\*[<colourname>]</span></kbd></a>,
<i>after</i> <kbd>.PP</kbd>. The colour must be one pre-defined (or
“initialized”) with
<a href="color.html#newcolor">NEWCOLOR</a>
or
<a href="color.html#xcolor">XCOLOR</a>.
</p>
<p>
Please note that unless you change the colour back to it’s
default (usually black) at the end of the paragraph, all subsequent
paragraphs will be set in the new colour, although most other
elements of your document will continue to be set in the default
colour (usually black).
</p>
<p>
For example, assuming you have defined the colour, blue,
<br/>
<span class="pre-in-pp">
.PP
.COLOR blue
<first paragraph>
.HEADING 1 "Monty Python"
.HEADING 2 "The Origins of Spam"
.PP
<second paragraph>
</span>
the first paragraph will be blue, the head and subhead will be in
the document’s default colour (usually black), and the second
paragraph will be in blue.
</p>
<h4 id="pp-leading" class="docs" style="margin-top: -.25em;">4. Leading</h4>
<p>
The paragraph
<a href="definitions.html#leading">leading</a>
is set with
<a href="typesetting.html#leading">LS</a>
prior to
<a href="docprocessing.html#start">START</a>,
or
<a href="docprocessing.html#doc-lead">DOC_LEAD</a>
afterwards. Please note that either method globally affects the
leading and spacing of every document element (except
<a href="definitions.html#header">headers</a>
and
<a href="definitions.html#footer">footers</a>).
</p>
<p>
If you wish to change the leading of regular text paragraphs only,
invoke <kbd>.LS</kbd> immediately after <kbd>.PP</kbd> in any
paragraph whose leading you wish to change.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Warning:</span>
Changing a paragraph’s leading will almost certainly screw up
mom’s ability to balance the bottom margin of pages. Should
you absolutely require a change to a paragraph’s leading and
need to get mom back on track leading-wise afterwards, use the
<a href="docprocessing.html#shim">SHIM</a>
or
<a href="docprocessing.html#shim">FLEX</a>
macro, depending on which
<a href="docprocessing.html#vertical-whitespace-management">vertical whitespace management</a>
strategy you are using.
</p>
</div>
<p>
Mom’s default paragraph leading (document leading)
is 16 points, adjusted to fill the page.
</p>
<h4 id="pp-just-quad" class="docs" style="margin-top: -.25em;">5. Justification / quad</h4>
<p>
The justification/quad-direction of regular text paragraphs (i.e.
<a href="definitions.html#just">justified</a>,
or
<a href="definitions.html#filled">filled</a>
and
<a href="definitions.html#quad">quadded</a>
left/right/centre) is set with
<a href="typesetting.html#justify">JUSTIFY</a>
or
<a href="typesetting.html#quad">QUAD</a>
prior to
<a href="docprocessing.html#start">START</a>,
and with
<a href="docprocessing.html#doc-quad">DOC_QUAD</a>
afterwards.
</p>
<p>
Please note that either method of setting the paragraph
justification/quad-direction also affects
<a href="#epigraph-intro">epigraphs</a>,
<a href="#footnote-intro">footnotes</a>,
and
<a href="#endnote-intro">endnotes</a>,
but not
<a href="#blockquote-intro">blockquotes</a>
(whose default is quad left unless you change it with
<a href="#blockquote">BLOCKQUOTE_QUAD</a>).
The justification/quad-direction of epigraphs and footnotes may be
changed with their own control macros.
</p>
<p>
If you wish to change the justification/quad-direction of individual
paragraphs, invoke
<a href="typesetting.html#justify"><kbd>.JUSTIFY</kbd></a>
or
<a href="typesetting.html#quad"><kbd>.QUAD</kbd></a>
on the line immediately after <kbd>.PP</kbd>. Only the paragraph
in question gets justified or quadded differently; subsequent
paragraphs remain unaffected.
</p>
<p>
Mom’s default justification/quad-direction for paragraphs
when the
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>
is <kbd>TYPESET</kbd> is justified; for PRINTSTYLE
<kbd>TYPEWRITE</kbd>, the default is quad left.
</p>
<h4 id="para-indent" class="docs" style="margin-top: -.25em;">6. First-line indent</h4>
<p>
The first-line indent of paragraphs is controlled by PARA_INDENT,
which takes one argument: the size of the indent. PARA_INDENT may be
used before or after
<a href="docprocessing.html#start">START</a>.
A
<a href="definitions.html#unitofmeasure">unit of measure</a>
is required; fractional sizes are allowed. Thus, to set the
paragraph indent to 4-1/2
<a href="definitions.html#em">ems</a>, do
<br/>
<span class="pre-in-pp">
.PARA_INDENT 4.5m
</span>
In addition to establishing the basic first line-indent of
paragraphs, PARA_INDENT also affects
<a href="#epigraph-intro">epigraphs</a>,
<a href="#quote-intro">quotes</a>
and
<a href="#blockquote-intro">blockquotes</a>,
whose overall indenting from the left and (where applicable)
right margins is relative to PARA_INDENT if
the _INDENT control macro for these tags has
no
<a href="definitions.html#unitofmeasure">unit of measure</a>
appended to it. Furthermore, the first-line indent of paragraphs
within these document elements (as well as footnotes) is also
relative to PARA_INDENT (always 1/2 of PARA_INDENT), hence they are
also affected.
</p>
<p>
Mom’s default PARA_INDENT is 2 ems for
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>
<kbd>TYPESET</kbd> and 3 picas (1/2 inch) for
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>
<kbd>TYPEWRITE</kbd>.
</p>
<h4 id="para-indent-first" class="docs" style="margin-top: -.25em;">7. Indenting initial paragraphs</h4>
<p>
By default, mom does not indent the first paragraph of a document,
nor the first paragraph after a heading or
<a href="#linebreak-intro">linebreak</a>,
nor the first paragraphs of
<a href="#epigraph-intro">epigraphs</a>,
<a href="#blockquote-intro">blockquotes</a>,
<a href="#endnote-intro">endnotes</a>
or
<a href="#footnote-intro">footnotes</a>
that run to more than one paragraph.
</p>
<p>
If you wish to have first paragraphs indented, invoke the macro
INDENT_FIRST_PARAS without an argument, either before or after
<a href="docprocessing.html#start">START</a>.
INDENT_FIRST_PARAS is a toggle macro, therefore passing it any
argument (<kbd>OFF</kbd>, <kbd>QUIT</kbd>, <kbd>Q</kbd>,
<kbd>X</kbd>...) cancels its effect, meaning that first paragraphs
will once again not be indented.
</p>
<h4 id="pp-space" class="docs">8. Inter-paragraph spacing</h4>
<p>
By default, mom does not insert a blank line between
paragraphs. If you would like her to do so, invoke the macro
PARA_SPACE without an argument, either before or after
<a href="docprocessing.html#start">START</a>.
PARA_SPACE is a toggle macro, therefore passing it any argument
(<kbd>OFF</kbd>, <kbd>QUIT</kbd>, <kbd>Q</kbd>, <kbd>X</kbd>...)
cancels its effect, meaning that paragraphs will once again not be
separated by a blank line.
</p>
<p>
If you would like to space paragraphs by less than a full linespace,
invoke PARA_SPACE with the amount of space you want as a numeric
argument. A
<a href="definitions.html#unitofmeasure">unit of measure</a>
is required. For example, to space paragraphs by one-quarter
linespace
<span class="pre-in-pp">
.PARA_SPACE .25v
</span>
is how you’d do it, or, if you want six points between
paragraphs
<span class="pre-in-pp">
.PARA_SPACE 6p
</span>
</p>
<p style="margin-top: -1em" >
If
<a href="docprocessing.html#flex-vs-shim">flex-spacing</a>
is enabled, additional flexible vertical whitespace can be inserted
between spaced paragraphs with the
<a href="docprocessing.html#flex">FLEX</a>
macro.
</p>
<p>
PARA_SPACE is not recommended for use with PRINTSTYLE TYPEWRITE
unless you give PRINTSTYLE the <kbd>SINGLESPACE</kbd> option.
</p>
<div class="box-tip">
<p class="tip-top">
<span class="note">Note:</span>
If PARA_SPACE is on, mom spaces only those paragraphs that come
after an initial paragraph. Initial paragraphs are those that come
immediately after the
<a href="definitions.html#docheader">docheader</a>
(i.e. the start of a document),
<a href="#epigraph-intro">epigraphs</a>,
<a href="#heading-intro">headings</a>,
and
<a href="#linebreak-intro">linebreaks</a>.
(The first paragraph after these document elements requires no
blank line to separate it from other paragraphs.)
</p>
<p class="tip-bottom">
Sometimes, you can be fairly deep into a document before using PP
for the first time, and when you do, because mom is still waiting
for that initial paragraph, she doesn’t space it with a blank
line, even though you expect her to. The simple workaround for this
is to invoke <kbd>.PP</kbd> twice (in succession) at the point you
expect the blank line to appear.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="heading-intro" class="macro-group">Headings</h2>
<ul style="margin-left: -.5em;">
<li><a href="#heading">Tag: HEADING</a></li>
<li><a href="#head-spacing-notes">Spacing of headings</a></li>
<li><a href="#heading-control">Heading control macros and defaults</a></li>
<li><a href="#prefix-chapter-number">Prefixing chapter numbers</a></li>
<li><a href="#oldstyle-headings">Oldstyle headings</a>
<ul style="list-style-type: circle; margin-left: -1.25em">
<li><a href="#parahead">Important information about PARAHEAD</a>
<ul style="list-style-type: square; margin-left: -1.25em">
<li><a href="#parahead-usage">Correct usage of paraheads</a></li>
</ul></li>
</ul></li>
</ul>
<p>
Heads, subheads, and deeper levels of section headings are
handled by a single macro, HEADING, to which you pass an argument
stating the desired level.
<kbd><span class="nobr">.HEADING 1 "<text>"</span></kbd>,
for example, would be a main head;
<kbd><span class="nobr">.HEADING 2 "<text>"</span></kbd>
would be a subhead; etc.
</p>
<p>
In addition to printing headings in the body of your document,
HEADING collects the heading as an entry for the Table of Contents,
if the document is to have one, and the
<a href="definitions.html#pdfoutline">PDF outline</a>.
With the <kbd>NAMED</kbd> argument, it furthermore acts as a
bookmark for
<a href="definitions.html#pdflink">PDF links</a>.
</p>
<p>
Headings can also be numbered on a per-heading-level basis,
hierarchically and concatenatively, e.g.
<br/>
<span class="pre-in-pp">
1.
1.1
1.2
1.2.1
2.
2.1
2.2
2.2.1
</span>
By default, a blank line precedes headings, regardless of the level.
Mom initially sets up a very basic style for nine levels of heading,
of which you can have an infinite number, although as has been said,
if you need more than four levels of heading, you should consider
re-organising your material. The pared-down style of mom’s
defaults is intentional; it is expected that you will design
headings to your own specifications with the
<a href="definitions.html#controlmacro">control macro</a>,
<a href="#heading-style">HEADING_STYLE</a>.
</p>
<p>
It is very good practice, and strongly recommended, that you respect
the hierarchy of headings, using level-1 for main heads, level-2 for
subheads, level-3 for subsubheads, etc. The ease of designing and
re-designing the style for each level, plus mom’s very basic
defaults, are meant, in part, to prevent the whimsical misuse of
a particular heading level just because its style appeals to you.
</p>
<!-- -HEAD- -->
<div class="macro-id-overline">
<h3 id="heading" class="macro-id">HEADING</h3>
</div>
<div class="box-macro-args">
Macro: <b>HEADING</b> <kbd class="macro-args"><level> [
PARAHEAD ] [ NAMED <pdf-id> ] "<heading text>"</kbd>
</div>
<p>
The first argument to HEADING is the <kbd>level</kbd>. Level 1 is
analogous to a main head; level 2 is analogous to a subhead; level 3
is analogous to a subsubhead; etc.
</p>
<p>
The second (optional) argument, <kbd>PARAHEAD</kbd>, instructs mom
that the heading should be treated as a
<a href="definitions.html#parahead">paragraph head</a>.
If HEADING is being used to create a parahead, it must come after
<a href="#pp">PP</a>,
not before.
</p>
<p>
The indent applied to a parahead is the same as what would be
expected from a paragraph without the parahead (see
<a href="#para-indent-first">Indenting initial paragraphs</a>).
If you wish that a paragraph introduced by a parahead not be
indented, use
<a href="#para-indent">PARA_INDENT</a>
to set the paragraph indent to zero, then reset the indent for
subsequent paragraphs.
</p>
<p>
The optional third argument, <kbd>NAMED <id></kbd>, gives
the heading a unique, non-printing identifier that allows it to be
referenced from anywhere in the final PDF document with the PDF_LINK
macro, provided the mom file is processed with
<a href="using.html#pdfmom" style="font-weight: bold">pdfmom</a>.
PDF_LINK usage is explained in the manual,
<a href="http://www.schaffter.ca/mom/pdf/mom-pdf.pdf"><span class="book-title">Producing PDFs with groff and mom</span></a>.
</p>
<p>
The final argument is the text of the heading, surrounded by double
quotes. Long headings that are likely to exceed the current
line length should be broken into chunks, each surrounded by
double-quotes, like this:
<br/>
<span class="pre-in-pp">
.HEADING 1 "A needlessly long but instructive" "first level heading"
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If a heading falls near the bottom of an output page and mom is
unable to fit the heading plus at least one line of text underneath
it, she will set the head at the top of the next page.
</p>
</div>
<div class="box-tip">
<h3 id="head-spacing-notes" class="docs" style="padding-top: 9px; font-size: 100%; text-transform: none">Spacing of headings</h3>
<p>
As described above, mom inserts a blank line before each heading.
If the leading of your document never changes, and you introduce no
additional space into the text—as, for example, between
paragraphs—this will result in perfectly equal whitespace before
each heading.
</p>
<p>
If, however, you disrupt the regular placement of text on
mom’s
<a href="definitions.html#baseline-grid">baseline grid</a>,
HEADING adds extra whitespace to the blank line according to the
<a href="docprocessing.html#vertical-whitespace-management">vertical whitespace management</a>
strategy in effect. This, along with a similar strategy for
whitespace around quotes, blockquotes, and
<a href="definitions.html#float">floated</a>
and
<a href="definitions.html#preprocessor">pre-processor material</a>
is what allows mom to balance the bottom
margins of pages effectively.
</p>
<p>
It occasionally happens that the extra whitespace becomes
noticeable. This typically occurs when the amount of whitespace
adjustment approaches the value of the current leading. The result
looks like two blank lines instead of one. When this happens, a
simple but effective fix is to reduce the space before the heading
by backing up one line, either with
<br/>
<span class="pre-in-pp">
.SPACE -1v
</span>
or
<br/>
<span class="pre-in-pp">
.RLD -1v
</span>
This results in slightly less whitespace than normal, but the
difference is usually not apparent. Alternatively, you may pass the
<kbd>NO_SHIM</kbd> or <kbd>NO_FLEX</kbd> argument to
<a href="#heading-style">HEADING_STYLE</a>
to prevent shimming or flex-spacing of any particular heading level
either globally or selectively. If shimming/flex-spacing is
disabled selectively with
<br/>
<span class="pre-in-pp">
.HEADING_STYLE <n> NO_SHIM | NO_FLEX
</span>
it can be re-enabled for the heading level with
<br/>
<span class="pre-in-pp">
.HEADING_STYLE <n> SHIM | FLEX
</span>
</p>
</div>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="heading-control" class="defaults" style="margin-left: 6px; margin-bottom: -1em">HEADING control and defaults</h3>
<div style="padding-left: 15px; padding-right: 15px">
<p style="margin-bottom: 1em">
By default, mom pre-initializes nine levels of headings to use
the bold font of the prevailing document family, with a baseline
adjustment of 1/10 of the current
<a href="definitions.html#leading">leading</a>.
In addition, level-1 headings are 3 points larger than running text,
level-2 headings 2 points larger, and level 3-headings 1 point
larger. The remaining 6 levels are the same size as running text.
A single blank line precedes all levels of heading.
</p>
<h4 id="heading-style" class="docs" style="margin-bottom: -.5em">The HEADING_STYLE macro</h4>
<p>
Styling heads is accomplished with a single macro
<br/>
<span class="pre-in-pp">
.HEADING_STYLE <level>
</span>
where <kbd><level></kbd> is the numeric heading level to which
the style applies.
</p>
<p>
HEADING_STYLE takes any or all of the following arguments,
which may be given in any order:
<br/>
<span class="pre defaults">
FAMILY <family> \
FONT <font> \
SIZE <+|-size> \
QUAD <direction> \
COLOR <colour> \
UNDERSCORE <weight> <gap> | NO_UNDERSCORE \
UNDERSCORE2 <weight> <gap1> <gap2> | NO_UNDERSCORE2 \
CAPS | NO_CAPS \
SMALLCAPS | NO_SMALLCAPS \
BASELINE_ADJUST <amount to raise heading from the baseline> \
NEEDS <lines of text required beneath the heading> \
PREFIX_CHAPTER [<n>] \
SPACE_AFTER | NO_SPACE_AFTER \
NUMBER | NO_NUMBER \
NO_SHIM | SHIM \
NO_FLEX | FLEX
</span>
</p>
<p>
You may enter your entire argument list on a single line, or, if it
is very long, break it into shorter lines with the
“line-continued” backslash (<kbd>\</kbd>), as shown
above.
</p>
<p class="defaults" style="margin-bottom: 1em">
The arguments to <kbd>FAMILY</kbd>, <kbd>FONT</kbd>,
<kbd>SIZE</kbd>, <kbd>QUAD</kbd>, and
<kbd>COLOR</kbd> are the same as
those you’d give to the
<a href="#docelement-control">control macros</a>
ending in _FAMILY, _FONT, _SIZE, _QUAD, or _COLOR. See
<a href="#control-macro-args">Arguments to the control macros</a>.
</p>
<p class="defaults" style="margin-bottom: 1em">
<kbd>UNDERSCORE</kbd> and <kbd>UNDERSCORE2</kbd> require that a
weight for the underscore be given, in points (decimal fractions
allowed), but without the unit of measure <kbd>p</kbd> appended.
They also require that the underscore’s distance from the
baseline be supplied; in the case of UNDERSCORE2, an additional gap
argument representing the distance between the two underscores must
be provided.
</p>
<p class="defaults" style="margin-bottom: 1em">
The <kbd>CAPS</kbd> argument capitalizes the text of a heading
level in the body of a document but not in the Table of
Contents, where capitalization of entries is controlled by
<a href="tables-of-contents.html#toc-entry-style">TOC_ENTRY_STYLE <n></a>.
</p>
<p class="defaults" style="margin-bottom: 1em">
<kbd>BASELINE_ADJUST</kbd> allows you to raise a heading slightly
above the baseline on which it would otherwise sit. For aesthetic
reasons, it is often desirable to introduce a small amount of space
between a heading and the text following it. Since headings are
preceded by a blank line, it is preferable to move the heading
upward than to lower the text following it. The argument to
BASELINE_ADJUST is the amount by which to raise the heading. It
requires no <kbd>+</kbd> or <kbd>-</kbd> sign, and must have a
<a href="definitions.html#unitofmeasure">unit of measure</a>
appended to it.
</p>
<p class="defaults" style="margin-bottom: 1em">
<kbd>NEEDS</kbd> lets you reserve the number of lines of text
required beneath a heading, including fractions thereof (e.g.
“1.5” for one line of text plus half a linespace).
If a heading falls near the bottom margin and there isn’t
sufficient room for both the heading and the reserved space, mom
will break to a new page for the heading. A
<a href="definitions.html#unitofmeasure">unit of measure</a>
should not be appended to the argument.
<span class="note"><i>Note:</i></span> If you have
<a href="goodies.html#dropcap">DROPCAP</a>s
after headings, you must increase the value of <kbd>NEEDS</kbd>
to match the number of dropcap lines.
</p>
<p class="defaults" style="margin-bottom: 1em">
<kbd>PREFIX_CHAPTER</kbd> instructs mom to prefix the current
chapter number to numbered headings. If mom is unable to determine
a chapter number, she will ask for one.
</p>
<p class="defaults" style="margin-bottom: 1em">
Note that using <kbd>PREFIX_CHAPTER</kbd> with an explicit chapter
number will also set the chapter number for subsequent
<a href="images.html#autolabel">automatically-generated image and pre-processor labels</a>
as well.
</p>
<p class="defaults" style="margin-bottom: 1em">
<kbd>SPACE_AFTER</kbd> inserts a blank line equal to the current
<a href="definitions.html#leading">leading</a> after a HEADING.
If you’d like a full linespace after a heading level, use
<kbd>SPACE_AFTER</kbd>. If you’d like additional space before
a heading level, you must introduce it yourself with
<a href="typesetting.html#space">SPACE</a>
or
<a href="typesetting.html#ald">ALD</a>.
</p>
<p class="defaults" style="margin-bottom: 1em">
<kbd>NUMBER</kbd> and <kbd>NO_NUMBER</kbd> allow you to determine
whether mom prepends a hierarchic numbering scheme to a heading
level in the body of a document. Numbering of Table of Contents
entries is controlled separately with
<a href="tables-of-contents.html#toc-entry-numbers">TOC_ENTRY_NUMBERS</a>.
Mom also has a special macro to toggle whether to prefix a chapter
number to numbered headings and Table of Contents entries,
<a href="#prefix-chapter-number">PREFIX_CHAPTER_NUMBER</a>.
</p>
<p class="defaults" style="margin-bottom: 1em">
<kbd>SHIM</kbd> is not necessary if shimming is enabled
globally, which it is by default; it exists to re-enable
shimming for the heading level if you have previously passed
HEADING_STYLE <kbd><n></kbd> a <kbd>NO_SHIM</kbd>
argument. The <kbd>FLEX</kbd> and <kbd>NO_FLEX</kbd> arguments work
the same way if flex-spacing is enabled.
</p>
<p class="defaults" style="padding-bottom: .5em">
The argument list is long, so you may want to break it into
several lines by using the backslash character (<kbd>\</kbd>).
Here’s an example of how you might style a level 1 heading:
<br/>
<span class="pre defaults">
.HEADING_STYLE 1 \
FONT B \
QUAD C \
UNDERSCORE .5 2p \
BASELINE_ADJUST 3p \
NUMBER
</span>
This creates a level-1 heading style that’s bold, centred,
underscored and numbered, raised by 3 points from the baseline.
</p>
</div>
</div>
<!-- -PREFIX_CHAPTER_NUMBER- -->
<div id="prefix-chapter-number" class="macro-id-overline" style="margin-top: -1em;">
<h3 class="macro-id" style="text-transform: none; font-size: 105%;">Prefixing chapter numbers</h3>
</div>
<div class="box-macro-args">
Macro: <b>PREFIX_CHAPTER_NUMBER</b> <kbd class="macro-args"><none> | <chapter number as digit> | <anything></kbd>
</div>
<p>
If, in addition to numbering heads, you want mom to prepend the
chapter number, invoke <kbd>.PREFIX_CHAPTER_NUMBER</kbd>.
</p>
<p>
When you invoke <kbd>.PREFIX_CHAPTER_NUMBER</kbd> without an
argument, mom checks to see whether the argument you passed to <a
href="docprocessing.html#chapter">CHAPTER</a> (if it’s been
called) is a digit. If it isn’t (say you’ve numbered your
chapter “One” instead of “1”), mom will
abort with a request that you pass PREFIX_CHAPTER_NUMBER a digit
representing the chapter number.
</p>
<p>
After you invoke <kbd>.PREFIX_CHAPTER_NUMBER</kbd>, mom will prepend
the chapter number to all headings you have requested be numbered
with
<a href="#heading-style"><kbd>.HEADING_STYLE <n> NUMBER</kbd></a>.
Thus, assuming chapter number twelve (12):
<br/>
<span class="pre-in-pp">
1. LEVEL 1 HEADING
1.1. Level 2 heading
</span>
would become
<br/>
<span class="pre-in-pp">
12.1. LEVEL 1 HEADING
12.1.1. Level 2 heading
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If a chapter number is given to PREFIX_CHAPTER_NUMBER, automatically
generated labels with a prepended chapter number are also affected.
</p>
</div>
<p>
In collated documents, mom automatically increments the digit used
by PREFIX_CHAPTER_NUMBER by one (current chapter digit + 1) every
time you invoke
<a href="rectoverso.html#collate"><kbd>.COLLATE</kbd></a>,
even if you’ve (temporarily) turned off the prefixing
of chapter numbers. Thus, even if you number your chapters
“One”, “Two”, “Three” instead of
“1”, “2”, “3”, mom will Do The
Right Thing with respect to numbering head (and label) elements
in all collated chapters following the first invocation of
PREFIX_CHAPTER_NUMBER (assuming, of course, that the collated
chapters are in incrementing order; if not, you must put
<br/>
<span class="pre-in-pp">
.PREFIX_CHAPTER_NUMBER <chapter number>
</span>
somewhere after the invocation of COLLATE and before the first
numbered head element of each collated document).
</p>
<p>
PREFIX_CHAPTER_NUMBER can be disabled by passing it any argument
other than a digit (e.g. (<kbd>OFF</kbd>, <kbd>QUIT</kbd>, <kbd>Q</kbd>,
<kbd>X</kbd>...), although, as noted above, mom will keep,
and—in the case of collated documents—increment the
chapter number, allowing you to turn prefixing of chapter numbers to
numbered head elements off and on according to your needs or whims.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Because PREFIX_CHAPTER_NUMBER takes an (optional) digit representing
the chapter number, it’s use need not be restricted to
<a href="docprocessing.html#doctype">DOCTYPE <kbd>CHAPTER</kbd></a>.
You can use it with any document type. Furthermore, even if
your doctype isn’t <kbd>CHAPTER</kbd>, you can identify
the document as a chapter for the purposes of numbering head
elements by invoking the macro
<a href="docprocessing.html#chapter"><kbd>.CHAPTER</kbd></a>
with a
<a href="definitions.html#numericargument">numeric argument</a>
in your document setup.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="oldstyle-headings-intro" class="macro-group">Oldstyle headings</h2>
<ul style="margin-left: -.5em;">
<li><a href="#oldstyle-headings">Macro: OLDSTYLE_HEADINGS</a></li>
<li><a href="#head">Macro: HEAD</a></li>
<li><a href="#subhead">Macro: SUBHEAD</a></li>
<li><a href="#subsubhead">Macro: SUBSUBHEAD</a></li>
</ul>
<p>
In versions of mom prior to 2.0, headings were entered by their
commonly used names, <i>viz.</i> HEAD, SUBHEAD, and SUBSUBHEAD. The
new
<a href="#heading-intro">HEADING</a>
scheme allows for greater flexibility, and permits seamless
integration with PDF output.
</p>
<p>
Documents created with pre-2.0 versions may still use the oldstyle
heading names, as may new documents, however there are some
differences in their behaviour.
</p>
<p>
Whenever mom encounters an oldstyle heading, she loads the default
style formerly associated with the oldstyle name. See below for a
description of the default styles in the sections
<a href="#head">HEAD</a> (now HEADING 1),
<a href="#subhead">SUBHEAD</a> (now HEADING 2),
and
<a href="#subsubhead">SUBSUBHEAD</a> (now HEADING 3).
Mom also emits a message to stderr alerting you to what she’s
doing.
</p>
<p>
The control macros formerly associated with oldstyle headings are no
longer present in mom’s macro file, which means that if you
made changes to mom’s default for those headings, you must
recreate the changes with the
<a href="#heading-style">HEADING_STYLE</a>
macro. The entire style need not be recreated, only those
parameters that differed from mom’s defaults. Thus, if your
HEADs were set flush left, instead of the oldstyle default, centred,
but otherwise kept mom’s settings, you need only do
<br/>
<span class="pre-in-pp">
.HEADING_STYLE 1 QUAD L
</span>
</p>
<div id="parahead" class="box-important">
<p class="tip-top">
<span class="important">Important:</span>
The macro PARAHEAD is no longer available. You must create paragraph
heads using the
<a href="#heading">HEADING</a>
macro. Mom will abort with an informational message whenever she
encounters PARAHEAD. Assuming a heading level of 3 for your
paraheads, the former defaults for PARAHEAD can be set up like this:
<br/>
<span class="pre-in-pp">
.HEADING STYLE 3 FONT BI SIZE -.25 \" For PRINTSTYLE TYPESET
.HEADING STYLE 3 FONT I SIZE +0 \" For PRINTSTYLE TYPEWRITE
</span>
Equally, the macro NUMBER_PARAHEADS is no longer available. You
must enable numbering of the correct level for paraheads with
HEADING_STYLE. Again assuming a heading level of 3 for paraheads,
it’s simply done:
<br/>
<span class="pre-in-pp">
.HEADING_STYLE 3 NUMBER
</span>
</p>
<h3 id="parahead-usage" class="docs" style="text-transform: none; margin-top: -1em">Correct usage of paraheads</h3>
<p style="margin-top: .5em">
It is tempting to choose an arbitrary heading level for paraheads,
since they are sometimes needed out-of-sequence; for example,
immediately after a main head (level-1) in a document that
subsequently requires subheads (level-2). In such a circumstance,
choosing level-3 for all your paraheads might seem to make sense,
but in fact doesn’t, since it disrupts the hierarchy of
both the Table of Contents (if your document has one) and the PDF
outline.
</p>
<p>
Correct use of the <kbd>PARAHEAD</kbd> option to HEADING under such
circumstances requires always assigning <kbd>PARAHEAD</kbd> to
the next logical level in the heading hierarchy. For example, if
there are no headings before the parahead, it should be assigned to
level-1. If subsequently there is a main head to be followed by
more paraheads, the main head should be level-1, and the paraheads
level-2. This will almost certainly require assigning new style
parameters to level-1 (with
<a href="#heading-style">HEADING_STYLE</a>)
and to the level now being used for paraheads. The following
example demonstrates.
<br/>
<span class="pre-in-pp">
.HEADING_STYLE 1 FONT BI SIZE +.25 \" parahead style, level-1
.PP
.HEADING 1 PARAHEAD <parahead>
<paragraph text>
.PP
.HEADING 1 PARAHEAD <parahead>
<paragraph text>
\# main head style, level-1
.HEADING_STYLE 1 FONT B SIZE +3 QUAD CENTER UNDERSCORE .5 2p
.HEADING_STYLE 2 FONT BI SIZE +.25 \" parahead style, level-2
.HEADING 1 <main head>
.PP
<paragraph text>
.PP
.HEADING 2 PARAHEAD <parahead>
<paragraph text>
</span>
</p>
</div>
<!-- -OLDSTYLE_HEADINGS - -->
<div class="macro-id-overline">
<h3 id="oldstyle-headings" class="macro-id">OLDSTYLE HEADINGS</h3>
</div>
<div class="box-macro-args">
Macro: <b>OLDSTYLE_HEADINGS</b>
</div>
<p>
OLDSTYLE_HEADINGS requires no argument. It instructs mom to set the
first three levels of heading to the parameters of her old defaults
for HEAD, SUBHEAD, and SUBSUBHEAD. Use of OLDSTYLE_HEADINGS will
also prevent mom from generating the message she issues the first
time she encounters HEAD, SUBHEAD, and SUBSUBHEAD.
</p>
<!-- -HEAD- -->
<div id="head" class="box-macro-args">
Macro: <b>HEAD</b> <kbd class="macro-args">[ NAMED <id> ] "<text of head>" "<another line>"...</kbd>
</div>
<p>
When invoked for the first time, with or without
<a href="oldstyle-headings">OLDSTYLE_HEADINGS</a>,
HEAD sets the parameters for level-1 headings to mom’s old
HEAD defaults, then prints the head as a level-1 heading.
The <kbd>NAMED <id></kbd> optional argument is explained in
the description of
<a href="#heading">HEADING</a>.
</p>
<p>
If, prior to invoking HEAD, you have given any parameters to level-1
heads with
<a href="#heading-style">HEADING STYLE</a>,
they will be preserved; any you give afterwards will be respected.
</p>
<p>
The former style defaults for HEAD were:
<br/>
<span class="pre-in-pp">
FAMILY = prevailing document family
FONT = bold (TYPESET); roman (TYPEWRITE)
SIZE = +1 (TYPESET); +0 (TYPEWRITE)
QUAD = C
UNDERSCORE .5 2p
CAPS
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The macro NUMBER_HEADS from pre-2.0 versions of mom, can still be
used, though it is now a wrapper for
<br/>
<span class="pre-in-pp">
.HEADING_STYLE 1 NUMBER
</span>
Mom will alert you to this on stderr.
</p>
</div>
<!-- -SUBHEAD- -->
<div id="subhead" class="box-macro-args">
Macro: <b>SUBHEAD</b> <kbd class="macro-args">[ NAMED <id> ] "<text of head>" "<another line>"...</kbd>
</div>
<p>
When invoked for the first time, with or without
<a href="oldstyle-headings">OLDSTYLE_HEADINGS</a>,
SUBHEAD sets the parameters for level-2 headings to mom’s old
SUBHEAD defaults, then prints the subhead as a level-2 heading.
The <kbd>NAMED <id></kbd> optional argument is explained in
the description of
<a href="#heading">HEADING</a>.
</p>
<p>
The former style defaults for SUBHEAD were:
<br/>
<span class="pre-in-pp">
FAMILY = prevailing document family
FONT = bold (TYPESET); italic, i.e. underlined (TYPEWRITE)
SIZE = +.5 (TYPESET); +0 (TYPEWRITE)
QUAD = L
BASELINE_ADJUST = 1/8 the current leading
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The macro NUMBER_SUBHEADS from pre-2.0 versions of mom, can still be
used, though it is now a wrapper for
<br/>
<span class="pre-in-pp">
.HEADING_STYLE 2 NUMBER
</span>
Mom will alert you to this on stderr.
</p>
</div>
<!-- -SUBSUBHEAD- -->
<div id="subsubhead" class="box-macro-args">
Macro: <b>SUBSUBHEAD</b> <kbd class="macro-args">[ NAMED <id> ] "<text of head>" "<another line>"...</kbd>
</div>
<p>
When invoked for the first time, with or without
<a href="oldstyle-headings">OLDSTYLE_HEADINGS</a>,
SUBSUBHEAD sets the parameters for level-3 headings to mom’s old
SUBSUBHEAD defaults, then prints the subsubhead as a level-3 heading.
The <kbd>NAMED <id></kbd> optional argument is explained in
the description of
<a href="#heading">HEADING</a>.
</p>
<p>
The former style defaults for SUBSUBHEAD were:
<br/>
<span class="pre-in-pp">
FAMILY = prevailing document family
FONT = italic (TYPESET); roman (TYPEWRITE)
SIZE = +.5 (TYPESET); +0 (TYPEWRITE)
QUAD = L
BASELINE_ADJUST = 1/8 the current leading
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The macro NUMBER_SUBSUBHEADS from pre-2.0 versions of mom, can still be
used, though it is now a wrapper for
<br/>
<span class="pre-in-pp">
.HEADING_STYLE 3 NUMBER
</span>
Mom will alert you to this on stderr.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="linebreak-intro" class="macro-group">Linebreaks (section breaks)</h2>
<ul style="margin-left: -.5em;">
<li><a href="#linebreak">Tag: LINEBREAK</a></li>
<li><a href="#linebreak-control">Linebreak control macros and defaults</a></li>
</ul>
<p>
Linebreaks (“author linebreaks”, “section
breaks”) are gaps in the vertical flow of running text that
indicate a shift in content (e.g. a scene change in story). They
are frequently set off by typographic symbols, sometimes whimsical
in nature.
</p>
<!-- -LINEBREAK- -->
<div class="macro-id-overline">
<h3 id="linebreak" class="macro-id">LINEBREAK</h3>
</div>
<div class="box-macro-args">
Macro: <b>LINEBREAK</b>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Alias:</i> <b>SECTION</b>
</p>
<p>
LINEBREAK takes no arguments. Simply invoke it (on a line by
itself, of course) whenever you want to insert an author linebreak.
</p>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="linebreak-control" class="docs defaults">LINEBREAK control macros and defaults</h3>
<p class="defaults">
By default, mom marks
<a href="definitions.html#linebreak">author linebreaks</a>
with three centred asterisks (stars) in the prevailing colour of the
document (by default, black). You can alter this with the control
macros
</p>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#linebreak-char">LINEBREAK_CHAR</a></li>
<li><a href="#linebreak-color">LINEBREAK_COLOR</a></li>
</ol>
</div>
<h4 id="linebreak-char" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Linebreak character</h4>
<div class="box-macro-args">
Macro: <b>LINEBREAK_CHAR</b> <kbd class="macro-args">[ <character> ] [ <iterations> [ <vertical adjustment> ] ]</kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Alias:</i> <b>SECTION_CHAR</b>
</p>
<p class="requires">
• The third optional argument requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>.
</p>
<p>
LINEBREAK_CHAR determines what mom prints when LINEBREAK is invoked.
It takes 3 optional arguments: the character you want deposited at
the line break, the number of times you want the character repeated,
and a vertical adjustment factor.
</p>
<p>
The first argument is any valid groff character (e.g. <kbd>*</kbd>
[an asterisk], <kbd>\[dg]</kbd> [a dagger], <kbd>\f[ZD]\N'141'\fP</kbd>
[an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd> [a
4-pica long rule]). Mom sets the character centred on the current
line length. (See <kbd>man groff_char</kbd> for a list of all
valid groff characters.)
</p>
<p>
The second argument is the number of times to repeat the character.
</p>
<p>
The third argument is a +|-value by which to raise (-) or lower (+)
the character in order to make it appear visually centred between
sections of text. This lets you make vertical adjustments to
characters that don’t sit on the
<a href="definitions.html#baseline">baseline</a>
(such as asterisks). The argument must be preceded by a plus or
minus sign, and must include a unit of measure.
</p>
<p>
If you enter LINEBREAK_CHAR with no arguments, sections of
text will be separated by two blank lines when you invoke
<kbd>.LINEBREAK</kbd>.
</p>
<p>
Mom’s default for LINEBREAK_CHAR is
<br/>
<span class="pre-in-pp">
.LINEBREAK_CHAR * 3 -3p
</span>
i.e. three asterisks, raised 3 points from their normal vertical
position (for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>;
the vertical adjustment is -2 points for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>).
</p>
<h4 id="linebreak-color" class="docs" style="margin-top: -.25em; margin-bottom: .5em;">2. Linebreak colour</h4>
<div class="box-macro-args">
Macro: <b>LINEBREAK_COLOR</b> <kbd class="macro-args"><colourname></kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Alias:</i> <b>SECTION_COLOR</b>
</p>
<p>
To change the colour of the linebreak character(s), simply invoke
<kbd>.LINEBREAK_COLOR</kbd> with the name of a colour pre-defined
(or “initialized”) with
<a href="color.html#newcolor">NEWCOLOR</a>
or
<a href="color.html#xcolor">XCOLOR</a>.
</p>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="quote-intro" class="macro-group">Quotes (line for line, poetry or code)</h2>
<ul style="margin-left: -.5em;">
<li><a href="#quote-description">Introduction</a>
<ul style="margin-left: -1.25em">
<li><a href="#quote-spacing">Quote spacing</a>
<ul style="margin-left: -1.25em">
<li><a href="#quote-spacing-notes">Notes on quote spacing</a></li>
</ul></li>
<li><a href="#no-shim">Disable shimming of quotes and blockquotes</a></li>
<li><a href="#float-quote">Keeping quotes and blockquotes together as a block</a></li>
<li><a href="#label-caption">Labelling/captioning quotes and blockquotes</a></li>
</ul></li>
<li><a href="#quote">Tag: QUOTE</a></li>
<li><a href="#quote-control">Quote control macros and defaults</a></li>
</ul>
<p id="quote-decription">
<a href="definitions.html#quote">Quotes</a>
are always set in
<a href="definitions.html#filled">nofill mode</a>,
flush left. This permits entering quotes on a line for line basis
in your text editor and have them come out the same way on output
copy. (See
<a href="#blockquote-intro">Blockquotes</a>
for how quotes, in the present sense, differ from longer passages of
cited text.)
</p>
<p>
Since mom originally came into being to serve the needs of creative
writers (i.e. novelists, short story writers, etc.—not
to cast aspersions on the creativity of mathematicians and
programmers), she sets quotes in italics
<a href="docprocessing.html#printstyle">(PRINTSTYLE <kbd>TYPESET</kbd>)</a>
or underlined
<a href="docprocessing.html#printstyle">(PRINTSTYLE <kbd>TYPEWRITE</kbd>)</a>,
indented from the left margin. Obviously, she’s thinking
“quotes from poetry or song lyrics”, but with the
<a href="#quote-control">QUOTE control macros</a>
you can change her defaults so QUOTE serves other needs, e.g.
entering verbatim snippets of programming code, command-line
instructions, and so on. (See the
<a href="#code">CODE</a>
for a convenience macro to assist in including code snippets in
documents.)
</p>
<h3 id="quote-spacing" class="docs">QUOTE spacing</h3>
<p>
Besides indenting quotes, mom further sets them off from
<a href="definitions.html#running">running text</a>
with a small amount of vertical whitespace top and bottom. In
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>,
this is always one full linespace. In
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>,
it’s 1/2 of the prevailing
<a href="definitions.html#leading">leading</a>
if the quote fits fully on the page (i.e. with running text above
and below it), otherwise it’s a full linespace either above
or below as is necessary to balance the page to the bottom margin.
This behaviour can be changed with the control macro
<a href="#always-fullspace-quotes">ALWAYS_FULLSPACE_QUOTES</a>.
</p>
<div class="box-tip">
<h3 id="quote-spacing-notes" class="docs" style="padding-top: 9px; font-size: 95%;">Notes on quote spacing</h3>
<p style="margin-top: .5em">
If your quote (or blockquote) leading differs from the document
leading, mom attempts to observe the same rules for vertical
whitespace outlined above; however, she will also insert a small,
flexible amount of extra whitespace
(<a href="docprocessing.html#shim-vs-flex">shim or flex-spacing</a>)
around the quotes to make sure the whitespace is equal, top and
bottom. When shimming is enabled, this may result in multiple
quotes or blockquotes on the same page being spaced slightly
differently.
</p>
<h4 id="no-shim" class="docs">Disable shimming/flex-spacing of quotes and blockquotes</h4>
<p class="tip-bottom">
If you don’t want the behaviour
described above (i.e., you don’t want mom putting additional shim
or flex-spacing around quotes and
blockquotes), put <kbd>.NO_SHIM</kbd> or/and <kbd>.NO_FLEX</kbd>
in the style sheet section of your document (i.e. after PRINTSTYLE
but before START), which will disable shimming or/and flex-spacing
globally for all tags, or disable shimming/flex-spacing
on a per-instance basis prior to <kbd>.QUOTE</kbd> or
<kbd>.BLOCKQUOTE</kbd>, re-enabling it after the terminating
<kbd>.QUOTE OFF</kbd> or <kbd>.BLOCKQUOTE OFF</kbd> with
<kbd>.NO_SHIM OFF</kbd> or <kbd>.NO_FLEX OFF</kbd>.
</p>
</div>
<h3 id="float-quote" class="docs">Keeping QUOTEs and BLOCKQUOTEs together as a block</h3>
<p>
The text of quotes and blockquotes is output immediately, and may therefore
start on one page and finish on the next. If you wish to keep the
text together as a block, deferred to the following page if the
block doesn’t all fit on one page, wrap
<kbd><span class="nobr">(BLOCK)QUOTE...(BLOCK)QUOTE OFF</span></kbd>
inside a
<a href="images.html#floats-intro">float</a>.
If you further wish to force a page break before the floated quote
or blockquote (leaving whitespace at the bottom of the page, pass
<a href="images.html#float">FLOAT</a>
the <kbd>FORCE</kbd> argument.
<span class="pre-in-pp">
.FLOAT FORCE
.QUOTE
Fly me to the moon
And let me play among the stars
Let me see what life is like
On Jupiter and Mars
.QUOTE END
.FLOAT OFF
</span>
</p>
<h3 id="label-caption" class="docs">Labelling/captioning quotes and blockquotes</h3>
<p>
Quotes and blockquotes may be labelled and/or captioned identically to
<a href="images.html#floats-intro">floats</a>
with the macros
<a href="images.html#label">LABEL</a>
and
<a href="images.html#caption">CAPTION</a>
(see
<a href="images.html#float-label-caption">Labelling and captioning floats</a>).
</p>
<!-- -QUOTE- -->
<div class="macro-id-overline">
<h3 id="quote" class="macro-id">QUOTE</h3>
</div>
<div class="box-macro-args">
Macro: <b>QUOTE</b> <kbd class="macro-args">[ ADJUST +|-<space> ] | <anything></kbd>
</div>
<p class="requires">
• The argument to <kbd style="font-style: normal">ADJUST</kbd> requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
QUOTE is a toggle macro. To begin a section of quoted text, invoke
it with no argument, then type in your quote. When you’re
finished, invoke <kbd>.QUOTE</kbd> with any argument (e.g. <kbd>OFF,
END, X, Q</kbd>...) to turn it off. Example:
<br/>
<span class="pre-in-pp">
.QUOTE
Nymphomaniacal Jill
Used a dynamite stick for a thrill
They found her vagina
In North Carolina
And bits of her tits in Brazil.
.QUOTE END
</span>
Mom does her best to equalize whitespace around quotes and make
sure the line following it falls on a valid baseline. On occasion,
you may need to tweak the quote placement slightly, which is done
by passing <kbd>ADJUST</kbd> to QUOTE with a plus or minus value.
The quote will be lowered (<kbd>+</kbd>) or raised (<kbd>-</kbd>)
<i>within the space allotted for it</i> by the given amount. For
example, to lower a quote slightly within the space allotted for it,
you’d do
<br/>
<span class="pre-in-pp">
.QUOTE ADJUST +3p
There was a soprano named Golda
Whose lovers grew colda and colda
For during love-making
She'd sing the earth-shaking
Love theme from Tristan und Isolde.
.QUOTE off
</span>
</p>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="quote-control" class="docs defaults">QUOTE control macros and defaults</h3>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#quote-general">Family/font/size/leading/colour/indent</a></li>
<li><a href="#always-fullspace-quotes">Spacing above and below quotes (typeset only)</a></li>
<li><a href="#underline-quotes">Underlining quotes (typewrite only)</a></li>
</ol>
</div>
<h4 id="quote-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour/indent</h4>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following QUOTE control macros may also be
<a href="#grouping">grouped</a>
using QUOTE_STYLE. If you do so, <kbd>QUOTE_LEFT</kbd>, <kbd>QUOTE_CENTER</kbd>,
and <kbd>QUOTE_RIGHT</kbd> must be entered as:
<br/>
<kbd> QUAD LEFT</kbd><br/>
<kbd> QUAD CENTER</kbd><br/>
<kbd> QUAD RIGHT</kbd>
</p>
<span class="pre defaults">
.QUOTE_FAMILY default = prevailing document family; default is Times Roman
.QUOTE_FONT default = italic; underlined in TYPEWRITE
.QUOTE_SIZE default = +0 (i.e. same size as paragraph text)
<a id="quote-autolead">.QUOTE_AUTOLEAD default = none; leading of quotes is the same as paragraphs </a>
.QUOTE_COLOR default = black
.QUOTE_INDENT (see below, "Quote indent")
.QUOTE_LEFT -+ Quad direction of quote.
.QUOTE_CENTER | LEFT observes QUOTE_INDENT;
.QUOTE_RIGHT -+ CENTER and RIGHT do not
</span>
</div>
<h4 id="quote-indent" class="docs" style="margin-top: -1.5em;">Quote indent</h4>
<p>
<kbd>QUOTE_INDENT</kbd> takes one of two kinds of argument: an integer
representing the amount by which to multiply the argument passed to
<a href="#para-indent"><kbd>.PARA_INDENT</kbd></a>
(by default, 2
<a href="definitions.html#em">ems</a>
for TYPESET, 3
<a href="definitions.html#picaspoints">picas</a>
for TYPEWRITE) to arrive at the quote indent, or a distance with a
<a href="definitions.html#unitofmesaure">unit of measure</a>
appended.
</p>
<p>
Be careful when using QUOTE. If a quote is set flush left (the
default), the QUOTE_INDENT applies only to the left margin. Because
quote lines are output as-is (see
<a href="definitions.html#no-fill">no-fill mode</a>),
they do not respect line length and may extend beyond a document's
right margin. Similarly, if a quote is being set flush right, the
indent applies only to the right margin; long lines may extend into
the left margin. Centered quotes are never indented, so long lines
may extend beyond both the left and right margins.
</p>
<p>
The default value for QUOTE_INDENT is 3 (for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>)
and 1 (for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>).
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If your PARA_INDENT is 0 (i.e. no indenting of the first line of
paragraphs), you <i>must</i> set a QUOTE_INDENT yourself, with a
unit of measure appended to the argument. Mom has no default for
QUOTE_INDENT if paragraph first lines are not being indented.
</p>
</div>
<h4 id="always-fullspace-quotes" class="docs" style="margin-top: -.25em;">2. Spacing above and below quotes (typeset only)</h4>
<p>
If you’d like mom always to put a full linespace above and
below quotes, invoke
<br/>
<span class="pre-in-pp">
.ALWAYS_FULLSPACE_QUOTES
</span>
with no argument. If you wish to restore mom’s
default behaviour regarding the spacing of quotes (see
<a href="#quote-spacing">Quote spacing</a>),
invoke the macro with any argument (<kbd>OFF</kbd>, <kbd>QUIT</kbd>,
<kbd>END</kbd>, <kbd>X</kbd>...)
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
This macro also sets mom’s spacing policy for
<a href="#blockquote-intro">blockquotes</a>.
</p>
</div>
<h4 id="underline-quotes" class="docs" style="margin-top: -.25em;">3. Underlining quotes (typewrite only)</h4>
<p>
By default in
<a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
mom underlines quotes. If you’d rather she didn’t,
invoke <kbd>.UNDERLINE_QUOTES</kbd> with any argument
(<kbd>OFF</kbd>, <kbd>QUIT</kbd>, <kbd>END</kbd>, <kbd>X</kbd>...)
to disable the feature. Invoke it without an argument to restore
mom’s default underlining of quotes.
</p>
<p>
If you not only wish that mom not underline quotes, but also that
she set them in italic, you must follow each instance of QUOTE with
the typesetting macro
<a href="typesetting.html#font">FT I</a>.
Furthermore, since mom underlines all instances of italics by
default in PRINTSTYLE TYPEWRITE, you must also make sure that
ITALIC_MEANS_ITALIC is enabled (see
<a href="docprocessing.html#typewrite-control">PRINTSTYLE TYPEWRITE control macros</a>).
</p>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="blockquote-intro" class="macro-group">Blockquotes (cited material)</h2>
<ul style="margin-left: -.5em;">
<li><a href="#blockquote-description">Introduction</a></li>
<li><a href="#blockquote">Tag: BLOCKQUOTE</a></li>
<li><a href="#blockquote-control">BLOCKQUOTE control macros</a></li>
</ul>
<p id="blockquote-description">
<a href="definitions.html#blockquote">Blockquotes</a>
are used to cite passages from another author’s work. So that
they stand out well from
<a href="definitions.html#running">running text</a>,
mom indents them from both the left and right margins and sets them
in a different point size
(<a href="docprocessing.html#printstyle">PRINTSTYLE TYPESET</a>
only).
<a href="definitions.html#outputline">Output lines</a>
are
<a href="definitions.html#filled">filled</a>,
and, by default,
<a href="definitions.html#quad">quadded</a>
left.
</p>
<p>
Besides indenting blockquotes, mom further sets them off from
running text with a small amount of vertical whitespace top and
bottom. (See
<a href="#quote-spacing">Quote spacing</a>
for a complete explanation of how this is managed, and how
to control it.)
</p>
<p>
Additional information concerning blockquotes, floats, and labelling
blockquotes can be found in the sections
<a href="#float-quote">Keeping quotes and blockquotes together as a block</a>,
and
<a href="#label-caption">Labelling/captioning quotes and blockquotes</a>.
</p>
<!-- -BLOCKQUOTE- -->
<div class="macro-id-overline">
<h3 id="blockquote" class="macro-id">BLOCKQUOTE</h3>
</div>
<div class="box-macro-args">
Macro: <b>BLOCKQUOTE</b> <kbd class="macro-args">[ ADJUST +|-<space> ] | <anything></kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Aliases: </i> <b>CITE, CITATION</b>
</p>
<p class="requires">
• The argument to <kbd style="font-style: normal">ADJUST</kbd> requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
BLOCKQUOTE is a toggle macro. To begin a cited passage, invoke
the tag with no argument, then type in your blockquote. When
you’re finished, invoke <kbd>.BLOCKQUOTE</kbd> with any
argument (e.g. <kbd>OFF, END, X, Q</kbd>...) to turn it off.
Example:
<br/>
<span class="pre-in-pp">
.BLOCKQUOTE
Redefining the role of the United States from enablers to keep
the peace to enablers to keep the peace from peacekeepers is
going to be an assignment.
.RIGHT
\[em]George W. Bush
.BLOCKQUOTE END
</span>
If the cited passage runs to more than one paragraph, you must
introduce each paragraph—including the first—with
<kbd><a href="#pp">.PP</a></kbd>.
</p>
<p>
Mom does her best to equalize whitespace around blockquotes and make
sure the line following it falls on a valid baseline. On occasion,
you may need to tweak the blockquote placement slightly, which is
done by passing <kbd>ADJUST</kbd> to BLOCKQUOTE with a plus or minus
value. The blockquote will be lowered (<kbd>+</kbd>) or raised
(<kbd>-</kbd>) <i>within the space allotted for it</i> by the given
amount. For example, to raise a blockquote slightly within the
space allotted for it, you’d do
<br/>
<span class="pre-in-pp">
.BLOCKQUOTE ADJUST -3p
True! - nervous - very, very dreadfully nervous I had been and
am; but why will you say that I am mad? The disease had sharpened
my senses - not destroyed - not dulled them.
.RIGHT
\[em]Edgar Allen Poe, The Tell-Tale Heart
.QUOTE off
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The aliases CITE and CITATION may be used in place of the BLOCKQUOTE
tag, as well as in any of the control macros that begin or end with
BLOCKQUOTE_.
</p>
</div>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="blockquote-control" class="docs defaults">BLOCKQUOTE control macros and defaults</h3>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#blockquote-general">Family/font/size/leading/colour/quad/indent</a></li>
<li><a href="#bq-always-fullspace-quotes">Spacing above and below (typeset only)</a></li>
</ol>
</div>
<h4 id="blockquote-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour/quad/indent</h4>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following BLOCKQUOTE control macros may also be
<a href="#grouping">grouped</a>
using BLOCKQUOTE_STYLE.
</p>
<span class="pre defaults">
.BLOCKQUOTE_FAMILY default = prevailing document family; default is Times Roman
.BLOCKQUOTE_FONT default = roman
.BLOCKQUOTE_SIZE default = -1 (point)
<a id="blockquote-autolead">.BLOCKQUOTE_AUTOLEAD default = none; leading of blockquotes is the same as paragraphs</a>
.BLOCKQUOTE_COLOR default = black
.BLOCKQUOTE_QUAD default = left
.BLOCKQUOTE_INDENT (see below)
</span>
</div>
<h4 id="blockquote-indent" class="docs" style="margin-top: -1.5em;">Blockquote indent</h4>
<p>
<kbd>BLOCKQUOTE_INDENT</kbd> takes one of two kinds of argument: an
integer representing the amount by which to multiply the argument
passed to
<a href="#para-indent">PARA_INDENT</a>
(by default, 2
<a href="definitions.html#em">ems</a>
for TYPESET, 3
<a href="definitions.html#picaspoints">picas</a>
for TYPEWRITE) to arrive at the blockquote indent, or a distance with a
<a href="definitions.html#unitofmesaure">unit of measure</a>
appended. Both result in blockquotes being indented equally from
the left and right margins.
</p>
<p>
The default value for BLOCKQUOTE_INDENT is 3 (for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>)
and 1 (for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>).
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If your PARA_INDENT is 0 (i.e. no indenting of the first line of
paragraphs), you must set a BLOCKQUOTE_INDENT yourself, with
a unit of measure appended to the argument. Mom has no default for
BLOCKQUOTE_INDENT if paragraph first lines are not being indented.
</p>
</div>
<h4 id="bq-always-fullspace-quotes" class="docs">2. Spacing above and below blockquotes (typeset only)</h4>
<p>
If you’d like mom always to put a full linespace above and
below blockquotes, invoke
<br/>
<span class="pre-in-pp">
.ALWAYS_FULLSPACE_QUOTES
</span>
with no argument. If you wish to restore mom’s default
behaviour regarding the spacing of blockquotes (see
<a href="#quote-spacing">Quote spacing</a>),
invoke the macro with any argument (<kbd>OFF</kbd>, <kbd>QUIT</kbd>,
<kbd>END</kbd>, <kbd>X</kbd>...).
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
This macro also sets mom’s spacing policy for
<a href="#quote-intro">quotes</a>.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="code-intro" class="macro-group">Inserting code into a document</h2>
<ul style="margin-left: -.5em;">
<li><a href="#code">Tag: CODE</a></li>
<li><a href="#code-control">CODE control macros and defaults</a></li>
</ul>
<p>
CODE is a convenience macro that facilitates entering code blocks
into documents. Its use is not restricted to documents created
using mom’s document processing macros; it can be used for
“manually” typeset documents as well.
</p>
<div class="macro-id-overline">
<h3 id="code" class="macro-id">CODE</h3>
</div>
<div class="box-macro-args">
Macro: <b>CODE</b> <kbd class="macro-args">[BR | BREAK | SPREAD] <anything></kbd>
</div>
<p class="requires" style="font-style: normal">
Inline escape: <b><kbd>\*[CODE]</kbd></b>
</p>
<p>
When you invoke the macro CODE or insert
<kbd><span class="nobr">\*[CODE]</span></kbd> into running text, mom switches to
a
<a href="definitions.html#fixedwidthfont">fixed-width font</a>
(Courier, by default) and turns
<a href="goodies.html#smartquotes">SMARTQUOTES</a>
off.
</p>
<p>
If your code includes the backslash character, which is
groff’s escape character, you will have to change the
escape character temporarily to something else with the macro
<a href="goodies.html#esc-char">ESC_CHAR</a>.
Mom has no way of knowing what special characters you’re going
to use in code snippets, therefore she cannot automatically replace
the escape character with something else.
</p>
<p>
The correct order for changing the escape character inside
<kbd>CODE</kbd> is
<span class="pre-in-pp">
.CODE
.ESC_CHAR character
<code>
.ESC_CHAR \
.CODE OFF
</span>
Be aware that changing the escape character prevents subsequent
macros, which require that the backslash be the escape character,
from functioning correctly. Therefore, do not introduce any macros
into your CODE block without first restoring the escape character to
its default.
</p>
<p>
Alternatively, you can enter the backslash character as
<kbd>\e</kbd> or <kbd>\\</kbd> (two backslashes), which tells groff
to print a literal backslash.
</p>
<div class="box-tip">
<p class="tip-top">
<span class="tip">Note:</span>
<kbd>.CODE</kbd> does not cause a line break when
you’re in a
<a href="definitions.html#filled">fill mode</a>
(i.e.
<a href="typesetting.html#justify">JUSTIFY</a>
or
<a href="typesetting.html#quad">QUAD</a>
<kbd>LEFT, CENTER,</kbd> or <kbd>RIGHT</kbd>).
If you want CODE to deposit a break, invoke <kbd>.CODE</kbd> with
the argument <kbd>BR</kbd> (or <kbd>BREAK</kbd>). If, in addition
to having mom break the line before <kbd>.CODE</kbd>, you want her
to
<a href="definitions.html#force">force justify</a>
it as well, invoke <kbd>.CODE</kbd> with the argument,
<kbd>SPREAD</kbd>. If, in addition to breaking the line before CODE
you want a break afterwards, you must supply it manually with
<a href="typesetting.html#br">BR</a>
unless what follows immediately is a macro that automatically causes
a break (e.g.
<a href="#pp">PP</a>).
</p>
<p id="quote-code" class="tip-bottom">
In all likelihood, if you want the situation described above (i.e. a
break before and after CODE), what you probably want is to use
<a href="quote">QUOTE</a>
in conjunction with CODE, like this:
<br/>
<span class="pre-in-pp">
.QUOTE
.CODE
$ echo "Hello, world" | sed -e 's/Hello,/Goodbye, cruel/'
.QUOTE OFF
</span>
QUOTE takes care of breaking both the text and the code, as well as
indenting the code and offsetting it from
<a href="definitions.html#running">running text</a>
with vertical whitespace. Notice that <kbd>.CODE</kbd>, above, has
no corresponding <kbd>.CODE OFF</kbd>. <kbd>.CODE</kbd> inside a QUOTE
does not require a terminating <kbd>.CODE OFF</kbd>, which risks
introducing unwanted vertical whitespace.
</p>
</div>
<p>
Passing any argument other than <kbd>BR</kbd>, <kbd>BREAK</kbd> or
<kbd>SPREAD</kbd> to CODE (e.g. <kbd>OFF</kbd>, <kbd>QUIT</kbd>,
<kbd>END</kbd>, <kbd>X</kbd>, etc) turns CODE off and returns the
family, font, and smartquotes back to their former state.
</p>
<h4 class="docs" style="font-size: 102%">Using <kbd>\*[CODE]</kbd> inline</h4>
<p>
<kbd><span class="nobr">\*[CODE]</span></kbd> invokes <kbd>.CODE</kbd>, allowing you to
bracket code snippets inline. It does not accept the <kbd>BR</kbd>,
<kbd>BREAK</kbd>, or <kbd>SPREAD</kbd> arguments. It is most useful
for short snippets, as in the following example.
<br/>
<span class="pre-in-pp">
\*[CODE]apropos\*[CODE X] and \*[CODE]man -k\*[CODE X] are identical.
</span>
</p>
<p>
<kbd><span class="nobr">\*[CODE]</span></kbd> does not permit changing the escape
character, so <kbd>\e</kbd> or a doubled backslash must be used.
Furthermore, if your code starts with a period, you must enter it as
“<kbd>\&.</kbd>”.
<br/>
<span class="pre-in-pp">
Registers are created with the \*[CODE]\&.nr\*[CODE X] request.
</span>
</p>
<h4 class="docs" style="font-size: 102%; margin-top: -1em">CODE and punctuation</h4>
<p>
<kbd>.CODE OFF</kbd> automatically inserts a word space into
running text. If your CODE block is to be followed by punctuation
with the parameters of
<a href="definitions.html#running">running text</a>,
you must terminate the block with “<kbd>\c</kbd>” and
enter the punctuation at the beginning of the next input line. If
the punctuation mark is a period or an apostrophe, you must precede
it with
“<kbd>\&</kbd>”.
<br/>
<span class="pre-in-pp">
...for example,
.CODE
echo "Hello, world" | sed -e 's/Hello,/Goodbye, cruel/'\c
.CODE OFF
\&. As this demonstrates...
</span>
Use of <kbd><span class="nobr">\*[CODE]</span></kbd> inline does not require
the <kbd>\c</kbd>, however periods and apostrophes after
<kbd><span class="nobr">\*[CODE X]</span></kbd> still need to be introduced
with <kbd>\&</kbd>, as in this example:
<br/>
<span class="pre-in-pp">
...append the unit of measure \*[CODE]p\*[CODE OFF]\&. New sentence...
</span>
</p>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="code-control" class="docs defaults">CODE control macros and defaults</h3>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#code-general">Family/Font/Colour</a></li>
<li><a href="#code-size">Size</a></li>
</ol>
</div>
<h4 id="code-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/colour</h4>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following CODE control macros may also be
<a href="#grouping">grouped</a>
using CODE_STYLE.
</p>
<span class="pre defaults">
.CODE_FAMILY default = Courier
.CODE_FONT default = roman; see Note
.CODE_COLOR default = black
Note: Unlike other control macros, CODE_FONT sets the code font for both
PRINTSTYLE TYPESET and PRINTSTYLE TYPEWRITE.
</span>
</div>
<h4 id="code-size" class="docs" style="margin-top: -1.25em;">2. Size</h4>
<p>
CODE_SIZE works a little differently from the other _SIZE macros
(see <a href="#control-macro-args">Arguments to the control
macros</a>). The argument you pass it is a percentage of the
prevailing document point size. It does not require a prepended
plus (<kbd>+</kbd>) or minus (<kbd>-</kbd>) sign, nor an appended
percent sign (<kbd>%</kbd>). Thus, if you want the point size of your CODE font to be
90% of the prevailing document point size, you enter:
<br/>
<span class="pre-in-pp">
.CODE_SIZE 90
</span>
Fixed-width fonts have notoriously whimsical
<a href="definitions.html#xheight">x-heights</a>,
meaning that they frequently look bigger (or, in some cases,
smaller) than the type surrounding them, even if they’re
technically the same point size. CODE_SIZE lets you choose a
percentage of the prevailing point size for your fixed-width
CODE font so it doesn’t look gangly or minuscule in relation
to the type around it. All invocations of <kbd>.CODE</kbd> or
<kbd><span class="nobr">\*[CODE]</span></kbd> will use this size, so that if you
decide to change the prevailing point size of your document, the
CODE font will be scaled proportionally.
</p>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="list-intro" class="macro-group">Nested lists</h2>
<ul style="margin-left: -.5em;">
<li><a href="#list">Tag: LIST</a></li>
<li><a href="#item">Tag: ITEM</a></li>
<li><a href="#list-control">LIST control macros and defaults</a></li>
</ul>
<p>
Lists are points or items of interest or importance that are
separated from
<a href="definitions.html#running">running text</a>
by enumerators. Some typical enumerators are
<a href="definitions.html#em">en-dashes</a>,
<a href="definitions.html#bullet">bullets</a>,
digits and letters.
</p>
<p>
Setting lists with mom is easy. First, you initialize a list with
the LIST macro. Then, for every item in the list, you invoke
the macro <kbd>.ITEM</kbd> followed by the text of the item.
When a list is finished, you exit the list with
<kbd>.LIST OFF</kbd> (or <kbd>QUIT</kbd>, <kbd>END</kbd>,
<kbd>BACK</kbd>, etc.)
</p>
<p>
By default mom starts each list with the enumerator flush with the
left margin of running text that comes before it, like this:
<br/>
<span class="pre-in-pp">
My daily schedule needs organising. I can’t
seem to get everything done I want.
o an hour’s worth of exercise
o time to prepare at least one healthy
meal per day
o reading time
o work on mom
o writing
- changes from publisher
- current novel
o a couple of hours at the piano
</span>
In other words, mom does not, by default, indent entire lists.
Indenting a list is controlled by the macro
<a href="#shift-list">SHIFT_LIST</a>.
(This is a design decision; there are too many instances where a
default indent is not desirable.) Equally, mom does not add any
extra space above or below lists.
</p>
<p>
Lists can be nested (as in the example above). In other words,
you can set lists within lists, each with an enumerator (and
possibly, indent) of your choosing. In nested lists, each
invocation of <kbd>.LIST OFF</kbd> (you may prefer to use
<kbd>.LIST BACK</kbd>) takes you back to the previous depth
(or level) of list, with that list’s enumerator and indent
intact. The final <kbd>.LIST OFF</kbd> exits lists completely
and returns you to the left margin of running text.
</p>
<p>
If
<kbd><a href="typesetting.html#quad">QUAD CENTER</a></kbd>
is in effect when LIST is invoked, the list is set quad left but
centred on the page as a block, based on the longest line of list
text. Equally, if <kbd>QUAD RIGHT</kbd> in in effect, the list is
set flush left but quadded right as a block. If you want a centred
or right-quadded list in an otherwise left-quadded or justified
document, simply invoke <kbd>.QUAD <direction></kbd>
before the list and reset the quad afterwards. Do not use
<kbd><a href="typesetting.html#lrc">CENTER</a></kbd>
or
<kbd><a href="typesetting.html#lrc">RIGHT</a></kbd>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Mom centres lists over the entire line length, disregarding
<a href="typesetting.html#ib">IB</a>
if it is in effect. If there are lines in the list that exceed
the margins of IB, they must be broken manually with
<kbd>.BR</kbd> if you wish to keep them within the indented margins.
</p>
</div>
<p>
Finally, lists can be used in documents created with either the
<a href="docprocessing.html#top">document processing macros</a>
or just the
<a href="typesetting.html#top">typesetting macros</a>.
</p>
<!-- -LIST- -->
<div class="macro-id-overline">
<h3 id="list" class="macro-id">LIST</h3>
</div>
<div class="box-macro-args">
Macro: <b>LIST</b> <kbd class="macro-args">[ BULLET | DASH | DIGIT | ALPHA | alpha | ROMAN<n> | roman<n> | USER <user-defined enumerator> | PLAIN | VARIABLE <character>] [ <separator> ] [ <prefix> ] [ <anything> ]</kbd>
</div>
<p>
Invoked by itself (i.e. with no argument), LIST
initializes a list with bullets as the default enumerator.
Afterwards, each block of input text preceded by
<kbd><a href="#item">.ITEM</a></kbd>,
on a line by itself, is treated as a list item.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Every time you invoke <kbd>.LIST</kbd> to start a list (as opposed to
<a href="#list-exit">exiting one</a>),
you must supply an enumerator (and optionally, a separator) for the
list, unless you want mom’s default enumerator, which is a
bullet. Within nested lists, mom stores the enumerator, separator
and indent for any list you return <i>backwards</i> to (i.e. with
<kbd>.LIST OFF</kbd>), but does not store any information for lists
you move <i>forward</i> to.
</p>
</div>
<p>
There are a lot of arguments (be sure to side-scroll through them
all, above), so I’ll discuss them one at a time here.
</p>
<h3 class="docs">The first argument – enumerator style</h3>
<p>
The optional arguments <kbd>BULLET</kbd>, <kbd>DASH</kbd>,
<kbd>DIGIT</kbd> (for Arabic numerals), <kbd>ALPHA</kbd> (for
uppercase letters), <kbd>alpha</kbd> (for lowercase letters),
<kbd>ROMAN<n></kbd> (for uppercase roman numerals),
<kbd>roman<n></kbd> (for lowercase roman numerals) tell
mom what kind of enumerator to use for a given list.
</p>
<p>
The arguments, <kbd>ROMAN<n></kbd> and
<kbd>roman<n></kbd>, are special. You must append to them
a digit (arabic, e.g. "1" or "9" or "17") saying how many items a
particular roman-numeraled LIST is going to have. Mom requires this
information in order to align roman numerals sensibly, and will
abort—with a message — if you don’t provide it.
(For setting roman numeral and digit lists with the enumerators
aligned flush right—the default is flush left—see
<a href="#pad-list-digits">PAD_LIST_DIGITS</a>.)
</p>
<p>
A roman-numeraled list containing, say, five items, would be set
up like this:
<br/>
<span class="pre-in-pp">
.LIST roman5 producing i) Item 1.
.ITEM ii) Item 2.
Item 1. iii) Item 3.
.ITEM iv) Item 4.
Item 2. v) Item 5.
.ITEM
Item 3
.ITEM
Item 4
.ITEM
Item 5
</span>
</p>
<p>
The argument <kbd>VARIABLE <character></kbd> lets
you choose different enumerators for the items in a list.
<kbd><character></kbd> is the widest enumerator to
be used. Thus, if you have a list enumerated by both bullets
and em-dashes, you’d set it up with
<br/>
<span class="pre-in-pp">
.LIST VARIABLE \[em]
</span>
and select the enumerator you want with
<br/>
<span class="pre-in-pp">
.ITEM \[em]
</span>
or
<br/>
<span class="pre-in-pp">
.ITEM \[bu]
</span>
If your enumerator contains spaces, you must enclose the
<kbd><character></kbd> argument in both LIST and ITEM in
double-quotes, e.g.
<br/>
<span class="pre-in-pp">
.LIST VARIABLE "\*[UP 1p]\[bu]\*[DOWN 1p]"
.ITEM "\*[UP 1p]\[bu]\*[DOWN 1p]"
</span>
</p>
<p>
The argument <kbd>USER</kbd> lets you make up your own enumerator,
and must be followed by a second argument: what you’d like the
enumerator to look like. For example, if you want a list enumerated
with <kbd>=></kbd>,
<br/>
<span class="pre-in-pp">
.LIST USER =>
.ITEM
A list item
</span>
will produce
<br/>
<span class="pre-in-pp">
=> A list item
</span>
Some useful special groff characters you might want to pass to
<kbd>USER</kbd> are:
<span class="pre-in-pp">
\[sq] - square box
\[rh] - pointing hand
\[->] - right arrow
\[rA] - right double arrow
\[OK] - checkmark
</span>
The size and vertical positioning of special characters may be
adjusted with
<a href="definitions.html#inlines">inline escapes</a>
in the argument passed to USER. For example, to raise the position
of <kbd><span class="nobr">\[sq]</span></kbd> slightly, you might do
<span class="pre-in-pp">
.LIST USER "\*[UP .25p]\[sq]\*[DOWN .25p]"
or
.LIST USER \v'-.25p'\[sq]\v'.25p'
</span>
</p>
<p>
The argument <kbd>PLAIN</kbd> initializes a list with no enumerator.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If the argument to <kbd>USER</kbd> contains spaces, you must enclose
the argument in double quotes.
</p>
</div>
<h3 class="docs">The second argument – separator style</h3>
<p>
If you choose <kbd>DIGIT</kbd>, <kbd>ALPHA</kbd>, <kbd>alpha</kbd>,
<kbd>ROMAN<n></kbd>, or <kbd>roman<n></kbd>, you may
enter the optional argument, <kbd>separator</kbd>, to say what kind
of separator you want after the enumerator. The separator can be
anything you like. The default for <kbd>DIGIT</kbd> is a period
(dot), like this:
<br/>
<span class="pre-in-pp">
1. A list item
</span>
The default separator for <kbd>ALPHA</kbd>, <kbd>alpha</kbd>,
<kbd>ROMAN<n></kbd> and <kbd>roman<n></kbd> is a right
parenthesis, like this:
<br/>
<span class="pre-in-pp">
a) An alpha-ed list item
b) A second alpha-ed list item
</span>
If you’d prefer, say, digits with right-parenthesis separators
instead of the default period, you’d do
<br/>
<span class="pre-in-pp">
.LIST DIGIT )
.ITEM
A numbered list item
</span>
which would produce
<br/>
<span class="pre-in-pp">
1) A numbered list item
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd>BULLET</kbd>, <kbd>DASH</kbd> and <kbd>USER</kbd> do not take a
separator.
</p>
</div>
<h3 class="docs">The third argument – prefix style</h3>
<p>
Additionally, you may give a prefix (i.e. a character
that comes <i>before</i> the enumerator) when your
enumerator style for a particular list is <kbd>DIGIT</kbd>,
<kbd>ALPHA</kbd>, <kbd>alpha</kbd>, <kbd>ROMAN<n></kbd> or
<kbd>roman<n></kbd>. In the arguments to LIST, the prefix
comes <i>after</i> the separator, which is counter-intuitive,
so please be careful.
</p>
<p>
A prefix can be anything you like. Most likely, you’ll want
some kind of open-bracket, such as a left parenthesis. If, for
example, you want a <kbd>DIGIT</kbd> list with the numbers enclosed
in parentheses, you’d enter
<br/>
<span class="pre-in-pp">
.LIST DIGIT ) (
.ITEM
The first item on the list.
.ITEM
The second item on the list.
</span>
which would produce
<br/>
<span class="pre-in-pp">
(1) The first item on the list.
(2) The second item on the list.
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd>BULLET</kbd>, <kbd>DASH</kbd> and
<kbd>USER</kbd> do not take a prefix.
</p>
</div>
<h3 class="docs">Exiting lists – LIST OFF / BACK or QUIT_LISTS</h3>
<p>
Any single argument to <kbd>LIST</kbd> other than
<kbd>BULLET</kbd>, <kbd>DASH</kbd>, <kbd>DIGIT</kbd>,
<kbd>ALPHA</kbd>, <kbd>alpha</kbd>, <kbd>ROMAN<n></kbd>,
<kbd>roman<n></kbd> or <kbd>USER</kbd> (e.g.
<kbd>LIST OFF</kbd> or <kbd>LIST BACK</kbd>) takes you out
of the current list.
</p>
<p>
If you are at the first list-level (or list-depth), mom returns you
to the left margin of running text. Any indents that were in effect
prior to setting the list are fully restored.
</p>
<p>
If you are in a nested list, mom moves you back one list-level
(i.e., does not take you out of the list structure) and restores the
enumerator, separator and indent appropriate to that level.
</p>
<p>
Each invocation of <kbd>.LIST</kbd> should thus be matched by
a corresponding <kbd>.LIST OFF</kbd> in order to fully exit
lists. For example,
<br/>
<span class="pre-in-pp">
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
o List item in level 1
o List item in level 1
- List item in level 2
- List item in level 2
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
</span>
is created like this:
<br/>
<span class="pre-in-pp">
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
.LIST BULLET
.ITEM
List item in level 1
.ITEM
List item in level 1
.LIST DASH
.ITEM
List item in level 2
.ITEM
List item in level 2
.LIST OFF \" Turn level 2 list off
.LIST OFF \" Turn level 1 list off
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
</span>
Alternatively, you may use the single-purpose macro
<kbd>.QUIT_LISTS</kbd>, to get yourself out of a list structure. In
the example above, the two <kbd>.LIST OFF</kbd> lines could be
replaced with a single <kbd>.QUIT_LISTS</kbd>.
</p>
<div class="macro-id-overline">
<h3 id="item" class="macro-id">ITEM</h3>
</div>
<div class="box-macro-args">
Macro: <b>ITEM</b> <kbd class="macro-args">[<enumerator>] [<space>]</kbd>
</div>
<p class="requires">
• The argument to <kbd style="font-style: normal"><space></kbd> requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
After you’ve initialized a list with
<a href="#list">LIST</a>,
precede each item you want in the list with <kbd>.ITEM</kbd>. Mom
takes care of everything else with respect to setting the item
appropriate to the list you’re in.
</p>
<p>
If you’ve chosen the <kbd>VARIABLE</kbd> argument when
invoking LIST, ITEM must be followed by an enumerator character.
</p>
<p>
If you give ITEM a space argument, either by itself or after a
variable enumerator character, the item will be spaced by the amount
of the argument.
</p>
<p>
In document processing, it is valid to have list items that contain
multiple paragraphs. Simply issue a
<kbd><a href="#pp">.PP</a></kbd>
request for each paragraph <i>following</i> the first item.
I.e., don’t do this:
<br/>
<span class="pre-in-pp">
.ITEM
.PP
Some text...
.PP
A second paragraph of text
</span>
but rather
<br/>
<span class="pre-in-pp">
.ITEM
Some text...
.PP
A second paragraph of text
</span>
</p>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="list-control" class="docs defaults">LIST control macros and defaults</h3>
<p style="margin-top: 0; margin-left: .5em">
LIST control macros may not be
<a href="#grouping">grouped</a>.
</p>
<ol style="margin-top: -.5em; padding-left: 1.5em; padding-bottom: .5em;">
<li><a href="#shift-list">Indenting lists (SHIFT_LIST)</a></li>
<li><a href="#reset-list">Resetting an initialized list’s enumerator (RESET_LIST)</a></li>
<li><a href="#pad-list-digits">Padding digit enumerators (PAD_LIST_DIGITS)</a></li>
</ol>
</div>
<h4 id="shift-list" class="docs" style="margin-top: -1.5em;">1. Indenting lists – SHIFT_LIST</h4>
<p>
If you want a list to be indented to the right of running text, or
indented to the right of a current list, use the macro SHIFT_LIST
immediately after
<a href="#list">LIST</a>.
SHIFT_LIST takes just one argument: the amount by which you want the
list shifted to the right. The argument requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>.
</p>
<p>
SHIFT_LIST applies only to the list you just initialized with LIST.
It does not carry over from one invocation of LIST to the next.
However, the indent remains in effect when you return to a list
level in a nested list.
</p>
<p>
For example, if you want a 2-level list, with each list indented to
the right by 18
<a href="definitions.html#picaspoints">points</a>,
<br/>
<span class="pre-in-pp">
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
.LIST \" List 1
.SHIFT_LIST 18p \" Indent 18 points right of running text
.ITEM
List 1 item
.ITEM
List 1 item
.LIST DASH \" List 2
.SHIFT_LIST 18p \" Indent 18 points right of list 1
.ITEM
List 2 item
.ITEM
List 2 item
.LIST OFF \" Move back to list 1
.ITEM
List 1 item
.ITEM
List 1 item
.LIST OFF \" Exit lists
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
</span>
produces (approximately)
<br/>
<span class="pre-in-pp">
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
• List 1 item
• List 1 item
- List 2 item
- List 2 item
• List 1 item
• List 1 item
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
</span>
</p>
<h4 id="reset-list" class="docs" style="margin-top: -.25em;">2. Resetting an initialized list’s enumerator – RESET_LIST</h4>
<p>
In nested lists, if your choice of enumerator for a given level
of list is <kbd>DIGIT</kbd>, <kbd>ALPHA</kbd>, <kbd>alpha</kbd>,
<kbd>ROMAN</kbd> or <kbd>roman</kbd>, you may sometimes want to
reset the list’s enumerator when you return to that list.
Consider the following:
<br/>
<span class="pre-in-pp">
Things to do religiously each and every day:
• take care of the dog
a) walk every day
b) brush once a week
- trim around the eyes every fourth brushing
- don’t forget to check nails
• feed the cat
d) soft food on Mon., Wed. and Fri.
e) dry food on Tues., Thurs. and Sat.
f) canned tuna on Sunday
</span>
</p>
<p>
The alpha-enumerated items under “Feed the cat”
would be normally a), b), c), but we want d), e), f). The
solution is to reset the second <kbd>.LIST alpha</kbd>’s
enumerator—before the first <kbd>.ITEM</kbd>—with
the macro RESET_LIST.
</p>
<p>
With no argument, <kbd>.RESET_LIST</kbd> resets an incrementing
enumerator to 1, A, a, I or i depending on the style of enumerator.
If you pass <kbd>.RESET_LIST</kbd> a
<a href="definitions.html#numericargument">numeric argument</a>,
it represents the starting position for an incrementing enumerator. In
the example above, <kbd>.RESET_LIST 4</kbd> starts the second
alpha-ed list at d).
</p>
<h4 id="pad-list-digits" class="docs" style="margin-top: -.25em;">3. Padding digit enumerators – PAD_LIST_DIGITS</h4>
<h5 class="docs" style="margin-top: 1em;">Arabic digits</h5>
<p style="margin-top: .5em;">
When your choice of enumerators is DIGIT and the number of items
in the list exceeds nine (9), you have to make a design decision:
should mom leave room for the extra numeral in two-numeral digits to
the right or the left of the single-numeral digits?
</p>
<p>
If you want the extra space to the right, invoke the macro
<kbd>.PAD_LIST_DIGITS</kbd> (with no argument), after
<kbd>.LIST</kbd> and before <kbd>.ITEM</kbd>. This will produce
something like
<br/>
<span class="pre-in-pp">
8. List item
9. List item
10. List item
</span>
If you want the extra space to the left, invoke
<kbd>.PAD_LIST_DIGITS</kbd> with the single argument,
<kbd>LEFT</kbd>, which will produce
<br/>
<span class="pre-in-pp">
8. List item
9. List item
10. List item
</span>
</p>
<p>
Of course, if the number of items in the list is less than ten
(10), there’s no need for PAD_LIST_DIGITS.
</p>
<h5 class="docs" style="margin-top: -.5em;">Roman numerals</h5>
<p style="margin-top: .5em;">
By default, mom sets roman numerals in lists flush left. The
<kbd><n></kbd> argument appended to <kbd>ROMAN<n></kbd>
or <kbd>roman<n></kbd> allows her to calculate how much space
to put after each numeral in order to ensure that the text of items
lines up properly.
</p>
<p>
If you’d like the roman numerals to line
up flush right (i.e. be padded "left"), simply
invoke <kbd>.PAD_LIST_DIGITS LEFT</kbd> after
<kbd>.LIST ROMAN<n></kbd> or
<kbd>.LIST roman<n></kbd> and before <kbd>.ITEM</kbd>.
</p>
<div class="rule-short"><hr/></div>
<!-- -LINE NUMBERING- -->
<h2 id="number-lines-intro" class="macro-group">Line numbering – prepend numbers to output lines</h2>
<ul style="margin-left: -.5em;">
<li><a href="#number-lines">Macro: <b>NUMBER_LINES</b></a>
<ul style="margin-left: -.5em;">
<li><a href="#ln-control">Line numbering control (off/suspend, resume)</a></li>
</ul></li>
<li><a href="#number-lines-control">Control macros and defaults</a>
<ul style="margin-left: -.5em;">
<li><a href="#number-quote-lines">Line numbering control macros for quotes and blockquotes</a></li>
</ul></li>
</ul>
<p style="margin-top: -.5em;">
When you turn line-numbering on, mom, by default
</p>
<ul style="margin-top: -.5em;">
<li>numbers every line of paragraph text; line-numbering is
suspended for all other document processing tags (like
docheaders, epigraphs, headings, quotes, etc.) and special
pages (covers, endotes, bibliographies, etc.); be aware,
though, that if you turn
<a href="definitions.html#docheader">docheaders</a>
off (with
<a href="docprocessing.html#docheader">DOCHEADER</a> OFF)
and create your own docheader, mom
<i>will</i> line-number your custom docheader, so turn
line numbering on afterwards
</li>
<li>doesn’t touch your line length; line numbers are hung
outside your current left margin (as set with
<a href="typesetting.html#l-margin">L_MARGIN</a>,
<a href="typesetting.html#page">PAGE</a>
or
<a href="docprocessing.html#doc-left-margin">DOC_LEFT_MARGIN</a>),
regardless of any indents that may be active
</li>
<li>separates line numbers from running text by two
<a href="definitions.html#figurespace">figure spaces</a>.
</li>
</ul>
<p>
Mom expects that
<a href="#quote">QUOTE</a>s
and
<a href="#blockquote">BLOCKQUOTE</a>s
will not be line-numbered, however control macros are provided to
enable line numbering for either.
See
<a href="#number-quote-lines">Line numbering control macros for quotes and blockquotes</a>.
</p>
<!-- -NUMBER_LINES- -->
<div class="macro-id-overline">
<h3 id="number-lines" class="macro-id">NUMBER_LINES</h3>
</div>
<div class="box-macro-args">
Macro: <b>NUMBER_LINES</b> <kbd class="macro-args"><start number> [ <which lines to number> [ <gutter> ] ]</kbd>
</div>
<div class="box-macro-args" style="margin-top: 1em;">
Macro: <b>NUMBER_LINES</b> <kbd class="macro-args"><anything> | RESUME</kbd>
</div>
<p>
NUMBER_LINES does what it says: prints line numbers, to the left of
<a href="definitions.html#outputline">output lines</a>
of paragraph text. One of the chief reasons for wanting numbered
lines is in order to identify footnotes or endnotes by line number
instead of by a marker in the text. (See
<a href="#footnotes-by-linenumber">Footnotes by linenumber</a>
for instructions on line-numbered footnotes, and
<a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE LINE</a>
for instructions on line-numbered endnotes.)
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Do not use NUMBER_LINES inside
<a href="#quote">QUOTE</a>
or
<a href="#blockquote">BLOCKQUOTE</a>.
By default, mom expects that quotes and blockquotes will not be
line numbered. If you wish to enable line numbering for them, you
must invoke
<a href="#number-quote-lines">NUMBER_QUOTE_LINES</a>
or
<a href="#number-quote-lines">NUMBER_BLOCKQUOTE_LINES</a>.
</p>
</div>
<p>
The first time you invoke
<a href="#number-lines">NUMBER_LINES</a>
you must, at a minimum, tell it what line number you want the
<i>next</i>
<a href="definitions.html#outputline">output line</a>
to have. The optional arguments <kbd><which lines to number></kbd>
and <kbd><gutter></kbd> allow you to state which lines should
be numbered (e.g. every five or every ten lines), and the gutter to
place between line numbers and
<a href="definitions.html#running">running text</a>.
</p>
<p>
For example, if you want mom to number output lines using her defaults,
<span class="pre-in-pp">
.NUMBER_LINES 1
</span>
will prepend the number, 1, to the next output line and number all
subsequent output lines sequentially.
</p>
<p>
If you want only every five lines numbered, pass mom the optional
<kbd><which lines to number></kbd> argument, like this:
<span class="pre-in-pp">
.NUMBER_LINES 1 5
</span>
</p>
<div class="box-important">
<p class="tip-top">
<span class="important">GOTCHA!</span>
The argument to <kbd><which lines to number></kbd> instructs
mom to number only those lines that are multiples of the argument.
Hence, in the above example, line number <kbd>1</kbd> will
<i>not</i> be numbered, since <kbd>1</kbd> is not a multiple of
<kbd>5</kbd>.
</p>
<p>
If you want line number <kbd>1</kbd> to be numbered, you have
to invoke <kbd><span class="nobr">.NUMBER_LINES 1 1</span></kbd> before the
first output line you want numbered, then study your <i>output</i>
copy and determine where best to insert the following in your
<i>input</i> text:
<br/>
<span class="pre-in-pp">
.NUMBER_LINES \n[ln] 5
</span>
(The escape <kbd>\n[ln]</kbd> ensures that NUMBER_LINES
automatically supplies the correct value for the first argument,
<kbd><start number></kbd>.)
</p>
<p class="tip-bottom">
Following this recipe, line number <kbd>1</kbd> will be numbered;
subsequently, only line numbers that are multiples of 5 will be
numbered. A little experimentation may be required to determine the
best place for it in your input text.
</p>
</div>
<p>
The optional argument, <kbd><gutter></kbd>, tells mom how much
space to put between the line numbers and the running text.
<kbd><gutter></kbd> does not require (or even accept) a
<a href="definitions.html#unitofmeasure">unit of measure</a>.
The argument you pass to it is the number of
<a href="definitions.html#figurespace">figure spaces</a>
you want between line numbers and running text.
Mom’s default gutter is two figure spaces. If
you’d like a wider gutter, say, four figures spaces, you’d do
<br/>
<span class="pre-in-pp">
.NUMBER_LINES 1 1 4
|
+-- Notice you *must* supply a value
for the 2nd argument in order to supply
a value for the 3rd.
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
When giving a value for <kbd><gutter></kbd>, you cannot skip
the <kbd><which lines to number></kbd> argument. Either fill
in the desired value, or use two double-quotes ( <kbd>""</kbd> ) to
have mom use the value formerly in effect.
</p>
</div>
<h3 id="ln-control" class="docs" style="margin-top: -.5em;">Off/suspend, resume</h3>
<p style="margin-top: .5em;">
After initializing line numbering, you can suspend it, with the
option to resume, using
<br/>
<span class="pre-in-pp">
.NUMBER_LINES OFF
</span>
(or <kbd>END</kbd>, <kbd>QUIT</kbd>, <kbd>X</kbd>, etc).
</p>
<p>To resume line numbering:
<br/>
<span class="pre-in-pp">
.NUMBER_LINES RESUME
</span>
When you resume, the line number will be the next in sequence
from where you left off. If that is not what you want—say
you want to reset the line number to <kbd>1</kbd>—re-invoke
<kbd>.NUMBER_LINES</kbd> with whatever arguments are needed for the
desired result.
</p>
<div class="box-tip" style="margin-left: 6px;">
<p class="tip">
<span class="note">Additional notes:</span>
</p>
<ol style="margin-top: -1.25em; margin-left: -1.25em; padding-bottom: .5em;">
<li>In document processing, you may invoke
<kbd>.NUMBER_LINES</kbd> either before or after
<kbd>.START</kbd>. Mom doesn’t care.
</li>
<li style="margin-top: .25em;">If you’re collating documents with
<a href="rectoverso.html#collate">COLLATE</a>,
you should re-invoke, at a minimum,
<kbd>.NUMBER_LINES 1</kbd> for each collated
document, in order to ensure that each begins with the
number <kbd>1</kbd> prepended to the first line.
</li>
<li style="margin-top: .25em;">Occasionally, you may want to
change the current gutter between line numbers and running
text without knowing what the next output line number should
be. Since NUMBER_LINES requires this number as its first
argument, in such instances, pass NUMBER_LINES as its first
argument the escape
<kbd>\n[ln]</kbd>.
<br/>
<span style="display: block; margin-top: .5em;">For example, if you were numbering every 5 lines with a
gutter of 2 (figure spaces) and you needed to change the
gutter to 4 (figures spaces),
<br/>
<span class="pre-in-pp" style="margin-bottom: -2em;">
.NUMBER_LINES \n[ln] 5 4
</span>
would do the trick.
</span>
</li>
<li style="margin-top: .25em;">If you’re using
<a href="#mn-intro">margin notes</a>
in a document, be sure to set the gutter for margin notes wide
enough to allow room for the line numbers.
</li>
<li style="margin-top: .25em;">Mom (groff, actually), only numbers
lines <i>to the left</i> of running text. For aesthetic
reason, therefore, the use of line numbering when setting a
document in columns is discouraged. However, should you wish
to number lines when setting in columns, make sure the
<a href="definitions.html#gutter">gutter(s)</a>
between columns is wide enough to leave room for the numbers.
</li>
</ol>
</div>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="number-lines-control" class="docs defaults">NUMBER_LINES control macros and defaults</h3>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#number-lines-general">Family/font/size/colour</a></li>
<li><a href="#number-lines-per-section">Reset line numbering after COLLATE</a></li>
<li><a href="#number-quote-lines">Line numbering control for quotes and blockquotes</a>
<ul style="padding-left: 1em">
<li><a href="#number-quote-lines-global">Including QUOTEs and BLOCKQUOTEs in the line numbering scheme</a></li>
<li><a href="#number-quote-lines-selective">Selectively enabling line numbering for QUOTEs and BLOCKQUOTEs</a></li>
<li><a href="#number-quote-lines-gutter">Changing the line number gutter for QUOTEs and BLOCKQUOTEs</a></li>
<li><a href="#number-quote-lines-silent">Silently increment line numbers during QUOTE and BLOCKQUOTE</a></li>
</ul></li>
</ol>
</div>
<h4 id="number-lines-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour</h4>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following NUMBER_LINES control macros may also be
<a href="#grouping">grouped</a>
using LINENUMBER_STYLE.
</p>
<span class="pre defaults">
.LINENUMBER_FAMILY default = prevailing family or document family; default is Times Roman
.LINENUMBER_FONT default = prevailing font
.LINENUMBER_SIZE default = +0
.LINENUMBER_COLOR default = black
</span>
</div>
<h4 id="number-lines-per-section" class="docs" style="margin-top: -1.75em;">2. Reset line numbering after COLLATE</h4>
<p>
After
<a href="rectoverso.html#collate">COLLATE</a>,
line numbering continues from where it left off. If you would like
each chapter or major document section to begin its line numbering
at “1”, invoke
<span class="pre-in-pp">
.NUMBER_LINES_PER_SECTION
</span>
after
<a href="#number-lines"><kbd>.NUMBER_LINES</kbd></a>.
</p>
<h4 id="number-quote-lines" class="docs" style="margin-top: 0em;">3. Line numbering control macros for QUOTE and BLOCKQUOTE</h4>
<h5 id="number-quote-lines-global" class="docs" style="font-size: 87%">• Including QUOTEs and BLOCKQUOTEs in the line numbering scheme</h5>
<p>
If you’d like mom to number lines in a
<a href="#quote">QUOTE</a>
or
<a href="#blockquote">BLOCKQUOTE</a>
as part of the same order and sequence as paragraph text,
invoke
<span class="pre-in-pp">
.NUMBER_QUOTE_LINES
</span>
or
<span class="pre-in-pp">
.NUMBER_BLOCKQUOTE_LINES
</span>
either before or after NUMBER_LINES. Both behave identically with
respect to the affected macro (i.e. QUOTE or BLOCKQUOTE).
</p>
<h5 id="number-quote-lines-selective" class="docs" style="font-size: 87%">• Selectively enabling line numbering for QUOTEs and BLOCKQUOTEs</h5>
<p>
If you’d like to enable line numbering selectively for quotes
and blockquotes <i>only</i>, invoke <kbd>.NUMBER_QUOTE_LINES</kbd>
or <kbd>.NUMBER_BLOCKQUOTE_LINES</kbd> first, followed by
<kbd>.NUMBER_LINES <n></kbd>, where <kbd><n></kbd>
is the first line number of the quote or blockquote. Afterwards,
enter your QUOTE or BLOCKQUOTE. When the quote or blockquote
is finished (i.e. after <kbd>.QUOTE OFF</kbd> or
<kbd>.BLOCKQUOTE OFF</kbd>), turn line numbering off. Each
subsequent quote or blockquote you want line numbered requires
only <kbd>.NUMBER_LINES <n></kbd> (with a corresponding
<kbd>.NUMBER_LINES OFF</kbd>) until you turn NUMBER_QUOTE_LINES or
NUMBER_BLOCKQUOTE_LINES off.
</p>
<p>
Here’s a recipe where the first line number of quotes starts
repeatedly at “1”.
<span class="pre-in-pp">
<running text>
.NUMBER_QUOTE_LINES
.NUMBER_LINES 1
.QUOTE
<text of quote>
.QUOTE OFF
.NUMBER_LINES OFF
<further running text>
.NUMBER_LINES 1
.QUOTE
<text of quote>
.QUOTE OFF
.NUMBER_LINES OFF
<further running text>
</span>
</p>
<h5 id="number-quote-lines-gutter" class="docs" style="font-size: 87%">• Changing the line number gutter for QUOTEs and BLOCKQUOTEs</h5>
<p>
Owing to groff’s restriction on accepting only the figure
space as the line number
<a href="definitions.html#gutter">gutter</a>’s
unit of measure, it is not possible for line numbers in quotes
or blockquotes to hang outside a document’s overall left
margin and be reliably flush with the line numbers of paragraph
text. Consequently, line numbers in quotes or blockquotes hang
to the left of the quote, separated by the currently active
gutter for NUMBER_LINES.
</p>
<p>
If you’d like to change the line number gutter for quotes
or blockquotes, invoke <kbd>.NUMBER_QUOTE_LINES</kbd> or
<kbd>.NUMBER_BLOCKQUOTE_LINES</kbd> with a digit representing the
number of
<a href="definitions.html#figurespace">figure spaces</a>
you’d like between the line numbers and the quoted text, like this:
<br/>
<span class="pre-in-pp">
.NUMBER_QUOTE_LINES 3
</span>
With the above, line numbers in quotes (and only quotes) will have
a gutter of 3 figure spaces.
</p>
<h5 id="number-quote-lines-silent" class="docs" style="font-size: 87%">• Silently increment line numbers during QUOTE and BLOCKQUOTE</h5>
<p>
If you’ve asked mom not to line number quotes or blockquotes,
but would like line numbering to continue while they’re
being output (as opposed to mom’s default behaviour of
<i>suspending</i> incrementing of line numbers during the output of
quotes and blockquotes), invoke
<span class="pre-in-pp">
.NUMBER_QUOTE_LINES SILENT
</span>
or
<span class="pre-in-pp">
.NUMBER_BLOCKQUOTE_LINES SILENT
</span>
With these, mom continues to increment line numbers while quotes
or blockquotes are being output, but the line numbers won’t
appear in the output copy.
</p>
<p>
Once having turned NUMBER_QUOTE_LINES or NUMBER_BLOCKQUOTE_LINES on,
you may disable them with
<span class="pre-in-pp">
.NUMBER_QUOTE_LINES OFF
</span>
or
<span class="pre-in-pp">
.NUMBER_BLOCKQUOTE_LINES OFF
</span>
</p>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="footnote-intro" class="macro-group">Footnotes</h2>
<ul>
<li><a href="#footnote-behaviour">Footnote behaviour</a>
<ul style="margin-left: -.5em;">
<li><a href="#fn-and-punct">Footnote markers and punctuation in the running text</a></li>
</ul></li>
<li><a href="#footnote">Tag: FOOTNOTE</a></li>
<li><a href="#footnote-control">Footnote control macros and defaults</a></li>
</ul>
<p>
For something so complex behind the scenes, footnotes are easy to use.
You just type, for example,
<br/>
<span id="footnote-example" class="pre-in-pp">
...the doctrines of Identity as urged by Schelling\c
.FOOTNOTE
<footnote about who the hell is Schelling>
.FOOTNOTE OFF
were generally the points of discussion presenting the most
of beauty to the imaginative Morella.
</span>
and be done with it.
(Note the obligatory use of the <kbd>\c</kbd>
<a href="definitions.html#inlines">inline escape</a>,
required whenever your
<a href="#footnote-marker-style">FOOTNOTE_MARKER_STYLE</a>
is either <kbd>STAR</kbd> [star/dagger footnotes] or
<kbd>NUMBER</kbd> [superscript numbers].)
</p>
<p>
After you invoke <kbd>.FOOTNOTE</kbd>, mom takes care of everything:
putting footnote markers in the body of the document, keeping track
of how many footnotes are on the page, identifying the footnotes
themselves appropriately, balancing them properly with the bottom
margin, deferring footnotes that don’t fit on the page...
Even if you’re using
<a href="docprocessing.html#columns">COLUMNS</a>,
mom knows what to do, and Does The Right Thing.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
See
<a href="refer.html">refer.html</a>
for information on using footnotes with the <kbd>refer</kbd>
bibliographic database.
</p>
</div>
<h3 id="footnote-behaviour" class="docs">Footnote behaviour</h3>
<p>
Footnotes can be sly little beasts. If you’re writing a
document that’s footnote-heavy, you might want to read the
following.
</p>
<p>
By default, mom marks footnotes with alternating stars (asterisks),
daggers, and double-daggers. The first footnote gets a star, the
second a dagger, the third a double-dagger, the fourth two stars,
the fifth two daggers, etc. If you prefer numbered footnotes, rest
assured mom is happy to oblige.
</p>
<p>
A small amount of vertical whitespace and a short horizontal rule
separate footnotes from the document body. When
<a href="docprocessing.html#flex-vs-shim">shimming</a>
is enabled, the amount of whitespace
may vary slightly from page to page depending on the number of lines
in the footnotes. Mom tries for a nice balance between too little
whitespace and too much, but when push comes to shove, she’ll
usually opt for ample over cramped. The last lines of footnotes are
always flush with the document’s bottom margin.
</p>
<p>
When
<a href="docprocessing.html#flex-vs-shim">flex-spacing</a>
is enabled, the distance between the last line of text and the
first footnote is always the same.
</p>
<p>
If mom sees that a portion of a footnote cannot be fit on its page,
she carries that portion over to the next page. If an entire
footnote can’t be fit on its page (i.e., FOOTNOTE has been
called too close to the bottom), she defers the footnote to the next
page, but sets it with the appropriate marker from the previous
page.
</p>
<p>
When footnotes occur within cited text, for example a
<a href="#quote">QUOTE</a>
or a
<a href="#blockquote">BLOCKQUOTE</a>,
mom will usually opt for deferring the footnote over to the next
page if it allows her to complete the cited text on one page.
</p>
<p>
In the unfortunate happenstance that a deferred footnote is the
only footnote on its page (i.e., it’s marked in the document
body with a star) and the page it’s deferred to has its own
footnotes, mom separates the deferred footnote from the page’s
proper footnote(s) with a blank line. This avoids the confusion
that might result from readers seeing two footnote entries on
the same page identified by a single star (or the number 1 if
you’ve requested numbered footnotes that begin at 1 on every
page). The blank line makes it clear that the first footnote entry
belongs to the previous page.
</p>
<p>
In the circumstance where a deferred footnote is not the only one
on its page, and is consequently marked by something other than
a single star, there’s no confusion and mom doesn’t
bother with the blank line. (By convention, the first footnote on
a page is always marked with a single star, so if readers see, say,
a dagger or double-dagger marking the first footnote entry,
they’ll know the entry belongs to the previous page).
</p>
<p>
Very exceptionally, two footnotes may have to be deferred (e.g., one
occurs on the second to last line of a page, and another on the last
line). In such a circumstance, mom does not add
a blank after the second deferred footnote. If you’d like a blank
line separating both deferred footnotes from any footnotes proper to
the page the deferred ones were moved to, add the space manually by
putting a
<a href="typesetting.html#space"><kbd>.SPACE</kbd></a>
command at the end of the footnote text, before
<kbd>.FOOTNOTE OFF</kbd> (or <kbd>OFF</kbd>, <kbd>QUIT</kbd>,
<kbd>END</kbd>, <kbd>X</kbd>, etc).
</p>
<p>
Obviously, deferred footnotes aren’t an issue if you request
numbered footnotes that increase incrementally throughout the whole
document—yet another convenience mom has thought of.
</p>
<p>
While mom’s handling of footnotes is sophisticated,
and tries to take nearly every imaginable situation under which they
might occur into account, some situations are simply impossible from
a typographic standpoint. For example, if you have a
<a href="#head">HEAD</a>
near the bottom of a page and the page has some footnotes on it, mom
may simply not have room to set any text under the head (normally,
she insists on having room for at least one line of text beneath
a head). In such an instance, mom will either set the head, with
nothing under it but footnotes, or transfer the head to the next
page. Either way, you’ll have a gaping hole at the bottom
of the page. It’s a sort of typographic Catch-22, and can
only be resolved by you, the writer or formatter of the document,
adjusting the type on the offending page so as to circumvent the
problem.
</p>
<h3 id="fn-and-punct" class="docs">Footnote markers and punctuation in the running text</h3>
<ol style="margin-left: -1.25em;">
<li><a href="#fn-and-punct-fill">“Fill” modes – JUSTIFY, or QUAD LEFT | CENTER | RIGHT</a></li>
<li><a href="#fn-and-punct-nofill">“No-fill” modes – LEFT, CENTER, RIGHT</a></li>
</ol>
<h4 id="fn-and-punct-fill" class="docs">1. “Fill” modes – JUSTIFY, or QUAD LEFT | CENTER | RIGHT</h4>
<p>
In
<a href="definitions.html#filled">fill</a>
modes, the correct way to enter the line after
<kbd>.FOOTNOTE OFF</kbd> is to input it as if it’s
literally a continuation of the input line you were entering before
you invoked <kbd>.FOOTNOTE</kbd>. Therefore, if necessary, the
input line may have to begin with space(s) or a punctuation mark, as
in the two following examples.
</p>
<div id="examples-footnotes-1" class="examples-container" style="padding-bottom: 1em;">
<div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 1</div>
<span class="pre">
A line of text,\c
.FOOTNOTE
A footnote line.
.FOOTNOTE OFF
broken up with a comma.
^
(last line begins with a literal space)
</span>
</div>
<div id="examples-footnotes-2" class="examples-container" style="margin-top: 1em; padding-bottom: 1em;">
<div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 2</div>
<span class="pre">
A line of text\c
.FOOTNOTE
A footnote line.
.FOOTNOTE OFF
, broken up with a comma.
^
(last line begins with a comma and a space)
</span>
</div>
<p>
Example 1 produces, on output
<br/>
<span class="pre-in-pp">
A line of text,* broken up with a comma.
</span>
Example 2 produces
<br/>
<span class="pre-in-pp">
A line of text*, broken up with a comma.
</span>
Care must be taken, though, if the punctuation mark that begins the
line after <kbd>.FOOTNOTE OFF</kbd> is a period (dot). You
<b><i>must</i></b> begin such lines with <kbd>\&.</kbd>, like
this:
<br/>
<span class="pre-in-pp">
...end of sentence\c
.FOOTNOTE
A footnote line.
.FOOTNOTE OFF
\&. A new sentence...
</span>
If you omit the <kbd>\&.</kbd>, the line will vanish!
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The document element tags,
<a href="#epigraph">EPIGRAPH</a>
and
<a href="#blockquote">BLOCKQUOTE</a>,
imply a fill mode, therefore these instructions also apply when you
insert a footnote into epigraphs or blockquotes.
</p>
</div>
<h4 id="fn-and-punct-nofill" class="docs">2. “No-fill” modes – LEFT, CENTER, RIGHT</h4>
<p>
In
<a href="definitions.html#filled">no-fill</a>
modes, you must decide a) whether text on the <i>input</i> line
after <kbd>.FOOTNOTE OFF</kbd> is to be joined to the
<i>output</i> line before <kbd>.FOOTNOTE</kbd> was invoked, or b)
whether you want the <i>output</i> text to begin on a new line.
</p>
<p>
In the first instance, simply follow the instructions,
<a href="#fn-and-punct-fill">above</a>,
for fill modes.
</p>
<p>
In the second instance, you must explicitly tell mom that
you want input text after <kbd>.FOOTNOTE OFF</kbd> to
begin on a new output line. This is accomplished by passing
<kbd>.FOOTNOTE OFF</kbd> (or <kbd>OFF</kbd>, <kbd>QUIT</kbd>,
<kbd>END</kbd>, <kbd>X</kbd>, etc) an additional argument:
<kbd>BREAK</kbd> or <kbd>BR</kbd>.
</p>
<p>
Study the two examples below to understand the difference.
</p>
<div id="examples-footnotes-3" class="examples-container" style="padding-bottom: 1em;">
<div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 1</div>
<span class="pre">
.LEFT
A line of text\c
.FOOTNOTE
A footnote line
.FOOTNOTE OFF
that carries on after the footnote.
</span>
</div>
<div id="examples-footnotes-4" class="examples-container" style="margin-top: 1em; padding-bottom: 1em;">
<div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 2</div>
<span class="pre">
.LEFT
A line of text\c
.FOOTNOTE
A footnote line
.FOOTNOTE OFF BREAK
that doesn’t carry on after the footnote.
</span>
</div>
<p>
Example 1, on output, produces
<br/>
<span class="pre-in-pp">
A line of text* that carries on after the footnote.
</span>
whereas Example 2 produces
<span class="pre-in-pp">
A line of text*
that doesn’t carry on after the footnote.
</span>
The distinction becomes particularly important if you like to see
punctuation marks come <i>after</i> footnote markers. In no-fill
modes, that’s accomplished like this:
<br/>
<span class="pre-in-pp">
.LEFT
A line of text\c
.FOOTNOTE
A footnote line
.FOOTNOTE OFF
,
broken up with a comma.
</span>
The output of the above looks like this:
<br/>
<span class="pre-in-pp">
A line of text*,
broken up with a comma.
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The document element tag,
<a href="#quote">QUOTE</a>,
implies a no-fill mode, therefore these instructions also apply when
you insert footnotes into quotes.
</p>
</div>
<!-- -FOOTNOTE- -->
<div class="macro-id-overline">
<h3 id="footnote" class="macro-id">FOOTNOTE</h3>
</div>
<div class="box-macro-args">
Tag: FOOTNOTE <kbd class="macro-args"><toggle> [ BREAK | BR ] [ INDENT LEFT | RIGHT | BOTH <indent value> ]</kbd>
</div>
<p class="requires">
• <kbd><span style="font-style: normal"><indent value></span></kbd> requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
<br/>
See <span style="font-style: normal"><a href="#footnote-note">HYPER-IMPORTANT NOTE</a></span>.
</p>
<p>
FOOTNOTE is a toggle macro, therefore invoking it on a line by
itself allows you to enter a footnote in the body of a document.
Invoking it with any argument other than <kbd>INDENT</kbd> (i.e.
<kbd>OFF</kbd>, <kbd>QUIT</kbd>, <kbd>END</kbd>, <kbd>X</kbd>...)
tells mom you’re finished.
</p>
<p>
Footnotes are the only element of
<a href="definitions.html#running">running text</a>
that are not affected by the typesetting
<a href="typesetting.html#indents">indent macros</a>.
In the unlikely event that you want a page’s footnotes to
line up with a running indent, invoke <kbd>.FOOTNOTE</kbd> with
the <kbd>INDENT</kbd> argument and pass it an indent direction and
indent value. <kbd>L, R,</kbd> and <kbd>B</kbd> may be used in place
of <kbd>LEFT, RIGHT,</kbd> and <kbd>BOTH</kbd>. FOOTNOTE must be
invoked with <kbd>INDENT</kbd> for every footnote you want indented;
mom does not save any footnote indent information from invocation to
invocation.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If a footnote runs to more than one paragraph, do <i>not</i> begin
the footnote with the
<a href="#pp">PP</a>
tag. Use <kbd>.PP</kbd> only to introduce subsequent paragraphs.
</p>
</div>
<div id="footnote-note" class="box-tip">
<p class="tip-top">
<span class="note">HYPER-IMPORTANT NOTE:</span>
The final word on the
<a href="definitions.html#inputline">input line</a>
that comes immediately before FOOTNOTE <i>must</i> terminate with a
<kbd><a href="typesetting.html#join">\c</a></kbd>
inline escape if your
<a href="#footnote-marker-style">FOOTNOTE_MARKER_STYLE</a>
is either <kbd>STAR</kbd> or <kbd>NUMBER</kbd>. See the
<a href="#footnote-example">footnote example</a>
above.
</p>
<p>
Additionally, in
<a href="definitions.html#filled">fill</a>
modes
(<a href="typesetting.html#justify">JUSTIFY</a>
or
<a href="typesetting.html#quad">QUAD</a>),
the line <i>after</i> a <kbd>.FOOTNOTE OFF</kbd> should be
entered as if there were no interruption in the input text, i.e.,
the line should begin with a literal space or punctuation mark (see
explanation and examples
<a href="#fn-and-punct">here</a>).
</p>
<p>
In
<a href="definitions.html#filled">no-fill</a>
modes, the optional argument <kbd>BREAK</kbd> or <kbd>BR</kbd> may
be used after the <kbd>OFF</kbd> (or <kbd>OFF</kbd>,
<kbd>QUIT</kbd>, <kbd>END</kbd>, <kbd>X</kbd>, etc) argument to
instruct mom not to join the next input line to the previous output.
See
<a href="#fn-and-punct-nofill">here</a>
for a more complete explanation, with examples.
</p>
<p class="tip-bottom">
Do not use the <kbd>\c</kbd> inline escape if your
FOOTNOTE_MARKER_STYLE is <kbd>LINE</kbd>, or if you have disabled
footnote markers with
<kbd><a href="#footnote-markers">.FOOTNOTE_MARKERS OFF</a></kbd>.
In these instances, the line after <kbd>.FOOTNOTE OFF</kbd>
should be entered normally.
</p>
</div>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="footnote-control" class="docs defaults">FOOTNOTE control macros and defaults</h3>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#footnote-general">Family/font/size/colour/lead/quad</a></li>
<li><a href="#footnote-markers">Footnote markers</a> – on or off</li>
<li><a href="#footnote-marker-style">Footnote marker style</a> – star+dagger or numbered
<ul style="margin-left: -.5em; list-style-type: disc;">
<li><a href="#footnote-number-placeholders">Left padding of footnote numbers</a></li>
</ul></li>
<li><a href="#footnotes-by-linenumber">Footnotes by line number</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
<li><a href="#footnote-linenumber-brackets">FOOTNOTE_LINENUMBER_BRACKETS</a></li>
<li><a href="#footnote-linenumber-separator">FOOTNOTE_LINENUMBER_SEPARATOR</a></li>
<li><a href="#footnotes-run-on">FOOTNOTES_RUN_ON</a> – line-numbered footnotes only</li>
</ul></li>
<li><a href="#reset-footnote-number">Reset footnote number</a> – set footnote marker number to 1</li>
<li><a href="#footnote-space">Inter-footnote spacing</a></li>
<li><a href="#footnote-rule">Footnote rule</a> – on or off</li>
<li><a href="#footnote-rule-length">Footnote rule length</a> – length of footnote separator rule</li>
<li><a href="#footnote-rule-weight">Footnote rule weight</a> – weight of footnote separator rule</li>
<li><a href="#footnote-rule-adj">Adjust vertical position of footnote separator rule</a></li>
</ol>
</div>
<h4 id="footnote-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour/lead/quad</h4>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following FOOTNOTE control macros may also be
<a href="#grouping">grouped</a>
using FOOTNOTE_STYLE.
</p>
<span class="pre defaults">
.FOOTNOTE_FAMILY default = prevailing document family; default is Times Roman
.FOOTNOTE_FONT default = roman
.FOOTNOTE_SIZE default = -2 (points)
.FOOTNOTE_COLOR default = black
.FOOTNOTE_AUTOLEAD default = 2 points (typeset); single-spaced (typewrite)
.FOOTNOTE_QUAD default = same as paragraphs
</span>
</div>
<h4 id="footnote-markers" class="docs" style="margin-top: -1.25em;">2. Footnote markers – FOOTNOTE_MARKERS</h4>
<p>
If you don’t want footnote markers in either the body of
the document or beside footnote entries themselves, toggle them
off with <kbd>.FOOTNOTE_MARKERS OFF</kbd> (or <kbd>OFF</kbd>,
<kbd>QUIT</kbd>, <kbd>END</kbd>, <kbd>X</kbd>...). This means,
of course, that you’ll have to roll your own. If you want
them back on, invoke <kbd>.FOOTNOTE_MARKERS</kbd> with no argument.
Footnote markers are on by default.
</p>
<p>
If FOOTNOTE_MARKERS are disabled, do not use the <kbd>\c</kbd>
inline escape to terminate the line before <kbd>.FOOTNOTE</kbd>.
</p>
<h4 id="footnote-marker-style" class="docs" style="margin-top: -.25em;">3. Footnote marker style – FOOTNOTE_MARKER_STYLE</h4>
<p>
Mom gives you two choices of footnote marker style: star+dagger (see
<a href="#footnote-behaviour">footnote behaviour</a>
above), or numbered.
</p>
<p>
<kbd>.FOOTNOTE_MARKER_STYLE STAR</kbd> gives you star+dagger (the
default). There is a limit of 10 footnotes per page with this
style.
</p>
<p>
<kbd>.FOOTNOTE_MARKER_STYLE NUMBER</kbd> gives you superscript
numbers, both in the document body and in the footnote entries
themselves. By default, footnote numbers increase incrementally
(prev. footnote number + 1) throughout the whole document. You
can ask mom to start each page’s footnote numbers at 1 with
<kbd>.RESET_FOOTNOTE_NUMBER</kbd>
(<a href="#reset-footnote-number">see below</a>.)
</p>
<p>
If your
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>
is <kbd>TYPEWRITE</kbd> and you would prefer that the footnotes
themselves not use superscript numbers, you may pass
<kbd>.FOOTNOTE_MARKER_STYLE NUMBER</kbd> an additional argument:
<kbd>NO_SUPERSCRIPT</kbd>. While the marker in the text will still
be superscript, the footnotes themselves will be identified with
normal-sized, base aligned numbers, surrounded by parentheses.
</p>
<h5 id="footnote-number-placeholders" class="docs">Left padding of footnote numbers</h5>
<p>
When footnote numbering is enabled, in order to ensure that the
left margin of footnote text aligns regardless of the footnote
number, you sometimes have to pad the footnote numbers. This will
be the case any time the footnote numbers change from 9 to 10 on
the same page, or from 99 to 100. Consider this scenario:
<br/>
<span class="pre-in-pp">
<sup>9</sup> Footnote text
<sup>10</sup> Footnote text
<sup>11</sup> Footnote text
</span>
As you can see, the left margins of the footnotes are not aligned.
</p>
<p>
In order to correct this, use the macro
<kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS</kbd>, which takes a single
argument: the number of placeholders in the longer digit. For
example, placed at an appropriate point in your input file,
<kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS 2</kbd> causes the above
example to come out like this:
<br/>
<span class="pre-in-pp">
<sup> 9</sup> Footnote text
<sup>10</sup> Footnote text
<sup>11</sup> Footnote text
</span>
Given the impossibility of knowing in advance when the number of
placeholders required for footnote numbers will change, you must
study your <i>output</i> file to determine where to insert this
macro into your <i>input</i> file.
</p>
<p>
Obviously, mom does not provide a default for
<kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS</kbd>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS</kbd> affects both superscript
footnote numbers, and, in
<a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
the normal, base-aligned numbers surrounded by parentheses that you
get with
<kbd>.FOOTNOTE_MARKER_STYLE NUMBER NO_SUPERSCRIPT</kbd>.
</p>
</div>
<h4 id="footnotes-by-linenumber" class="docs" style="margin-top: -.25em;">4. Footnotes by line number – FOOTNOTE_MARKER_STYLE LINE</h4>
<p>
FOOTNOTE_MARKER_STYLE with the argument, <kbd>LINE</kbd> lets you
have footnotes which are identified by line number, rather than by a
marker in the text. (Note that
<a href="#number-lines">NUMBER_LINES</a>
must be enabled in order to use this marker style.)
</p>
<p>
With FOOTNOTE_MARKER_STYLE <kbd>LINE</kbd>, mom will identify
footnotes either by single line numbers, or line ranges. If
what you want is a single line number, you need only invoke
<kbd>.FOOTNOTE</kbd>, <i>without the terminating</i> <kbd>\c</kbd>,
at the appropriate place in running text. Input lines after the
footnote has been terminated (e.g. with
<kbd>.FOOTNOTE OFF</kbd>) are entered normally.
</p>
<p>
If you want a range of line numbers (e.g. [5-11] ),
insert, directly into the first line of the range you want, the
<a href="definitions.html#inlines">inline escape</a>,
<kbd><span class="nobr">\*[FN_MARK]</span></kbd>. For the terminating line
number of the range, you need only invoke <kbd>.FOOTNOTE</kbd>
(again, without the terminating <kbd>\c</kbd>); mom is smart enough
to figure out that where <kbd>.FOOTNOTE</kbd> was invoked represents
the terminating line number.
</p>
<p>
Range-numbered footnotes are always output on the page
where <kbd>.FOOTNOTE</kbd> was invoked, not the page where
<kbd><span class="nobr">\*[FN_MARK]</span></kbd> appears (subject, of course, to
the rules for footnotes that fall too close to the bottom of a page,
as outlined
<a href="#footnote-rules">here</a>).
</p>
<p>
The behaviour of line-numbered footnotes can be controlled with the
macros:
<br/>
<span style="display: inline-block; margin-left: 2em; margin-top: .5em;"><a href="#footnote-linenumber-brackets">FOOTNOTE_LINENUMBER_BRACKETS</a></span>
<br/>
<span style="margin-left: 2em;"><a href="#footnote-linenumber-separator">FOOTNOTE_LINENUMBER_SEPARATOR</a></span>
<br/>
<span style="margin-left: 2em;"><a href="#footnotes-run-on">FOOTNOTES_RUN_ON</a></span>
</p>
<div style="margin-left: 1.25em;">
<h5 id="footnote-linenumber-brackets" class="docs" style="margin-top: -.25em;">• FOOTNOTE_LINENUMBER_BRACKETS</h5>
<p style="margin-left: .5em;">
Mom, by default, surrounds footnote line numbers with square
brackets. The style of the brackets may be changed with the macro
<br/>
<span class="pre-in-pp">
.FOOTNOTE_LINENUMBER_BRACKETS
</span>
which takes one of three possible arguments: <kbd>PARENS</kbd>
(round brackets), <kbd>SQUARE</kbd> (the default) or
<kbd>BRACES</kbd> (curly braces). If you prefer a shortform, the
arguments, <kbd>(</kbd>, <kbd>[</kbd> or <kbd>{</kbd> may be used
instead.
</p>
<p style="margin-left: .5em;">Thus, for example, either
<br/>
<span class="pre-in-pp">
.FOOTNOTE_LINENUMBER_BRACKETS PARENS
</span>
or
<br/>
<span class="pre-in-pp">
.FOOTNOTE_LINENUMBER_BRACKETS (
</span>
will surround footnote line numbers with round brackets.
</p>
<h5 id="footnote-linenumber-separator" class="docs" style="margin-top: -.25em;">• FOOTNOTE_LINENUMBER_SEPARATOR</h5>
<p style="margin-left: .5em;">
If you don’t want the numbers enclosed in brackets, you
may tell mom to use a “separator” instead. A common
separator would be the colon, but it can be anything you like.
The macro to do this is
<br/>
<span class="pre-in-pp">
.FOOTNOTE_LINENUMBER_SEPARATOR
</span>
which takes, as its single argument, the separator you want. For
safety and consistency’s sake, always enclose the argument in
double-quotes. The separator can be composed of any valid groff
character, or any combination of characters.
</p>
<p style="margin-left: .5em;">
<b>A word of caution:</b> when using a separator, mom doesn’t
insert any space after the separator. Hence, if you want space
(you probably do), you must make the space part of the argument you
pass to FOOTNOTE_LINENUMBER_SEPARATOR. For example, to get a colon
separator with a space after it, you’d do
<br/>
<span class="pre-in-pp">
.FOOTNOTE_LINENUMBER_SEPARATOR ": "
</span>
</p>
<h5 id="footnotes-run-on" class="docs" style="margin-top: -1em;">• FOOTNOTES_RUN_ON</h5>
<p style="margin-left: .5em;">
Finally, if your footnote marker style is <kbd>LINE</kbd>, you may
instruct mom to do “run-on style” footnotes. Run-on
footnotes do not treat footnotes as discrete entities, i.e. each
beginning on a new line. Rather, each footnote is separated from
the footnote before it by horizontal space in the running line, so
that the footnotes on any given page form a continuous block, like
lines in a paragraph.
</p>
<p style="margin-left: .5em;">
The macro to get mom to run footnotes on is
<br/>
<span class="pre-in-pp">
.FOOTNOTES_RUN_ON
</span>
Invoked by itself, it turns the feature on. Invoked with any other
argument (<kbd>OFF, NO</kbd>, etc.), it turns the feature off.
It is generally not a good idea to turn the feature on and off
during the course of a single document. If you do, mom will issue
a warning if there’s going to be a problem. However, it is
always perfectly safe to enable/disable the feature after
<a href="rectoverso.html#collate">COLLATE</a>.
</p>
</div>
<h4 id="reset-footnote-number" class="docs" style="margin-top: -.25em;">5. Reset footnote number – RESET_FOOTNOTE_NUMBER</h4>
<p>
<kbd>.RESET_FOOTNOTE_NUMBER</kbd>, by itself, resets footnote
numbering so that the next footnote you enter is numbered 1.
</p>
<p>
<kbd>.RESET_FOOTNOTE_NUMBER PAGE</kbd> tells mom to start every
page’s footnote numbering at 1.
</p>
<h4 id="footnote-space" class="docs" style="margin-top: -.25em;">6. Inter-footnote spacing – FOOTNOTE_SPACING</h4>
<p>
If you’d like some space between footnotes, you can
have mom put it in for you by invoking <kbd>.FOOTNOTE_SPACING</kbd>
with an argument representing the amount of extra space you’d
like. The argument to FOOTNOTE_SPACING requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>.
</p>
<p>
In the following example, footnotes will be separated from each
other by 3
<a href="definitions.html#picaspoints">points</a>.
<br/>
<span class="pre-in-pp">
.FOOTNOTE_SPACING 3p
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If you’re using footnotes for references generated from the
refer database (see
<a href="refer.html">refer.html</a>),
correct MLA style requires a full linespace between footnotes, which
you can accomplish with <kbd>.FOOTNOTE_SPACING 1v</kbd>.
</p>
</div>
<h4 id="footnote-rule" class="docs" style="margin-top: -.25em;">7. Footnote rule – FOOTNOTE_RULE</h4>
<p>
If you don’t want a footnote separator rule, toggle it
off with <kbd>.FOOTNOTE_RULE OFF</kbd> (or <kbd>END</kbd>,
<kbd>QUIT</kbd>, <kbd>X</kbd>...). Toggle it back on by invoking
<kbd>.FOOTNOTE_RULE</kbd> with no argument. The default is to print
the rule.
</p>
<h4 id="footnote-rule-length" class="docs" style="margin-top: -.25em;">8. Footnote rule length – FOOTNOTE_RULE_LENGTH</h4>
<p>
If you want to change the length of the footnote separator rule,
invoke <kbd>.FOOTNOTE_RULE_LENGTH</kbd> with a length, like this,
<br/>
<span class="pre-in-pp">
.FOOTNOTE_RULE_LENGTH 1i
</span>
which sets the length to 1 inch. Note that a
<a href="definitions.html#unitofmeasure">unit of measure</a>
is required. The default is 4
<a href="definitions.html#picaspoints">picas</a>
for both
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>s.
</p>
<h4 id="footnote-rule-weight" class="docs" style="margin-top: -.25em;">9. Footnote rule weight – FOOTNOTE_RULE_WEIGHT</h4>
<p>
If you want to change the weight (“thickness”) of the
footnote separator rule, invoke <kbd>.FOOTNOTE_RULE_WEIGHT</kbd>
with the desired weight. The weight is measured in
<a href="definitions.html#picaspoints">points</a>;
however, do not append the
<a href="definitions.html#unitofmeasure">unit of measure</a>,
<kbd>p</kbd>, to the argument.
</p>
<p>
Mom’s default footnote rule weight is 1/2 point. If
you’d like a 1-point rule instead,<br/>
<span class="pre-in-pp">
.FOOTNOTE_RULE_WEIGHT 1
</span>
is how you’d get it.
</p>
<h4 id="footnote-rule-adj" class="docs" style="margin-top: -.25em;">10. Adjust vertical position of footnote separator rule – FOOTNOTE_RULE_ADJ</h4>
<p>
The footnote separator rule is a rule whose bottom edge falls
on the
<a href="definitions.html#baseline">baseline</a>
(at the footnote
<a href="definitions.html#leading">leading</a>)
one line above the first line of a page’s footnotes. By default,
mom raises the rule 3
<a href="definitions.html#picaspoints">points</a>
from the baseline so that the separator and the footnotes don’t
look jammed together. If you’d prefer a different vertical
adjustment, invoke <kbd>.FOOTNOTE_RULE_ADJ</kbd> with the
amount you’d like. For example
<br/>
<span class="pre-in-pp">
.FOOTNOTE_RULE_ADJ 4.25p
</span>
raises the rule by 4-1/4 points. Note that you can only raise
the rule, not lower it. A
<a href="definitions.html#unitofmeasure">unit of measure</a>
is required.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If your document
<a href="definitions.html#leading">leading</a>
is 2
<a href="definitions.html#picaspoints">points</a>
or less (e.g your
<a href="definitions.html#ps">point size</a>
is 10 and your linespacing is 10, 11, or 12), lowering mom’s
default footnote rule adjustment will almost certainly give you
nicer looking results than leaving the adjustment at the default.
Furthermore, you can invoke <kbd>.FOOTNOTE_RULE_ADJ</kbd> on any
page in which footnotes appear, or in any column, so that the
placement of the footnote rule can be changed on-the-fly, should you
wish.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="endnote-intro" class="macro-group">Endnotes</h2>
<ul style="margin-left: -.5em;">
<li><a href="#endnote-behaviour">Endnotes behaviour</a>
<ul style="margin-left: -.5em;">
<li><a href="#endnote-columns">Endnotes and columnar documents</a></li>
</ul></li>
<li><a href="#endnote">Tag: ENDNOTE</a></li>
<li><a href="#endnotes">Macro: <b>ENDNOTES</b></a>—tell mom to output endnotes</li>
<li><a href="#endnote-control">ENDNOTES control macros and defaults</a></li>
</ul>
<p>
Embedding endnotes into mom documents is accomplished the same way
as embedding
<a href="#footnote-intro">footnotes</a>.
The example below is identical to the one shown in the
<a href="#footnote-example">introduction to footnotes</a>,
except that <kbd>.FOOTNOTE</kbd> has been replaced with
<kbd>.ENDNOTE</kbd>.
</p>
<div id="examples" class="examples-container" style="padding-bottom: 1em;">
<div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example</div>
<span id="endnote-example" class="pre">
...the doctrines of Identity as urged by Schelling\c
.ENDNOTE
<endnote about who the hell is Schelling>
.ENDNOTE OFF
were generally the points of discussion presenting the most
of beauty to the imaginative Morella.
</span>
</div>
<p>
As with footnotes, note the obligatory use of the <kbd>\c</kbd>
<a href="definitions.html#inlines">inline escape</a>
when your
<a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
is <kbd>NUMBER</kbd> or <kbd>SUPERSCRIPT</kbd> (both of which mark
endnotes references in
<a href="definitions.html#running">running text</a>
with superscript numbers). When the marker style is
<kbd>LINE</kbd>, you must <i>not</i> use the <kbd>\c</kbd>
escape.
</p>
<p>
Endnotes differ from footnotes in two ways (other than the fact that
endnotes come at the end of a document whereas footnotes appear in
the body of the document):
</p>
<ol style="margin-top: -.5em;">
<li>When your ENDNOTE_MARKER_STYLE is <kbd>NUMBER</kbd> or
<kbd>SUPERSCRIPT</kbd>, endnotes are always numbered
incrementally, starting at “1”.
</li>
<li>Endnotes must be output explicitly; mom does not output
them for you. In
<a href="rectoverso.html#collate">collated</a>
documents, this allows you to choose whether you want the
endnotes to appear at the end of each chapter or article in a
document, or grouped together at the very end of the document.
</li>
</ol>
<p>
Within endnotes, you may use the document element tags
<a href="#pp">PP</a>,
<a href="#quote">QUOTE</a>
and
<a href="#blockquote">BLOCKQUOTE</a>.
This provides the flexibility to create endnotes that run to several
paragraphs, as well as to embed cited text within endnotes.
</p>
<p>
Should you wish to change the appearance of quotes or blockquotes
that appear within endnotes, you may do so with the
<a href="#quote-control">quote control macros</a>
or
<a href="#blockquote-control">blockquote control macros</a>.
However, you must make the changes <i>within</i> each endnote,
prior to invoking <kbd>.QUOTE</kbd> or <kbd>.BLOCKQUOTE</kbd>,
and undo them prior to terminating the endnote (i.e. before
<kbd>.ENDNOTE OFF</kbd>), otherwise the changes will affect
subsequent quotes and blockquotes that appear in the document body
as well.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
See
<a href="refer.html">refer.html</a>
for information on using endnotes with the <kbd>refer</kbd>
bibliographic database.
</p>
</div>
<h3 id="endnote-behaviour" class="docs">Endnotes behaviour</h3>
<p>
When you output endnotes (with
<kbd><a href="#endnotes">.ENDNOTES</a></kbd>),
mom finishes processing the last page of your document, then breaks
to a new page for printing the endnotes. If the document type is
<kbd><a href="docprocessing.html#doctype">CHAPTER</a></kbd>,
the centre part of the
<a href="definitions.html#header">header</a>
(or footer), which, by default, contains a chapter number or title,
is removed.
</p>
<p>
By default, mom starts the endnotes page with a bold, centred head,
“ENDNOTES”. Subsequently, for each section in a
<a href="rectoverso.html#collate-intro">collated</a>
document (e.g. chapters in a book), she identifies the section in bold
type, flush left and underscored, followed by one-half linespace.
Endnotes pertaining to the section are output underneath, identified
by superscript numbers. The text of the endnotes themselves is
indented to the right of the numbers.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The one-half linespace between section identifiers and the endnotes
themselves, plus the need to group identifiers and endnotes sensibly,
means that mom cannot guarantee perfectly aligned bottom margins.
This is an unavoidable consequence of the structure of endnotes.
</p>
</div>
<p>
Of course, all the defaults, as well as the overall style of the
endnotes pages, can be changed with the
<a href="#endnote-control">endnote control macros</a>.
The attentive will notice that endnotes have an awful lot of control
macros. This is because endnotes are like a mini-document unto
themselves, and therefore need not be bound by the style parameters
of the body of the document.
</p>
<h3 id="endnote-columns" class="docs">Endnotes and columnar documents</h3>
<p>
If your document is set in columns (see
<a href="docprocessing.html#columns">COLUMNS</a>),
mom gives you the option to have endnotes appear in either
the column format or set to the full page width. See
<a href="#endnotes-no-columns">ENDNOTES_NO_COLUMNS</a>.
</p>
<!-- -ENDNOTE- -->
<div class="macro-id-overline">
<h3 id="endnote" class="macro-id">ENDNOTE</h3>
</div>
<div class="box-macro-args">
Macro: <b>ENDNOTE</b> <kbd class="macro-args"><toggle> [ BREAK | BR ]</kbd>
</div>
<p class="requires">
See <span style="font-style: normal"><a href="#endnote-note">HYPER-IMPORTANT NOTE</a></span>
</p>
<p>
ENDNOTE is a toggle macro, therefore invoking it on a line by itself
allows you to enter an endnote in the body of a document. Invoking
it with any other argument (i.e. <kbd>OFF</kbd>, <kbd>QUIT</kbd>,
<kbd>END</kbd>, <kbd>X</kbd>...) tells mom that you’ve
finished the endnote.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If an endnote runs to more than one paragraph, do <i>not</i> begin
the endnote with the
<a href="#pp">PP</a>
tag. Use PP only to introduce subsequent paragraphs.
</p>
</div>
<div id="endnote-note" class="box-tip">
<p class="tip-top">
<span class="note">HYPER-IMPORTANT NOTE:</span>
If your
<a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
is <kbd>NUMBER</kbd> or <kbd>SUPERSCRIPT</kbd> (mom’s
default is <kbd>NUMBER</kbd> unless you have
<a href="refer.html#endnote-refs">ENDNOTE_REFS</a>
enabled, in which case it’s <kbd>SUPERSCRIPT</kbd>), the final word on the
<a href="definitions.html#inputline">input line</a>
that comes immediately before <kbd>.ENDNOTE</kbd> must terminate
with a
<a href="typesetting.html#join"><kbd>\c</kbd></a>
inline escape. See the
<a href="#endnote-example">endnote example</a>
above.
</p>
<p>
Additionally, in
<a href="definitions.html#filled">fill</a>
modes
(<a href="typesetting.html#justify">JUSTIFY</a>
or
<a href="typesetting.html#quad">QUAD</a>,
the line after <kbd>.ENDNOTE OFF</kbd> should be
entered as if there were no interruption in the input text, i.e.,
the line should begin with a literal space or punctuation mark (see
explanation and examples for footnotes, which apply equally to
endnotes,
<a href="#fn-and-punct">here</a>).
</p>
<p>
In
<a href="definitions.html#filled">no-fill</a>
modes, the optional argument <kbd>BREAK</kbd> or <kbd>BR</kbd> may
be used after the <kbd>OFF</kbd> (or <kbd>OFF</kbd>,
<kbd>QUIT</kbd>, <kbd>END</kbd>, <kbd>X</kbd>, etc) argument to
instruct mom not to join the next input line to the previous output.
See
<a href="#fn-and-punct-nofill">here</a>
for a more complete explanation. The examples are for
<kbd>.FOOTNOTE</kbd>, but apply equally to <kbd>.ENDNOTE</kbd>.
</p>
<p class="tip-bottom">
If your ENDNOTE_MARKER_STYLE is LINE, do not use the <kbd>\c</kbd>
escape, and enter the line after <kbd>.ENDNOTE OFF</kbd> normally,
ie at your text editor’s left margin.
</p>
</div>
<!-- -ENDNOTES- -->
<div class="macro-id-overline">
<h3 id="endnotes" class="macro-id">ENDNOTES</h3>
</div>
<div class="box-macro-args">
Macro: <b>ENDNOTES</b>
</div>
<p>
Unlike footnotes, which mom automatically outputs at the bottom
of pages, endnotes must be explicitly output by you, the
user. ENDNOTES, by itself (i.e. without any argument), is the macro
to do this.
</p>
<p>
Typically, you’ll use ENDNOTES at the end of a document. If
it’s a single (i.e. not collated) document, mom will print
the endnotes pertaining to it. If it’s a collated document,
mom will print all the endnotes contained within all sections of
the document (typically chapters), appropriately identified and
numbered.
</p>
<p>
Should you wish to output the endnotes for each section of a
collated document at the ends of the sections (instead of at the
very end of the document), simply invoke <kbd>.ENDNOTES</kbd>
immediately prior to
<a href="rectoverso.html#collate">COLLATE</a>.
Mom will print the endnotes, identified and numbered appropriately,
on a separate page prior to starting the next section of the
document. Each subsequent invocation of <kbd>.ENDNOTES</kbd>
outputs only those endnotes that mom collected after the previous
invocation.
</p>
<div class="defaults-container" style="background-color: #ded4bd; border: none;">
<h3 id="endnote-control" class="docs defaults">ENDNOTES control macros and defaults</h3>
<div class="box-important" style="width: 700px; margin: auto; background-color: #ded4bd;">
<p class="tip-top" style="color: #000056;">
<span class="important">Important:</span>
Endnotes control macros must always be invoked prior to the first
instance of
<a href="#endnote"><kbd>.ENDNOTE</kbd></a>.
</p>
<p style="color: #000056; margin-top: -.5em;">
When you embed endnotes in the body of a document, mom collects
<i>and processes</i> them for later outputting (when you invoke
<a href="#endnotes"><kbd>.ENDNOTES</kbd></a>).
By the time you do invoke <kbd
style="color: #000056;">.ENDNOTES</kbd>, it’s much too late to
change your mind about how you want them to look.
</p>
<p class="tip-bottom" style="color: #000056; margin-top: -.5em;">
My advice? If you’re planning to change the default
appearance of endnotes pages, set them up prior to
<a href="docprocessing.html#start">START</a>.
</p>
</div>
<ol style="margin-top: .5em; padding-bottom: .5em;">
<li><a href="#endnotes-general"><b>General endnotes style control</b></a>
<ul style="margin-left: -.5em;">
<li><a href="#endnote-style">Base family/font/quad</a></li>
<li><a href="#endnote-pt-size">Base point size</a></li>
<li><a href="#endnote-lead">Leading</a></li>
<li><a href="#endnote-spacing">Spacing between endnotes</a></li>
<li><a href="#singlespace-endnotes">Singlespace endnotes (TYPEWRITE only)</a></li>
<li><a href="#endnote-para-indent">Paragraph indenting</a></li>
<li><a href="#endnote-para-space">Inter-paragraph spacing</a></li>
<li><a href="#endnotes-no-columns">Turning off column mode during endnotes output</a></li>
</ul></li>
<li><a href="#endnotes-pagination"><b>Pagination of endnotes</b></a>
<ul style="margin-left: -.5em;">
<li><a href="#endnotes-pagenum-style">Page numbering style</a></li>
<li><a href="#endnotes-first-pagenumber">Setting the first page number of endnotes</a></li>
<li><a href="#endnotes-no-first-pagenum">Omitting a page number on the first page of endnotes</a></li>
<li><a href="#suspend-pagination">Suspending pagination during endnotes output</a></li>
</ul></li>
<li><a href="#endnotes-header-control"><b>Header/footer control</b></a>
<ul style="margin-left: -.5em;">
<li><a href="#endnotes-modify-hdrftr">Modifying what goes in the endnotes header/footer</a></li>
<li><a href="#endnotes-hdrftr-center">Header/footer centre string when doctype is CHAPTER</a></li>
<li><a href="#endnotes-allows-headers">Allow headers on endnotes pages</a></li>
</ul></li>
<li><a href="#endnotes-header"><b>Endnotes header (first-page title) control</b></a>
<ul style="margin-left: -.5em;">
<li><a href="#endnotes-header-string">Header string</a></li>
<li><a href="#endnotes-header-string-control">Header string control macros and defaults</a></li>
<li><a href="#endnotes-header-placement">Header string placement</a></li>
<li><a href="#endnotes-header-underscore">Header string underscoring</a></li>
<li><a href="#endnotes-header-caps">Header string capitalization</a></li>
</ul></li>
<li><a href="#endnotes-doc-title"><b>Endnotes document-identification string control</b></a>
<ul style="margin-left: -.5em;">
<li><a href="#endnote-title">Document-identification string(s)</a></li>
<li><a href="#endnote-title-control">Document-identification string control macros and defaults</a></li>
</ul></li>
<li><a href="#endnotes-numbering"><b>Endnotes referencing style</b></a>
<ul style="margin-left: -.5em;">
<li><a href="#endnote-marker-style">Endnote marker style</a> – by numbers in the text, or by line number
<ul style="margin-left: -.5em;">
<li><a href="#endnote-linenumber-gap">Spacing between line-numbered endnotes and the endnote text</a></li>
<li><a href="#endnote-linenumber-brackets">Brackets around endnote line numbers</a></li>
<li><a href="#endnote-linenumber-separator">Separator after endnote line numbers instead of brackets</a></li>
</ul></li>
<li><a href="#endnote-number-control">Endnote numbering control macros and defaults</a></li>
<li><a href="#endnote-number-alignment">Endnote numbering alignment</a></li>
</ul></li>
</ol>
</div>
<h4 id="endnotes-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. General endnotes page style control</h4>
<h5 id="endnote-style" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">• Base family/font/quad</h5>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following ENDNOTE control macros may also be
<a href="#grouping">grouped</a>
using ENDNOTE_STYLE.
</p>
<span class="pre defaults">
.ENDNOTE_FAMILY default = prevailing document family; default is Times Roman
.ENDNOTE_FONT default = roman
.ENDNOTE_QUAD* default = justified
*Note: ENDNOTE_QUAD must be set to either L (LEFT) or J (JUSTIFIED);
R (RIGHT) and C (CENTER) will not work.
</span>
</div>
<!-- -ENDNOTE_PT_SIZE- -->
<h5 id="endnote-pt-size" class="docs" style="margin-top: -1.5em; margin-bottom: .5em; margin-left: .5em;">• Base point size</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_PT_SIZE</b> <kbd class="macro-args"><base type size of endnotes></kbd>
</div>
<p>
Unlike most other control macros that deal with size of document
elements, ENDNOTE_PT_SIZE takes as its argument an absolute value,
relative to nothing. Therefore, the argument represents the size of
endnote type in
<a href="definitions.html#picaspoints">points</a>,
unless you append an alternative
<a href="definitions.html#unitofmeasure">unit of measure</a>.
For example,
<br/>
<span class="pre-in-pp">
.ENDNOTE_PT_SIZE 12
</span>
sets the base point size of type on the endnotes page to 12
points, whereas
<br/>
<span class="pre-in-pp">
.ENDNOTE_PT_SIZE .6i
</span>
sets the base point size of type on the endnotes page to 1/6 of an
inch.
</p>
<p>
The type size set with ENDNOTE_PT_SIZE is the size of type used for
the text of the endnotes, and forms the basis from which the point
size of other endnote page elements is calculated.
</p>
<p>
The default for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>
is 12.5 points (the same default size used in the body of the
document).
</p>
<!-- -ENDNOTE_LEAD- -->
<h5 id="endnote-lead" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Leading</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_LEAD</b> <kbd class="macro-args"><base leading of endnotes> [ ADJUST ] </kbd>
</div>
<p class="requires">
• Does not require a <a href="definitions.html#unitofmeasure">unit of measure</a>; points is assumed
</p>
<p>
Unlike most other control macros that deal with leading of document
elements, ENDNOTE_LEAD takes as its argument an absolute value,
relative to nothing. Therefore, the argument represents the
<a href="definitions.html#leading">leading</a>
of endnotes in
<a href="definitions.html#picaspoints">points</a>
unless you append an alternative
<a href="definitions.html#unitofmeasure">unit of measure</a>.
For example,
<br/>
<span class="pre-in-pp">
.ENDNOTE_LEAD 14
</span>
sets the base leading of type on the endnotes page to 14
points, whereas
<br/>
<span class="pre-in-pp">
.ENDNOTE_LEAD .5i
</span>
sets the base leading of type on the endnotes page to 1/2 inch.
</p>
<p>
If you want the leading of endnotes adjusted to fill the page, pass
ENDNOTE_LEAD the optional argument
<kbd>ADJUST</kbd>. (See
<a href="docprocessing.html#doc-lead-adjust">DOC_LEAD_ADJUST</a>
for an explanation of leading adjustment.)
</p>
<p>
The default for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>
is the prevailing document leading (16 by default), adjusted.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Even if you give mom a <kbd>.DOC_LEAD_ADJUST OFF</kbd> command, she
will still, by default, adjust endnote leading. You <i>must</i>
enter <kbd>.ENDNOTE_LEAD <lead></kbd> with no
<kbd>ADJUST</kbd> argument to disable this default behaviour.
</p>
</div>
<!-- -ENDNOTE_SPACING- -->
<h5 id="endnote-spacing" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Spacing between endnotes</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_SPACING</b> <kbd class="macro-args"><space to insert between endnotes></kbd>
</div>
<p class="requires">
• Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
If you’d like some whitespace between endnotes, just invoke
ENDNOTE_SPACING with the amount of space you want, e.g.
<br/>
<span class="pre-in-pp">
.ENDNOTE_SPACING 6p
</span>
which inserts 6 points of lead between endnotes. Be aware, though,
that inserting space between endnotes means that the bottoms of
endnotes pages will most likely not align.
</p>
<p>
Mom’s default is not to insert any whitespace between endnotes.
</p>
<!-- -SINGLESPACE_ENDNOTES- -->
<h5 id="singlespace-endnotes" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">• Singlespace endnotes (TYPEWRITE only)</h5>
<div class="box-macro-args">
Macro: <b>SINGLESPACE_ENDNOTES</b> <kbd class="macro-args"><toggle></kbd>
</div>
<p>
If your
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>
is <kbd>TYPEWRITE</kbd> and you use TYPEWRITE’s default
double-spacing, endnotes are double-spaced. If your document is
single-spaced, endnotes are single-spaced.
</p>
<p>
If, for some reason, you’d prefer that endnotes be
single-spaced in an otherwise double-spaced document (including
double-spaced
<a href="rectoverso.html#collate">collated</a>
documents), invoke
<br/>
<span class="pre-in-pp">
.SINGLESPACE_ENDNOTES
</span>
with no argument. And if, god help you, you want to change endnote
single-spacing back to double-spacing for different spacing of
endnotes output at the ends of separate documents in a collated
document, invoke <kbd>.SINGLESPACE_ENDNOTES</kbd> with any argument
(<kbd>OFF</kbd>, <kbd>QUIT</kbd>, <kbd>END</kbd>, <kbd>X</kbd>...).
</p>
<!-- -ENDNOTE_PARA_INDENT- -->
<h5 id="endnote-para-indent" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">• Paragraph indenting</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_PARA_INDENT</b> <kbd class="macro-args"><amount to indent first line of paragraphs in endnotes></kbd>
</div>
<p class="requires">
• Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
ENDNOTE_PARA_INDENT works exactly the same way as
<a href="#para-indent">PARA_INDENT</a>,
except that the indent given is the amount by which to indent the
first lines of endnote paragraphs, not document body paragraphs.
</p>
<p>
The default is 1.5
<a href="definitions.html#em">ems</a>
for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>;
1/2 inch for
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The first line of the first paragraph of endnotes (the one attached
immediately to the identifying endnote number) is never indented.
Only subsequent paragraphs are affected by ENDNOTE_PARA_INDENT.
</p>
</div>
<!-- -ENDNOTE_PARA_SPACE- -->
<h5 id="endnote-para-space" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Inter-paragraph spacing</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_PARA_SPACE</b> <kbd class="macro-args"><toggle></kbd>
</div>
<p>
ENDNOTE_PARA_SPACE works exactly the same way as
<a href="#pp-space">PARA_SPACE</a>,
except that it inserts a blank line between endnote paragraphs, not
document body paragraphs.
</p>
<p>
The default is not to insert a blank line between paragraphs in
endnotes.
</p>
<!-- -ENDNOTES_NO_COLUMNS- -->
<h5 id="endnotes-no-columns" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">• Turning off column mode during endnotes output</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_NO_COLUMNS</b> <kbd class="macro-args"><toggle></kbd>
</div>
<p>
By default, if your document is set in
<a href="docprocessing.html#columns">columns</a>,
mom sets the endnotes in columns, too. However, if your document
is set in columns and you’d like the endnotes not to be,
just invoke <kbd>.ENDNOTES_NO_COLUMNS</kbd> with no argument.
The endnotes pages will be set to the full page measure of your
document.
</p>
<p>
If you output endnotes at the end of each document in a
<a href="rectoverso.html#collate">collated</a>
document set in columns, column mode will automatically be
reinstated for each document, even with ENDNOTES_NO_COLUMNS turned
on. In such circumstances, you must re-enable ENDNOTES_NO_COLUMNS
for each separate collated document.
</p>
<h4 id="endnotes-pagination" class="docs" style="margin-bottom: .5em;">2. Pagination of endnotes</h4>
<!-- -ENDNOTES_PAGENUM_STYLE- -->
<h5 id="endnotes-pagenum-style" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">• Page numbering style</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_PAGENUM_STYLE</b> <kbd class="macro-args">DIGIT | ROMAN | roman | ALPHA | alpha</kbd>
</div>
<p>
Use this macro to set the page numbering style of endnotes pages.
The arguments are identical to those for
<a href="headfootpage.html#pagenum-style">PAGENUM_STYLE</a>.
The default is <kbd>digit</kbd>. You may want to change it to, say,
<kbd>alpha</kbd>, which you would do with
<br/>
<span class="pre-in-pp">
.ENDNOTES_PAGENUM_STYLE alpha
</span>
</p>
<!-- -ENDNOTES_FIRST_PAGENUMBER- -->
<h5 id="endnotes-first-pagenumber" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Setting the first page number of endnotes</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_FIRST_PAGENUMBER</b> <kbd class="macro-args"><page # that appears on page 1 of endnotes></kbd>
</div>
<p>
Use this macro with caution. If all endnotes for several
<a href="rectoverso.html#collate">collated</a>
documents are to be output at once, i.e. not at the end of each
separate doc, ENDNOTES_FIRST_PAGENUMBER tells mom what page number
to put on the first page of the endnotes.
</p>
<p>
However, if you set ENDNOTES_FIRST_PAGENUMBER in collated documents
in which the endnotes are output after each section (chapter,
article, etc), you have to reset every section’s first page
number after
<a href="rectoverso.html#collate">COLLATE</a>
and before
<a href="docprocessing.html#start">START</a>
with
<a href="headfootpage.html#pagenumber">PAGENUMBER</a>.
</p>
<!-- -ENDNOTES_NO_FIRST_PAGENUN- -->
<h5 id="endnotes-no-first-pagenum" class="docs" style="margin-top: -.25em; margin-bottom: .5em; margin-left: .5em;">• Omitting a page number on the first page of endnotes</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_NO_FIRST_PAGENUM</b> <kbd class="macro-args"><toggle></kbd>
</div>
<p>
This macro is for use only if
<a href="headfootpage.html#footers">FOOTERS</a>
are on. It tells
<a href="#endnotes">ENDNOTES</a>
not to print a page number on the first endnotes page. Mom’s
default is to print the page number.
</p>
<!-- -SUSPEND_PAGINATION- -->
<h5 id="suspend-pagination" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Suspending pagination during endnotes output</h5>
<div class="box-macro-args" style="margin-bottom: 1em;">
Macro: <b>SUSPEND_PAGINATION</b>
</div>
<div class="box-macro-args">
Macro: <b>RESTORE_PAGINATION</b>
</div>
<p>
SUSPEND_PAGINATION doesn’t take an argument. Invoked
immediately prior to
<a href="#endnotes">ENDNOTES</a>,
it turns off endnotes pages pagination. Mom continues, however to
increment page numbers silently.
</p>
<p>
To restore normal document pagination after endnotes, invoke
<kbd>.RESTORE_PAGINATION</kbd> (again, with no argument) immediately
after <kbd>.ENDNOTES</kbd>.
</p>
<h4 id="endnotes-header-control" class="docs" style="margin-bottom: .5em;">3. Header/footer control</h4>
<h5 id="endnotes-modify-hdrftr" class="docs" style="margin-top: 0; margin-bottom: -.75em; margin-left: .5em;">• Modifying what goes in the endnotes header/footer</h5>
<p>
If you wish to modify what appears in the header/footer that appears
on endnotes page(s), make the changes before you invoke
<a href="#endnotes"><kbd>.ENDNOTES</kbd></a>,
not afterwards.
</p>
<p>
Except in the case of
<a href="docprocessing.html#doctype">DOCTYPE <kbd>CHAPTER</kbd></a>,
mom prints the same header or footer used throughout the document
on the endnotes page(s). Chapters get treated differently in that,
by default, mom does not print the header/footer centre string
(normally the chapter number or chapter title.) In most cases, this
is what you want. However, should you not want mom to remove
the centre string from the endnotes page(s) headers/footers, invoke
<kbd><a href="#endnotes-hdrftr-center">.ENDNOTES_HEADER_CENTER</a></kbd>
with no argument.
</p>
<p>
An important change you may want to make is to put the word
“Endnotes” in the header/footer centre position. To do
so, invoke
<br/>
<span class="pre-in-pp" style="margin-bottom: -1em;">
.HEADER_CENTER "Endnotes"
</span>
or
<span class="pre-in-pp" style="margin-top: -.5em;">
.FOOTER_CENTER "Endnotes"
</span>
prior to invoking <kbd>.ENDNOTES</kbd>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If your
<a href="docprocessing.html#doctype">DOCTYPE</a>
is <kbd>CHAPTER</kbd>, you must also invoke
<a href="#endnotes-hdrftr-center">ENDNOTES_HEADER_CENTER</a>
for the ENDNOTES_HEADER_CENTER to appear.
</p>
</div>
<h5 id="endnotes-hdrftr-center" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">• Header/footer centre string when doctype is CHAPTER</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_HEADER_CENTER</b> <kbd class="macro-args">toggle</kbd>
</div>
<p>
If your
<a href="docprocessing.html#doctype">DOCTYPE</a>
is <kbd>CHAPTER</kbd> and you want mom to include a centre
string in the headers/footers that appear on endnotes
pages, invoke <kbd>.ENDNOTES_HEADER_CENTER</kbd> (or
<kbd>.ENDNOTES_FOOTER_CENTER</kbd>) with no argument. Mom’s
default is not to print the centre string.
</p>
<p>
If, for some reason, having enabled the header/footer centre string
on endnotes pages, you wish to disable it, invoke the same macro
with any argument (<kbd>OFF</kbd>, <kbd>QUIT</kbd>, <kbd>END</kbd>,
<kbd>X</kbd>...). </p>
<h5 id="endnotes-allows-headers" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Allow headers on endnotes pages</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_ALLOWS_HEADERS</b> <kbd class="macro-args"><none> | ALL</kbd>
</div>
<p>
By default, if HEADERS are on, mom prints page headers on all
endnotes pages except the first. If you don’t want her to
print headers on endnotes pages, do
<br/>
<span class="pre-in-pp">
.ENDNOTES_ALLOWS_HEADERS OFF
</span>
If you want headers on every page including the first, do
<br/>
<span class="pre-in-pp">
.ENDNOTES_ALLOWS_HEADERS ALL
</span>
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If FOOTERS are on, mom prints footers on every endnotes page.
This is a style convention. In mom, there is no such beast as
ENDNOTES_ALLOWS_FOOTERS OFF.
</p>
</div>
<h4 id="endnotes-header" class="docs">4. Endnotes header (first-page title) control</h4>
<!-- -ENDNOTES_HEADER_STRING- -->
<h5 id="endnotes-header-string" class="docs" style="margin-top: 1em; margin-bottom: .5em; margin-left: .5em;">• Header (first-page title) string</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_HEADER_STRING</b> <kbd class="macro-args">"<title to print at the top of endnotes>"</kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Alias:</i> <b>ENDNOTE_STRING</b> (for compatibility with older documents)
</p>
<p>
By default, mom prints the word “ENDNOTES” as a head
at the top of the first page of endnotes. If you want her to
print something else, invoke <kbd>.ENDNOTES_HEADER_STRING</kbd>
with the endnotes-page head you want, surrounded by double-quotes.
If you don’t want a head at the top of the first
endnotes-page, invoke <kbd>.ENDNOTES_HEADER_STRING</kbd>
with a blank argument (either two double-quotes side by
side—<kbd>""</kbd>—or no argument at all).
</p>
<!-- -ENDNOTES_HEADER_CONTROL- -->
<h5 id="endnotes-header-string-control" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Header (first-page title) control macros and defaults</h5>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following ENDNOTES_HEADER control macros may also be
<a href="#grouping">grouped</a>
using ENDNOTES_HEADER_STYLE.
</p>
<p style="margin-top: .5em; margin-bottom: 0; margin-left: .5em">
Please note that “_HEADER_”, here, refers to the title
that appears at the top of the first endnotes page, not to the page
headers of subsequent endnotes pages.
<span class="pre defaults">
.ENDNOTES_HEADER_FAMILY default = prevailing document family
.ENDNOTES_HEADER_FONT default = bold
.ENDNOTES_HEADER_SIZE* default = +1
.ENDNOTES_HEADER_QUAD default = centred
.ENDNOTES_HEADER_COLOR default = black
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</span>
</p>
</div>
<p style="margin-top: -2em">
<b>Note:</b> <i>For compatibility with older documents, these macros are aliased
as</i> <kbd>.ENDNOTE_STRING_<SPEC></kbd>, e.g. <kbd>.ENDNOTE_STRING_FAMILY</kbd>.
</p>
<!-- -ENDNOTES_HEADER_V_POS- -->
<h5 id="endnotes-header-placement" class="docs" style="margin-top: -.25em; margin-bottom: .5em; margin-left: .5em;">• Header (first-page title) placement</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_HEADER_V_POS</b> <kbd class="macro-args"><distance from top of page></kbd>
</div>
<p class="requires">
• Argument requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p class="alias" style="margin-top: -1em; margin-bottom: 0;">
<i>Alias:</i> <b>ENDNOTE_STRING_ADVANCE</b> (for compatibility with older documents)
</p>
<p>
By default, mom places the title (the docheader, as it were) of
endnotes pages (typically "ENDNOTES") on the same
<a href="definitions.html#baseline">baseline</a>
that is used for the start of
<a href="definitions.html#running">running text</a>.
If you’d prefer another location, higher or lower on the page
(thereby also raising or lowering the starting position of the
endnotes themselves), invoke <kbd>.ENDNOTES_HEADER_V_POS</kbd> with
an argument stating the distance from the top edge of the page at
which you’d like the title placed.
</p>
<p>
The argument requires a unit of measure, so if you’d like the title
to appear 1-1/2 inches from the top edge of the page, you’d tell
mom about it like this:
<br/>
<span class="pre-in-pp">
.ENDNOTES_HEADER_V_POS 1.5i
</span>
</p>
<!-- -ENDNOTES_HEADER_UNDERSCORE- -->
<h5 id="endnotes-header-underscore" class="docs" style="margin-top: -1em; margin-bottom: .5em; margin-left: .5em;">• Header (first-page title) underscoring</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_HEADER_UNDERSCORE</b> <kbd class="macro-args">[DOUBLE] [<underscore weight> [<underscore gap> [<distance between double rules]]] | <none> | <anything></kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Alias:</i> <b>ENDNOTES_HEADER_UNDERLINE</b>.
<i>(For compatibility with older documents, also
aliased as</i> <b>ENDNOTE_STRING_UNDERSCORE</b> <i>and</i>
<b>ENDNOTE_STRING_UNDERLINE</b>.)
</p>
<p class="requires">
• The argument
<span style="font-style: normal"><kbd><underscore weight></kbd></span>
must not have the
<a href="definitions.html#unitofmeasure">unit of measure</a>,
<span style="font-style: normal;"><kbd>p</kbd></span>,
appended to it; all other arguments require a unit of measure
</p>
<p>
Invoked without an argument, <kbd>.ENDNOTES_HEADER_UNDERSCORE</kbd>
will place a single rule underneath the endnotes page title. Invoked
with the argument, <kbd>DOUBLE</kbd>, ENDNOTES_HEADER_UNDERSCORE will
double-underscore the title. Invoked with any other non-numeric
argument, (e.g. <kbd>OFF, NO, X</kbd>, etc.) the macro disables
underscoring of the title.
</p>
<p>
In addition, you can use ENDNOTES_HEADER_UNDERSCORE to control the
weight of the underscore rule(s), the gap between the title and the
underscore, and, in the case of double-underscores, the distance
between the two rules.
</p>
<p>
Some examples:
<br/>
<span class="pre-in-pp">
.ENDNOTES_HEADER_UNDERSCORE 1
- turn underscoring on; set the rule weight to 1 point
.ENDNOTES_HEADER_UNDERSCORE 1 3p
- turn underscoring on; set the rule weight to 1 point; set
the gap between the title and the underscore to 3 points
.ENDNOTES_HEADER_UNDERSCORE DOUBLE .75 3p
- turn double-underscoring on; set the rule weight to 3/4 of
a point; set the gap between the title and the upper
underscore to 3 points; leave the gap between the upper
and the lower underscore at the default
.ENDNOTES_HEADER_UNDERSCORE DOUBLE 1.5 1.5p 1.5p
- turn double-underscoring on; set the rule weight to 1-1/2
points; set the gap between the title and the upper
underscore to 1-1/2 points; set the gap between the upper
and the lower underscore to 1-1/2 points
</span>
Note, from the above, that in all instances, underscoring (single
or double) is enabled whenever ENDNOTES_HEADER_UNDERSCORE is used in
this way.
</p>
<p>
By default, mom double-underscores the title if your
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>
is <kbd>TYPEWRITE</kbd>.
</p>
<!-- -ENDNOTES_HEADER_CAPS- -->
<h5 id="endnotes-header-caps" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Header (first-page title) capitalization</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTES_HEADER_CAPS</b> <kbd class="macro-args">toggle</kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Alias:</i> <b>ENDNOTE_STRING_CAPS</b> (for compatibility with older documents)
</p>
<p>
Invoked by itself, <kbd>.ENDNOTES_HEADER_CAPS</kbd> will
automatically capitalize the endnotes-page title. Invoked with any
other argument, the macro disables automatic capitalization of the
title.
</p>
<p>
If you’re generating a table of contents, you may want the
endnotes pages title to be in caps, but the toc entry in caps/lower
case. If the argument to
<a href="#endnotes-header-string">ENDNOTES_HEADER_STRING</a>
is in caps/lower case and ENDNOTES_HEADER_CAPS is on, this is exactly
what will happen.
</p>
<p>
Mom’s default is to capitalize the endnotes pages title string.
</p>
<!-- -ENDNOTE_TITLE- -->
<h4 id="endnotes-doc-title" class="docs" style="margin-top: -.25em;">5. Endnotes document-identification title control</h4>
<h5 id="endnote-title" class="docs" style="margin-top: 1em; margin-bottom: .5em; margin-left: .5em;">• Document-identification title string(s)</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_TITLE</b> <kbd class="macro-args">"<title to identify a document in endnotes>"</kbd>
</div>
<p>
By default, mom identifies the document(s) to which endnotes belong
by the document title(s) given to the
<a href="docprocessing.html#title">TITLE</a>
macro. If you’d like her to identify the document(s) another
way, simply invoke <kbd>.ENDNOTE_TITLE</kbd> prior to
<a href="docprocessing.html#start">START</a>
with the identifying title you want, surrounded by double-quotes.
</p>
<p>
If you don’t want any identifying title, invoke
<kbd>.ENDNOTE_TITLE</kbd> with a blank argument, either two
double-quotes side by side (<kbd>""</kbd>) or no argument
at all. This is particularly useful if you have a single (i.e.
non-collated) document and find having the document’s title
included in the endnotes redundant.
</p>
<!-- -ENDNOTE_TITLE_CONTROL- -->
<h5 id="endnote-title-control" class="docs" style="margin-top: .75em; margin-bottom: .5em; margin-left: .5em;">• Document-identification string control macros and defaults</h5>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
<br/>
The following ENDNOTE_TITLE_STYLE control macros may also be
<a href="#grouping">grouped</a>
using ENDNOTE_TITLE_STYLE_STYLE.
</p>
<span class="pre defaults">
.ENDNOTE_TITLE_FAMILY default = prevailing document family; default is Times Roman
.ENDNOTE_TITLE_FONT default = bold
.ENDNOTE_TITLE_SIZE* default = 0
.ENDNOTE_TITLE_COLOR default = black
.ENDNOTE_TITLE_QUAD default = left
.ENDNOTE_TITLE_CAPS
.ENDNOTE_TITLE_SMALLCAPS
.ENDNOTE_TITLE_UNDERSCORE default = single underscore
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</span>
</div>
<!-- -ENDNOTE_NUMBERING- -->
<h4 id="endnotes-numbering" class="docs" style="margin-top: -.25em;">6. Endnotes referencing style</h4>
<h5 id="endnote-marker-style" class="docs" style="margin-top: 1em; margin-bottom: .5em; margin-left: .5em;">• Endnote marker style</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_MARKER_STYLE</b> <kbd class="macro-args"><a href="#line">LINE</a> | <a href="#number">NUMBER</a> | <a href="#superscript">SUPERSCRIPT</a></kbd>
</div>
<p id="line">
<span style="display: block; margin-bottom: .25em;">• <i>Argument:</i> <kbd>LINE</kbd></span>
By default, mom places superscript numbers in
<a href="definitions.html#running">running text</a>
to identify endnotes. However, if you have
<a href="#number-lines">linenumbering</a>
turned on, you may instruct mom not to put superscript numbers in
the running text, but rather to reference endnotes by line number.
The command to do this is
<br/>
<span class="pre-in-pp">
.ENDNOTE_MARKER_STYLE LINE
</span>
With ENDNOTE_MARKER_STYLE <kbd>LINE</kbd>, mom will identify
endnotes either by single line numbers or by line ranges. If
what you want is a single line number, you need only invoke
<kbd>.ENDNOTE</kbd> at the appropriate place in running
text <i>without the terminating</i> <kbd>\c</kbd>. Input lines
after the endnote has been terminated (e.g. with <kbd>.ENDNOTE
OFF</kbd>) must begin at the left margin.
</p>
<p>
(Should you wish to revert to mom’s default behaviour of
placing a superscript number in the text to identify an endnote,
you can invoke <kbd>.ENDNOTE_MARKER_STYLE</kbd> with the argument,
<kbd>NUMBER</kbd>. It is not advisable to switch marker styles
within a single document, for aesthetic reasons, but there is
nothing to prevent you from doing so.)
</p>
<p id="en-mark">
If you want a range of line numbers (e.g. [5-11] ),
insert, directly into the first line of the range you want, the
<a href="definitions.html#inlines">inline escape</a>,
<kbd><span class="nobr">\*[EN-MARK]</span></kbd>. For the terminating line
number of the range, you need only invoke <kbd>.ENDNOTE</kbd>
(again, without the terminating <kbd>\c</kbd>). Mom is smart enough
to figure out that where <kbd>.ENDNOTE</kbd> is invoked represents
the terminating line number.
</p>
<div id="endnote-linenumbers-note" class="box-tip">
<p class="tip-top">
<span class="note">Note:</span>
By default, mom reserves a fixed amount of space, equal to 8
placeholders, for the linenumbers of linenumbered endnotes. Within
that space, the numbers are flush right with each other. The
reserved space is enough to print a range of linenumbers of the form
<kbd>[nnnn-nnnn]</kbd>, but may be more than you need.
</p>
<p>
The goal with linenumbered endnotes is to ensure that the longest
linenumber or range of lines is flush with the left margin of the
page. Adjusting the reserved space is done with the macro
<a href="docelement.html#endnote-numbers-align">ENDNOTE_NUMBERS_ALIGN</a>,
and the rules for getting it right are simple.
</p>
<p class="tip-bottom">
If your document runs to less than 100 lines, invoke
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 0
</span>
If your document has between 100 and 999 lines
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 1
</span>
If your document has between 1000 and 9999 lines
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 2
</span>
etc.
</p>
</div>
<p id="number" style="margin-top: -.5em;">
<span style="display: block; margin-bottom: .25em;">• <i>Argument:</i> <kbd>NUMBER</kbd></span>
With the argument <kbd>NUMBER</kbd>, mom places superscript numbers
in running text, but identifies endnotes in the endnotes section
of your document with normal-sized, base-aligned numbers.
</p>
<p id="superscript" style="margin-top: -.5em;">
<span style="display: block; margin-bottom: .25em;">• <i>Argument:</i> <kbd>SUPERSCRIPT</kbd></span>
With the argument <kbd>SUPERSCRIPT</kbd>, mom places superscript
numbers in running text, and identifies endnotes in the endnotes
section of your document with superscript numbers as well. This is
mom’s default.
</p>
<div id="endnote-superscript-note" class="box-tip">
<p class="tip-top">
<span class="note">Note:</span>
By default, mom reserves a fixed amount of space, equal to 2
placeholders, for the superscript numbers identifying endnotes in
the endnotes section of your document. Within that space, the
numbers are flush right with each other.
</p>
<p class="tip-bottom">
If you need less space (the total number of endnotes is less than 10) or
more (the total number of endnotes is greater than 99), use the
macro
<a href="docelement.html#endnote-numbers-align">ENDNOTE_NUMBERS_ALIGN</a>,
to set the desired amount of reserved space, e.g.
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 1
</span>
or
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 3
</span>
</p>
</div>
<h5 id="endnote-linenumber-gap" class="docs" style="margin-bottom: .5em; margin-left: .5em;">• Spacing between line-numbered endnotes and the endnote text</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_LINENUMBER_GAP</b> <kbd class="macro-args"><size of gap></kbd>
</div>
<p class="requires">
• Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
When your
<a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
is <kbd>LINE</kbd>, mom, by default, inserts a space equal to
1/2-<a href="definitions.html#em">en</a>
between the linenumber and the text of an endnote. For aesthetic
reasons, you may want to change the size of the gap, which is done
with the macro ENDNOTE_LINENUMBER_GAP.
</p>
<p>
ENDNOTE_LINENUMBER_GAP takes as its single argument the size
of the gap. The argument requires a
<a href="definitions.html#unitofmeasure">unit of measure</a>,
so, for example, to change the gap to 2
<a href="definitions.html#picaspoints">picas</a>,
you’d do
<br/>
<span class="pre-in-pp">
.ENDNOTE_LINENUMBER_GAP 2P
</span>
</p>
<h5 id="endnote-linenumber-brackets" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Brackets around endnote line numbers</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_LINENUMBER_BRACKETS</b> <kbd class="macro-args">PARENS | SQUARE | BRACES | ( | [ | {</kbd>
</div>
<p>
By default, mom puts endnote line numbers inside square brackets.
The style of the brackets may be changed with the macro
ENDNOTE_LINENUMBER_BRACKETS, which takes one of three possible
arguments: <kbd>PARENS</kbd> (“round” brackets),
<kbd>SQUARE</kbd> (the default) or <kbd>BRACES</kbd> (curly braces).
If you prefer a shortform, the arguments, <kbd>(</kbd>, <kbd>[</kbd>
or <kbd>{</kbd> may be used instead.
</p>
<h5 id="endnote-linenumber-separator" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">• Separator after endnote line numbers instead of brackets</h5>
<div class="box-macro-args">
Macro: <b>ENDNOTE_LINENUMBER_SEPARATOR</b> <kbd class="macro-args"><character></kbd>
</div>
<p>
If you don’t want the numbers enclosed in brackets, you may tell
mom to use a separator instead. A common
separator would be the colon, but it can be anything you like.
</p>
<p>
ENDNOTE_LINENUMBER_SEPARATOR takes as its single argument the
separator you want. (If the argument contains spaces, don’t
forget to enclose the argument in double-quotes.) The separator
can be composed of any valid groff character, or any combination of
characters. For example, to get a colon separator after the line
number in line-numbered endnotes, you’d do
<br/>
<span class="pre-in-pp">
.ENDNOTE_LINENUMBER_SEPARATOR :
</span>
</p>
<h5 id="endnote-number-control" class="docs" style="margin-top: -1em; margin-bottom: .5em; margin-left: .5em;">• Endnote numbering style control</h5>
<div class="defaults-container" style="padding-bottom: 8px;">
<p class="defaults" style="padding-top: 6px;">
See
<a href="#control-macro-args">Arguments to the control macros</a>.
</p>
<p class="defaults">
Please note that the control macros for endnote numbering affect only
the numbers that appear on the endnotes pages themselves, not the
endnote numbers that appear in the body of a document.
</p>
<span class="pre defaults">
Numbered endnotes
.ENDNOTE_NUMBER_FAMILY default = prevailing document family; default Times Roman
.ENDNOTE_NUMBER_FONT default = bold
.ENDNOTE_NUMBER_SIZE* default = 0
Linenumbered endnotes
.ENDNOTE_LINENUMBER_FAMILY default = prevailing document family; default Times Roman
.ENDNOTE_LINENUMBER_FONT default = bold
.ENDNOTE_LINENUMBER_SIZE* default = 0
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</span>
</div>
<h5 id="endnote-number-alignment" class="docs" style="margin-top: -1.25em; margin-bottom: -.5em; margin-left: .5em;">• Endnote numbering alignment</h5>
<p style="margin-top: .75em;">
By default, when your
<a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
is <kbd>NUMBER</kbd>, mom hangs the numbers on endnotes pages,
aligned right to two placeholders, producing this:
<br/>
<span id="endnote-numbering-alignment-example" class="pre-in-pp">
9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat, sed diam voluptua.
10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat, sed diam voluptua.
</span>
If you wish to change either the alignment or the number of
placeholders, the macro to use is ENDNOTE_NUMBERS_ALIGN.
</p>
<!-- -ENDNOTE_NUMBERS_ALIGN- -->
<div id="endnote-numbers-align" class="box-macro-args">
Macro: <b>ENDNOTE_NUMBERS_ALIGN</b> <kbd class="macro-args">LEFT | RIGHT <number of placeholders></kbd>
</div>
<p>
ENDNOTE_NUMBERS_ALIGN determines how endnote numbers are aligned. If you invoke
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 2
</span>
the periods (dots) after the numbers will align, like this
<span class="pre-in-pp">
9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat, sed diam voluptua.
10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat, sed diam voluptua.
</span>
If you invoke
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN LEFT 2
</span>
the first digits of the numbers will line up flush left, like this
<span class="pre-in-pp">
9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat, sed diam voluptua.
10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat, sed diam voluptua.
</span>
The argument <kbd><number of placeholders></kbd> represents
the maximum size of the numbers, expressed as the number of
digits in the largest number. Numbers in the range 0-9 require
1 placeholder; in the range 10-99, 2 placeholders; in the range
100-999 3 placeholders, and so on.
</p>
<p>
Therefore, if you have fewer than ten endnotes,
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 1
</span>
would ensure proper right alignment of endnote numbers.
</p>
<p>
Mom’s default for endnote number alignment is to align the
numbers right to two placeholders.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
ENDNOTE_NUMBERS_ALIGN can also be used to establish the alignment
and number of placeholders when your
<a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
is <kbd>SUPERSCRIPT</kbd>. Furthermore, it can be used to establish
the number of placeholders to reserve when your ENDNOTE_MARKER_STYLE
is <kbd>LINE</kbd>, even though, in such an instance, the numbers
themselves are always aligned right. See
<a href="#endnote-linenumbers-note">here</a>
for examples.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="margin-notes-intro" class="macro-group">Margin notes</h2>
<ul style="margin-left: -.5em;">
<li><a href="#margin-notes-behaviour">Margin notes behaviour</a>
<ul style="margin-left: -.5em;">
<li><a href="#margin-notes-vertical">Adjusting the vertical position of margin notes</a></li>
</ul></li>
<li><a href="#mn-init">Macro: <b>MN_INIT</b></a> – set margin notes parameters</li>
<li><a href="#mn">Tag: MN</a></li>
</ul>
<p>
Margin notes are short annotations that appear in either the left
or right margin of a document. Sometimes they comment on the text.
Sometimes they assist in following the “flow” of a
document by summarizing the subject of a portion of text. Sometimes
they’re comments to yourself in a draft copy.
</p>
<p>
The margin notes macros and routines in om.tmac (mom) are
“mommified” versions of the margin notes macros and
routines written by Werner Lemberg and patched by Gaius Mulley.
</p>
<h3 id="margin-notes-behaviour" class="docs">Margin notes behaviour</h3>
<p>
First things first: before you enter your first margin note, you
must “initialize” margin notes with
<a href="#mn-init">MN_INIT</a>.
MN_INIT sets up the style parameters for margin notes, including
things like
<a href="definitions.html#font">font</a>,
<a href="definitions.html#family">family</a>
and
<a href="definitions.html#leading">leading</a>.
MN_INIT may be called before or after
<a href="docprocessing.html#start">START</a>.
</p>
<p>
After initializing margin notes, you create margin notes with the
<a href="#mn">MN</a>
macro. Based on the argument you pass MN, your margin note will go
in either the left or the right margin.
</p>
<p>
Margin notes are tricky from a typographic standpoint with respect
to vertical placement. Since the leading of margin notes may differ
from that of
<a href="definitions.html#running">running text</a>,
it’s impossible for mom to guess whether to align
the first lines of margin notes with a document
<a href="definitions.html#baseline">baseline</a>,
whether to align the last lines of margin notes with a document
baseline, or whether to centre them, vertically, so that neither
first nor last line aligns with anything!
</p>
<p>
Given this difficulty, mom always aligns the first line of any
margin note with a document baseline. If you want a different
behaviour, you must adjust the position(s) of margin notes yourself,
on a note by note basis. (See
<a href="#margin-notes-vertical">Adjusting the vertical position of margin notes</a>.)
</p>
<p>
Generally speaking, mom tries to place margin notes at the point
where you invoke
<a href="#mn">MN</a>.
However, in the event that a margin note runs deep, she may not be
able to place a subsequent margin note exactly where you want. In
such an instance, mom will “shift” the margin note down
on the page, placing it one (margin note) linespace beneath the
previous margin note (plus whatever vertical space is required to
get the first line to line up with a baseline of running text). A
warning will be issued, letting you know this has happened, and
where.
</p>
<p>
Sometimes, if a margin note has to be shifted down, there simply
isn’t enough room to start the margin note on the page on
which <kbd>.MN</kbd> is invoked. In that case, mom ignores the
margin note entirely and issues a warning, letting you know what
she’s done, and where. </p>
<p>
In the event that a margin note, successfully begun on a page, runs
past your bottom margin (or the last line before footnotes begin),
the margin note will “flow” onto the next page. If
it is a “left” margin note, it will continue in the
left margin. If it is a “right” margin note, it will
continue in the right margin.
</p>
<p>
If your document is being set in two columns, mom will sensibly and
automatically set all margin notes pertaining to the left column in
the left margin, and all margin notes pertaining to the right column
in the right margin, regardless of the “direction”
argument you give the MN tag. If you try to use MN in documents of
more than two columns, mom will ignore all margin notes, and issue
a warning for each.
</p>
<h3 id="margin-notes-vertical" class="docs">Adjusting the vertical position of margin notes</h3>
<p>
When the
<a href="definitions.html#term-leading">leading</a>
of margin notes differs from the leading used throughout a document,
you may want to adjust the vertical position of individual margin
notes. This is most often going to be the case with margin notes
that end near the bottom of the page, where you want the last line
of the margin note to line up with the last line of text on the
page.
</p>
<p>
Adjustments to the vertical position of margin notes must be done
inside the margin note (i.e. after <kbd>.MN</kbd>), at the top,
before entering text. The commands to use are
<kbd>\!<a href="typesetting.html#ald">.ALD</a></kbd>
(to lower the margin note) and
<kbd>\!<a href="typesetting.html#rld">.RLD</a></kbd>
(to raise it).
The <kbd>\!</kbd> must precede the macros, or they
won’t have any effect.
</p>
<!-- -MN_INIT- -->
<div class="macro-id-overline">
<h3 id="mn-init" class="macro-id">MN_INIT</h3>
</div>
<div class="box-macro-args">
Macro: <b>MN_INIT</b> <kbd class="macro-args"><arguments> (see list)</kbd>
</div>
<h4 style="margin-top: .75em; margin-left: .5em; font-style: normal; font-weight: bold: font-size: 105%; color: #6f614a;">Argument list:</h4>
<span class="pre" style="margin-top: -1.5em; margin-left: .5em;">
RAGGED | SYMMETRIC
<L_WIDTH> <value>
<R_WIDTH> <value>
<GUTTER> <value>
<FONTSTYLE> <value>
<SIZE> <value>
<LEAD> <value>
<COLOR> <value>
<HY> <value>
</span>
<p style="margin-top: 1.25em;">
Before you enter your first margin note, you must initialize
the style parameters associated with margin notes using MN_INIT.
If you forget to do so, mom will issue a warning and abort.
</p>
<p>
The arguments may be entered in any order, and since the list is
long, use of the backslash character ( <kbd>\</kbd> ) to put each on
a separate line is recommended, e.g.
<br/>
<span class="pre-in-pp">
.MN_INIT \
SYMMETRIC \
L_WIDTH 4P \
SIZE 8 \
LEAD 9 \
HY 14
</span>
All arguments are optional, but since mom requires you to run
MN_INIT before entering margin notes, you should, at a minimum, set
the <kbd>RAGGED</kbd> or <kbd>SYMMETRIC</kbd> parameter.
You will almost certainly want to set <kbd>L_WIDTH</kbd>, <kbd>R_WIDTH</kbd>,
<kbd>SIZE</kbd> and <kbd>LEAD</kbd> as well.
</p>
<h4 class="docs arg-list"><kbd>RAGGED | SYMMETRIC</kbd></h4>
<p>
If the argument <kbd>RAGGED</kbd> is given, both left and
right margin notes will be flush left. If the argument
<kbd>SYMMETRIC</kbd> is given, left margin notes will be set flush
<i>right</i>, and right margin notes flush <i>left</i>. The effect
is something like this:
<br/>
<span class="pre-in-pp">
A left This is a meaningless batch A right
margin note of text whose sole purpose is margin note
with just to demonstrate how the sym- with just
a few words metric argument to MN sets left a few words
in it. and right margin notes. in it.
</span>
</p>
<p>
If the argument is omitted, both left and right margin notes will
be set justified. (Justified is usually not a good idea, since the
narrow measure of margin notes makes pleasing justification a near
impossibility.)
</p>
<h4 class="docs arg-list"><kbd>L_WIDTH <value></kbd></h4>
<p>
The width of left margin notes. A
<a href="definitions.html#unitofmeasure">unit of measure</a>
must be appended directly onto the argument. The default is to set
left margin notes right out to the edge of the page, which is almost
certainly not what you want, so you should give a value for this
argument if using left margin notes.
</p>
<h4 class="docs arg-list"><kbd>R_WIDTH <value></kbd></h4>
<p>
The width of right margin notes. A
<a href="definitions.html#unitofmeasure">unit of measure</a>
must be appended directly onto the argument. The default is to
set right margin notes right out to the edge of the page, which is
almost certainly not what you want, so you should give a value for
this argument if using right margin notes.
</p>
<h4 class="docs arg-list"><kbd>GUTTER <value></kbd></h4>
<p>
The
<a href="definitions.html#gutter">gutter</a>
between margin notes and
<a href="definitions.html#running">running text</a>.
A
<a href="definitions.html#unitofmeasure">unit of measure</a>
must be appended directly onto the argument. The gutter applies to
both left and right margin notes. The default is 1
<a href="definitions.html#em">em</a>.
</p>
<h4 class="docs arg-list"><kbd>FONTSTYLE <value></kbd></h4>
<p>
The family+font for margin notes. Yes, that’s right: the
family <i>plus</i> font combo. For example, if you want Times
Roman Medium, the argument must be <kbd>TR</kbd>. If you want Palatino
Medium Italic, the argument must be <kbd>PI</kbd>. The default is the same
family+font combo used for a document’s paragraph text.
</p>
<h4 class="docs arg-list"><kbd>SIZE <value></kbd></h4>
<p>
The point size of type for margin notes. There is no need to append a
<a href="definitions.html#unitofmeasure">unit of measure</a>
to the argument;
<a href="definitions.html#picaspoints">points</a>
is assumed (although there’s nothing preventing you from
appending an alternative unit of measure directly to the argument).
The default is for margin notes to use the same point size of type
as is used in document paragraphs.
</p>
<h4 class="docs arg-list"><kbd>LEAD <value></kbd></h4>
<p>
The
<a href="definitions.html#leading">leading</a>
of margin notes. <kbd><LEAD></kbd> takes
<a href="definitions.html#picaspoints">points</a>
as its unit of measure, so don’t tack a unit of measure onto
the end of the argument. The default lead is the same as paragraph
text (i.e. the document’s base leading).
</p>
<h4 class="docs arg-list"><kbd>COLOR <value></kbd></h4>
<p>
The colour of margin notes. The colour must be pre-initialized
with
<a href="color.html#newcolor">NEWCOLOR</a>
or
<a href="color.html#xcolor">XCOLOR</a>.
The default is black.
</p>
<h4 class="docs arg-list"><kbd>HY <value></kbd></h4>
<p>
<kbd><value></kbd> is a digit telling groff how you want margin
notes hyphenated.
<br/>
<span class="pre-in-pp">
0 = do not hyphenate
1 = hyphenate without restrictions
2 = do not hyphenate the last word on the page
4 = do not hyphenate the last two characters of a word
8 = do not hyphenate the first two characters of a word
</span>
The values can be added together, so, for example, if you want
neither the first two nor the last two characters of words
hyphenated, the hyphenation-flag would be 12. The default value is
14 (i.e. 2+4+8).
</p>
<!-- -MN- -->
<div class="macro-id-overline">
<h3 id="mn" class="macro-id">MN</h3>
</div>
<div class="box-macro-args">
Macro: <b>MN</b> <kbd class="macro-args">LEFT | RIGHT</kbd>
</div>
<p>
Once you’ve initialized margin notes with
<kbd><a href="#mn-init">.MN_INIT</a></kbd>,
you can enter margin notes any time you like with <kbd>.MN</kbd>.
An argument of <kbd>LEFT</kbd> will set a left margin note. An
argument of <kbd>RIGHT</kbd> will set a right margin note.
</p>
<p>
Any argument, such as <kbd>OFF</kbd> (or <kbd>OFF</kbd>,
<kbd>QUIT</kbd>, <kbd>END</kbd>, <kbd>X</kbd>, etc) exits the
current margin note.
</p>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<!-- -FINIS- -->
<h2 id="finis-intro" class="macro-group">Document termination string</h2>
<ul style="margin-left: -.5em;">
<li><a href="#finis">Tag: FINIS</a></li>
<li><a href="#finis-control">FINIS control macros</a>
<ul style="margin-left: -1.25em;">
<li><a href="#finis-string">Changing the FINIS string</a></li>
<li><a href="#finis-string-caps">Automatic capitalization of the FINIS string</a></li>
<li><a href="#finis-color">Changing the FINIS colour</a></li>
<li><a href="#finis-no-dashes">Removing the dashes around FINIS</a></li>
</ul></li>
</ul>
<p>
The use of FINIS is optional. If you invoke it at the end of a
document (before
<kbd><a href="#endnotes">.ENDNOTES</a></kbd>,
<kbd><a href="refer.html#bibliography">.BIBLIOGRAPHY</a></kbd>
or
<kbd><a href="tables-of-contents.html#toc">.TOC</a></kbd>)
mom deposits the word, <b>END</b>, centred after a blank line,
beneath the last line of the document. <b>END</b> is enclosed
between
<a href="definitions.html#em">em-dashes</a>,
like this:
<br/>
<span class="pre-in-pp">
...and they all lived happily ever after.
— END —
</span>
If there is insufficient room for FINIS on the last page of a
document, mom will alert you on stderr.
</p>
<p>
If you’re writing in a language other than English, you can
change what mom prints for END with the control macro
<a href="#finis-string">FINIS_STRING</a>.
</p>
<div class="macro-id-overline">
<h3 id="finis" class="macro-id">FINIS</h3>
</div>
<div class="box-macro-args">
Macro: <b>FINIS</b>
</div>
<p>
The use of FINIS is optional, but if you use it, it should be the
last macro you invoke in a document before
<kbd><a href="#endnotes">.ENDNOTES</a></kbd>,
<kbd><a href="refer.html#bibliography">.BIBLIOGRAPHY</a></kbd>
or
<kbd><a href="tables-of-contents.html#toc">.TOC</a></kbd>.
See
<a href="#finis-intro">above</a>
for a description of how FINIS behaves.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If you don’t use FINIS, and you don’t want
<a href="definitions.html#footer">footers</a>
(if they’re on) or a page number at the bottom of the last
page of a document, you have to turn them off manually, as the last
two lines of your document file, like this:
<br/>
<span class="pre-in-pp">
.FOOTERS OFF
.PAGINATE OFF
</span>
</p>
</div>
<!-- -FINIS STRING- -->
<h3 id="finis-control" class="docs" style="margin-bottom: -1em">Finis control macros</h3>
<p>
Since FINIS is only used once in a document, it has few control
macros. It is expected that you will make changes to style
parameters such as family, font, and size with
<a href="definitions.html#inlines">inline escapes</a>
in the FINIS string itself (see below).
</p>
<h4 id="finis-string" class="docs" style="margin-top: -.5em">Changing the FINIS string</h4>
<p>
By default, FINIS prints the word, END, between
<a href="definitions.html#em">em-dashes</a>.
If you’d like mom to print something else between the dashes,
use the FINIS_STRING macro (anywhere in the document prior to
FINIS).
</p>
<p>
For example, if your document’s in French, you’d do
<br/>
<span class="pre-in-pp">
.FINIS_STRING "FIN"
</span>
Double-quotes must enclose the macro’s argument.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If you pass FINIS_STRING a blank string,
<br/>
<span class="pre-in-pp">
.FINIS_STRING ""
</span>
mom will still print the em-dashes when you invoke
<kbd>.FINIS</kbd>. This, in effect, produces a short, centred
horizontal rule that terminates the document. (In
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>,
it’s a short, dashed line composed of four hyphens.)
</p>
</div>
<!-- -FINIS STRING CAPS- -->
<h4 id="finis-string-caps" class="docs">Automatic capitalization of the FINIS string</h4>
<p>
By default, mom sets the string you pass to FINIS all-caps.
If you’d prefer that she not do so, but rather respect
the FINIS string exactly as you enter it, invoke the macro
<kbd>.FINIS_STRING_CAPS</kbd> with the <kbd>OFF</kbd> argument, like
this:
<br/>
<span class="pre-in-pp">
.FINIS_STRING_CAPS OFF
</span>
<kbd>OFF</kbd>, above, could be anything, e.g. <kbd>NO</kbd> or
<kbd>X</kbd>.
</p>
<!-- -FINIS COLOR- -->
<h4 id="finis-color" class="docs">Changing the FINIS colour</h4>
<p>
Invoking the control macro <kbd>.FINIS_COLOR</kbd> with a
pre-defined (or “initialized”) colour changes the colour
of both the FINIS string and the em-dashes that surround it. If you
use the
<a href="definitions.html#inline">inline escape</a>,
<a href="color.html#color-inline"><kbd><span class="nobr">\*[<colourname>]</span></kbd></a>,
in the argument passed to FINIS, only the text will be in the
new colour; the em-dashes will be in the default document colour
(usually black).
</p>
<!-- -FINIS DASHES- -->
<h4 id="finis-no-dashes" class="docs">Removing the dashes around FINIS</h4>
<p>
If you don’t want the dashes around the FINIS string, you can
remove them with
<br/>
<span class="pre-in-pp">
.FINIS_NO_DASHES
</span>
</p>
<div class="rule-long"><hr/></div>
<!-- Navigation links -->
<table style="width: 100%; margin-top: 12px;">
<tr>
<td style="width: 33%;"><a href="toc.html">Back to Table of Contents</a></td>
<td style="width: 33%; text-align: center;"><a href="#top">Top</a></td>
<td style="width: 33%; text-align: right;"><a href="images.html#top">Next: Graphics, floats, and preprocessor support</a></td>
</tr>
</table>
</div>
<div class="bottom-spacer"><br/></div>
</body>
</html>
|
