Home | History | Annotate | Line # | Download | only in momdoc
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
      2 <html>
      3 <head>
      4 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
      5 <title>Mom, version 1.3-a -- Table of Contents</title>
      6 </head>
      7 <body bgcolor="#dfdfdf">
      8 
      9 <!====================================================================>
     10 
     11 <h1 align="center"><u>Table of Contents for mom, version 1.3-a</u></h1>
     12 
     13 The table of contents has grown quite large.  If you've been using
     14 <strong>mom</strong> for a while, you might prefer the
     15 <a href="macrolist.html#TOP"><strong>Quick Reference Guide</strong></a>.
     16 <p>
     17 If you're new to <strong>mom</strong>, click on any link in the
     18 <a href="#QUICK_TOC"><strong>Quick Table of Contents</strong></a>
     19 to go to the
     20 appropriate section of the <strong>Full Table of Contents</strong>.
     21 <p>
     22 Or click
     23 <a href="#TOC_PROP">here</a>
     24 to go directly to the <strong>Full Table of Contents</strong>.
     25 <p>
     26 <hr>
     27 
     28 <a name="QUICK_TOC"><h2>Quick Table of Contents</h2></a>
     29 <a href="#INTRO"><strong>INTRODUCTORY STUFF</strong></a>
     30 <ul>
     31     <li><a href="#WHAT">What is mom?</a>
     32 	<li><a href="#DEFS">Definitions of terms used in this manual</a>
     33     <li><a href="#USING">Using mom</a>
     34 </ul>
     35 <a href="#TYPESET"><strong>TYPESETTING WITH MOM</strong></a>
     36 <ul>
     37     <li><a href="#TYPE_INTRO">Intro to typesetting macros</a>
     38     <li><a href="#PAGE">Page setup</a>
     39     <li><a href="#PARAM">Basic typesetting parameters</a>
     40     <li><a href="#JUST">Justifying, quadding, etc.</a>
     41     <li><a href="#REFINE">Refinements</a>
     42     <li><a href="#MOD">Modifying type</a>
     43     <li><a href="#VERT">Vertical movements</a>
     44     <li><a href="#TAB">Tabs</a>
     45     <li><a href="#COL">Multiple columns</a>
     46     <li><a href="#IND">Indents</a>
     47     <li><a href="#GOODIES">Goodies</a>
     48     <li><a href="#ESCAPES">Inline escapes</a>
     49     <li><a href="#COLOR">Coloured text</a>
     50 </ul>
     51 <p>
     52 <a href="#DOCPROC"><strong>DOCUMENT PROCESSING WITH MOM</strong></a>
     53 <ul>
     54     <li><a href="#DOCPROC_INTRO">Introduction to document processing</a>
     55     <li><a href="#PRELIM">Preliminary document setup</a>
     56     <li><a href="#TAGS">The document element tags</a> -- heads, subheads, footnotes, etc.
     57     <li><a href="#HDRFTR">Headers and footers</a>
     58     <li><a href="#PAGINATE">Pagination</a>
     59     <li><a href="#RV">Recto/verso printing and collating</a>
     60     <li><a href="#COVER">Cover pages</a>
     61     <li><a href="#REF">Bibliographies and references</a>
     62     <li><a href="#LETTER">Writing letters</a>
     63     <li><a href="#TYPEMACDOC">Using typesetting macros during document processing</a>
     64     <li><a href="#QUICK">Quick reference guide to mom</a>
     65     <li><a href="#APP">Appendices</a>
     66 </ul>
     67 <br>
     68 <hr>
     69 <a name="TOC_PROP"></a>
     70 <h2>Full Table of Contents</h2>
     71 <a name="INTRO"></a>
     72 <a name="WHAT"></a>
     73 	<li><a href="intro.html#INTRO"><strong>1. WHAT IS MOM?</strong></a>
     74 	<ul>
     75 		<li><a href="intro.html#INTRO_INTRO">1.1 Who is mom meant for?</a>
     76 		<li><a href="intro.html#INTRO_TYPESETTING">1.2 Typesetting with mom</a>
     77 		<li><a href="intro.html#INTRO_DOCPROCESSING">1.3 Document processing with mom</a>
     78 		<li><a href="intro.html#INTRO_PHILOSOPHY">1.4 Mom's philosophy</a>
     79 		<li><a href="intro.html#INTRO_DOCUMENTATION">1.5 A note on mom's documentation</a>
     80 		<ul>
     81 			<li><a href="intro.html#MACRO_ARGS">1.5.1 How to read macro arguments</a>
     82 			<li><a href="intro.html#TOGGLE_MACRO">1.5.2 &quot;Toggle&quot; macros</a>
     83 		</ul>
     84 	</ul>
     85 <a name="DEFS"></a>
     86 	<li><a href="definitions.html#TERMS"><strong>2. DEFINITIONS OF TERMS USED IN THIS MANUAL</strong></a>
     87 	<ul>
     88 		<li><a href="definitions.html#TERMS_TYPESETTING">2.1 Typesetting terms</a>
     89 		<li><a href="definitions.html#TERMS_GROFF">2.2 Groff terms</a>
     90 		<li><a href="definitions.html#TERMS_MOM">2.3 Mom's document processing terms</a>
     91 	</ul>
     92 <a name="USING"></a>
     93 	<li><a href="using.html#USING"><strong>3. USING MOM</strong></a>
     94 	<ul>
     95 		<li><a href="using.html#USING_INTRO">3.1 Introduction</a>
     96 		<li><a href="using.html#USING_MACROS">3.2 How to input mom's macros</a>
     97 		<li><a href="using.html#USING_INVOKING">3.3 Printing -- invoking groff with mom</a>
     98 		<li><a href="using.html#USING_PREVIEWING">3.4 How to preview documents</a>
     99 	</ul>
    100 <a name="TYPESET"></a>
    101 	<li><a href="typesetting.html#MACROS_TYPESETTING"><strong>4. THE TYPESETTING MACROS</strong></a>
    102 	<ul>
    103 <a name="TYPE_INTRO"></a>
    104 		<li><a href="typesetting.html#INTRO_MACROS_TYPESETTING">4.1 Introduction to the typesetting macros</a>
    105 		<br>
    106 <a name="PAGE"></a>
    107 		<li><a href="typesetting.html#PAGE_MARGINS"><strong>4.2 Page Setup</strong></a> -- paper size and page margins
    108 		<ul>
    109 			<li><a href="typesetting.html#INDEX_SETUP">4.2.1 Macro list</a>
    110 		</ul>
    111 <a name="PARAM"></a>
    112 		<li><a href="typesetting.html#BASIC_PARAMS"><strong>4.3 Basic Parameters</strong></a> -- family, font, fallback font, point size, line space, line length, autolead
    113 		<ul>
    114 			<li><a href="typesetting.html#INDEX_BASIC">4.3.1 Macro list</a>
    115 		</ul>
    116 <a name="JUST"></a>
    117 		<li><a href="typesetting.html#JUST_QUAD_FILL"><strong>4.4 Justifying, Quadding, Filling and Breaking Lines</strong></a>
    118 		<ul>
    119 			<li><a href="typesetting.html#INDEX_JUST">4.4.1 Macro list</a>
    120 		</ul>
    121 <a name="REFINE"></a>
    122 		<li><a href="typesetting.html#REFINEMENTS"><strong>4.5 Refinements</strong></a> -- word space, sentence space, letter spacing (track kerning), hyphenation, kerning, ligatures
    123 		<ul>
    124 			<li><a href="typesetting.html#INDEX_REFINEMENTS">4.5.1 Macro list</a>
    125 		</ul>
    126 <a name="MOD"></a>
    127 		<li><a href="typesetting.html#MODIFICATIONS"><strong>4.6 Modifying Type</strong></a> -- pseudo-italic, -bold, -condensed, and -extended
    128 		<ul>
    129 			<li><a href="typesetting.html#INDEX_MODIFICATIONS">4.6.1 Macro list</a>
    130 		</ul>
    131 <a name="VERT"></a>
    132 		<li><a href="typesetting.html#ALDRLD"><strong>4.7 Vertical Movements</strong></a> -- moving up and down on the page
    133 		<ul>
    134 			<li><a href="typesetting.html#INDEX_ALDRLD">4.7.1 Macro list</a>
    135 		</ul>
    136 <a name="TAB"></a>
    137 		<li><a href="typesetting.html#TABS"><strong>4.8 Tabs</strong></a>
    138 		<ul>
    139 			<li><a href="typesetting.html#TYPESETTING_TABS">4.8.1 Typesetting tabs</a>
    140 			<ul>
    141 				<li><a href="typesetting.html#TYPESETTING_TABS_TUT">4.8.1.1 Quickie tutorial</a>
    142 			</ul>
    143 			<li><a href="typesetting.html#STRING_TABS">4.8.2 String tabs (autotabs)</a>
    144 			<ul>
    145 				<li><a href="typesetting.html#STRING_TABS_TUT">4.8.2.1 Quickie tutorial</a>
    146 			</ul>
    147 			<li><a href="typesetting.html#INDEX_TABS">4.8.3 Macro list</a>
    148 		</ul>
    149 <a name="COL"></a>
    150 		<li><a href="typesetting.html#MULTI_COLUMNS"><strong>4.9 Multi-columns</strong></a>
    151 		<ul>
    152 			<li><a href="typesetting.html#INDEX_MULTI_COLUMNS">4.9.1 Macro list</a>
    153 		</ul>
    154 <a name="IND"></a>
    155 		<li><a href="typesetting.html#INDENTS"><strong>4.10 Indents</strong></a>
    156 		<ul>
    157 			<li><a href="typesetting.html#INDENTS_TUT">4.10.1 A brief explanation of how mom handles indents</a>
    158 			<li><a href="typesetting.html#INDEX_INDENTS">4.10.2 Macro list</a>
    159 		</ul>
    160 <a name="GOODIES"></a>
    161 		<li><a href="goodies.html#GOODIES"><strong>4.11 Goodies</strong></a> -- aliases,
    162 			transparent lines, smartquotes, caps,
    163 			underscoring/underlining, padding lines, leaders, drop
    164 			caps, superscripts, (nested) lists, user-definable strings
    165 		<ul>
    166 			<li><a href="goodies.html#INDEX_GOODIES">4.11.1 Macro list</a>
    167 		</ul>
    168 <a name="ESCAPES"></a>
    169 		<li><a href="inlines.html#INLINE_ESCAPES"><strong>4.12 Inline Escapes</strong></a>
    170 		<ul>
    171 			<li><a href="inlines.html#INTRO_INLINE_ESCAPES">4.12.1 Introduction to inline escapes</a>
    172 			<li><a href="inlines.html#INLINES_MOM">4.12.2 Mom's personal inlines</a>
    173 			<li><a href="inlines.html#INLINES_GROFF">4.12.3 Groff inlines</a>
    174 			<li><a href="inlines.html#INLINE_CHARACTERS_GROFF">4.12.3.1 Inlines for special characters and symbols</a>
    175 		</ul>
    176 <a name="COLOR"></a>
    177 		<li><a href="color.html#TOP"><strong>4.13 Coloured text</strong></a>
    178 		<ul>
    179 			<li><a href="color.html#INTRO_COLOR">4.13.1 Introduction to coloured text</a>
    180 			<li><a href="color.html#MACROS_COLOR">4.13.2 Macro list</a>
    181 		</ul>
    182 	</ul>
    183 <a name="DOCPROC"></a>
    184 <a name="DOCPROC_INTRO"></a>
    185 	<li><a href="docprocessing.html#DOCPROCESSING"><strong>5. DOCUMENT PROCESSING WITH MOM</strong></a>
    186 	<ul>
    187 		<li><a href="docprocessing.html#INTRO_MACROS_DOCPROCESSING">5.1 Introduction to document processing</a>
    188 		<li><a href="docprocessing.html#DEFAULTS">5.2 Some document defaults</a>
    189 		<ul>
    190 			<li><a href="docprocessing.html#LEADING_NOTE">IMPORTANT NOTE on leading/spacing and bottom margins</a>
    191 			<li><a href="docprocessing.html#SHIM">The SHIM macro</a> -- to get document leading back on track
    192 		</ul>
    193 <a name="PRELIM"></a>
    194 		<li><a href="docprocessing.html#SETUP"><strong>5.3 PRELIMINARY DOCUMENT SETUP</strong></a>
    195 		<ul>
    196 			<li><a href="docprocessing.html#DOCPROCESSING_TUT">5.3.1 Tutorial</a> -- setting up a mom document
    197 			<br>
    198 			<li><a href="docprocessing.html#REFERENCE_MACROS"><strong>5.3.2 The Reference Macros</strong></a>
    199 			<ul>
    200 				<li><a href="docprocessing.html#TITLE">5.3.2.1 TITLE</a>
    201 				<li><a href="docprocessing.html#DOC_TITLE">5.3.2.2 DOCTITLE</a>
    202 				<li><a href="docprocessing.html#SUBTITLE">5.3.2.3 SUBTITLE</a>
    203 				<li><a href="docprocessing.html#AUTHOR">5.3.2.4 AUTHOR</a>
    204 				<li><a href="docprocessing.html#CHAPTER">5.3.2.5 CHAPTER</a>
    205 				<li><a href="docprocessing.html#CHAPTER_TITLE">5.3.2.6 CHAPTER_TITLE</a>
    206 				<li><a href="docprocessing.html#DRAFT">5.3.2.7 DRAFT</a>
    207 				<li><a href="docprocessing.html#REVISION">5.3.2.8 REVISION</a>
    208 				<li><a href="docprocessing.html#COPYRIGHT">5.3.2.9 COPYRIGHT</a>
    209 				<li><a href="docprocessing.html#MISC">5.3.2.10 MISC</a>
    210 				<li><a href="docprocessing.html#COVERTITLE">5.3.2.11 COVER_TITLE</a>
    211 				<li><a href="docprocessing.html#COVERTITLE">5.3.2.12 DOC_COVER_TITLE</a>
    212 			</ul>
    213 			<li><a href="docprocessing.html#DOCSTYLE_MACROS"><strong>5.3.3 The Docstyle Macros</strong></a>
    214 			<ul>
    215 				<li><a href="docprocessing.html#DOCTYPE">5.3.3.1 DOCTYPE</a> -- kind of document
    216 				<li><a href="docprocessing.html#PRINTSTYLE">5.3.3.2 PRINTSTYLE</a> -- typeset or typewrite
    217 				<li><a href="docprocessing.html#COPYSTYLE">5.3.3.3 COPYSTYLE</a> -- draft or final
    218 			</ul>
    219 			<li><a href="docprocessing.html#STYLE_BEFORE_START"><strong>5.3.4 Changing Type and Style Parameters <em>before</em> START</strong></a>
    220 			<ul>
    221 				<li><a href="docprocessing.html#TYPE_BEFORE_START">5.3.4.1 Typesetting macros before START</a> -- usage
    222 				<ul>
    223 					<li><a href="docprocessing.html#COLOR">Colour</a>
    224 				</ul>
    225 				<li><a href="docprocessing.html#DOC_LEAD_ADJUST">5.3.4.2  DOC_LEAD_ADJUST</a> -- adjusting the document
    226 				    <a href="definitions.html#TERMS_LEADING">leading</a> (line spacing) to fill pages
    227 				<li><a href="docprocessing.html#DOCHEADER">5.3.4.3 DOCHEADER</a> -- managing the
    228                     <a href="definitions.html#TERMS_DOCHEADER">document header</a>
    229 
    230 			    <li><a href="docprocessing.html#COLUMNS_INTRO">5.3.4.4 COLUMNS</a> -- setting documents in columns
    231 			</ul>
    232 			<li><a href="docprocessing.html#START_MACRO"><strong>5.3.5 ***START***</strong></a> -- the macro to initiate document processing
    233 			<br>
    234 			<li><a href="docprocessing.html#DOC_PARAM_MACROS"><strong>5.3.6 Changing Document-wide Style Parameters <em>after</em> START</strong></a>
    235 			<ul>
    236 				<li><a href="docprocessing.html#INDEX_DOC_PARAM">5.3.6.1 Macro list</a>
    237 			</ul>
    238 <a name="TYPEMACDOC"></a>
    239 		<li><a href="typemacdoc.html#TYPESETTING"><strong>5.3.7 Using typesetting macros during document processing</strong></A>
    240 		</ul>
    241 <a name="TAGS"></a>
    242 		<li><a href="docelement.html#DOCELEMENT"><strong>5.4 THE DOCUMENT ELEMENT TAGS</strong></a>
    243 		<ul>
    244 			<li><a href="docelement.html#DOCELEMENT_INTRO">5.4.1 Introduction to the document element tags</a>
    245 			<ul>
    246 				<li><a href="docelement.html#DOCELEMENT_CONTROL">Control macros</a> -- changing style defaults for document element tags
    247 				<li><a href="docelement.html#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
    248 			</ul>
    249 			<li><a href="docelement.html#EPIGRAPH_INTRO">5.4.2 Epigraphs</a>
    250 			<li><a href="docelement.html#PP_INTRO">5.4.3 Paragraphs</a>
    251 			<li><a href="docelement.html#HEAD_INTRO">5.4.4 Main heads</a>
    252 			<li><a href="docelement.html#SUBHEAD_INTRO">5.4.5 Subheads</a>
    253 			<li><a href="docelement.html#PARAHEAD_INTRO">5.4.6 Paragraph heads</a>
    254 			<li><a href="docelement.html#LINEBREAK_INTRO">5.4.7 Linebreaks</a> -- author linebreaks (section breaks)
    255 			<li><a href="docelement.html#QUOTE_INTRO">5.4.8 Quotes</a> -- line for line poetic quotes or unformatted, verbatim text (e.g. code snippets)
    256 			<li><a href="docelement.html#BLOCKQUOTE_INTRO">5.4.9 Blockquotes</a> -- cited material
    257 			<li><a href="docelement.html#LIST_INTRO">5.4.10 Lists</a> -- (nested) lists
    258 			<li><a href="docelement.html#NUMBER_LINES_INTRO">5.4.11 Line numbering</a>
    259 			<li><a href="docelement.html#FOOTNOTE_INTRO">5.4.12 Footnotes</a>
    260 			<li><a href="docelement.html#ENDNOTE_INTRO">5.4.13 Endnotes</a>
    261 			<li><a href="docelement.html#MARGIN_NOTES_INTRO">5.4.14 Margin notes</a>
    262 			<li><a href="docelement.html#BLANK_PAGE_TITLE">5.4.15 Blank pages</a>
    263 			<li><a href="docelement.html#TOC_INTRO">5.4.16 Table of contents</a>
    264 			<li><a href="docelement.html#FINIS_INTRO">5.4.17 Document termination</a> -- FINIS
    265 		</ul>
    266 <a name="HDRFTR"></a>
    267 		<li><a href="headfootpage.html#HEADFOOTPAGE"><strong>5.5 DOCUMENT HEADERS AND FOOTERS</strong></a>
    268 		<ul>
    269 			<li><a href="headfootpage.html#HEADFOOTPAGE_INTRO">5.5.1 Introduction</a>
    270 			<li><a href="headfootpage.html#DESCRIPTION_GENERAL">5.5.2 General description of headers/footers</a>
    271 			<li><a href="headfootpage.html#HEADER_STYLE">5.5.3 Default specs for headers/footers</a>
    272 			<li><a href="headfootpage.html#VERTICAL_SPACING">5.5.4 Vertical placement and spacing of headers/footers</a>
    273 			<li><a href="headfootpage.html#HEADFOOT_MANAGEMENT">5.5.5 Managing headers/footers</a>
    274             <ul>
    275 		        <li><a href="headfootpage.html#USERDEF_HDRFTR">5.5.5.1 User-defined, single string recto/verso headers/footers</a>
    276             </ul>
    277 			<li><a href="headfootpage.html#HEADFOOT_CONTROL">5.5.6 Control macros for headers/footers</a>
    278 		</ul>
    279 <a name="PAGINATE"></a>
    280 		<li><a href="headfootpage.html#PAGINATION"><strong>5.6 PAGINATION</strong></a>
    281 		<ul>
    282 			<li><a href="headfootpage.html#PAGINATION">Introduction</a>
    283 			<li><a href="headfootpage.html#INDEX_PAGINATION">Pagination macros list</a>
    284 		</ul>
    285 <a name="RV"></a>
    286 		<li><a href="rectoverso.html#RECTOVERSO"><strong>5.7 RECTO/VERSO PRINTING AND COLLATING</strong></a>
    287 		<ul>
    288 			<li><a href="rectoverso.html#RECTOVERSO_INTRO">5.7.1 Introduction to recto/verso</a>
    289 			<ul>
    290 				<li><a href="rectoverso.html#RECTOVERSO_LIST">5.7.1.1 Macro list</a>
    291 			</ul>
    292 			<li><a href="rectoverso.html#COLLATE_INTRO">5.7.2 Introduction to collating</a>
    293 			<ul>
    294 				<li><a href="rectoverso.html#COLLATE">5.7.2.1 The COLLATE macro</a>
    295 			</ul>
    296 		</ul>
    297 <a name="COVER"></a>
    298 		<li><a href="cover.html#COVER_TOP"><strong>5.8 CREATING COVER PAGES</strong></a>
    299 		<br>
    300 <a name="REF"></a>
    301 		<li><a href="refer.html#REF_TOP"><strong>5.9 BIBLIOGRAPHIES AND REFERENCES</strong></a>
    302 		<br>
    303 <a name="LETTER"></a>
    304 		<li><a href="letters.html#LETTERS"><strong>5.10 WRITING LETTERS</strong></a>
    305 		<ul>
    306 			<li><a href="letters.html#LETTERS_INTRO">5.10.1 Introduction to writing letters</a>
    307 			<li><a href="letters.html#TUTORIAL">5.10.2 Tutorial on writing letters</a>
    308 			<li><a href="letters.html#LETTERS_DEFAULTS">5.10.3 Default style for letters</a>
    309 			<li><a href="letters.html#LETTERS_MACROS">5.10.4 The letter macros</a>
    310 		</ul>
    311 	</ul>
    312 <a name="QUICK"></a>
    313 <li><a href="macrolist.html#QUICK"><strong>6. QUICK REFERENCE GUIDE TO MOM</strong></a>
    314 <p>
    315 <a name="APP"></a>
    316 <li><a href="appendices.html#APPENDICES"><strong>7. APPENDICES</strong></a>
    317 	<ul>
    318 		<li><a href="appendices.html#MOREDOC">7.1 Further notes on this documentation</a>
    319 		<li><a href="appendices.html#FONTS">7.2 Adding PostScript fonts to groff</a>
    320 		<ul>
    321 			<li><a href="appendices.html#HOWTO">7.2.1 How to create a PostScript font for use with groff</a>
    322 		</ul>
    323 		<li><a href="appendices.html#CODENOTES">7.2 Some reflections on mom</a>
    324 		<li><a href="reserved.html#RESERVED">7.3 List of reserved words</a>
    325 		<li><a href="appendices.html#CONTACT">7.4 Contact the author</a>
    326 	</ul>
    327 </ul>
    328 </body>
    329 </html>
    330