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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!--
This file is part of groff, the GNU roff type-setting system.
Copyright (C) 2004, 2005, 2006, 2009 Free Software Foundation, Inc.
Written by Peter Schaffter.
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=iso-8859-1"/>
<title>Mom -- Document Processing, Introduction and Setup</title>
</head>
<body bgcolor="#dfdfdf">
<!-- ==================================================================== -->
<a name="TOP"></a>
<p>
<a href="typemacdoc.html#TOP">Next</a>
<a href="color.html#TOP">Prev</a>
<a href="toc.html">Back to Table of Contents</a>
</p>
<a name="DOCPROCESSING"><h1 align="center"><u>Document processing with mom</u></h1></a>
<p>
<a href="#INTRO_MACROS_DOCPROCESSING">Introduction to document processing</a>
<br/>
<a href="#DEFAULTS">Some document defaults</a>
<br/>
<a href="#LEADING_NOTE">***IMPORTANT NOTE on leading/spacing and bottom margins***</a>
<br/>
<a href="#SHIM">The SHIM macro</a>
</p>
<h2><u>Table of Contents for document processing</u></h2>
<ul>
<li><a href="#SETUP"><strong>DOCUMENT SETUP</strong></a>
<br/>
<a href="#DOCPROCESSING_TUT">Tutorial — setting up a mom document</a>
</li>
<ul>
<li><a href="#REFERENCE_MACROS"><strong>The Reference Macros</strong></a></li>
<ul>
<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>
</ul>
<li><a href="#DOCSTYLE_MACROS"><strong>The Docstyle Macros</strong></a></li>
<ul>
<li><a href="#DOCTYPE">DOCTYPE</a></li>
<li><a href="#PRINTSTYLE">PRINTSTYLE</a></li>
<li><a href="#COPYSTYLE">COPYSTYLE</a></li>
</ul>
<li><a href="#START_MACRO"><strong>Initiate document processing</strong></a></li>
<ul>
<li><a href="#START">START</a></li>
</ul>
<li><a href="#STYLE_BEFORE_START"><strong>Changing global typesetting and formatting parameters before START</strong></a></li>
<ul>
<li><a href="#TYPE_BEFORE_START">Using the typesetting macros before START</a></li>
<ul>
<li><a href="docprocessing.html#INCLUDE">Including (sourcing) style sheets and files</a></li>
<li><a href="#COLOR">Initializing colours</a></li>
</ul>
<li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST — adjust a document's leading to fill pages</a></li>
<li><a href="#DOCHEADER">Managing the document header</a></li>
<ul>
<li><a href="#DOCHEADER">DOCHEADER — turning docheaders off</a></li>
<li><a href="#DOCHEADER_CONTROL">Docheader control</a></li>
</ul>
</ul>
<li><a href="#COLUMNS_INTRO"><strong>Setting documents in columns</strong></a></li>
<ul>
<li><a href="#COLUMNS">COLUMNS</a></li>
<li><a href="#BREAKING_COLUMNS">Breaking columns manually</a></li>
<ul>
<li><a href="#COL_NEXT">COL_NEXT</a></li>
<li><a href="#COL_BREAK">COL_BREAK</a></li>
</ul>
</ul>
<li><a href="#DOC_PARAM_MACROS"><strong>Changing global style parameters after START</strong></a></li>
<ul>
<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><a href="typemacdoc.html#TYPESETTING"><strong>Using the typesetting macros during document processing</strong></a></li>
<li><a href="docelement.html#DOCELEMENT"><strong>THE DOCUMENT ELEMENT TAGS</strong></a></li>
<ul>
<li><a href="docelement.html#DOCELEMENT_INTRO">Introduction to the document element tags</a></li>
<ul>
<li><a href="docelement.html#DOCELEMENT_CONTROL">Document element (tag) control macros</a></li>
<li><a href="docelement.html#CONTROL_MACRO_ARGS">Arguments to the control macros</a></li>
</ul>
<li><a href="docelement.html#EPIGRAPH_INTRO"><strong>Epigraphs</strong></a></li>
<ul>
<li><a href="docelement.html#EPIGRAPH">EPIGRAPH</a></li>
<li><a href="docelement.html#EPIGRAPH_CONTROL">Epigrah control</a></li>
</ul>
<li><a href="docelement.html#PP_INTRO"><strong>Paragraphs</strong></a></li>
<ul>
<li><a href="docelement.html#PP">PP</a></li>
<li><a href="docelement.html#PP_CONTROL">Paragraph control</a></li>
</ul>
<li><a href="docelement.html#HEAD_INTRO"><strong>Main heads</strong></a></li>
<ul>
<li><a href="docelement.html#HEAD">HEAD</a></li>
<li><a href="docelement.html#HEAD_CONTROL">Head control</a></li>
</ul>
<li><a href="docelement.html#SUBHEAD_INTRO"><strong>Subheads</strong></a></li>
<ul>
<li><a href="docelement.html#SUBHEAD">SUBHEAD</a></li>
<li><a href="docelement.html#SUBHEAD_CONTROL">Subhead control</a></li>
</ul>
<li><a href="docelement.html#PARAHEAD_INTRO"><strong>Paragraph heads</strong></a></li>
<ul>
<li><a href="docelement.html#PARAHEAD">PARAHEAD</a></li>
<li><a href="docelement.html#PARAHEAD_CONTROL">Parahead control</a></li>
</ul>
<li><a href="docelement.html#LINEBREAK_INTRO"><strong>Linebreaks (author linebreaks, also called section breaks)</strong></a></li>
<ul>
<li><a href="docelement.html#LINEBREAK">LINEBREAK</a></li>
<li><a href="docelement.html#LINEBREAK_CONTROL">Linebreak control</a></li>
</ul>
<li><a href="docelement.html#QUOTE_INTRO"><strong>Quotes (line for line poetic quotes or code snippets)</strong></a></li>
<ul>
<li><a href="docelement.html#QUOTE">QUOTE</a></li>
<li><a href="docelement.html#QUOTE_CONTROL">Quote control</a></li>
</ul>
<li><a href="docelement.html#BLOCKQUOTE_INTRO"><strong>Blockquotes (cited material)</strong></a></li>
<ul>
<li><a href="docelement.html#BLOCKQUOTE">BLOCKQUOTE</a></li>
<li><a href="docelement.html#BLOCKQUOTE_CONTROL">Blockquote control</a></li>
</ul>
<li><a href="docelement.html#FOOTNOTE_INTRO"><strong>Footnotes</strong></a></li>
<ul>
<li><a href="docelement.html#FOOTNOTE">FOOTNOTE</a></li>
<li><a href="docelement.html#FOOTNOTE_CONTROL">Footnote control</a></li>
</ul>
<li><a href="docelement.html#ENDNOTE_INTRO"><strong>Endnotes</strong></a></li>
<ul>
<li><a href="docelement.html#ENDNOTE">ENDNOTE</a></li>
<li><a href="docelement.html#ENDNOTE_CONTROL">Endnote control</a></li>
</ul>
<li><a href="docelement.html#FINIS_INTRO"><strong>Document termination string</strong></a></li>
<ul>
<li><a href="docelement.html#FINIS">FINIS</a></li>
<li><a href="docelement.html#FINIS_CONTROL">Finis control</a></li>
</ul>
</ul>
<li><a href="headfootpage.html#HEADFOOTPAGE"><strong>HEADERS and FOOTERS</strong></a></li>
<ul>
<li><a href="headfootpage.html#HEADFOOTPAGE_INTRO">Introduction to headers/footers</a></li>
<li><a href="headfootpage.html#HEADFOOT_MANAGEMENT">Managing headers/footers</a></li>
<ul>
<li><a href="headfootpage.html#HEADERS">HEADERS</a> — on or off</li>
<li><a href="headfootpage.html#FOOTERS">FOOTERS</a> — on or off</li>
<li><a href="headfootpage.html#FOOTER_ON_FIRST_PAGE">FOOTER_ON_FIRST_PAGE</a></li>
</ul>
<li><a href="headfootpage.html#HEADFOOT_CONTROL">Header/footer control</a></li>
<ul>
<li><a href="headfootpage.html#HDRFTR_STRINGS">Header/footer strings</a></li>
<li><a href="headfootpage.html#HDRFTR_STYLE">Header/footer style</a> — global and part-by-part</li>
<li><a href="headfootpage.html#HDRFTR_VERTICAL">Header/footer placement and spacing</a></li>
<li><a href="headfootpage.html#HDRFTR_SEPARATOR">The header/footer separator rule</a></li>
</ul>
</ul>
<li><a href="headfootpage.html#PAGINATION"><strong>PAGINATION</strong></a></li>
<ul>
<li><a href="headfootpage.html#PAGINATE">PAGINATE</a> — on or off</li>
<li><a href="headfootpage.html#PAGENUMBER">PAGENUMBER</a> — user supplied page number</li>
<li><a href="headfootpage.html#PAGENUM_STYLE">PAGENUM_STYLE</a> — digits, roman numerals, etc.</li>
<li><a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a> — attach draft/revision information to page numbers</li>
<li><a href="headfootpage.html#PAGINATE_CONTROL">Pagination control</a></li>
</ul>
<li><a href="rectoverso.html#RECTOVERSO"><strong>RECTO_VERSO PRINTING and COLLATING</strong></a></li>
<ul>
<li><a href="rectoverso.html#RECTOVERSO_INTRO">Introduction to recto/verso</a></li>
<ul>
<li><a href="rectoverso.html#RECTO_VERSO">RECTO_VERSO</a></li>
<li><a href="rectoverso.html#SWITCH_HDRFTR">SWITCH_HEADERS</a> (also FOOTERS)</li>
</ul>
<li><a href="rectoverso.html#COLLATE_INTRO">Introduction to collating</a></li>
<ul>
<li><a href="rectoverso.html#COLLATE">COLLATE</a></li>
</ul>
</ul>
<li><a href="cover.html#TOP"><strong>CREATING A COVER PAGE</strong></a></li>
<li><a href="letters.html#LETTERS"><strong>WRITING LETTERS</strong></a></li>
<ul>
<li><a href="letters.html#LETTERS_INTRO">Introduction to writing letters</a></li>
<li><a href="letters.html#TUTORIAL">Tutorial on writing letters</a></li>
<li><a href="letters.html#LETTERS_DEFAULTS">Default style for letters</a></li>
<li><a href="letters.html#LETTERS_MACROS">The letter macros</a></li>
</ul>
</ul>
</ul>
<hr/>
<!-- ==================================================================== -->
<h2><a name="INTRO_MACROS_DOCPROCESSING"><u>Introduction to document processing</u></a></h2>
<p>
As explained in
<a href="intro.html#INTRO_DOCPROCESSING">Document processing with mom</a>,
document processing uses markup tags to identify document elements
such as heads, paragraphs, 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, <strong>mom</strong> has an
extensive array of macros that control how they look and behave.
</p>
<p>
Setting up a <strong>mom</strong> doc is a simple, four-part procedure.
You begin by entering information about the document itself (title,
subtitle, author, etc.). Next, you tell <strong>mom</strong> what
kind of document you're creating (e.g. chapter, letter, abstract,
etc...) and what kind of output you want (typeset, typewritten,
draft-style, etc). Thirdly, you make as many or as few changes to
<strong>mom</strong>'s default behaviour as you wish. Lastly, you
invoke the
<a href="#START">START</a>
macro. Voilà! You're ready to write.
</p>
<!-- ==================================================================== -->
<hr align="left" width="66%"/>
<h2><a name="DEFAULTS"><u>Some document defaults</u></a></h2>
<p>
As is to be expected, <strong>mom</strong> 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. Just in case, here they are.
<ul>
<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 <nobr>( e.g. -6- )</nobr>
</li>
<li>the first page of a document begins with a
<a href="definitions.html#TERMS_DOCHEADER">document header</a>
</li>
<li>subsequent pages have
<a href="definitions.html#TERMS_HEADER">page headers</a>
with a rule underneath
</li>
</ul>
</p>
<p>
Another way to check up on document processing defaults is to have
a look at the macro file (om.tmac). Each macro is preceded by a
description that (generally) says what its default is (if it has
one).
</p>
<!-- ==================================================================== -->
<hr align="left" width="66%"/>
<a name="LEADING_NOTE"><h2><u>IMPORTANT NOTE on leading/spacing and bottom margins</u></h2></a>
<p>
<strong>Mom</strong> takes evenly-aligned bottom margins in
<a href="definitions.html#TERMS_RUNNING">running text</a>
very seriously. Only under a very few (exceptional) circumstances
will she allow a bottom margin to "hang" (i.e. to fall
short).
</p>
<p>
In order to ensure even bottom margins, <strong>mom</strong>
uses the "base" document
<a href="definitions.html#TERMS_LEADING">leading</a>
in effect <em>at the start of running text on each page</em> (i.e.
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#TERMS_CONTROLMACRO">control macro</a>
<a href="#DOC_LEAD">DOC_LEAD</a>.
</p>
<p>
Because <strong>mom</strong> 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 "v"
<a href="definitions.html#TERMS_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 <strong>mom</strong> won't object. "v" means
"the current leading", so she isn't confused by it. And
since "v" accepts decimal fractions, you can add/subtract
half linespaces and quarter linespaces with "v" as well,
<em>provided you compensate for the fractional linespace somewhere
else on the page</em>.
</p>
<p>
If all this seems like too much work, <strong>mom</strong>
provides a special macro to get you out of trouble if you've played
around with leading and/or spacing. The macro is called
<strong>SHIM</strong> (like those little pieces of wood carpenters
use to get their work even, level and snug), and it's described
below.
</p>
<!-- -SHIM- -->
<hr width="33%" align="left"/>
<a name="SHIM"></a>
<p>
<nobr>Macro: <strong>SHIM</strong></nobr>
</p>
<p>
<strong>SHIM</strong> doesn't take any argument. Use it whenever
you've played around with the
<a href="definitions.html#TERMS_LEADING">leading</a>
or spacing on a page and you
need to get <strong>mom</strong>'s document leading back on track.
</p>
<p>
For example, say you want to insert a picture into a document with
the special groff macro, <strong>PSPIC</strong> (see <kbd>man
groff_tmac</kbd> for usage).
</p>
<p>
Pictures aren't usually conveniently sized in multiples of document
leading, which means that when you insert the picture, you disrupt
<strong>mom</strong>'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 <strong>SHIM</strong> after the picture,
like this:
<pre>
<some lines of text>
.PSPIC <full path to picture>
.SHIM
<more lines of text>
</pre>
</p>
<p>
<strong>SHIM</strong> instructs <strong>mom</strong> 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#TERMS_OUTPUTLINE">output line</a>
falls where <strong>mom</strong> 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 that the picture
doesn't centre nicely between the lines of text, you can always do
<pre>
<some lines of text>
.RLD 3p
.PSPIC <full path to picture>
.SHIM
<more lines of text>
</pre>
to raise the picture slightly
(<strong>R</strong>everse <strong>L</strong>ea<strong>D</strong>
3 points; see
<a href="typesetting.html#RLD">RLD</a>),
and still have <strong>SHIM</strong> ensure that text underneath
falls exactly where it's supposed to.
</p>
<p>
<strong>NOTE:</strong> For information on disabling the automatic
shimming of quotes and blockquotes during document processing, see
<a href="docelement.html#NO_SHIM">here</a>.
</p>
<hr/>
<!-- ==================================================================== -->
<a name="SETUP"><h2><u>Document setup</u></h2></a>
<a name="DOCPROCESSING_TUT"><h3><u>Tutorial — setting up a mom document</u></h3></a>
<p>
There are four "parts" to setting up a
<strong>mom</strong> doc (three, actually, with one optional).
Before we proceed, though, be reassured that something as simple as
<pre>
.TITLE "By the Shores of Lake Attica"
.AUTHOR "Rosemary Winspeare"
.PRINTSTYLE TYPESET
.START
</pre>
produces a beautifully typeset 8.5x11 document, with a
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>
at the top of page 1,
<a href="definitions.html#TERMS_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, heads, subheads, 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 — <em>My Pulitzer Winner</em> by Joe Blow. Thankfully,
we don't have to look at story itself, just the setup.
Joe wants the document
<ul>
<li>to be draft 7, revision 39;</li>
<li>to use the "default" style of document formatting:</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#TERMS_RAG">rag-right</a>;
</li>
<li>to have <a href="definitions.html#TERMS_FOOTER">footers</a>
instead of
<a href="definitions.html#TERMS_HEADER">headers</a>;
</li>
<li>to use a single asterisk for
<a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>.
</li>
</ul>
</p>
<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><u>Step 1</u></h4>
<p>
The first step in setting up any document is giving <strong>mom</strong>
some reference information. The reference macros are:
<ul>
<li>TITLE</li>
<li>DOCTITLE</li>
<li>COVERTITLE</li>
<li>SUBTITLE</li>
<li>AUTHOR</li>
<li>CHAPTER — the chapter number</li>
<li>DRAFT — the draft number</li>
<li>REVISION — the revision number</li>
<li>COPYRIGHT — only used on cover pages</li>
<li>MISC — only used on cover pages</li>
<li>COVER_TITLE — only on cover pages; only if needed</li>
<li>DOC_COVER_TITLE — only on document cover pages; only if needed</li>
</ul>
</p>
<p>
You can use as many or as few as you wish, although at a minimum,
you'll probably fill in <strong>TITLE</strong> (unless the document's
a letter) and <strong>AUTHOR</strong>. Order doesn't matter.
You can separate the
<a href="definitions.html#TERMS_ARGUMENTS">arguments</a>
from the macros by any number of spaces. The following are
what you'd need to start Joe Blow's story.
<pre>
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
</pre>
</p>
<h4><u>Step 2</u></h4>
<p>
Once you've given <strong>mom</strong> 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?
<strong>Mom</strong> calls the macros that answer these questions
"the docstyle macros." They are:
<ul>
<li>DOCTYPE — the type of document (default, chapter, user-defined, letter)</li>
<li>PRINTSTYLE — typeset or typewritten</li>
<li>COPYSTYLE — draft or final copy</li>
</ul>
</p>
<p>
<strong>Mom</strong> has defaults for <strong>DOCTYPE</strong>
and <strong>COPYSTYLE</strong>; if they're what you want, you
don't need to include them here. However, <strong>PRINTSTYLE</strong>
has no default and MUST be present in every formatted document.
If you omit it, <strong>mom</strong> 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:
<pre>
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.DOCTYPE DEFAULT \"Superfluous; mom uses DOCTYPE DEFAULT by default
.PRINTSTYLE TYPESET
.COPYSTYLE DRAFT
</pre>
</p>
<p>
Notice the use of the
<a href="definitions.html#TERMS_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><u>Step 3</u></h4>
<p>
This step — completely optional — is where you, the user, take
charge. <strong>Mom</strong> has defaults for <em>everything</em>,
but who's ever satisfied with defaults? Use any of the <a
href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
here to change <strong>mom</strong>'s document defaults (paper
size, margins, family, point size, line space, rag, etc), or
any of the document processing macros that set/change/control
the appearance of document elements. Think of this as the
"style-sheet " section of a document. And please note:
you MUST give <strong>mom</strong> a
<a href="#PRINTSTYLE">PRINTSTYLE</a>
directive <strong>before</strong> making any such changes.
</p>
<p>
Joe Blow wants his story printed in Helvetica, 12 on 14, rag
right, with
<a href="definitions.html#TERMS_FOOTER">page footers</a>
instead of
<a href="definitions.html#TERMS_HEADER">page headers</a>
and a single asterisk for the
<a href="definitions.html#TERMS_LINEBREAK">linebreak</a>
character. None of these requirements conforms
to <strong>mom</strong>'s defaults for the chosen
<strong>PRINTSTYLE</strong> (TYPESET), so we change them here.
The setup for Joe Blow's story now looks like this:
<pre>
.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 \"i.e. rag right
.FOOTERS
.LINEBREAK_CHAR *
</pre>
</p>
<h4><u>Step 4</u></h4>
<p>
The final step in setting up a document is telling
<strong>mom</strong> to start document processing. It's a
no-brainer, just the single macro <strong>START</strong>. Other
than <strong>PRINTSTYLE</strong>, it's the only macro required for
document processing (although I can't guarantee you'll like the
results of using just the two).
</p>
<p>
Here's the complete setup for <em>My Pulitzer Winner</em>:
<pre>
.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 \"i.e. rag right
.FOOTERS
.LINEBREAK_CHAR *
\#
.START
</pre>
</p>
<p>
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:
<pre>
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.PRINTSTYLE TYPEWRITE
.COPYSTYLE DRAFT
\#
.START
</pre>
</p>
<p>
<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:
<pre>
.TITLE "My Pulitzer Winner"
.AUTHOR "Joe Blow"
.DRAFT 7
.REVISION 39
\#
.PRINTSTYLE TYPESET \"first change
.COPYSTYLE FINAL \"second change
\#
.START
</pre>
</p>
<p>
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 <strong>COPYSTYLE</strong> is
<strong>FINAL</strong>, and <strong>COPYSTYLE FINAL</strong> is
<strong>mom</strong>'s default unless you tell her otherwise.
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>
<hr/>
<!-- ======================================================================== -->
<a name="REFERENCE_MACROS"><h2><u>The Reference Macros</u></h2></a>
<p>
The reference macros give <strong>mom</strong> the information
she needs to generate
<a href="definitions.html#TERMS_DOCHEADER">docheaders</a>,
<a href="definitions.html#TERMS_HEADER">page headers</a>,
and
<a href="cover.html#COVER_TOP">covers</a>.
They must go at the top of any file that uses <strong>mom</strong>'s
document processing macros.
</p>
<a name="INDEX_REFERENCE"><h3><u>Reference macros list</u></h3></a>
<ul>
<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>
</ul>
<!-- -TITLE- -->
<hr width="66%" align="left"/>
<a name="TITLE"></a>
<p>
<nobr>Macro: <strong>TITLE</strong> <kbd>"<title string>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd></nobr>
<br/>
<em>*Arguments must be enclosed in double-quotes</em>
</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#TERMS_DOCHEADER">docheader</a>
exactly as you typed it. However, <strong>mom</strong> converts
the title to all caps in
<a href="definitions.html#TERMS_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>
<strong>TITLE</strong> 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>
<p>
<strong>NOTE:</strong> If your
<a href="#DOCTYPE">DOCTYPE</a>
is <strong>CHAPTER</strong>, <strong>TITLE</strong> should be the
title of the opus, not "CHAPTER whatever".
</p>
<!-- -DOCTITLE- -->
<hr width="33%" align="left"/>
<a name="DOC_TITLE"></a>
<p>
<nobr>Macro: <strong>DOCTITLE</strong> <kbd>"<overall document title>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd></nobr>
<br/>
<em>*Arguments must be enclosed in double-quotes</em>
</p>
<p>
<strong>NOTE:</strong> This macro should be used only if your
<a href="#DOCTYPE">DOCTYPE</a>
is <strong>DEFAULT</strong> (which is <strong>mom</strong>'s
default). If your <strong>DOCTYPE</strong> is
<strong>CHAPTER</strong>, use
<a href="#TITLE">TITLE</a>
to set the overall document title for cover pages, document cover
pages, and page headers or footers.
</p>
<p>
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 <strong>DOCTITLE</strong>.
</p>
<p>
<strong>DOCTITLE</strong> tells <strong>mom</strong> the title
of the complete document (as opposed to the title of each article
or entitled section).
</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 appears in the rightmost position of
<a href="definitions.html#TERMS_HEADER">page headers</a>,
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>
<strong>DOCTITLE</strong> 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>
<p>
<strong>NOTE:</strong> If your
<a href="#DOCTYPE">DOCTYPE</a>
is <strong>CHAPTER</strong>, you don't need
<strong>DOCTITLE</strong>. <strong>TITLE</strong> takes care of
everything.
</p>
<!-- -SUBTITLE- -->
<hr width="33%" align="left"/>
<a name="SUBTITLE"></a>
<p>
<nobr>Macro: <strong>SUBTITLE</strong> <kbd>[COVER | DOC_COVER] "<subtitle>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd></nobr>
<br/>
<em>*String arguments must be enclosed in double-quotes</em>
</p>
<p>
The subtitle string can be caps or caps/lower-case. I recommend
caps/lower case.
</p>
<p>
<strong>SUBTITLE</strong> 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 <strong>SUBTITLE</strong>, 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:
<pre>
.SUBTITLE "The Docheader Subtitle"
.SUBTITLE DOC_COVER "The Document Cover Subtitle"
.SUBTITLE COVER "The Cover Subtitle"
</pre>
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 "SUBTITLE" 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- -->
<hr width="33%" align="left"/>
<a name="AUTHOR"></a>
<p>
<nobr>Macro: <strong>AUTHOR</strong> <kbd>[COVER | DOC_COVER] "<author>" [ "<author2>" ["<author3>" ... ] ]</kbd></nobr>
<br/>
Alias: <strong>EDITOR</strong>
<br/>
<em>*String arguments must be enclosed in double-quotes</em>
</p>
<p>
Each author string can hold as many names as you like, e.g.
<pre>
.AUTHOR "Joe Blow"
or
.AUTHOR "Joe Blow, Jane Doe" "John Hancock"
</pre>
</p>
<p>
<strong>Mom</strong> prints each string that's enclosed in
double-quotes on a separate line in the
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
however only the first string appears in
<a href="definitions.html#TERMS_HEADER">page headers</a>.
If you want <strong>mom</strong> 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 <strong>AUTHOR</strong>, 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:
<pre>
.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)"
</pre>
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 "AUTHOR" 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- -->
<hr width="33%" align="left"/>
<a name="CHAPTER"></a>
<p>
<nobr>Macro: <strong>CHAPTER</strong> <kbd><chapter number></kbd></nobr>
</p>
<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>,
<strong>mom</strong> prints whatever argument you pass
<strong>CHAPTER</strong> beside the word "Chapter" as a
single line
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>.
She also puts the same thing in the middle of
<a href="definitions.html#TERMS_HEADER">page headers</a>.
</p>
<p>
Please note that if your argument to <strong>CHAPTER</strong> runs
to more than one word, you must enclose the argument in
double-quotes.
</p>
<p>
If you're not using <strong>DOCTYPE CHAPTER</strong>, the macro can
be used to identify any document as a chapter <em>for the purpose of
prepending a chapter number to numbered head elements</em>, provided
you pass it a
<a href="definitions.html#TERMS_NUMERICARGUMENT">numeric argument</a>.
See
<a href="docelement.html#PREFIX_CHAPTER_NUMBER">PREFIX_CHAPTER_NUMBER</a>.
</p>
<!-- -CHAPTER_STRING- -->
<a name="CHAPTER_STRING"><h4><u>The chapter string</u></h4></a>
<p>
If you're not writing in English, you can ask <strong>mom</strong>
to use the word for "chapter" in your own language by
telling her what it is with the <strong>CHAPTER_STRING</strong>
macro, like this:
<pre>
.CHAPTER_STRING "Chapître"
</pre>
</p>
<p>
You can also use <strong>CHAPTER_STRING</strong> if you want
"CHAPTER" instead of "Chapter" in the doc-and
page-headers.
</p>
<!-- -CHAPTER_TITLE- -->
<hr width="33%" align="left"/>
<a name="CHAPTER_TITLE"></a>
<p>
<nobr>Macro: <strong>CHAPTER_TITLE</strong> "<chapter title>" ["<2nd line>" ["<3rd line>" ... ] ]</nobr>
<br/>
<em>*Arguments must be enclosed in double-quotes</em>
</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 <strong>CHAPTER_TITLE</strong>, with
your title enclosed in double-quotes, like this:
<pre>
.CHAPTER_TITLE "The DMCA Nazis"
</pre>
</p>
<p>
<strong>CHAPTER_TITLE</strong> 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:
<pre>
Chapter 1
The DMCA Nazis
</pre>
</p>
<p>
In such a case, by default, only the chapter's title will appear in
the
<a href="definitions.html#TERMS_HEADER">page headers</a>,
not "Chapter <n>".
</p>
<p>
If you omit <strong>CHAPTER</strong> 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>,
e.g. <strong>CHAPTER_TITLE_FAMILY</strong>,
<strong>CHAPTER_TITLE_FONT</strong>, etc. The default family,
font and point size are Times Roman, Bold Italic, 4 points larger
than
<a href="definitions.html#TERMS_RUNNING">running text</a>.
</p>
<!-- -DRAFT- -->
<hr width="33%" align="left"/>
<a name="DRAFT"></a>
<p>
<nobr>Macro: <strong>DRAFT</strong> <kbd><draft number></kbd></nobr>
</p>
<p>
<strong>DRAFT</strong> only gets used with
<a href="#COPYSTYLE">COPYSTYLE DRAFT</a>.
If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong> (the
default), <strong>mom</strong> ignores <strong>DRAFT</strong>.
<strong>DRAFT</strong> accepts both alphabetic and numeric
arguments, hence it's possible to do either
<pre>
.DRAFT 2
or
.DRAFT Two
</pre>
</p>
<p>
<strong>Mom</strong> prints the argument to <kbd>.DRAFT</kbd> (i.e.
the draft number) beside the word "Draft" in the middle
part of
<a href="definitions.html#TERMS_HEADER">page headers</a>.
</p>
<p>
<strong>A small word of caution:</strong> If your argument to
<kbd>.DRAFT</kbd> is more than one word long, you must enclose the
argument in double-quotes.
</p>
<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- -->
<a name="DRAFT_STRING"><h4><u>The draft string</u></h4></a>
<p>
If you're not writing in English, you can ask <strong>mom</strong>
to use the word for "draft" in your own language by
telling her what it is with the <strong>DRAFT_STRING</strong> macro,
like this:
<pre>
.DRAFT_STRING "Jet"
</pre>
</p>
<p>
Equally, <strong>DRAFT_STRING</strong> 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
<pre>
.DRAFT alpha-three
.DRAFT_STRING "Trial run
</pre>
</p>
<p>
<kbd>.DRAFT</kbd> without an argument, above, ensures that only the
<strong>DRAFT_STRING</strong> gets printed.
</p>
<p>
<strong>NOTE:</strong> If you define both a blank <kbd>.DRAFT</kbd>
and a blank <kbd>.DRAFT_STRING</kbd>, <strong>mom</strong> skips the
draft field in headers entirely. If this is what you want, this is
also the only way to do it. Simply omitting a <kbd>.DRAFT</kbd> and
<kbd>.DRAFT_STRING</kbd> will result in <strong>mom</strong> using
her default, which is to print "Draft <number>".
</p>
<!-- -REVISION- -->
<hr width="33%" align="left"/>
<a name="REVISION"></a>
<p>
<nobr>Macro: <strong>REVISION</strong> <kbd><revision number></kbd></nobr>
</p>
<p>
<strong>REVISION</strong> only gets used with
<a href="#COPYSTYLE">COPYSTYLE DRAFT</a>.
If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong>
(the default), <strong>mom</strong> ignores the
<strong>REVISION</strong> macro. <strong>REVISION</strong> accepts
both alphabetic and numeric arguments, hence it's possible to do
either
<pre>
.REVISION 2
or
.REVISION Two
</pre>
</p>
<p>
<strong>Mom</strong> prints the revision number beside the shortform
"Rev." in the middle part of
<a href="definitions.html#TERMS_HEADER">page headers</a>.
</p>
<p>
<strong>A small word of caution:</strong> If your argument to
<kbd>.REVISION</kbd> is more than one word long, you must
enclose the argument in double-quotes.
</p>
<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- -->
<a name="REVISION_STRING"><h4><u>The revision string</u></h4></a>
<p>
If you're not writing in English, you can ask <strong>mom</strong>
to use the word for "revision," or a shortform
thereof, in your own language by telling her what it is with the
<strong>REVISION_STRING</strong> macro, like this:
<pre>
.REVISION_STRING "Rév."
</pre>
</p>
<p>
Additionally, you may sometimes want to make use of
<strong>mom</strong>'s
<a href="#COPYSTYLE">COPYSTYLE DRAFT</a>
but not actually require any draft information. For example, you
might like <strong>mom</strong> 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:
<pre>
.DRAFT
.DRAFT_STRING
.REVISION 2
</pre>
</p>
<p>
Equally, if you want to roll your own solution to what revision
information appears in headers, you could do something like this:
<pre>
.DRAFT
.DRAFT_STRING
.REVISION "two-twenty-two"
.REVISION_STRING "Revision"
</pre>
</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- -->
<hr width="33%" align="left"/>
<a name="COPYRIGHT"></a>
<p>
<nobr>Macro: <strong>COPYRIGHT</strong> <kbd>[COVER | DOC_COVER] "<copyright info>"</kbd></nobr>
<br/>
<em>*Argument must be enclosed in double-quotes</em>
</p>
<p>
The argument passed to <strong>COPYRIGHT</strong> 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
<strong>COPYRIGHT</strong>; <strong>mom</strong> puts it in for
you.
</p>
<p>
If the optional argument, <kbd>COVER</kbd> or <kbd>DOC_COVER</kbd>,
is given to <strong>COPYRIGHT</strong>, 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:
<pre>
.COPYRIGHT DOC_COVER "2006 John Smith and Jane Doe"
.COPYRIGHT COVER "2002 Joe Blow"
</pre>
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
"COPYRIGHT" 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- -->
<hr width="33%" align="left"/>
<a name="MISC"></a>
<p>
<nobr>Macro: <strong>MISC</strong> <kbd>[COVER | DOC_COVER] "<argument 1>" ["<argument 2>" "<argument 3>" ...]</kbd></nobr>
<br/>
<em>*String arguments must be enclosed in double-quotes</em>
</p>
<p>
The argument(s) passed to <strong>MISC</strong> 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>.
<strong>MISC</strong> 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
<pre>
.MISC "Music History 101" "Professor Hasbeen" "Dec. 24, 2006"
</pre>
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 <strong>MISC</strong>, 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:
<pre>
.MISC DOC_COVER "Music History 101" "Professor Hasbeen"
.MISC COVER "Spring Term Paper"
</pre>
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- -->
<hr width="33%" align="left"/>
<a name="COVERTITLE"></a>
<p>
<nobr>Macro: <strong>COVERTITLE</strong> <kbd>"<user defined cover page title>" ["<2nd line>" ["<3rd line>" ... ] ]</kbd></nobr>
<br/>
<a name="DOC_COVERTITLE"></a>
<nobr>Macro: <strong>DOC_COVERTITLE</strong> "<user defined document cover page title>" ["<2nd line>" ["<3rd line>" ... ] ]</nobr>
<br/>
<em>*Arguments must be enclosed in double-quotes</em>
</p>
<p>
The arguments passed to <strong>COVERTITLE</strong> or
<strong>DOC_COVERTITLE</strong> are only used on cover or doc cover
pages, and then only if the argument 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 <strong>COVERTITLE</strong> or
<strong>DOC_COVERTITLE</strong> is when none of the required first
arguments to <strong>COVER</strong> or <strong>DOC_COVER</strong>
fits your needs for the title you want to appear on cover (or doc
cover) pages.
</p>
<p>
<strong>COVERTITLE</strong> and <strong>DOC_COVERTITLE</strong>
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>
<hr/>
<!-- ======================================================================== -->
<a name="DOCSTYLE_MACROS"><h2><u>The Docstyle Macros</u></h2></a>
<p>
The docstyle macros tell <strong>mom</strong> what type of
document you're writing, whether you want the output typeset or
"typewritten", and whether you want a draft copy (with
draft and revision information in the headers) or a final copy.
</p>
<a name="INDEX_DOCSTYLE"><h3><u>Docstyle macros list</u></h3></a>
<ul>
<li><a href="#DOCTYPE">DOCTYPE</a></li>
<li><a href="#PRINTSTYLE">PRINTSTYLE</a></li>
<ul>
<li><a href="#TYPESET_DEFAULTS">Defaults for PRINTSTYLE TYPESET</a></li>
<li><a href="#TYPEWRITE_DEFAULTS">Defaults for PRINTSTYLE TYPEWRITE</a></li>
<ul>
<li><a href="#TYPEWRITE_CONTROL">TYPEWRITE control macros</a></li>
</ul>
</ul>
<li><a href="#COPYSTYLE">COPYSTYLE</a></li>
</ul>
<!-- -DOCTYPE- -->
<hr width="66%" align="left"/>
<a name="DOCTYPE"></a>
<p>
<nobr>Macro: <strong>DOCTYPE</strong> <kbd>DEFAULT | CHAPTER | NAMED "<name>" | LETTER</kbd></nobr>
</p>
<p>
The arguments <kbd>DEFAULT, CHAPTER</kbd> and
<kbd>NAMED</kbd> tell <strong>mom</strong> what to put in the
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>
and
<a href="definitions.html#TERMS_HEADER">page headers</a>.
<kbd>LETTER</kbd> tells her that you want to write a letter.
</p>
<p>
<strong>Mom</strong>'s default <strong>DOCTYPE</strong> is
<kbd>DEFAULT</kbd>. If that's what you want, you don't
have to give a <strong>DOCTYPE</strong> command.
</p>
<h4><u>DEFAULT</u></h4>
<p>
<strong>DEFAULT</strong> prints a
<a href="definitions.html#TERMS_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 <strong>mom</strong> outputs each part of the page header.)
</p>
<h4><u>CHAPTER</u></h4>
<p>
<strong>CHAPTER</strong> prints "Chapter <n>" in place of a
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>
<nobr>(<kbd><n></kbd></nobr> is what you gave to the
<a href="#REFERENCE_MACROS">reference macro</a>
<a href="#CHAPTER">CHAPTER</a>).
If you give the chapter a title with
<a href="#CHAPTER_TITLE">CHAPTER TITLE</a>,
<strong>mom</strong> 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>,
<strong>mom</strong> prints only the chapter title. <em>(*For
backward compatibility with pre-1.1.5 versions of</em>
<strong>mom</strong><em>, you can also supply a chapter title by
omitting the</em> <strong>CHAPTER</strong> <em>reference macro and
supplying a chapter title with</em>
<a href="#CHAPTER_STRING">CHAPTER_STRING</a>.)
</p>
<p>
The page headers in <strong>DOCTYPE CHAPTER</strong> 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 <strong>mom</strong>'s default type parameters for each part of
the page header.
</p>
<h4><u>NAMED</u></h4>
<p>
<strong>NAMED</strong> takes an additional argument: a name
for this particular kind of document (e.g. outline, synopsis,
abstract, memorandum), enclosed in double-quotes.
<strong>NAMED</strong> is identical to <strong>DEFAULT</strong>
except that <strong>mom</strong> prints the argument to
<strong>NAMED</strong> beneath the
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
as well as in page headers.
(See
<a href="headfootpage.html#HEADER_STYLE">Default specs for headers</a>
for how <strong>mom</strong> 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 <strong>DOCTYPE NAMED</strong>
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 <strong>DOCTYPE</strong> entry would look like:
<pre>
.DOCTYPE NAME "Warning" red
</pre>
</p>
<p>
By default, the string passed to <strong>DOCTYPE NAMED</strong> 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>
<a name="DOCTYPE_UNDERLINE"><h5><u>The DOCTYPE_UNDERLINE macro</u></h5></a>
<p>
Formerly, this underlining was carved in stone. As of version
1.5 of <strong>mom</strong>, you can now use the macro
<strong>DOCTYPE_UNDERLINE</strong> to set the weight of the
underline and its distance from the doctype-name <em>in the
docheader</em> (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.
<strong>Mom</strong>'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#TERMS_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#TERMS_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.
<strong>Mom</strong>'s default for head underlines 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 head to
the upper edge of the underline. <strong>Mom</strong>'s default
gap for named-doctype underlines is 2 points.
</p>
<p>
As an example, supposed you want the doctype-name underlined in the
docheader with a 2-point rule separated from the head by 3 points.
The way to accomplish that is:
<pre>
.DOCTYPE_UNDERLINE 2 3p
</pre>
If you wanted the same thing, but were content with
<strong>mom</strong>'s default gap of 2 points,
<pre>
.DOCTYPE_UNDERLINE 4
</pre>
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><nobr>.DOCTYPE_UNDERLINE
OFF</nobr></kbd> (or <strong>NO</strong>, <strong>X</strong>, etc.)
</p>
<p>
Please note that if you supply a weight to
<strong>DOCTYPE_UNDERLINE</strong>, 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 head underlining off manually
afterwards.
</p>
<h4><u>LETTER</u></h4>
<p>
<strong>LETTER</strong> tells mom you're writing a letter. See
the section
<a href="letters.html#LETTERS">Writing Letters</a>
for instructions on using <strong>mom</strong> to format letters.
</p>
<!-- -PRINTSTYLE- -->
<hr width="33%" align="left"/>
<a name="PRINTSTYLE"></a>
<p>
<nobr>Macro: <strong>PRINTSTYLE</strong> <kbd>TYPESET | TYPEWRITE [ SINGLESPACE ]</kbd></nobr>
<br/>
<em>*Required for document processing</em>
<br/>
<em>*Must come before any changes to default document style</em>
</p>
<p>
<strong>PRINTSTYLE</strong> tells <strong>mom</strong> whether to typeset
a document, or to print it out "typewritten, doubled-spaced".
</p>
<p>
<strong>THIS MACRO MAY NOT BE OMITTED.</strong> In order for
document processing to take place, <strong>mom</strong> requires
a <strong>PRINTSTYLE</strong>. If you don't give one,
<strong>mom</strong> will warn you on stderr and print a single
page with a nasty message.
</p>
<p>
Furthermore, <strong>PRINTSTYLE</strong> must come before any
changes to <strong>mom</strong>'s default typestyle parameters.
(This applies primarily to, but is by no means restricted to,
<strong>PRINTSTYLE TYPESET</strong>.) <strong>PRINTSTYLE</strong>
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>
<p>
<strong>TYPESET</strong>, 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, <strong>PRINTSTYLE TYPESET</strong> must come
before any changes to <strong>mom</strong>'s default typographic
settings. For example,
<pre>
.PAPER A4
.LS 14
.PRINTSTYLE TYPESET
</pre>
will not changes <strong>mom</strong>'s default paper size to A4,
nor her default document leading 14 points, whereas
<pre>
.PRINTSTYLE TYPESET
.PAPER A4
.LS 14
</pre>
will.
</p>
<p>
With <strong>TYPEWRITE</strong>, <strong>mom</strong> 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#TERMS_LEADING">leading</a>
are (mostly) ignored. An important exception is
<a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a>
(and, by extension, <strong>FOOTER_SIZE</strong>), which allows
you to reduce the point size of headers/footers should they become
too crowded. Most of <strong>mom</strong>'s inlines affecting the
appearance of type are also ignored (<kbd>\*S</kbd> is an exception;
there may be a few others).
</p>
<p>
In short, <strong>TYPEWRITE</strong> never produces effects
other than those available on a typewriter. Don't be fooled by
how brainless this sounds; <strong>mom</strong> is remarkably
sophisticated when it comes to conveying the typographic sense of a
document within the confines of <strong>TYPEWRITE</strong>.
</p>
<p>
The primary uses of <strong>TYPEWRITE</strong> 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 <strong>TYPEWRITE</strong> to
<strong>TYPESET</strong> and print out a copy.
</p>
<p>
If, for some reason, you would prefer the output
of <strong>TYPEWRITE</strong> single-spaced, pass
<strong>PRINTSTYLE TYPEWRITE</strong> the optional argument,
<strong>SINGLESPACE</strong>.
</p>
<p>
If you absolutely must have a leading other than typewriter double-
or singlespaced, the only way to get it is with the
<a href="#DOC_LEAD">DOC_LEAD</a>
macro, and then ONLY if <strong>DOC_LEAD</strong> is set
<strong>before</strong> you invoke the <kbd>.START</kbd>
macro.
</p>
<a name="TYPESET_DEFAULTS"><h3><u>TYPESET defaults</u></h3></a>
<pre>
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
</pre>
<a name="TYPEWRITE_DEFAULTS"><h3><u>TYPEWRITE defaults</u></h3></a>
<pre>
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
</pre>
<a name="TYPEWRITE_CONTROL"><h3><u>PRINTSTYLE TYPEWRITE control macros</u></h3></a>
<p>
In <strong>PRINTSTYLE TYPEWRITE</strong>, <strong>mom</strong>,
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#TERMS_INLINES">inline escape</a>
for pseudo-italics.
</p>
<p>
If you'd prefer that <strong>mom</strong> were less bloody-minded
about pretending to be a typewriter (i.e. you'd like italics and
pseudo-italics to come out as italics), use the control macros
<kbd>.ITALIC_MEANS_ITALIC</kbd> and <kbd>.SLANT_MEANS_SLANT</kbd>.
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>
<a name="UNDERLINE_QUOTES"></a>
<p>
Additionally, by default, <strong>mom</strong> underlines
<a href="definitions.html#TERMS_QUOTES">quotes</a>
(but not
<a href="definitions.html#TERMS_BLOCKQUOTES">blockquotes</a>)
in <strong>PRINTSTYLE TYPEWRITE</strong>.
If you don't like this behaviour, turn it off with
<pre>
.UNDERLINE_QUOTES OFF
</pre>
</p>
<p>
To turn underlining of quotes back on, use
<strong>UNDERLINE_QUOTES</strong> without an argument.
</p>
<p>
While most of the
<a href="docelement.html#DOCELEMENT_CONTROL">control macros</a>
have no effect on <strong>PRINTSTYLE TYPEWRITE</strong>, there
is an important exception:
<a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a>
(and by extension, <strong>FOOTER_SIZE</strong>). 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
<a href="#COPYSTYLE">COPYSTYLE</a>
is <strong>DRAFT</strong>).
</p>
<!-- -COPYSTYLE- -->
<hr width="33%" align="left"/>
<a name="COPYSTYLE"></a>
<p>
<nobr>Macro: <strong>COPYSTYLE</strong> <kbd>DRAFT | FINAL</kbd></nobr>
</p>
<p>
<strong>Mom</strong>'s default <strong>COPYSTYLE</strong> is
<strong>FINAL</strong>, so you don't have to use this macro unless
you want to.
</p>
<p>
<strong>COPYSTYLE DRAFT</strong> exhibits the following behaviour:
<ol>
<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#TERMS_HEADER">page headers</a>
(or footers, depending on which you've selected) along with
any other information that normally appears there.
</li>
</ol>
</p>
<p>
<strong>IMPORTANT:</strong> 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>
<p>
<strong>COPYSTYLE FINAL</strong> differs from <strong>DRAFT</strong> in that:
<ol>
<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>
</p>
<p>
<a name="COPYSTYLE_NOTE"><strong>NOTE:</strong></a>
The centre part of page headers can get crowded,
especially with
<a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a>
and
<a href="docprocessing.html#DOCTYPE">DOCTYPE NAMED</a>,
when the <strong>COPYSTYLE</strong> is <strong>DRAFT</strong>.
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 TYPESET</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>
<hr/>
<!-- ======================================================================== -->
<a name="START_MACRO"><h2><u>Initiate document processing</u></h2></a>
<p>
In order to use <strong>mom</strong>'s document element macros
(tags), you have to tell her you want them. The macro to do this is
<strong>START</strong>.
</p>
<p>
<strong>START</strong> collects the information you gave
<strong>mom</strong> 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 <strong>mom</strong> to process your document using
the document element tags. No document processing takes place until
you invoke <kbd>.START</kbd>.
</p>
<!-- -START- -->
<hr width="66%" align="left"/>
<a name="START"></a>
<p>
<nobr>Macro: <strong>START</strong></nobr>
<br/>
<em>*Required for document processing.</em>
</p>
<p>
<strong>START</strong> takes no arguments. It simply instructs
<strong>mom</strong> to begin document processing. If you don't
want document processing (i.e. you only want the
<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>),
don't use <strong>START</strong>.
</p>
<p>
At a barest minimum before <strong>START</strong>, you must enter a
<a href="#PRINTSTYLE">PRINTSTYLE</a>
command.
</p>
<hr/>
<!-- ======================================================================== -->
<a name="STYLE_BEFORE_START"><h2><u>Changing global typesetting and formatting parameters before START</u></h2></a>
<p>
In the third (optional) part of setting up a document (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 <strong>mom</strong>'s document-wide defaults for margins,
line length, family, base point size,
<a href="definitions.html#TERMS_LEADING">leading</a>,
and justification style.
</p>
<p>
Two additional style concerns have to be addressed here (i.e. in
macros before
<a href="#START">START</a>):
changes to the
<a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
and whether you want you want the document's nominal leading
adjusted to fill pages fully to the bottom margin.
</p>
<ul>
<li><a href="#TYPE_BEFORE_START">Using the typesetting macros before START</a></li>
<li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
— adjusting linespacing for equal, accurate bottom margins
</li>
<li><a href="#DOCHEADER">DOCHEADER</a>
— turning the docheader off
</li>
<ul>
<li><a href="#DOCHEADER_CONTROL">Docheader control</a></li>
</ul>
</ul>
<hr width="66%" align="left"/>
<a name="TYPE_BEFORE_START"><h3><u>Using the typesetting macros before START</u></h3></a>
<p>
From time to time (or maybe frequently), you'll want the overall
look of a document to differ from <strong>mom</strong>'s defaults.
Perhaps you'd like her to use a different
<a href="definitions.html#TERMS_FAMILY">family</a>,
or a different overall
<a href="definitions.html#TERMS_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) <strong>after</strong>
<a href="#PRINTSTYLE">PRINTSTYLE</a>
and <strong>before</strong>
<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 "<u>after <strong>PRINTSTYLE</strong></u>".
</p>
<p>
Changes to any aspect of the default look and/or formatting
of a <strong>mom</strong> document must come after
<strong>PRINTSTYLE</strong>. For example, it might seem natural to
set up page margins at the very top of a document with
<pre>
.L_MARGIN 1i
.R_MARGIN 1.5i
</pre>
</p>
<p>
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 <strong>after
PRINTSTYLE</strong>.
</p>
<p>
<strong>NOTE:</strong> Don't use the macros listed in
<a href="#DOC_PARAM_MACROS">Changing document-wide typesetting parameters after START</a>
prior to <strong>START</strong>; they are exclusively for use
afterwards.
</p>
<p>
When used before <strong>START</strong>, the
<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
(below) have the following meanings:
<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 (i.e. not
headers/footers or page numbers) starts on each page
B_MARGIN* The point at which running text (i.e. 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 (e.g. 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 <a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
***See <a href="#LRC_NOTE">Special note</a>
</pre>
</p>
<p>
Other macros that deal with type style, or refinements thereof
(<strong>KERN, LIGATURES, HY, WS, SS,</strong> etc.), behave normally.
It is not recommended that you set up tabs or indents prior to
<strong>START</strong>.
</p>
<p>
If you want to change any of the basic parameters (above)
<em>after</em> <strong>START</strong> and have them affect a
document globally (as if you'd entered them <em>before</em>
<strong>START</strong>), you must use the macros listed in
<a href="#DOC_PARAM_MACROS">Changing document-wide style parameters after START</a>.
</p>
<a name="LRC_NOTE"><h4><u>Special note on LEFT, RIGHT and CENTER prior to START</u></h4></a>
<p>
In a word, these three macros have no effect on document processing
when invoked prior to <strong>START</strong>.
</p>
<p>
All <strong>mom</strong>'s document element tags
(<strong>PP</strong>, <strong>HEAD</strong>,
<strong>BLOCKQUOTE</strong>, <strong>FOOTNOTE</strong>, etc.)
except
<a href="docelement.html#QUOTE">QUOTE</a>
set a
<a href="definitions.html#TERMS_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
<nobr><a href="typesetting.html#LRC">LEFT, RIGHT or CENTER</a>)</nobr>
you must do so immediately after invoking the tag. Furthermore,
the change affects <em>only</em> 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- -->
<hr align="left" width="66%"/>
<a name="INCLUDE"><h2><u>Including (sourcing) style sheets and files</u></h2></a>
<p>
If you routinely make the same changes to <strong>mom</strong>'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
<strong>mom</strong> documents with the macro,
<strong>INCLUDE</strong>. 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.
<pre>
.HEAD_FAMILY H
.HEAD_FONT BI
.HEAD_QUAD L
.HEAD_UNDERLINE OFF
</pre>
Then, in the preliminary document set-up section of your main file,
you'd include the style sheet, or template, like this:
<pre>
.TITLE "Sample Document
.AUTHOR "Joe Blow
.PRINTSTYLE TYPESET
\#
.INCLUDE head_template
\#
.START
</pre>
The blank comment lines <nobr>( <kbd>\#</kbd> )</nobr> 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:
<pre>
.TITLE "Sample Document
.AUTHOR "Joe Blow
.PRINTSTYLE TYPESET
\#
.INCLUDE /home/joe/style_sheets/head_template
\#
.START
</pre>
</p>
<p>
<strong>INCLUDE</strong> 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
<strong>mom</strong> formatting commands. Neither is
<strong>INCLUDE</strong> restricted to use with
<strong>mom</strong>'s document processing macros. You can use it
in plain typeset documents as well.
</p>
<p>
<strong>EXPERTS: INCLUDE</strong> is an alias for the groff
request, <kbd>.so</kbd>. Mix 'n' match with impunity.
</p>
<!-- -COLOUR- -->
<hr align="left" width="66%"/>
<a name="COLOR"><h2><u>Initializing colours</u></h2></a>
<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
<a href="#START">START</a>.
</p>
<p>
The macro,
<a href="color.html#COLOR">COLOR</a>,
and the
<a href="definitions.html#TERMS_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>
<p>
<strong>PLEASE NOTE:</strong> If you plan to have <strong>mom</strong>
generate a
<a href="docelement.html#TOC">table of contents</a>,
do NOT embed colour
<a href="definitions.html#TERMS_INLINES">inline escapes</a>
(<a href="color.html#COLOR_INLINE"><kbd>\[<colorname>]</kbd></a>)
in the
<a href="definitions.html#TERMS_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#TERMS_CONTROLMACRO">control macros</a>
<strong>mom</strong> provides to automatically colourize these
elements.
</p>
<!-- -DOC LEAD ADJUST- -->
<hr align="left" width="66%"/>
<a name="DOC_LEAD_ADJUST"><h2><u>Adjust a document's leading to fill pages</u></h2></a>
<p>
<nobr>Macro: <strong>DOC_LEAD_ADJUST</strong> <kbd>toggle</kbd></nobr>
<br/>
<em>*Must come after LS or AUTOLEAD and before START</em>
</p>
<p>
<strong>DOC_LEAD_ADJUST</strong> is a special macro to adjust
document
<a href="definitions.html#TERMS_LEADING">leading</a>
so that bottom margins fall precisely where you expect.
</p>
<p>
If you invoke <kbd>.DOC_LEAD_ADJUST</kbd>, <strong>mom</strong>
takes the number of lines that fit on the page at your requested
leading, then incrementally adds
<a href="definitions.html#TERMS_UNITS">machine units</a>
to the leading until the maximum number of lines at the new leading
matches the bottom margin. 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 <strong>mom</strong>'s default.
</p>
<p>
Should you NOT want adjusted document leading, you MUST turn it
off manually, like this:
<pre>
.DOC_LEAD_ADJUST OFF
</pre>
</p>
<p>
If you set the document leading prior to <strong>START</strong>
with
<a href="typesetting.html#LEADING">LS</a>
or
<a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>,
<strong>DOC_LEAD_ADJUST OFF</strong> must come afterwards, like
this:
<pre>
.LS 12
.DOC_LEAD_ADJUST OFF
</pre>
</p>
<p>
In this scenario, the maximum number of lines that fit on a page at
a
<a href="definitions.html#TERMS_LEADING">leading</a>
of 12
<a href="definitions.html#TERMS_PICASPOINTS">points</a>
determine where <strong>mom</strong> 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>
<strong>TYPEWRITE</strong>, the leading is always adjusted and
can't be turned off.
</p>
<p>
<strong>NOTE:</strong> <strong>DOC_LEAD_ADJUST</strong>, 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>
<strong>ADDITIONAL NOTE:</strong> Even if you disable
<strong>DOC_LEAD_ADJUST</strong>, <strong>mom</strong> 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>
<!-- -DOCHEADER- -->
<hr align="left" width="66%"/>
<a name="DOCHEADER"><h2><u>Managing the docheader</u></h2></a>
<p>
<nobr>Macro: <strong>DOCHEADER</strong> <kbd><toggle> [ distance to advance from top of page ]</kbd></nobr>
<br/>
<em>*Must come before</em> START; <kbd>distance</kbd> <em>requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
</p>
<p>
By default, <strong>mom</strong> prints a
<a href="definitions.html#TERMS_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
<pre>
.DOCHEADER OFF
</pre>
</p>
<p>
<strong>DOCHEADER</strong> is a toggle macro, so the argument doesn't
have to be <strong>OFF</strong>; it can be anything you like.
</p>
<p>
If you turn the docheader off, <strong>mom</strong>, by default, starts
the running text of your document on the same top
<a href="definitions.html#TERMS_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.
<pre>
.DOCHEADER OFF 1.5i
</pre>
</p>
<p>
This starts the document 1.5 inches from the top of the page PLUS
whatever spacing adjustment <strong>mom</strong> has to make in
order to ensure that the first baseline of running text falls on a
"valid" baseline (i.e. 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#TERMS_BASELINE">baseline</a>
of the first line of type.
</p>
<p>
<strong>TIP:</strong> 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 <strong>START</strong> (if
you don't like the way <strong>mom</strong> does things) and use
<strong>DOCHEADER OFF</strong> with its optional distance argument
to ensure that the body of your document starts where you want. You
can even insert a PostScript file (with <kbd>.PSPIC</kbd>; see the
<strong>groff_tmac</strong> man page for usage).
</p>
<!-- DOCHEADER CONTROL -->
<a name="DOCHEADER_CONTROL"><h3><u>How to change the look of docheaders: docheader control macros</u></h3></a>
<p>
With
<a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
the look of docheaders is carved in stone.
In
<a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
however, you can make a lot of changes. Macros that alter docheaders
MUST come before
<a href="#START">START</a>.
</p>
<a name="DOCHEADER_DESC"></a>
<p>
A typeset docheader has the following characteristics. Note that
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; <strong>mom</strong> will
compensate:
<pre>
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
</pre>
</p>
<p>
If the
<a href="#DOCTYPE">DOCTYPE</a>
is CHAPTER,
<pre>
Chapter <n> bold, 4 points larger than running text
Chapter Title bold italic, 4 points larger than running text
</pre>
</p>
<p>
The
<a href="definitions.html#TERMS_FAMILY">family</a>
is the prevailing family of the whole document.
</p>
<p>
<strong>NOTE:</strong> If your <strong>DOCTYPE</strong> is
<strong>CHAPTER</strong> and you have both "Chapter
<n>" and a "Chapter Title" (as above),
<strong>mom</strong> inserts a small amount of whitespace between
them, equal to one-quarter of the
<a href="definitions.html#TERMS_LEADING">leading</a>
in effect. If this doesn't suit you, you can alter the space
by including the
<a href="definitions.html#TERMS_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:
<pre>
.CHAPTER_TITLE "\*[DOWN 2p]Why Not Patent Calculus?"
or
.CHAPTER_TITLE "\*[UP 2p]Why Not Patent Calculus?"
</pre>
</p>
<a name="DOCHEADER_CONTROL_INDEX"><h4><u>The docheader macros to:</u></h4></a>
<ol>
<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="#ADJUST_LEADING">Adjust the docheader leading</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 docheader elements</a></li>
<li><a href="#CHANGE_COLOR">Change the colour of the docheader</a></li>
<li><a href="#CHANGE_SIZE">Adjust the size of docheader elements</a></li>
<li><a href="#CHANGE_ATTRIBUTE">Change the attribution string ("by")</a></li>
</ol>
<a name="CHANGE_START"><h5><u>1. Change the starting position</u></h5></a>
<p>
By default, a docheader starts on the same
<a href="definitions.html#TERMS_BASELINE">baseline</a>
as
<a href="definitions.html#TERMS_RUNNING">running text</a>.
If you'd like it to start somewhere else, use the macro
<kbd>.DOCHEADER_ADVANCE</kbd> and give it the distance you want
(measured from the top edge of the paper to the first baseline
of the docheader), like this:
<pre>
.DOCHEADER_ADVANCE 4P
</pre>
A
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
is required.
</p>
<p>
<strong>NOTE:</strong> If
<a href="headfootpage.html#HEADERS">HEADERS</a>
are <strong>OFF</strong>, <strong>mom</strong>'s normal top
margin for
<a href="definitions.html#TERMS_RUNNING">running text</a>
(7.5
<a href="definitions.html#TERMS_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
<a href="#CHANGE_START">DOCHEADER_ADVANCE</a>
to place them where you want.
</p>
<a name="DOCHEADER_QUAD"><h5><u>2. Change the quad direction of the docheader</u></h5></a>
<p>
By default, <strong>mom</strong> 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>
<a name="DOCHEADER_FAMILY"><h5><u>3. Change the family of the entire docheader</u></h5></a>
<p>
By default, <strong>mom</strong> sets the docheader in the same
family used for
<a href="definitions.html#TERMS_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 for <strong>DOCHEADER_FAMILY</strong> is the same as
for
<a href="typesetting.html#FAMILY">FAMILY</a>.
</p>
<p>
For example, <strong>mom</strong>'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,
<pre>
.DOCHEADER_FAMILY H
</pre>
is how you'd do it.
</p>
<p>
Please note that if you use <strong>DOCHEADER_FAMILY</strong>,
you can still alter the family of individual parts of the docheader
with the macros listed
<a href="#CHANGE_FAMILY">here</a>.
</p>
<a name="ADJUST_LEADING"><h5><u>4. Adjust the leading</u></h5></a>
<p>
The
<a href="definitions.html#TERMS_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:
<pre>
.DOCHEADER_LEAD +2
</pre>
</p>
<p>
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#TERMS_UNITOFMEASURE">unit of measure</a>
is required; points is assumed.
</p>
<a name="CHANGE_FAMILY"><h5><u>5. Change the family of docheader elements</u></h5></a>
<p>
The following macros let you change the
<a href="definitions.html#TERMS_FAMILY">family</a>
of each docheader element separately:
<ul>
<li><nobr><kbd>.TITLE_FAMILY <family></kbd></nobr></li>
<li><nobr><kbd>.CHAPTER_TITLE_FAMILY <family></kbd></nobr></li>
<li><nobr><kbd>.SUBTITLE_FAMILY <family></kbd></nobr></li>
<li><nobr><kbd>.AUTHOR_FAMILY <family></kbd></nobr></li>
<li><nobr><kbd>.DOCTYPE_FAMILY <family></kbd></nobr>
(if <a href="#DOCTYPE">DOCTYPE</a> is NAMED)
</li>
</ul>
</p>
<p>
Simply pass the appropriate macro the family you want, just as you
would with
<a href="typesetting.html#FAMILY">FAMILY</a>.
</p>
<a name="CHANGE_FONT"><h5><u>6. Change the font of docheader elements</u></h5></a>
<p>
The following macros let you change the
<a href="definitions.html#TERMS_FONT">font</a>
of each docheader element separately:
<ul>
<li><nobr><kbd>.TITLE_FONT R | B | I | BI</kbd></nobr></li>
<li><nobr><kbd>.CHAPTER_TITLE_FONT R | B | I | BI</kbd></nobr></li>
<li><nobr><kbd>.SUBTITLE_FONT R | B | I | BI</kbd></nobr></li>
<li><nobr><kbd>.AUTHOR_FONT R | B | I | BI</kbd></nobr></li>
<li><nobr><kbd>.DOCTYPE_FONT R | B | I | BI</kbd></nobr>
(if <a href="#DOCTYPE">DOCTYPE</a> is NAMED)
</li>
</ul>
</p>
<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>.
</p>
<a name="CHANGE_COLOR"><h5><u>7. Change the colour of the docheader elements individually</u></h5></a>
<p>
The following macros let you change the color of each docheader
element separately. You must pre-define (or
"initialize") the color with
<a href="color.html#NEWCOLOR">NEWCOLOR</a>
or
<a href="color.html#XCOLOR">XCOLOR</a>.
<ul>
<li><nobr><kbd>.TITLE_COLOR <colorname></kbd></nobr></li>
<li><nobr><kbd>.CHAPTER_TITLE_COLOR <colorname></kbd></nobr></li>
<ul>
<li><strong>Note: CHAPTER_TITLE_COLOR</strong> is needed
only if you enter both a <strong>CHAPTER</strong>
reference macro AND a <strong>CHAPTER_TITLE</strong>
macro. Otherwise, the macro,
<strong>TITLE_COLOR</strong> takes care of colorizing
the chapter header.
</li>
</ul>
<li><nobr><kbd>.SUBTITLE_COLOR <colorname></kbd></nobr></li>
<li><nobr><kbd>.ATTRIBUTE_COLOR <colorname></kbd></nobr>
(the "by" string that precedes the author[s] name[s])
</li>
<li><nobr><kbd>.AUTHOR_COLOR <colorname></kbd></nobr></li>
<li><nobr><kbd>.DOCTYPE_COLOR <colorname></kbd></nobr>
(if <a href="#DOCTYPE">DOCTYPE</a> is NAMED)
</li>
</ul>
</p>
<p>
It is not recommended that you embed colour (with the
<a href="definitions.html#TERMS_INLINES">inline escape</a>,
<a href="color.html#COLOR_INLINE"><kbd>\*[<colorname>]</kbd></a>)
in the strings passed to
<strong>TITLE</strong>, <strong>CHAPTER_TITLE</strong>,
<strong>SUBTITLE</strong>, <strong>AUTHOR</strong> or the name you
give <strong>DOCTYPE NAMED</strong>. The strings passed to these
macros are used to generate page
<a href="definitions.html#TERMS_HEADER">headers</a>
and
<a href="definitions.html#TERMS_FOOTER">footers</a>.
An embedded colour will cause the string to be colourized any time
it appears in headers or footers. (If you want headers or footers
colourized, or parts thereof, use the header/footer control macros.)
</p>
<a name="DOCHEADER_COLOR"></a>
<p>
If you want to colourize the entire docheader, use the macro
<ul>
<li><nobr><strong>DOCHEADER_COLOR</strong> <kbd><color name></kbd></nobr></li>
</ul>
</p>
<a name="CHANGE_SIZE"><h5><u>8. Adjust the size of docheader elements</u></h5></a>
<p>
The following macros let you adjust the point size of each docheader
element separately.
</p>
<p>
<strong>Mom</strong> 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#TERMS_UNITOFMEASURE">unit of measure</a>,
so there's no need to append a unit to the argument. Fractional point
sizes are allowed.
</p>
<ul>
<li><nobr><kbd>.TITLE_SIZE <+/-points></kbd></nobr>
<br/>
default = +3.5 (+4 if docheader title is "Chapter <n>")
</li>
<li><nobr><kbd>.CHAPTER_TITLE_SIZE <+/-points></kbd></nobr>
<br/>
default = +4
</li>
<li><nobr><kbd>.SUBTITLE_SIZE <+/-points></kbd></nobr>
<br/>
default = +0
</li>
<li><nobr><kbd>.AUTHOR_SIZE <+/-points></kbd></nobr>
<br/>
default = +0
</li>
<li><nobr><kbd>.DOCTYPE_SIZE <+/-points></kbd></nobr>
(if <a href="#DOCTYPE">DOCTYPE</a> is NAMED)
<br/>
default = +3
</li>
</ul>
<p>
Simply pass the appropriate macro the size adjustment you want.
</p>
<a name="CHANGE_ATTRIBUTE"><h5><u>9. Change the attribution string ("by")</u></h5></a>
<p>
If you're not writing in English, you can change what
<strong>mom</strong> prints where "by" appears in
docheaders. For example,
<pre>
.ATTRIBUTE_STRING "par"
</pre>
changes "by" to "par". <strong>ATTRIBUTE_STRING</strong>
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
<strong>ATTRIBUTE_STRING</strong> an empty argument, like this:
<pre>
.ATTRIBUTE_STRING ""
</pre>
</p>
<p>
<strong>Mom</strong> 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 <strong>ATTRIBUTE_STRING</strong>, 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:
<pre>
.ATTRIBUTE_STRING ""
.ATTRIBUTE_STRING DOC_COVER "Edited by"
.ATTRIBUTE_STRING COVER "by"
</pre>
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>
<p>
<strong>NOTE:</strong> 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 do so by using
<a href="definitions.html#TERMS_INLINES">inline escapes</a>
in the argument to <strong>ATTRIBUTE_STRING</strong>. For
example,
<pre>
.ATTRIBUTE_STRING "\f[HBI]\*[SIZE -2p] by \*[SIZE +2p]\*[PREV]"
</pre>
would set "by" in Helvetica bold italic, 2 points
smaller than normal.
</p>
<!-- -COLUMNS- -->
<hr align="left" width="66%"/>
<a name="COLUMNS_INTRO"><h2><u>Setting documents in columns</u></h2></a>
<p>
Setting documents in columns is easy with <strong>mom</strong>. (Of
course she'd say that, but it's true!) 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#TERMS_GUTTER">gutters</a>).
That's it. <strong>Mom</strong> takes care of everything else, from
soup to nuts.
</p>
<h3><u>Some words of advice</u></h3>
<p>
If you want your type to achieve a pleasing
<a href="definitions.html#TERMS_JUST">justification</a>
or
<a href="definitions.html#TERMS_RAG">rag</a>
in columns, reduce the point size of type (and probably the
<a href="definitions.html#TERMS_LEADING">leading</a>
as well). <strong>Mom</strong>'s default document point
size is 12.5, which works well across her default 39
<a href="definitions.html#TERMS_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- -->
<hr width="33%" align="left"/>
<a name="COLUMNS"></a>
<p>
<nobr>Macro: <strong>COLUMNS</strong> <kbd><number of columns> <width of gutters></kbd></nobr>
<br/>
<em>*Should be the last macro before</em> START
<br/>
<em>The second argument requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
</p>
<p>
<strong>COLUMNS</strong> takes two arguments: the number of
columns you want on document pages, and the width of the
<a href="definitions.html#TERMS_GUTTER">gutter</a>
between them. For example, to set up a page with two columns
separated by an 18 point gutter, you'd do
<pre>
.COLUMNS 2 18p
</pre>
</p>
<p>
Nothing to it, really. However, as noted above,
<strong>COLUMNS</strong> should always be the last document
setup macro prior to
<a href="#START">START</a>.
</p>
<p>
<strong>NOTE:</strong> <strong>Mom</strong> ignores columns completely
when the
<a href="#PRINTSTYLE">PRINTSTYLE</a>
is <strong>TYPEWRITE</strong>. The notion of typewriter-style
output in columns is just too ghastly for her to bear.
</p>
<h4><u>Using tabs when COLUMNS are enabled</u></h4>
<p>
<strong>Mom</strong>'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
<strong>COLUMNS</strong> are enabled. Tab structures set up
during document processing carry over from page to page and column
to column.
</p>
<!-- -BREAKING COLUMNS- -->
<a name="BREAKING_COLUMNS"><h4><u>Breaking columns manually</u></h4></a>
<p>
<strong>Mom</strong> 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: <strong>COL_NEXT</strong> and <strong>COL_BREAK</strong>.
</p>
<a name="COL_NEXT"></a>
<p>
<kbd>.COL_NEXT</kbd> breaks the line just before it,
<a href="definitions.html#TERMS_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, <strong>mom</strong> 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>
<a name="COL_BREAK"></a>
<p>
<kbd>.COL_BREAK</kbd> is almost the same, except that
instead of breaking and quadding the line preceding it,
she 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>
<p>
If you need <strong>COL_BREAK</strong> in the middle of a blockquote
or (god help you) an epigraph, you must do the following in order for
<strong>COL_BREAK</strong> to work:
<pre>
.SPREAD
\!.COL_BREAK
</pre>
</p>
<hr/>
<!-- ======================================================================== -->
<a name="DOC_PARAM_MACROS"><h2><u>Changing global style parameters after START</u></h2></a>
<p>
In the normal course of things, you change the basic type
parameters of a document <em>before</em>
<a href="#START">START</a>,
using
<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
(<strong>L_MARGIN, FAMILY, PT_SIZE, LS,</strong> etc). After
<strong>START</strong>, you MUST use the following macros to make
global changes to the basic type parameters of a document.
</p>
<a name="INDEX_DOC_PARAM"><h3><u>Macro list</u></h3></a>
<ul>
<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>
<!-- -DOC_LEFT_MARGIN -->
<hr width="66%" align="left"/>
<a name="DOC_LEFT_MARGIN"></a>
<p>
<nobr>Macro: <strong>DOC_LEFT_MARGIN</strong> <kbd><left margin></kbd></nobr>
<br/>
<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
</p>
<ul>
<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 (i.e. the right margin
shifts when you change the left margin)
</li>
</ul>
<!-- -DOC_RIGHT_MARGIN -->
<hr width="33%" align="left"/>
<a name="DOC_RIGHT_MARGIN"></a>
<p>
<nobr>Macro: <strong>DOC_RIGHT_MARGIN</strong> <kbd><right margin></kbd></nobr>
<br/>
<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
</p>
<ul>
<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#TERMS_DOCHEADER">docheaders</a>,
headers (or footers) and page numbering to the new value;
for changing the right margin of
<a href="definitions.html#TERMS_RUNNING">running text</a>
only, use
<a href="typesetting.html#R_MARGIN">R_MARGIN</a>
(see
<a href="typemacdoc.html#TOP">Using typesetting macros during
document processing</a>,
entry for <strong>R_MARGIN</strong>)
</li>
<li>all mom commands that include a right indent calculate
the indent from the new value
</li>
</ul>
<!-- -DOC_RIGHT_MARGIN -->
<hr width="33%" align="left"/>
<a name="DOC_LINE_LENGTH"></a>
<p>
<nobr>Macro: <strong>DOC_LINE_LENGTH</strong> <kbd><length></kbd></nobr>
<br/>
<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
</p>
<ul>
<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#TERMS_RUNNING">running text</a>
only, use
<a href="typesetting.html#LINELENGTH">LL</a>
(see
<a href="typemacdoc.html#TOP">Using typesetting macros during
document processing</a>,
entry for <strong>LL</strong>)
</li>
</ul>
<!-- -DOC_FAMILY- -->
<hr width="33%" align="left"/>
<a name="DOC_FAMILY"></a>
<p>
<nobr>Macro: <strong>DOC_FAMILY</strong> <kbd><family></kbd></nobr>
</p>
<ul>
<li>the argument is the same as for
<a href="typesetting.html#FAMILY">FAMILY</a>
</li>
<li>globally changes the type family for</li>
<ul>
<li>the <a href="definitions.html#TERMS_DOCHEADER">docheader</a></li>
<li>all <a href="docelement.html#INDEX_DOCELEMENT">document element tags</a>, including footnotes</li>
<li><a href="definitions.html#TERMS_HEADER">headers and/or footers</a></li>
<li><a href="docelement.html#NUMBER_LINES_INTRO">line numbering</a></li>
<li><a href="headfootpage.html#PAGINATION">page numbering</a></li>
</ul>
<li>does <em>not</em> change the family of</li>
<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>any page elements (e.g. 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- -->
<hr width="33%" align="left"/>
<a name="DOC_PT_SIZE"></a>
<p>
<nobr>Macro: <strong>DOC_PT_SIZE</strong> <kbd><point size></kbd></nobr>
<br/>
<em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
</p>
<ul>
<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- -->
<hr width="33%" align="left"/>
<a name="DOC_LEAD"></a>
<p>
<nobr>Macro: <strong>DOC_LEAD</strong> <kbd><points></kbd> [ ADJUST ]</nobr>
<br/>
<em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
</p>
<ul>
<li>the argument is the same as for
<a href="typesetting.html#LEADING">LS</a>,
and refers to the
<a href="definitions.html#TERMS_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 <strong>ADJUST</strong> performs
leading adjustment as explained in
<a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
</li>
</ul>
<p>
<strong>IMPORTANT:</strong> Do not use <strong>DOC_LEAD</strong>
in the middle of a page! It should always and only be invoked
immediately prior to a new page, like this:
<pre>
.DOC_LEAD <new value>
.NEWPAGE
</pre>
</p>
<p>
<strong>NOTE:</strong> Even if you don't pass
<strong>DOC_LEAD</strong> the optional argument
<kbd>ADJUST</kbd>, <strong>mom</strong> 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>
<!-- -DOC_QUAD- -->
<hr width="33%" align="left"/>
<a name="DOC_QUAD"></a>
<p>
<nobr>Macro: <strong>DOC_QUAD</strong> <kbd>L | R | C | J</kbd></nobr>
</p>
<ul>
<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>
<hr/>
<p>
<a href="typemacdoc.html#TOP">Next</a>
<a href="color.html#TOP">Prev</a>
<a href="#TOP">Top</a>
<a href="toc.html">Back to Table of Contents</a>
</p>
</body>
</html>
<!-- vim: fileencoding=latin1: nomodified:
-->
|
