Mom, version 1.5-c -- Table of Contents

# Table of Contents for mom, version 1.5-c

The table of contents has grown quite large. If you've been using mom for a while, you might prefer the Quick Reference Guide.

If you're new to mom, click on any link in the Quick Table of Contents to go to the appropriate section of the Full Table of Contents.

Alternatively, go directly to the Full Table of Contents.

## Quick Table of Contents

INTRODUCTORY STUFF

- What is mom?
- Definitions of terms used in this manual
- Using mom

TYPESETTING WITH MOM

- Intro to typesetting macros
- Page setup
- Basic typesetting parameters
- Justifying, quadding, etc.
- Refinements
- Modifying type
- Vertical movements
- Tabs
- Multiple columns
- Indents
- Goodies
- Inline escapes
- Coloured text
- Graphical objects

DOCUMENT PROCESSING WITH MOM

- Introduction to document processing
- Preliminary document setup
- The document element tags — heads, subheads, footnotes, etc.
- Inserting images into a document
- Page headers and footers
- Pagination
- Recto/verso printing and collating
- Cover pages
- Bibliographies and references
- Writing letters
- Using typesetting macros during document processing
- Quick reference guide to mom
- Appendices

## Full Table of Contents

1. WHAT IS MOM?

- 1.1 Who is mom meant for?
- 1.2 Typesetting with mom
- 1.3 Document processing with mom
- 1.4 Mom's philosophy
- 1.5 A note on mom's documentation

- 1.5.1 How to read macro arguments
- 1.5.2 "Toggle" macros

2. DEFINITIONS OF TERMS USED IN THIS MANUAL

- 2.1 Typesetting terms
- 2.2 Groff terms
- 2.3 Mom's document processing terms

3. USING MOM

- 3.1 Introduction
- 3.2 How to input mom's macros
- 3.3 Printing — invoking groff with mom
- 3.4 How to preview documents

4. THE TYPESETTING MACROS

- 4.1 Introduction to the typesetting macros
- 4.2 Page Setup — paper size and page margins

- 4.2.1 Macro list

- 4.3 Basic Parameters — family, font, fallback font, point size, line space, line length, autolead

- 4.3.1 Macro list

- 4.4 Justifying, Quadding, Filling and Breaking Lines

- 4.4.1 Macro list

- 4.5 Refinements — word space, sentence space, letter spacing (track kerning), hyphenation, kerning, ligatures

- 4.5.1 Macro list

- 4.6 Modifying Type — pseudo-italic, -bold, -condensed, and -extended

- 4.6.1 Macro list

- 4.7 Vertical Movements — moving up and down on the page

- 4.7.1 Macro list

- 4.8 Tabs

- 4.8.1 Typesetting tabs

- 4.8.1.1 Quickie tutorial

- 4.8.2 String tabs (autotabs)

- 4.8.2.1 Quickie tutorial

- 4.8.3 Macro list

- 4.9 Multi-columns

- 4.9.1 Macro list

- 4.10 Indents

- 4.10.1 A brief explanation of how mom handles indents
- 4.10.2 Macro list

- 4.11 Goodies — aliases, transparent lines, smartquotes, caps, underscoring/underlining, padding lines, leaders, drop caps, superscripts, (nested) lists, user-definable strings, changing the escape character

- 4.11.1 Macro list

- 4.12 Inline Escapes

- 4.12.1 Introduction to inline escapes
- 4.12.2 Mom's personal inlines
- 4.12.3 Groff inlines
- 4.12.3.1 Inlines for special characters and symbols

- 4.13 Coloured text

- 4.13.1 Introduction to coloured text
- 4.13.2 Macro list

- 4.14 Graphical objects — horizontal and vertical rules, boxes, ellipses (circles)

- 4.14.1 Introduction to graphical objects
- 4.13.2 Macro list

5. DOCUMENT PROCESSING WITH MOM

- 5.1 Introduction to document processing
- 5.2 Some document defaults

- IMPORTANT NOTE on leading/spacing and bottom margins
- The SHIM macro — to get document leading back on track

- 5.3 PRELIMINARY DOCUMENT SETUP

- 5.3.1 Tutorial — setting up a mom document
- 5.3.2 The Reference Macros — giving mom the information she needs to do her job

- 5.3.2.1 TITLE
- 5.3.2.2 DOCTITLE
- 5.3.2.3 SUBTITLE
- 5.3.2.4 AUTHOR
- 5.3.2.5 CHAPTER
- 5.3.2.6 CHAPTER_TITLE
- 5.3.2.7 DRAFT
- 5.3.2.8 REVISION
- 5.3.2.9 COPYRIGHT
- 5.3.2.10 MISC
- 5.3.2.11 COVERTITLE
- 5.3.2.12 DOC_COVERTITLE

- 5.3.3 The Docstyle Macros — telling mom what kind of document you're creating and how you want it to look overall

- 5.3.3.1 DOCTYPE — kind of document
- 5.3.3.2 PRINTSTYLE — typeset or typewrite
- 5.3.3.3 COPYSTYLE — draft or final

- 5.3.4 Initiate document processing

- 5.3.4.1 START — the required macro to initiate document processing

- 5.3.5 Changing global typesetting and formatting parameters before START

- 5.3.5.1 Using the typesetting macros before START

- Including (sourcing) style sheets and files
- Initializing colours

- 5.3.5.2 DOC_LEAD_ADJUST — adjust a document's leading (line spacing) to fill pages
- 5.3.5.3 DOCHEADER — managing the document header
- 5.3.5.4 COLUMNS — setting documents in columns

- 5.3.6 Changing global style parameters after START

- 5.3.6.1 Macro list

- 5.3.7 Using the typesetting macros during document processing

- 5.4 THE DOCUMENT ELEMENT TAGS

- 5.4.1 Introduction to the document element tags

- Control macros — changing style defaults for document element tags
- Arguments to the control macros

- 5.4.2 Epigraphs
- 5.4.3 Paragraphs
- 5.4.4 Main heads
- 5.4.5 Subheads
- 5.4.6 Paragraph heads
- 5.4.7 Linebreaks — author linebreaks (section breaks)
- 5.4.8 Quotes — line for line poetic quotes or unformatted, verbatim text (e.g. code snippets)
- 5.4.9 Blockquotes — cited material
- 5.4.10 Code — inserting code snippets into documents
- 5.4.11 Lists — (nested) lists
- 5.4.12 Line numbering
- 5.4.13 Footnotes
- 5.4.14 Endnotes
- 5.4.15 Margin notes
- 5.4.16 Blank pages
- 5.4.17 Document termination string — FINIS
- 5.4.18 Tables of contents

- 5.5 INSERTING IMAGES INTO A DOCUMENT
- 5.6 PAGE HEADERS AND FOOTERS

- 5.6.1 Introduction
- 5.6.2 General description of headers/footers
- 5.6.3 Default specs for headers/footers
- 5.6.4 Vertical placement and spacing of headers/footers
- 5.6.5 Managing headers/footers

- 5.6.5.1 User-defined, single string recto/verso headers/footers

- 5.6.6 Control macros for headers/footers

- 5.7 PAGINATION

- Introduction
- Pagination macros list

- 5.8 RECTO/VERSO PRINTING, COLLATING

- 5.8.1 Introduction to recto/verso

- 5.8.1.1 Macro list

- 5.8.2 Introduction to collating

- 5.8.2.1 The COLLATE macro

- 5.9 CREATING COVER PAGES
- 5.10 BIBLIOGRAPHIES AND REFERENCES
- 5.11 WRITING LETTERS

- 5.11.1 Introduction to writing letters
- 5.11.2 Tutorial on writing letters
- 5.11.3 Default style for letters
- 5.11.4 The letter macros

6. QUICK REFERENCE GUIDE TO MOM
7. APPENDICES

- 7.1 Further notes on this documentation
- 7.2 Adding PostScript fonts to groff

- 7.2.1 How to create a PostScript font for use with groff

- 7.3 Some reflections on mom
- 7.5 List of reserved words — complete list of macros, registers, strings, aliases and diversions
- 7.5 Contact the author