Table of Contents

VERSION 2.0 NOTES

INTRODUCTION TO MOM

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

TYPESETTING WITH MOM

• Introduction to the 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
• Document defaults
• Preliminary document setup
• Behaviour of the typesetting macros during document processing
• The document element tags – headings, paragraphs, quotes, footnotes, etc.
• Graphics, floats, and preprocessor support
• Page headers and footers
• Pagination
• Recto/verso printing and collating
• Cover pages
• Tables of contents
• Bibliographies and references
• Writing letters
  •  
• Quick reference guide
• Appendices

VERSION 2.0 NOTES

• Prefatory comments
• Differences between 2.0 and 1.x
  • PDF Support
  • Covers
  • Headings
  • Margin notes
  • Floats
  • Table of Contents
• The pdfmom wrapper around groff
• The install-font script

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 Canonical reference materials
  • 1.5.2 How to read macro arguments
  • 1.5.3 “Toggle” macros
  • 1.5.4 Examples

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 Processing and viewing documents
  • Mom and pdf
  • pdfmom
• 3.4 Automatic previewing of documents

4. TYPESETTING WITH MOM

• 4.1 Introduction to the typesetting macros
• 4.2 Page setup – paper size and page margins
  • 4.2.1 Macro list
• 4.3 Basic typesetting 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 Multiple 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 (comment) lines, smartquotes, caps, underscoring/underlining, padding lines, leaders, drop caps, superscripts, 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 List of inline escapes
  • 4.12.3 Mom's personal inline escapes
  • 4.12.4 Commonly-used groff inline escapes
    • 4.12.4.1 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 Document defaults – papersize, margins, etc.
  • 5.2.1 Important note on leading/spacing and bottom margins
  • 5.2.1 The SHIM macro – flexible spacer to keep 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 – metadata mom 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.2.12 PDF_TITLE
  • 5.3.3 The docstyle macros – base templates; what kind of document you're creating, how you want it to look overall
    • 5.3.3.1 DOCTYPE – the kind of document
    • 5.3.3.2 PRINTSTYLE – typeset or “typewritten, double-spaced”
    • 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 Managing the DOCHEADER – title, author, etc. on first page
  • 5.3.5.1 DOCHEADER control
  • 5.3.6 Setting documents in columns
  • 5.3.7 Establishing type and formatting parameters before START
    • 5.3.7.1 Use of the typesetting macros before START
      • – 5.3.7.1.1 Including (sourcing) style sheets and files
      • – 5.3.7.1.2 Initializing colours
    • 5.3.7.2 DOC_LEAD_ADJUST – adjust document leading to fill pages
      • – 5.3.6.7.1 SHIM – flexible spacer to keep document leading back on track
  • 5.3.8 Changing basic type and formatting parameters after START
    • 5.3.8.1 Behaviour of the typesetting macros during document processing
    • 5.3.8.2 Post-START global style-change macros
      • – Macro list
• 5.4 THE DOCUMENT ELEMENT TAGS
  • 5.4.1 Introduction to the document element tags
    • 5.4.1.1 Control macros – changing style defaults for document element tags
    • 5.4.1.2 Arguments to the control macros
  • 5.4.2 Epigraphs
  • 5.4.3 Paragraphs
  • 5.4.4 Headings
  • 5.4.5 Linebreaks – author linebreaks (section breaks)
  • 5.4.6 Quotes – line for line poetic quotes or unformatted, verbatim text (e.g. blocks of code)
  • 5.4.7 Blockquotes – cited material
  • 5.4.8 Code – inserting code snippets
  • 5.4.9 Lists – nested lists
  • 5.4.10 Line numbering
  • 5.4.11 Footnotes
  • 5.4.12 Endnotes
  • 5.4.13 Margin notes
  • 5.4.14 Document termination string – FINIS
• 5.5 GRAPHICS, FLOATS, AND PREPROCESSOR SUPPORT
  • 5.5.1 Inserting images and graphics
  • 5.5.2 Image conversion and file processing
  • 5.5.3 PDF_IMAGE
    • 5.5.3.1 PDF_IMAGE_FRAME
  • 5.5.4 PSPIC
  • 5.5.5 Floats
    • 5.5.5.1 FLOAT
  • 5.5.6 Preprocessor support
    • 5.5.6.1 tbl support
    • 5.5.6.2 eqn support
    • 5.5.6.3 pic support
      • 5.5.6.3.1 PIC_TEXT_STYLE
    • 5.5.6.4 refer support
  • 5.5.7 Captions and labels
    • 5.5.7.1 AUTOLABEL
    • 5.5.7.2 CAPTION_AFTER_LABEL
    • 5.5.7.3 CAPTIONS / LABELS / SOURCES—set style parameters
    • 5.5.7.4 MLA
  • 5.5.8 Lists of Figures, Tables, and Equations
    • 5.5.8.1 Placement of Lists
    • 5.5.8.2 Macros to generate Lists
    • 5.5.8.3 Formatting and style parameters for Lists
      • 5.5.8.3.1 LISTS_STYLE
• 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 page headers and footers
  • 5.6.6 Control macros for headers/footers
  • 5.6.7 User-defined, single string recto/verso headers/footers
    • 5.6.7.1 User-defined, single string headers/footers (no recto/verso)
  • 5.6.8 Headers and footers on the same page
• 5.7 PAGINATION
  • 5.7.1 Introduction
  • 5.7.2 Pagination macros list
  • 5.7.3 Blank pages
• 5.8 RECTO/VERSO PRINTING, COLLATING
  • 5.8.1 Introduction to recto/verso printing
    • 5.8.1.1 Macro list
  • 5.8.2 Introduction to collating
    • 5.8.2.1 The COLLATE macro
• 5.9 COVER PAGES
• 5.10 TABLES OF CONTENTS
  • 5.10.1 Introduction – the TOC macro
  • 5.10.2 Table of contents appearance and behaviour
  • 5.10.3 PDF output
  • 5.10.4 Positioning the table of contents
    • 5.10.2 Automatic PDF relocation of the Table of Contents
    • 5.10.2 Using psselect to relocate the TOC in PostScript documents
  • 5.10.5 Table of contents control macros
• 5.11 BIBLIOGRAPHIES AND REFERENCES
• 5.12 WRITING LETTERS
  • 5.11.1 Introduction to writing letters
  • 5.11.2 Tutorial on writing letters
  • 5.11.3 Default letter style
  • 5.11.4 The letter macros

6. QUICK REFERENCE GUIDE

7. APPENDICES

• 7.1 Adding fonts to groff
  • 7.1.1 Step-by-step instructions
• 7.2 Some reflections on mom
• 7.3 List of reserved words (macros, registers, strings)
• 7.4 Contact the author