Quick reference guide
Once you know your way around mom, you may find this guide
preferable to using the Table of Contents. It lists mom’s
major user-space macros. The links point to references found
elsewhere in the documentation.
Index to the quick reference guide
TYPESETTING MACROS
- Paper size, margins, line length
- Family, font, point size
- Font modifications
- Linespacing (leading)
- Justification, quad, breaking lines
- Hyphenation
- Word and sentence spacing
- Kerning, ligatures, smartquotes
- Horizontal/vertical motions, columns
- Indents
- Tabs
- Underscoring, underlining
- Superscipts
- Nested lists
- Colour
- Dropcaps
- Utilities
- Graphics, images and floats
DOCUMENT PROCESSING MACROS
Quick reference guide
TYPESETTING MACROS
| +++ Paper size, margins, line length |
| PAPER | -- set common paper sizes (letter, A4, etc) |
| PAGEWIDTH | -- set a custom page width |
| PAGELENGTH | -- set a custom page length |
| PAGE | -- set explicit page dimensions and margins |
| T_MARGIN | -- set a top margin |
| B_MARGIN | -- set a bottom margin |
| L_MARGIN | -- set a left margin (page offset) |
| R_MARGIN | -- set a right margin |
| LL | -- set a line length |
| +++ Family, font, point size |
|---|
| FAMILY | -- set the family of type |
| FT | -- set the font style (roman, italic, etc) |
| FALLBACK_FONT | -- establish a fallback font (for missing fonts) |
| PT_SIZE | -- set the point size |
| \*[SIZE n] | -- change the point size inline |
| +++ Font modifications |
| Pseudo italic |
| SETSLANT | -- set the degree of slant |
| \*[SLANT] | -- invoke pseudo italic inline |
| \*[SLANTX] | -- off pseudo italic inline |
| Pseudo bold |
| SETBOLDER | -- set the amount of emboldening |
| \*[BOLDER] | -- invoke pseudo bold inline |
| \*[BOLDERX] | -- off pseudo bold inline |
| Pseudo condensed |
| CONDENSE | -- set the amount to pseudo condense |
| \*[COND] | -- invoke pseudo condensing inline |
| \*[CONDX] | -- off pseudo condensing inlines |
| Pseudo extended |
| EXTEND | -- set the amount to pseudo extend |
| \*[EXT] | -- invoke pseudo extending inline |
| \*[EXTX] | -- off pseudo condensing inlinee |
| +++ Linespacing (leading) |
| LS | -- set the linespacing (leading) |
| AUTOLEAD | -- set the linespacing relative to the point size |
| +++ Justification, quad direction, line-by-line setting, breaking lines |
| JUSTIFY | -- justify text to both margins |
| QUAD | -- "justify" text left, centre, or right |
| LEFT | -- set line-by-line quad left |
| CENTER | -- set line-by-line quad centre |
| RIGHT | -- set line-by-line quad right |
| BR | -- break a justified line |
| SPREAD | -- force justify a line |
| EL | -- break a line without advancing on the page |
| +++ Hyphenation |
| HY | -- automatic hyphenation on/off |
| HY_SET | -- set automatic hyphenation parameters |
| +++ Word and sentence spacing |
| WS | -- set the minimum word space size |
| SS | -- set the sentence space size |
| +++ Kerning, ligatures, smartquotes |
| KERN | -- automatic character pair kerning on/off |
| \*[BU n] | -- move characters pairs closer together inline |
| \*[FU n] | -- move character pairs further apart inline |
| RW | -- uniformly tighten space between characters |
| EW | -- uniformly loosen space between characters |
| BR_AT_LINE_KERN | -- break previous line when RW or EW is invoked |
| LIGATURES | -- automatic generation of ligatures on/off |
| SMARTQUOTES | -- smartquoting on/off |
| +++ Horizontal and vertical movements, columnar setting |
| ALD | -- move downards on the page |
| RLD | -- move upwards on the page |
| SPACE | -- insert space between lines on a page |
| \*[DOWN n] | -- temporarily move downwards in a line |
| \*[UP n] | -- temporarily move upwards in a line |
| \*[FWD n] | -- move forward in a line |
| \*[BCK n] | -- move backwards in a line |
| MCO | -- multiple columns on |
| MCR | -- recto vertical position of column start |
| MCX | -- multiple columns off, advance past longest column |
| +++ Indents |
| IL | -- set and turn on a left indent |
| IR | -- set and turn on a right indent |
| IB | -- set and turn on indents both left and right |
| IQ | -- quit (exit) all indents |
| TI | -- set and turn on a temporary (one line) indent |
| HI | -- set and turn on a hanging indent |
| ILX | -- left indents off |
| IRX | -- right indents off |
| IBX | -- both left and right indents off |
| +++ Tabs |
| TAB_SET | -- set up a typesetting tab |
| TAB <n> | -- call tab <n> |
| TQ | -- quit (exit) tabs |
| \*[ST<n>]... | -- string tabs (mark tab positions inline) |
| \*[ST<n>X]
|
| TN | -- move to tab<n+1> without advancing on the page |
| ST | -- set quad/fill for string tabs |
| +++ Colour |
| NEWCOLOR | -- initialize (define) a colour |
| COLOR | -- begin using an initialized colour |
| XCOLOR | -- initialize a "named" X colour |
| \*[<colorname>] | -- begin using an initialized colour inline |
| +++ Utilities |
| ALIAS | -- give a macro a new name |
| CAPS | -- set type all caps |
| COMMENT | -- silently embed comments in a document |
| ESC_CHAR | -- change the default escape character |
| \*[LEADER] | -- insert leaders at the end of a line |
| LEADER_CHARACTER | -- change the character used for leaders |
| NEWPAGE | -- break to a new page |
| PAD | -- insert equalized whitespace into a line |
| PAD_MARKER | -- change the pad marker |
| \*[RULE] | -- draw a full measure rule |
| SIZESPECS | -- get cap-height, x-height and descender depth |
| SILENT | -- output processing off or on |
| TRAP | -- enable or disable page position traps |
| +++ Graphics, images and floats |
| DRH | -- draw a horizontal rule |
| DRV | -- draw a vertical rule |
| DBX | -- draw a box |
| DCL | -- draw a circle (ellipse) |
| RULE_WEIGHT | -- set weight of rules drawn with \*[RULE] |
| PDF_IMAGE | -- insert a PDF image |
| PSPIC | -- insert a PostScript image |
| FLOAT | -- keep blocks of input together, output on next page
if necessary |
DOCUMENT PROCESSING MACROS
| +++ General document formatting directives |
| DOCTYPE | -- general document type |
| COPYSTYLE | -- draft or final copy |
| PRINTSTYLE | -- typeset or “typewritten” |
| +++ Initiate document processing |
| START | -- begin document processing |
| +++ Epigraphs |
| EPIGRAPH | -- set an epigraph underneath the docheader |
| Control macros | -- change default style of epigraphs |
| +++ Code snippets |
| CODE | -- set a code snippet |
| Control macros | -- change default style of code snippets |
| General | -- family, font, and colour |
| CODE_SIZE | -- code size as a percentage of prevailing text |
| +++ Margin notes |
| MN_INIT | -- initialize margin notes |
| MN | -- set a margin note |
| +++ Letter (correspondence) macros |
| DATE | -- letter’s date |
| FROM | -- letter’s addresser |
| TO | -- letter’s addressee |
| GREETING | -- letter’s salutation |
| CLOSING | -- letter’s closing salutation |
| CLOSING_INDENT | -- indentation of the closing salutation |
| SIGNATURE_SPACE | -- room to leave for the signature |
| NO_SUITE | -- printing of "next page number" off or on |
| +++ Managing a document’s first-page header |
| DOCHEADER | -- document first-page header on/off |
| Control macros | -- change default style of docheader elements |
| +++ Document and section cover (title) pages |
| COVER | -- information to include in a section cover |
| DOC_COVER | -- information to include in a document cover |
| COVERS | -- printing of section covers on/off |
| DOC_COVERS | -- printing of document covers on/off |
| Control macros | -- change style defaults for covers |
| +++ Utilities |
| ADD_SPACE | -- add space to the top of a page |
| BLANKPAGE | -- output one or more blank pages |
| DOC_LEAD_ADJUST | -- adjust leading to fill pages |
| COLLATE | -- join documents (chapters/sections) together |
| SHIM | -- move vertical position to next valid baseline |