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
|
<?xml version="1.0" encoding="utf-8"?>
<!--
This file is part of groff, the GNU roff type-setting system.
Copyright (C) 2004, 2005, 2006, 2009, 2010,
2011, 2012, 2013 Free Software Foundation, Inc.
Written by Peter Schaffter (peter@schaffter.ca).
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being this comment section, with no Front-Cover
Texts, and with no Back-Cover Texts.
A copy of the Free Documentation License is included as a file called
FDL in the main directory of the groff source package.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
<title>Mom -- Document Processing, Introduction and Setup</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" />
</head>
<body style="background-color: #f5faff;">
<!-- ==================================================================== -->
<div id="top" class="page">
<!-- Navigation links -->
<table style="width: 100%;">
<tr>
<td><a href="toc.html">Back to Table of Contents</a></td>
<td style="text-align: right;"><a href="docelement.html#top">Next: The document element tags</a></td>
</tr>
</table>
<h1 class="docs">Document processing with mom</h1>
<div style="text-align: center;">
<ul class="no-enumerator" style="margin-left: -2.5em;">
<li><a href="#defaults">Document defaults</a></li>
<li><a href="#leading-note">Important note on leading/spacing and bottom margins</a></li>
<li><a href="#shim">The SHIM macro</a></li>
</ul>
</div>
<div class="rule-medium"><hr/></div>
<h2 id="toc-doc-processing" class="docs" style="text-align: center;">Table of contents</h2>
<div id="docprocessing-mini-toc" style="font-size: 90%; line-height: 150%; margin-top: .5em;">
<div class="mini-toc-col-1" style="margin-left: 0;">
<h3 class="toc toc-docproc-header" style="margin-top: 1em;"><a class="header-link" href="#docprocessing-intro">Introduction</a></h3>
<h3 class="toc toc-docproc-header" style="margin-top: .5em;"><a
class="header-link" href="#setup">Preliminary document setup</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#docprocessing-tut"><b>Tutorial – Setting up a mom document</b></a></li>
<li><a href="#reference-macros"><b>The reference macros (metadata)</b></a>
<ul class="toc-docproc">
<li><a href="#title">TITLE</a></li>
<li><a href="#doc-title">DOCTITLE</a></li>
<li><a href="#subtitle">SUBTITLE</a></li>
<li><a href="#author">AUTHOR</a></li>
<li><a href="#chapter">CHAPTER</a></li>
<li><a href="#chapter-title">CHAPTER_TITLE</a></li>
<li><a href="#draft">DRAFT</a></li>
<li><a href="#revision">REVISION</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
<li><a href="#misc">MISC</a></li>
<li><a href="#covertitle">COVERTITLE</a></li>
<li><a href="#doc-covertitle">DOC_COVERTITLE</a></li>
<li><a href="#pdftitle">PDF_TITLE</a></li>
</ul></li>
<li><a href="#docstyle-macros"><b>The docstyle macros (templates)</b></a>
<ul class="toc-docproc">
<li><a href="#doctype">DOCTYPE</a></li>
<li><a href="#printstyle">PRINTSTYLE</a></li>
<li><a href="#copystyle">COPYSTYLE</a></li>
</ul></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#start-macro">Initiate document processing</a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#start"><b>The START macro</b></a></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#style-before-start">Establishing type and formatting<br/><span style="display: block; margin-top: -.3em;">parameters before START</span></a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#type-before-start"><b>Behaviour of the typesetting macros before START</b></a>
<ul class="toc-docproc">
<li><a href="docprocessing.html#include">Including (sourcing) style sheets and files</a></li>
<li><a href="#color">Initializing colours</a></li>
</ul></li>
</ul>
</div>
<div class="mini-toc-col-2" style="margin-top: -.5em;">
<br/>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#doc-lead-adjust"><b>Adjust linespacing to fill pages</b></a>
<ul class="toc-docproc">
<li><a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a></li>
<li><a href="#shim">SHIM</a> – get document leading back on track
<ul>
<li><a href="#automatic-shimming">Automatic shimming (headings, etc)</a></li>
</ul></li>
</ul></li>
<li><a href="#docheader"><b>Managing the document header</b></a>
<ul class="toc-docproc">
<li><a href="#docheader">DOCHEADER</a></li>
<li><a href="#docheader-control">Docheader control</a>
<ul class="toc-docproc">
<li><a href="#docheader-desc">Docheader description</a></li>
<li><a href="#index-docheader-control">Macro list</a></li>
</ul></li>
</ul></li>
<li><a href="#columns-intro"><b>Setting documents in columns</b></a>
<ul class="toc-docproc">
<li><a href="#columns">COLUMNS</a></li>
<li><a href="#breaking-columns">Breaking columns manually</a>
<ul class="toc-docproc">
<li><a href="#col-next">COL_NEXT</a></li>
<li><a href="#col-break">COL_BREAK</a></li>
</ul></li>
</ul></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#style-after-start">Changing basic type and formatting<br/><span style="display: block; margin-top: -.3em;">parameters after START</span></a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#behaviour"><b>Behaviour of the typesetting macros during document processing</b></a></li>
<li><a href="docprocessing.html#index-doc-param"><b>Post-START global style change macros</b></a>
<ul class="toc-docproc">
<li><a href="#doc-left-margin">DOC_LEFT_MARGIN</a></li>
<li><a href="#doc-right-margin">DOC_RIGHT_MARGIN</a></li>
<li><a href="#doc-line-length">DOC_LINE_LENGTH</a></li>
<li><a href="#doc-family">DOC_FAMILY</a></li>
<li><a href="#doc-pt-size">DOC_PT_SIZE</a></li>
<li><a href="#doc-lead">DOC_LEAD</a></li>
<li><a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a></li>
<li><a href="#doc-quad">DOC_QUAD</a></li>
</ul></li>
</ul>
<h3 class="toc toc-docproc-header"><a class="header-link" href="#terminating">Terminating a document</a></h3>
</div>
</div>
<div class="rule-medium" style="clear: both;"><hr/></div>
<!-- ==================================================================== -->
<h2 id="docprocessing-intro" class="docs">Introduction to document processing</h2>
<p>
Document processing with mom uses markup tags to identify document elements
such as headings, paragraphs, blockquotes, and so on. The tags are, of course,
macros, but with sensible, readable names that make them easy
to grasp and easy to remember. (And don’t forget: if you
don’t like the “official” name of a tag —
too long, cumbersome to type in, not “intuitive” enough
— you can change it with the
<a href="goodies.html#alias">ALIAS</a>
macro.)
</p>
<p>
In addition to the tags themselves, mom has an extensive array of
macros that control how they look and behave.
</p>
<p>
Setting up a mom doc is a simple, four-part procedure. You
begin by entering metadata about the document itself (title,
subtitle, author, etc.). Next, you tell mom what kind of document
you’re creating (eg chapter, letter, abstract, etc...) and
what kind of output you want (typeset, typewritten, draft-style,
etc) — essentially, templates. Thirdly, you make as many
or as few changes to the templates as you wish; in other words,
create a style sheet. Lastly, you invoke the
<kbd><a href="#start">START</a></kbd>
macro. Voilà ! You’re ready to write.
</p>
<!-- ==================================================================== -->
<h2 id="defaults" class="docs">Document defaults</h2>
<p>
As is to be expected, mom has defaults for everything. If you want
to know a particular default, read about it in the description of
the pertinent tag.
</p>
<p>
I fear the following may not be adequately covered in the
documentation, so just in case:
</p>
<ul style="margin-top: -.5em; margin-bottom: .5em;">
<li>the paper size is 8.5x11 inches</li>
<li>the left and right margins are 1-inch</li>
<li>the top and bottom margins for document text are plus/minus
visually 1-inch
</li>
<li>pages are numbered; the number appears centred, at the
bottom, surrounded by hyphens ( eg -6- )
</li>
<li>the first page of a document begins with a
<a href="definitions.html#docheader">document header</a>
</li>
<li>subsequent pages have
<a href="definitions.html#header">page headers</a>
with a rule underneath
</li>
</ul>
<!-- ==================================================================== -->
<h2 id="leading-note" class="docs">Important note on leading/spacing and bottom margins</h2>
<p>
Mom takes evenly-aligned bottom margins in
<a href="definitions.html#running">running text</a>
very seriously. Only under a very few (exceptional) circumstances
will she allow a bottom margin to “hang” (ie to fall
short).
</p>
<p>
In order to ensure even bottom margins, mom uses the
“base” document
<a href="definitions.html#leading">leading</a>
in effect <i>at the start of running text on each page</i> (ie
the leading used in paragraphs) to calculate the spacing of every
document element. Prior to invoking
<a href="#start">START</a>,
this is set with the
<a href="typesetting.html#macros-typesetting">typesetting macro</a>
<a href="typesetting.html#leading">LS</a>,
afterwards with the document
<a href="definitions.html#controlmacro">control macro</a>
<a href="#doc-lead">DOC_LEAD</a>.
</p>
<p>
Because mom relies so heavily on the base document
leading, any change to the leading or spacing on a page will almost
certainly have undesirable consequences on that page’s bottom margin
unless the change is fully compensated for elsewhere on the page.
</p>
<p>
In other words, if you add a few points of space somewhere on a page,
you must subtract the same number of points somewhere else on that
same page, and vice versa.
</p>
<p>
If it’s a question of adding or subtracting full
line spaces between or within document elements, you
can do so by using the “<kbd>v</kbd>” <a
href="definitions.html#unitofmeasure">unit of measure</a> with
whatever spacing macro you choose —
<a href="typesetting.html#ald">ALD</a>,
<a href="typesetting.html#rld">RLD</a>,
<a href="typesetting.html#space">SPACE</a>
— and mom won’t object. “<kbd>v</kbd>” means
“the current leading”, so she isn’t confused by it. And
since “<kbd>v</kbd>” accepts decimal fractions, you can add/subtract
half linespaces and quarter linespaces with “<kbd>v</kbd>” as well,
<i>provided you compensate for the fractional linespace somewhere
else on the page</i>.
</p>
<p>
If all this seems like too much work, mom provides a special macro
to get you out of trouble if you’ve played around with leading
and/or spacing. The macro is called SHIM (like those little pieces
of wood carpenters use to get their work even, level and snug), and
it’s described below.
</p>
<!-- -SHIM- -->
<div class="macro-id-overline">
<h3 id="shim" class="macro-id">SHIM</h3>
</div>
<div class="box-macro-args">
Macro: <b>SHIM</b>
</div>
<p>
SHIM doesn’t take any argument. Use it whenever you’ve played
around with the
<a href="definitions.html#leading">leading</a>
or spacing on a page and you need to get mom’s document
leading back on track.
</p>
<p>
For example, say you want to insert an image into a document with
<a href="images.html#pdf-image">PDF_IMAGE</a>
or
<a href="images.html#pspic">PSPIC</a>.
</p>
<p>
Images and graphics aren’t usually conveniently sized in
multiples of the document leading, which means that when you insert
the picture, you disrupt mom’s ordered placement of baselines
on the page. This will certainly result in a bottom margin that
doesn’t match the bottom margins of your document’s
other pages.
</p>
<p>
The solution is to insert SHIM after the image, like this:
<br/>
<span class="pre-in-pp">
<text>
.PDF_IMAGE <args> <span style="font-family: arial,sans-serif; font-weight: normal;">or</span> .PSPIC <args>
.SHIM
<text>
</span>
</p>
<p>
SHIM instructs mom to insert as much or a little space after the
picture as is needed to ensure that the baseline of the next
<a href="definitions.html#outputline">output line</a>
falls where mom would have put it had you not disrupted the normal
flow of output lines with the picture.
</p>
<p>
And say, on previewing the above example, you find the image
doesn’t centre nicely between the lines of text, you can
adjust the image position either by passing a baseline adjustment
to PDF_IMAGE, or by using
<a href="typesetting.html#ald">ALD</a>
or
<a href="typesetting.html#rld">RLD</a>
before PSPIC. To demonstrate,
<br/>
<span class="pre-in-pp">
<text>
.PDF_IMAGE <args> -3p
.SHIM
<text>
</span>
and
<span class="pre-in-pp">
<text>
.RLD 3p
.PSPIC <args>
.SHIM
<text>
</span>
both raise an image slightly within the space allotted for it while
ensuring that text underneath falls exactly where should.
</p>
<h4 id="automatic-shimming" class="docs">Automatic shimming of headings, quotes, blockquotes, PDF images, and floats</h4>
<p style="margin-bottom: -1em">
By default, mom automatically applies shimming
</p>
<ul>
<li><i>before</i> headings</li>
<li><i>around</i> quotes and blockquotes</li>
<li><i>after</i> PDF images and floats</li>
</ul>
<p>
In documents where paragraphs are not spaced, automatic shimming is
almost always desirable. In documents where paragraphs are spaced
by an amount less than the document leading, or which have numerous
graphics, headings, and quotes, you may want to disable shimming,
either globally or on a tag-by-tag basis.
</p>
<p id="disable-shim">
<span style="font-weight: bold; font-style: italic; font-size: 95%">To disable
automatic shimming</span>, invoke the macro, <kbd>.NO_SHIM</kbd>,
either in the style sheet section of your document (ie after
<a href="#printstyle">PRINTSTYLE</a>
and before
<a href="#start">START</a>),
or just before
<a href="docelement.html#heading">HEADING</a>,
<a href="docelement.html#quote">QUOTE</a>,
<a href="docelement.html#blockquote">BLOCKQUOTE</a>,
<a href="images.html#pdf-image">PDF_IMAGE</a>
or
<a href="images.html#float">FLOAT</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<kbd>.NO_SHIM</kbd> also disables the SHIM macro itself.
</p>
</div>
<p>To re-enable automatic shimming and the SHIM macro itself, use
<kbd>.NO_SHIM OFF</kbd> (or <kbd>QUIT, END, X</kbd>, etc).
</p>
<div class="rule-short"><hr/></div>
<!-- ==================================================================== -->
<h2 id="setup" class="docs" style="margin-bottom: .5em;">Preliminary document setup</h2>
<div class="examples-container" style="margin-bottom: 1.5em;">
<h3 id="docprocessing-tut" class="docs">Tutorial – Setting up a mom document</h3>
<p style="margin-top: 1em;">
There are four parts to setting up a mom doc (three, actually,
with one optional). Before we proceed, though, be reassured that
something as simple as
<br/>
<span class="pre-in-pp">
.TITLE "By the Shores of Lake Attica"
.AUTHOR "Rosemary Winspeare"
.PRINTSTYLE TYPESET
.START
</span>
produces a beautifully typeset 8.5x11 document, with a
<a href="definitions.html#docheader">docheader</a>
at the top of page 1,
<a href="definitions.html#header">page headers</a>
with the title and author on subsequent pages, and page numbers at
the bottom of each page. In the course of the document, headings,
citations, quotes, epigraphs, and so on, all come out looking neat,
trim, and professional.
</p>
<p>
For the purposes of this tutorial, we’re going to set up
a short story—<i>My Pulitzer Winner</i>—by Joe Blow.
Thankfully, we don’t have to look at story itself, just the
setup. Joe wants the document
</p>
<ul style="margin-top: -.5em; margin-bottom: -.5em;">
<li>to be draft 7, revision 39;</li>
<li>to use the DEFAULT template;</li>
<li>to print as draft-style output (instead of final-copy output);</li>
<li>to be typeset, in Helvetica, 12 on 14,
<a href="definitions.html#rag">rag-right</a>;
</li>
<li>to have <a href="definitions.html#footer">footers</a>
instead of
<a href="definitions.html#header">headers</a>;
</li>
<li>to use a single asterisk for
<a href="definitions.html#linebreak">author linebreaks</a>.
</li>
</ul>
<p>
Joe Blow has no taste in typography. His draft won’t look
pretty, but this is, after all, a tutorial; we’re after
examples, not beauty.
</p>
<h4 class="docs" style="margin-top: -.5em;">Step 1</h4>
<p style="margin-bottom: -.5em;">
The first step in setting up any document is giving mom some
reference information (metadata). The reference macros are:
</p>
<div style="width: 50%; float: left;">
<ul>
<li>TITLE</li>
<li>SUBTITLE</li>
<li>AUTHOR</li>
<li>CHAPTER – chapter number</li>
<li>CHAPTER_TITLE – chapter name</li>
<li>DRAFT – the draft number</li>
<li>REVISION – the revision number</li>
</ul>
</div>
<div>
<ul>
<li>COPYRIGHT – only used on cover pages</li>
<li>MISC – only used on cover pages</li>
<li>DOCTITLE</li>
<li>COVERTITLE</li>
<li>DOC_COVERTITLE</li>
<li>PDF_TITLE</li>
</ul>
</div>
<p style="margin-top: -.5em; clear: both;">
You can use as many or as few as you wish, although at a minimum,
you’ll probably fill in TITLE (unless the document’s a
letter) and AUTHOR. Order doesn’t matter. You can separate
the
<a href="definitions.html#arguments">arguments</a>
from the macros by any number of spaces. The following are what
you’d need to start Joe Blow’s story.
<br/>
<span class="pre-in-pp">
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
</span>
</p>
<h4 class="docs" style="margin-top: -1.5em;">Step 2</h4>
<p>
Once you’ve given mom the reference information she needs, you
tell her how you want your document formatted. What kind of
document is it? Should it be typeset or typewritten? Is this a
final copy (for the world to see) or just a draft? Mom calls
the macros that answer these questions “the docstyle
macros.”, and they're essentially templates.
</p>
<ul style="margin-top: -.5em; margin-bottom: -.5em;">
<li>PRINTSTYLE—typeset or typewritten</li>
<li>DOCTYPE—the type of document (default, chapter, user-defined, letter)</li>
<li>COPYSTYLE —draft or final copy</li>
</ul>
<p>
Mom has defaults for DOCTYPE and COPYSTYLE; if they’re what
you want, you don’t need to include them. However,
PRINTSTYLE has no default and must be present in every formatted
document. If you omit it, mom won’t process the document
AND she’ll complain (both to stderr and as a single printed
sheet with a warning). Moms—they can be so annoying
sometimes. <sigh>
</p>
<p>
Adding to what we already have, the next bit of setup for Joe
Blow’s story looks like this:
<br/>
<span class="pre-in-pp">
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.DOCTYPE DEFAULT \"Superfluous; mom uses DOCTYPE DEFAULT by default
.PRINTSTYLE TYPESET
.COPYSTYLE DRAFT
</span>
Notice the use of the
<a href="definitions.html#commentlines">comment line</a>
( <kbd>\#</kbd> ), a handy way to keep groups of macros visually
separated for easy reading in a text editor.
</p>
<h4 class="docs" style="margin-top: -.5em; margin-bottom: -.5em;">Step 3</h4>
<p>
This step—completely optional—is where you, the user,
take charge. Mom has reasonable defaults for every document element
and tag, but who’s ever satisfied with defaults? Use any of
the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>
here to change mom’s document defaults (paper size, margins,
family, point size, line space, rag, etc), or use any of the
document processing
<a href="definitions.html#controlmacro">control macros</a>.
This is the style-sheet section of a document, and
must come after the
<a href="#printstyle">PRINTSTYLE</a>
directive. Failure to observe this condition will result in
PRINTSTYLE overriding your changes.
</p>
<p>
Joe Blow wants his story printed in Helvetica, 12 on 14, rag right,
with
<a href="definitions.html#footer">page footers</a>
instead of
<a href="definitions.html#header">page headers</a>
and a single asterisk for the
<a href="definitions.html#linebreak">linebreak</a>
character. None of these requirements conforms to mom’s
defaults for the chosen PRINTSTYLE (TYPESET), so we change them
here. The setup for Joe Blow’s story now looks like this:
<br/>
<span class="pre-in-pp">
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.DOCTYPE DEFAULT
.PRINTSTYLE TYPESET
.COPYSTYLE DRAFT
\#
.FAMILY H
.PT_SIZE 12
.LS 14
.QUAD LEFT \"ie rag right
.FOOTERS
.LINEBREAK_CHAR *
</span>
</p>
<h4 class="docs" style="margin-top: -1.5em; margin-bottom: -.5em;">Step 4</h4>
<p>
The final step in setting up a document is telling mom to start
document processing. It’s a no-brainer, just the single
macro, START. Other than PRINTSTYLE, it’s the only macro
required for document processing.
</p>
<p>
Here’s the complete setup for <i>My Pulitzer Winner</i>:
<br/>
<span class="pre-in-pp">
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.DOCTYPE DEFAULT
.PRINTSTYLE TYPESET
.COPYSTYLE DRAFT
\#
.FAMILY H
.PT_SIZE 12
.LS 14
.QUAD LEFT \"ie rag right
.FOOTERS
.LINEBREAK_CHAR *
\#
.START
</span>
As pointed out earlier, Joe Blow is no typographer. Given that all he
needs is a printed draft of his work, a simpler setup would have been:
<br/>
<span class="pre-in-pp">
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.PRINTSTYLE TYPEWRITE
.COPYSTYLE DRAFT
\#
.START
</span>
<kbd>.PRINTSTYLE TYPEWRITE</kbd>, above, means that Joe’s
work will come out “typewritten, double-spaced”,
making the blue-pencilling he (or someone else) is sure to do much
easier (which is why many publishers and agents still insist on
typewritten, double-spaced copy).
</p>
<p>
When J. Blow stops re-writing and decides to print off a final,
typeset copy of his work for the world to see, he need only make two
changes to the (simplified) setup:
<br/>
<span class="pre-in-pp">
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.PRINTSTYLE TYPESET \"first change
.COPYSTYLE FINAL \"second change
\#
.START
</span>
In the above, <kbd>.DRAFT 7, .REVISION 39,</kbd> and
<kbd>.COPYSTYLE FINAL</kbd> are actually superfluous. The draft
and revision numbers aren’t used when COPYSTYLE is FINAL,
and <b>COPYSTYLE FINAL</b> is mom’s default unless you tell
her otherwise.
</p>
<p>
But... to judge from the number of drafts already,
J. Blow may very well decide his “final” version still
isn’t up to snuff. Hence, he might as well leave in the
superfluous macros. That way, when draft 7, rev. 62 becomes draft
8, rev. 1, he’ll be ready to tackle his Pulitzer winner again.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ======================================================================== -->
<h2 id="reference-macros" class="macro-group">The reference macros (metadata)</h2>
<p>
The reference macros give mom the metadata she needs to generate
<a href="definitions.html#docheader">docheaders</a>,
<a href="definitions.html#header">page headers</a>,
and
<a href="cover.html#cover-top">covers</a>.
They must go at the top of any file that uses mom’s document
processing macros.
</p>
<div class="macro-list-container">
<h3 id="index-reference" class="macro-list">Reference macros</h3>
<ul class="macro-list">
<li><a href="#title">TITLE</a> – title of a story, article, etc</li>
<li><a href="#doc-title">DOCTITLE</a> – title of a book, or any collated document</li>
<li><a href="#subtitle">SUBTITLE</a></li>
<li><a href="#author">AUTHOR</a></li>
<li><a href="#chapter">CHAPTER</a> – the chapter number
<ul>
<li class="sublist"><a href="#chapter-string">CHAPTER_STRING</a> – “Chapter”, “CHAPTER”, “Chapître”, etc</li>
</ul></li>
<li><a href="#chapter-title">CHAPTER_TITLE</a></li>
<li><a href="#draft">DRAFT</a>
<ul>
<li class="sublist"><a href="#draft-string">DRAFT_STRING</a> – “Draft”, “DRAFT”, “Jet”, etc</li>
</ul></li>
<li><a href="#revision">REVISION</a>
<ul>
<li class="sublist"><a href="#revision-string">REVISION_STRING</a> – “Revision”, “Rev.”, “Révision”, etc</li>
</ul></li>
<li><a href="#copyright">COPYRIGHT</a></li>
<li><a href="#misc">MISC</a></li>
<li><a href="#covertitle">COVERTITLE</a> – frontispiece, title page, etc</li>
<li><a href="#doc-covertitle">DOC_COVERTITLE</a> – book cover, collated document cover, etc</li>
<li><a href="#pdftitle">PDF_TITLE</a> – window title for PDF viewers</li>
</ul>
</div>
<!-- -TITLE- -->
<div class="macro-id-overline">
<h3 id="title" class="macro-id">TITLE</h3>
</div>
<div class="box-macro-args">
Macro: <b>TITLE</b> <kbd>"<title string>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd>
</div>
<p class="requires">
• Arguments must be enclosed in double-quotes
</p>
<p>
The title string can be caps or caps/lower-case; it’s up to you. In
<a href="#printstyle">PRINTSTYLE TYPESET</a>,
the title will appear in the
<a href="definitions.html#docheader">docheader</a>
exactly as you typed it. However, mom converts the title to all
caps in
<a href="definitions.html#header">page headers</a>
unless you turn that feature off (see
<a href="headfootpage.html#_caps">HEADER_<POSITION>_CAPS</a>).
In
<a href="#printstyle">PRINTSTYLE TYPEWRITE</a>,
the title always gets converted to caps.
</p>
<p>
TITLE accepts multiple arguments, each surrounded by double-quotes.
Each argument is printed on a separate line, permitting you to
create multi-line titles in your docheaders.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If your <kbd><a href="#doctype">DOCTYPE</a></kbd> is CHAPTER, TITLE
should be the title of the opus, not “CHAPTER whatever”.
</p>
</div>
<!-- -DOCTITLE- -->
<div class="macro-id-overline">
<h3 id="doc-title" class="macro-id">DOCUMENT TITLE</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOCTITLE</b> <kbd class="macro-args">"<overall document title>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd>
</div>
<p class="requires">
• Arguments must be enclosed in double-quotes
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
This macro should be used only if your <a
href="#doctype">DOCTYPE</a> is <kbd>DEFAULT</kbd> (which is
mom’s default). If your DOCTYPE is CHAPTER, use
<a href="#title">TITLE</a>
to set the overall document title for cover pages, document cover
pages, and page headers or footers.
</p>
</div>
<p style="margin-top: -.5em;">
When you’re creating a single document, say, an essay or a
short story, you have no need of this macro.
<a href="#title">TITLE</a>
takes care of all your title needs.
</p>
<p>
However if you’re
<a href="rectoverso.html#collate">collating</a>
a bunch of documents together, say, to print out a report containing
many articles with different titles, or a book of short stories with
different authors, you need DOCTITLE.
</p>
<p>
DOCTITLE tells mom the title of the complete document (as opposed to
the title of each article or entitled section), and appears
</p>
<ol style="list-style-type: lower-alpha">
<li>as the window title in PDF viewers (eg Okular or Evince)</li>
<li>in the initial rightmost position of page headers in the document</li>
</ol>
<p>
Moreover, DOCTITLE does not appear in the
<a href="definitions.html#pdfoutline">PDF outline </a>,
as its presence in window title would make it redundant.
</p>
<p>
The doctitle string can be caps or caps/lower-case; it’s up to
you. In
<a href="#printstyle">PRINTSTYLE TYPESET</a>,
by default, the doctitle in
<a href="definitions.html#header">page headers</a>
is all in caps, unless you turn that feature off (see
<a href="headfootpage.html#_caps">HEADER_<POSITION>_CAPS</a>).
In
<a href="#printstyle">PRINTSTYLE TYPEWRITE</a>,
the doctitle always gets converted to caps.
</p>
<p>
DOCTITLE accepts multiple arguments, each surrounded
by double-quotes. Each argument is printed on a separate line,
permitting you to create multi-line document titles for use on
<a href="cover.html#cover">Covers</a>
and/or
<a href="cover.html#doc-cover">Doc covers</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If your
<a href="#doctype">DOCTYPE</a>
is CHAPTER, you don’t need DOCTITLE. TITLE takes care of
everything.
</p>
</div>
<!-- -SUBTITLE- -->
<div class="macro-id-overline">
<h3 id="subtitle" class="macro-id">SUBTITLE</h3>
</div>
<div class="box-macro-args">
Macro: <b>SUBTITLE</b> <kbd class="macro-args">[COVER | DOC_COVER] "<subtitle>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd>
</div>
<p class="requires">
• String arguments must be enclosed in double-quotes
</p>
<p>
The subtitle string can be caps or caps/lower-case. I recommend
caps/lower case.
</p>
<p>
SUBTITLE accepts multiple arguments, each surrounded
by double-quotes. Each argument is printed on a separate line,
permitting you to create multi-line subtitles.
</p>
<p>
If the optional argument, <kbd>COVER</kbd> or <kbd>DOC_COVER</kbd>,
is given to SUBTITLE, the remaining string
arguments represent the subtitle that will appear on cover or
document cover pages (see the
<a href="cover.html#cover-intro">Introduction to cover pages</a>
for a description of the difference between “document
covers” and “covers”). Thus, it is possible to have
differing subtitles appear on the document cover, the cover
(“title”) page, and in the document header. An extreme
example would be:
<br/>
<span class="pre-in-pp">
.SUBTITLE "The Docheader Subtitle"
.SUBTITLE DOC_COVER "The Document Cover Subtitle"
.SUBTITLE COVER "The Cover Subtitle"
</span>
The first invocation of <kbd>.SUBTITLE</kbd> establishes the
subtitle that appears in the docheader at the top of the first page
of a document. The second invocation establishes the subtitle that
appears on the document cover; the third establishes the subtitle
that appears on the cover (“title”) page.
</p>
<p>
If you don’t require differing subtitles for doc cover and cover
pages, <kbd>.SUBTITLE</kbd>, without the optional first argument, is
sufficient, provided you give the word, <kbd>SUBTITLE</kbd>, as an
argument to the macro
<a href="cover.html#doc-cover">DOC_COVER</a>
or
<a href="cover.html#cover">COVER</a>
</p>
<!-- -AUTHOR- -->
<div class="macro-id-overline">
<h3 id="author" class="macro-id">AUTHOR</h3>
</div>
<div class="box-macro-args">
Macro: <b>AUTHOR</b> <kbd class="macro-args">[COVER | DOC_COVER] "<author>" [ "<author2>" ["<author3>" ... ] ]</kbd>
</div>
<p class="alias" style="margin-bottom: 0;">
<i>Alias:</i> <b>EDITOR</b>
</p>
<p class="requires">
• String arguments must be enclosed in double-quotes
</p>
<p>
Each author string can hold as many names as you like, eg
<br/>
<span class="pre-in-pp" style="margin-bottom: -1em;">
.AUTHOR "Joe Blow"
</span>
or
<br/>
<span class="pre-in-pp" style="margin-top: -.5em;">
.AUTHOR "Joe Blow, Jane Doe" "John Hancock"
</span>
Mom prints each string that’s enclosed in double-quotes on a
separate line in the
<a href="definitions.html#docheader">docheader</a>,
however only the first string appears in
<a href="definitions.html#header">page headers</a>.
If you want mom to put something else in the author part of page
headers (say, just the last names of a document’s two
authors), redefine the appropriate part of the header (see
<a href="headfootpage.html#header-control">header/footer control</a>).
</p>
<p>
The strings can be caps or caps/lower-case. I recommend caps/lower
case.
</p>
<p>
If the optional argument, <kbd>COVER</kbd> or <kbd>DOC_COVER</kbd>,
is given to AUTHOR, the remaining string arguments represent the
author(s) that will appear on cover or document cover pages (see the
<a href="cover.html#cover-intro">Introduction to cover pages</a>
for a description of the difference between “document
covers” and “covers”). Thus, it is possible
to have differing authors on the document cover, the cover
(“title”) page, in the document first-page header and
subsequent page headers/footers. An example might be:
<br/>
<span class="pre-in-pp">
.AUTHOR "Joe Blow"
.EDITOR DOC_COVER "John Smith" "and" "Jane Doe" \" EDITOR is an alias for AUTHOR
.AUTHOR COVER "Joe Blow" "(assisted by Jane Doe)"
</span>
The first invocation of <kbd>.AUTHOR</kbd> establishes the author
that appears in the docheader at the top of the first page of
a document and in subsequent page headers/footers. The second
invocation establishes the authors (editors, in this instance) that
appear on the document cover; the third establishes the author(s)
that appear(s) on the cover (“title”) page.
</p>
<p>
If you don’t require differing authors for doc cover and cover
pages, <kbd>.AUTHOR</kbd>, without the optional first argument, is
sufficient, provided you give the word, <kbd>AUTHOR</kbd> as an
argument to the macro
<a href="cover.html#doc-cover">DOC_COVER</a>
or
<a href="cover.html#cover">COVER</a>
</p>
<!-- -CHAPTER- -->
<div class="macro-id-overline">
<h3 id="chapter" class="macro-id">CHAPTER</h3>
</div>
<div class="box-macro-args">
Macro: <b>CHAPTER</b> <kbd class="macro-args"><chapter number></kbd>
</div>
<p>
The chapter number can be in any form you like—a digit, a roman
numeral, a word. If you choose
<a href="#doctype">DOCTYPE CHAPTER</a>,
mom prints whatever argument you pass CHAPTER beside the word,
“Chapter”, as a single line
<a href="definitions.html#docheader">docheader</a>.
She also puts the same thing in the middle of
<a href="definitions.html#header">page headers</a>.
</p>
<p>
Please note that if your argument to CHAPTER runs to more than one
word, you must enclose the argument in double-quotes.
</p>
<p>
If you’re not using DOCTYPE CHAPTER, the macro can
be used to identify any document as a chapter <i>for the purpose of
prepending a chapter number to numbered head elements</i>, provided
you pass it a
<a href="definitions.html#numericargument">numeric argument</a>.
See
<a href="docelement.html#prefix-chapter-number">PREFIX_CHAPTER_NUMBER</a>.
</p>
<!-- -CHAPTER_STRING- -->
<h3 id="chapter-string" class="docs">Chapter string</h3>
<p>
If you’re not writing in English, you can ask mom to use the
word for “chapter” in your own language by telling her
what it is with the CHAPTER_STRING macro, like this:
<br/>
<span class="pre">
.CHAPTER_STRING "Chapître"
</span>
</p>
<p>
You can also use CHAPTER_STRING if you want
“CHAPTER” (all caps) instead of “Chapter”
(caps/lowercase) in the doc- and page-headers.
</p>
<!-- -CHAPTER_TITLE- -->
<div class="macro-id-overline">
<h3 id="chapter-title" class="macro-id">CHAPTER_TITLE</h3>
</div>
<div class="box-macro-args">
Macro: <b>CHAPTER_TITLE</b> <kbd class="macro-args">"<chapter title>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd>
</div>
<p class="requires">
• Arguments must be enclosed in double-quotes
</p>
<p>
If, either in addition to or instead of “Chapter
<n>” appearing at the top of chapters, you want your
chapter to have a title, use CHAPTER_TITLE, with your title enclosed
in double-quotes, like this:
<br/>
<span class="pre">
.CHAPTER_TITLE "The DMCA Nazis"
</span>
</p>
<p>
CHAPTER_TITLE accepts multiple arguments, each surrounded by
double-quotes. Each argument is printed on a separate line,
permitting you to create multi-line chapter titles in your
docheaders.
</p>
<p>
If you’ve used
<a href="#chapter">CHAPTER</a>
to give the chapter a number, both “Chapter <n>”
and the chapter title will appear at the top of the chapter, like
this:
<br/>
<span class="pre-in-pp">
Chapter 1
The DMCA Nazis
</span>
In such a case, by default, only the chapter’s title will appear in
the
<a href="definitions.html#header">page headers</a>,
not “Chapter <n>”.
</p>
<p>
If you omit CHAPTER when setting up your reference macros, only the
title will appear, both at the top of page one and in subsequent
page headers.
</p>
<p>
The style of the chapter title can be altered by
<a href="docelement.html#docelement-control">control macros</a>,
eg CHAPTER_TITLE_FAMILY, CHAPTER_TITLE_FONT, etc. The default
family, font and point size are Times Roman, Bold Italic, 4 points
larger than
<a href="definitions.html#running">running text</a>.
</p>
<!-- -DRAFT- -->
<div class="macro-id-overline">
<h3 id="draft" class="macro-id">DRAFT</h3>
</div>
<div class="box-macro-args">
Macro: <b>DRAFT</b> <kbd class="macro-args"><draft number></kbd>
</div>
<p>
DRAFT only gets used with
<a href="#copystyle">COPYSTYLE DRAFT</a>.
If the COPYSTYLE is FINAL (the default), mom ignores DRAFT. DRAFT
accepts both alphabetic and numeric arguments, hence it’s
possible to do either
<br/>
<span class="pre">
.DRAFT 2
or
.DRAFT Two
</span>
</p>
<p>
Mom prints the argument to <kbd>.DRAFT</kbd> (ie the draft number)
beside the word “Draft” in the middle part of
<a href="definitions.html#header">page headers</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">A small word of caution:</span>
If your argument to <kbd>.DRAFT</kbd> is more than one word long,
you must enclose the argument in double-quotes.
</p>
</div>
<p>
You may, if you wish, invoke <kbd>.DRAFT</kbd> without an
argument, in which case, no draft number will be printed beside
“Draft” in headers or footers.
</p>
<!-- -DRAFT_STRING- -->
<h3 id="draft-string" class="docs">The draft string</h3>
<p>
If you’re not writing in English, you can ask mom
to use the word for “draft” in your own language by
telling her what it is with the DRAFT_STRING macro,
like this:
<br/>
<span class="pre">
.DRAFT_STRING "Jet"
</span>
</p>
<p>
Equally, DRAFT_STRING can be used to roll your own solution to
something other than the word “Draft.” For example, you
might want “Trial run alpha-three” to appear in the
headers of a draft version. You’d accomplish this by doing
<br/>
<span class="pre">
.DRAFT alpha-three
.DRAFT_STRING "Trial run"
</span>
</p>
<p>
If you wanted only “Trial run” to appear, entering
<kbd>.DRAFT</kbd> without an argument as well as
<kbd>.DRAFT_STRING "Trial run"</kbd> is how you’d do it.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If you define both a blank <kbd>.DRAFT</kbd> and a blank
<kbd>.DRAFT_STRING</kbd>, mom skips the draft field in headers
entirely. If this is what you want, this is also the only way
to do it. Simply omitting invocations of <kbd>.DRAFT</kbd> and
<kbd>.DRAFT_STRING</kbd> will result in mom using her default, which
is to print “Draft <number>”.
</p>
</div>
<!-- -REVISION- -->
<div class="macro-id-overline">
<h3 id="revision" class="macro-id">REVISION</h3>
</div>
<div class="box-macro-args">
Macro: <b>REVISION</b> <kbd class="macro-args"><revision number></kbd>
</div>
<p>
REVISION only gets used with
<a href="#copystyle">COPYSTYLE DRAFT</a>.
If the COPYSTYLE is FINAL (the default), mom ignores the REVISION
macro. REVISION accepts both alphabetic and numeric arguments, hence
it’s possible to do either
<br/>
<span class="pre" style="margin-bottom: -1em;">
.REVISION 2
</span>
or
<span class="pre" style="margin-top: -.5em;">
.REVISION Two
</span>
</p>
<p>
Mom prints the revision number beside the shortform
“Rev.” in the middle part of
<a href="definitions.html#header">page headers</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">A small word of caution:</span>
If your argument to <kbd>.REVISION</kbd> is more than one word long,
you must enclose the argument in double-quotes.
</p>
</div>
<p>
You may, if you wish, invoke <kbd>.REVISION</kbd> without an
argument, in which case, no revision number will be printed beside
"Rev." in headers or footers.
</p>
<!-- -REVISION_STRING- -->
<h3 id="revision-string" class="docs">The revision string</h3>
<p>
If you’re not writing in English, you can ask mom
to use the word for “revision,” or a shortform
thereof, in your own language by telling her what it is with the
REVISION_STRING macro, like this:
<br/>
<span class="pre">
.REVISION_STRING "Rév."
</span>
</p>
<p>
Additionally, you may sometimes want to make use of mom’s
<a href="#copystyle">COPYSTYLE DRAFT</a>
but not actually require any draft information. For example,
you might like mom to indicate only the revision number of
your document. The way to do that is to define an empty
<kbd>.DRAFT</kbd> and <kbd>.DRAFT_STRING</kbd> in addition to
<kbd>.REVISION</kbd>, like this:
<br/>
<span class="pre">
.DRAFT
.DRAFT_STRING
.REVISION 2
</span>
</p>
<p>
Equally, if you want to roll your own solution to what revision
information appears in headers, you could do something like this:
<br/>
<span class="pre">
.DRAFT
.DRAFT_STRING
.REVISION "two-twenty-two"
.REVISION_STRING "Revision"
</span>
</p>
<p>
The above, naturally, has no draft information. If you want to roll
your own <kbd>.DRAFT</kbd> and/or <kbd>.DRAFT_STRING</kbd> as well,
simply supply arguments to either or both.
</p>
<!-- -COPYRIGHT- -->
<div class="macro-id-overline">
<h3 id="copyright" class="macro-id">COPYRIGHT</h3>
</div>
<div class="box-macro-args">
Macro: <b>COPYRIGHT</b> <kbd class="macro-args">[COVER | DOC_COVER] "<copyright info>"</kbd>
</div>
<p class="requires">
• Argument must be enclosed in double-quotes
</p>
<p>
The argument passed to COPYRIGHT is only used on cover or doc cover
pages, and then only if the argument COPYRIGHT is passed to
<a href="cover.html#cover">COVER</a>
or
<a href="cover.html#doc-cover">DOC_COVER</a>.
Do not include the copyright symbol in the argument passed to
COPYRIGHT; mom puts it in for you.
</p>
<p>
If the optional argument, <kbd>COVER</kbd> or <kbd>DOC_COVER</kbd>,
is given to COPYRIGHT, the string argument represents the copyright
information that will appear on cover or document cover pages (see
the
<a href="cover.html#cover-intro">Introduction to cover pages</a>
for a description of the difference between “document
covers” and “covers”). Thus, it is possible to
have differing copyright information on the document cover and on
the cover (“title”) page. An example might be:
<br/>
<span class="pre-in-pp">
.COPYRIGHT DOC_COVER "2010 John Smith and Jane Doe"
.COPYRIGHT COVER "2008 Joe Blow"
</span>
The first invocation of <kbd>.COPYRIGHT</kbd> establishes the
copyright information that appears on the document cover; the second
establishes the copyright information that appears on the cover
(“title”) page.
</p>
<p>
If you don’t require differing copyright information for
doc cover and cover pages, <kbd>.COPYRIGHT</kbd>, without the
optional first argument, is sufficient, provided you give the word,
<kbd>COPYRIGHT</kbd>, as an argument to the macro
<a href="cover.html#doc-cover">DOC_COVER</a>
or
<a href="cover.html#cover">COVER</a>
</p>
<!-- -MISC- -->
<div class="macro-id-overline">
<h3 id="misc" class="macro-id">MISC</h3>
</div>
<div class="box-macro-args">
Macro: <b>MISC</b> <kbd class="macro-args">[COVER | DOC_COVER] "<argument 1>" ["<argument 2>" "<argument 3>" ...]</kbd>
</div>
<p class="requires">
• String arguments must be enclosed in double-quotes
</p>
<p>
The argument(s) passed to MISC are only used on cover or doc cover
pages, and then only if the argument <kbd>MISC</kbd> is passed to
<a href="cover.html#cover">COVER</a>
or
<a href="cover.html#doc-cover">DOC_COVER</a>.
MISC can contain any information you like. Each argument appears on
a separate line at the bottom of the cover or doc cover page.
</p>
<p>
For example, if you’re submitting an essay where the prof has
requested that you include the course number, his name and the date,
you could do
<br/>
<span class="pre-in-pp">
.MISC "Music History 101" "Professor Hasbeen" "Dec. 24, 2010"
</span>
and the information would appear on the essay’s cover page.
</p>
<p>
If the optional argument, <kbd>COVER</kbd> or <kbd>DOC_COVER</kbd>,
is given to MISC, the string arguments represent the miscellaneous
information that will appear on cover or document cover pages (see
the
<a href="cover.html#cover-intro">Introduction to cover pages</a>
for a description of the difference between “document
covers” and “covers”). Thus, it is possible to
have differing miscellaneous information on the document cover and
on the cover (“title”) page. An example might be:
<br/>
<span class="pre">
.MISC DOC_COVER "Music History 101" "Professor Hasbeen"
.MISC COVER "Spring Term Paper"
</span>
</p>
<p>
The first invocation of <kbd>.MISC</kbd> establishes the
miscellaneous information that appears on the document cover; the
second establishes the miscellaneous information that appears on the
cover (“title”) page.
</p>
<p>
If you don’t require differing miscellaneous information
for doc cover and cover pages, <kbd>.MISC</kbd>, without the
optional first argument, is sufficient, provided you give the word
“MISC” as an argument to the macro
<a href="cover.html#doc-cover">DOC_COVER</a>
or
<a href="cover.html#cover">COVER</a>
</p>
<!-- -COVER_TITLE- -->
<div class="macro-id-overline">
<h3 class="macro-id">COVERTITLE & DOC_COVERTITLE</h3>
</div>
<div id="covertitle" class="box-macro-args">
Macro: <b>COVERTITLE</b> <kbd class="macro-args">"<user defined cover page title>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd>
</div>
<p class="requires">
• Arguments must be enclosed in double-quotes
</p>
<div id="doc-covertitle" class="box-macro-args">
Macro: <b>DOC_COVERTITLE</b> <kbd class="macro-args">"<user defined document cover page title>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd>
</div>
<p class="requires">
• Arguments must be enclosed in double-quotes
</p>
<p>
The arguments passed to COVERTITLE or DOC_COVERTITLE are only
used on cover or doc cover pages, and then only if the argument
COVERTITLE or DOC_COVERTITLE is passed to
<a href="cover.html#cover">COVER</a>
or
<a href="cover.html#doc-cover">DOC_COVER</a>.
</p>
<p>
The only time you require a COVERTITLE or DOC_COVERTITLE is when
none of the required first arguments to COVER or DOC_COVER fits
your needs for the title you want to appear on cover (or doc cover)
pages.
</p>
<p>
COVERTITLE and DOC_COVERTITLE accept multiple arguments, each
surrounded by double-quotes. Each argument is printed on a separate
line, permitting you to create multi-line titles on your cover
and/or doc cover pages.
</p>
<div class="macro-id-overline">
<h3 class="macro-id">PDF Title</h3>
</div>
<div id="pdftitle" class="box-macro-args">
Macro: <b>PDF_TITLE</b> <kbd class="macro-args">"<pdf viewer window title>" </kbd>
</div>
<p class="requires">
• Arguments must be enclosed in double-quotes
</p>
<p>
Except for
<a href="#doctitle">DOCTITLE</a>,
mom does not, by default, provide PDF viewers with a document title.
You may set one, if you like, with PDF_TITLE.
</p>
<div class="rule-short"><hr/></div>
<!-- ======================================================================== -->
<h2 id="docstyle-macros" class="macro-group">The docstyle macros</h2>
<p>
The docstyle macros tell mom what type of document you’re
writing, whether you want the output typeset or “typewritten,
double-spaced”, and whether you want a draft copy (with draft
and revision information in the headers) or a final copy.
</p>
<div class="macro-list-container">
<h3 id="index-docstyle" class="macro-list">Docstyle macros</h3>
<ul class="macro-list">
<li><a href="#doctype">DOCTYPE</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
<li><a href="#doctype-underline">DOCTYPE_UNDERLINE</a> – how to control DOCTYPE <kbd>NAMED</kbd> underlining</li>
</ul></li>
<li><a href="#printstyle">PRINTSTYLE</a> – non-optional macro required for document processing
<ul style="margin-left: -.5em; list-style-type: disc;">
<li><a href="#typeset-defaults">Defaults for PRINTSTYLE TYPESET</a></li>
<li><a href="#typewrite-defaults">Defaults for PRINTSTYLE TYPEWRITE</a>
<ul style="margin-left: -.5em; list-style-type: circle;">
<li><a href="#typewrite-control">PRINTSTYLE TYPEWRITE control macros</a>
<ul style="margin-left: -1.5em; list-style-type: square;">
<li><a href="#typewriter-family">Family</a></li>
<li><a href="#typewriter-size">Point size</a></li>
<li><a href="#typewriter-underlining">Underlining of italics</a></li>
</ul></li>
</ul></li>
</ul></li>
<li><a href="#copystyle">COPYSTYLE</a></li>
</ul>
</div>
<!-- -DOCTYPE- -->
<div class="macro-id-overline">
<h3 id="doctype" class="macro-id">DOCTYPE</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOCTYPE</b> <kbd class="macro-args">DEFAULT | CHAPTER | NAMED "<name>" | LETTER</kbd>
</div>
<p>
The arguments <kbd>DEFAULT,</kbd> <kbd>CHAPTER</kbd> and
<kbd>NAMED</kbd> tell mom what to put in the
<a href="definitions.html#docheader">docheader</a>
and
<a href="definitions.html#header">page headers</a>.
<kbd>LETTER</kbd> tells her that you want to write a letter.
</p>
<p>
Mom’s default DOCTYPE is <kbd>DEFAULT</kbd>. If that’s
what you want, you don’t have to give a DOCTYPE command.
</p>
<p>
<kbd>DEFAULT</kbd> prints a
<a href="definitions.html#docheader">docheader</a>
containing the title, subtitle and author information given to the
<a href="#reference-macros">reference macros</a>,
and page headers with the author and title. (See
<a href="headfootpage.html#header-style">Default specs for headers</a>
for how mom outputs each part of the page header.)
</p>
<p>
<kbd>CHAPTER</kbd> prints “Chapter <n>” in place
of a
<a href="definitions.html#docheader">docheader</a>
(<n> is what you gave to the
<a href="#reference-macros">reference macro</a>,
<kbd><a href="#chapter">CHAPTER</a></kbd>).
If you give the chapter a title with
<a href="#chapter-title">CHAPTER TITLE</a>,
mom prints “Chapter <n>” and the
title underneath. If you omit the
<a href="#chapter">CHAPTER</a>
reference macro but supply a
<a href="#chapter-title">CHAPTER_TITLE</a>,
mom prints only the chapter title.
</p>
<p>
The page headers in DOCTYPE <kbd>CHAPTER</kbd> contain the author,
the title of the book (which you gave with
<a href="#title">TITLE</a>),
and “Chapter <n>” (or the chapter title). See
<a href="headfootpage.html#header-style">Default Specs for Headers</a>
for mom’s default type parameters for each part of
the page header.
</p>
<p>
<kbd>NAMED</kbd> takes an additional argument: a name for this
particular kind of document (eg outline, synopsis, abstract,
memorandum), enclosed in double-quotes. <kbd>NAMED</kbd> is
identical to <kbd>DEFAULT</kbd> except that mom prints the argument
to <kbd>NAMED</kbd> beneath the
<a href="definitions.html#docheader">docheader</a>,
as well as in page headers.
(See
<a href="headfootpage.html#header-style">Default specs for headers</a>
for how mom outputs each part of the page header.)
</p>
<p>
Additionally, if you wish the name of this particular kind of
document to be coloured, you can pass DOCTYPE <kbd>NAMED</kbd> a
third (optional) argument: the name of a colour pre-defined (or
“initialized”) with
<a href="color.html#newcolor">NEWCOLOR</a>
or
<a href="color.html#xcolor">XCOLOR</a>.
For example, if you have a doctype named “Warning”,
and you’d like “Warning” to be in red, assuming you’ve
pre-defined (or “initialized”) the color, red, this is
what the DOCTYPE entry would look like:
<br/>
<span class="pre">
.DOCTYPE NAMED "Warning" red
</span>
</p>
<div class="box-tip" style="margin-top: 1.5em;">
<h3 id="doctype-underline" class="docs control">How to control DOCTYPE NAMED underlining</h3>
<p style="tip">
By default, the string passed to DOCTYPE <kbd>NAMED</kbd> is
underlined in the docheader, and on document-cover pages and cover
(“title”) pages. (See the
<a href="cover.html#intro">Introduction to covers</a>
for the difference between “doc cover” and
“cover” pages.)
</p>
<p>
You can use the macro DOCTYPE_UNDERLINE to set the weight of
the underline and its distance from where the doctype-name appears
in the docheader (doc covers and covers handle underlining of the
doctype-name differently; see
<a href="cover.html#cover-underline">COVER_UNDERLINE</a>),
or simply toggle doctype underlining on or off. Mom’s default
is to underline the doctype-name.
</p>
<p>
The order of arguments is <kbd>weight</kbd>, optionally followed by
<kbd>gap</kbd>, where “gap” is the distance from the
<a href="definitions.html#baseline">baseline</a>
of the doctype-name to the underline.
</p>
<p>
The <kbd>weight</kbd> argument is given in points, or fractions
thereof, and must not have the
<a href="definitions.html#unitofmeasure">unit of measure</a>,
<kbd>p</kbd>, appended. Like
<a href="inlines.html#rule-weight">RULE_WEIGHT</a>,
weights must be greater than 0 and less than 100. Mom’s
default for DOCTYPE <kbd>NAMED</kbd> underlining is 1/2 point.
</p>
<p>
The <kbd>gap</kbd> argument can be given using any unit of measure,
and must have the unit of measure appended to the argument.
The distance of the gap is measured from the baseline of the
DOCTYPE <kbd>NAMED</kbd> name to the upper edge of the underline.
Mom’s default gap for named-doctype underlining is 2 points.
</p>
<p>
As an example, suppose you want the doctype-name underlined in the
docheader with a 2-point rule separated from the doctype-name by 3
points. The way to accomplish it is:
<br/>
<span class="pre-in-pp">
.DOCTYPE_UNDERLINE 2 3p
</span>
If you wanted the same thing, but were content with mom’s
default gap of 2 points,
<br/>
<span class="pre-in-pp">
.DOCTYPE_UNDERLINE 2
</span>
would do the trick.
</p>
<p>
If you merely want to toggle the underlining of
the doctype-name in docheaders on or off, invoke
<kbd>.DOCTYPE_UNDERLINE</kbd> by itself to turn the underlining on,
or <kbd>.DOCTYPE_UNDERLINE OFF</kbd> (or NO, X, etc.)
</p>
<p class="tip-bottom">
Please note that if you supply a weight to DOCTYPE_UNDERLINE, and
optionally a gap, you also turn the underlining of the doctype-name
in docheaders on; if this is not what you want, you must turn the
underlining off manually afterwards.
</p>
</div>
<p>
<kbd>LETTER</kbd> tells mom you’re writing a letter. See the
section
<a href="letters.html#letters">Writing Letters</a>
for instructions on using mom to format letters.
</p>
<!-- -PRINTSTYLE- -->
<div class="macro-id-overline">
<h3 id="printstyle" class="macro-id">PRINTSTYLE</h3>
</div>
<div class="box-macro-args">
Macro: <b>PRINTSTYLE</b> <kbd class="macro-args">TYPESET | TYPEWRITE [ SINGLESPACE ]</kbd>
</div>
<p class="requires">
• Required for document processing
<br/>
Must come before any changes to default document style
</p>
<p>
PRINTSTYLE tells mom whether to typeset a document, or to print it
out “typewritten, doubled-spaced”.
</p>
<div class="box-important">
<p class="tip-top">
<span class="important">Important:</span>
<b>This macro may not be omitted.</b> In order for document
processing to take place, mom requires a PRINTSTYLE. If you
don’t give one, mom will warn you on stderr and print a single
page with a nasty message.
</p>
<p class="tip-bottom">
<span class="important">Just as important:</span>
PRINTSTYLE <b>must precede any and all page and style parameters
associated with a document.</b> This applies primarily to, but is by
no means restricted to, PRINTSTYLE <kbd>TYPESET</kbd>. PRINTSTYLE
sets up complete templates that include default papersize, margins,
family, fonts, point sizes, and so on. Therefore, changes to any
aspect of document style must come afterwards.
</p>
</div>
<p>
<kbd>TYPESET</kbd>, as the argument implies, typesets
documents (by default in Times Roman; see
<a href="#typeset-defaults">TYPESET defaults</a>).
You have full access to all the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>
as well as the
<a href="definitions.html#style-control">style control macros</a>
of document processing.
</p>
<p>
As mentioned above, PRINTSTYLE <kbd>TYPESET</kbd> must come before
any changes to mom’s default typographic settings. For
example,
<br/>
<span class="pre-in-pp">
.PAPER A4
.LS 14
.PRINTSTYLE TYPESET
</span>
will not changes mom’s default paper size to A4,
nor her default document leading 14 points, whereas
<br/>
<span class="pre-in-pp">
.PRINTSTYLE TYPESET
.PAPER A4
.LS 14
</span>
will.
</p>
<p>
With <kbd>TYPEWRITE</kbd>, mom does her best to reproduce the look
and feel of typewritten, double-spaced copy (see
<a href="#typewrite-defaults">TYPEWRITE defaults</a>).
<a href="docelement.html#docelement-control">Control macros</a>
and
<a href="typesetting.html#intro-macros-typesetting">typesetting macros</a>
that alter family, font, point size, and
<a href="definitions.html#leading">leading</a>
are (mostly) ignored. An important exception is
<a href="headfootpage.html#hdrftr-global-size">HEADER_SIZE</a>
(and, by extension, FOOTER_SIZE), which allows you to reduce the
point size of headers/footers should they become too crowded. Most
of mom’s inlines affecting the appearance of type are also
ignored
(<kbd><a href="inlines.html#inline-size-mom">\*S[<size>]</a></kbd>
is an exception; there may be a few others).
</p>
<p>
In short, <kbd>TYPEWRITE</kbd> never produces effects
other than those available on a typewriter. Don’t be fooled
by how brainless this sounds; mom is remarkably sophisticated when
it comes to conveying the typographic sense of a document within the
confines of <kbd>TYPEWRITE</kbd>.
</p>
<p>
The primary uses of <kbd>TYPEWRITE</kbd> are: outputting hard
copy drafts of your work (for editing) and producing documents
for submission to publishers and agents who (wisely) insist on
typewritten, double-spaced copy. To get a nicely typeset version of
work that’s in the submission phase of its life (say, to show
fellow writers for critiquing), simply change <kbd>TYPEWRITE</kbd>
to <kbd>TYPESET</kbd> and print out a copy.
</p>
<p>
If, for some reason, you would prefer the output of
<kbd>TYPEWRITE</kbd> single-spaced, pass PRINTSTYLE
<kbd>TYPEWRITE</kbd> the optional argument, <kbd>SINGLESPACE</kbd>.
</p>
<div class="defaults-container">
<h3 id="typeset-defaults" class="docs defaults" style="margin-top: 0;">PRINTSTYLE TYPESET defaults</h3>
<span class="pre defaults">
Family = Times Roman
Point size = 12.5
Paragraph leading = 16 points, adjusted
Fill mode = justified
Hyphenation = enabled
max. lines = 2
margin = 36 points
interword adjustment = 1 point
Kerning = enabled
Ligatures = enabled
Smartquotes = enabled
Word space = groff default
Sentence space = 0
</span>
</div>
<div class="defaults-container">
<h3 id="typewrite-defaults" class="docs defaults" style="margin-top: 0;">PRINTSTYLE TYPEWRITE defaults</h3>
<span class="pre defaults">
Family = Courier
Italics = underlined
Point size = 12
Paragraph leading = 24 points, adjusted; 12 points for SINGLESPACE
Fill mode = left
Hyphenation = disabled
Kerning = disabled
Ligatures = disabled
Smartquotes = disabled
Word space = groff default
Sentence space = groff default
Columns = ignored
</span>
</div>
<div class="box-tip" style="margin-top: 1.5em;">
<h3 id="typewrite-control" class="docs control">PRINTSTYLE TYPEWRITE control macros</h3>
<h4 id="typewriter-family" class="docs">Family</h4>
<p style="margin-top: .5em;">
If you’d prefer a monospace
<a href="definitions.html#family">family</a>
for PRINTSTYLE <kbd>TYPEWRITE</kbd> other than than mom's default,
Courier, you can change it with
<kbd>.TYPEWRITER_FAMILY <family></kbd> (or
<kbd>.TYPEWRITER_FAM</kbd>). Since groff ships with only the
Courier family, you will have to install any other monospace family
yourself. See
<a href="appendices.html#fonts">Adding fonts to
groff</a>.
</p>
<h4 id="typewriter-size" class="docs">Point size</h4>
<p style="margin-top: .5em;">
If you’d like a smaller or larger point size for
for PRINTSTYLE <kbd>TYPEWRITE</kbd> (mom’s default is 12-point),
you can change it with
<kbd>.TYPEWRITER_SIZE <size></kbd>. There’s no need to
add a
<a href="definitions.html#unitofmeasure">unit of measure</a>
to the <kbd><size></kbd> argument; points is assumed. Be
aware, however, that regardless of point size, mom’s
leading/linespacing for <kbd>TYPEWRITE</kbd> is fixed at 24-point
for double-spaced, and 12-point for single-spaced.
</p>
<h4 id="typewriter-underlining" class="docs">Underlining of italics</h4>
<p>
In PRINTSTYLE <kbd>TYPEWRITE</kbd>, mom, by default, underlines
anything that looks like italics. This includes the
<a href="typesetting.html#slant-inline"><kbd>\*[SLANT]</kbd></a>
<a href="definitions.html#inlines">inline escape</a>
for pseudo-italics.
</p>
<p id="printstyle-italics">
If you’d prefer that mom were less bloody-minded
about pretending to be a typewriter (ie you’d like italics and
pseudo-italics to come out as italics), use the control macros
<br/>
<span class="pre-in-pp">
.ITALIC_MEANS_ITALIC
</span>
and
<span class="pre-in-pp">
.SLANT_MEANS_SLANT
</span>
Neither requires an argument.
</p>
<p>
Although it’s unlikely, should you wish to reverse
the sense of these macros in the midst of a document,
<kbd>.UNDERLINE_ITALIC</kbd> and <kbd>.UNDERLINE_SLANT</kbd> restore
underlining of italics and pseudo-italics.
</p>
<p id="underline-quotes">
Additionally, by default, mom underlines
<a href="definitions.html#quotes">quotes</a>
(but not
<a href="definitions.html#blockquotes">blockquotes</a>)
in PRINTSTYLE <kbd>TYPEWRITE</kbd>. If you don’t like this
behaviour, turn it off with
<br/>
<span class="pre">
.UNDERLINE_QUOTES OFF
</span>
</p>
<p>
To turn underlining of quotes back on, use UNDERLINE_QUOTES without
an argument.
</p>
<p class="tip-bottom">
While most of the
<a href="docelement.html#docelement-control">control macros</a>
have no effect on <b>PRINTSTYLE TYPEWRITE</b>, there
is an important exception:
<a href="headfootpage.html#hdrftr-global-size">HEADER_SIZE</a>
(and by extension, FOOTER_SIZE). This is
particularly useful for reducing the point size of
headers/footers should they become crowded (quite likely to
happen if the title of your document is long and your
<kbd><a href="#copystyle">COPYSTYLE</a></kbd>
is DRAFT).
</p>
</div>
<!-- -COPYSTYLE- -->
<div class="macro-id-overline">
<h3 id="copystyle" class="macro-id">COPYSTYLE</h3>
</div>
<div class="box-macro-args">
Macro: <b>COPYSTYLE</b> <kbd class="macro-args">DRAFT | FINAL</kbd>
</div>
<p>
Mom’s default COPYSTYLE is <kbd>FINAL</kbd>, so you
don’t have to use this macro unless you want to.
</p>
<p>
COPYSTYLE <kbd>DRAFT</kbd> exhibits the following behaviour:
</p>
<ol style="margin-top: -.5em;">
<li>Documents start on page 1, whether or not you
request a different starting page number with
<a href="headfootpage.html#pagenumber">PAGENUMBER</a>.
</li>
<li>Page numbers are set in lower case roman numerals.</li>
<li>The draft number supplied by
<a href="#draft">DRAFT</a>
and a revision number, if supplied with
<a href="#revision">REVISION</a>
(see
<a href="#reference-macros">reference macros</a>),
appear in the centre part of
<a href="definitions.html#header">page headers</a>
(or footers, depending on which you’ve selected) along with
any other information that normally appears there.
</li>
</ol>
<div class="box-important">
<p class="tip">
<span class="important">Important:</span>
If you define your own centre part for page headers with
<a href="headfootpage.html#hdrftr-center">HEADER_CENTER</a>,
no draft and/or revision number will appear there. If you want
draft and revision information in this circumstance, use
<a href="headfootpage.html#draft-with-pagenumber">DRAFT_WITH_PAGENUMBER</a>.
</p>
</div>
<p>
COPYSTYLE <kbd>FINAL</kbd> differs from <kbd>DRAFT</kbd> in that:
</p>
<ol style="margin-top: -.5em;">
<li>It respects the starting page number you give the document.</li>
<li>Page numbers are set in normal (Arabic) digits.</li>
<li>No draft or revision number appears in the page headers.</li>
</ol>
<div class="box-tip">
<p id="copystyle-note" class="tip">
<span class="note">Note:</span>
The centre part of page headers can get crowded, especially with
<a href="docprocessing.html#doctype">DOCTYPE <kbd>CHAPTER</kbd></a>
and
<a href="docprocessing.html#doctype">DOCTYPE <kbd>NAMED</kbd></a>,
when the COPYSTYLE is <kbd>DRAFT</kbd>. Three mechanisms are
available to overcome this problem. One is to reduce the overall
size of headers (with
<a href="headfootpage.html#hdrftr-global-size">HEADER_SIZE</a>).
Another, which only works with
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>,
is to reduce the size of the header’s centre part only (with
<a href="headfootpage.html#_size">HEADER_CENTER_SIZE</a>).
And finally, you can elect to have the draft/revision information
attached to page numbers instead of having it appear in the centre
of page headers (see
<a href="headfootpage.html#draft-with-pagenumber">DRAFT_WITH_PAGENUMBER</a>).
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ======================================================================== -->
<h2 id="start-macro" class="macro-group">Initiate document processing</h2>
<p>
In order to use mom’s document element macros (tags), you have
to tell her you want them. The macro to do this is
<a href="#start">START</a>.
</p>
<p>
START collects the information you gave mom in the setup section at
the top of your file (see
<a href="#docprocessing-tut">Tutorial – Setting up a mom document</a>),
merges it with her defaults, sets up headers and page numbering,
and prepares mom to process your document using the document
element tags. No document processing takes place until you invoke
<kbd>.START</kbd>.
</p>
<!-- -START- -->
<div class="macro-id-overline">
<h3 id="start" class="macro-id">START</h3>
</div>
<div class="box-macro-args">
Macro: <b>START</b>
</div>
<p class="requires">
• Required for document processing
</p>
<p>
START takes no arguments. It simply instructs mom to begin document
processing. If you don’t want document processing (ie you
only want the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>),
don’t use START.
</p>
<p>
At a barest minimum before START, you must enter a
<a href="#printstyle">PRINTSTYLE</a>
command.
</p>
<div class="rule-short"><hr/></div>
<!-- ======================================================================== -->
<h2 id="style-before-start" class="macro-group">Establishing typestyle and formatting parameters before START</h2>
<p>
In the third (optional) part of setting up a document (the
stylesheet; see
<a href="#docprocessing-tut">Tutorial – Setting up a mom document</a>),
you can use the
<a href="typesetting.html">typesetting macros</a>
to change mom’s document-wide defaults for margins,
line length, family, base point size,
<a href="definitions.html#leading">leading</a>,
and justification style.
</p>
<p>
Two additional style concerns have to be addressed here (ie in
macros before
<a href="#start">START</a>):
changes to the
<a href="definitions.html#docheader">docheader</a>,
and whether you want you want the document’s nominal leading
adjusted to fill pages fully to the bottom margin.
</p>
<div class="macro-list-container" style="margin-top: 2em;">
<h3 id="index-style-before-start" class="macro-list">Type & formatting parameters before START</h3>
<ul class="macro-list">
<li><a href="#type-before-start">Behaviour of the typesetting macros before START</a>
<ul class="sublist" style="line-height: 120%; margin-bottom: .25em;">
<li><a href="#meanings">List of meanings</a></li>
<li><a href="#lrc-note">Special note on LEFT, RIGHT and CENTER</a></li>
<li><a href="#include">Including (sourcing) style sheets and files</a></li>
<li><a href="#color">Initializing colors</a></li>
</ul></li>
<li><a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a> – adjust linespacing to fill pages and align bottom margins</li>
<li><a href="#docheader">DOCHEADER</a>
<ul class="sublist" style="line-height: 120%;">
<li><a href="#docheader-control">Docheader control</a></li>
</ul></li>
<li><a href="#columns">COLUMNS</a>
<ul class="sublist" style="line-height: 120%;">
<li><a href="#col-next">COL_NEXT</a></li>
<li><a href="#col-break">COL_BREAK</a></li>
</ul></li>
</ul>
</div>
<h3 id="type-before-start" class="docs">Behaviour of the typesetting macros before START</h3>
<p>
From time to time (or maybe frequently), you’ll want the
overall look of a document to differ from mom’s defaults.
Perhaps you’d like her to use a different
<a href="definitions.html#family">family</a>,
or a different overall
<a href="definitions.html#leading">leading</a>,
or have different left and/or right page margins.
</p>
<p>
To accomplish such alterations, use the appropriate
<a href="typesetting.html#macros-typesetting">typesetting macros</a>
(listed below) after
<a href="#printstyle">PRINTSTYLE</a>
and before
<a href="#start">START</a>.
</p>
<p>
More than one user has, quite understandably, not fully grasped the
significance of the preceding sentence. The part they’ve missed is
<i>after</i> PRINTSTYLE.
</p>
<p>
Changes to any aspect of the default look and/or formatting of a mom
document must come after PRINTSTYLE. For example, it might seem
natural to set up page margins at the very top of a document with
<br/>
<span class="pre-in-pp">
.L_MARGIN 1i
.R_MARGIN 1.5i
</span>
However, when you invoke <kbd>.PRINTSTYLE</kbd>, those margins
will be overridden. The correct place to set margins—and
all other changes to the look of a document—is <i>after</i>
PRINTSTYLE.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Don’t use the macros listed in
<a href="#doc-param-macros">Changing document-wide typesetting parameters after START</a>
prior to START; they are exclusively for use
afterwards.
</p>
</div>
<div id="meanings" class="defaults-container">
<h3 class="docs defaults" style="margin-top: 0;">Meanings</h3>
<p style="margin-left: 9px; margin-top: -.25em;">
When used before START, the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>,
below have the following meanings:
<br/>
<span class="pre">
L_MARGIN Left margin of pages, including headers/footers
R_MARGIN Right margin of pages, including headers/footers
T_MARGIN The point at which running text (ie not
headers/footers or page numbers) starts on each
page
B_MARGIN* The point at which running text (ie not
(see note) headers/footers or page numbers) ends on each page
PAGE If you use PAGE, its final four arguments have the
same meaning as L_ R_ T_ and B_MARGIN (above).
LL The line length for everything on the page;
equivalent to setting the right margin with
R_MARGIN
FAMILY The family of all type in the document
PT_SIZE The point size of type in paragraphs; mom uses
this to calculate automatic point size changes
(eg for heads, footnotes, quotes, headers, etc)
LS/AUTOLEAD** The leading used in paragraphs; all leading and
spacing of running text is calculated from this
QUAD/JUSTIFY Affects paragraphs only
LEFT*** No effect
RIGHT*** No effect
CENTER*** No effect
------
*See <a href="headfootpage.html#footer-margin">FOOTER MARGIN AND BOTTOM MARGIN</a> for an important warning
**See <kbd><a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a></kbd>
***See <a href="#lrc-note">Special note</a>
</span>
</p>
</div>
<p style="margin-top: -.75em;">
Other macros that deal with type style, or refinements thereof
(<b>KERN, LIGATURES, HY, WS, SS,</b> etc.), behave normally.
It is not recommended that you set up tabs or indents prior to
START.
</p>
<p>
If you want to change any of the basic parameters (above)
<i>after</i> START and have them affect a document globally (as if
you’d entered them <i>before</i> START), you must use the macros
listed in
<a href="#doc-param-macros">Changing document-wide style parameters after START</a>.
</p>
<h4 id="lrc-note" class="docs">Special note on LEFT, RIGHT and CENTER prior to START</h4>
<p>
In a word, these three macros have no effect on document processing
when invoked prior to START.
</p>
<p>
All mom’s document element tags (PP, HEAD, BLOCKQUOTE,
FOOTNOTE, etc.) except
<a href="docelement.html#quote">QUOTE</a>
set a
<a href="definitions.html#filled">fill mode</a>
as soon as they’re invoked. If you wish to turn fill mode off
for the duration of any tag (with
<a href="typesetting.html#lrc">LEFT, RIGHT or CENTER</a>)
you must do so immediately after invoking the tag. Furthermore,
the change affects <i>only</i> the current invocation of the tag.
Subsequent invocations of the same tag for which you want the same
change require that you invoke <kbd>.LEFT</kbd>, <kbd>.RIGHT</kbd>
or <kbd>.CENTER</kbd> immediately after every invocation of the tag.
</p>
<!-- -INCLUDE- -->
<h4 id="include" class="docs">Including (sourcing) style sheets and files</h4>
<p>
If you routinely make the same changes to mom’s defaults in
order to create similar documents in a similar style—in other
words, you need a template— you can create style-sheet files
and include, or "source", them into your mom documents with the
macro, INCLUDE. The right place for such style sheets is after
<a href="#printstyle">PRINTSTYLE</a>
and before
<a href="#start">START</a>.
</p>
<p>
Say, for example, in a particular kind of document, you always
want main heads set in Helvetica Bold Italic, flush left,
with no underscore. You’d create a file, let’s call it
<kbd>head-template</kbd>, in which you’d place the pertinent HEAD
control macros.
<br/>
<span class="pre-in-pp">
.HEAD_FAMILY H
.HEAD_FONT BI
.HEAD_QUAD L
.HEAD_UNDERLINE OFF
</span>
Then, in the preliminary document set-up section of your main file,
you’d include the style sheet, or template, like this:
<br/>
<span class="pre-in-pp">
.TITLE "Sample Document
.AUTHOR "Joe Blow
.PRINTSTYLE TYPESET
\#
.INCLUDE head-template
\#
.START
</span>
The blank comment lines ( <kbd>\#</kbd> ) aren’t required, but
they do make your file(s) easier to read.
</p>
<p>
If the file to be included is in the same directory as the file
you’re working, you simply enter the filename after
<kbd>.INCLUDE</kbd>. If the file’s in another directory, you must
provide a full path name to it. For example, if you’re working in
a directory called <kbd>/home/joe/stories</kbd> and your
style-sheet is in <kbd>/home/joe/style-sheets</kbd>, the above
example would have to look like this:
<br/>
<span class="pre-in-pp">
.TITLE "Sample Document
.AUTHOR "Joe Blow
.PRINTSTYLE TYPESET
\#
.INCLUDE /home/joe/style-sheets/head-template
\#
.START
</span>
</p>
<p>
INCLUDE is not restricted to style sheets or templates. You can
include any file at any point into a document, provided the file
contains only text and valid groff or mom formatting commands.
Neither is INCLUDE restricted to use with mom’s document
processing macros. You can use it in plain typeset documents as
well.
</p>
<div class="box-tip">
<p class="tip">
<span class="experts">Experts:</span>
INCLUDE is an alias for the groff request, <kbd>.so</kbd>. Mix 'n'
match with impunity.
</p>
</div>
<!-- -COLOUR- -->
<h4 id="color" class="docs">Initializing colours</h4>
<p>
Although it doesn’t really matter where you define/initialize
colours for use in document processing (see
<a href="color.html#newcolor">NEWCOLOR</a>
and
<a href="color.html#xcolor">XCOLOR</a>
in the section
<a href="color.html#color-intro">Coloured text</a>),
I recommend doing so before you begin document processing with
<kbd><a href="#start">START</a></kbd>.
</p>
<p>
The macro,
<a href="color.html#color">COLOR</a>,
and the
<a href="definitions.html#inlines">inline escape</a>,
<a href="color.html#color-inline"><kbd>\[<colorname>]</kbd></a>,
can be used at any time during document processing for occasional
colour effects. However, consistent and reliable colourizing of
various document elements (the docheader, heads, linebreaks,
footnotes, pagenumbers, and so on) must be managed through the use
of the
<a href="docelement.html#docelement-control">document element control macros</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If you plan to have mom generate a
<a href="docelement.html#toc">table of contents</a>,
do not embed colour
<a href="definitions.html#inlines">inline escapes</a>
(<a href="color.html#color-inline"><kbd>\[<colorname>]</kbd></a>)
in the
<a href="definitions.html#stringargument">string arguments</a>
given to any of the
<a href="docprocessing.html#reference-macros">reference macros</a>,
nor in the string arguments given to
<a href="docelement.html#head">HEAD</a>,
<a href="docelement.html#subhead">SUBHEAD</a>
or
<a href="docelement.html#parahead">PARAHEAD</a>.
Use, rather, the
<a href="definitions.html#controlmacro">control macros</a>
mom provides to automatically colourize these
elements.
</p>
</div>
<!-- -DOC LEAD ADJUST- -->
<div class="macro-id-overline">
<h3 id="doc-lead-adjust" class="macro-id">Adjust linespacing to fill pages and align bottom margins</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_LEAD_ADJUST</b> <kbd class="macro-args">toggle</kbd>
</div>
<p class="requires">
• Must come after
<a href="typesetting.html#ls"><span class="normal">LS</span></a>
or
<a href="typesetting.html.#autoloead"><span class="normal">AUTOLEAD</span></a>
and before
<a href="#start"><span class="normal">START</span></a>
</p>
<p>
DOC_LEAD_ADJUST is a special macro to adjust document
<a href="definitions.html#leading">leading</a>
so that bottom margins fall precisely where you expect.
</p>
<p>
When you invoke <kbd>.DOC_LEAD_ADJUST</kbd>, mom takes the number
of lines that fit on the page at your requested leading, then
incrementally adds
<a href="definitions.html#units">machine units</a>
to the leading until the maximum number of lines at the new leading
that fit on the page coincides perfectly with the bottom margin of
<a href="definitions.html#running">running text</a>.
</p>
<p>
In most instances, the difference between the requested lead and
the adjusted lead is unnoticeable, and since in almost all cases
adjusted leading is what you want, it’s mom’s default
and you don't have to invoke it explicitly.
</p>
<p>
However, should you not want adjusted document leading, you must
turn it off manually, like this:
<br/>
<span class="pre">
.DOC_LEAD_ADJUST OFF
</span>
</p>
<p>
If you set the document leading prior to START with
<a href="typesetting.html#leading">LS</a>
or
<a href="typesetting.html#autolead">AUTOLEAD</a>,
DOC_LEAD_ADJUST <kbd>OFF</kbd> must come afterwards, like
this:
<br/>
<span class="pre-in-pp">
.LS 12
.DOC_LEAD_ADJUST OFF
</span>
In this scenario, the maximum number of lines that fit on a page at
a
<a href="definitions.html#leading">leading</a>
of 12
<a href="definitions.html#picaspoints">points</a>
determine where mom ends a page. The effect will be that last lines
usually fall (slightly) short of the “official” bottom
margin.
</p>
<p>
In
<a href="docprocessing.html#printstyle">PRINTSTYLE</a> <kbd>TYPEWRITE</kbd>,
the leading is always adjusted and can’t be turned off.
</p>
<div class="box-tip">
<p class="tip-top">
<span class="note">Note:</span>
DOC_LEAD_ADJUST, if used, must be invoked after
<a href="typesetting.html#leading">LS</a>
or
<a href="typesetting.html#autolead">AUTOLEAD</a>
and before
<a href="#start">START</a>.
</p>
<p class="tip-bottom">
<span class="additional-note">Additional note:</span>
Even if you disable DOC_LEAD_ADJUST, mom will still adjust the
leading of endnotes pages and toc pages. See
<a href="docelement.html#endnote-lead">ENDNOTE_LEAD</a>
and
<a href="docelement.html#toc-lead">TOC_LEAD</a>
for an explanation of how to disable this default behaviour.
</p>
</div>
<!-- -DOCHEADER- -->
<div class="macro-id-overline">
<h3 id="docheader" class="macro-id">Managing the docheader</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOCHEADER</b> <kbd class="macro-args"><toggle> [ distance to advance from top of page ]</kbd>
</div>
<p class="requires">
• Must come before
<a href="#start"><span class="normal">START</span></a>; <kbd><span class="normal">distance</span></kbd> requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
By default, mom prints a
<a href="definitions.html#docheader">docheader</a>
on the first page of any document (see
<a href="#docheader-desc">below</a>
for a description of the docheader). If you don’t want a docheader,
turn it off with
<br/>
<span class="pre-in-pp">
.DOCHEADER OFF
</span>
DOCHEADER is a toggle macro, so the argument doesn’t
have to be OFF; it can be anything you like.
</p>
<p>
If you turn the docheader off, mom, by default, starts
the running text of your document on the same top
<a href="definitions.html#baseline">baseline</a>
as all subsequent pages. If you’d like her to start at a different
vertical position, give her the distance you’d like as a second
argument.
<br/>
<span class="pre-in-pp">
.DOCHEADER OFF 1.5i
</span>
This starts the document 1.5 inches from the top of the page PLUS
whatever spacing adjustment mom has to make in order to ensure that
the first baseline of running text falls on a “valid”
baseline (ie one that ensures that the bottom margin of the first
page falls where it should). The distance is measured from the top
edge of the paper to the
<a href="definitions.html#baseline">baseline</a>
of the first line of type.
</p>
<div class="box-tip">
<p class="tip">
<span class="tip">Tip:</span>
Since no document processing happens until you invoke
<a href="#start"><kbd>.START</kbd></a>—including
anything to do with docheaders—you can
typeset your own docheader prior to START (if
you don’t like the way mom does things) and use
<kbd>.DOCHEADER OFF</kbd> with its optional distance
argument to ensure that the body of your document starts where
you want. You can even insert a PostScript image file (see <a
href="docelement.html#pspic">PSPIC)</a>.
</p>
</div>
<!-- DOCHEADER CONTROL -->
<h3 id="docheader-control" class="docs">Docheader control: How to change the look of docheaders</h3>
<p>
In
<a href="#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>,
the look of docheaders is carved in stone. In
<a href="#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>,
however, you can make a lot of changes. Macros that alter
docheaders must come before
<a href="#start">START</a>.
</p>
<h4 id="docheader-desc" class="docs">Docheader description</h4>
<p>
A typeset docheader has the following characteristics:
</p>
<div class="box-code" style="margin-left: 24px;">
<span class="pre" style="color: #302419;">
TITLE bold, 3.5 points larger than running text (not necessarily caps)
Subtitle medium, same size as running text
by medium italic, same size as running text
Author(s) medium italic, same size as running text
(Document type) bold italic, underscored, 3 points larger than running text
</span>
</div>
<p>
Or, if the
<a href="#doctype">DOCTYPE</a>
is <kbd>CHAPTER</kbd>,
</p>
<div class="box-code" style="margin-left: 24px;">
<span class="pre" style="color: #302419;">
Chapter <n> bold, 4 points larger than running text
Chapter Title bold italic, 4 points larger than running text
</span>
</div>
<p>
The
<a href="definitions.html#family">family</a>
is the prevailing family of the whole document. Title, subtitle,
author and document type are what you supply with the
<a href="#reference-macros">reference macros</a>.
Any you leave out will not appear; mom will compensate:
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If your DOCTYPE is <kbd>CHAPTER</kbd> and you have both “Chapter
<n>” and a “Chapter Title” (as above), mom
inserts a small amount of whitespace between them, equal to
one-quarter of the <a href="definitions.html#leading">leading</a> in
effect. If this doesn’t suit you, you can alter the space by
including the
<a href="definitions.html#inlines">inline escapes</a>,
<a href="inlines.html#up"><kbd>\*[UP]</kbd></a>
or
<a href="inlines.html#down"><kbd>\*[DOWN]</kbd></a>,
in the argument you pass to
<a href="#chapter-title">CHAPTER_TITLE</a>,
like this:
<br/>
<span class="pre-in-pp" style="margin-bottom: -1em;">
.CHAPTER_TITLE "\*[DOWN 2p]Why Not Patent Calculus?"
</span>
or
<span class="pre-in-pp" style="margin-top: -.5em;">
.CHAPTER_TITLE "\*[UP 2p]Why Not Patent Calculus?"
</span>
</p>
</div>
<div class="macro-list-container">
<h3 id="index-docheader-control" class="macro-list">Docheader control</h3>
<ol class="macro-list">
<li><a href="#change-start">Change the starting position of the docheader</a></li>
<li><a href="#docheader-quad">Change quad direction the entire docheader</a></li>
<li><a href="#docheader-family">Change the family of the entire docheader</a></li>
<li><a href="#change-family">Change the family of individual docheader elements</a></li>
<li><a href="#change-font">Change the font of individual docheader elements</a></li>
<li><a href="#change-size">Adjust the size of docheader elements</a></li>
<li><a href="#adjust-leading">Adjust the docheader leading</a></li>
<li><a href="#docheader-color">Change the colour of the entire docheader</a></li>
<li><a href="#change-color">Change the colour of the individual docheader elements</a></li>
<li><a href="#change-attribute">Change the attribution string (“by”)</a></li>
</ol>
</div>
<h4 id="change-start" class="docs">1. Change the starting position of the docheader</h4>
<p>
By default, a docheader starts on the same
<a href="definitions.html#baseline">baseline</a>
as
<a href="definitions.html#running">running text</a>.
If you’d like it to start somewhere else, use the macro,
DOCHEADER_ADVANCE, and give it the distance you want (measured from
the top edge of the paper to the first baseline of the docheader),
like this:
<br/>
<span class="pre-in-pp">
.DOCHEADER_ADVANCE 4P
</span>
A
<a href="definitions.html#unitofmeasure">unit of measure</a>
is required.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
If
<a href="headfootpage.html#headers">HEADERS</a>
are <kbd>OFF</kbd>, mom’s normal top margin for
<a href="definitions.html#running">running text</a>
(7.5
<a href="definitions.html#picaspoints">picas</a>)
changes to 6 picas (visually approx. 1 inch). Since the first
baseline of the docheader falls on the same baseline as the first
line of running text (on pages after page 1), you might find the
docheaders a bit high when headers are off. Use DOCHEADER_ADVANCE
to place them where you want.
</p>
</div>
<h4 id="docheader-quad" class="docs">2. Change the quad direction of the docheader</h4>
<p>
By default, mom centers the docheader. If you’d prefer to
have your docheaders set flush left or right, or need to restore
the default centering, invoke <kbd>.DOCHEADER_QUAD</kbd> with the
quad direction you want, either <kbd>LEFT</kbd> (or <kbd>L</kbd>),
<kbd>RIGHT</kbd> (or <kbd>R</kbd>) or <kbd>CENTER</kbd> (or
<kbd>C</kbd>).
</p>
<h4 id="docheader-family" class="docs">3. Change the family of the entire docheader</h4>
<p>
By default, mom sets the docheader in the same
family used for
<a href="definitions.html#running">running text</a>.
If you’d prefer to have your docheaders set in a different
family, invoke <kbd>.DOCHEADER_FAMILY</kbd> with the family you
want. The argument to DOCHEADER_FAMILY is the same as for
<a href="typesetting.html#family">FAMILY</a>.
</p>
<p>
For example, mom’s default family for running text is Times
Roman. If you’d like to keep that default, but have the
docheaders set entirely in Helvetica,
<br/>
<span class="pre-in-pp">
.DOCHEADER_FAMILY H
</span>
is how you’d do it.
</p>
<p>
Please note that if you use DOCHEADER_FAMILY, you can still alter
the family of individual parts of the docheader with the macros
listed
<a href="#change-family">here</a>.
</p>
<h4 id="change-family" class="docs">4. Change the family of individual docheader elements</h4>
<p>
The following macros let you change the
<a href="definitions.html#family">family</a>
of each docheader element separately:
</p>
<ul style="list-style-type: none; margin: -.5em;">
<li>Macro: <b>TITLE_FAMILY</b> <kbd class="macro-args"><family></kbd></li>
<li>Macro: <b>CHAPTER_TITLE_FAMILY</b> <kbd class="macro-args"><family></kbd></li>
<li>Macro: <b>SUBTITLE_FAMILY</b> <kbd class="macro-args"><family></kbd></li>
<li>Macro: <b>AUTHOR_FAMILY</b> <kbd class="macro-args"><family></kbd></li>
<li>Macro: <b>DOCTYPE_FAMILY</b> <kbd class="macro-args"><family></kbd>
(if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
</li>
</ul>
<p>
Simply pass the appropriate macro the family you want, just as you
would with
<a href="typesetting.html#family">FAMILY</a>.
</p>
<h4 id="change-font" class="docs">5. Change the font of individual docheader elements</h4>
<p>
The following macros let you change the
<a href="definitions.html#font">font</a>
of each docheader element separately:
</p>
<ul style="list-style-type: none; margin: -.5em;">
<li>Macro: <b>TITLE_FONT</b> <kbd class="macro-args">R | B | I | BI</kbd></li>
<li>Macro: <b>CHAPTER_TITLE_FONT</b> <kbd class="macro-args">R | B | I | BI</kbd></li>
<li>Macro: <b>SUBTITLE_FONT</b> <kbd class="macro-args">R | B | I | BI</kbd></li>
<li>Macro: <b>AUTHOR_FONT</b> <kbd class="macro-args">R | B | I | BI</kbd></li>
<li>Macro: <b>DOCTYPE_FONT</b> <kbd class="macro-args">R | B | I | BI</kbd>
(if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
</li>
</ul>
<p>
Simply pass the appropriate macro the font you want. <kbd>R, B,
I</kbd> and <kbd>BI</kbd> have the same meaning as they do for
<a href="typesetting.html#font">FT</a>. You may also use any of the
<a href="appendices.html#style-extensions">style extensions</a>
provided by mom.
</p>
<h4 id="change-size" class="docs">6. Adjust the size of individual docheader elements</h4>
<p>
The following macros let you adjust the point size of each docheader
element separately.
</p>
<p>
Mom calculates the point size of docheader elements from the point
size of paragraphs in running text, so you must prepend a + or -
sign to the argument. Points is assumed as the
<a href="definitions.html#unitofmeasure">unit of measure</a>,
so there’s no need to append a unit to the argument.
Fractional point sizes are allowed.
</p>
<ul style="list-style-type: none; margin: -.5em;">
<li>Macro: <b>TITLE_SIZE</b> <kbd class="macro-args"><+/-points></kbd>
<br/>
default = +3.5 (+4 if docheader title is "Chapter <n>")
</li>
<li>Macro: <b>CHAPTER_TITLE_SIZE</b> <kbd class="macro-args"><+/-points></kbd>
<br/>
default = +4
</li>
<li>Macro: <b>SUBTITLE_SIZE</b> <kbd class="macro-args"><+/-points></kbd>
<br/>
default = +0
</li>
<li>Macro: <b>AUTHOR_SIZE</b> <kbd class="macro-args"><+/-points></kbd>
<br/>
default = +0
</li>
<li>Macro: <b>DOCTYPE_SIZE</b> <kbd class="macro-args"><+/-points></kbd>
(if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
<br/>
default = +3
</li>
</ul>
<p>
Simply pass the appropriate macro the size adjustment you want.
</p>
<h4 id="adjust-leading" class="docs">7. Adjust the docheader leading</h4>
<p>
The
<a href="definitions.html#leading">leading</a>
of docheaders is the same as running text. If you’d like your
docheaders to have a different leading, say, 2 points more than the
lead of running text, use:
<br/>
<span class="pre-in-pp">
.DOCHEADER_LEAD +2
</span>
Since the leading of docheaders is calculated from the lead of running
text, a + or - sign is required before the argument (how much to add
or subtract from the lead of running text). No
<a href="definitions.html#unitofmeasure">unit of measure</a>
is required; points is assumed.
</p>
<h4 id="docheader-color" class="docs">8. Change the colour of the entire docheader</h4>
<p>
If you want to colourize the entire docheader:
<br/>
<span class="pre-in-pp">
.DOCHEADER_COLOR <kbd class="macro-args"><color name></kbd>
</span>
You must pre-define (or “initialize”) the colour with
<a href="color.html#newcolor">NEWCOLOR</a>
or
<a href="color.html#xcolor">XCOLOR</a>.
</p>
<h4 id="change-color" class="docs">9. Change the colour of the docheader elements individually</h4>
<p>
The following macros let you change the colour of each
docheader element separately. You must pre-define (or
“initialize”) the colour with
<a href="color.html#newcolor">NEWCOLOR</a>
or
<a href="color.html#xcolor">XCOLOR</a>.
</p>
<ul style="list-style-type: none; margin: -.5em;">
<li>Macro: <b>TITLE_COLOR</b> <kbd class="macro-args"><colorname></kbd></li>
<li>Macro: <b>CHAPTER_TITLE_COLOR</b> <kbd class="macro-args"><colorname></kbd>
<ul style="list-style-type: disc; margin-left: -.5em;">
<li>Note: <b>CHAPTER_TITLE_COLOR</b> is needed only if you supply both a
<a href="#chapter">CHAPTER</a>
reference macro and a
<a href="#chapter-title">CHAPTER_TITLE</a>
macro. Otherwise, TITLE_COLOR takes care of colorizing the
chapter header.
</li>
</ul></li>
<li>Macro: <b>SUBTITLE_COLOR</b> <kbd class="macro-args"><colorname></kbd></li>
<li>Macro: <b>ATTRIBUTE_COLOR</b> <kbd class="macro-args"><colorname></kbd>
(the “by” string preceding author[s] name[s])
</li>
<li>Macro: <b>AUTHOR_COLOR</b> <kbd class="macro-args"><colorname></kbd></li>
<li>Macro: <b>DOCTYPE_COLOR</b> <kbd class="macro-args"> <colorname></kbd>
(if <a href="#doctype">DOCTYPE</a> is <kbd>NAMED</kbd>)
</li>
</ul>
<p>
It is not recommended that you embed colour (with the
<a href="definitions.html#inlines">inline escape</a>,
<a href="color.html#color-inline"><kbd>\*[<colorname>]</kbd></a>)
in the strings passed to TITLE, CHAPTER_TITLE, SUBTITLE, AUTHOR or
the name you give DOCTYPE <kbd>NAMED</kbd>. The strings passed to
these macros are used to generate page
<a href="definitions.html#header">headers</a>
and
<a href="definitions.html#footer">footers</a>,
with the result that an embedded colour will cause the string to be
colourized in headers and/or footers as well. (If you want headers
or footers colourized, or parts thereof, use the header/footer
control macros.)
</p>
<h4 id="change-attribute" class="docs">10. Change the attribution string (“by”)</h4>
<p>
If you’re not writing in English, you can change what mom
prints where “by” appears in docheaders. For example,
<br/>
<span class="pre-in-pp">
.ATTRIBUTE_STRING "par"
</span>
changes “by” to “par”. ATTRIBUTE_STRING
can also be used, for example, to make the attribution read
"Edited by".
</p>
<p>
If you don’t want an attribution string at all, simply pass
ATTRIBUTE_STRING an empty argument, like this:
<br/>
<span class="pre-in-pp">
.ATTRIBUTE_STRING ""
</span>
Mom will deposit a blank line where the attribution string normally
appears.
</p>
<p>
If the optional argument, <kbd>COVER</kbd> or <kbd>DOC_COVER</kbd>,
is given to ATTRIBUTE_STRING, the string argument represents the
attribution string that will appear on cover or document cover pages
(see the
<a href="cover.html#cover-intro">Introduction to cover pages</a>
for a description of the difference between “document
covers” and “covers”). Thus, it is possible to
have different attribution strings on the document cover page, the
cover (“title”) page, and in the first-page docheader.
An extreme example would be:
<br/>
<span class="pre-in-pp">
.ATTRIBUTE_STRING ""
.ATTRIBUTE_STRING DOC_COVER "Edited by"
.ATTRIBUTE_STRING COVER "by"
</span>
The first invocation of <kbd>.ATTRIBUTE_STRING</kbd> establishes a
blank attribution string that will be incorporated in the first-page
docheader. The second will print “Edited by” on the
document cover; the third will print “by” on the cover
(“title”) page.
</p>
<p>
If you don’t require differing attribute strings for
doc cover pages, cover pages, or the first-page docheader,
<kbd>.ATTRIBUTE_STRING</kbd>, without either of the optional first
arguments, is sufficient.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
The type specs for the attribution line in docheaders are the
same as for the author line. Although it’s highly unlikely
you’ll want the attribution line in a different family, font,
or point size, you can make such changes using
<a href="definitions.html#inlines">inline escapes</a>
in the argument to ATTRIBUTE_STRING. For example,
<br/>
<span class="pre-in-pp">
.ATTRIBUTE_STRING "\f[HBI]\*[SIZE -2p] by \*[SIZE +2p]\*[PREV]"
</span>
would set “by” in Helvetica bold italic, 2 points
smaller than normal.
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- -COLUMNS- -->
<h2 id="columns-intro" class="docs">Setting documents in columns</h2>
<p>
Setting documents in columns is easy with mom. All you have to do
is is say how many columns you want and how much space you want
between them (the
<a href="definitions.html#gutter">gutters</a>).
That’s it. Mom takes care of everything else, from soup to
nuts.
</p>
<h3 class="docs">Some words of advice</h3>
<p>
If you want your type to achieve a pleasing
<a href="definitions.html#just">justification</a>
or
<a href="definitions.html#rag">rag</a>
in columns, reduce the point size of type (and probably the
<a href="definitions.html#leading">leading</a>
as well). Mom’s default document point size is 12.5, which
works well across her default 39
<a href="definitions.html#picaspoints">pica</a>
full page line length, but with even just two columns on a page, the
default point size is awkward to work with.
</p>
<p>
Furthermore, you’ll absolutely need to reduce the indents for
<a href="docelement.html#epigraph-control">epigraphs</a>,
<a href="docelement.html#quote-general">quotes</a>,
and
<a href="docelement.html#blockquote-general">blockquotes</a>
(and probably the
<a href="docelement.html#para-indent">paragraph first-line indent</a>
as well).
</p>
<!-- -COLUMN- -->
<div class="macro-id-overline">
<h3 id="columns" class="macro-id">COLUMNS</h3>
</div>
<div class="box-macro-args">
Macro: <b>COLUMNS</b> <kbd class="macro-args"><number of columns> <width of gutters></kbd>
</div>
<p class="requires">
• Should be the last macro before START
<br/>
<i>The second argument requires a <a href="definitions.html#unitofmeasure">unit of measure</a></i>
</p>
<p>
COLUMNS takes two arguments: the number of columns you want on
document pages, and the width of the
<a href="definitions.html#gutter">gutter</a>
between them. For example, to set up a page with two columns
separated by an 18 point gutter, you’d do
<br/>
<span class="pre-in-pp">
.COLUMNS 2 18p
</span>
Nothing to it, really. However, as noted above, COLUMNS should
always be the last document setup macro prior to
<a href="#start">START</a>.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Mom ignores columns completely
when the
<a href="#printstyle">PRINTSTYLE</a>
is <kbd>TYPEWRITE</kbd>. The notion of typewriter-style
output in columns is just too ghastly for her to bear.
</p>
</div>
<h3 class="docs">Using tabs when COLUMNS are enabled</h3>
<p>
Mom’s tabs (both
<a href="typesetting.html#typesetting-tabs">typesetting tabs</a>
and
<a href="typesetting.html#string-tabs">string tabs</a>)
behave as you’d expect during document processing, even
when COLUMNS are enabled. Tab structures set up during document
processing carry over from page to page and column to column.
</p>
<!-- -BREAKING COLUMNS- -->
<h3 id="breaking-columns" class="docs">Breaking columns manually</h3>
<p>
Mom takes care of breaking columns when they reach the bottom
margin of a page. However, there may be times you want to break
the columns yourself. There are two macros for breaking columns
manually: COL_NEXT and COL_BREAK.
</p>
<div id="col-next" class="box-macro-args">
Macro: <b>COL_NEXT</b>
</div>
<p>
<kbd>.COL_NEXT</kbd> breaks the line just before it,
<a href="definitions.html#quad">quads</a>
it left (assuming the type is justified or quad left), and moves over
to the top of the next column. If the column happens to be the last
(rightmost) one on the page, mom starts a new page
at the "column 1" position. This is the macro to use when
you want to start a new column after the end of a paragraph.
</p>
<div id="col-break" class="box-macro-args">
Macro: <b>COL_BREAK</b>
</div>
<p>
<kbd>.COL_BREAK</kbd> is almost the same as <kbd>.COL_NEXT</kbd>,
except that instead of breaking and quadding the line preceding it,
mom breaks and spreads it (see
<a href="typesetting.html#spread">SPREAD</a>).
Use this macro whenever you need to start a new column in the middle
of a paragraph.
</p>
<div class="box-important">
<p class="tip">
<span class="important">Warning:</span>
If you need COL_BREAK in the middle of a blockquote or (god help
you) an epigraph, you must do the following in order for COL_BREAK
to work:
<br/>
<span class="pre-in-pp">
.SPREAD
\!.COL_BREAK
</span>
</p>
</div>
<div class="rule-short"><hr/></div>
<!-- ======================================================================== -->
<!-- *** -->
<h2 id="style-after-start" class="macro-group">Changing basic type and formatting parameters after START</h2>
<ul id="changing-basic-type">
<li><a href="#behaviour">Behaviour of the typesetting macros during document processing</a>
<ul style="margin-left: -.5em;">
<li><a href="#behaviour-specific">Effect of specific typesetting macros</a></li>
</ul></li>
<li><a href="#tb-margins">Top and bottom margins in document processing</a></li>
<li><a href="#space">Inserting space at the top of a new page</a>
<ul style="margin-left: -.5em;">
<li><a href="#add-space">ADD_SPACE</a></li>
</ul></li>
</ul>
<div class="rule-medium"><hr/></div>
<h3 id="behaviour" class="docs">Behaviour of the typesetting macros during document processing</h3>
<p>
During document processing, most of the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>
affect type in the document globally. For example, if you turn
kerning off, pairwise kerning is disabled not only in paragraphs,
but also in headers, footers, quotes, and so on.
</p>
<p>
Typesetting macros that alter margins and line lengths affect
<a href="definitions.html#running">running text</a>
globally (or at least try to), but leave headers/footers and
footnotes alone. (To indent footnotes, see the full explanation of
the
<a href="docelement.html#footnote">FOOTNOTE</a>
macro.)
</p>
<p>
Mom’s tabs (both
<a href="typesetting.html#typesetting-tabs">typesetting tabs</a>
and
<a href="typesetting.html#string-tabs">string tabs</a>)
behave as expected in running text during document processing. Tab
structures that do not exceed the line length of running text are
preserved sensibly from page to page, and, if
<a href="docprocessing.html#columns">COLUMNS</a>
are enabled, from column to column.
</p>
<p>
Some typesetting macros, however, when used during document
processing, behave in special ways. These are the macros that deal
with the basic parameters of type style: horizontal and vertical
margins, line length,
<a href="definitions.html#family">family</a>,
<a href="definitions.html#font">font</a>,
<a href="definitions.html#ps">point size</a>,
<a href="definitions.html#leading">leading</a>,
and
<a href="definitions.html#quad">quad</a>.
</p>
<p>
Mom assumes that any changes to these parameters stem from a
temporary need to set type in a style different from that provided
by mom’s
<a href="docelement.html#index-docelement">document element tags</a>.
In other words, you need to do a bit of creative typesetting in the
middle of a document.
</p>
<p>
The following lists those typesetting macros whose behaviour during
document processing requires some explanation.
(Please refer to
<a href="#tb-margins">Top and bottom margins in document processing</a>
for information on how mom interprets
<a href="typesetting.html#t-margin">T_MARGIN</a>
and
<a href="typesetting.html#b-margin">B_MARGIN</a>
in document processing. Additionally, see
<a href="#add-space">ADD_SPACE</a>
if you encounter the problem of trying to get mom to put space at
the tops of pages after the first.)
</p>
<div id="behaviour-specific" class="box-code" style="margin-left: 24px;">
<span class="pre" style="color: #302419;">
MACRO EFFECT DURING DOCUMENT PROCESSING
----- ---------------------------------
L_MARGIN •The left margin of all running text
assumes the new value.
•The line length remains unaltered.
•The header and footer left margin
remain at the current document default.
(You won’t use this often by itself. Most
likely, you’ll use it in combination with
R_MARGIN or LL.)
R_MARGIN •The right margin of all running text
assumes the new value. In other words,
the line length is altered.
•The header and footer right margin
remain at the current document default.
LL •The line length of all running text
is set to the new value.
•The header and footer line length remain
at the current document default.
FAMILY •Changes family for the duration of the
current tag only. As soon as another document
element tag is invoked, the family reverts to
the current default for the new tag.
FT •Changes font for the duration of the
current tag only. As soon as another document
element tag is entered, the font reverts
to the current default for the new tag.
N.B. — \•[SLANT] and \•[BOLDER] affect
paragraph text, and remain in effect for all
paragraphs until turned off. If you want to
use them in a macro that takes a string
argument, include the escape in the string.
\•[COND] and \•[EXT] behave similarly.
PT_SIZE •Changes point size for the duration of the
current tag only. As soon as another document
element tag is entered, the point size reverts
to the current document default for the new
tag.
LS •Changes line space for the duration of the
current tag only. As soon as another document
element tag is entered, the line space reverts
to the current document default for the new
tag.
Using LS to temporarily change leading within
a document will almost certainly result in a
bottom margin that doesn’t align with
the bottom margin of subsequent pages. You’ll
need to use the SHIM macro to get mom back on
track when you’re ready to return to the
document’s default leading.
QUAD •Changes quad for the duration of the
current tag only. As soon as another document
element tag is entered, the quad reverts to
the current document default for the new
tag.
N.B. — Line-for-line quadding macros
(LEFT, CENTER, RIGHT) are also temporary,
overridden by the QUAD value of any subsequent
document element tag.
</span>
</div>
<h3 id="tb-margins" class="docs" style="margin-top: 1.5em;">Top and bottom margins in document processing</h3>
<p>
Normally, mom establishes the top and bottom
margins of
<a href="definitions.html#running">running text</a>
in documents from the values of <b>HEADER_MARGIN +
HEADER_GAP</b> and <b>FOOTER_MARGIN + FOOTER_GAP</b>
respectively. However, if you invoke
<a href="typesetting.html#t-margin">T_MARGIN</a>
or
<a href="typesetting.html#b-margin">B_MARGIN</a>
either before or after
<a href="docelement.html#start">START</a>,
they set the top and bottom margins of running text irrespective of
HEADER_GAP and FOOTER_GAP.
</p>
<p>
Put another way, in document processing, T_MARGIN
and B_MARGIN set the top and bottom margins of
running text, but have no effect on the placement of
<a href="definitions.html#header">headers</a>,
<a href="definitions.html#footer">footers</a>,
or page numbers.
</p>
<!-- ==================================================================== -->
<h3 id="space" class="docs">Inserting space at the top of a new page</h3>
<p>
Occasionally, you may want to insert space before the start of
<a href="definitions.html#running">running text</a>
on pages after the first.
</p>
<p>
You might have tried using
<a href="typesetting.html#ald">ALD</a>
or
<a href="typesetting.html#space">SPACE</a>
and found it did nothing. This is because mom normally inhibits
any extra space before the start of running text on pages after the
first.
</p>
<p>
If you need the space, you must use the macro, ADD_SPACE, in
conjunction with
<a href="typesetting.html#newpage">NEWPAGE</a>.
</p>
<!-- -ADD_SPACE- -->
<div class="macro-id-overline">
<h3 id="add-space" class= "macro-id">ADD_SPACE</h3>
</div>
<div class="box-macro-args">
Macro: <b>ADD_SPACE</b> <kbd class="macro-args"><amount of space></kbd>
</div>
<p class="requires">
• Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<p>
ADD_SPACE takes as its single argument the distance
you want mom to advance from the normal
baseline position at the top of any page after the first
(ie the one on which the docheader is normally printed). A
<a href="definitions.html#unitofmeasure">unit of measure</a> is
required.
</p>
<p>
For example, say you wanted to insert 2 inches of space before the
start of
<a href="definitions.html#running">running text</a>
on a page other than the first. You’d accomplish it with
<br/>
<span class="pre-in-pp">
.NEWPAGE
.ADD_SPACE 2i
</span>
which would terminate your current page, break to a new page, print
the header (assuming headers are on) and insert 2 inches of space
before the start of running text.
</p>
<p>
Since adding space in this way is almost sure to disrupt mom’s
ability to guarantee perfectly flush bottom margins, I highly
recommend using the
<a href="docprocessing.html#shim">SHIM</a>
macro immediately after ADD_SPACE.
</p>
<!-- *** -->
<h2 id="intro-doc-param" class="macro-group">Changing basic type and formatting parameters after START</h2>
<p>
In the normal course of things, you establish the basic type
parameters of a document prior to invoking
<a href="#start">START</a>,
using the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>
(<b>L_MARGIN, FAMILY, PT_SIZE, LS,</b> etc). After
START, you <i>must</i> use the following macros to make
global changes to the basic type parameters of a document.
</p>
<div class="macro-list-container">
<h3 id="index-doc-param" class="macro-list">Post-START global style change macros</h3>
<ul class="macro-list">
<li><a href="#doc-left-margin">DOC_LEFT_MARGIN</a></li>
<li><a href="#doc-right-margin">DOC_RIGHT_MARGIN</a></li>
<li><a href="#doc-line-length">DOC_LINE_LENGTH</a></li>
<li><a href="#doc-family">DOC_FAMILY</a></li>
<li><a href="#doc-pt-size">DOC_PT_SIZE</a></li>
<li><a href="#doc-lead">DOC_LEAD</a></li>
<li><a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a></li>
<li><a href="#doc-quad">DOC_QUAD</a></li>
</ul>
</div>
<!-- -DOC_LEFT_MARGIN -->
<div class="macro-id-overline">
<h3 id="doc-left-margin" class="macro-id">DOC_LEFT_MARGIN</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_LEFT_MARGIN</b> <kbd class="macro-args"><left margin></kbd>
</div>
<p class="requires">
• Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<h4 class="docs doc-param-macros">Arguments and behaviour</h4>
<ul class="doc-param-macros">
<li>the argument is the same as for
<a href="typesetting.html#l-margin">L_MARGIN</a>
</li>
<li>changes all left margins to the new value</li>
<li>the line length remains the same (ie the right margin
shifts when you change the left margin)
</li>
</ul>
<!-- -DOC_RIGHT_MARGIN -->
<div class="macro-id-overline">
<h3 id="doc-right-margin" class="macro-id">DOC_RIGHT_MARGIN</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_RIGHT_MARGIN</b> <kbd class="macro-args"><right margin></kbd>
</div>
<p class="requires">
• Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<h4 class="docs doc-param-macros">Arguments and behaviour</h4>
<ul class="doc-param-macros">
<li>the argument is the same as for
<a href="typesetting.html#r-margin">R_MARGIN</a>
</li>
<li>changes all right margins, including
<a href="definitions.html#docheader">docheaders</a>,
headers (or footers) and page numbering to the new value;
for changing the right margin of
<a href="definitions.html#running">running text</a>
only, use
<a href="typesetting.html#r-margin">R_MARGIN</a>
(see
<a href="#behaviour">typesetting macros during
document processing</a>,
entry for R_MARGIN)
</li>
<li>all mom commands that include a right indent calculate
the indent from the new value
</li>
</ul>
<!-- -DOC_RIGHT_MARGIN -->
<div class="macro-id-overline">
<h3 id="doc-line-length" class="macro-id">DOC_LINE_LENGTH</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_LINE_LENGTH</b> <kbd class="macro-args"><length></kbd>
</div>
<p class="requires">
• Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
</p>
<h4 class="docs doc-param-macros">Arguments and behaviour</h4>
<ul class="doc-param-macros">
<li>the argument is the same as for
<a href="typesetting.html#linelength">LL</a>
</li>
<li>exactly equivalent to changing the right margin with
DOC_RIGHT_MARGIN (see
<a href="#doc-right-margin">above</a>);
for changing the line length of
<a href="definitions.html#running">running text</a>
only, use
<a href="typesetting.html#linelength">LL</a>
(see
<a href="#behaviour">typesetting macros during document processing</a>,
entry for LL)
</li>
</ul>
<!-- -DOC_FAMILY- -->
<div class="macro-id-overline">
<h3 id="doc-family" class="macro-id">DOC_FAMILY</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_FAMILY</b> <kbd class="macro-args"><family></kbd>
</div>
<h4 class="docs doc-param-macros" style="margin-top: 1em;">Arguments and behaviour</h4>
<ul class="doc-param-macros">
<li>the argument is the same as for
<a href="typesetting.html#family">FAMILY</a>
</li>
<li>globally changes the type family for
<ul>
<li style="margin-left: -.5em;">the <a href="definitions.html#docheader">docheader</a></li>
<li style="margin-left: -.5em;">all <a href="docelement.html#index-docelement">document element tags</a>, including footnotes</li>
<li style="margin-left: -.5em;"><a href="definitions.html#header">headers and/or footers</a></li>
<li style="margin-left: -.5em;"><a href="docelement.html#number-lines-intro">line numbering</a></li>
<li style="margin-left: -.5em;"><a href="headfootpage.html#pagination">page numbering</a></li>
</ul></li>
<li>does <i>not</i> change the family of
<ul>
<li><a href="cover.html#doc-cover">document cover pages</a></li>
<li><a href="cover.html#cover">cover pages</a></li>
<li><a href="docelement.html#endnote-intro">endnotes pages</a></li>
<li><a href="docelement.html#toc-intro">table of contents</a></li>
</ul></li>
<li>any page elements (eg headers page numbers, footnotes) whose
families you wish to remain at their old values must be
reset with the appropriate
<a href="docelement.html#docelement-control">control macros</a>
</li>
</ul>
<!-- -DOC_PT_SIZE- -->
<div class="macro-id-overline">
<h3 id="doc-pt-size" class="macro-id">DOC_PT_SIZE</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_PT_SIZE</b> <kbd class="macro-args"><point size></kbd>
</div>
<p class="requires">
• Does not require a <a href="definitions.html#unitofmeasure">unit of measure</a>; points is assumed
</p>
<h4 class="docs doc-param-macros">Arguments and behaviour</h4>
<ul class="doc-param-macros">
<li>the argument is the same as for
<a href="typesetting.html#ps">PT_SIZE</a>,
and refers to the point size of type in paragraphs
</li>
<li>all automatic point size changes (heads, quotes,
footnotes, headers, etc.) are affected by the new size;
anything you do not want affected must be reset to
its former value (see the Control Macros section of
the pertinent document element for instructions on
how to do this)
</li>
</ul>
<!-- -DOC_LEAD- -->
<div class="macro-id-overline">
<h3 id="doc-lead" class="macro-id">DOC_LEAD</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_LEAD</b> <kbd class="macro-args"><points> [ ADJUST ]</kbd>
</div>
<p class="requires">
• Does not require a <a href="definitions.html#unitofmeasure">unit of measure</a>; points is assumed
</p>
<h4 class="docs doc-param-macros">Arguments and behaviour</h4>
<ul class="doc-param-macros">
<li>the argument is the same as for
<a href="typesetting.html#leading">LS</a>,
and refers to the
<a href="definitions.html#lead">leading</a>
of paragraphs
</li>
<li>because paragraphs will have a new leading, the leading and
spacing of most running text is influenced by the new value
</li>
<li>epigraphs and footnotes remain unaffected;
if you wish to change their leading, use
<a href="docelement.html#epigraph-autolead">EPIGRAPH_AUTOLEAD</a>
and
<a href="docelement.html#footnote-autolead">FOOTNOTE_AUTOLEAD</a>.
</li>
<li>the optional argument <kbd>ADJUST</kbd> performs
leading adjustment as explained in
<a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a>
</li>
</ul>
<div class="box-important">
<p class="tip">
<span class="important">Important:</span>
Do not use DOC_LEAD in the middle of a page! It should always and
only be invoked immediately prior to a new page, like this:
<br/>
<span class="pre-in-pp">
.DOC_LEAD <new value>
.NEWPAGE
</span>
</p>
</div>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
Even if you don’t pass DOC_LEAD the optional argument
<kbd>ADJUST</kbd>, mom will still adjust the leading of endnotes
pages and toc pages. See
<a href="docelement.html#endnote-lead">ENDNOTE_LEAD</a>
and
<a href="docelement.html#toc-lead">TOC_LEAD</a>
for an explanation of how to disable this default behaviour.
</p>
</div>
<!-- -DOC_QUAD- -->
<div class="macro-id-overline">
<h3 id="doc-quad" class="macro-id">DOC_QUAD</h3>
</div>
<div class="box-macro-args">
Macro: <b>DOC_QUAD</b> <kbd class="macro-args">L | R | C | J</kbd>
</div>
<h4 class="docs doc-param-macros" style="margin-top: 1em;">Arguments and behaviour</h4>
<ul class="doc-param-macros">
<li>the arguments are the same as for
<a href="typesetting.html#quad">QUAD</a>
</li>
<li>affects paragraphs, epigraphs and footnotes; does not
affect blockquotes
</li>
</ul>
<h2 id="terminating" class="macro-group">Terminating a document</h2>
<p>
You need do nothing special to terminate a document. When groff
finishes processing the last
<a href="definitions.html#inputline">input line</a>
of a file, the page is ejected, subject to whatever routines are
needed to complete it (eg printing footnotes or adding the page
number).
</p>
<p>
It happens sometimes, however, that a last line of
<a href="definitions.html#running">running text</a>,
falling on or very near the bottom of the page, tricks groff into
breaking to a new page before terminating. The result is a blank
page at the end of the formatted document.
</p>
<p>
The situation is rare, generally occurring only when some additional
macro is required after the input text, eg to exit a
<a href="docelement.html#list-intro">list</a>
or terminate a
<a href="docelement.html#quote">quote</a>.
To prevent it from ever happening, I recommend getting into the habit
of following the final input line of all your mom files with
<a href="typesetting.html#el"><kbd>.EL</kbd></a>.
Depending on the
<a href="definitions.html#filled">fill mode</a>
in effect, you may also have to append the “join line”
<a href="definitions.html#inlines">escape</a>,
<kbd>\c</kbd>, to the final line.</p>
<p>
Thus, for normal text at the end of a paragraph, which is in fill
mode,
<br/>
<span class="pre-in-pp">
and they all lived happily ever after.
.EL
</span>
or for ending a
<a href="docelement.html#list-intro">LIST</a>
(also in fill mode)
<span class="pre-in-pp">
.ITEM
peaches, pears, plums
.EL
.LIST OFF
</span>
whereas, at the end of a
<a href="docelement.html#quote-intro">QUOTE</a>
(which is in nofill mode),
<span class="pre-in-pp">
Shall be lifted\[em]nevermore!\c
.EL
.QUOTE OFF
</span>
Notice that the <kbd>.EL</kbd> comes after the last line of input
text, not any macros following.
</p>
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
<a href="inlines.html#b"><kbd>\*[B]</kbd></a>
cannot be used as a replacement for <kbd>.EL</kbd> when terminating
a document.
</p>
</div>
<div class="rule-long"><hr/></div>
<!-- Navigation links -->
<table style="width: 100%; margin-top: 12px;">
<tr>
<td style="width: 33%;"><a href="toc.html">Back to Table of Contents</a></td>
<td style="width: 24%; text-align: center;"><a href="#top">Top</a></td>
<td style="width: 43%; text-align: right;"><a href="docelement.html#top">Next: The document element tags</a></td>
</tr>
</table>
</div>
<div class="bottom-spacer"><br/></div>
</body>
</html>
<!-- vim: fileencoding=utf-8: nomodified: -->
|
