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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
<title>Mom -- Document Processing, element tags</title>
</head>
<body bgcolor="#dfdfdf">
<!====================================================================>
<a href="headfootpage.html#TOP">Next</a>
<a href="docprocessing.html#TOP">Prev</a>
<a href="toc.html">Back to Table of Contents</a>
<p>
<a name="TOP"></a>
<a name="DOCELEMENT">
<h1 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h1>
</a>
<ul>
<li><a href="#DOCELEMENT_INTRO">Introduction to the document element tags</a>
<ul>
<li><a href="#DOCELEMENT_CONTROL">Control macros -- changing defaults for document element tags</a>
<li><a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
</ul>
<li><a href="#INDEX_DOCELEMENT">Index of document element tags</a>
</ul>
<a name="DOCELEMENT_INTRO">
<h2><u>Introduction to the document element tags</u></h2>
</a>
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 <strong>mom</strong>, "This is a paragraph, this
is a subhead, this is a footnote," and so on.
<p>
The list of tags is actually quite small -- ideal for the users
<strong>mom</strong> brought herself into being for (see
<a href="intro.html#INTRO_INTRO">Who mom is meant for</a>).
However, the list of macros that control the appearance of the
tags upon output is extensive. Generally, for each tag,
there are
<a href="definitions.html#TERMS_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.
<p>
<strong>Mom</strong> 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>
<a name="DOCELEMENT_CONTROL"><h3><u>Control macros -- changing defaults</u></h3></a>
<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
<strong>mom</strong>'s defaults for family, font, point size and
colour. Where appropriate, there are macros to control leading,
indents and quad as well.
<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 <strong>mom</strong>'s defaults for the tag are.
<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>
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#TERMS_TOGGLE">toggle</a>
tags (affecting only that particular invocation of the tag).
Equally,
<a href="definitions.html#TERMS_INLINES">inline escapes</a>
can be used in tags that take
<a href="definitions.html#TERMS_STRINGARGUMENT">string arguments.</a>
<p>
<strong>IMPORTANT NOTE:</strong> The family, font, point size,
colour and leading control macros have no effect in
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
which sets EVERYTHING in Courier roman, 12/24 (i.e. 12-point type on
a linespace of 24 points).
<p>
Please also note that the defaults listed
with the control macros apply only to
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
unless a default for <strong>TYPEWRITE</strong> is also given.
<p>
<strong>A WORD OF ADVICE:</strong> Get familiar with
<strong>mom</strong> 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 <strong>mom</strong>
is complex and unwieldy, which is not only untrue, but would offend
her mightily.
<p>
<a name="CONTROL_MACRO_ARGS"><h3><u>Arguments to the control macros</u></h3></a>
<h3>Family and font</h3>
The arguments to the control macros that end in
<strong>_FAMILY</strong> or <strong>_FONT</strong> are the same
as for
<a href="typesetting.html#FAMILY">FAMILY</a>
and
<a href="typesetting.html#FONT">FT</a>.
<h3>Point size</h3>
Control macros that end in <strong>_SIZE</strong> always take
the form <kbd>+digit</kbd> or <kbd>-digit</kbd> where digit is
the number of
<a href="definitions.html#TERMS_PICASPOINTS">points</a>
larger (+) or smaller (-) than the point size of paragraphs
you want the document element to be. For example, to change
subheads to 1-1/2 points larger than the type in paragraphs, do
<p>
<pre>
.SUBHEAD_SIZE +1.5
</pre>
There's no need for a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
with the <strong>_SIZE</strong> control macros; points is assumed.
<h3>Colour</h3>
Control macros that end in <strong>_COLOR</strong> 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 heads to be red, once you've defined
or initialized the color, red,
<p>
<pre>
.HEAD_COLOR red
</pre>
will turn your heads red.
<h3>Lead/linespacing</h3>
Control macros that end in <strong>_AUTOLEAD</strong> take the
same argument as
<a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>,
viz. a digit that represents the number of points to add to the
tag's point size to arrive at its
<a href="definitions.html#TERMS_LEADING">lead</a>.
For example, to set footnotes
<a href="definitions.html#TERMS_SOLID">solid</a>, do
<p>
<pre>
.FOOTNOTE_AUTOLEAD 0
</pre>
To set footnotes with a 1-point lead (i.e. with the line spacing
one point greater than the footnote's point size), do
<p>
<pre>
.FOOTNOTE_AUTOLEAD 1
</pre>
<h3><a name="CONTROL_INDENTS">Indents</a></h3>
Except for <strong>PARA_INDENT</strong>, the argument to the control
macros that end
in <strong>_INDENT</strong> is always a single digit (whole numbers
only; no decimal fractions) with no
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
appended to it. The digit represents by how much you want the
size of the paragraph first-line indent multiplied to achieve the
correct indent for a particular tag.
<h3>Quad/justification style</h3>
Control macros that end in <strong>_QUAD</strong> take the same
arguments as
<a href="typesetting.html#QUAD">QUAD</a>.
<p>
<hr>
<a name="INDEX_DOCELEMENT"><h3><u>Document element tags list</u></h3></a>
<ul>
<li><a href="#EPIGRAPH_INTRO">Epigraphs</a>
<ul>
<li><a href="#EPIGRAPH">EPIGRAPH</a>
<li><a href="#EPIGRAPH_CONTROL">Epigrah control</a>
</ul>
<li><a href="#PP_INTRO">Paragraphs</a>
<ul>
<li><a href="#PP">PP</a>
<li><a href="#PP_CONTROL">Paragraph control</a>
</ul>
<li><a href="#HEAD_INTRO">Main heads</a>
<ul>
<li><a href="#HEAD">HEAD</a>
<li><a href="#HEAD_CONTROL">Head control</a>
</ul>
<li><a href="#SUBHEAD_INTRO">Subheads</a>
<ul>
<li><a href="#SUBHEAD">SUBHEAD</a>
<li><a href="#SUBHEAD_CONTROL">Subhead control</a>
</ul>
<li><a href="#PARAHEAD_INTRO">Paragraph heads</a>
<ul>
<li><a href="#PARAHEAD">PARAHEAD</a>
<li><a href="#PARAHEAD_CONTROL">Parahead control</a>
</ul>
<li><a href="#LINEBREAK_INTRO">Linebreaks (author linebreaks, section breaks)</a>
<ul>
<li><a href="#LINEBREAK">LINEBREAK</a>
<li><a href="#LINEBREAK_CHAR">Linebreak character</a>
<li><a href="#LINEBREAK_COLOR">Linebreak colour</a>
</ul>
<li><a href="#QUOTE_INTRO">Quotes (line for line)</a>
<ul>
<li><a href="#QUOTE">QUOTE</a>
<li><a href="#QUOTE_CONTROL">Quote control</a>
</ul>
<li><a href="#BLOCKQUOTE_INTRO">Blockquotes (cited material)</a>
<ul>
<li><a href="#BLOCKQUOTE">BLOCKQUOTE</a>
<li><a href="#BLOCKQUOTE_CONTROL">Blockquote control</a>
</ul>
<li><a href="#LIST_INTRO">Nested lists</a>
<ul>
<li><a href="#LIST">LIST</a>
<ul>
<li><a href="#ITEM">ITEM</a>
</ul>
<li><a href="#LIST_CONTROL">List control</a>
</ul>
<li><a href="#NUMBER_LINES_INTRO">Line numbering</a>
<ul>
<li><a href="#NUMBER_LINES">NUMBER_LINES</a>
<li><a href="#NUMBER_LINES_CONTROL">Control macros</a> (for QUOTE and BLOCKQUOTE)
</ul>
<li><a href="#FOOTNOTE_INTRO">Footnotes</a>
<ul>
<li><a href="#FOOTNOTE">FOOTNOTE</a>
<li><a href="#FOOTNOTE_CONTROL">Footnote control</a>
</ul>
<li><a href="#ENDNOTE_INTRO">Endnotes</a>
<ul>
<li><a href="#ENDNOTE">ENDNOTE</a>
<li><a href="#ENDNOTE_CONTROL">Endnote control</a>
</ul>
<li><a href="#MARGIN_NOTES_INTRO">Margin notes</a>
<ul>
<li><a href="#MN_INIT">MN_INIT</a> -- initialize margin notes
<li><a href="#MN">MN</a> -- start and end a margin note
</ul>
<li><a href="refer.html#TOP">Bibliographies and references</a>
<ul>
<li><a href="refer.html#REF">REF</a>
<li><a href="refer.html#ENDNOTE_REFS">ENDNOTE_REFS</a>
<li><a href="refer.html#FOOTNOTE_REFS">FOOTNOTE_REFS</a>
<li><a href="refer.html#BRACKET_REFS">Embedded references</a>
<li><a href="refer.html#BIBLIOGRAPHY">BIBLIOGRAPHY</a>
<li><a href="refer.html#BIBLIOGRAPHY_TYPE">BIBLIOGRAPHY_TYPE</a>
</ul>
<li><a href="#BLANK_PAGE_TITLE">Blank pages</a>
<li><a href="#TOC_INTRO">Table of contents</a>
<ul>
<li><a href="#TOC">TOC</a>
<li><a href="#TOC_CONTROL">Table of contents control</a>
</ul>
<li><a href="#FINIS_INTRO">Document termination</a>
<ul>
<li><a href="#FINIS">FINIS (Document termination)</a>
</ul>
<ul>
<li><a href="#FINIS_STRING">Changing the FINIS string</a>
<li><a href="#FINIS_COLOR">Changing the FINIS colour</a>
</ul>
</ul>
<hr>
<!====================================================================>
<a name="EPIGRAPH_INTRO"><h2><u>Epigraphs</u></h2></a>
<ul>
<li><a href="#EPIGRAPH">Tag: EPIGRAPH</a>
<li><a href="#EPIGRAPH_CONTROL">Epigraph control macros</a>
</ul>
<p>
<a href="definitions.html#TERMS_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>
By default, <strong>mom</strong> sets epigraphs centred and
<a href="definitions.html#TERMS_NOFILL">unfilled</a>;
this lets you input them on a line for line basis. This behaviour
can be changed to accomodate
<a href="definitions.html#TERMS_FILLED">filled</a>
epigraph "blocks."
<p>
<!---EPIGRAPH--->
<hr width="66%" align="left">
<p>
<a name="EPIGRAPH">
<nobr>Macro: <strong>EPIGRAPH</strong> <toggle> | [ BLOCK ]</a></nobr>
</a>
<p>
<strong>EPIGRAPH</strong> is a toggle, used like this:
<p>
<pre>
.EPIGRAPH
<text of epigraph>
.EPIGRAPH OFF
</pre>
<strong>OFF</strong>, above, could be anything -- say, Q or X --
since any argument other than <strong>BLOCK</strong> turns it off.
<p>
If given the argument <strong>BLOCK</strong>, <strong>EPIGRAPH</strong>
sets epigraphs
<a href="definitions.html#TERMS_FILLED">filled</a>,
justified or quadded in the same direction as paragraphs, indented
equally from both the left and right margins.
<p>
If a block-style epigraph runs to more than one paragraph (unlikely,
but conceivable), you <strong>MUST</strong> introduce every paragraph
-- <u>INCLUDING THE FIRST!!!</u> -- with the
<a href="#PP">PP</a>
tag.
<p>
<strong>NOTE:</strong> <strong>EPIGRAPH</strong> should only be
used at the top of a document (i.e. just after
<a href="docprocessing.html#START">START</a>)
or after
<a href="#HEAD_INTRO">heads</a>. 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>
<a name="EPIGRAPH_CONTROL"><h3><u>Epigraph control macros</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.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_QUAD default = same as paragraphs
.EPIGRAPH_INDENT* default = para indent x 3 (for typeset), x 2 (for typewrite)
*Indent here refers to the indent from both the left and right margins
that centres the block style epigraph on the page.
</pre>
<hr>
<!====================================================================>
<a name="PP_INTRO"><h2><u>Paragraphs</u></h2></a>
<ul>
<li><a href="#PP">Tag: PP</a>
<li><a href="#PP_CONTROL">Paragraph control macros</a>
</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
<strong>PP</strong>. No arguments, nothing. Just <kbd>.PP</kbd>
on a line by itself any time, in any document element, tells
<strong>mom</strong> 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>
By default, <strong>mom</strong> does not indent the first paragraph
of a document, nor paragraphs that fall immediately after
<a href="#HEAD_INTRO">heads</a>
or
<a href="#SUBHEAD_INTRO">subheads</a>.
The first paragraphs of blockquotes and block-style epigraphs are
also not indented. This behaviour can be changed with the control
macro
<a href="#PARA_INDENT_FIRST">INDENT_FIRST_PARAS</a>.
<p>
In contrast to some other macro packages, <strong>mom</strong> does not
deposit a blank line between paragraphs. If you want her to do so, use
the control macro <strong>PARA_SPACE</strong>. (I don't recommend
using this macro with
<a href="typesetting.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.)
<p>
Note that <strong>mom</strong> does not provide "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>
<strong>TIP:</strong> The last thing you want while you're writing
and editing drafts of a document (particularly stories and chapters)
is a text file cluttered up with <strong>PP</strong>'s. The visual
interruption in the flow of text is a serious obstacle to creativity
and critiquing.
<p>
I use the tab key on my keyboard to indent paragraphs when I'm writing,
producing a text file that looks pretty much like what you see on
a printed page. When it comes time to format and print the file,
I run it through a sed script that (amongst other things) converts
the character generated by the tab key (<kbd>^I</kbd>) into <code>.PP</code>
(plus a new line), and pipe the output to groff for processing and
printing.
<p>
Another solution is to insert a blank line between paragraphs.
The blank lines can then be sedded out at print time as above, or,
more conveniently, you can use the <code>.blm</code>
<a href="definitions.html#TERMS_PRIMITIVES">primitive</a>
(blank line macro) to instruct groff (and <strong>mom</strong>)
that blank lines should be interpreted as <strong>PP</strong>'s.
<p>
<pre>
.blm PP
</pre>
tells groff that all blank lines are really the macro <strong>PP</strong>.
<p>
<!---PP--->
<hr width="66%" align="left">
<p>
<a name="PP">
Macro: <strong>PP</strong>
</a>
<p>
<strong>PP</strong> (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 <strong>PP</strong> in
<a href="#EPIGRAPH_INTRO">epigraphs</a>,
<a href="#BLOCKQUOTE_INTRO">blockquotes</a>
and
<a href="#FOOTNOTE_INTRO">footnotes</a>.
<a name="PP_CONTROL"><h3><u>Paragraph control macros</u></h3></a>
<p>
The <strong>PP</strong> 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.
<p>
<ol>
<li><a href="#PP_FAMILY">Family control</a>
<li><a href="#PP_FONT">Font control</a>
<li><a href="#PP_COLOR">Paragraph colour</a>
<li><a href="#PP_LEADING">Leading/linespacing control</a>
<li><a href="#PP_JUST_QUAD">Justification/quad control</a>
<li><a href="#PARA_INDENT">First-line indent control</a>
<li><a href="#PARA_INDENT_FIRST">Initial paragraphs indent control</a>
<li><a href="#PP_SPACE">Paragraph spacing control</a>
</ol>
<a name="PP_FAMILY"><h3><u>1. Family</u></h3></a>
<p>
The paragraph
<a href="definitions.html#TERMS_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>
If you wish to change the family for regular
text paragraphs only, invoke <strong>FAMILY</strong> immediately
after <strong>PP</strong> in EVERY paragraph whose family you wish
to differ from the prevailing document family.
<p>
<strong>Mom</strong>'s default paragraph (and document) family
is Times Roman.
<p>
<a name="PP_FONT"><h3><u>2. Font -- PP_FONT</u></h3></a>
<p>
To change the
<a href="definitions.html#TERMS_FONT">font</a>
used in regular text paragraphs, use <code>.PP_FONT</code>,
which takes the same argument as
<a href="typesetting.html#FONT">FT</a>.
<strong>PP_FONT</strong> 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>
and
<a href="#FOOTNOTE_INTRO">footnotes</a>
remain at their default setting (medium roman) unless you change them
with the appropriate control macros.
<p>
<strong>Mom</strong>'s default paragraph font is medium roman.
<p>
<a name="PP_COLOR"><h3><u>3. Paragraph colour</u></h3></a>
<p>
<strong>Mom</strong> has no special control macro for colourizing
paragraphs. If you wish a colourized paragraph, you must use the
macro,
<a href="color.html#COLOR">COLOR</a>,
or the
<a href="definitions.html#TERMS_INLINE">inline escape</a>,
<a href="color.html#COLOR_INLINE">\*[<colorname>]</a>,
<em>after</em> <strong>.PP</strong>. 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>
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>
For example, assuming you have defined the colour, blue,
<p>
<pre>
.PP
.COLOR blue
<first paragraph>
.HEAD "Monty Python"
.SUBHEAD "The Origins of Spam"
.PP
<second paragraph>
</pre>
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>
The one document element that is affected by changing the colour
of paragraphs are
<a href="#PARAHEAD">paraheads</a>,
since they are attached directly to the body of paragraphs. In
other words, if you change the colour of a paragraph and do not
reset the paragraph colour back to its default, subsequent paraheads
will appear in the same colour as your paragraphs unless you have
explicitly told <strong>mom</strong> you want a pre-defined (or
"initialized") color (usually black) for your paraheads.
<p>
See the footnote to
<a href="#PARAHEAD_COLOR">.PARAHEAD_COLOR</a>.
<a name="PP_LEADING"><h3><u>4. Leading</u></h3></a>
<p>
The paragraph
<a href="definitions.html#TERMS_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#TERMS_HEADER">headers</a>
and
<a href="definitions.html#TERMS_FOOTER">footers</a>).
<p>
If you wish to change the leading of regular text paragraphs only,
invoke <strong>LS</strong> immediately after <strong>PP</strong> in
EVERY paragraph whose leading you wish to change.
<p>
<strong>HYPER-IMPORTANT NOTE:</strong> It is extremely unwise to change
paragraph leading with <strong>LS</strong>, as it will, in all cases,
screw up <strong>mom</strong>'s ability to balance the bottom margin
of pages. Should you absolutely need to change paragraph leading
with <strong>LS</strong>, and subsequently want <strong>mom</strong>
to get back on the right leading track, use the
<a href="docprocessing.html#SHIM">SHIM</a>
macro.
<p>
<strong>Mom</strong>'s default paragraph leading (document leading)
is 16 points, adjusted to fill the page.
<p>
<a name="PP_JUST_QUAD"><h3><u>5. Justification/quad</u></h3></a>
<p>
The justification/quad-direction of regular text paragraphs (i.e.
<a href="definitions.html#TERMS_JUST">justified</a>,
or
<a href="definitions.html#TERMS_FILLED">filled</a>
and
<a href="definitions.html#TERMS_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>
Please note that either method of setting the paragraph
justification/quad-direction also affects
<a href="#EPIGRAPH_INTRO">epigraphs</a>
and
<a href="#FOOTNOTE_INTRO">footnotes</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>
If you wish to change the justification/quad-direction of
individual paragraphs, use <strong>JUSTIFY</strong> or
<strong>QUAD</strong> immediately after <strong>PP</strong>.
Only the paragraph in question gets justified or quadded
differently; subsequent paragraphs remain unaffected.
<p>
<strong>Mom</strong>'s default justification/quad-direction for
paragraphs is
<br>
<ul>
<li>justified, for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
<li>quad left, for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>
</ul>
<p>
<a name="PARA_INDENT"><h3><u>6. First-line indent -- PARA_INDENT</u></h3></a>
<p>
The first-line indent of paragraphs is controlled by
<strong>PARA_INDENT</strong>, which takes one argument: the size
of the indent. <strong>PARA_INDENT</strong> may be used before
or after
<a href="docprocessing.html#START">START</a>.
A
<a href="definitions.html#TERMS_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#TERMS_EM">ems</a>, do
<p>
<pre>
.PARA_INDENT 4.5m
</pre>
In addition to establishing the basic first line-indent of
paragraphs, <strong>PARA_INDENT</strong> 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 <strong>PARA_INDENT</strong>. Furthermore, the
first-line indent of paragraphs within these document elements (as well
as footnotes) is also relative to <strong>PARA_INDENT</strong> (always
1/2 of <strong>PARA_INDENT)</strong>), hence they are also affected.
<p>
<strong>Mom</strong>'s default <strong>PARA_INDENT</strong> is 2
ems for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
and 3 picas (1/2 inch) for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>.
<p>
<a name="PARA_INDENT_FIRST"><h3><u>7. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a>
<p>
By default, <strong>mom</strong> does not indent the first paragraph
of a document, nor the first paragraph after a head or
subhead, nor the first paragraphs of
<a href="#EPIGRAPH_INTRO">epigraphs</a>,
<a href="#BLOCKQUOTE_INTRO">blockquotes</a>
or
<a href="#FOOTNOTE_INTRO">footnotes</a>
that run to more than one paragraph.
<a name="INDENT_FIRST_PARAS"></a>
<p>
If you wish to have first paragraphs indented, invoke the macro
<strong>.INDENT_FIRST_PARAS</strong> with no argument, either
before or after
<a href="docprocessing.html#START">START</a>.
<strong>INDENT_FIRST_PARAS</strong> is a toggle macro, therefore
passing it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels
its effect, meaning that first paragraphs will once again NOT be
indented.
<p>
<a name="PP_SPACE"><h3><u>8. Spacing paragraphs -- PARA_SPACE</u></h3></a>
<p>
By default, <strong>mom</strong> does not insert a blank line
between paragraphs. If you would like her to do so, invoke the
macro <code>.PARA_SPACE</code> with no argument, either
before or after
<a href="docprocessing.html#START">START</a>.
<strong>PARA_SPACE</strong> is a toggle macro, therefore passing
it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels its
effect, meaning that paragraphs will once again NOT be separated by
a blank line.
<p>
<strong>NOTE:</strong> If <strong>PARA_SPACE</strong> is on,
<strong>mom</strong> spaces only those paragraphs that come after
an "initial" paragraph. Initial paragraphs are those
that come immediately after the
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
<a href="#EPIGRAPH_INTRO">epigraphs</a>,
<a href="#HEAD_INTRO">heads</a>,
<a href="#SUBHEAD_INTRO">subheads</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>
Sometimes, you can be fairly deep into a document before using
<strong>.PP</strong> for the first time, and when you do, because
<strong>mom</strong> 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
<strong>.PP</strong> <em>twice</em> (in succession) at the point you
expect the blank line to appear.
<br>
<hr>
<!====================================================================>
<a name="HEAD_INTRO"><h2><u>Main heads</u></h2></a>
<ul>
<li><a href="#HEAD">Tag: HEAD</a>
<li><a href="#HEAD_CONTROL">Head control macros</a>
</ul>
<p>
Main heads -- or, in this documentation, just "heads"
-- should be used any place you want titles to introduce major
sections of a document. If you wish, <strong>mom</strong> can number
your heads for you. Head numbers can also be included
hierarchically in numbered
<a href="#SUBHEAD_INTRO">subheads</a>
and
<a href="#PARAHEAD_INTRO">paraheads</a>.
<p>
By default, heads are centred on the page, underlined,
all in caps. A double linespace precedes each head. In <a
href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, heads
are bold, slightly larger than paragraph text.
<p>
If these defaults don't suit you, you can change them with the
head control macros.
<p>
<!---HEAD--->
<hr width="66%" align="left">
<p>
<a name="HEAD">
<nobr>Macro: <strong>HEAD</strong> "<text of head>" [ "<2nd line>" [ "<3rd line>" ... ] ]</nobr>
</a>
<p>
The argument to <strong>HEAD</strong> is the text of the head,
surrounded by double-quotes. If you need additional lines for a
head, simply surround each line with double-quotes.
<p>
<strong>NOTE:</strong> If a head falls near the bottom of an output page
and <strong>mom</strong> is unable to fit the head <em>plus at least
one line of text underneath it</em>, she will set the head at the
top of the next page.
<p>
<strong>ADDITIONAL NOTE:</strong> If an
<a href="definitions.html#TERMS_INPUTLINE">input line</a>
in a head (i.e. one of the lines surrounded by double-quotes) has
to be broken by <strong>mom</strong> in order to fit the current
line-length (say, a narrow column measure), the head underline
(underscore) will not behave. You'll recognize the problem as soon
as you preview your document. If you encounter a head that
misbehaves with respect to underlining, the solution is to
supply each line <em>as you want it</em> as a separate argument
(surrounded by double-quotes) to the <strong>HEAD</strong> macro.
<p>
For example, if <strong>mom</strong> breaks
<pre>
.HEAD "This is a very, very, very long head"
</pre>
into
<pre>
This is a very, very, very
long head
</pre>
you'll see the misbehaving underscore and should change the
argument to <strong>HEAD</strong> to
<pre>
.HEAD "This is a very, very very" "long head"
</pre>
<a name="HEAD_CONTROL"><h3><u>Head control macros</u></h3></a>
<p>
There are, in addition to the usual family/font/size/quad control
macros, a number of macros to manage head numbering, spacing,
underlining, and so on. Check them out if you're unhappy with
<strong>mom</strong>'s defaults.
<p>
<ol>
<li><a href="#HEAD_GENERAL">Family/font/size/colour/quad</a>
<li><a href="#HEAD_CAPS">Caps</a>
<li><a href="#HEAD_SPACE">Pre-head space</a>
<li><a href="#HEAD_UNDERLINE">Underlining</a>
<li><a href="#NUMBER_HEADS">Numbering</a>
<li><a href="#RESET_HEAD_NUMBER">Reset head numbering</a>
<li><a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>
</ol>
<p>
<a name="HEAD_GENERAL"><h3><u>1. Family/font/size/colour/quad</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.HEAD_FAMILY default = prevailing document family; default is Times Roman
.HEAD_FONT default = bold
.HEAD_SIZE default = +1 (point)
.HEAD_COLOR default = black
.HEAD_QUAD default = CENTER
</pre>
<a name="HEAD_CAPS"><h3><u>2. Capitalizing heads -- HEAD_CAPS</u></h3></a>
<p>
By default, <strong>mom</strong> sets heads in caps, regardless
of the
<a href="definitions.html#TERMS_STRINGARGUMENT">string(s)</a>
you give to
<a href="#HEAD">HEAD</a>.
To change this behaviour, do
<p>
<pre>
.HEAD_CAPS OFF
</pre>
<strong>HEAD_CAPS</strong> is a toggle macro, therefore you can use
any argument you like instead of <strong>OFF</strong> (<strong>END,
QUIT, Q, X</strong>...). To turn <strong>HEAD_CAPS</strong> back on,
simply invoke it without an argument.
<p>
<a name="HEAD_SPACE"><h3><u>3. Space before heads -- HEAD_SPACE</u></h3></a>
<p>
By default, <strong>mom</strong> deposits 2 blank lines prior to every
head. If you'd prefer just a single blank line, do
<p>
<pre>
.HEAD_SPACE OFF
</pre>
<strong>HEAD_SPACE</strong> is a toggle macro, therefore you can use
any argument you like instead of <strong>OFF</strong> (<strong>END,
QUIT, Q, X</strong>...). To restore the space before heads to 2
blank lines, invoke <strong>HEAD_SPACE</strong> without an argument.
<p>
<a name="HEAD_UNDERLINE"><h3><u>4. Underlining heads -- HEAD_UNDERLINE</u></h3></a>
<p>
By default, <strong>mom</strong> underlines heads. To change this
behaviour, do
<p>
<pre>
.HEAD_UNDERLINE OFF
</pre>
<strong>HEAD_UNDERLINE</strong> is a toggle macro, therefore you can
use any argument you like instead of <strong>OFF</strong> (<strong>END,
QUIT, Q, X</strong>...). To restore underlining of heads, invoke
<strong>HEAD_UNDERLINE</strong> without an argument.
<p>
<a name="NUMBER_HEADS"><h3><u>5. Number heads -- NUMBER_HEADS</u></h3></a>
<p>
If you'd like your heads numbered, simply invoke
<strong>NUMBER_HEADS</strong> with no argument. <strong>Mom</strong>
will number all subsequent heads automatically (in ascending order,
naturally).
<p>
If, in addition to numbering heads, you also request that
<a href="#SUBHEAD_INTRO">subheads</a>
and/or
<a href="#PARAHEAD_INTRO">paraheads</a>
be numbered, the head number will be included in their numbers
(each number separated by a period [dot]).
<p>
Should you wish to stop head numbering, invoke
<strong>NUMBER_HEADS</strong> with any argument (<strong>OFF, QUIT,
END, X</strong>...). Head numbering will cease, and the head number
will not be included in the numbering of subheads and/or paraheads.
<p>
<a name="RESET_HEAD_NUMBER"><h3><u>6. Reset head numbering -- RESET_HEAD_NUMBER</u></h3></a>
<p>
Should you wish to reset the head number to "1", invoke
<strong>RESET_HEAD_NUMBER</strong> with no argument. If, for some
reason, you want <strong>mom</strong> to use a head number that is not
the next in ascending order (i.e. the last head number + 1), invoke
<strong>RESET_HEAD_NUMBER</strong> with the number you want, e.g.
<p>
<pre>
.RESET_HEAD_NUMBER 6
</pre>
Your next head will be numbered "6" and subsequent heads will
be numbered in ascending order from "6".
<p>
<a name="HEAD_INLINES"><h3><u>7. Vertical inline escapes inside heads</u></h3></a>
<p>
If you need to adjust the
<a href="definitions.html#TERMS_BASELINE">baseline</a>
position of a head (e.g. the head falls at the top of a column and
you want its
<a href="definitions.html#TERMS_ASCENDER">ascenders</a>
to line up with the ascenders of
<a href="definitions.html#TERMS_RUNNING">running text</a>
in other columns), you can embed a vertical motion
<a href="definitions.html#TERMS_INLINES">inline escape</a>
(either
<a href="inlines.html#INLINE_VERTICAL_MOM">mom</a>'s
or
<a href="inlines.html#INLINE_VERTICAL_GROFF">groff</a>'s
in the string(s) you pass to <strong>HEAD</strong>
<p>
For example,
<p>
<pre>
.HEAD "\[ALD3]Text of head"
or
.HEAD "\[DOWN 3p]Text of head"
</pre>
will lower the baseline of the head by three points. Note that
there's no need to reverse the sense of the inline escape.
<p>
In the case of heads that run to more than one line, you must embed
the escape in the string for each line, like this:
<p>
<pre>
.HEAD "\[ALD3]First line" "\[ALD3]Next line"
or
.HEAD "\[DOWN 3p]First line" "\[DOWN 3p]Next line"
</pre>
<hr>
<!====================================================================>
<a name="SUBHEAD_INTRO"><h2><u>Subheads</u></h2></a>
<ul>
<li><a href="#SUBHEAD">Tag: SUBHEAD</a>
<li><a href="#SUBHEAD_CONTROL">Subhead control macros</a>
</ul>
<p>
Subheads should be used any place you want titles to introduce
sections of a document below heads. If you wish, <strong>mom</strong>
can number subheads for you. Subhead numbers can also be included
hierarchically in numbered
<a href="#PARAHEAD_INTRO">paraheads</a>.
<p>
By default, subheads are flush left. In
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
they are set bold, slightly larger than paragraph text. In
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
they are underlined. A single linespace precedes them in both
printstyles, and a tiny space adjustment raises them slightly
above text that comes afterwards for greater clarity in
document structuring.
<p>
If these defaults don't suit you, you can change them with the
subhead control macros.
<p>
<!---SUBHEAD--->
<hr width="66%" align="left">
<p>
<a name="SUBHEAD">
<nobr>Macro: <strong>SUBHEAD</strong> "<text of subhead>" [ "<2nd line>" [ "<3rd line>" ... ] ]</nobr>
</a>
<p>
The argument to <strong>SUBHEAD</strong> is the text of the subhead,
surrounded by double-quotes. If you need additional lines for a
subhead, simply surround each line with double-quotes.
<p>
<strong>NOTE:</strong> If a subhead falls near the bottom of an output
page and <strong>mom</strong> is unable to fit the head <em>plus at
least one line of text underneath it</em>, she will set the subhead
at the top of the next page.
<a name="SUBHEAD_CONTROL"><h3><u>Subhead control macros</u></h3></a>
<p>
In addition to the usual family/font/size/quad control
macros, there are macros to manage subhead numbering.
<p>
<ol>
<li><a href="#SUBHEAD_GENERAL">Family/font/size/colour/quad</a>
<li><a href="#NUMBER_SUBHEADS">Numbering</a>
<li><a href="#RESET_SUBHEAD_NUMBER">Reset subhead numbering</a>
<li><a href="#SUBHEAD_INLINES">Vertical inline escapes inside subheads</a>
</ol>
<p>
<a name="SUBHEAD_GENERAL"><h3><u>1. Family/font/size/quad</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.SUBHEAD_FAMILY default = prevailing document family; default is Times Roman
.SUBHEAD_FONT default = bold
.SUBHEAD_SIZE default = +.5 (point)
.SUBHEAD_COLOR default = black
.SUBHEAD_QUAD default = LEFT
</pre>
<a name="NUMBER_SUBHEADS"><h3><u>2. Number subheads -- NUMBER_SUBHEADS</u></h3></a>
<p>
If you'd like your subheads numbered, simply invoke
<strong>.NUMBER_SUBHEADS</strong> with no argument.
<strong>Mom</strong> will number all subsequent subheads automatically
(in ascending order, naturally).
<p>
If, in addition to numbering subheads, you also request that
<a href="#HEAD_INTRO">heads</a>
be numbered, the head number will be included in the subhead number
(separated by a period [dot]).
<p>
Should you wish to stop subhead numbering, invoke
<strong>NUMBER_SUBHEADS</strong> with any argument (<strong>OFF, QUIT,
END, X</strong>...). Subhead numbering will cease, and the subhead
number will not be included in the numbering of paraheads.
<p>
<a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a>
<p>
Should you wish to reset the subhead number to "1", invoke
<strong>RESET_SUBHEAD_NUMBER</strong> with no argument. If, for some
reason, you want <strong>mom</strong> to use a subhead number that is not
the next in ascending order (i.e. the last subhead number + 1), invoke
<strong>RESET_SUBHEAD_NUMBER</strong> with the number you want, e.g.
<p>
<pre>
.RESET_SUBHEAD_NUMBER 4
</pre>
Your next subhead will be numbered "4" and subsequent
subheads will be numbered in ascending order from "4".
<a name="SUBHEAD_INLINES"><h3><u>Vertical inline escapes inside subheads</u></h3></a>
See
<a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>.
The information there applies equally to subheads.
<p>
<hr>
<!====================================================================>
<a name="PARAHEAD_INTRO"><h2><u>Paragraph heads</u></h2></a>
<ul>
<li><a href="#PARAHEAD">Tag: PARAHEAD</a>
<li><a href="#PARAHEAD_CONTROL">Parahead control macros</a>
</ul>
<p>
Paragraph heads (paraheads) should be used any place you want titles
to introduce paragraphs below heads or subheads. If you wish,
<strong>mom</strong> can number paraheads for you.
<p>
By default, paraheads are joined to the body of a paragraph,
slightly indented (provided the paragraph is not a
"first" paragraph as defined in
<a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>).
In
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
they are set bold italic, slightly larger than paragraph text. In
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
they are underlined.
<p>
If these defaults don't suit you, you can change them with the
parahead control macros.
<p>
<!---PARAHEAD--->
<hr width="66%" align="left">
<p>
<a name="PARAHEAD">
<nobr>Macro: <strong>PARAHEAD</strong> "<text of parahead>"</nobr>
</a>
<p>
<strong>PARAHEAD</strong> must come AFTER
<a href="#PP">PP</a>
or it will not work!
<p>
The argument is the text of the parahead, surrounded by double-quotes.
Because paraheads are joined to the body of a paragraph, they accept
only one argument (see
<a href="#HEAD">HEAD</a>
and
<a href="#SUBHEAD">SUBHEAD</a>).
<p>
<a name="PARAHEAD_CONTROL"><h3><u>Parahead control macros</u></h3></a>
<p>
In addition to the family/font/size/colour/indent control macros,
there are macros to manage parahead numbering.
<p>
<ol>
<li><a href="#PARAHEAD_GENERAL">Family/font/size/color</a>
<li><a href="#PARAHEAD_INDENT">Indent</a>
<li><a href="#NUMBER_PARAHEADS">Numbering</a>
<li><a href="#RESET_PARAHEAD_NUMBER">Reset parahead numbering</a>
</ol>
<p>
<a name="PARAHEAD_GENERAL"><h3><u>1. Family/font/size/colour</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.PARAHEAD_FAMILY default = prevailing document family; default is Times Roman
.PARAHEAD_FONT default = bold italic
.PARAHEAD_SIZE default = +.5 (point)
<a name="PARAHEAD_COLOR">.PARAHEAD_COLOR default = black*</a>
*If you colourize paragraph text, paraheads will appear in the same
colour as the text unless you explicitly tell mom to colour them
otherwise by invoking .PARAHEAD_COLOR. If you do want paraheads
that are coloured the same as paragraph text, it's generally a good
idea to invoke .PARAHEAD_COLOR anyway (with the same colour used
for paragraph text), just to let mom know.
</pre>
<a name="PARAHEAD_INDENT"><h3><u>2. Indent</u></h3></a>
<p>
Unlike other control macros that end in
<a href="#CONTROL_INDENTS"><strong>_INDENT</strong></a>,
the argument to the macro that controls indenting of paragraph heads
(<strong>PARAHEAD_INDENT</strong>) is NOT relative to the first-line
indent of normal paragraphs. In other words, it takes an absolute
value, and requires a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
For example, to set the paragraph head indent to 2-1/2 picas, you
do:
<p>
<pre>
.PARAHEAD_INDENT 2.5P
</pre>
<strong>Mom</strong>'s default indent for paragraph heads is 1/2
the first-line indent of normal paragraphs (both printstyles).
However, as stated above, if you choose to change the indent, you
must give an absolute value (unless you're a groff expert and want
to manipulate the number register <code>\n[#PP_INDENT]u</code>
arithmetically as the argument to <strong>PARAHEAD_INDENT</strong>
for an indent that's relative to <strong>PP_INDENT</strong>.)
<p>
<strong>NOTE:</strong> Paragraph heads in "first
paragraphs", as defined in
<a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>,
are not indented unless you turn
<a href="#INDENT_FIRST_PARAS">INDENT_FIRST_PARAS</a>
on.
<p>
<a name="NUMBER_PARAHEADS"><h3><u>3. Number paraheads -- NUMBER_PARAHEADS</u></h3></a>
<p>
If you'd like your paraheads numbered, simply invoke
<strong>.NUMBER_PARAHEADS</strong> with no argument.
<strong>Mom</strong> will number all subsequent paraheads automatically
(in ascending order, naturally).
<p>
If, in addition to numbering paraheads, you also request that
<a href="#HEAD_INTRO">heads</a>
and
<a href="#SUBHEAD_INTRO">subheads</a>
be numbered, the head and/or subhead number will be included in the
parahead number (separated by a period [dot]).
<p>
Should you wish to stop parahead numbering, invoke
<strong>NUMBER_PARAHEADS</strong> with any argument (<strong>OFF,
QUIT, END, X</strong>...). Parahead numbering will cease.
<p>
<a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a>
<p>
Should you wish to reset the parahead number to "1", invoke
<strong>RESET_PARAHEAD_NUMBER</strong> with no argument. If, for some
reason, you want <strong>mom</strong> to use a parahead number that is not
the next in ascending order (i.e. the last parahead number + 1), invoke
<strong>RESET_PARAHEAD_NUMBER</strong> with the number you want, e.g.
<p>
<pre>
.RESET_PARAHEAD_NUMBER 7
</pre>
Your next parahead will be numbered "7" and subsequent
paraheads will be numbered in ascending order from "7".
<p>
<hr>
<!====================================================================>
<a name="LINEBREAK_INTRO"><h2><u>Author linebreaks</u></h2></a>
<ul>
<li><a href="#LINEBREAK">Tag: LINEBREAK</a>
<li><a href="#LINEBREAK_CHAR">Linebreak character control macro</a>
</ul>
<p>
By default, <strong>mom</strong> marks
<a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>
with three centred asterisks. You can change this behaviour
with the linebreak character
<a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>.
<p>
<!---LINEBREAK--->
<hr width="66%" align="left">
<p>
<a name="LINEBREAK">
Macro: <strong>LINEBREAK</strong>
</a>
<br>
Alias: <strong>SECTION</strong>
<p>
<strong>LINEBREAK</strong> takes no arguments. Simply invoke it
(on a line by itself, of course) whenever you want to insert an
author linebreak. The appearance of the linebreak is controlled
by the
<a href="#LINEBREAK_CHAR">LINEBREAK_CHAR</a>
macro.
<h3><u>Linebreak character control macro</u></h3>
<p>
<a name="LINEBREAK_CHAR">
<nobr>Macro: <strong>LINEBREAK_CHAR</strong> [ <character> ] [ <iterations> [ <vertical adjustment> ] ]</nobr>
</a>
<br>
Alias: <strong>SECTION_CHAR</strong>
<br>
<em>*The third optional argument requires a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>.
<p>
<strong>LINEBREAK_CHAR</strong> determines what <strong>mom</strong>
prints when <strong>LINEBREAK</strong> 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>
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]). <strong>Mom</strong> sets the character
centred on the current line length. (See "man groff_char"
for a list of all valid groff characters.)
<p>
The second argument is the number of times to repeat the character.
<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#TERMS_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>
If you enter <strong>LINEBREAK_CHAR</strong> with no arguments,
sections of text will be separated by two blank lines when you invoke
<strong>LINEBREAK</strong>.
<p>
<strong>Mom</strong>'s default for <strong>LINEBREAK_CHAR</strong> is
<p>
<pre>
.LINEBREAK_CHAR * 3 -3p
</pre>
i.e. three asterisks, lowered 3 points from their normal vertical
position (for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
the vertical adjustment is -2 points for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>).
<h3><u>Linebreak colour control macro</u></h3>
<p>
<a name="LINEBREAK_COLOR">
<nobr>Macro: <strong>LINEBREAK_COLOR</strong> <color name></nobr>
</a>
<p>
To change the colour of the linebreak character(s), simply invoke
<strong>LINBREAK_COLOR</strong> with the name of a pre-defined (or
"initialized") colour.
<br>
<hr>
<!====================================================================>
<a name="QUOTE_INTRO"><h2><u>Quotes (line for line)</u></h2></a>
<ul>
<li><a href="#QUOTE">Tag: QUOTE</a>
<li><a href="#QUOTE_CONTROL">Quote control macros</a>
</ul>
<p>
<a href="definitions.html#TERMS_QUOTE">Quotes</a>
are always set in
<a href="definitions.html#TERMS_NOFILL">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>
Since <strong>mom</strong> 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 TYPESET)</a>
or underlined
<a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPEWRITE)</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 <strong>QUOTE</strong> serves other
needs, e.g. entering verbatim snippets of programming code, command
line instructions, and so on. (See the
<a href="#QUOTE_TIP">tip</a>
below for suggestions about including programming code snippets in
documents.)
<p>
<a name="QUOTE_SPACING"></a>
Besides indenting quotes, <strong>mom</strong> further sets them
off from
<a href="definitions.html#TERMS_RUNNING">running text</a>
with a small amount of vertical whitespace top and bottom. In
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
this is always one full linespace. In
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
it's 1/2 of the prevailing
<a href="definitions.html#TERMS_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>
<strong>NOTE:</strong> <strong>ALWAYS_FULLSPACE_QUOTES</strong>
applies to both
<a href="#QUOTE">QUOTE</a>
and
<a href="#BLOCKQUOTE">BLOCKQUOTE</a>,
as does the control macro
<a href="#QUOTE_INDENT">QUOTE_INDENT</a>.
<p>
<strong>Version 1.3: mom</strong>'s handling of the
vertical whitespace around quotes has changed slightly. In
versions prior to 1.3, it was not possible to alter the <a
href="definitions.html#TERMS_LEADING">leading</a> of quotes and
blockquotes (which was the same as the document leading), ensuring
that the vertical whitespace remained consistent, as described
above.
<p>
In 1.3 and later, it is possible to change the leading of quotes
and blockquote via the <strong>QUOTE_AUTOLEAD</strong> and
<strong>BLOCKQUOTE_AUTOLEAD</strong> macro. Now, if your quote
(or blockquote) leading differs from the document leading,
<strong>mom</strong> attempts to observe the same rules for vertical
whitespace outlined above; however, she will also insert a small,
flexible amount of extra whitespace around the quotes to make sure
the whitespace is equal, top and bottom. Since she does this on a
quote by quote basis, rather than by figuring out how much extra
whitespace is needed to adjust <em>all</em> quotes on a page,
the spacing around multiple quotes on the same page will differ
slightly, although each will be balanced between lines of normal
<a href="definitions.html#TERMS_RUNNING">running text</a>,
top and bottom. (The inability to scan an entire page and insert
equalized whitespace at marked places is a limitation of groff,
which, by and large, works in a line-per-line fashion.)
<p>
<a name="NO_SHIM"></a>
If you don't want the behaviour described above (i.e.
you don't want <strong>mom</strong> shimming [possibly
irregularly linespaced] quotes or blockquotes), issue the macro
<strong>.NO_SHIM</strong> prior to invoking <strong>QUOTE</strong>
or <strong>BLOCKQUOTE</strong>. If you've disabled shimming of
quotes and blockquotes with <strong>.NO_SHIM</strong> and you want
<strong>mom</strong> to return to her default behaviour in this
matter, invoke <strong>.NO_SHIM OFF</strong> (or <strong>QUIT, END,
X</strong>, etc).
<p>
If you don't provide <strong>mom</strong> with a
<strong>QUOTE_AUTOLEAD</strong>, quotes are leaded at the default
for normal running text, meaning that multiple quotes on the same
page are all spaced identically.
<p>
<a name="QUOTE_TIP"><strong>TIP:</strong></a>
If you want to include snippets of programming code in
<strong>mom</strong> documents, you may come acropper of the fact
that groff (and <strong>mom</strong>'s) escape character is the
backslash. In order for <strong>mom</strong> not to interpret
backslashes that occur in code snippets as escapes, you have to
tell <strong>mom</strong> that the backslash character is
(temporarily) no longer the escape character. The easiest way
to do this is to set the escape character to something else for
the duration of the code snippet. You accomplish this with
<strong>ESC_CHAR</strong>, like this:
<p>
<pre>
.ESC_CHAR c
</pre>
where "c", above, is the alternate escape character
(which should be a character that does not appear in the code). To
set the escape character back to the backslash, simply invoke
<strong>.ESC_CHAR</strong> by itself (i.e. with no argument).
<p>
Because <strong>mom</strong>, by default, sets the text after
<strong>.QUOTE</strong> in italic (for <strong>PRINTSTYLE
TYPESET</strong>) or underlined (for <strong>PRINTSTYLE
TYPEWRITE</strong>), you'll want to change that behaviour as
well. Therefore, a recipe for setting verbatim code snippets using
<strong>QUOTE</strong> could be (assuming you want a fixed width
font like Courier):
<p>
<pre>
\# You only need the first two lines before the first invocation
\# of QUOTE. They stay in effect for all subsequent invocations.
\#
.QUOTE_FONT CR \" Set quote font to Courier roman
.UNDERLINE_QUOTES OFF \" Don't underline quotes in TYPEWRITE
.QUOTE
.ESC_CHAR ^ \" Change escape character to ^
<code snippet>
.ESC_CHAR \" Restore escape character to \
.QUOTE OFF
</pre>
<!---QUOTE--->
<hr width="66%" align="left">
<p>
<a name="QUOTE">
<nobr>Macro: <strong>QUOTE</strong> toggle</nobr>
</a>
<p>
<strong>QUOTE</strong> 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 <strong>QUOTE</strong> with any
argument (e.g. OFF, END, X, Q...) to turn it off. Example:
<p>
<pre>
.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
</pre>
<a name="QUOTE_CONTROL"><h3><u>Quote control macros</u></h3></a>
<ol>
<li><a href="#QUOTE_GENERAL">Family/font/size/leading/colour/indent</a>
<li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a>
<li><a href="#UNDERLINE_QUOTES">Underline quotes (typewrite only)</a>
<li><a href="#BREAK_QUOTE">Manually break a footnoted quote that crosses pages/columns</a>
</ol>
<p>
<a name="QUOTE_GENERAL"><h3><u>1. Family/font/size/colour/indent</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.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)
.QUOTE_AUTOLEAD default = none; leading of quotes is the same as paragraphs
.QUOTE_COLOR default = black
<a name="QUOTE_INDENT">.QUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
(note that this macro also sets the indents (left and right)
for blockquotes)
</pre>
<a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
<p>
If you'd like <strong>mom</strong> always to put a full linespace above
and below quotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
with no argument. If you wish to restore <strong>mom</strong>'s
default behaviour regarding the spacing of quotes (see
<a href="#QUOTE_SPACING">above</a>),
invoke the macro with any argument (<strong>OFF, QUIT, END,
X</strong>...)
<p>
<strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
spacing policy for
<a href="#BLOCKQUOTE_INTRO">blockquotes</a>.
<p>
<a name="UNDERLINE_QUOTES"><h3><u>3. Underlining -- UNDERLINE_QUOTES (typewrite only)</u></h3></a>
<p>
By default in
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
<strong>mom</strong> underlines quotes. If you'd rather she didn't,
invoke <strong>.UNDERLINE_QUOTES</strong> with any argument
(<strong>OFF, QUIT, END, X</strong>...) to disable the feature.
Invoke it without an argument to restore <strong>mom</strong>'s
default underlining of quotes.
<p>
If you not only wish that <strong>mom</strong> not underline
quotes, but also that she set them in italic, you must follow each
instance of <strong>QUOTE</strong> with the typesetting macro <a
href="typesetting.html#FONT">FT I</a>.
Furthermore, since <strong>mom</strong> underlines all instances
of italics by default in <strong>PRINTSTYLE TYPEWRITE</strong>,
you must also make sure that <strong>ITALIC_MEANS_ITALIC</strong>
is enabled (see
<a href="docprocessing.html#TYPEWRITE_CONTROL">PRINTSTYLE TYPEWRITE control macros</a>).
<p>
<a name="BREAK_QUOTE"><h3><u>4. Manually break a footnoted quote -- BREAK_QUOTE</u></h3></a>
<p>
<strong>NOTE:</strong> <em>As of version 1.1.9, the macro</em>
<strong>BREAK_QUOTE</strong> <em>has become obsolete (or, at least,
should have become obsolete.) It remains here for backward
compatibility with documents created prior to 1.1.9, and just in
case, despite my efforts to make it obsolete, you still encounter the
problem it's supposed to fix. Should you find yourself having to
use</em> <strong>BREAK_QUOTE</strong> <em>while running</em> <strong>mom</strong>
1.1.9 <em>or higher, please notify me immediately.</em>
<p>
Exceptionally, a quote or blockquote containing a footnote may cross
a page or column. When this happens, the footnote marker may not be
correct for its position relative to other footnotes on the page, and
the footnote itself may appear on the wrong page or at the bottom of
the wrong column. When this happens, study your output to determine
the precise point at which the quote breaks (or at which you want
it to break), and add <code>.BREAK_QUOTE</code> on a line by itself
afterwards. No other intervention is required, and the footnote(s)
will be marked correctly and appear on the correct page.
<p>
<strong>BREAK_QUOTE</strong> may be used with both quotes and
blockquotes, and hence is aliased as <strong>BREAK_BLOCKQUOTE,
BREAK_CITATION</strong> and <strong>BREAK_CITE</strong>.
<p>
<hr>
<!====================================================================>
<a name="BLOCKQUOTE_INTRO"><h2><u>Blockquotes (cited passages)</u></h2></a>
<ul>
<li><a href="#BLOCKQUOTE">Tag: BLOCKQUOTE (aliases: CITE, CITATION)</a>
<li><a href="#BLOCKQUOTE_CONTROL">BLOCKQUOTE control macros</a>
</ul>
<p>
<strong>BLOCKQUOTES</strong> are used to cite passages from another
author's work. So that they stand out well from
<a href="definitions.html#TERMS_RUNNING">running text</a>,
<strong>mom</strong> 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#TERMS_OUTPUTLINE">Output lines</a>
are
<a href="definitions.html#TERMS_FILLED">filled</a>,
and, by default,
<a href="definitions.html#TERMS_QUAD">quadded</a>
left.
<p>
Besides indenting blockquotes, <strong>mom</strong> further sets them
off from running text with a small amount of vertical whitespace top
and bottom. (See
<a href="#QUOTE_SPACING">above</a>
for a complete explanation of how this is managed, and how to control it.
Be sure to read the section <strong>Version 1.3</strong>.)
<p>
<!---BLOCKQUOTE--->
<hr width="66%" align="left">
<p>
<a name="BLOCKQUOTE">
<nobr>Macro: <strong>BLOCKQUOTE</strong> toggle</nobr>
<br>
Aliases: <strong>CITE, CITATION</strong>
</a>
<p>
<strong>BLOCKQUOTE</strong> is a toggle macro. To begin a
cited passage, invoke the tag with no argument, then type in your quote.
When you're finished, invoke <strong>BLOCKQUOTE</strong> with any
argument (e.g. OFF, END, X, Q...) to turn it off. Example:
<p>
<pre>
.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
\(emGeorge W. Bush
.BLOCKQUOTE END
</pre>
If the cited passage runs to more than one paragraph, you MUST
introduce each paragraph -- <em>including the first!</em> --
with
<a href="#PP">PP</a>.
<p>
<strong>NOTE:</strong> The aliases <strong>CITE</strong>
and <strong>CITATION</strong> may be used in place of the
<strong>BLOCKQUOTE</strong> tag, as well as in any of the control
macros that begin with <strong>BLOCKQUOTE_</strong> or end with
<strong>_BLOCKQUOTE</strong>.
<a name="BLOCKQUOTE_CONTROL"><h3><u>Blockquote control macros</u></h3></a>
<ol>
<li><a href="#BLOCKQUOTE_GENERAL">Family/font/size/leading/colour/quad/indent</a>
<li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a>
<li><a href="#BREAK_QUOTE">Manually break a footnoted blockquote that crosses pages/columns</a>
</ol>
<p>
<a name="BLOCKQUOTE_GENERAL"><h3><u>1. Family/font/size/colour/quad/indent</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.BLOCKQUOTE_FAMILY default = prevailing document family; default is Times Roman
.BLOCKQUOTE_FONT default = roman
.BLOCKQUOTE_SIZE default = -1 (point)
.BLOCKQUOTE_AUTOLEAD default = none; leading of blockquotes is the same as paragraphs
.BLOCKQUOTE_COLOR default = black
.BLOCKQUOTE_QUAD default = left
.BLOCKQUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
(note that this macro also sets the left indent for quotes)
</pre>
<a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
<p>
If you'd like <strong>mom</strong> always to put a full linespace above
and below blockquotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
with no argument. If you wish to restore <strong>mom</strong>'s
default behaviour regarding the spacing of blockquotes (see
<a href="#QUOTE_SPACING">above</a>),
invoke the macro with any argument (<strong>OFF, QUIT, END,
X</strong>...).
<p>
<strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
spacing policy for
<a href="#QUOTE_INTRO">quotes</a>.
<p>
<hr>
<!====================================================================>
<a name="LIST_INTRO"><h2><u>Nested lists</u></h2></a>
<ul>
<li><a href="#LIST">Tag: LIST</a>
<li><a href="#ITEM">Tag: ITEM</a>
<li><a href="#LIST_CONTROL">LIST control macros</a>
</ul>
<p>
Lists are points or items of interest or importance that are
separated from
<a href="definitions.html#TERMS_RUNNING">running text</a>
by enumerators. Some typical enumerators are
<a href="definitions.html#TERMS_EM">en-dashes</a>,
<a href="definitions.html#TERMS_BULLET">bullets</a>,
digits and letters.
<p>
Setting lists with <strong>mom</strong> is easy. First, you
initialize a list with the <strong>LIST</strong> macro. Then, for
every item in the list, you invoke the macro, <strong>ITEM</strong>,
followed by the text of the item. When a list is finished, you
exit the list with <strong>LIST OFF</strong> (or
<strong>QUIT</strong>, <strong>END</strong>, <strong>BACK</strong>,
etc.)
<p>
By default <strong>mom</strong> starts each list with the enumerator
flush with the left margin of running text that comes before it,
like this:
<p>
<pre>
My daily schedule needs organizing. 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
</pre>
In other words, <strong>mom</strong> 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, <strong>mom</strong>
does not add any extra space above or below lists.
<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
<strong>LIST OFF</strong> (you may prefer to use <strong>LIST
BACK</strong>) takes you back to the previous depth (or
level) of list, with that list's enumerator and indent intact. The
final <strong>LIST OFF</strong> exits lists completely and returns
you to the left margin of running text.
<p>
Finally, lists can be used in documents created with either the
document processing macros or just the typesetting macros.
<p>
<!---LIST--->
<hr width="66%" align="left">
<p>
<a name="LIST">
<nobr>Macro: <strong>LIST</strong> [ BULLET | DASH | DIGIT | ALPHA | alpha | ROMAN<n> | roman<n> | USER <string>] [ <separator> | <user-defined enumerator> ] [ <prefix> ] [ <off> ]</a></nobr>
<p>
Invoked by itself (i.e. with no argument), <strong>LIST</strong>
initializes a list (with bullets as the default enumerator).
Afterwards, each block of input text preceded by
<a href="#ITEM">.ITEM</a>,
on a line by itself, is treated as a list item.
<p>
<strong>NOTE:</strong> Every time you invoke <strong>LIST</strong>
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 <strong>mom</strong>'s default enumerator,
which is a bullet. Within nested lists, <strong>mom</strong>
stores the enumerator, separator and indent for any list you return
<em>backwards</em> to (i.e. with <strong>LIST OFF</strong>), but
does not store any information for lists you move <em>forward</em>
to.
<br>
<h3><u>The first argument--enumerator style</u></h3>
<p>
The optional arguments <strong>BULLET</strong>,
<strong>DASH</strong>, <strong>DIGIT</strong> (for
Arabic numerals), <strong>ALPHA</strong> (for uppercase
letters), <strong>alpha</strong> (for lowercase letters),
<strong>ROMAN<n></strong> (for uppercase roman numerals),
<strong>roman<n></strong> (for lowercase roman numerals) tell
<strong>mom</strong> what kind of enumerator to use for a given
list.
<p>
The arguments, <strong>ROMAN<n></strong> and
<strong>roman<n></strong>, are special. You must append to
them a digit (arabic, e.g. "1" or "9" or "17") saying how many items
a particular roman-numeralled <strong>LIST</strong> is going to
have. <strong>Mom</strong> requires this information in order to
align roman numerals sensibly, and will abort--with a message--if
you don't provide it.
<p>
A roman-numeralled list containing, say, five items, would be set
up like this:
<p>
<pre>
.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
</pre>
<p>
The argument, <strong>USER</strong>, 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
<strong>=></strong>,
<p>
<pre>
.LIST USER =>
.ITEM
A list item
</pre>
will produce
<p>
<pre>
=> A list item
</pre>
<strong>Please note:</strong> if the argument to
<strong>USER</strong> contains spaces, you must enclose the argument
in double quotes.
<br>
<h3><u>The second argument--separator style</u></h3>
<p>
If you choose <strong>DIGIT</strong>, <strong>ALPHA</strong>,
<strong>alpha</strong>, <strong>ROMAN<n></strong>, or
<strong>roman<n></strong>, you may enter the optional
argument, <strong>separator</strong>, to say what kind of separator
you want after the enumerator. The separator can be anything you
like. The default for <strong>DIGIT</strong> is a period (dot),
like this:
<p>
<pre>
1. A list item
</pre>
The default separator for <strong>ALPHA</strong>,
<strong>alpha</strong>, <strong>ROMAN<n></strong> and
<strong>roman<n></strong> is a right parenthesis, like this:
<p>
<pre>
a) An alpha-ed list item
b) A second alpha-ed list item
or
i) A roman-ed list item
ii) A second roman-ed item
</pre>
If you'd prefer, say, digits with right-parenthesis separators
instead of the default period, you'd do
<p>
<pre>
.LIST DIGIT )
.ITEM
A numberd list item
</pre>
which would produce
<p>
<pre>
1) A numbered list item
</pre>
<strong>Please note: BULLET</strong>, <strong>DASH</strong> and
<strong>USER</strong> do not take a separator.
<br>
<h3><u>The third argument--prefix style</u></h3>
<p>
Additionally, you may give a prefix (i.e. a character that comes
<em>before</em> the enumerator) when your enumerator style for a
particular list is <strong>DIGIT</strong>, <strong>ALPHA</strong>,
<strong>alpha</strong>, <strong>ROMAN<n></strong>
or <strong>roman<n></strong>. In the arguments to
<strong>LIST</strong>, the prefix comes <em>after</em> the
separator, which may seem counter-intuitive, so please be careful.
<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 <strong>DIGIT</strong> list with the numbers enclosed in
parentheses, you'd enter
<p>
<pre>
.LIST DIGIT ) (
.ITEM
The first item on the list.
.ITEM
The second item on the list.
</pre>
which would produce
<p>
<pre>
(1) The first item on the list.
(2) The second item on the list.
</pre>
<strong>Please note: BULLET</strong>, <strong>DASH</strong> and
<strong>USER</strong> do not take a prefix.
<br>
<a name="LIST_EXIT"></a>
<h3><u>Exiting lists--.LIST OFF/BACK or .QUIT_LISTS</u></h3>
<p>
Any single argument to <strong>LIST</strong> other
than <strong>BULLET</strong>, <strong>DASH</strong>,
<strong>DIGIT</strong>, <strong>ALPHA</strong>,
<strong>alpha</strong>, <strong>ROMAN<n></strong>,
<strong>roman<n></strong> or <strong>USER</strong> (e.g.
<strong>LIST</strong> <kbd>OFF</kbd> or <strong>LIST</strong>
<kbd>BACK</kbd>) takes you out of the current list.
<p>
If you are at the first list-level (or "list-depth"),
<strong>mom</strong> returns you to the left margin of running text.
Any indents that were in effect prior to setting the list are fully
restored.
<p>
If you are in a nested list, <strong>mom</strong> moves you
<em>back one list-level</em> (i.e. does not take you out of the
list structure) and restores the enumerator, separator and indent
appropriate to that level.
<p>
Each invocation of <strong>LIST</strong> should be be matched by
a corresponding <strong>LIST OFF</strong> in order to fully exit
lists. For example,
<p>
<pre>
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.
</pre>
is created like this:
<p>
<pre>
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.
</pre>
Alternatively, you may use the single-purpose macro,
<strong>QUIT_LISTS</strong>, 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>
<hr width="33%" align="left">
<p>
<a name="ITEM">
Macro: <strong>ITEM</strong>
<p>
After you've initialized a list with
<a href="#LIST">LIST</a>,
precede each item you want in the list with <strong>ITEM</strong>.
<strong>Mom</strong> takes care of everything else with respect to
setting the item appropriate to the list you're in.
<p>
In document processing, it is valid to have list items that contain
multiple paragraphs. Simply issue a
<a href="#PP">PP</a>
request for each paragraph <em>following</em> the first item.
I.e., don't do this:
<p>
<pre>
.ITEM
.PP
Some text...
.PP
A second paragraph of text
</pre>
but rather
<p>
<pre>
.ITEM
Some text...
.PP
A second paragraph of text
</pre>
<hr width="33%" align="left">
<a name="LIST_CONTROL"><h3><u>List control macros</u></h3></a>
<ol>
<li><a href="#SHIFT_LIST">Indenting lists (SHIFT_LIST)</a>
<li><a href="#RESET_LIST">Resetting an initialized list's enumerator (RESET_LIST)</a>
<li><a href="#PAD_LIST_DIGITS">Padding digit enumerators (PAD_LIST_DIGITS)</a>
</ol>
<a name="SHIFT_LIST"><h3><u>1. Indenting lists -- SHIFT_LIST</u></h3></a>
<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
<strong>SHIFT_LIST</strong> immediately after
<a href="#LIST">LIST</a>.
<strong>SHIFT_LIST</strong> takes just one argument: the amount by
which you want the list shifted to the right. The argument requires
a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
<p>
<strong>SHIFT_LIST</strong> applies <em>only</em> to the list you
just initialized with <strong>LIST</strong>. It does not carry
over from one invocation of <strong>LIST</strong> to the next.
However, the indent remains in effect when you <em>return</em> to a
list level in a nested list.
<p>
For example, if you want a 2-level list, with each list indented to
the right by 18
<a href="definitions.html#TERMS_PICASPOINTS">points</a>,
<p>
<pre>
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.
</pre>
produces (approximately)
<p>
<pre>
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
o List 1 item
o List 1 item
- List 2 item
- List 2 item
o List 1 item
o List 1 item
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
</pre>
<a name="RESET_LIST"><h3><u>2. Resetting an initialized list's enumerator -- RESET_LIST</u></h3></a>
<p>
In nested lists, if your choice of list enumerator for a given
level of list is <strong>DIGIT</strong>, <strong>ALPHA</strong>,
<strong>alpha</strong>, <strong>ROMAN</strong> or
<strong>roman</strong>, you may sometimes want to reset the list's
enumerator when you return to that list. Consider the following:
<p>
<pre>
Things to do religiously each and every day:
1. 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
2. Feed the cat
a) soft food on Mon., Wed. and Fri.
b) dry food on Tues., Thurs. and Sat.
c) canned tuna on Sunday
</pre>
Normally, within a nested list, when you return to an
incrementally-enumerated list, the enumerator continues incrementing
from where it left off. That means, in the example above, the
normal state of affairs for the alpha'ed list under "2. Feed
the cat" would be c), d) and e). The solution, in such a case,
is simply to reset the enumerator --before <strong>ITEM</strong>!--
with the macro, <strong>RESET_LIST</strong>.
<p>
By default, with no argument, <strong>RESET_LIST</strong> resets the
enumerator to 1, A, a, I or i depending on the style of enumerator.
You may, if you wish, pass <strong>RESET_LISTS</strong> a numeric
argument representing the starting enumerator for the reset (if
different from "1"), although I can't at present think of a use for
this feature.
<p>
<a name="PAD_LIST_DIGITS"><h3><u>3. Padding digit enumerators (PAD_LIST_DIGITS)</a></u></h3></a>
<p>
<strong><u>Arabic digits</u></strong>
<p>
When your choice of enumerators is <strong>DIGIT</strong> AND the
number of items in the list exceeds nine (9), you have to make a
design decision: should <strong>mom</strong> leave room for the
extra numeral in two-numeral digits to the right or the left of
the single-numeral digits?
<p>
If you want the extra space to the right, invoke the macro,
<strong>.PAD_LIST_DIGITS</strong> (with no argument), after
<strong>LIST</strong> and before <strong>ITEM</strong>. This will
produce something like
<p>
<pre>
8. List item
9. List item
10. List item
</pre>
If you want the extra space to the left, invoke
<strong>PAD_LIST_DIGITS</strong> with the single argument,
<strong>LEFT</strong>, which will produce
<p>
<pre>
8. List item
9. List item
10. List item
</pre>
Of course, if the number of items in the list is less than ten
(10), there's no need for <strong>PAD_LIST_DIGITS</strong>.
<p>
<strong><u>Roman numerals</u></strong>
<p>
By default, <strong>mom</strong> sets roman numerals in lists flush
left. The <strong><n></strong> argument appended to
<strong>ROMAN<n></strong> or <strong>roman<n></strong>
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>
If you'd like the roman numerals to line up flush right (i.e. be
padded "left"), simply invoke <strong>PAD_LIST_DIGITS</strong>
<kbd>LEFT</kbd> after <strong>LIST</strong> <kbd>ROMAN<n></kbd>
or <strong>LIST</strong> <kbd>roman<n></kbd> and before
<strong>ITEM</strong>.
<p>
<hr>
<!---LINE NUMBERING--->
<a name="NUMBER_LINES_INTRO"><h2><u>Line numbering</u></h2></a>
<ul>
<li><a href="#NUMBER_LINES">Macro: NUMBER_LINES</a>
<li><a href="#NUMBER_LINES_CONTROL">Control macros</a>
<ul>
<li><a href="#NUMBER_LINES_CONTROL_QUOTE">Control macros for quotes and blockquotes</a>
</ul>
</ul>
<p>
<strong>Mom</strong>'s line-numbering capabilities are not as flexible
as most of her other document processing macros. The reason is
that groff's underlying line-numbering
<a href="definitions.html#TERMS_PRIMITIVES">primitive</a>,
<kbd>.nm</kbd>, is, well...primtive. It is not possible, for
example, to set the
<a href="definitions.html#TERMS_GUTTER">gutter</a>
using any
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
other than the
<a href="definitions.html#TERMS_FIGURESPACE">figure space</a>.
<p>
That said, when you turn line-numbering on, <strong>mom</strong>,
by default
<br>
<a name="NUMBER_LINES_DEFAULTS"></a>
<ul>
<li>numbers every line of paragraph text; line-numbering is
suspended for all other document processing tags (like
docheaders, epigraphs, heads, subheads, etc.) and special
pages (covers, endotes, bibliographies, etc.); be aware,
though, that if you turn
<a href="definitions.html#TERMS_DOCHEADER">docheaders</a>
off (with
<a href="docprocessing.html#DOCHEADER">DOCHEADER</a> <strong>OFF</strong>)
and create your own docheader, <strong>mom</strong>
<em>will</em> line-number your custom docheader
<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>separates line numbers from running text by two
<a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>.
</ul>
<p>
Line numbering may be enabled and disabled for
<a href="#QUOTE">QUOTE</a>
and/or
<a href="#BLOCKQUOTE">BLOCKQUOTE</a>
in one of three styles. See
<a href="#NUMBER_LINES_CONTROL_QUOTE">Line numbering control macros for quotes and blockquotes</a>.
<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
<em>next</em>
<a href="definitions.html#TERMS_OUTPUTLINE">output line</a>
to have. Optional arguments 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#TERMS_RUNNING">running text</a>.
<p>
Subsequently, you can turn line-numbering off, either permanently,
or resume it later at a place of your choosing. When you
resume line-numbering, the line numbers pick up where you left off.
<p>
<!---NUMBER_LINES--->
<hr width="66%" align="left">
<p>
<nobr>
<a name="NUMBER_LINES">
<nobr>Macro: <strong>NUMBER_LINES</strong> <start number> [ <which lines to number> [ <gutter> ] ]</nobr>
<br>
<nobr>Macro: <strong>NUMBER_LINES</strong> <anything> | RESUME</nobr>
<br>
</a>
</nobr>
<p>
<strong>NUMBER_LINES</strong> does what it says: prints line
numbers, to the left of
<a href="definitions.html#TERMS_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="#FOOTNOTE_LINENUMBERS">.FOOTNOTE_MARKER_STYLE LINE</a>
for instructions on line-numbered footnotes, and
<a href="#ENDNOTE_MARKER_STYLE">.ENDNOTE_MARKER_STYLE</a>
for instructions on line-numbered endnotes.)
<p>
Every time you invoke <strong>NUMBER_LINES</strong>, unless you are
using the arguments <strong>OFF</strong> (<strong>QUIT</strong>,
<strong>END</strong>, <strong>X</strong>, etc.) or
<strong>RESUME</strong> you must, at a minimum, pass it one
argument, namely the number (digit) you want the <em>next</em>
<a href="definitions.html#TERMS_OUTPUTLINE">output line</a>
to have. For example,
<pre>
.NUMBER_LINES 3
</pre>
will prepend the number, 3, to the next output line.
<p>
Normally, of course, you will number lines of text starting at 1.
All you have to do in that case is ensure that
<pre>
.NUMBER_LINES 1
</pre>
precedes your first line of input text, which will also be the
first line of output text.
<p>
You can alter <strong>mom</strong>'s default line numbering
behaviour (see
<a href="#NUMBER_LINES_DEFAULT">above</a>)
with the optional arguments <strong><which lines to
number></strong> and <strong><gutter></strong>.
<p>
<strong><which lines to number></strong> instructs
<strong>NUMBER_LINES</strong> to number only certain lines, e.g.
every two lines or every five lines. If you want, say, only every
five lines to have a prepended number, you'd do
<pre>
.NUMBER_LINES 1 5
</pre>
<strong>GOTCHA!</strong> The argument to <strong><which
lines to number></strong> only numbers those lines that are
multiples of the argument. Hence, in the above example, line
number "1" will <em>not</em> be numbered, since "1" is not a
multiple of "5".
<p>
If you wanted line number "1" to be numbered, you'd have to invoke
<kbd>.NUMBER_LINES 1 1</kbd> before the first output line, then
study your <em>output</em> copy and determine where best to insert
the following in your <em>input</em> copy:
<pre>
.NUMBER_LINES \n(ln 5
</pre>
(The escape, <kbd>\n(ln</kbd>, ensures that
<strong>NUMBER_LINES</strong> automatically supplies the correct
value for the first argument, <strong><start
number></strong>.)
<p>
Following this recipe, line number 1 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.
<p>
The optional argument, <strong><gutter></strong>, tells
<strong>mom</strong> how much space to put between the line numbers
and the running text.
<p>
<strong>Note</strong>: when giving a value for
<strong><gutter></strong>, you cannot skip the
<strong><which lines to number></strong> argument. Either
fill in the desired value, or use two double-quotes
(<strong>""</strong>) to have <strong>mom</strong> use the value
formerly in effect.
<p>
<strong><gutter></strong> does not require (or even accept) a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
The argument you pass to it is the number of
<a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>
you want between line numbers and running text.
<strong>Mom</strong>'s default gutter is two figure spaces. If
you'd like a wider gutter, say, four figures spaces, you'd do
<pre>
.NUMBER_LINES 1 1 4
|
+-- Notice you *must* supply a value
for the 2nd argument in order to supply
a value for the 3rd.
</pre>
<p>
After you've set up line-numbering, <strong>NUMBER_LINES</strong>
can be used to control line numbering.
<br>
<h3><u>Line-numbering control</u></h3>
<p>
<strong>NUMBER_LINES OFF</strong> (or <strong>END, QUIT, X,</strong> etc.)
turns line-numbering off.
<p>
Sometimes, you merely want to suspend line-numbering. In that case,
turn line numbering off with <strong>NUMBER_LINES OFF</strong>.
Later, when you want it to resume, enter
<pre>
.NUMBER_LINES RESUME
</pre>
Line numbering will resume exactly where it left off. If this is
not what you want--say you want to reset the line number to "1"--simply
invoke <strong>NUMBER_LINES</strong> with whatever arguments
are needed for the desired result.
<p>
<strong>Extra Notes:</strong>
<br>
<ol>
<li>In document processing, you may invoke <strong>NUMBER_LINES</strong>
either before or after <strong>START</strong>.
<strong>Mom</strong> doesn't care.
<li>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 "1" prepended to the first line
(unless, of course, that is not what you want).
<li>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
<strong>NUMBER_LINES</strong> requires this number
as its first argument, in such instances, pass
<strong>NUMBER_LINES</strong> as its first argument the
escape <kbd>\n(ln</kbd>.
<p>
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),
<p>
<kbd> .NUMBER_LINES \n(ln 5 4</kbd>
<p>
would do the trick.
<li>If you're using margin notes in a document, be sure to set
the gutter for margin notes wide enough to allow room for
the line numbers.
<li><strong>Mom</strong> (groff, actually), only numbers lines
<em>to the left of text</em>. 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#TERMS_GUTTER">gutter(s)</a>
between columns is wide enough to leave room for the
numbers.
</ol>
<hr width="33%" align="left">
<a name="NUMBER_LINES_CONTROL"><h3><u>Line numbering control macros</u></h3></a>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.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
</pre>
<a name="NUMBER_LINES_CONTROL_QUOTE"><h3><u>Line numbering control macros for QUOTE and BLOCKQUOTE</u></h3></a>
<ol>
<li><a href="#NUMBER_QUOTE_LINES">NUMBER_QUOTE_LINES</a>
<li><a href="#NUMBER_BLOCKQUOTE_LINES">NUMBER_BLOCKQUOTE_LINES</a>
<li><a href="#NUMBER_LINES_QUOTES">Setting up line numbering in quotes and blockquotes on a case by case basis</a>
</ol>
<a name="NUMBER_QUOTE_LINES"><h3><u>1. NUMBER_QUOTE_LINES</u></h3></a>
<p>
If you'd like <strong>mom</strong> to number lines of output text
in a
<a href="#QUOTE">QUOTE</a>
as part of the same order and sequence as paragraph text, simply
invoke <strong>NUMBER_QUOTE_LINES</strong> by itself.
<p>
There is a catch with numbering quotes, though. Owing to groff's
restriction of accepting only the figure space as the line number
gutter's unit of measure, it is not possible for line numbers
in quotes to hang outside a document's overall left margin and
be reliably flush with the line numbers of paragraph text.
Conseqently, line numbers in quotes hang to the left of the quote,
separated from the quote by the <strong><gutter></strong>
argument.
<p>
If you'd like to change the gutter for quotes line-numbered in
this way, invoke <strong>NUMBER_QUOTE_LINES</strong> with a digit
representing the number of
<a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>
you'd like between the line numbers and the quoted text, like this:
<pre>
.NUMBER_QUOTE_LINES 1
</pre>
With the above, line numbers in quotes (and only quotes) will have
a gutter of 1 figure space.
<p>
If you are using "line numbering style" for footnotes
(<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> <strong>LINE</strong>),
you may not wish to have quotes <em>visibly</em> line-numbered, but
still want to embed footnotes inside quotes. In order to do that,
<strong>mom</strong> allows you to say <strong>NUMBER_QUOTE_LINES
SILENT</strong>.
<p>
When you invoke <strong>NUMBER_QUOTE_LINES</strong>
<kbd>SILENT</kbd>, <strong>mom</strong> continues to increment line
numbers while quotes are being output, but they won't appear in the
output copy. (Compare this with <strong>mom</strong>'s default
behaviour of <em>suspending</em> incrementing of line numbers
during the output of quotes.) This allows you to embed
line-numbered footnotes inside quotes and have the line number
"label" in the footnote come out sensibly.
<p>
Once having turned <strong>NUMBER_QUOTE_LINES</strong> on, you
may disable it with <strong>NUMBER_QUOTE_LINES OFF</strong> (or
<strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>,
etc).
<p>
<a name="NUMBER_BLOCKQUOTE_LINES"><h3><u>2. NUMBER_BLOCKQUOTE_LINES</u></h3></a>
<p>
If you'd like <strong>mom</strong> to number lines of output text
in a
<a href="#QUOTE">BLOCKQUOTE</a>
as part of the same order and sequence as paragraph text, simply
invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong> by itself.
<p>
There is a catch with numbering blockquotes, though. Owing to
groff's restriction of accepting only the figure space as the
line number gutter's unit of measure, it is not possible for line
numbers in blockquotes to hang outside a document's overall left
margin and be reliably flush with the line numbers of paragraph
text. Conseqently, line numbers in blockquotes hang to the
left of the blockquote, separated from the blockquote by the
<strong><gutter></strong> argument.
<p>
If you'd like to change the gutter for blockquotes line-numbered in
this way, invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong> with a digit
representing the number of
<a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>
you'd like between the line numbers and the blockquoted text, like
this:
<pre>
.NUMBER_BLOCKQUOTE_LINES 1
</pre>
With the above, line numbers in blockquotes (and only blockquotes)
will have a gutter of 1 figure space.
<p>
If you are using "line numbering style" for footnotes
(<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> <strong>LINE</strong>),
you may not wish to have blockquotes <em>visibly</em> line-numbered,
but still want to embed footnotes inside blockquotes. In
order to do that, <strong>mom</strong> allows you to say
<strong>NUMBER_BLOCKQUOTE_LINES SILENT</strong>.
<p>
When you invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong>
<kbd>SILENT</kbd>, <strong>mom</strong> continues to increment line
numbers while blockquotes are being output, but they won't appear in
the output copy. (Compare this with <strong>mom</strong>'s default
behaviour of <em>suspending</em> incrementing of line numbers during
the output of blockquotes.) This allows you to embed line-numbered
footnotes inside blockquotes and have the line number "label" in the
footnote come out sensibly.
<p>
Once having turned <strong>NUMBER_BLOCKQUOTE_LINES</strong> on, you
may disable it with <strong>NUMBER_BLOCKQUOTE_LINES OFF</strong> (or
<strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>,
etc).
<p>
<a name="NUMBER_LINES_QUOTES"><h3><u>3. Setting up line numbering in quotes and blockquotes on a case by case basis</u></h3></a>
<p>
Sometimes, you may want quotes or blockquotes to have a different
line numbering scheme from the one used in the rest of the
document. Or, you may want line numbering enabled only inside a
particular quote or blockquote. A common reason for this would be
if you were using the
<a href="#QUOTE">QUOTE</a>
macro to insert lines of programming code into a document. (See
<a href="#QUOTE_TIP">here</a>
for suggestions about including programming code snippets in
documents.)
<p>
To enable line numbering within quotes or blockquotes on a case by
case basis, simply invoke <strong>NUMBER_LINES</strong>, with the
arguments you need, immediately after entering <strong>QUOTE</strong>
or <strong>BLOCKQUOTE</strong>. (<strong>NUMBER_QUOTE_LINES</strong>
and/or <strong>NUMBER_BLOCKQUOTE_LINES</strong> should be turned
off if you're doing this.) The quote or blockquote will then be
line-numbered according to your specifications: the starting line
number of the quote or blockquote will be the one you give as a
first argument to <strong>NUMBER_LINES</strong>; which lines to
number will be the value you pass to <strong><which lines to
number></strong> (defaults to "1"); line numbers will hang
to the left of the quote or blockquote, separated from the quote or
blockquote by <strong><gutter></strong> (defaults to "2").
<p>
As soon as <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong> is
turned off, line numbering ceases, not only with respect to
subsequent paragraph text (if they are not being line-numbered),
but also for any subsequent invocation of <strong>QUOTE</strong> or
<strong>BLOCKQUOTE</strong>. In other words, you must re-enable
quote or blockquote line-numbering inside every instance of
<strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong> when
line-numbering either of them on a case by case basis.
<p>
<hr>
<!====================================================================>
<a name="FOOTNOTE_INTRO"><h2><u>Footnotes</u></h2></a>
<ul>
<li><a href="#FOOTNOTE_BEHAVIOUR">Footnote behaviour</a>
<ul>
<li><a href="#FN_AND_PUNCT">Footnote markers and punctuation in the running text</a>
</ul>
<li><a href="#FOOTNOTE">Tag: FOOTNOTE</a>
<li><a href="#FOOTNOTE_CONTROL">FOOTNOTE control macros</a>
</ul>
<p>
For something so complex behind the scenes, footnotes are easy to use.
You just type, for example
<p>
<a name="FOOTNOTE_EXAMPLE"></a>
<pre>
...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.
</pre>
and be done with it.
<p>
(Note the obligatory use of the <strong>\c</strong>
<a href="definitions.html#TERMS_INLINES">inline escape</a>.
It is required when your
<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a>
is either <strong>STAR</strong> [star/dagger footnotes] or
<strong>NUMBER</strong> [superscript numbers]; it is NOT to be used
when the <strong>FOOTNOTE_MARKER_STYLE</strong> is
<strong>LINE</strong>, or when footnote markers have been disabled
with
<a href="#FOOTNOTE_MARKERS">.FOOTNOTE_MARKERS</a>
<strong>OFF</strong>.)
<p>
<strong>***Version 1.3-d change***</strong>
<p>
As of version 1.3-d, the manner of entering the line
<em>after</em> <strong>.FOOTNOTE OFF</strong> has changed
to accommodate users' differing wishes with respect to
the order of punctuation and footnote markers. Please see
<a href="#FN_AND_PUNCT">Footnote markers and punctuation in the running text</a>
for more information.
<p>
<strong>***End of version 1.3-d change***</strong>
<p>
After you invoke <strong>FOOTNOTE</strong>, <strong>mom</strong>
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="columns.html#COLUMNS">COLUMNS</a>,
<strong>mom</strong> knows what to do, and Does The Right Thing.
<p>
Footnotes can be sly little beasts, though. If you're writing a
document that's footnote-heavy, you might want to read the following.
<p>
<a name="FOOTNOTE_BEHAVIOUR"><h3><u>Footnote behaviour</u></h3></a>
<p>
By default, <strong>mom</strong> 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 <strong>mom</strong> is happy to
oblige.
<p>
A small amount of vertical whitespace and a short horizontal rule
separate footnotes from the document body. The amount of whitespace
varies slightly from page to page depending on the number of lines
in the footnotes. <strong>Mom</strong> 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.
<a name="FOOTNOTE_RULES"></a>
<p>
If <strong>mom</strong> 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.
<strong>FOOTNOTE</strong> 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>
When footnotes occur within cited text, for example a
<a href="#QUOTE">QUOTE</a>
or a
<a href="#BLOCKQUOTE">BLOCKQUOTE</a>,
<strong>mom</strong> 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>
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,
<strong>mom</strong> 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>
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 <strong>mom</strong> 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>
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, <strong>mom</strong> 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">.SPACE</a>
command at the end of the footnote text, before
<strong>FOOTNOTE OFF</strong> (or <strong>FOOTNOTE X, QUIT,
EXIT, etc...</strong>).
<p>
Obviously, deferred footnotes aren't an issue if you request numbered
footnotes that increase incrementally throughout the whole document --
yet another convenience <strong>mom</strong> has thought of.
<p>
While <strong>mom</strong>'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 the page AND that page has some footnotes on it,
<strong>mom</strong> 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, <strong>mom</strong>
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>
<strong>NOTE:</strong> Exceptionally, you may encounter problems with footnotes inside
quotes and blockquotes that cross a page or column. See <a
href="#BREAK_QUOTE">BREAK_QUOTE</a>
for a solution.
<p>
<h3><u><a name="FN_AND_PUNCT">Footnote markers and punctuation in the running text</a></u></h3>
<p>
As of version 1.3-d, the manner of entering the line <em>after</em>
<strong>.FOOTNOTE OFF</strong> has changed.
<br>
<a name="FN_AND_PUNCT_FILL"><h4>"Fill" modes -- JUSTIFY, or QUAD LEFT | CENTER | RIGHT</h4></a>
In fill modes, the correct way to enter the line after
<strong>.FOOTNOTE OFF</strong> is to input it as if it's literally a
continuation of the input line you were entering before you invoked
<strong>.FOOTNOTE</strong>. Therefore, if necessary, the input line
may have to begin with space(s) or a punctuation mark, as in the two
following examples.
<pre>
Example 1
---------
A line of text,\c
.FOOTNOTE
A footnote line.
.FOOTNOTE OFF
broken up with a comma.
^
(last line begins with a literal space)
Example 2
---------
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)
</pre>
Example 1 produces, on output
<pre>
A line of text,* broken up with a comma.
</pre>
Example 2 produces
<pre>
A line of text*, broken up with a comma.
</pre>
Care must be taken, though, if the punctuation mark that begins the
line after <strong>FOOTNOTE OFF</strong> is a period (dot). You
<strong><em><u>must</u></em></strong> begin such lines with
<strong>\&.</strong>, like this:
<pre>
end of a sentence\c
.FOOTNOTE
A footnote line.
.FOOTNOTE OFF
\&. A new sentence...
</pre>
If you omit the <strong>\&.</strong>, the line will vanish!
<p>
<strong>NOTE:</strong> The document element tag,
<strong>BLOCKQUOTE</strong>, implies a "fill" mode, therefore these
instructions also apply when you're inputting blockquote text.
<br>
<a name="FN_AND_PUNCT_NOFILL"><h4>"No-fill" modes -- LEFT, CENTER, RIGHT</h4></a>
In no-fill modes, you must decide a) whether text on the
<em>input</em> line after <strong>FOOTNOTE OFF</strong> is
to be joined to the <em>output</em> line before
<strong>FOOTNOTE</strong> was invoked, or b) whether you want the
<em>output</em> text to begin on a new line.
<p>
In the first instance, simply follow the instructions,
<a href="#FN_AND_PUNCT_FILL">above</a>,
for fill modes.
<p>
In the second instance, you must explicitly tell <strong>mom</strong>
that you want input text after <strong>FOOTNOTE OFF</strong> to
begin on a new output line. This is accomplished by passing
<strong>.FOOTNOTE OFF</strong> (or <strong>QUIT, END, X,</strong>
etc) an additional argument: <strong>BREAK</strong> or
<strong>BR</strong>.
<p>
Study the two examples below to understand the difference.
<pre>
Example 1 -- No-fill mode, FOOTNOTE OFF with no BREAK
-----------------------------------------------------
.LEFT
A line of text\c
.FOOTNOTE
A footnote line
.FOOTNOTE OFF
that carries on after the footnote.
</pre>
produces, on output
<pre>
A line of text* that carries on after the footnote.
</pre>
whereas
<pre>
Example 2 -- No-fill mode, FOOTNOTE OFF with BREAK
--------------------------------------------------
.LEFT
A line of text\c
.FOOTNOTE
A footnote line
.FOOTNOTE OFF BREAK
that doesn't carry on after the footnote.
</pre>
produces the following on output:
<pre>
A line of text*
that doesn't carry on after the footnote.
</pre>
<p>
The distinction becomes particularly important if you like to see
punctuation marks come <em>after</em> footnote markers. In no-fill
modes, that's accomplished like this:
<pre>
.LEFT
A line of text\c
.FOOTNOTE
A footnote line
.FOOTNOTE OFF
,
broken up with a comma.
</pre>
The output of the above looks like this:
<pre>
A line of text*,
broken up with a comma.
</pre>
<p>
<strong>NOTE:</strong> The document element tag,
<strong>QUOTE</strong>, implies a "no-fill" mode, therefore these
instructions also apply when you're inputting quote text.
<p>
<!---FOOTNOTE--->
<hr width="66%" align="left">
<p>
<a name="FOOTNOTE">
<nobr>Tag: <strong>FOOTNOTE</strong> <toggle> [ BREAK | BR ] | INDENT LEFT | RIGHT | BOTH <indent value></nobr>
<br>
<em>*See <a href="#FOOTNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!</em>
<br>
<indent value> requires a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
</a>
<p>
<strong>FOOTNOTE</strong> 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 <em>other than INDENT</em>
(i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong>
you're finished.
<p>
Footnotes are the only element of
<a href="definitions.html#TERMS_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 <strong>FOOTNOTE</strong> with
the <strong>INDENT</strong> argument and pass it an indent
direction and indent value. <strong>L, R,</strong> and
<strong>B</strong> may be used in place of <strong>LEFT,
RIGHT,</strong> and <strong>BOTH</strong>.
<strong>FOOTNOTE</strong> must be invoked with <strong>INDENT</strong>
for every footnote you want indented; <strong>mom</strong> does
not save any footnote indent information from invocation to
invocation.
<p>
<strong>NOTE:</strong> If a footnote runs to more than one
paragraph(!), <strong>DO NOT</strong> begin the footnote with
the
<a href="#PP">PP</a>
tag. Use <strong>PP</strong> only to introduce subsequent paragraphs.
<p>
<a name="FOOTNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a>
The final word on the
<a href="definitions.html#TERMS_INPUTLINE">input line</a>
that comes immediately before <strong>FOOTNOTE</strong> MUST terminate
with a
<a href="typesetting.html#JOIN">\c</a>
inline escape if your
<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a>
is either <strong>STAR</strong> or <strong>NUMBER</strong>.
See the
<a href="#FOOTNOTE_EXAMPLE">footnote example</a>
above.
<p>
Additionally, in "fill" modes (<strong>JUSTIFY</strong>
or <strong>QUAD LEFT | CENTER | RIGHT</strong>), the line
<em>after</em> a <strong>FOOTNOTE OFF</strong> 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>
In "no-fill" modes, the optional argument <strong>BREAK</strong> or
<strong>BR</strong> may be used after the <strong>OFF</strong> (or
<strong>QUIT, END, X,</strong> etc.) argument to instruct
<strong>mom</strong> 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>
Do NOT use the <strong>\c</strong> inline escape if your
<strong>FOOTNOTE_MARKER_STYLE</strong> is <strong>LINE</strong>, or
if you have disabled footnote markers with
<a href="#FOOTNOTE_MARKERS">.FOOTNOTE_MARKERS</a>
<strong>OFF</strong>. In these instances, the line after
<strong>FOOTNOTE OFF</strong> should be entered normally.
<p>
<a name="FOOTNOTE_CONTROL"><h3><u>Footnote control macros</u></h3></a>
<ol>
<li><a href="#FOOTNOTE_GENERAL">Family/font/size/colour/lead/quad</a>
<li><a href="#FOOTNOTE_MARKERS">Footnote markers</a> -- on or off
<li><a href="#FOOTNOTE_MARKER_STYLE">Footnote marker style</a> -- star+dagger, numbered or by line number
<ul>
<li><a href="#FOOTNOTE_LINENUMBER_BRACKETS">FOOTNOTE_LINENUMBER_BRACKETS</a>
<li><a href="#FOOTNOTE_LINENUMBER_SEPARATOR">FOOTNOTE_LINENUMBER_SEPARATOR</a>
<li><a href="#FOOTNOTES_RUN_ON">FOOTNOTES_RUN_ON</a>--line-numbered footnotes only
</ul>
<li><a href="#RESET_FOOTNOTE_NUMBER">Reset footnote number</a> -- set footnote marker number to 1
<li><a href="#FOOTNOTE_SPACE">Inter-footnote spacing</a>
<li><a href="#FOOTNOTE_RULE">Footnote rule</a> -- on or off
<li><a href="#FOOTNOTE_RULE_LENGTH">Footnote rule length</a> -- length of footnote separator rule
<li><a href="#FOOTNOTE_RULE_ADJ">Adjust vertical position of footnote separator rule</a>
</ol>
<p>
<a name="FOOTNOTE_GENERAL"><h3><u>1. Family/font/size/colour/lead/quad</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.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
</pre>
<a name="FOOTNOTE_MARKERS"><h3><u>2. Footnote markers -- FOOTNOTE_MARKERS</u></h3></a>
<p>
If you don't want footnote markers, in either the body of
the document or beside footnote entries themselves, toggle
them off with <strong>.FOOTNOTE_MARKERS OFF</strong> (or
<strong>END, QUIT, X</strong>...). This means, of course, that
you'll have to roll your own. If you want them back on, invoke
<strong>.FOOTNOTE_MARKERS</strong> with no argument. Footnote markers
are on by default.
<p>
If <strong>FOOTNOTE_MARKERS</strong> are disabled, do NOT use the
<strong>\c</strong> inline escape to terminate the line before
<strong>.FOOTNOTE</strong>.
<p>
<a name="FOOTNOTE_MARKER_STYLE"><h3><u>3. Footnote marker style -- FOOTNOTE_MARKER_STYLE</u></h3></a>
<p>
<strong>Mom</strong> gives you two choices of footnote marker style:
star+dagger (see
<a href="#FOOTNOTE_BEHAVIOUR">footnote behaviour</a>
above), or numbered.
<p>
<strong>.FOOTNOTE_MARKER_STYLE STAR</strong> gives you star+dagger
(the default). There is a limit of 10 footnotes per page with
this style.
<p>
<strong>.FOOTNOTE_MARKER_STYLE NUMBER</strong> 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 <strong>mom</strong> to start each page's footnote numbers at 1
with <strong>.RESET_FOOTNOTE_NUMBER</strong>
(<a href="#RESET_FOOTNOTE_NUMBER">see below</a>.)
<a name="FOOTNOTE_LINENUMBERS"><p></a>
<p>
<strong>.FOOTNOTE_MARKER_STYLE LINE</strong> 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>
With <strong>FOOTNOTE_MARKER_STYLE LINE</strong>, <strong>mom</strong>
will identify footnotes either by single line numbers, or line
ranges. If what you want is a single line number, you need only
invoke <strong>.FOOTNOTE</strong>, <em>without terminating the text
line before it with</em> <strong>\c</strong>, at the appropriate
place in running text.
<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#TERMS_INLINES">inline escape</a>,
<strong>\*[FN-MARK]</strong>. For the terminating line number of
the range, you need only invoke <strong>.FOOTNOTE</strong>, (again,
without attaching <strong>\c</strong> to the text line before it).
<strong>Mom</strong> is smart enough to figure out that where
<strong>FOOTNOTE</strong> was invoked represents the terminating
line number. Range-numbered footnotes are always output on the page
where <strong>FOOTNOTE</strong> was invoked, not the page where
<strong>\*[FN-MARK]</strong> 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>).
<a name="FOOTNOTE_LINENUMBER_BRACKETS"></a>
<p>
<strong>Mom</strong>, by default, puts footnote line numbers inside
square brackets. The style of the brackets may be changed with
the macro, <strong>FOOTNOTE_LINENUMBER_BRACKETS</strong>, which
takes one of three possible arguments: <strong>PARENS</strong>
("round" brackets), <strong>SQUARE</strong> (the default) or
<strong>BRACES</strong> (curly braces). If you prefer a
shortform, the arguments, <strong>(</strong>, <strong>[</strong> or
<strong>{</strong> may be used instead.
<a name="FOOTNOTE_LINENUMBER_SEPARATOR"></a>
<p>
If you don't want the numbers enclosed in brackets, you may tell
<strong>mom</strong> 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 <strong>FOOTNOTE_LINENUMBER_SEPARATOR</strong>,
which takes, as its single argument, the separator you want. For
safety and consistency's sake, ALWAYS enclose the argument in
double-quotes.
<p>
The separator can be composed of any valid groff character, or any
combination of characters. <strong>A word of caution:</strong> when
using a separator, <strong>mom</strong> doesn't insert a space
after the separator. Hence, if you want the space (you probably
do), you must make the space part of the argument you pass to
<strong>FOOTNOTE_LINENUMBER_SEPARATOR</strong>. For example,
to get a colon separator with a space after it, you'd do
<p>
<pre>
.FOOTNOTE_LINENUMBER_SEPARATOR ": "
</pre>
<a name="FOOTNOTES_RUN_ON"><strong><u>RUN-ON FOOTNOTES</u></strong></a>
<p>
Finally, if your footnote marker style is <strong>LINE</strong>, you
may instruct <strong>mom</strong> to do "run-on style" footnotes.
Run-on footnotes do not treat footnotes as discrete entities, i.e.
on a line by themselves. Rather, each footnote is separated from
the footnote before it by a space, so that the footnotes on any
given page form a continuous block, like lines in a paragraph. The
macro to get
<strong>mom</strong> to run footnotes on is
<strong>.FOOTNOTES_RUN_ON</strong>. Invoked by itself, it turns
the feature on. Invoked with any other argument
(<strong>OFF</strong>, <strong>NO</strong>, 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,
<strong>mom</strong> 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>
The usual reason for wanting run-on footnotes is that you're
using them to hold many, short references. (See
<a href="refer.html#TOP">here</a>
for instructions on using the <strong>groff</strong> program,
<strong>refer</strong>, to set up references.)
<p>
<a name="RESET_FOOTNOTE_NUMBER"><h3><u>4. Reset footnote number -- RESET_FOOTNOTE_NUMBER</u></h3></a>
<p>
<strong>.RESET_FOOTNOTE_NUMBER</strong>, by itself, resets
footnote numbering so that the next footnote you enter is
numbered 1.
<p>
<strong>.RESET_FOOTNOTE_NUMBER PAGE</strong> tells
<strong>mom</strong> to start every page's footnote numbering at 1.
<p>
<a name="FOOTNOTE_SPACE"><h3><u>5. Inter-footnote spacing -- FOOTNOTE_SPACE</u></h3></a>
<p>
If you'd like a little extra space between footnotes, you can have
<strong>mom</strong> put it in for you by invoking
<strong>.FOOTNOTE_SPACE</strong> with an argument representing the
amount of extra space you'd like. The argument to
<strong>FOOTNOTE_SPACE</strong> requires a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
<p>
In the following example, footnotes will be separated from each
other by 3
<a href="definitions.html#TERMS_PICASPOINTS">points</a>.
<pre>
.FOOTNOTE_SPACE 3p
</pre>
<a name="FOOTNOTE_RULE"><h3><u>6. Footnote rule -- FOOTNOTE_RULE</u></h3></a>
<p>
If you don't want a footnote separator rule, toggle it off with
<strong>.FOOTNOTE_RULE OFF</strong> (or <strong>END,
QUIT, X</strong>...). Toggle it back on by invoking
<strong>.FOOTNOTE_RULE</strong> with no argument. The default is to
print the rule.
<p>
<a name="FOOTNOTE_RULE_LENGTH"><h3><u>7. Footnote rule length -- FOOTNOTE_RULE_LENGTH</u></h3></a>
<p>
If you want to change the length of the footnote separator rule,
invoke <strong>.FOOTNOTE_RULE_LENGTH</strong> with a length, like
this,
<pre>
.FOOTNOTE_RULE_LENGTH 1i
</pre>
which sets the length to 1 inch. Note that a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
is required. The default is 4
<a href="definitions.html#TERMS_PICASPOINTS">picas</a>
for both
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLES</a>.
<p>
<a name="FOOTNOTE_RULE_ADJ"><h3><u>8. Adjust vertical position of footnote separator rule -- FOOTNOTE_RULE_ADJ</u></h3></a>
<p>
The footnote separator rule is actually a baseline rule that falls
on the
<a href="definitions.html#TERMS_BASELINE">baseline</a>
of the first line of a page's footnotes. By default,
<strong>mom</strong> raises the rule 3
<a href="definitions.html#TERMS_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 <strong>.FOOTNOTE_RULE_ADJ</strong> with the
amount you'd like. For example
<p>
<pre>
.FOOTNOTE_RULE_ADJ 4.25p
</pre>
raises the rule by 4-1/4 points. Note that you can only raise
the rule, not lower it. A
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
is required.
<p>
<strong>Tip:</strong> If your document
<a href="definitions.html#TERMS_LEADING">leading</a>
is 2
<a href="definitions.html#TERMS_PICASPOINTS">points</a>
or less (e.g your
<a href="definitions.html#TERMS_PS">point size</a>
is 10 and your linespacing is 10, 11, or 12, lowering
<strong>mom</strong>'s default footnote rule adjustment will
almost certainly give you nicer looking results than leaving
the adjustment at the default. Furthermore, you can invoke
<strong>FOOTNOTE_RULE_ADJ</strong> 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 to do so.
<p>
<hr>
<!====================================================================>
<a name="ENDNOTE_INTRO"><h2><u>Endnotes</u></h2></a>
<ul>
<li><a href="#ENDNOTE_BEHAVIOUR">Endnote behaviour</a>
<ul>
<li><a href="#ENDNOTE_SPACING">A Note on Endnote Spacing</a>
<li><a href="#ENDNOTE_COLUMNS">Endnotes and columnar documents</a>
</ul>
<li><a href="#ENDNOTE">Tag: ENDNOTE</a>
<li><a href="#ENDNOTES">Macro: ENDNOTES</a> -- tell <strong>mom</strong> to output endnotes
<li><a href="#ENDNOTE_CONTROL">ENDNOTES control macros</a>
</ul>
<p>
Embedding endnotes into <strong>mom</strong> 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>
<a name="ENDNOTE_EXAMPLE"></a>
<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.
</pre>
As with footnotes, note the obligatory use of the <strong>\c</strong>
<a href="definitions.html#TERMS_INLINES">inline escape</a>
when your
<a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a>
is <strong>NUMBER</strong> (which marks endnotes references in
<a href="definitions.html#TERMS_RUNNING">running text</a>
with superscript numbers). When the marker style is
<strong>LINE</strong>, you must <em>not</em> use the
<strong>\c</strong> escape.
<p>
<strong>***Version 1.3-d change***</strong>
<p>
As of version 1.3-d, the manner of entering the line <em>after</em>
<strong>.ENDNOTE OFF</strong> has changed to accommodate users'
differing wishes with respect to the order of punctuation and
endnote markers. <strong>Mom</strong> handles endnotes and
footnotes identically in this regard, so please read the footnote
section,
<a href="#FN_AND_PUNCT">Footnote markers and punctuation in the running text</a>,
for an explanation.
<p>
<strong>***End version 1.3 change***</strong>
<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):
<br>
<ol>
<li>When your <strong>ENDNOTE_MARKER_STYLE</strong> is
<strong>NUMBER</strong>, endnotes are always numbered
incrementally, starting at "1".
<li>Endnotes MUST be output explicitly; <strong>mom</strong> 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.
</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>
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 <em>within</em> each endnote, prior
to invoking <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong>, and
undo them prior to terminating the endnote (i.e. before <strong>ENDNOTE
OFF</strong>), otherwise the changes will affect subsequent quotes and
blockquotes that appear in the document body as well.
<p>
<a name="ENDNOTE_BEHAVIOUR"><h3><u>Endnote behaviour</u></h3></a>
<br>
When you output endnotes (with
<a href="#ENDNOTES">ENDNOTES</a>),
<strong>mom</strong> finishes processing the last page of your document,
then breaks to a new page for printing the endnotes. If the document
type is
<a href="docprocessing.html#DOCTYPE">CHAPTER</a>,
the centre part of the
<a href="definitions.html#TERMS_HEADER">header</a>
(or footer), which, by default, contains a chapter number or title, is
removed.
<p>
By default, <strong>mom</strong> starts the endnotes page with a
bold, centred, double-underscored head, "ENDNOTES".
Underneath--flush left, bold, and underscored--she prints the document
title (or, in the case of chapters, the chapter number or title). She
then prints the endnotes. Each endnote is identified by its appropriate
number, in bold, right aligned to two placeholders. The text of the
endnotes themselves is indented to the right of the numbers.
<p>
If the endnotes are grouped together at the end of a collated document,
each section of the document that contains endnotes is identified by its
own unique title (or chapter number or title), bold, flush left, and
underscored.
<p>
Of course, all the defaults, as well as the overall style of the
endnotes page, 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>
<a name="ENDNOTE_SPACING">
<h3><u>A Note on Endnote Spacing</u></h3>
</a>
<br>
On the endnotes page(s), each new endnote is separated from the
previous endnote by a full line space. This can result in a bottom
margin that hangs, and is the one instance, other than the use of
<a href="#PP_SPACE">PARA_SPACE</a>,
where <strong>mom</strong> allows unequal bottom alignment of pages.
Should you wish to correct this, by adding or subtracting small amounts
of space between endnotes that appear together on an endnotes page, make
the adjustment (with
<a href="typesetting.html#ALD">ALD</a>,
<a href="typesetting.html#RLD">RLD</a>
or
<a href="typesetting.html#SPACE">SPACE</a>)
<em>at the end of each endnote</em> (i.e. just before invoking
<a href="#ENDNOTE">ENDNOTE OFF</a>)
rather than at the top.
<p>
<a name="ENDNOTE_COLUMNS">
<h3><u>Endnotes and columnar documents</u></h3>
</a>
<br>
Formerly (pre 1.1.6), there was no way to set a document in columns
(see
<a href="docprocessing.html#COLUMNS">COLUMNS</a>)
and then turn off column mode for endnotes. As of version 1.1.6,
you may now do so. See
<a href="#ENDNOTES_NO_COLUMNS">ENDNOTES_NO_COLUMNS</a>.
<p>
<hr>
<!---ENDNOTE--->
<p>
<a name="ENDNOTE">
<nobr>Macro: <strong>ENDNOTE</strong> <toggle> [ BREAK | BR ]</nobr>
<br>
<em>*See <a href="#ENDNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!</em>
</a>
<p>
<strong>ENDNOTE</strong> 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. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong>
that you've finished the endnote.
<p>
<strong>NOTE:</strong> If an endnote runs to more than one paragraph,
<strong>DO NOT</strong> begin the endnote with the
<a href="#PP">PP</a>
tag. Use <strong>PP</strong> only to introduce subsequent paragraphs.
<p>
<a name="ENDNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a>
If your
<a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a>
is <strong>NUMBER</strong> (<strong>mom</strong>'s default), the
final word on the
<a href="definitions.html#TERMS_INPUTLINE">input line</a>
that comes immediately before <strong>ENDNOTE</strong> MUST terminate
with a
<a href="typesetting.html#JOIN">\c</a>
inline escape. See the
<a href="#ENDNOTE_EXAMPLE">endnote example</a>
above.
<p>
Additionally, in "fill" modes (<strong>JUSTIFY</strong>
or <strong>QUAD LEFT | CENTER | RIGHT</strong>), the line
<em>after</em> a <strong>ENDNOTE OFF</strong> 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>
In "no-fill" modes, the optional argument <strong>BREAK</strong> or
<strong>BR</strong> may be used after the <strong>OFF</strong> (or
<strong>QUIT, END, X,</strong> etc.) argument to instruct
<strong>mom</strong> 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>
If your <strong>ENDNOTE_MARKER_STYLE</strong> is
<strong>LINE</strong>, do NOT use the <strong>\c</strong> escape,
and enter the line after <strong>.ENDNOTE OFF</strong>
normally.
<p>
<!---ENDNOTES--->
<hr width="66%" align="left">
<p>
<a name="ENDNOTES">Tag: <strong>ENDNOTES</strong></a>
<p>
Unlike footnotes, which <strong>mom</strong> automatically outputs at the
bottom of pages, endnotes must be explicitly output by you, the user.
<strong>ENDNOTES</strong>, by itself (i.e. without any argument), is
the macro to do this.
<p>
Typically, you'll use <strong>ENDNOTES</strong> at the end of
a document. If it's a single (i.e. not collated) document,
<strong>mom</strong> will print the endnotes pertaining to it. If it's
a collated document, <strong>mom</strong> will print all the endnotes
contained within all sections of the document (typically chapters),
appropriately identified and numbered.
<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 <strong>ENDNOTES</strong> immediately prior to
<a href="rectoverso.html#COLLATE">COLLATE</a>.
<strong>Mom</strong> 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 <strong>ENDNOTES</strong>
outputs only those endnotes that <strong>mom</strong> collected
after the previous invocation.
<p>
<hr width="66%" align="left">
<a name="ENDNOTE_CONTROL"><h3><u>Endnote control macros</u></h3></a>
<p>
<strong>VERY IMPORTANT NOTE!</strong>
<br>
Endnote control macros must always be invoked prior to the first
instance of
<a href="#ENDNOTE">ENDNOTE/ENDNOTE OFF</a>.
<p>
When you embed endnotes in the body of a document,
<strong>mom</strong> collects <em>and processes</em> them for later
outputting (when you invoke
<a href="#ENDNOTES">ENDNOTES</a>).
By the time you do invoke <strong>ENDNOTES</strong>, it's much too
late to change your mind about how you want them to look.
<p>
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>
<ol>
<li><a href="#ENDNOTES_GENERAL"><strong>General endnotes-pages style control</strong></a>
<ul>
<li><a href="#ENDNOTE_STYLE">Base family/font/quad for endnotes-pages</a>
<li><a href="#ENDNOTE_PT_SIZE">Base point size for the endnotes-pages</a>
<li><a href="#ENDNOTE_LEAD">Leading of endnotes-pages</a>
<li><a href="#SINGLESPACE_ENDNOTES">Singlespace endnotes (for TYPEWRITE only)</a>
<li><a href="#ENDNOTE_PARA_INDENT">Size of paragraph first line indent in multi-paragraph endnotes</a>
<li><a href="#ENDNOTE_PARA_SPACE">Inserting space between paragraphs of multi-paragraph endnotes</a>
<li><a href="#ENDNOTES_NO_COLUMNS">Turning off column mode during endnotes output</a>
<li>Pagination of endnotes:
<ul>
<li><a href="#ENDNOTES_PAGENUM_STYLE">Endnotes-pages page numbering style</a>
<li><a href="#ENDNOTES_FIRST_PAGENUMBER">Setting the first page number of endnotes pages</a>
<li><a href="#ENDNOTES_NO_FIRST_PAGENUM">Omitting a page number on the first page of endnotes</a>
</ul>
<li><a href="#SUSPEND_PAGINATION">Suspending pagination of endnotes pages</a>
</ul>
<li><a href="#ENDNOTES_HEADER_CONTROL"><strong>Endnotes-page header/footer control</strong></a>
<ul>
<li><a href="#ENDNOTES_MODIFY_HDRFTR">Modifying what goes in the endnotes-pages header/footer</a>
<li><a href="#ENDNOTES_HDRFTR_CENTER">Enabling a header/footer centre when doctype is CHAPTER</a>
<li><a href="#ENDNOTES_ALLOWS_HEADERS">Allow headers on endnotes-pages</a>
</ul>
<li><a href="#ENDNOTES_MAIN_TITLE"><strong>Endnotes-page head (i.e. the title at the top) control</strong></a>
<ul>
<li><a href="#ENDNOTE_STRING">Creating/modifying the endnotes-page head</a>
<li><a href="#ENDNOTE_STRING_CONTROL">Endnotes-page head control</a>
<li><a href="#ENDNOTE_STRING_UNDERSCORE">Endnotes-page head underscoring</a>
<li><a href="#ENDNOTE_STRING_CAPS">Endnotes-page head capitalization</a>
</ul>
<li><a href="#ENDNOTES_DOC_TITLE"><strong>Endnote document-identification title</strong></a>
<ul>
<li><a href="#ENDNOTE_TITLE">Creating/modifying the endnote document-identification title</a>
<li><a href="#ENDNOTE_TITLE_CONTROL">Document-identification title control</a>
<li><a href="#ENDNOTE_TITLE_UNDERSCORE">Document-identification title underscoring</a>
</ul>
<li><a href="#ENDNOTES_NUMBERING"><strong>Endnotes-pages endnote numbering style</strong></a>
<ul>
<li><a href="#ENDNOTE_MARKER_STYLE">Endnote marker style</a>--by numbers in the text, or by line number
<ul>
<li><a href="#ENDNOTE_LINENUMBER_GAP">ENDNOTE_LINENUMBER_GAP</a>
<li><a href="#ENDNOTE_LINENUMBER_BRACKETS">ENDNOTE_LINENUMBER_BRACKETS</a>
<li><a href="#ENDNOTE_LINENUMBER_SEPARATOR">ENDNOTE_LINENUMBER_SEPARATOR</a>
</ul>
<li><a href="#ENDNOTE_NUMBER_CONTROL">Endnotes-pages endnote numbering style control</a>
<li><a href="#ENDNOTE_NUMBER_ALIGNMENT">Endnote numbering alignment</a>
<ul>
<li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT">ENDNOTE_NUMBERS_ALIGN_RIGHT</a>
<li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT">ENDNOTE_NUMBERS_ALIGN_LEFT</a>
</ul>
</ul>
</ol>
<hr>
<a name="ENDNOTES_GENERAL"><h2><u>1. General endnotes page style control</u></h2>
<a name="ENDNOTE_STYLE"><h3><u>*Endnote family/font/quad</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.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 or J
</pre>
<!---ENDNOTE_PT_SIZE--->
<a name="ENDNOTE_PT_SIZE"><h3><u>*Endnote point size</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTE_PT_SIZE</strong> <base type size of endnotes></nobr>
<p>
Unlike most other control macros that deal with size of document
elements, <strong>ENDNOTE_PT_SIZE</strong> takes as its argument an
absolute value, relative to nothing. Therefore, the argument represents
the size of endnote type in
<a href="definitions.html#TERMS_PICASPOINTS">points</a>,
unless you append an alternative
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
For example,
<p>
<pre>
.ENDNOTE_PT_SIZE 12
</pre>
sets the base point size of type on the endnotes page to 12
points, whereas
<p>
<pre>
.ENDNOTE_PT_SIZE .6i
</pre>
sets the base point size of type on the endnotes page to 1/6 of an
inch.
<p>
The type size set with <strong>ENDNOTE_PT_SIZE</strong> 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>
The default for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
is 12.5 points (the same default size used in the body of the document).
<p>
<!---ENDNOTE_LEAD--->
<a name="ENDNOTE_LEAD"><h3><u>*Endnote lead</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTE_LEAD</strong> <base leading of endnotes> [ ADJUST ] </nobr>
<br>
<em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
<p>
Unlike most other control macros that deal with leading of document
elements, <strong>ENDNOTE_LEAD</strong> takes as its argument an
absolute value, relative to nothing. Therefore, the argument represents
the
<a href="definitions.html#TERMS_LEADING">leading</a>
of endnotes in
<a href="definitions.html#TERMS_PICASPOINTS">points</a>
unless you append an alternative
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
For example,
<p>
<pre>
.ENDNOTE_LEAD 14
</pre>
sets the base leading of type on the endnotes page to 14
points, whereas
<p>
<pre>
.ENDNOTE_LEAD .5i
</pre>
sets the base leading of type on the endnotes page to 1/2 inch.
<p>
If you want the leading of endnotes adjusted to fill the page, pass
<strong>ENDNOTE_LEAD</strong> the optional argument
<strong>ADJUST</strong>. (See
<a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
for an explanation of leading adjustment.)
<p>
The default for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
is 14 points, adjusted.
<p>
<strong>NOTE:</strong> Even if you give <strong>mom</strong> a
<strong>DOC_LEAD_ADJUST OFF</strong> command, she will still, by
default, adjust endnote leading. You MUST enter
<strong>ENDNOTE_LEAD <lead></strong> with no
<strong>ADJUST</strong> argument to disable this default behaviour.
<p>
<!---SINGLESPACE_ENDNOTES--->
<a name="SINGLESPACE_ENDNOTES"><h3><u>*Singlespace endnotes (TYPEWRITE only)</u></h3></a>
<p>
<nobr>Macro: <strong>SINGLESPACE_ENDNOTES</strong> <toggle></nobr>
<p>
If your
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a>
is <strong>TYPEWRITE</strong> and you use TYPEWRITE's default
double-spacing, endnotes are double-spaced. If your document is
single-spaced, endnotes are single-spaced.
<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 <strong>SINGLESPACE_ENDNOTES</strong> 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 <strong>SINGLESPACE_ENDNOTES</strong> with any
argument (<strong>OFF, QUIT, Q, X</strong>...).
<p>
<!---ENDNOTE_PARA_INDENT--->
<a name="ENDNOTE_PARA_INDENT"><h3><u>*Endnote paragraph indenting</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTE_PARA_INDENT</strong> <amount to indent first line of paragraphs in endnotes></nobr>
<br>
<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
<p>
<strong>ENDNOTE_PARA_INDENT</strong> 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>
The default is 1.5
<a href="definitions.html#TERMS_EM">ems</a>
for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
1/2 inch for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.
<p>
<strong>NOTE:</strong> 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
<strong>ENDNOTE_PARA_INDENT</strong>.
<p>
<!---ENDNOTE_PARA_SPACE--->
<a name="ENDNOTE_PARA_SPACE"><h3><u>*Endnote paragraph spacing</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTE_PARA_SPACE</strong> <toggle></nobr>
<p>
<strong>ENDNOTE_PARA_SPACE</strong> 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>
The default is not to insert a blank line between paragraphs in
endnotes.
<p>
<strong>NOTE:</strong> Each endnote itself is always separated from any
previous endnote by a line space. <strong>ENDNOTE_PARA_SPACE</strong>
refers only to paragraphs that appear within each discrete endnote.
<p>
<!---ENDNOTES_NO_COLUMNS--->
<a name="ENDNOTES_NO_COLUMNS"><h3><u>*Turning off column mode during endnotes output</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTES_NO_COLUMNS</strong> <toggle></nobr>
<p>
By default, if your document is
<a href="columns.html#COLUMNS">set in columns</a>,
<strong>mom</strong> 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 <strong>ENDNOTES_NO_COLUMNS</strong> with no
argument. The endnotes pages will be set to the full page measure
of your document.
<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
<strong>ENDNOTES_NO_COLUMNS</strong> turned on.
<p>
<!---ENDNOTES_PAGENUM_STYLE--->
<a name="ENDNOTES_PAGENUM_STYLE"><h3><u>*Endnotes-pages page numbering style</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTES_PAGENUM_STYLE</strong> DIGIT | ROMAN | roman | ALPHA | alpha</nobr>
<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 <strong>digit</strong>. You may want to change it
to, say, <strong>alpha</strong>, which you would do with
<p>
<pre>
.ENDNOTES_PAGENUM_STYLE alpha
</pre>
<!---ENDNOTES_FIRST_PAGENUMBER--->
<a name="ENDNOTES_FIRST_PAGENUMBER"><h3><u>*Setting the first page number of endnotes pages</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTES_FIRST_PAGENUMBER</strong> <page # that appears on page 1 of endnotes></nobr>
<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, <strong>ENDNOTES_FIRST_PAGENUMBER</strong> tells
<strong>mom</strong> what page number to put on the first page of
the endnotes.
<p>
If you set <strong>ENDNOTES_FIRST_PAGENUMBER</strong> in collated
documents where the endnotes are output after each separate doc,
you have to reset every separate document's first page number after
<a href="rectoverso.html#COLLATE">COLLATE</a>
and before
<a href="docprocessing.html#START">START</a>.
<p>
<!---ENDNOTES_NO_FIRST_PAGENUN--->
<a name="ENDNOTES_NO_FIRST_PAGENUM"><h3><u>*Omitting a page number on the first page of endnotes</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTES_NO_FIRST_PAGENUM</strong> <toggle></nobr>
<p>
This macro is for use only if <strong>FOOTERS</strong> are on. It
tells
<a href="#ENDNOTES">ENDNOTES</a>
not to print a page number on the first endnotes page.
<strong>Mom</strong>'s default is to print the page number.
<p>
<!---SUSPEND_PAGINATION--->
<a name="SUSPEND_PAGINATION"><h3><u>*Suspending pagination of endnotes pages</u></h3></a>
<p>
Macro: <strong>SUSPEND_PAGINATION</strong>
<br>
Macro: <strong>RESTORE_PAGINATION</strong>
<p>
<strong>SUSPEND_PAGINATION</strong> doesn't take an argument.
Invoked immediately prior to
<a href="#ENDNOTES">ENDNOTES</a>,
it turns off endnotes pages pagination. <strong>Mom</strong>
continues, however to increment page numbers silently.
<p>
To restore normal document pagination after endnotes, invoke
<strong>RESTORE_PAGINATION</strong> (again, with no argument)
immediately after <strong>ENDNOTES</strong>.
<a name="ENDNOTES_HEADER_CONTROL"><h2><u>2. Endnotes-page header/footer control</u></h2></a>
<p>
<a name="ENDNOTES_MODIFY_HDRFTR"></a>
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">ENDNOTES</a>,
not afterwards.
<p>
Except in the case of
<a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a>,
<strong>mom</strong> prints the same header or footer used throughout
the document on the endnotes page(s). Chapters get treated differently
in that, by default, <strong>mom</strong> 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
<em>not</em> want <strong>mom</strong> to remove the centre string from
the endnotes page(s) headers/footers, invoke
<a href="#ENDNOTES_HDRFTR_CENTER">ENDNOTES_HEADER_CENTER</a>
with no argument.
<p>
An important change you may want to make is to put the word
"Endnotes" in the header/footer centre position.
To do so, do
<p>
<pre>
.HEADER_CENTER "Endnotes"
or
.FOOTER_CENTER "Endnotes"
</pre>
prior to invoking <strong>.ENDNOTES</strong>. 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 <strong>HEADER_CENTER</strong> to appear.
<p>
<a name="ENDNOTES_HDRFTR_CENTER"><h3><u>*Endnotes page(s) header/footer centre string</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTES_HEADER_CENTER</strong> toggle</nobr>
<p>
If your
<a href="docprocessing.html#DOCTYPE">DOCTYPE</a>
is <kbd>CHAPTER</kbd> and you want <strong>mom</strong> to include
a centre string in the headers/footers that appear on endnotes pages,
invoke <strong>ENDNOTES_HEADER_CENTER</strong> (or
<strong>ENDNOTES_FOOTER_CENTER</strong>) with no argument.
<strong>Mom</strong>'s default is NOT to print the centre string.
<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 (<strong>OFF, QUIT, Q, X</strong>...).
<p>
<a name="ENDNOTES_ALLOWS_HEADERS"><h3><u>*Allow headers on endnotes-pages</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTES_ALLOWS_HEADERS</strong> <none> | ALL</nobr>
<p>
By default, if <strong>HEADERS</strong> are on, <strong>mom</strong>
prints page headers on all endnotes pages except the first. If you
don't want her to print headers on endnotes pages, do
<p>
<pre>
.ENDNOTES_ALLOWS_HEADERS OFF
</pre>
If you want headers on every page <em>including the first</em>, do
<p>
<pre>
.ENDNOTES_ALLOWS_HEADERS ALL
</pre>
<strong>NOTE:</strong> If <strong>FOOTERS</strong> are on,
<strong>mom</strong> prints footers on every endnotes page. This is
a style convention. In <strong>mom</strong>, there is no such beast
as <strong>ENDNOTES_ALLOWS_FOOTERS OFF</strong>.
<p>
<a name="ENDNOTES_MAIN_TITLE"><h2><u>3. Endnotes-page first page head (title) control</u></h2>
<!---ENDNOTE_STRING--->
<a name="ENDNOTE_STRING"><h3><u>*Endnotes-page first page head (title) string</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTE_STRING</strong> "<head to print at the top of endnotes>"</nobr>
<p>
By default, <strong>mom</strong> 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 <strong>ENDNOTE_STRING</strong> 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
<strong>ENDNOTE_STRING</strong> with a blank argument (either two
double-quotes side by side -- <kbd>""</kbd> -- or no argument
at all).
<p>
<!---ENDNOTE_STRING_CONTROL--->
<a name="ENDNOTE_STRING_CONTROL"><h3><u>*Endnotes-page first page head (title) control</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.ENDNOTE_STRING_FAMILY default = prevailing document family; default is Times Roman
.ENDNOTE_STRING_FONT default = bold
.ENDNOTE_STRING_SIZE* default = +1
.ENDNOTE_STRING_QUAD default = centred
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</pre>
<!---ENDNOTE_STRING_UNDERSCORE--->
<a name="ENDNOTE_STRING_UNDERSCORE"><h3><u>*Endnotes-page head (title) underscoring</h3></u></a>
<p>
<nobr>Macro: <strong>ENDNOTE_STRING_UNDERSCORE</strong> toggle | 2</nobr>
<p>
Invoked by itself, <strong>ENDNOTE_STRING_UNDERSCORE</strong> will
underscore the endnotes-page head. Invoked with the argument 2
(i.e. the digit 2), <strong>ENDNOTE_STRING_UNDERSCORE</strong> will
double-underscore the head. Invoked with any other argument, the macro
disables underscoring of the head.
<p>
<strong>Mom</strong>'s default is to double-underscore the
head, therefore if you want no underscoring, you must insert
<kbd>.ENDNOTE_STRING_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO,
NONE,</kbd> etc.) into your document prior to outputting endnotes with
<a href="#ENDNOTES">ENDNOTES</a>.
<!---ENDNOTE_STRING_CAPS--->
<a name="ENDNOTE_STRING_CAPS"><h3><u>*Endnotes-page head (title) automatic capitalization</h3></u></a>
<p>
<nobr>Macro: <strong>ENDNOTE_STRING_CAPS</strong> toggle</nobr>
<p>
Invoked by itself, <strong>ENDNOTE_STRING_CAPS</strong> will
automatically capitalize the endnotes-page head. Invoked with any
other argument, the macro disables automatic capitalization of the
head.
<p>
If you're generating a table of contents, you may want the
endnotes-pages head string in caps, but the toc entry in caps/lower
case. If the argument to
<a href="#ENDNOTE_STRING">ENDNOTE_STRING</a>
is in caps/lower case and <strong>ENDNOTE_STRING_CAPS</strong> is
on, this is exactly what will happen.
<p>
<strong>Mom</strong>'s default is to capitalize the endnotes-pages
head string.
<p>
<!---ENDNOTE_TITLE--->
<a name="ENDNOTES_DOC_TITLE"><h2><u>4. Endnote document-identification title</u></h2>
<a name="ENDNOTE_TITLE"><h3><u>*Endnote document-identification title string</u></h3></a>
<p>
<nobr>Macro: <strong>ENDNOTE_TITLE</strong> "<title to identify a document in endnotes>"</nobr>
<p>
By default, <strong>mom</strong> 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 want her to identify the document(s) another way,
just invoke <strong>ENDNOTE_TITLE</strong> with the identifying
title you want, surrounded by double-quotes.
<p>
If you don't want any identifying title, invoke
<strong>ENDNOTE_TITLE</strong> 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--->
<a name="ENDNOTE_TITLE_CONTROL"><h3><u>*Endnote document-identification title control</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.ENDNOTE_TITLE_FAMILY default = prevailing document family; default is Times Roman
.ENDNOTE_TITLE_FONT default = bold
.ENDNOTE_TITLE_SIZE* default = 0
.ENDNOTE_TITLE_QUAD default = left
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</pre>
<!---ENDNOTE_TITLE_UNDERSCORE--->
<a name="ENDNOTE_TITLE_UNDERSCORE"><h3><u>*Endnote document-identification title underscoring</h3></u></a>
<p>
<nobr>Macro: <strong>ENDNOTE_TITLE_UNDERSCORE</strong> toggle</nobr>
<p>
Invoked by itself, <strong>ENDNOTE_TITLE_UNDERSCORE</strong> will
underscore the endnote document-identification title(s). Invoked with any
other argument, the macro disables underscoring of the title(s).
<p>
<strong>Mom</strong>'s default is to underscore the document-identification title, therefore if you want no underscoring, you must
insert <kbd>.ENDNOTE_TITLE_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO,
NONE,</kbd> etc.) into your document prior to outputting endnotes with
<a href="#ENDNOTES">ENDNOTES</a>.
<p>
<!---ENDNOTE_NUMBERING--->
<a name="ENDNOTES_NUMBERING"><h2><u>5. Endnotes-pages endnote numbering style</u></h2>
<a name="ENDNOTE_MARKER_STYLE"><h3><u>*Endnote marker style</u></h3></a>
<p>
The macro to control how endnotes are referenced is
<strong>ENDNOTE_MARKER_STYLE</strong>.
<p>
By default, <strong>mom</strong> places superscript numbers in
<a href="definitions.html#RUNNING">running text</a>
to identify endnotes. However, if you have
<a href="#NUMBER_LINES">line-numbering</a>
turned on, you may instruct <strong>mom</strong> not to put
superscript numbers in the running text, but rather to reference
endnotes by line number. The command to do this is
<p>
<pre>
.ENDNOTE_MARKER_STYLE LINE
</pre>
With <strong>ENDNOTE_MARKER_STYLE LINE</strong>, <strong>mom</strong>
will identify endnotes either by single line numbers, or line
ranges. If what you want is a single line number, you need only
invoke <strong>.ENDNOTE</strong>, <em>without terminating the text
line before it with</em> <strong>\c</strong>, at the appropriate
place in running text. (Should you wish to revert to
<strong>mom</strong>'s default behaviour of placing a superscript
number in the text to identify an endnote, you can invoke
<strong>ENDNOTE_MARKER_STYLE</strong> with the argument,
<strong>NUMBER</strong>. 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>
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#TERMS_INLINES">inline escape</a>,
<strong>\*[EN-MARK]</strong>. For the terminating line number of
the range, you need only invoke <strong>.ENDNOTE</strong>, (again,
without attaching <strong>\c</strong> to the text line before it).
<strong>Mom</strong> is smart enough to figure out that where
<strong>ENDNOTE</strong> was invoked represents the terminating
line number.
<a name="ENDNOTE_LINENUMBER_GAP"></a>
<p>
Given the impossibility of knowing, in advance, the "string length"
of all the line numbers or ranges of line numbers that will be used
in endnotes (the string length of 12 is two; the string length
of 12-15 is 5), <strong>mom</strong> cannot "hang" line numbers
and guarantee that they, and the endnote text, will align in a
visually pleasing manner. Consequently, <strong>mom</strong> sets
the entirety of line-numbered endnotes completely flush left,
<strong>including the line numbers themselves</strong>. The line
numbers (by default, enclosed in square brackets) are separated from
the beginning of each endnote by a gap, so that a line-numbered
endnote looks approximately like this:
<p>
<pre>
[1-2] Notwithstanding, Frye later asserts that Christianity
is "a ghost with the chains of a foul historical record of
cruelty clanking behind it."
</pre>
The default gap for <strong>PRINTSTYLE TYPESET</strong> and
<strong>PRINSTYLE TYPEWRITE</strong> is 1.5
<a href="definitions.html#TERMS_EM">ems</a>.
You can change the size of the gap with the macro,
<strong>ENDNOTE_LINENUMBER_GAP</strong>, which takes, as its single
argument, the size of the gap. The argument requires a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
so, for example, to change the gap to 2
<a href="definitions.html#TERMS_PICASPOINTS">picas</a>,
you'd do
<p>
<pre>
.ENDNOTE_LINENUMBER_GAP 2P
</pre>
<a name="ENDNOTE_LINENUMBER_BRACKETS"></a>
By default, <strong>mom</strong> puts endnote line numbers inside
square brackets. The style of the brackets may be changed with
the macro, <strong>ENDNOTE_LINENUMBER_BRACKETS</strong>, which
takes one of three possible arguments: <strong>PARENS</strong>
("round" brackets), <strong>SQUARE</strong> (the default) or
<strong>BRACES</strong> (curly braces). If you prefer a
shortform, the arguments, <strong>(</strong>, <strong>[</strong> or
<strong>{</strong> may be used instead.
<a name="ENDNOTE_LINENUMBER_SEPARATOR"></a>
<p>
If you don't want the numbers enclosed in brackets, you may tell
<strong>mom</strong> 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 <strong>ENDNOTE_LINENUMBER_SEPARATOR</strong>,
which 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
<p>
<pre>
.ENDNOTE_LINENUMBER_SEPARATOR :
</pre>
<a name="ENDNOTE_NUMBER_CONTROL"><h3><u>*Endnote numbering style control</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
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 the document(s).
<p>
<pre>
.ENDNOTE_NUMBER_FAMILY default = prevailing document family; default is Times Roman
.ENDNOTE_NUMBER_FONT default = bold
.ENDNOTE_NUMBER_SIZE* default = 0
*Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
</pre>
<a name="ENDNOTE_NUMBER_ALIGNMENT"><h3><u>*Endnote numbering alignment</u></h3></a>
<p>
By default, <strong>mom</strong> hangs the numbers on endnotes pages,
aligned right to two placeholders, producing this:
<p>
<a name="ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE"></a>
<pre>
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.
</pre>
The macros to alter this behaviour are
<br>
<ul>
<li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT"><strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong></a>
<li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT"><strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong></a>
</ul>
<br>
<hr width="66%" align="left">
<!---ENDNOTE_NUMBERS_ALIGN_RIGHT--->
<p>
<a name="ENDNOTE_NUMBERS_ALIGN_RIGHT">
<nobr>Macro: <strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> <number of placeholders></nobr>
</a>
<p>
<strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> takes one (non-optional)
argument: the number of placeholders to reserve for right alignment of
endnote numbers.
<p>
For example, if you have fewer than ten endnotes, you might want to do
<p>
<pre>
.ENDNOTE_NUMBERS_ALIGN_RIGHT 1
</pre>
which would ensure that the endnote numbers hang, but are all flush
with the page's left margin. If, god help you, you have over a hundred
endnotes, you'd want to do
<p>
<pre>
.ENDNOTE_NUMBERS_ALIGN_RIGHT 3
</pre>
to ensure that the numbers hang and are properly right-aligned.
<p>
<hr width="66%" align="left">
<!---ENDNOTE_NUMBERS_ALIGN_LEFT--->
<p>
<a name="ENDNOTE_NUMBERS_ALIGN_LEFT">
Macro: <strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong>
</a>
<p>
If you don't want the endnote numbers to hang and right-align, invoke
<strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong>, which doesn't require any
argument. This disables hanging and right-alignment of endnote numbers,
so that the example
<a href="#ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE">above</a>
comes out like this:
<p>
<pre>
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.
</pre>
<hr>
<!====================================================================>
<a name="MARGIN_NOTES_INTRO"><h2><u>Margin notes</u></h2></a>
<ul>
<li><a href="#MARGIN_NOTES_BEHAVIOUR">Margin notes behaviour
<ul>
<li><a href="#MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a>
</ul>
<li><a href="#MN_INIT">Macro: MN_INIT</a> -- initialize margin notes
<li><a href="#MN">Tag: MN</a>
</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>
The margin notes macros and routines in om.tmac
(<strong>mom</strong>) are "mommified" versions of the margin notes
macros and routines written by Werner Lemberg and patched by Gaius
Mulley.
<p>
<a name="MARGIN_NOTES_BEHAVIOUR"<h3><u>Margin notes behaviour</u></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>.
<strong>MN_INIT</strong> sets up the style parameters for margin
notes, including things like
<a href="definitions.html#TERMS_FONT">font</a>,
<a href="definitions.html#TERMS_FAMILY">family</a>
and
<a href="definitions.html#TERMS_LEADING">leading</a>.
<p>
After initializing margin notes, you create margin notes with the
<a href="#MN">MN</a>
macro. Based on the argument you pass <strong>MN</strong>, your
margin note will go in either the left or the right margin.
<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#TERMS_RUNNING">running text</a>,
it's impossible for <strong>mom</strong> to guess whether to align
the first lines of margin notes with a document
<a href="definitions.html#TERMS_BASELINE">baseline</a>,
whether to align the last lines of margin notes with a document
baseline, or whether to center them, vertically, so that neither
first nor last line aligns with anything!
<p>
Given this difficulty, <strong>mom</strong> 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>
Generally speaking, <strong>mom</strong> tries to place margin
notes at the point where you invoke the tag,
<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, <strong>mom</strong> 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>
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
<strong>MN</strong> is invoked. In that case, <strong>mom</strong>
ignores the margin note entirely and issues a warning, letting you
know what she's done, and where.
<p>
In the event that a margin note, sucessfully 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>
If your document is being set in two columns, <strong>mom</strong>
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 <strong>MN</strong> tag. If
you try to use <strong>MN</strong> in documents of more than two
columns, <strong>mom</strong> will ignore all margin notes, and
issue warning for each.
<p>
<h3><u><a name="MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a></u></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>
Adjustments to the vertical position of margin notes must be done
inside the margin note (i.e. after <strong>MN</strong>), at the
top, before entering text. The commands to use are
\!<a href="typesetting.html#ALD">.ALD</a>
(to lower the margin note), and
\!<a href="typesetting.html#RLD">.RLD</a>
(to raise it). The <strong>\!</strong> <em>must</em> precede the
macros, or they won't have any effect.
<p>
<hr width="66%" align="left">
<!---MN_INIT--->
<p>
<a name="MN_INIT">
<nobr>Macro: <strong>MN_INIT</strong> [ RAGGED | SYMMETRIC ] < left-width right-width gutter family+font point-size lead colour hyphenation-flags ></nobr>
</a>
<p>
Before you enter your first margin note, you must initialize
all the parameters associated with margin notes with
<strong>MN_INIT</strong>. If you forget to do so,
<strong>mom</strong> will issue a warning and abort.
<p>
The argument list is quite long; an
explanation of each argument follows. Any argument whose value you
want to be the default must be entered as "" (i.e. two
double-quotes with no space between them). Defaults for each
argument are given in the explanations below.
<p>
<strong>[ RAGGED | SYMMETRIC ]</strong>
<br>
If the first argument is "RAGGED", both left and right margin notes
will be flush left. If the first argument is "SYMMETRIC", left
margin notes will be set flush <em>right</em>, and right margin
notes will be set flush <em>left</em>. The effect is something
like this:
<p>
<pre>
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.
</pre>
If the argument is omitted,
or given as "", 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>
<strong>left-width</strong>
<br>
The width of left margin notes. A
<a href="definitions.html#TERMS_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>
<strong>right-width</strong>
<br>
The width of right margin notes. A
<a href="definitions.html#TERMS_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>
<strong>gutter</strong>
<br>
The
<a href="definitions.html#TERMS_GUTTER">gutter</a>
between margin notes and
<a href="definitions.html#TERMS_RUNNING">running text</a>.
A
<a href="definitions.html#TERMS_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#TERMS_EM">em</a>.
<p>
<strong>font</strong>
<br>
The family+font for margin notes. Yes, that's right: the family
PLUS font combo. For example, if you want Times Roman Medium,
the argument must be TR. If you want Palatino Medium Italic, the
argument must be PI. The default is the same family+font combo used
for a document's paragraph text.
<p>
<strong>point size</strong>
<br>
The point size of type for margin notes. There is no need to append a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
to the argument;
<a href="definitions.html#TERMS_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>
<strong>lead</strong>
<br>
The
<a href="definitions.html#TERMS_LEADING">leading</a>
of margin notes. <strong>lead</strong> uses
<a href="definitions.html#TERMS_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 leading as
is used for paragraph text (i.e. the document's base leading).
For convenience and clarity, you may also give the word,
<strong>DOC</strong>, to this argument, which indicates that the
leading should be the same as the document's base leading.
<p>
<strong>colour</strong>
<br>
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>
<strong>hyphenation-flags</strong>
<br>
A number telling <strong>groff</strong> how you want margin notes
hyphenated.
<p>
<pre>
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
</pre>
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>
<hr width="66%" align="left">
<!---MN_INIT--->
<p>
<a name="MN">
<nobr>Macro: <strong>MN</strong> LEFT|RIGHT</nobr>
</a>
<p>
Once you've initialized margin notes with
<a href="#MN_INIT">MN_INIT</a>,
you can enter margin notes any time you like with
<strong>MN</strong>. An argument of <strong>LEFT</strong> will set
a left margin note. An argument of <strong>RIGHT</strong> will set
a right margin note.
<p>
Any argument, such as <strong>OFF</strong> (or
<strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>,
etc) exits the current margin note.
<p>
<hr>
<!====================================================================>
<a name="BLANK_PAGE_TITLE"><h2><u>Inserting a blank page into the document</u></h2></a>
<p>
<a name="BLANK_PAGE">
<nobr>Macro: <strong>BLANKPAGE</strong> <# of blank pages to insert></nobr>
</a>
<p>
This one does exactly what you'd expect -- inserts a blank page into
the document. <strong>Mom</strong> silently increments the page
number of every blank page and keeps track of
<a href="rectoverso.html#RECTO_VERSO">recto/verso</a>
stuff, but otherwise, does nothing. It's up to you, the user, to
figure out what to do with this feature. However, it's worth
noting that without it, inserting completely blank pages, to use
a vernacular Québécois phrase, "c'est pas évident"
(somewhere between "isn't easy", "isn't
obvious" and "isn't fun").
<p>
The argument to <strong>BLANK_PAGE</strong> is the number of blank
pages to insert. The argument is not optional, hence even if you
only want one blank page, you have to tell <strong>mom</strong>:
<p>
<pre>
.BLANKPAGE 1
</pre>
<a name="FINIS_INTRO"><h2><u>Terminate document processing</u></h2></a>
<ul>
<li><a href="#FINIS">Tag: FINIS</a>
<li><a href="#FINIS_STRING">Changing the FINIS string</a>
</ul>
<p>
The use of <strong>FINIS</strong> is optional. If you invoke it
(at the end of a document before
<a href="#TOC">TOC</a>
or
<a href="#ENDNOTES">ENDNOTES</a>),
<strong>mom</strong>
deposits the word END, centred after a blank line, beneath the last
line of the document. END is enclosed between
<a href="definitions.html#TERMS_EM">em-dashes</a>.
<p>
<strong>Please note</strong> that in versions of
<strong>mom</strong> prior to 1.1.9, <strong>FINIS</strong> used to
turn off
<a href="definitions.html#TERMS_FOOTER">footers</a>
(if they were on) and page numbering (if page numbers were at the
bottom of the page). Damned if I can recall why I thought anyone
would want this behaviour, but it has been removed.
<p>
If you're writing in a language other than English, you can
change what <strong>mom</strong> prints for END with
the control macro <strong>FINIS_STRING</strong>.
<p>
<hr>
<!====================================================================>
<a name="TOC_INTRO"><h2><u>Table of contents</u></h2></a>
<ul>
<li><a href="#TOC_BEHAVIOUR">TOC behaviour</a>
<li><a href="#TOC">Macro: TOC</a> -- tell <strong>mom</strong> to output a table of contents
<li><a href="#TOC_CONTROL">TOC control macros</a>
</ul>
<p>
Want a table of contents for your document? Easy. Just enter
<p>
<pre>
.TOC
</pre>
as the very last macro of your document file. <strong>Mom</strong>
will have picked up all document titles (in
<a href="docprocessing.html#COLLATE">collated</a>
documents), all heads, subheads, and paragraph heads, as well as any
endnotes pages that have been output, and assigned them the
appropriate page number (and page numbering style). Talk about a
no-brainer!
That said, tables of contents (tocs) have even more control macros
than endnotes. As always, the reason for so many control macros is
so that if you want to change just about any aspect of the toc's
typographic appearance, you can. <strong>Mom</strong> is all about
simplicity AND flexibility.
<p>
<a name="TOC_BEHAVIOUR"><h3><u>TOC behaviour</u></h3></a>
<p>
When you output a toc (with
<a href="#TOC">TOC</a>),
<strong>mom</strong> finishes processing the last page of your document,
then breaks to a new page for printing the toc.
<p>
<strong>Mom</strong> follows standard typesetting conventions for
tables of contents. To this end, if
<a href="headfootpage.html#HEADERS">HEADERS</a>
are on for the document, the first page of the toc has no page
header, but does have a first page (roman numeral) number, always
"1", in the bottom margin. If
<a href="headfootpage.html#FOOTERS">FOOTERS</a>
are on for the document, the first page has neither a footer, nor a
page number in the top margin. (If you absolutely must have a page
footer on the first page of the toc, simply invoke
<a href="headfootpage.html#FOOTER_ON_FIRST_PAGE">FOOTER_ON_FIRST_PAGE</a>
immediately before <strong>TOC</strong>.) Subsequent toc pages have
both page headers or footers and a page number.
<p>
Entries in the toc are hierarchically indented, as you would
expect. By default, each type of entry (e.g. a head or a subhead)
is set in a different font as well. If any of heads, subheads or
paragraph heads are numbered in the body of the document, they are
also numbered in the toc. Head numbering in the toc is NOT
concatenated as it is in the body of the document, which would be
visually redundant in a toc.
<p>
Tocs are never set in columns, regardless of whether the rest of
the document is. Lastly, if
<a href="rectoverso.html#RECTO_VERSO">recto/verso</a>
printing is enabled, the toc respects it. This sometimes leads to
tocs that begin with the wrong margins, but the margins can be
corrected either by outputting a
<a href="#BLANK_PAGE">BLANKPAGE</a>
or by using the toc control macro
<a href="#TOC_RV_SWITCH">TOC_RV_SWITCH</a>.
<p>
The overall toc
<a href="definitions.html#TERMS_FAMILY">family</a>,
<a href="definitions.html#TERMS_PS">point size</a>
and
<a href="definitions.html#TERMS_LEADING">lead</a>
can be altered with the toc
<a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>,
as can the family,
<a href="definitions.html#TERMS_FONT">font</a>,
point size and indent of each type of toc entry (i.e. title, head,
subhead, paragraph head). Furthermore, the page numbering style
can be changed, as can the amount of visual space reserved for toc
entry page numbers.
<p>
<!---TOC--->
<hr width="66%" align="left">
<p>
<a name="TOC">Macro: <strong>TOC</strong></a>
<p>
If you want a toc, just put <strong>TOC</strong> as the last macro
in a document. <strong>Mom</strong> takes care of the rest.
<p>
<hr width="66%" align="left">
<a name="TOC_CONTROL"><h3><u>TOC control macros</u></h3></a>
<p>
Toc entries are not actually processed when <strong>mom</strong>
collects them, so you can put any toc control macros anywhere you
like in your document. Some may prefer to place them at the top of
the file. Others may prefer to place them just before outputting
the toc. The choice is yours.
<br>
<ol>
<li><a href="#TOC_GENERAL"><strong>General toc page style control</strong></a>
<ul>
<li><a href="#TOC_FAMILY">Base family for toc pages</a>
<li><a href="#TOC_PT_SIZE">Base point size for toc pages</a>
<li><a href="#TOC_LEAD">Leading of toc pages</a>
</ul>
<li><a href="#TOC_PAGENUMBERING"><strong>Toc page numbering</strong></a>
<ul>
<li><a href="#PAGINATE_TOC">Turn toc pagination on or off</a>
<li><a href="#TOC_PAGENUM_STYLE">Toc page numbering style</a>
</ul>
<li><a href="#TOC_HEADER"><strong>Changing the toc header (title), string and style</strong></a>
<ul>
<li><a href="#TOC_HEADER_STRING">Changing the string (title)</a>
<li><a href="#TOC_HEADER_STYLE">Changing the string (title) style</a>
</ul>
<li><a href="#TOC_STYLE"><strong>Changing the style for toc entries</strong></a>
<ul>
<li><a href="#TOC_INDENT">The toc _INDENT control macros</a>
<li><a href="#TOC_TITLE">Changing the style for toc title entries</a>
<li><a href="#TOC_HEAD">Changing the style for toc head entries</a>
<li><a href="#TOC_SUBHEAD">Changing the style for toc subhead entries</a>
<li><a href="#TOC_PARAHEAD">Changing the style for toc paragraph head entries</a>
<li><a href="#TOC_PN">Changing the style for toc page number listings</a>
</ul>
<li><a href="#TOC_ADDITIONAL"><strong>Additional toc control macros</strong></a>
<ul>
<li><a href="#TOC_TITLE_ENTRY">Change the wording of a toc title entry</a>
<li><a href="#TOC_APPENDS_AUTHOR">Append author(s) to toc title entries</a>
<li><a href="#TOC_RV_SWITCH">TOC_RV_SWITCH</a>
<li><a href="#TOC_PADDING">TOC_PADDING</a>
</ul>
</ol>
<hr>
<a name="TOC_GENERAL"><h2><u>1. General toc page style control</u></h2>
<a name="TOC_FAMILY"><h3><u>*Toc family</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
Set the family of toc pages with <strong>TOC_FAMILY</strong>, which
establishes the default family for every element of a toc page,
including the toc title ("Contents") and the page number
in the top or bottom margin. The default is the prevailing document
family.
<p>
All elements on a toc page also have their own _FAMILY
control macros, which override the default set by
<strong>TOC_FAMILY</strong>.
<p>
<!---TOC_PT_SIZE--->
<a name="TOC_PT_SIZE"><h3><u>*Toc point size</u></h3></a>
<p>
<nobr>Macro: <strong>TOC_PT_SIZE</strong> <base type size of the toc></nobr>
<p>
Unlike most other control macros that deal with size of document
elements, <strong>TOC_PT_SIZE</strong> takes as its argument an
absolute value, relative to nothing. Therefore, the argument
represents the size of toc type in
<a href="definitions.html#TERMS_PICASPOINTS">points</a>,
unless you append an alternative
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
For example,
<p>
<pre>
.TOC_PT_SIZE 12
</pre>
sets the base point size of type for the toc to 12 points, whereas
<p>
<pre>
.TOC_PT_SIZE .6i
</pre>
sets the base point size of type for the toc to 1/6 of an inch.
<p>
The type size set with <strong>TOC_PT_SIZE</strong> forms the basis
from which the point size of other toc page elements are calculated.
<p>
The default for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
is 12.5 points (the same default size used in the body of the
document).
<p>
<!---TOC_LEAD--->
<a name="TOC_LEAD"><h3><u>*Toc lead</u></h3></a>
<p>
<nobr>Macro: <strong>TOC_LEAD</strong> <leading of the toc> [ ADJUST ]</nobr>
<br>
<em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
<p>
Unlike most other control macros that deal with leading of document
elements, <strong>TOC_LEAD</strong> takes as its argument an
absolute value, relative to nothing. Therefore, the argument
represents the
<a href="definitions.html#TERMS_LEADING">leading</a>
of tocs in
<a href="definitions.html#TERMS_PICASPOINTS">points</a>
unless you append an alternative
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
For example,
<p>
<pre>
.TOC_LEAD 14
</pre>
sets the base leading of type on the endnotes page to 14
points, whereas
<p>
<pre>
.TOC_LEAD .5i
</pre>
sets the base leading of type on the endnotes page to 1/2 inch.
<p>
If you want the leading of toc pages adjusted to fill the
page, pass <strong>TOC_LEAD</strong> the optional argument
<strong>ADJUST</strong>. (See
<a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
for an explanation of leading adjustment.)
<p>
The default for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
is the prevailing document lead (16 by default), adjusted.
<p>
<strong>NOTE:</strong> Even if you give <strong>mom</strong> a
<strong>DOC_LEAD_ADJUST OFF</strong> command, she will still, by
default, adjust toc leading. You MUST enter
<strong>TOC_LEAD <lead></strong> with no
<strong>ADJUST</strong> argument to disable this default behaviour.
<p>
<strong>ADDITIONAL NOTE:</strong> Tocs are always double-spaced in
<strong>PRINTSTYLE TYPEWRITE</strong>, regardless of whether the
body of the document is single-spaced.
<a name="TOC_PAGENUMBERING"><h2><u>2. Toc page numbering</u></h2></a>
<p>
The page numbering of toc pages is controlled by the same macros
that control
<a href="headfootpage.html#PAGINATION">document page numbering</a>,
except
<a href="headfootpage.html#PAGENUM">PAGENUM</a>
(tocs always start on page 1). The defaults are the same as the
rest of the document.
<p>
If you wish to change some aspect of toc pagination, use the
document pagination control macros immediately prior to
<strong>.TOC</strong>.
<p>
A special macro,
<a href="#TOC_PAGENUM_STYLE">TOC_PAGENUM_STYLE</a>
controls the style of toc pages page numbers.
<p>
<hr width="33%" align="left">
<!---PAGINATE_TOC--->
<p>
<a name="PAGINATE_TOC">
<nobr>Macro: <strong>PAGINATE_TOC</strong> <toggle></nobr>
</a>
<p>
By default, <strong>mom</strong> paginates the toc. If you'd like
her not to, do
<p>
<pre>
.PAGINATE_TOC OFF
</pre>
<strong>NOTE:</strong> Simply invoking <strong>PAGINATION
OFF</strong> or <strong>PAGINATE OFF</strong> disables toc
pagination <em>for the first toc page only.</em> You MUST use
<strong>.PAGINATE_TOC OFF</strong> to disable toc pagination, even
if pagination is turned off elsewhere in your document.
<p>
<hr width="33%" align="left">
<p>
<!---TOC_PAGENUM_STYLE--->
<a name="TOC_PAGENUM_STYLE">
<nobr>Macro: <strong>TOC_PAGENUM_STYLE</strong> <DIGIT | ROMAN | roman | ALPHA | alpha></nobr>
</a>
<p>
By default, <strong>mom</strong> uses roman numerals to number
toc pages. Use <strong>TOC_PAGENUM_STYLE</strong> if you'd prefer
something else. For example, to have standard digits instead of
roman numerals, do the following:
<p>
<pre>
.TOC_PAGENUM_STYLE DIGIT
</pre>
<hr width="33%" align="left">
<a name="TOC_HEADER"><h2><u>3. Changing the toc header (title) string and style</u></h2></a>
<p>
The toc header string is the title that appears at to top of the
toc. By default, it's "Contents". If you'd like
something else, say, "Table of Contents", do
<p>
<a name="TOC_HEADER_STRING"></a>
<pre>
.TOC_HEADER_STRING "Table of Contents"
</pre>
<a name="TOC_HEADER_STYLE"></a>
The style of the toc header (title) is managed by the usual control
macros (see
<a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
<p>
<pre>
.TOC_HEADER_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
.TOC_HEADER_FONT default = bold
.TOC_HEADER_SIZE default = +4
.TOC_HEADER_QUAD default = left
</pre>
<a name="TOC_STYLE"><h2><u>4. Changing the style for toc entries</u></h2></a>
<p>
"Toc entries" refers to titles, heads, subheads and
paragraph heads as they appear in the toc. Their style is managed
by the usual
<a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>,
starting with TOC_
<p>
<a name="TOC_INDENT"><h3><u>The toc _INDENT control macros</u></h3></a>
<p>
The toc control macros that end in _INDENT all take a single
argument that requires a
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
The argument is the distance to indent the entry, always measured
from the left margin. For example,
<p>
<pre>
.TOC_HEAD_INDENT 2P
</pre>
indents head entries 2
<a href="definitions.html#TERMS_PICASPOINTS">picas</a>
from the left margin.
<p>
<a name="TOC_TITLE"><h3><u>*Changing the style for toc title entries</u></h3></a>
<p>
(See
<a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
<p>
Toc title entries are the titles of documents that have been
<a href="rectoverso.html#COLLATE">collated</a>
together.
<p>
<pre>
.TOC_TITLE_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
.TOC_TITLE_FONT default = bold italic
.TOC_TITLE_SIZE default = +0
.TOC_TITLE_INDENT default = 0 for TYPESET and TYPEWRITE
</pre>
<a name="TOC_HEAD"><h3><u>*Changing the style for toc head entries</u></h3></a>
<p>
(See
<a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
<p>
Toc head entries are main heads that appear in the body of a
document.
<p>
<pre>
.TOC_HEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
.TOC_HEAD_FONT default = bold
.TOC_HEAD_SIZE default = +.5
.TOC_HEAD_INDENT default = 18p for TYPESET; 2m for TYPEWRITE
</pre>
<a name="TOC_SUBHEAD"><h3><u>*Changing the style for toc subhead entries</u></h3></a>
<p>
(See
<a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
<p>
Toc subhead entries are subheads that appear in the body of a
document.
<p>
<pre>
.TOC_SUBHEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
.TOC_SUBHEAD_FONT default = roman
.TOC_SUBHEAD_SIZE default = +0
.TOC_SUBHEAD_INDENT default = 30p for TYPESET; 4m for TYPEWRITE
</pre>
<a name="TOC_PARAHEAD"><h3><u>*Changing the style for toc paragraph head entries</u></h3></a>
<p>
(See
<a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
<p>
Toc paragraph head entries are paragraph heads that appear in the
body of a document.
<p>
<pre>
.TOC_PARAHEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
.TOC_PARAHEAD_FONT default = italic
.TOC_PARAHEAD_SIZE default = +0
.TOC_PARAHEAD_INDENT default = 42p for TYPESET; 6m for TYPEWRITE
</pre>
<a name="TOC_PN"><h3><u>*Changing the style for toc paragraph page number listings</u></h3></a>
<p>
(See
<a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
<p>
Toc paragraph head entries are paragraph heads that appear in the
body of a document.
<p>
<pre>
.TOC_PN_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
.TOC_PN_FONT default = roman
.TOC_PN_SIZE default = +0
</pre>
<a name="TOC_ADDITIONAL"><h2><u>5. Additional toc macros</u></h2></a>
<p>
The following macros allow you to switch page margins should
they be incorrect for recto/verso printing, to establish how
many placeholders to leave for page listings, and to have
<strong>mom</strong> append author(s) to toc title entries.
<p>
<hr width="33%" align="left">
<!---TOC_RV_SWITCH--->
<p>
<a name="TOC_RV_SWITCH">
Macro: <strong>TOC_RV_SWITCH</strong>
</a>
<p>
<strong>TOC_RV_SWITCH</strong> doesn't take an argument. It simply
instructs <strong>mom</strong> to switch the left and right margins
of
<a href="rectoverso.html#RECTO_VERSO">recto/verso</a>
documents should the toc happen to begin on an even page when you
want an odd, or vice versa.
<p>
The same result can be accomplished by outputting a
<a href="#BLANK_PAGE">BLANKPAGE</a>.
<p>
<hr width="33%" align="left">
<!---TOC_TITLE_ENTRY--->
<p>
<a name="TOC_TITLE_ENTRY">
<nobr>Macro: <strong>TOC_TITLE_ENTRY</strong> <"alternate wording for a title entry in the toc"></nobr>
</a>
<p>
In
<a href="rectoverso.html#COLLATE">collated</a>
documents, the title of each separate document appears in the table
of contents. It may sometimes happen that you don't want the title
as it appears in the toc to be the same as what appears in
the
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>.
You might, for example, want to shorten it. Or, in the case of
chapters where the docheader contains both a chapter number and a
chapter title, like this
<p>
<pre>
Chapter 6
Burning Bush -- Maybe God Was Right
</pre>
you might want only the chapter title, not the chapter number, to
show up in the toc. (By default, <strong>TOC</strong> generates
both.)
<p>
If you want to change the wording of a title entry in the toc,
simply invoke <strong>TOC_TITLE_ENTRY</strong> with the desired
wording, enclosed in double-quotes. Using the example, above,
<p>
<pre>
.CHAPTER 6
.CHAPTER_TITLE "Burning Bush -- Maybe God Was Right"
.TOC_TITLE_ENTRY "Burning Bush"
.DOCTYPE CHAPTER
</pre>
would identify chapter 6 in the toc simply as "Burning
Bush".
<p>
<hr width="33%" align="left">
<!---TOC_APPENDS_AUTHOR--->
<p>
<a name="TOC_APPENDS_AUTHOR">
<nobr>Macro: <strong>TOC_APPENDS_AUTHOR</strong> <none> | <"name(s) of authors"></nobr>
</a>
<p>
In certain kinds of collated documents, different authors are
responsible for the articles or stories contained within them. In
such documents, you may wish to have the author or authors
appended to the toc's title entry for each story or article.
<p>
If you invoke <strong>TOC_APPENDS_AUTHOR</strong> with no argument,
<strong>mom</strong> appends the first argument you passed to
<a href="docprocessing.html#AUTHOR">AUTHOR</a>
to toc title entries, separated by a front-slash.
<p>
If you invoke <strong>TOC_APPENDS_AUTHOR</strong> with an argument
(surrounded by double-quotes), <strong>mom</strong> will append it
to the toc title entries instead. This is useful if you have
multiple authors you wish to identify by last name only. For
example, if three authors--Joe Blough, Jane Doe, and John
Deere--are responsible for a single article
<p>
<pre>
.TOC_APPENDS_AUTHOR "Blough et al."
</pre>
would be a good way to identify them in the toc.
<p>
<hr width="33%" align="left">
<!---TOC_PADDING--->
<p>
<a name="TOC_PADDING">
<nobr>Macro: <strong>TOC_PADDING</strong> <# of placeholders to allow for page number listings></nobr>
</a>
<p>
By default, <strong>mom</strong> allows room for 3 digits in the
page number listings of tocs. If you'd like some other number of
placeholders, say 2, do
<p>
<pre>
.TOC_PADDING 2
</pre>
<!---FINIS--->
<hr width="66%" align="left">
<p>
<a name="FINIS">
Macro: <strong>FINIS</strong>
</a>
<p>
The use of <strong>FINIS</strong> is optional, but if you use
it, it should be the last macro you invoke in a document (before
<a href="#ENDNOTES">ENDNOTES</a>
or
<a href="#TOC">TOC</a>).
See
<a href="#FINIS_INTRO">above</a>
for a description of how <strong>FINIS</strong> behaves.
<p>
<strong>NOTE:</strong> If you don't use <strong>FINIS</strong>,
and you don't want
<a href="definitions.html#TERMS_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:
<p>
<pre>
.FOOTERS OFF
.PAGINATE OFF
</pre>
<a name="FINIS_STRING"><h3><u>Changing the FINIS string</u></h3></a>
<p>
By default, <strong>FINIS</strong> prints the word
END between
<a href="definitions.html#TERMS_EM">em-dashes</a>.
If you'd like <strong>mom</strong> to print something else
between the dashes, use the <strong>FINIS_STRING</strong> macro
(anywhere in the document prior to <strong>FINIS</strong>).
<p>
For example, if your document's in French, you'd do
<p>
<pre>
.FINIS_STRING "FIN"
</pre>
Double-quotes must enclose the macro's argument.
<p>
<strong>NOTE:</strong> If you pass <strong>FINIS_STRING</strong>
a blank string, i.e.
<p>
<pre>
.FINIS_STRING ""
</pre>
<strong>mom</strong> will still print the em-dashes if you
invoke <strong>FINIS</strong>. This, in effect, produces a
short, centred horizontal rule that terminates the document.
(In
<a href="docprocessing.html.#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
it's a short, dashed line composed of four hyphens.)
<a name="FINIS_COLOR"><h3><u>Changing the FINIS colour</u></h3></a>
<p>
Invoking <strong>FINIS_COLOR</strong> with a pre-defined (or
"initalized") color changes the colour of both the FINIS
string and the em-dashes that surround it. If you use the
<a href="definitions.html#TERMS_INLINE">inline escape</a>,
<a href="color.html#COLOR_INLINE">\*[<colorname>]</a>,
in the argument passed to <strong>FINIS</strong>, only the text
will be in the new colour; the em-dashes will be in the default
document colour (usually black).
<p>
<hr>
<a href="headfootpage.html#TOP">Next</a>
<a href="docprocessing.html#TOP">Prev</a>
<a href="#TOP">Top</a>
<a href="toc.html">Back to Table of Contents</a>
</body>
</html>
|
