/contrib/groff/contrib/mom/momdoc/toc.html

https://bitbucket.org/freebsd/freebsd-head/ · HTML · 329 lines · 324 code · 5 blank · 0 comment · 0 complexity · 00d1099ddfcc8b9be694b54f8f1ed93e MD5 · raw file

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