o Added TOC (finally) and a nearly complete set of associated
[s-roff.git] / contrib / mom / momdoc / toc.html
bloba6e1b8ff5567fa866f542eba8e0b62d58f6802fe
1 <html>
2 <head>
3 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
4 <title>Mom -- Table of Contents</title>
5 </head>
6 <body bgcolor="#dfdfdf">
8 <!====================================================================>
10 <h1><u>Table of Contents</u></h1>
11 <a href="#TOC_PROP">This link takes you to the Table of Contents itself</a>
12 <h3>Table of Contents Navigation</h3>
13 <a href="#INTRO">INTRODUCTORY STUFF</a>
14 <ul>
15 <li><a href="#WHAT">What is mom?</a>
16 <li><a href="#DEFS">Definitions of terms used in this manual</a>
17 <li><a href="#USING">Using mom</a>
18 </ul>
19 <a href="#TYPESET">TYPESETTING WITH MOM</a>
20 <ul>
21 <li><a href="#TYPE_INTRO">Intro to typesetting macros</a>
22 <li><a href="#PAGE">Page setup</a>
23 <li><a href="#PARAM">Basic typesetting parameters</a>
24 <li><a href="#JUST">Justifying, quadding, etc.</a>
25 <li><a href="#REFINE">Refinements</a>
26 <li><a href="#MOD">Modifying type</a>
27 <li><a href="#VERT">Vertical movements</a>
28 <li><a href="#TAB">Tabs</a>
29 <li><a href="#COL">Multiple columns</a>
30 <li><a href="#IND">Indents</a>
31 <li><a href="#GOODIES">Goodies</a>
32 <li><a href="#ESCAPES">Inline escapes</a>
33 </ul>
34 <a href="#DOCPROC">DOCUMENT PROCESSING WITH MOM</a>
35 <ul>
36 <li><a href="#DOCPROC_INTRO">Introduction to document processing</a>
37 <li><a href="#PRELIM">Preliminary document setup</a>
38 <li><a href="#TAGS">The document element tags</a> -- heads, subheads, footnotes, etc.
39 <li><a href="#HDRFTR">Headers and footers</a>
40 <li><a href="#PAGINATE">Pagination</a>
41 <li><a href="#RV">Recto/verso printing and collating</a>
42 <li><a href="#COVER">Cover pages</a>
43 <li><a href="#LETTER">Writing letters</a>
44 <li><a href="#TYPEMACDOC">Using typesetting macros during document processing</a>
45 <li><a href="#APP">Appendices</a>
46 </ul>
47 <br>
48 <hr width="66%" align="left">
49 <br>
50 <a name="TOC_PROP"></a>
51 <h3>The Table of Contents Proper</h3>
52 <a name="INTRO"></a>
53 <a name="WHAT"></a>
54 <li><a href="intro.html#INTRO"><strong>1. WHAT IS MOM?</strong></a>
55 <ul>
56 <li><a href="intro.html#INTRO_INTRO">1.1 Who is mom meant for?</a>
57 <li><a href="intro.html#INTRO_TYPESETTING">1.2 Typesetting with mom</a>
58 <li><a href="intro.html#INTRO_DOCPROCESSING">1.3 Document processing with mom</a>
59 <li><a href="intro.html#INTRO_PHILOSOPHY">1.4 Mom's philosophy</a>
60 <li><a href="intro.html#INTRO_DOCUMENTATION">1.5 A note on mom's documentation</a>
61 <ul>
62 <li><a href="intro.html#MACRO_ARGS">1.5.1 How to read macro arguments</a>
63 <li><a href="intro.html#TOGGLE_MACRO">1.5.2 &quot;Toggle&quot; macros</a>
64 </ul>
65 </ul>
66 <a name="DEFS"></a>
67 <li><a href="definitions.html#TERMS"><strong>2. DEFINITIONS OF TERMS USED IN THIS MANUAL</strong></a>
68 <ul>
69 <li><a href="definitions.html#TERMS_TYPESETTING">2.1 Typesetting terms</a>
70 <li><a href="definitions.html#TERMS_GROFF">2.2 Groff terms</a>
71 <li><a href="definitions.html#TERMS_MOM">2.3 Mom's document processing terms</a>
72 </ul>
73 <a name="USING"></a>
74 <li><a href="using.html#USING"><strong>3. USING MOM</strong></a>
75 <ul>
76 <li><a href="using.html#USING_INTRO">3.1 Introduction</a>
77 <li><a href="using.html#USING_MACROS">3.2 How to input mom's macros</a>
78 <li><a href="using.html#USING_INVOKING">3.3 Printing -- invoking groff with mom</a>
79 <li><a href="using.html#USING_PREVIEWING">3.4 How to preview documents</a>
80 </ul>
81 <a name="TYPESET"></a>
82 <li><a href="typesetting.html#MACROS_TYPESETTING"><strong>4. THE TYPESETTING MACROS</strong></a>
83 <ul>
84 <a name="TYPE_INTRO"></a>
85 <li><a href="typesetting.html#INTRO_MACROS_TYPESETTING">4.1 Introduction to the typesetting macros</a>
86 <br>
87 <a name="PAGE"></a>
88 <li><a href="typesetting.html#PAGE_MARGINS"><strong>4.2 Page Setup</strong></a> -- paper size and page margins
89 <ul>
90 <li><a href="typesetting.html#INDEX_SETUP">4.2.1 Macro list</a>
91 </ul>
92 <a name="PARAM"></a>
93 <li><a href="typesetting.html#BASIC_PARAMS"><strong>4.3 Basic Parameters</strong></a> -- family, font, point size, line space, line length, autolead
94 <ul>
95 <li><a href="typesetting.html#INDEX_BASIC">4.3.1 Macro list</a>
96 </ul>
97 <a name="JUST"></a>
98 <li><a href="typesetting.html#JUST_QUAD_FILL"><strong>4.4 Justifying, Quadding, Filling and Breaking Lines</strong></a>
99 <ul>
100 <li><a href="typesetting.html#INDEX_JUST">4.4.1 Macro list</a>
101 </ul>
102 <a name="REFINE"></a>
103 <li><a href="typesetting.html#REFINEMENTS"><strong>4.5 Refinements</strong></a> -- word space, sentence space, letter spacing (track kerning), hyphenation, kerning, ligatures
104 <ul>
105 <li><a href="typesetting.html#INDEX_REFINEMENTS">4.5.1 Macro list</a>
106 </ul>
107 <a name="MOD"></a>
108 <li><a href="typesetting.html#MODIFICATIONS"><strong>4.6 Modifying Type</strong></a> -- pseudo-italic, -bold, -condensed, and -extended
109 <ul>
110 <li><a href="typesetting.html#INDEX_MODIFICATIONS">4.6.1 Macro list</a>
111 </ul>
112 <a name="VERT"></a>
113 <li><a href="typesetting.html#ALDRLD"><strong>4.7 Vertical Movements</strong></a> -- moving up and down on the page
114 <ul>
115 <li><a href="typesetting.html#INDEX_ALDRLD">4.7.1 Macro list</a>
116 </ul>
117 <a name="TAB"></a>
118 <li><a href="typesetting.html#TABS"><strong>4.8 Tabs</strong></a>
119 <ul>
120 <li><a href="typesetting.html#TYPESETTING_TABS">4.8.1 Typesetting tabs</a>
121 <ul>
122 <li><a href="typesetting.html#TYPESETTING_TABS_TUT">4.8.1.1 Quickie tutorial</a>
123 </ul>
124 <li><a href="typesetting.html#STRING_TABS">4.8.2 String tabs (autotabs)</a>
125 <ul>
126 <li><a href="typesetting.html#STRING_TABS_TUT">4.8.2.1 Quickie tutorial</a>
127 </ul>
128 <li><a href="typesetting.html#INDEX_TABS">4.8.3 Macro list</a>
129 </ul>
130 <a name="COL"></a>
131 <li><a href="typesetting.html#MULTI_COLUMNS"><strong>4.9 Multi-columns</strong></a>
132 <ul>
133 <li><a href="typesetting.html#INDEX_MULTI_COLUMNS">4.9.1 Macro list</a>
134 </ul>
135 <a name="IND"></a>
136 <li><a href="typesetting.html#INDENTS"><strong>4.10 Indents</strong></a>
137 <ul>
138 <li><a href="typesetting.html#INDENTS_TUT">4.10.1 A brief explanation of how mom handles indents</a>
139 <li><a href="typesetting.html#INDEX_INDENTS">4.10.2 Macro list</a>
140 </ul>
141 <a name="GOODIES"></a>
142 <li><a href="goodies.html#GOODIES"><strong>4.11 Goodies</strong></a> -- aliases,
143 transparent lines, smartquotes, caps,
144 underscoring/underlining, padding lines, leaders, drop
145 caps, superscripts
146 <ul>
147 <li><a href="goodies.html#INDEX_GOODIES">4.11.1 Macro list</a>
148 </ul>
149 <a name="ESCAPES"></a>
150 <li><a href="inlines.html#INLINE_ESCAPES"><strong>4.12 Inline Escapes</strong></a>
151 <ul>
152 <li><a href="inlines.html#INTRO_INLINE_ESCAPES">4.12.1 Introduction to inline escapes</a>
153 <li><a href="inlines.html#INLINES_MOM">4.12.2 Mom's personal inlines</a>
154 <li><a href="inlines.html#INLINES_GROFF">4.12.3 Groff inlines</a>
155 <li><a href="inlines.html#INLINE_CHARACTERS_GROFF">4.12.3.1 Inlines for special characters and symbols</a>
156 </ul>
157 </ul>
158 <a name="DOCPROC"></a>
159 <a name="DOCPROC_INTRO"></a>
160 <li><a href="docprocessing.html#DOCPROCESSING"><strong>5. DOCUMENT PROCESSING WITH MOM</strong></a>
161 <ul>
162 <li><a href="docprocessing.html#INTRO_MACROS_DOCPROCESSING">5.1 Introduction to document processing</a>
163 <li><a href="docprocessing.html#DEFAULTS">5.2 Some document defaults</a>
164 <ul>
165 <li><a href="docprocessing.html#LEADING_NOTE">IMPORTANT NOTE on leading/spacing and bottom margins</a>
166 </ul>
167 <a name="PRELIM"></a>
168 <li><a href="docprocessing.html#SETUP"><strong>5.3 PRELIMINARY DOCUMENT SETUP</strong></a>
169 <ul>
170 <li><a href="docprocessing.html#DOCPROCESSING_TUT">5.3.1 Tutorial</a> -- setting up a mom document
171 <br>
172 <li><a href="docprocessing.html#REFERENCE_MACROS"><strong>5.3.2 The Reference Macros</strong></a>
173 <ul>
174 <li><a href="docprocessing.html#TITLE">5.3.2.1 TITLE</a>
175 <li><a href="docprocessing.html#DOC_TITLE">5.3.2.2 DOCTITLE</a>
176 <li><a href="docprocessing.html#SUBTITLE">5.3.2.3 SUBTITLE</a>
177 <li><a href="docprocessing.html#AUTHOR">5.3.2.4 AUTHOR</a>
178 <li><a href="docprocessing.html#CHAPTER">5.3.2.5 CHAPTER</a>
179 <li><a href="docprocessing.html#CHAPTER_TITLE">5.3.2.6 CHAPTER_TITLE</a>
180 <li><a href="docprocessing.html#DRAFT">5.3.2.7 DRAFT</a>
181 <li><a href="docprocessing.html#REVISION">5.3.2.8 REVISION</a>
182 </ul>
183 <li><a href="docprocessing.html#DOCSTYLE_MACROS"><strong>5.3.3 The Docstyle Macros</strong></a>
184 <ul>
185 <li><a href="docprocessing.html#DOCTYPE">5.3.3.1 DOCTYPE</a> -- kind of document
186 <li><a href="docprocessing.html#PRINTSTYLE">5.3.3.2 PRINTSTYLE</a> -- typeset or typewrite
187 <li><a href="docprocessing.html#COPYSTYLE">5.3.3.3 COPYSTYLE</a> -- draft or final
188 </ul>
189 <li><a href="docprocessing.html#STYLE_BEFORE_START"><strong>5.3.4 Changing Type and Style Parameters <em>before</em> START</strong></a>
190 <ul>
191 <li><a href="docprocessing.html#TYPE_BEFORE_START">5.3.4.1 Typesetting macros</a> -- usage
192 <li><a href="docprocessing.html#DOC_LEAD_ADJUST">5.3.4.2 DOC_LEAD_ADJUST</a> -- adjust document leading to fill pages
193 <li><a href="docprocessing.html#DOCHEADER">5.3.4.3 DOCHEADER</a> -- managing the docheader
194 <li><a href="docprocessing.html#COLUMNS_INTRO">5.3.4.4 COLUMNS</a> -- setting documents in columns
195 </ul>
196 <li><a href="docprocessing.html#START_MACRO"><strong>5.3.5 ***START***</strong></a> -- the macro to initiate document processing
197 <br>
198 <li><a href="docprocessing.html#DOC_PARAM_MACROS"><strong>5.3.6 Changing Document-wide Style Parameters <em>after</em> START</strong></a>
199 <ul>
200 <li><a href="docprocessing.html#INDEX_DOC_PARAM">5.3.6.1 Macro list</a>
201 </ul>
202 </ul>
203 <a name="TAGS"></a>
204 <li><a href="docelement.html#DOCELEMENT"><strong>5.4 THE DOCUMENT ELEMENT TAGS</strong></a>
205 <ul>
206 <li><a href="docelement.html#DOCELEMENT_INTRO">5.4.1 Introduction to the document element tags</a>
207 <ul>
208 <li><a href="docelement.html#DOCELEMENT_CONTROL">Control macros</a> -- changing style defaults for document element tags
209 <li><a href="docelement.html#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
210 </ul>
211 <li><a href="docelement.html#EPIGRAPH_INTRO">5.4.2 Epigraphs</a>
212 <li><a href="docelement.html#PP_INTRO">5.4.3 Paragraphs</a>
213 <li><a href="docelement.html#HEAD_INTRO">5.4.4 Main heads</a>
214 <li><a href="docelement.html#SUBHEAD_INTRO">5.4.5 Subheads</a>
215 <li><a href="docelement.html#PARAHEAD_INTRO">5.4.6 Paragraph heads</a>
216 <li><a href="docelement.html#LINEBREAK_INTRO">5.4.7 Linebreaks</a> -- author linebreaks
217 <li><a href="docelement.html#QUOTE_INTRO">5.4.8 Quotes</a> -- line for line poetic quotes
218 <li><a href="docelement.html#BLOCKQUOTE_INTRO">5.4.9 Blockquotes</a> -- cited material
219 <li><a href="docelement.html#FOOTNOTE_INTRO">5.4.10 Footnotes</a>
220 <li><a href="docelement.html#ENDNOTE_INTRO">5.4.11 Endnotes</a>
221 <li><a href="docelement.html#BLANK_PAGE_TITLE">5.4.12 Blank page</a>
222 <li><a href="docelement.html#TOC_INTRO">5.4.13 Table of contents</a>
223 <li><a href="docelement.html#FINIS_INTRO">5.4.14 Document termination</a> -- FINIS
224 </ul>
225 <a name="HDRFTR"></a>
226 <li><a href="headfootpage.html#HEADFOOTPAGE"><strong>5.5 DOCUMENT HEADERS AND FOOTERS</strong></a>
227 <ul>
228 <li><a href="headfootpage.html#HEADFOOTPAGE_INTRO">5.5.1 Introduction</a>
229 <li><a href="headfootpage.html#DESCRIPTION_GENERAL">5.5.2 General description of headers/footers</a>
230 <li><a href="headfootpage.html#HEADER_STYLE">5.5.3 Default specs for headers/footers</a>
231 <li><a href="headfootpage.html#VERTICAL_SPACING">5.5.4 Vertical placement and spacing of headers/footers</a>
232 <li><a href="headfootpage.html#HEADFOOT_MANAGEMENT">5.5.5 Managing headers/footers</a>
233 <ul>
234 <li><a href="headfootpage.html#USERDEF_HDRFTR">5.5.5.1 User-defined, single string recto/verso headers/footers</a>
235 </ul>
236 <li><a href="headfootpage.html#HEADFOOT_CONTROL">5.5.6 Control macros for headers/footers</a>
237 </ul>
238 <a name="PAGINATE"></a>
239 <li><a href="headfootpage.html#PAGINATION"><strong>5.6 PAGINATION</strong></a>
240 <ul>
241 <li><a href="headfootpage.html#PAGINATION">Introduction</a>
242 <li><a href="headfootpage.html#INDEX_PAGINATION">Pagination macros list</a>
243 </ul>
244 <a name="RV"></a>
245 <li><a href="rectoverso.html#RECTOVERSO"><strong>5.7 RECTO/VERSO PRINTING AND COLLATING</strong></a>
246 <ul>
247 <li><a href="rectoverso.html#RECTOVERSO_INTRO">5.7.1 Introduction to recto/verso</a>
248 <ul>
249 <li><a href="rectoverso.html#RECTOVERSO_LIST">5.7.1.1 Macro list</a>
250 </ul>
251 <li><a href="rectoverso.html#COLLATE_INTRO">5.7.2 Introduction to collating</a>
252 <ul>
253 <li><a href="rectoverso.html#COLLATE">5.7.2.1 The COLLATE macro</a>
254 </ul>
255 </ul>
256 <a name="COVER"></a>
257 <li><a href="cover.html"><strong>5.8 CREATING A COVER PAGE</strong></a>
258 <br>
259 <a name="LETTER"></a>
260 <li><a href="letters.html#LETTERS"><strong>5.9 WRITING LETTERS</strong></a>
261 <ul>
262 <li><a href="letters.html#LETTERS_INTRO">5.9.1 Introduction to writing letters</a>
263 <li><a href="letters.html#TUTORIAL">5.9.2 Tutorial on writing letters</a>
264 <li><a href="letters.html#LETTERS_DEFAULTS">5.9.3 Default style for letters</a>
265 <li><a href="letters.html#LETTERS_MACROS">5.9.4 The letter macros</a>
266 </ul>
267 <a name="TYPEMACDOC"></a>
268 <li><a href="typemacdoc.html#TYPESETTING"><strong>5.10 USING TYPESETTING MACROS DURING DOCUMENT PROCESSING</strong></a>
269 </ul>
270 <a name="APP"></a>
271 <li><a href="appendices.html#APPENDICES"><strong>6. APPENDICES</strong></a>
272 <ul>
273 <li><a href="appendices.html#MOREDOC">6.1 Further notes on this documentation</a>
274 <li><a href="appendices.html#CODENOTES">6.2 Some reflections on mom</a>
275 <li><a href="reserved.html#RESERVED">6.3 List of reserved words</a>
276 <li><a href="appendices.html#CONTACT">6.4 Contact the author</a>
277 </ul>
278 </ul>
279 </body>
280 </html>