| Back to Table of Contents | Next: Appendices |
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.
| +++ 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] | -- turn off pseudo italic inline |
| Pseudo bold | |
| SETBOLDER | -- set the amount of emboldening |
| \*[BOLDER] | -- invoke pseudo bold inline |
| \*[BOLDERX] | -- turn off pseudo bold inline |
| Pseudo condensed | |
| CONDENSE | -- set the amount to pseudo condense |
| \*[COND] | -- invoke pseudo condensing inline |
| \*[CONDX] | -- turn off pseudo condensing inline |
| Pseudo extended | |
| EXTEND | -- set the amount to pseudo extend |
| \*[EXT] | -- invoke pseudo extending inline |
| \*[EXTX] | -- turn off pseudo condensing inline |
| +++ Linespacing (leading) | |
|---|---|
| LS | -- set the linespacing (leading) |
| AUTOLEAD | -- set the linespacing relative to the point size |
| +++ Justification, quad, 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 |
| +++ Underscoring, underlining | |
|---|---|
| UNDERSCORE | -- underscore |
| UNDERSCORE2 | -- double underscore |
| UNDERLINE | -- underline (fixed width fonts only) |
| \*[UL]... | -- invoke underlining inline (fixed width fonts only) |
| \*[ULX] | |
| +++ Superscipts | |
|---|---|
| \*[SUP]...\*[SUPX] | -- superscript |
| \*[CONDSUP]...\*[CONDSUPX] | -- pseudo-condensed superscript |
| \*[EXTSUP]...\*[EXTSUPX] | -- pseudo extended supercript |
| SUPERSCRIPT_RAISE_AMOUNT | -- vertical offset of superscripts |
| +++ Nested lists | |
|---|---|
| LIST | -- begin a list |
| ITEM | -- begin an item in a list |
| SHIFT_LIST | -- change the indent of a list |
| RESET_LIST | -- clear and reset a list’s enumerator |
| PAD_LIST_DIGITS | -- reserve space for digits |
| +++ 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 |
| +++ Dropcaps | |
|---|---|
| DROPCAP | -- set a dropcap |
| DROPCAP_FAMILY | -- set a dropcap’s family |
| DROPCAP_FONT | -- set a dropcap’s font style |
| DROPCAP_COLOR | -- set a dropcap’s colour |
| DROPCAP_ADJUST | -- adjust size of a dropcap |
| DROPCAP_GUTTER | -- adjust space between a dropcap and regular text |
| +++ Smallcaps | |
|---|---|
| SMALLCAPS | |
| SMALLCAPS_STYLE | |
| +++ 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 |
| NEWSLIDE | -- break to a new slide |
| PAUSE | -- pause slide presentation |
| TRANSITION | -- transition effect for slides |
| PAD | -- insert equalized whitespace into a line |
| PAD_MARKER | -- change the pad marker |
| \*[RULE] | -- draw a full measure rule |
| SIZESPECS | -- cap-height, x-height, descender depth |
| SILENT | -- output processing off or on |
| TRAP | -- enable or disable page position traps |
| LEFT_HANG / \*[HANG] | -- hanging punctuation |
| +++ Graphical objects and images | |
|---|---|
| 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 |
| +++ Reference macros | |
|---|---|
| TITLE | -- document title |
| DOCTITLE | -- document title (if different from TITLE) |
| ENDNOTE_TITLE | -- document/chapter id string for endnotes |
| CHAPTER | -- chapter number |
| CHAPTER_TITLE | -- chapter title |
| CHAPTER_STRING | -- what to use in place of “Chapter” |
| SUBTITLE | -- document subtitle |
| AUTHOR | -- document author(s) |
| DOC_COVERTITLE | -- document title cover |
| COVERTITLE | -- section cover title |
| COPYRIGHT | -- copyright |
| MISC | -- miscellaneous cover information |
| DRAFT | -- document’s draft number |
| DRAFT_STRING | -- what to use in place of “Draft” |
| REVISION | -- document’s revision number |
| REVISION_STRING | -- what to use in place of “Revision” |
| PDF_TITLE | -- PDF viewer window title |
| TOC_HEADING | -- non-pagenumbered line inserted into the TOC |
| +++ General document formatting directives | |
|---|---|
| DOCTYPE | -- general document type |
| DOCTYPE SLIDES | -- create slide presentation |
| COPYSTYLE | -- draft or final copy |
| PRINTSTYLE | -- typeset or “typewritten” |
| +++ Line numbering | |
|---|---|
| NUMBER_LINES | -- automatic line numbering on/off |
| NUMBER_QUOTE_LINES | -- numbering of QUOTE lines on/off |
| NUMBER_BLOCKQUOTE_LINES | -- numbering of BLOCKQUOTE lines on/off |
| Control macros | |
| +++ Set documents in columns | |
|---|---|
| COLUMNS | |
| COL_NEXT | |
| COL_BREAK | |
| +++ TYPEWRITE control macros | |
|---|---|
| TYPEWRITER_FAMILY | alternative to Courier |
| TYPEWRITER_SIZE | point size of typewriter font |
| UNDERLINE_ITALIC | -- underlining of italics on |
| UNDERLINE_QUOTES | -- underlining of QUOTEs on/off |
| ITALIC_MEANS_ITALIC | -- use real italics (not underlining) |
| UNDERLINE_SLANT | -- underlining of pseudo-italics on |
| SLANT_MEANS_SLANT | -- use pseudo italics (not underlining) |
| +++ Initiate document processing | |
|---|---|
| START | -- begin document processing |
| +++ Epigraphs | |
|---|---|
| EPIGRAPH | -- set an epigraph underneath the docheader |
| Control macros | -- change default style of epigraphs |
| +++ Headings | |
|---|---|
| HEADING | -- hierarchical headings |
| Control macros | -- style heading levels |
| HEADING_STYLE | -- set style parameters for heading levels |
| PREFIX_CHAPTER_NUMBER | -- add chapter number to heading numbering |
| +++ Paragraphs | |
|---|---|
| PP | -- set a paragraph |
| Control macros | -- managing paragraph style concerns |
| PP_FONT | -- globally change font of regular paragraphs |
| PARA_INDENT | -- set the paragraph first-line indent |
| INDENT_FIRST_PARAS | -- indenting of paragraph first-lines on/off |
| PARA_SPACE | -- linespace between paragraphs on/off |
| +++ Quotes (line for line verbatim quotes) | |
|---|---|
| QUOTE | -- set quoted text line for line |
| Control macros | -- change default style of quotes |
| ALWAYS_FULLSPACE_QUOTES | -- control vertical space around quotes |
| +++ Blockquotes (cited passages of text) | |
|---|---|
| BLOCKQUOTE | -- set passages of cited text |
| Control macros | -- change default blockquote style |
| ALWAYS_FULLSPACE_BLOCKQUOTES | -- control vertical spacing |
| +++ Floats | |
|---|---|
| FLOAT | -- keep blocks of input together, output on next page
if necessary |
| +++ Images and graphics | |
|---|---|
| PDF_IMAGE | -- inserting pdf images |
| PDF_IMAGE_FRAME | -- set parameters for pdf image frames |
| PSPIC | -- inserting PostScript images |
| +++ Shaded backgrounds, frames, page colour | |
|---|---|
| BOX -- shaded backgrounds and frames | |
| PAGE_COLOR | |
| +++ eqn support | |
|---|---|
| EQ | -- begin an eqn block |
| EN | -- end an eqn block |
| +++ pic support | |
|---|---|
| PS | -- begin a pic block |
| PE | -- end a pic block |
| PIC_TEXT_STYLE | -- set style for pic text |
| +++ grap support | |
|---|---|
| G1 | -- begin a grap block |
| G2 | -- end a grap block |
| +++ tbl support | |
|---|---|
| TS | -- begin a tbl block |
| TH | -- running table header (after TS H) |
| TE | -- end tbl block |
| +++ Captions and labels | |
|---|---|
| AUTOLABEL | -- auto-label figures, tables, equations |
| SET_AUTOLABEL | -- set or reset autolabel numbers |
| CAPTION_AFTER_LABEL | -- place captions after labels |
| MLA | -- MLA-style labelling and captioning |
| CAPTION | -- add a caption to a float or (block)quote |
| LABEL | -- add a label to a float or (block)quote |
| CAPTIONS | -- set style for captions |
| LABELS | -- set style for labels |
| SOURCES | -- set style for sources (tbl only) |
| +++ Lists of Figures, Tables, and Equations | |
|---|---|
| LIST_OF_FIGURES | -- generate a List of Figures |
| LIST_OF_TABLES | -- generate a List of Tables |
| LIST_OF_EQUATIONS | -- generate a List of Equations |
| LISTS_STYLE | -- set style parameters for Lists |
| +++ 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 |
| +++ Author linebreaks (section breaks) | |
|---|---|
| LINEBREAK | -- insert an author linebreak (section break) |
| Control macros | -- change default style of linebreaks |
| LINEBREAK_CHAR | -- character to use for author linebreaks |
| LINEBREAK_COLOR | -- colour of author linebreak character |
| +++ Document termination string | |
|---|---|
| FINIS | -- insert a document termination string |
| Control macros | -- change default style finis string |
| FINIS_STRING | -- set the document termination string |
| FINIS_STRING_CAPS | -- capitalization of termination string |
| FINIS_COLOR | -- set the document termination string colour |
| +++ Footnotes | |
|---|---|
| FOOTNOTE | -- set a footnote |
| Control macros | -- change default style of footnotes |
| FOOTNOTE_MARKERS | -- footnote markers on/off |
| FOOTNOTE_MARKER_STYLE | -- type of footnote marker to use |
| RESET_FOOTNOTE_NUMBER | -- reset footnote numbering |
| FOOTNOTE_RULE | -- footnote separator rule on/off |
| FOOTNOTE_RULE_ADJ | -- adjust position of footnote rule |
| FOOTNOTE_RULE_LENGTH | -- adjust length of footnote rule |
| FOOTNOTES_RUN_ON | -- instruct footnotes to be continuous |
| +++ Endnotes | |
|---|---|
| ENDNOTE | -- set an endnote |
| \*[EN-MARK] | -- mark initial line of a range of line numbers (for use with line numbered endnotes) |
| ENDNOTES | -- output endnotes |
| Control macros | |
| General style control |
| Pagination |
| Header/footer control |
| Title control |
| Document/section identification control |
| Identification style |
| +++ Margin notes | |
|---|---|
| MN_INIT | -- initialize margin notes |
| MN | -- set a margin note |
| +++ Bibliographic references | |
|---|---|
| REF | -- begin a reference |
| FOOTNOTE_REFS | -- place references in footnotes |
| ENDNOTE_REFS | -- place references in endnotes |
| REF( / REF) | -- put parentheses around embedded references |
| REF[ / REF] | -- put square brackets around embedded references |
| REF{ / REF} | -- put curly braces around embedded references |
| BIBLIOGRAPHY | -- output a bibliography |
| Control macros | |
| BIBLIOGRAPHY_TYPE -- "plain" or enumerated list |
| General style control |
| Header/footer control |
| Main head control |
| +++ Tables of contents | |
|---|---|
| TOC | -- output a table of contents |
| NO_TOC_ENTRY | -- omit a document section from the TOC |
| TOC_HEADING | -- insert a heading into the TOC |
| Control macros | |
| +++ 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 |
| +++ Changing global print style parameters after START | |
|---|---|
| DOC_LEFT_MARGIN | -- left margin of everything on the page |
| DOC_RIGHT_MARGIN | -- right margin of everything on the page |
| DOC_LINE_LENGTH | -- document’s base line length |
| DOC_FAMILY | -- document’s base family |
| DOC_PT_SIZE | -- document’s base point size |
| DOC_LEAD | -- document’s base lead |
| DOC_QUAD | -- document’s base quad directions |
| +++ Managing a document’s first-page header | |
|---|---|
| DOCHEADER | -- document first-page header on/off |
| Control macros | -- change default style of docheader elements |
| +++ Managing page headers and footers | |
|---|---|
| HEADERS | -- page headers on/off |
| FOOTERS | -- page footers on/off |
| HEADERS_AND_FOOTERS | -- enable generation of both headers and footers |
| Control macros | |
| Strings | -- left-right-center strings |
| Style | -- change defaults for headers and/or footers |
| Global | -- global style changes |
| Part-by-part | -- part-by-part style changes |
| Vertical placement | -- adjust position of headers and/or footers |
| Separator rule | -- manage the header/footer separator rule |
| +++ Recto/verso page headers and footers | |
|---|---|
| RECTO_VERSO | -- recto/verso headers and/or footers on/off |
| FORCE_RECTO | -- insert blank pages so chapters start recto |
| SWITCH_HEADERS | -- switch recto or verso header |
| SWITCH_FOOTERS | -- switch recto or verso footer |
| HEADER_RECTO | -- string that constitutes a recto header |
| HEADER_VERSO | -- string that constitutes a verso header |
| FOOTER_RECTO | -- string that constitutes a recto footer |
| FOOTER_VERSO | -- string that constitutes a recto footer |
| +++ Pagination | |
|---|---|
| PAGINATE | -- pagination on/off |
| Control macros | -- change default style for pagination |
| PAGENUMBER | -- user-defined (starting) page number |
| PAGENUM_STYLE | -- digits, roman numerals, etc |
| PAGENUMBER_STRING | -- user-defined page numbering string |
| PAGENUM_ON_FIRST_PAGE | -- when page numbering is at page top |
| DRAFT_WITH_PAGENUMBER | -- attach draft/revision to page number |
| PDF_OUTLINE_PN | -- change page numbers in the pdf outline |
| +++ Vertical whitespace management | |
|---|---|
| SHIM | -- align to the baseline grid |
| FLEX | -- insert flexible whitespace |
| +++ Document and section cover (title) pages | |
|---|---|
| DOC_COVER | -- information to include in a document cover |
| COVER | -- information to include in a section cover |
| DOC_COVERS | -- printing of document covers on/off |
| COVERS | -- printing of section covers on/off |
| DOC_COVERTEXT | -- user-added text for document covers |
| COVERTEXT | -- user-added text for section covers |
| DOC_COVER_IMAGE | -- add images to document covers |
| COVER_IMAGE | -- add images to document covers |
| Control macros | -- change style defaults for covers |
| +++ Utilities | |
|---|---|
| ADD_SPACE | -- add space to the top of a page |
| RESTORE_SPACE | -- restore spacing at 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) |
| CENTER_BLOCK | -- centre blocks of type |
| Back to Table of Contents | Top | Next: Appendices |