| blob | 64be7ea56e51a05a50aa3ecc4df93079ed5f3a6d |
1 <html>
2 <head>
5 </head>
8 <!====================================================================>
17 </h1>
18 </a>
21 <br>
23 <p>
25 <p>
26 <ul>
28 <br>
30 <br>
31 <ul>
33 <ul>
40 </ul>
42 <ul>
46 </ul>
48 <li><a href="#STYLE_BEFORE_START"><strong>Changing type/style parameters prior to START</strong></a>
49 <ul>
53 <ul>
56 </ul>
57 </ul>
60 <ul>
65 </ul>
67 <li><a href="#START_MACRO"><strong>START</strong> -- the macro to initiate document processing</a>
68 <ul>
70 </ul>
72 <li><a href="#DOC_PARAM_MACROS"><strong>Changing document-wide typesetting parameters after START</strong></a>
73 <ul>
82 </ul>
83 <br>
85 <ul>
87 <ul>
89 </ul>
91 <ul>
94 </ul>
96 <ul>
99 </ul>
101 <ul>
104 </ul>
106 <ul>
109 </ul>
111 <ul>
114 </ul>
115 <li><a href="docelement.html#LINEBREAK_INTRO"><strong>Linebreaks (author linebreaks)</strong></a>
116 <ul>
119 </ul>
120 <li><a href="docelement.html#QUOTE_INTRO"><strong>Quotes (line for line poetic quotes)</strong></a>
121 <ul>
124 </ul>
125 <li><a href="docelement.html#BLOCKQUOTE_INTRO"><strong>Blockquotes (cited material)</strong></a>
126 <ul>
129 </ul>
131 <ul>
134 </ul>
136 <ul>
139 </ul>
140 </ul>
143 <br>
144 <ul>
147 <ul>
151 </ul>
153 <ul>
158 </ul>
159 </ul>
161 <br>
162 <ul>
166 <li><a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a> -- attach draft/revision information to page numbers
168 </ul>
169 <br>
170 <li><a href="rectoverso.html#RECTOVERSO"><strong>RECTO_VERSO PRINTING and COLLATING</strong></a>
171 <br>
172 <ul>
174 <ul>
177 </ul>
179 <ul>
181 </ul>
182 </ul>
185 <br>
187 <ul>
195 </ul>
196 </ul>
197 </ul>
198 <br>
199 <hr>
202 <p>
203 As explained in
205 document processing uses markup tags to identify document elements
206 like heads, paragraphs, and so on. The tags are, of course, macros,
207 but with sensible, readable names that make them easy to grasp and
208 easy to remember. (And don't forget: if you don't like the
211 with the
213 macro.)
214 <p>
216 extensive array of macros that control how they look and behave.
217 <p>
219 You begin by entering information about the document itself (title,
221 kind of document you're creating (e.g. chapter, letter, abstract,
222 etc...) and what kind of output you want (typeset, typewrittten,
223 draft-style, etc). Thirdly, you make as many or as few changes to
225 invoke the
227 macro. Voilà ! You're ready to write.
228 <br>
229 <hr>
235 If you want to know a particular default, read about it in the
236 description of the pertinent tag.
237 <p>
238 I fear the following may not be adequately covered in the
239 documentation. Just in case, here they are.
240 <p>
241 <ul>
244 <li>the top and bottom margins for document text are plus/minus
245 visually 1-inch
246 <li>pages are numbered; the number appears centered, at the
247 bottom, surrounded by hyphens ( e.g. -6- )
248 <li>the first page of a document begins with a
250 <li>subsequent pages have
252 with a rule underneath
253 </ul>
254 <p>
255 Another way to check up on document processing defaults is to have
256 a look at the macro file (om.tmac). Each macro is preceded by a
257 description that (generally) says what its default is (if it has
258 one).
259 <br>
260 <hr>
264 </a>
268 very seriously. Only under a very few (exceptional) circumstances
270 short).
271 <p>
276 in paragraphs) to calculate the spacing of every document element.
277 Prior to invoking
279 this is done with the
282 afterwards with the document
285 <p>
287 leading, any change to the leading or spacing on a page will almost
288 certainly have undesirable consequences on that page's bottom margin
289 unless the change is fully compensated for elsewhere on the page.
290 <p>
291 In other words, if you add a few points of space somewhere on a page,
292 you must subtract the same number of points somewhere else on that
293 same page, and vice versa.
294 <p>
295 If it's a question of adding or subtracting full line spaces between
298 with whatever spacing macro you choose --
306 <em>provided you compensate for the fractional linespace somewhere
307 else on the page</em>.
308 <br>
309 <hr>
315 </a>
316 <p>
318 doc (three, actually, with one optional). Before we proceed, though,
319 be reassured that something as simple as
320 <p>
321 <pre>
322 .TITLE "By the Shores of Lake Attica"
323 .AUTHOR "Rosemary Winspeare"
324 .PRINTSTYLE TYPESET
325 .START
326 </pre>
328 produces a beautifully typeset 8.5x11 document, with a
330 at the top of page 1,
332 with the title and author on subsequent
333 pages, and page numbers at the bottom of each page. In the course
334 of the document, heads, subheads, citations, quotes, epigraphs,
335 and so on, all come out looking neat, trim, and professional.
336 <p>
337 For the purposes of this tutorial, we're going to set up a short
339 we don't have to look at story itself, just the setup.
340 Joe wants the document
341 <p>
342 <ul>
349 instead of
351 <li>to use a single asterisk for
353 </ul>
354 <p>
355 Joe Blow has no taste in typography. His draft won't look pretty,
356 but this is, after all, a tutorial; we're after examples, not beauty.
360 some reference information. The reference macros are:
361 <p>
362 <ul>
363 <li>TITLE
364 <li>SUBTITLE
365 <li>AUTHOR
366 <li>CHAPTER -- the chapter number
367 <li>DRAFT -- the draft number
368 <li>REVISION -- the revision number
369 </ul>
370 <p>
371 You can use as many or as few as you wish, although at a minimum,
374 You can separate the
376 from the macros by any number of spaces. The following are
377 what you'd need to start Joe Blow's story.
378 <p>
379 <pre>
380 .TITLE "My Pulitzer Winner"
381 .AUTHOR "Joe Blow"
382 .DRAFT 7
383 .REVISION 39
384 </pre>
389 needs, you tell her how you want your document formatted. What kind
390 of document is it? Should it be typeset or typewritten? Is this
394 <p>
395 <ul>
396 <li>DOCTYPE -- the type of document (default, chapter, user-defined, letter)
397 <li>PRINTSTYLE -- typeset or typewritten
398 <li>COPYSTYLE -- draft or final copy
399 </ul>
400 <p>
404 has no default and MUST be present in every formatted document.
406 she'll complain (both to stderr and as a single printed sheet with
408 <p>
409 Adding to what we already have, the next bit of setup for Joe
410 Blow's story looks like this:
411 <p>
412 <pre>
413 .TITLE "My Pulitzer Winner"
414 .AUTHOR "Joe Blow"
415 .DRAFT 7
416 .REVISION 39
417 \#
418 .DOCTYPE DEFAULT \"Superfluous; mom uses DOCTYPE DEFAULT by default
419 .PRINTSTYLE TYPESET
420 .COPYSTYLE DRAFT
421 </pre>
423 Notice the use of the
425 ( \# ), a handy way to keep groups of macros visually separated
426 for easy reading in a text editor.
428 <h3><u>Step 3</u></h3>
430 This step -- completely optional -- is where you, the user, take
431 charge. <strong>Mom</strong> has defaults for <em>everything</em>,
432 but who's ever satisfied with defaults? Use any of the <a
434 here to change <strong>mom</strong>'s document defaults (paper
435 size, margins, family, point size, line space, rag, etc), or
436 any of the document processing macros that set/change/control
437 the appearance of document elements. Think of this as the
438 "style-sheet " section of a document.
439 <p>
440 Joe Blow wants his story printed in Helvetica, 12 on 14, rag
441 right, with
443 instead of
445 and a single asterisk for the
447 character. None of these requirements conforms
448 to <strong>mom</strong>'s defaults for the chosen
449 <strong>PRINTSTYLE</strong> (TYPESET), so we change them here.
450 The setup for Joe Blow's story now looks like this:
451 <p>
452 <pre>
455 .DRAFT 7
456 .REVISION 39
457 \#
458 .DOCTYPE DEFAULT
459 .PRINTSTYLE TYPESET
460 .COPYSTYLE DRAFT
461 \#
462 .FAMILY H
463 .PT_SIZE 12
464 .LS 14
465 .QUAD LEFT \"ie. rag right
466 .FOOTERS
467 .LINEBREAK_CHAR *
468 </pre>
472 to start document processing. It's a no-brainer, just the single macro
474 the only macro required for document processing (although
475 I can't guarantee you'll like the results of using just the two).
476 <p>
478 <p>
479 <pre>
480 .TITLE "My Pulitzer Winner"
481 .AUTHOR "Joe Blow"
482 .DRAFT 7
483 .REVISION 39
484 \#
485 .DOCTYPE DEFAULT
486 .PRINTSTYLE TYPESET
487 .COPYSTYLE DRAFT
488 \#
489 .FAMILY H
490 .PT_SIZE 12
491 .LS 14
492 .QUAD LEFT \"ie. rag right
493 .FOOTERS
494 .LINEBREAK_CHAR *
495 \#
496 .START
497 </pre>
499 As pointed out earlier, Joe Blow is no typographer. Given that all he
500 needs is a printed draft of his work, a simpler setup would have been:
501 <p>
502 <pre>
505 .DRAFT 7
506 .REVISION 39
507 \#
508 .PRINTSTYLE TYPEWRITE
509 .COPYSTYLE DRAFT
510 \#
511 .START
512 </pre>
514 <kbd>.PRINTSTYLE TYPEWRITE</kbd>, above, means that Joe's work
515 will come out "typewritten, double-spaced", making the
516 blue-pencilling he (or someone else) is sure to do much
517 easier (which is why many publishers and agents still insist on
518 typewritten, double-spaced copy).
519 <p>
520 When J. Blow stops re-writing and decides to print off a final,
521 typeset copy of his work for the world to see, he need only
522 make two changes to the (simplified) setup:
523 <p>
524 <pre>
527 .DRAFT 7
528 .REVISION 39
529 \#
530 .PRINTSTYLE TYPESET \"first change
531 .COPYSTYLE FINAL \"second change
532 \#
533 .START
534 </pre>
536 In the above, <kbd>.DRAFT 7, .REVISION 39,</kbd> and <kbd>.COPYSTYLE
537 FINAL</kbd> are actually superfluous. The draft and revision numbers
538 aren't used when <strong>COPYSTYLE</strong> is <strong>FINAL</strong>,
539 and <strong>COPYSTYLE FINAL</strong> is <strong>mom</strong>'s
540 default unless you tell her otherwise. BUT... to judge from the
541 number of drafts already, J. Blow may very well decide his
542 "final" version still isn't up to snuff. Hence, he might
543 as well leave in the superfluous macros. That way, when draft 7,
544 rev. 62 becomes draft 8, rev. 1, he'll be ready to tackle his Pulitzer
545 winner again.
546 <br>
547 <hr>
549 <!========================================================================>
552 <h2><u>The Reference Macros</u></h2>
553 </a>
555 The reference macros give <strong>mom</strong> the information
556 she needs to generate
558 and
560 must go at the top of any file that uses <strong>mom</strong>'s
561 document processing macros.
564 <h3><u>Reference macros list</u></h3>
565 </a>
567 <ul>
574 </ul>
576 <!---TITLE--->
579 <p>
581 Macro: <strong>TITLE</strong> <var>"<title>"</var>
582 <br>
583 <em>*Argument must be enclosed in double-quotes</em>
585 <p>
586 The title string can be caps or caps/lower-case; it's up to you.
587 In
589 the title will appear in the
591 exactly as you typed it. However, <strong>mom</strong> converts
592 the title to all caps in
594 unless you turn that feature off (see
597 the title always gets converted to caps.
598 <p>
599 <strong>NOTE:</strong> If your
601 is <strong>CHAPTER</strong>, <strong>TITLE</strong> should be the
602 title of the opus, not "CHAPTER whatever".
603 <br>
605 <!---SUBTITLE--->
608 <p>
610 Macro: <strong>SUBTITLE</strong> <var>"<subtitle>"</var>
611 <br>
612 <em>*Argument must be enclosed in double-quotes</em>
614 <p>
615 The subtitle string can be caps or caps/lower-case. Since a
616 document's subtitle appears only in the
618 and the title is most likely in caps, I recommend caps/lower case.
619 <br>
621 <!---AUTHOR--->
624 <p>
626 Macro: <strong>AUTHOR</strong> <var>"<author string>" [ "<author2 string>" "<author3 string>" ... ]</var>
627 <br>
628 <em>*Multiple arguments must be enclosed in double-quotes</em>
630 <p>
631 Each author string can hold as many names as you like, e.g.
632 <p>
633 <pre>
635 or
637 </pre>
639 <strong>Mom</strong> prints each string that's enclosed in
640 double-quotes on a separate line in the
642 however only the first string appears in
644 If you want <strong>mom</strong> to put something else in the author
645 part of page headers (say, just the last names of a document's two
646 authors), redefine the appropriate part of the header (see
648 <p>
649 The strings can be caps or caps/lower-case. I recommend caps/lower
650 case.
651 <br>
653 <!---CHAPTER--->
656 <p>
658 Macro: <strong>CHAPTER</strong> <var><chapter number></var>
660 <p>
661 The chapter number can be in any form you like -- a digit, a roman
662 numeral, a word. If you choose
664 <strong>mom</strong> prints whatever argument you pass
665 <strong>CHAPTER</strong> beside the word "Chapter" as a
666 single line
668 She also puts the same thing in the middle of
670 <p>
671 If you're not using <strong>DOCTYPE CHAPTER</strong>, the macro serves
672 no purpose and <strong>mom</strong> ignores it.
674 <p>
675 If you're not writing in English, you can ask <strong>mom</strong>
676 to use the word for chapter in your own language by telling
677 her what it is with the <strong>CHAPTER_STRING</strong> macro,
678 like this:
679 <p>
680 <pre>
682 </pre>
684 You can also use <strong>CHAPTER_STRING</strong> if you want
685 "CHAPTER" instead of "Chapter" in the doc- and
686 page-headers. (See also the
688 <br>
690 <!---DRAFT--->
693 <p>
695 Macro: <strong>DRAFT</strong> <var><draft #></var>
697 <p>
698 <strong>DRAFT</strong> only gets used with
700 If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong> (the
701 default), <strong>mom</strong> ignores <strong>DRAFT</strong>.
702 <strong>DRAFT</strong> only accepts a
704 <p>
705 <strong>Mom</strong> prints the draft number beside the word
706 "Draft" in the middle part of
708 If you're not writing in English, you can ask <strong>mom</strong>
709 to use the word for draft in your own language by telling
710 her what it is with the <strong>DRAFT_STRING</strong> macro,
711 like this:
712 <p>
713 <pre>
715 </pre>
717 <!---REVISION--->
720 <p>
722 Macro: <strong>REVISION</strong> <var><revision #></var>
724 <p>
725 <strong>REVISION</strong> only gets used with
727 If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong>
728 (the default), <strong>mom</strong> ignores the
729 <strong>REVISION</strong> macro. <strong>REVISION</strong> only
730 accepts a
732 <p>
733 <strong>Mom</strong> prints the revision number beside the shortform
734 "Rev." in the middle part of
736 If you're not writing in English, you can ask <strong>mom</strong>
737 to use the word for revision, or a shortform therof in your own language
738 by telling her what it is with the <strong>REVISION_STRING</strong>
739 macro, like this:
740 <p>
741 <pre>
743 </pre>
744 <hr>
746 <!========================================================================>
749 <h2><u>The Docstyle Macros</u></h2>
750 </a>
752 The docstyle macros tell <strong>mom</strong> what type of document you're
753 writing, whether you want the output typeset or
754 "typewritten", and whether you want a draft copy (with
755 draft and revision information in the headers) or a final copy.
758 <h3><u>Docstyle macros list</u></h3>
759 </a>
761 <ul>
764 <ul>
767 <ul>
769 </ul>
770 </ul>
772 </ul>
774 <!---DOCTYPE--->
777 <p>
779 Macro: <strong>DOCTYPE</strong> <var>DEFAULT | CHAPTER | NAMED "<name>" | LETTER</var>
780 <p>
781 The arguments <strong>DEFAULT, CHAPTER</strong> and
782 <strong>NAMED</strong> tell <strong>mom</strong> what to put
783 in the
785 and
787 <strong>LETTER</strong> tells her that you want to write a
788 lettter.
789 <p>
790 <strong>Mom</strong>'s default <strong>DOCTYPE</strong> is
791 <strong>DEFAULT</strong>. If that's what you want, you don't
792 have to give a <strong>DOCTYPE</strong> command.
793 <p>
794 <strong>DEFAULT</strong> prints a
796 containing the title, subtitle and author information given to the
798 and page headers with the author and title.
799 (See
801 for how <strong>mom</strong>'s outputs each part of the page header.)
802 <p>
803 <strong>CHAPTER</strong> prints "Chapter #" in place of a
805 (# is what you gave to
807 Page headers contain the author, the title of the book (which
808 you gave with
810 and "Chapter #". (See
812 for <strong>mom</strong>'s default type parameters for each part of
813 the page header.)
814 <p>
815 <em>*See the
817 below for how you can make CHAPTER print something
818 other than "Chapter #" as its docheader.</em>
819 <p>
820 <strong>NAMED</strong> takes an additional argument: a name
821 for this particular kind of document (e.g. outline, synopsis,
822 abstract, memorandum), enclosed in double-quotes.
823 <strong>NAMED</strong> is identical to <strong>DEFAULT</strong>
824 except that <strong>mom</strong> prints the argument to
825 <strong>NAMED</strong> beneath the
827 as well as in page headers.
828 (See
830 for how <strong>mom</strong>'s outputs each part of the page header.)
831 <p>
832 <strong>LETTER</strong> tells mom you're writing a letter. See
833 the section
835 for instructions on using <strong>mom</strong> to format letters.
838 In novels, new chapters are generally (but not always)
839 introduced by "Chapter #". Other types of documents
840 (reports and so on) often require specific titles for chapters.
841 If your document is of this latter type, use <strong>DOCTYPE
842 CHAPTER</strong> in the following way:
843 <p>
844 <ol>
845 <li>Omit the
848 <li>Invoke
850 with the title you'd like the chapter to have (enclosed
851 in double-quotes, of course).
852 <li>Optionally, if you'd like the chapter title to appear
853 in the the center part of
855 (its default location), invoke
857 with the same title you gave to <strong>CHAPTER_STRING</strong>.
859 </ol>
860 <br>
862 <!---PRINTSTYLE--->
865 <p>
867 Macro: <strong>PRINTSTYLE</strong> <var>TYPESET | TYPEWRITE [ SINGLESPACE ]</var>
868 <br>
869 <em>*Required for document processing.</em>
871 <p>
872 <strong>PRINTSTYLE</strong> tells <strong>mom</strong> whether to typeset
873 a document, or to print it out "typewritten, doubled-spaced".
874 <p>
875 <strong>THIS MACRO MAY NOT BE OMITTED.</strong> In order for
876 document processing to take place, <strong>mom</strong> requires
877 a <strong>PRINTSTYLE</strong>. If you don't give one,
878 <strong>mom</strong> will warn you on stderr and print a single
879 page with a nasty message.
880 <p>
881 <strong>TYPESET</strong>, as the argument implies, typesets documents
882 (by default in Times Roman; see
884 You have full access to all the
886 as well as the
888 of document processing.
889 <p>
890 With <strong>TYPEWRITE</strong>, <strong>mom</strong> does her best
891 to reproduce the look and feel of typewritten, double-spaced copy (see
894 and
896 that alter family, font, point size, and
898 are (mostly) ignored. An important exception is
900 (and, by extension, <strong>FOOTER_SIZE</strong>), which allows
901 you to reduce the point size of headers/footers should they become
902 too crowded. Most of <strong>mom</strong>'s inlines affecting the
903 appearance of type are also ignored (<strong>\*S</strong> is an
904 exception; there may be a few others).
905 <p>
906 In short, <strong>TYPEWRITE</strong> never produces effects other than
907 those available on a typewriter. Don't be fooled by how brainless
908 this sounds; <strong>mom</strong> is remarkably sophisticated when
909 it comes to conveying the typographic sense of a document within the
910 confines of <strong>TYPEWRITE</strong>.
911 <p>
912 The primary uses of <strong>TYPEWRITE</strong> are: outputting hard
913 copy drafts of your work (for editing), and producing documents
914 for submission to publishers and agents who (wisely) insist on
915 typewritten, double-spaced copy. To get a nicely typeset version of
916 work that's in the submission phase of its life (say, to show fellow
917 writers for critiquing), simply change <strong>TYPEWRITE</strong>
918 to <strong>TYPESET</strong> and print out a copy.
919 <p>
920 If, for some reason, you would prefer the output of
921 <strong>TYPEWRITE</strong> single-spaced, pass <strong>PRINTSTYLE
922 TYPEWRITE</strong> the optional argument, <strong>SINGLESPACE</strong>.
923 <p>
924 If you absolutely must have a leading other than typewriter double-
925 or singlespaced, the only way to get it is with the
927 macro, and then ONLY if <strong>DOC_LEAD</strong> is set
928 <strong>before</strong> you invoke the <strong>START</strong>
929 macro.
932 <pre>
933 Family = Times Roman
934 Point size = 12.5
935 Paragraph leading = 16 points, adjusted
936 Fill mode = justified
937 Hyphenation = enabled
938 max. lines = 2
939 margin = 36 points
940 interword adjustment = 1 point
941 Kerning = enabled
942 Ligatures = enabled
943 Smartquotes = enabled
944 Word space = groff default
945 Sentence space = 0
946 </pre>
949 <pre>
950 Family = Courier
951 Italics = underlined
952 Point size = 12
953 Paragraph leading = 24 points, adjusted; 12 points for SINGLESPACE
954 Fill mode = left
955 Hyphenation = disabled
956 Kerning = disabled
957 Ligatures = disabled
958 Smartquotes = disabled
959 Word space = groff default
960 Sentence space = groff default
961 Columns = ignored
962 </pre>
965 <p>
966 In <strong>PRINTSTYLE TYPEWRITE</strong>, <strong>mom</strong>,
967 by default, underlines anything that looks like italics. This
968 includes the
971 for pseudo-italics.
972 <p>
973 If you'd prefer that <strong>mom</strong> were
974 less bloody-minded about pretending to be a typewriter (i.e.
975 you'd like italics and pseudo-italics to come out as italics),
976 use the control macros <strong>.ITALIC_MEANS_ITALIC</strong> and
977 <strong>.SLANT_MEANS_SLANT</strong>. Neither requires an
978 argument.
979 <p>
980 Although it's unlikely, should you wish to reverse the sense of
981 these macros in the midst of a document,
982 <strong>.UNDERLINE_ITALIC</strong> and
983 <strong>.UNDERLINE_SLANT</strong> restore underlining of
984 italics and pseudo-italics.
985 <p>
986 Additionally, by default, <strong>mom</strong> underlines
988 (but not
990 in <strong>PRINTSTYLE TYPEWRITE</strong>.
991 If you don't like this behaviour, turn it off with
992 <p>
993 <pre>
994 .UNDERLINE_QUOTES OFF
995 </pre>
997 To turn underlining of quotes back on, use
998 <strong>UNDERLINE_QUOTES</strong> without an argument.
999 <p>
1000 While most of the
1002 have no effect on <strong>PRINTSTYLE TYPEWRITE</strong>, there
1003 is an important exception:
1005 (and by extension, <strong>FOOTER_SIZE</strong>). This is
1006 particularly useful for reducing the point size of
1007 headers/footers should they become crowded (quite likely to
1008 happen if the title of your document is long and your
1010 is <strong>DRAFT</strong>).
1011 <br>
1013 <!---COPYSTYLE--->
1016 <p>
1018 Macro: <strong>COPYSTYLE</strong> <var>DRAFT | FINAL</var>
1020 <p>
1021 <strong>Mom</strong>'s default <strong>COPYSTYLE</strong> is
1022 <strong>FINAL</strong>, so you don't have to use this macro unless
1023 you want to.
1024 <p>
1025 <strong>COPYSTYLE DRAFT</strong> exhibits the following behaviour:
1026 <br>
1027 <ol>
1028 <li>documents start on page 1, whether or not you
1029 request a different starting page number with
1031 <li>page numbers are set in lower case roman numerals
1032 <li>the draft number supplied by
1034 and a revision number, if supplied with
1036 (see
1038 appear in the center part of
1040 (or footers, depending on which you'ves selected) along with
1041 any other information that normally appears there.
1042 </ol>
1043 <p>
1044 <strong>IMPORTANT:</strong> If you define your own center part for page
1045 headers with
1047 no draft and/or revision number will appear there. If you want draft
1048 and revision information in this circumstance, use
1050 <p>
1051 <strong>COPYSTYLE FINAL</strong> differs from <strong>DRAFT</strong> in that:
1052 <br>
1053 <ol>
1054 <li>it respects the starting page number you give the document
1055 <li>page numbers are set in normal (arabic) digits
1056 <li>no draft or revision number appears in the page headers
1057 </ol>
1058 <p>
1059 <strong>NOTE:</strong> The center part of page headers can get crowded,
1060 especially with
1062 and
1064 when the <strong>COPYSTYLE</strong> is <strong>DRAFT</strong>.
1065 Three mechanisms are available to overcome this problem. One is to
1066 reduce the overall size of headers (with
1068 Another, which only works with
1070 is to reduce the size of the header's centre part only (with
1072 And finally, you can elect to have the draft/revsion information
1073 attached to page numbers instead of having it appear in the center
1074 of page headers (see
1076 <br>
1077 <hr>
1079 <!========================================================================>
1083 In the third (optional) part of setting up a document (see
1085 you can use the
1087 to change <strong>mom</strong>'s document-wide defaults for margins,
1088 line length, family, base point size,
1090 and justification style.
1091 <p>
1092 Two additional style concerns have to be addressed here (i.e. in
1093 macros before
1095 changes to the
1097 and whether you want you want the document's nominal leading
1098 adjusted to fill pages fully to the bottom margin.
1099 <p>
1100 <ul>
1102 <p>
1104 -- adjusting linespacing for equal, accurate bottom margins
1106 -- turning the docheader off
1107 <ul>
1109 </ul>
1110 </ul>
1115 When used before the
1117 macro, the following
1119 have these meanings:
1120 <p>
1121 <pre>
1122 L_MARGIN Left margin of pages, including headers/footers
1123 R_MARGIN Right margin of pages, including headers/footers
1124 T_MARGIN The point at which running text (i.e. not
1125 headers/footers or page numbers) starts on each page
1126 B_MARGIN The point at which running text (i.e. not
1127 headers/footers or page numbers) ends on each page
1129 (PAGE If you use PAGE, its first four arguments have the
1130 same meaning as L_ R_ T_ and B_MARGIN above.)
1132 LL The line length for everything on the page;
1133 equivalent to setting the right margin with R_MARGIN
1134 FAMILY The family of all type in the document
1135 PT_SIZE The point size of type in paragraphs; mom uses this
1136 calculate automatic point size changes (eg. for heads,
1137 footnotes, quotes, headers, etc)
1138 *LS or AUTOLEAD The leading used in paragraphs; all leading and spacing
1139 of running text is calculated from this
1140 QUAD Affects paragraphs only
1142 ------
1144 </pre>
1146 Other macros that deal with type style, or refinements thereof
1147 (<strong>KERN, LIGATURES, HY, WS, SS,</strong> etc.), behave normally.
1148 It is not recommended that you set up tabs or indents prior to
1149 <strong>START</strong>.
1150 <p>
1151 If you want to change any of the basic parameters above
1152 <em>after</em> <strong>START</strong> and have them affect a
1153 document globally (as if you'd entered them <em>before</em>
1154 <strong>START</strong>), you must use the macros listed in
1156 <br>
1158 <!---DOC_LEAD_ADJUST--->
1162 <br>
1163 Macro: <strong>DOC_LEAD_ADJUST</strong> <var>toggle</var>
1164 <br>
1165 <em>*Must come after LS or AUTOLEAD and before START</em>
1167 <p>
1168 <strong>DOC_LEAD_ADJUST</strong> is a special macro to adjust
1169 document
1171 so that bottom margins fall precisely where you expect.
1172 <p>
1173 If you invoke <strong>DOC_LEAD_ADJUST</strong>, <strong>mom</strong>
1174 takes the number of lines that fit on the page at your requested
1175 leading, then incrementally adds
1177 to the leading until the maximum number of lines at the new leading
1178 matches the bottom margin. In most instances, the difference
1179 between the requested lead and the adjusted lead is
1180 unnoticeable.
1181 <p>
1182 <strong>Mom</strong> uses <strong>DOC_LEAD_ADJUST</strong> with
1183 her default document settings, but if you invoke
1185 or
1187 prior to
1189 you have to do
1190 <p>
1191 <pre>
1192 .DOC_LEAD_ADJUST
1193 </pre>
1194 in order to enable it.
1195 <p>
1196 If you don't like the idea of <strong>mom</strong> playing around
1197 with the leading by default, you can turn adjusting off with
1198 <p>
1199 <pre>
1200 .DOC_LEAD_ADJUST OFF
1201 </pre>
1203 In this scenario, the maximum number of lines that fit on a page at
1204 the current document leading determine where <strong>mom</strong> ends
1205 a page. The effect will be that last lines usually fall (slightly)
1206 short of your expected bottom margin.
1207 <p>
1208 <strong>NOTE:</strong> <strong>DOC_LEAD_ADJUST</strong>, if
1209 used, must be invoked after
1211 or
1213 and before
1215 <br>
1217 <!---DOCHEADER--->
1221 <br>
1222 Macro: <strong>DOCHEADER</strong> <var><toggle> [ distance to advance from top of page ]</var>
1223 <br>
1224 <em>*Must come before START; distance requires a <a href="#TERMS_UNITOFMEASURE">unit of measure</a></em>
1226 <p>
1227 By default, <strong>mom</strong> prints a
1229 on the first page of any document (see
1231 for a description of the docheader). If you don't want a docheader,
1232 turn it off with
1233 <p>
1234 <pre>
1235 .DOCHEADER OFF
1236 </pre>
1238 <strong>DOCHEADER</strong> is a toggle macro, so the argument doesn't
1239 have to be <strong>OFF</strong>; it can be anything you like.
1240 <p>
1241 If you turn the docheader off, <strong>mom</strong>, by default, starts
1242 your document in the same place she would if the docheader were there.
1243 If you'd like her to start at a different vertical position, give
1244 her the distance you'd like as a second argument.
1245 <p>
1246 <pre>
1247 .DOCHEADER OFF 1.5i
1248 </pre>
1250 This starts the document 1.5 inches from the top of the page.
1251 The distance you give is measured from the top edge of the paper
1252 to the
1254 of the first line of type.
1255 <p>
1256 <strong>TIP:</strong> Since no document processing happens until
1257 you invoke
1259 -- including anything to do with docheaders -- you can typeset
1260 your own docheader prior to <strong>START</strong> (if you don't
1261 like the way <strong>mom</strong> does things) and use
1262 <strong>DOCHEADER OFF</strong> with its optional distance argument
1263 to ensure that the body of your document starts where you want.
1264 You can even insert a PostScript file (with <strong>.PSPIC</strong>;
1265 see the <strong>grops</strong> man page for usage).
1267 <a name="DOCHEADER_CONTROL"><h3><u>How to change the look of docheaders: docheader control macros</u></h3></a>
1269 <p>
1270 With
1272 the look of docheaders is carved in stone.
1273 In
1275 however, you can make a lot of changes. Macros that alter docheaders
1276 MUST come before
1279 <p>
1280 A typeset docheader has the following characteristics. Note that
1281 title, subtitle, author, and document type are what you supply
1282 with the
1284 Any you leave out will not appear; <strong>mom</strong> will
1285 compensate:
1286 <p>
1287 <pre>
1288 TITLE bold, 3.5 points larger than running text (not necessarily caps)
1289 Subtitle medium, same size as running text
1290 by medium italic, same size as running text
1291 Author(s) medium italic, same size as running text
1293 (Document type) bold italic, underscored, 3 points larger than running text
1294 </pre>
1296 The
1298 is the prevailing family of the whole document.
1300 <h3><u>The docheader macros to:</u></h3>
1301 <ol>
1308 </ol>
1309 <p>
1311 By default, a docheader starts on the same
1313 as
1315 If you'd like it to start somewhere else, use the macro
1316 <kbd>.DOCHEADER_ADVANCE</kbd> and give it the distance you want
1317 (measured from the top edge of the paper to the first baseline
1318 of the docheader), like this:
1319 <p>
1320 <pre>
1321 .DOCHEADER_ADVANCE 4P
1322 </pre>
1324 A
1326 is required.
1327 <p>
1328 <strong>NOTE:</strong> If
1330 are <strong>OFF</strong>, <strong>mom</strong>'s normal top
1331 margin for
1333 (7.5
1335 changes to 6 picas (visually approx. 1 inch). Since the
1336 first baseline of the docheader falls on the same baseline
1337 as the first line of running text (on pages after page 1),
1338 you might find the docheaders a bit high when headers are off.
1339 Use
1341 to place them where you want.
1345 The
1347 docheaders is the same as running text. If you'd like a
1348 different leading, say, 2 points more than the lead of running
1349 text, use:
1350 <p>
1351 <pre>
1352 .DOCHEADER_LEAD +2p
1353 </pre>
1355 Since the leading of docheaders is calculated from the lead of running
1356 text, a + or - sign is required before the argument (how much to add
1357 or subtract from the lead of running text). The
1359 is also required.
1362 The following macros let you change the
1364 of each docheader element separately:
1365 <p>
1366 <ul>
1367 <li><strong>TITLE_FAMILY</strong> <var><family></var>
1368 <li><strong>SUBTITLE_FAMILY</strong> <var><family></var>
1369 <li><strong>AUTHOR_FAMILY</strong> <var><family></var>
1370 <li><strong>DOCTYPE_FAMILY</strong> <var><family></var> (if
1372 </ul>
1373 <p>
1374 Simply pass the appropriate macro the family you want.
1377 The following macros let you change the
1379 of each docheader element separately:
1380 <p>
1381 <ul>
1382 <li><strong>TITLE_FONT</strong> <var>R | B | I | BI</var>
1383 <li><strong>SUBTITLE_FONT</strong> <var>R | B | I | BI</var>
1384 <li><strong>AUTHOR_FONT</strong> <var>R | B | I | BI</var>
1385 <li><strong>DOCTYPE_FONT</strong> <var>R | B | I | BI</var> (if
1387 </ul>
1388 <p>
1389 Simply pass the appropriate macro the font you want. <strong>R,
1390 B, I</strong> and <strong>BI</strong> have the same meaning as
1391 they do for
1396 The following macros let you adjust the point size of each docheader
1397 element separately.
1398 <p>
1399 <strong>Mom</strong> calculates the point size
1400 of docheader elements from the point size of paragraphs, so you
1401 must prepend a + or - sign to the argument. Points is
1402 assumed as the
1404 so there's no need to append a unit to the argument. Fractional point
1405 sizes are allowed.
1406 <p>
1407 <ul>
1408 <li><strong>TITLE_SIZE</strong> <var><+/-points></var>
1409 <br>
1410 default = +3.5 (+4 if docheader title is "Chapter #")
1411 <li><strong>SUBTITLE_SIZE</strong> <var><+/-points></var>
1412 <br>
1413 default = +0
1414 <li><strong>AUTHOR_SIZE</strong> <var><+/-points></var>
1415 <br>
1416 default = +0
1417 <li><strong>DOCTYPE_SIZE</strong> <var><+/-points></var> (if
1419 <br>
1420 default = +3
1421 </ul>
1422 <p>
1423 Simply pass the appropriate macro the size adjustment you want.
1425 <a name="CHANGE_ATTRIBUTE"><h3><u>6. Change the attribution string ("by")</u></h3></a>
1426 If you're not writing in English, you can change what
1427 <strong>mom</strong> prints where "by" appears in
1428 docheaders. For example,
1429 <p>
1430 <pre>
1432 </pre>
1434 changes "by" to "par". If you
1435 don't want an attribution string at all, simply pass
1436 <strong>ATTRIBUTE_STRING</strong> an empty argument, like this:
1437 <p>
1438 <pre>
1440 </pre>
1442 <strong>Mom</strong> will deposit a blank line where the
1443 attribution string normally appears.
1444 <p>
1445 <strong>NOTE:</strong> The type specs for the attribution line
1446 in docheaders are the same as for the author line. Although
1447 it's highly unlikely you'll want the attribution line in a
1448 different family, font, or point size, you can do so by using
1450 in the argument to <strong>ATTRIBUTE_STRING</strong>. For
1451 example,
1452 <p>
1453 <pre>
1455 </pre>
1457 would set "by" in Helvetica bold italic, 2 points
1458 smaller than normal.
1459 <br>
1460 <hr>
1462 <!---COLUMNS_INTRO--->
1466 <p>
1467 Setting documents in columns is easy with <strong>mom</strong>. (Of
1468 course she'd say that, but it's true!) All you have to do is is
1469 say how many columns you want and how much space you want
1470 between them (the
1472 That's it. <strong>Mom</strong> takes care of everything else, from
1473 soup to nuts.
1474 <p>
1475 <strong>SOME WORDS OF ADVICE:</strong>
1476 <p>
1477 If you want your type to achieve a pleasing
1479 or
1481 in columns, reduce the point size of type (and probably the
1483 as well). <strong>Mom</strong>'s default document point
1484 size is 12.5, which works well across her default 39
1486 full page line length, but with even just two columns on a page,
1487 the default point size is awkward to work with.
1488 <p>
1489 Furthermore, you'll absolutely need to reduce the indents for
1492 and
1494 (and probably the
1496 as well).
1497 <br>
1499 <!---COLUMNS--->
1503 <br>
1504 Macro: <strong>COLUMNS</strong> <var><number of columns> <width of gutters></var>
1505 <br>
1506 <em>*Should be the last macro before START
1507 <br>
1510 <p>
1511 <strong>COLUMNS</strong> takes two arguments: the number of
1512 columns you want on document pages, and the width of the
1514 between them. For example, to set up a page with two columns
1515 separated by an 18 point gutter, you'd do
1516 <p>
1517 <pre>
1518 .COLUMNS 2 18p
1519 </pre>
1521 Nothing to it, really. However, as noted above,
1522 <strong>COLUMNS</strong> should always be the last document
1523 setup macro prior to
1525 <p>
1526 <strong>NOTE:</strong> <strong>Mom</strong> ignores columns completely
1527 when the
1529 is <strong>TYPEWRITE</strong>. The notion of typewriter-style
1530 output in columns is just too ghastly for her to bear.
1532 <h3><u>Breaking columns manually</u></h3>
1533 <p>
1534 <strong>Mom</strong> takes care of breaking columns when they reach
1535 the bottom margin of a page. However, there may be times you want to
1536 break the columns yourself. There are two macros for breaking columns
1537 manually: <strong>COL_NEXT</strong> and <strong>COL_BREAK</strong>.
1540 <p>
1541 <kbd>.COL_NEXT</kbd> breaks the line just before it,
1543 it left (assuming the type is justified or quad left), and moves over
1544 to the top of the next column. If the column happens to be the last
1545 (rightmost) one on the page, <strong>mom</strong> starts a new page
1546 at the "column 1" position. This is the macro to use when
1547 you want to start a new column after the end of a paragraph.
1550 <p>
1551 <kbd>.COL_BREAK</kbd> is almost the same, except that
1552 instead of breaking and quadding the line preceding it,
1553 she breaks and spreads it (see
1555 Use this macro whenever you need to start a new column in the middle
1556 of a paragraph.
1557 <p>
1558 If you need <strong>COL_BREAK</strong> in the middle of a blockquote
1559 or (god help us) an epigraph, you must do the following in order for
1560 <strong>COL_BREAK</strong> to work:
1561 <p>
1562 <pre>
1563 .SPREAD
1564 \!.COL_BREAK
1565 </pre>
1566 <hr>
1568 <!========================================================================>
1571 <h2><u>Initiate document processing</u></h2>
1572 </a>
1574 In order to use <strong>mom</strong>'s document element macros
1575 (tags), you have to tell her you want them. The macro to do this
1576 is <strong>START</strong>.
1577 <p>
1578 <strong>START</strong> collects the information you gave
1579 <strong>mom</strong> in the setup section at the top of your file (see
1581 merges it with her defaults, sets up headers and page numbering,
1582 and prepares <strong>mom</strong> to process your document using
1583 the document element tags. No document processing takes place until
1584 you invoke <strong>START</strong>.
1585 <br>
1587 <!---START--->
1590 <p>
1592 Macro: <strong>START</strong>
1593 H C P R A A T E U<br>
1594 <em>*Required for document processing.</em>
1596 <p>
1597 <strong>START</strong> takes no arguments. It simply instructs
1598 <strong>mom</strong> to begin document processing. If you don't
1599 want document processing (i.e. you only want the
1601 don't use <strong>START</strong>.
1602 <p>
1603 At a barest minimum before <strong>START</strong>, you must enter a
1605 command.
1606 <br>
1607 <hr>
1609 <!========================================================================>
1612 <h2><u>Changing document-wide style parameters after START</u></h2>
1613 </a>
1615 In the normal course of things, you change the basic type
1616 parameters of a document <em>before</em>
1618 using
1620 (<strong>L_MARGIN, FAMILY, PT_SIZE, LS,</strong> etc). After
1621 <strong>START</strong>, you must use the following macros to make
1622 global changes to the basic type parameters of a document.
1623 <br>
1626 <h3><u>Macro list</u></h3>
1627 </a>
1628 <ul>
1637 </ul>
1640 <p>
1642 Macro: <strong>DOC_LEFT_MARGIN</strong> <var><left margin></var>
1643 </a>
1644 <br>
1646 <p>
1647 <ul>
1648 <li>the argument is the same as for
1650 <li>changes all left margins to the new value
1651 <li>the line length remains the same (i.e. the right margin
1652 shifts when you change the left margin)
1653 </ul>
1655 <br>
1658 <p>
1660 Macro: <strong>DOC_RIGHT_MARGIN</strong> <var><right margin></var>
1661 </a>
1662 <br>
1664 <p>
1665 <ul>
1666 <li>the argument is the same as for
1668 <li>changes all right margins to the new value
1669 <li>all mom commands that include a right indent calculate
1670 the indent from the new value
1671 </ul>
1672 <br>
1675 <p>
1677 Macro: <strong>DOC_LINE_LENGTH</strong> <var><length></var>
1678 </a>
1679 <br>
1681 <p>
1682 <ul>
1683 <li>the argument is the same as for
1685 <li>equivalent to changing the right margin with DOC_RIGHT_MARGIN
1686 </ul>
1687 <br>
1690 <p>
1692 Macro: <strong>DOC_FAMILY</strong> <var><family></var>
1693 </a>
1694 <p>
1695 <ul>
1696 <li>the argument is the same as for
1698 <li>globally changes the type family
1699 <li>if you wish the
1701 and/or page number families to remain at their old values,
1702 you must reset them with
1704 and
1706 </ul>
1707 <br>
1710 <p>
1712 Macro: <strong>DOC_PT_SIZE</strong> <var><point size></var>
1713 </a>
1714 <br>
1715 <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
1716 <p>
1717 <ul>
1718 <li>the argument is the same as for
1720 and refers to the point size of type in paragraphs
1721 <li>all automatic point size changes (heads, quotes,
1722 footnotes, headers, etc.) are affected by the new size;
1723 anything you do not want affected must be reset to
1724 its former value (see the Control Macros section of
1725 the pertinent document element for instructions on
1726 how to do this)
1727 </ul>
1728 <br>
1731 <p>
1733 Macro: <strong>DOC_LEAD</strong> <var><points> [ ADJUST ]</var>
1734 </a>
1735 <br>
1736 <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
1737 <p>
1738 <ul>
1739 <li>the argument is the same as for
1741 and refers to the
1743 of paragraphs
1744 <li>because paragraphs will have a new leading, the leading and
1745 spacing of most running text is influenced by the new value
1746 <li>epigraphs and footnotes remain unaffected;
1747 if you wish to change their leading, use
1749 and
1751 <li>the optional argument <strong>ADJUST</strong> performs
1752 leading adjustment as explained in
1754 </ul>
1755 <p>
1756 <strong>IMPORTANT:</strong> Do not use <strong>DOC_LEAD</strong>
1757 in the middle of a page! It should always and only be invoked
1758 immediately prior to a new page, like this:
1759 <p>
1760 <pre>
1761 .DOC_LEAD <new value>
1762 .NEWPAGE
1763 </pre>
1766 <p>
1768 Macro: <strong>DOC_QUAD</strong> <var>L | R | C | J</var>
1769 </a>
1770 <p>
1771 <ul>
1772 <li>the arguments are the same as for
1774 <li>affects paragraphs, epigraphs and footnotes; does not
1775 affect blockquotes
1776 </ul>
1778 <p>
1779 <hr>
1784 </body>
1785 </html>