PageRenderTime 76ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/contrib/groff/contrib/mom/momdoc/typesetting.html

https://bitbucket.org/freebsd/freebsd-head/
HTML | 4189 lines | 3745 code | 386 blank | 58 comment | 0 complexity | 31b388b97e5373c5259dc6a73c87a7ba MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, BSD-3-Clause, LGPL-2.0, LGPL-2.1, BSD-2-Clause, 0BSD, JSON, AGPL-1.0, GPL-2.0
  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 -- Typesetting Macros</title>
  6. </head>
  7. <body bgcolor="#dfdfdf">
  8. <!====================================================================>
  9. <a href="goodies.html#TOP">Next</a>&nbsp;&nbsp;
  10. <a href="definitions.html#TOP">Prev</a>&nbsp;&nbsp;
  11. <a href="toc.html">Back to Table of Contents</a>
  12. <p>
  13. <a name="TOP"></a>
  14. <a name="MACROS_TYPESETTING">
  15. <h1 align="center"><u>THE TYPESETTING MACROS</u></h1>
  16. </a>
  17. <a href="#INTRO_MACROS_TYPESETTING">Introduction to the typesetting macros</a>
  18. <br>
  19. <ul>
  20. <li><strong>PAGE SETUP</strong>
  21. <ul>
  22. <li><a href="#INTRO_SETUP">Introduction to Page Setup</a>
  23. <li><a href="#INDEX_SETUP">List of macros</a>
  24. </ul>
  25. <li><strong>BASIC TYPESETTING PARAMETERS</strong>
  26. <ul>
  27. <li><a href="#INTRO_BASIC_PARAMS">Introduction to Basic Parameters</a>
  28. <li><a href="#INDEX_BASIC">List of macros</a>
  29. </ul>
  30. <li><strong>JUSTIFYING, QUADDING, FILLING, BREAKING and JOINING LINES</strong>
  31. <ul>
  32. <li><a href="#INTRO_JUST_QUAD_FILL">Introduction to justify, quad, fill, break</a>
  33. <li><a href="#INDEX_JUST">List of macros</a>
  34. </ul>
  35. <li><strong>TYPOGRAPHIC REFINEMENTS</strong>
  36. <ul>
  37. <li><a href="#INTRO_REFINEMENTS">Introduction to typographic refinements</a>
  38. <li><a href="#INDEX_REFINEMENTS">List of macros</a>
  39. </ul>
  40. <li><strong>TYPE MODIFICATIONS -- pseudo italic, bold, condense, extend</strong>
  41. <ul>
  42. <li><a href="#INTRO_MODIFICATIONS">Introduction to type modifications</a>
  43. <li><a href="#INDEX_MODIFICATIONS">List of macros</a>
  44. </ul>
  45. <li><strong>VERTICAL MOVEMENTS</strong>
  46. <ul>
  47. <li><a href="#INTRO_ALDRLD">Introduction to vertical movements</a>
  48. <li><a href="#INDEX_ALDRLD">List of macros</a>
  49. </ul>
  50. <li><strong>TABS</strong>
  51. <ul>
  52. <li><a href="#INTRO_TABS">Introduction to tabs</a>
  53. <li><a href="#TYPESETTING_TABS">Typesetting tabs</a>
  54. <ul>
  55. <li><a href="#TYPESETTING_TABS_TUT">Quickie tutorial</a>
  56. </ul>
  57. <li><a href="#STRING_TABS">String tabs</a>
  58. <ul>
  59. <li><a href="#STRING_TABS_TUT">Quickie tutorial</a>
  60. </ul>
  61. <li><a href="#INDEX_TABS">List of macros</a>
  62. </ul>
  63. <li><strong>MULTI-COLUMNS</strong>
  64. <ul>
  65. <li><a href="#INTRO_MULTI_COLUMNS">Introduction to multi-columns</a>
  66. <li><a href="#INDEX_MULTI_COLUMNS">List of macros</a>
  67. </ul>
  68. <li><strong>INDENTS</strong>
  69. <ul>
  70. <li><a href="#INTRO_INDENTS">Introduction to indents</a>
  71. <li><a href="#INDEX_INDENTS">List of macros</a>
  72. </ul>
  73. <li><strong>GOODIES</strong>
  74. <ul>
  75. <li><a href="goodies.html#GOODIES">Introduction to goodies</a>
  76. <li><a href="goodies.html#INDEX_GOODIES">List of macros</a>
  77. </ul>
  78. <li><strong>INLINE ESCAPES</strong>
  79. <ul>
  80. <li><a href="inlines.html#INLINE_ESCAPES_INTRO">Introduction to inline escapes</a>
  81. <li><a href="inlines.html#INDEX_INLINES">List of inline escapes</a>
  82. </ul>
  83. </ul>
  84. <p>
  85. <hr>
  86. <h2><a name="INTRO_MACROS_TYPESETTING"><u>Introduction to the typesetting macros</u></a></h2>
  87. <strong>Mom</strong>'s typesetting macros provide access to
  88. groff's typesetting capabilities. Aside from controlling basic
  89. type parameters (family, font, line length, point size, leading),
  90. <strong>mom</strong>'s macros fine-tune wordspacing, letterspacing,
  91. kerning, hyphenation, and so on. In addition, <strong>mom</strong>
  92. has true typesetting tabs, string tabs, multiple indent styles,
  93. line padding, and a batch of other goodies.
  94. <p>
  95. In some cases, <strong>mom</strong>'s typesetting macros merely imitate
  96. groff primitives. In others, they approach typesetting concerns in
  97. conceptually new ways (for groff, at least). This should present no
  98. problem for newcomers to groff who are learning <strong>mom</strong>.
  99. Old groff hands should be careful. Just because it looks like a
  100. duck and walks like a duck does not, in this instance, mean that it
  101. is a duck. When using <strong>mom</strong>, stay away from groff
  102. primitives if <strong>mom</strong> provides a macro that accomplishes
  103. the same thing.
  104. <p>
  105. <strong>Mom</strong>'s typesetting macros can be used as a standalone
  106. package, independent of the
  107. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
  108. With them, you can typeset on-the-fly. Book covers, your best
  109. friend's résumé, a poster for a lost dog--none of these requires
  110. structured document processing (page headers, paragraphs, heads,
  111. footnotes, etc). What they do demand is precise control over every
  112. element on the page. The typesetting macros give you that control.
  113. <p>
  114. <hr>
  115. <!====================================================================>
  116. <a name="INTRO_SETUP"></a>
  117. <a name="PAGE_MARGINS">
  118. <h2><u>Page setup: paper size and page margins</u></h2>
  119. </a>
  120. The page setup macros establish the physical dimensions of your
  121. page and the margins you want it to have. <strong>Groff</strong>
  122. has defaults for these, but I recommend setting them at the top
  123. of your files anyway unless you're using <strong>mom</strong>'s
  124. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>
  125. and are content with her defaults.
  126. <p>
  127. The
  128. <a href="#PAPER">PAPER</a>
  129. macro provides a shortcut for setting the page to the correct dimensions
  130. for a number of well-known, established paper sizes. The
  131. <a href="#PAGE">PAGE</a>
  132. macro provides a convenient way of setting the page dimensions and
  133. some or all of the page margins with a single macro.
  134. <p>
  135. <a name="INDEX_SETUP">
  136. <h3><u>Page setup macros list</u></h3>
  137. </a>
  138. <ul>
  139. <li><a href="#PAGEWIDTH">PAGEWIDTH</a> (page width)
  140. <li><a href="#PAGELENGTH">PAGELENGTH</a> (page length)
  141. <li><a href="#PAPER">PAPER</a> (common paper sizes)
  142. <li><a href="#L_MARGIN">L_MARGIN</a> (left margin)
  143. <li><a href="#R_MARGIN">R_MARGIN</a> (right margin)
  144. <li><a href="#T_MARGIN">T_MARGIN</a> (top margin)
  145. <li><a href="#B_MARGIN">B_MARGIN</a> (bottom margin)
  146. <li><a href="#PAGE">PAGE</a> (page dimensions and margins all in one fell swoop)
  147. <li><a href="#NEWPAGE">NEWPAGE</a> (start a new page)
  148. </ul>
  149. <p>
  150. <!---PAGEWIDTH--->
  151. <hr width="66%" align="left">
  152. <a name="PAGEWIDTH"><h3><u>Page width</u></h3></a>
  153. <br>
  154. <nobr>Macro: <strong>PAGEWIDTH</strong> &lt;width of printer sheet&gt;</nobr>
  155. <br>
  156. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  157. <p>
  158. The argument to <strong>PAGEWIDTH</strong> is the width of your
  159. printer sheet. <strong>PAGEWIDTH</strong> requires a unit of measure.
  160. Decimal fractions are allowed. Hence, to tell <strong>mom</strong>
  161. the width of your printer sheet is 8-1/2 inches, you enter
  162. <p>
  163. <pre>
  164. .PAGEWIDTH 8.5i
  165. </pre>
  166. <!---PAGELENGTH--->
  167. <hr width="66%" align="left">
  168. <a name="PAGELENGTH"><h3><u>Page length</u></h3></a>
  169. <br>
  170. <nobr>Macro: <strong>PAGELENGTH</strong> &lt;length of printer sheet&gt;</nobr>
  171. <br>
  172. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  173. <p>
  174. <strong>PAGELENGTH</strong> tells <strong>mom</strong> how long your
  175. printer sheet is. It works just like
  176. <strong>PAGEWIDTH</strong>. Therefore, to tell
  177. <strong>mom</strong> your printer sheet is 11 inches long, you
  178. enter
  179. <p>
  180. <pre>
  181. .PAGELENGTH 11i
  182. </pre>
  183. <!---PAPER--->
  184. <hr width="66%" align="left">
  185. <a name="PAPER"><h3><u>Paper</u></h3></a>
  186. <br>
  187. <nobr>Macro: <strong>PAPER</strong> &lt;paper type&gt;</nobr>
  188. <p>
  189. <strong>PAPER</strong> provides a convenient way to set the page
  190. dimensions for some common printer sheet sizes. <nobr>&lt;paper
  191. type&gt; can be one of:</nobr>
  192. <p>
  193. <pre>
  194. LETTER
  195. LEGAL
  196. STATEMENT
  197. TABLOID
  198. LEDGER
  199. FOLIO
  200. QUARTO
  201. 10x14
  202. EXECUTIVE
  203. A3
  204. A4
  205. A5
  206. B4
  207. B5
  208. </pre>
  209. Say, for example, you have A4-sized sheets in your printer.
  210. It's shorter (and easier) to enter
  211. <p>
  212. <pre>
  213. .PAPER A4
  214. </pre>
  215. than to remember the correct dimensions and enter
  216. <p>
  217. <pre>
  218. .PAGEWIDTH 595p
  219. .PAGELENGTH 842p
  220. </pre>
  221. <!---L_MARGIN--->
  222. <hr width="66%" align="left">
  223. <a name="L_MARGIN"><h3><u>Left margin</u></h3></a>
  224. <br>
  225. <nobr>Macro: <strong>L_MARGIN</strong> &lt;left margin&gt;</nobr>
  226. <br>
  227. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  228. <p>
  229. <strong>L_MARGIN</strong> establishes the distance from the left edge
  230. of the printer sheet at which you want your type to start. It may
  231. be used any time, and remains in effect until you enter a new value.
  232. <p>
  233. <a href="#IL">Left indents</a>
  234. and
  235. <a href="#TABS">tabs</a>
  236. are calculated from the value you pass to <strong>L_MARGIN</strong>,
  237. hence it's always a good idea to invoke it before starting any serious
  238. typesetting. A unit of measure is required. Decimal fractions are
  239. allowed. Therefore, to set the left margin at 3 picas (1/2 inch),
  240. you'd enter either
  241. <p>
  242. <pre>
  243. .L_MARGIN 3P
  244. &nbsp;&nbsp;or
  245. .L_MARGIN .5i
  246. </pre>
  247. If you use the macros
  248. <a href="#PAGE">PAGE</a>,
  249. <a href="#PAGEWIDTH">PAGEWIDTH</a>
  250. or
  251. <a href="#PAPER">PAPER</a>
  252. without invoking <strong>L_MARGIN</strong> (either before
  253. or afterwards), <strong>mom</strong> automatically sets
  254. </strong>L_MARGIN</strong> to 1 inch.
  255. <p>
  256. <strong>NOTE:</strong> L_MARGIN behaves in a special way when you're
  257. using the
  258. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
  259. See
  260. <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a>
  261. for an explanation.
  262. <p>
  263. <!---R_MARGIN--->
  264. <hr width="66%" align="left">
  265. <a name="R_MARGIN"><h3><u>Right margin</u></h3></a>
  266. <br>
  267. <nobr>Macro: <strong>R_MARGIN</strong> &lt;right margin&gt;</nobr>
  268. <br>
  269. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  270. <p>
  271. <strong>R_MARGIN</strong> establishes the amount of space you
  272. want between the end of typeset lines and the right hand edge
  273. of the printer sheet. In other words, it sets the line length.
  274. <strong>R_MARGIN</strong> requires a unit of measure. Decimal
  275. fractions are allowed.
  276. <p>
  277. The <a href="#LINELENGTH">line length macro</a> (<strong>LL</strong>) can
  278. be used in place of <strong>R_MARGIN</strong>. In either case, the
  279. last one invoked sets the line length. The choice of which to use is
  280. up to you. In some instances, you may find it easier to think of a
  281. section of type as having a right margin. In others, giving a line
  282. length may make more sense.
  283. <p>
  284. For example, if you're setting a page of type you know should have
  285. 6-pica margins left and right, it makes sense to enter a left and
  286. right margin, like this:
  287. <p>
  288. <pre>
  289. .L_MARGIN 6P
  290. .R_MARGIN 6P
  291. </pre>
  292. That way, you don't have to worry about calculating the line
  293. length. On the other hand, if you know the line length for a
  294. patch of type should be 17 picas and 3 points, entering the line
  295. length with <strong>LL</strong> is much easier than calculating the
  296. right margin.
  297. <p>
  298. <pre>
  299. .LL 17P+3p
  300. </pre>
  301. If you use the macros
  302. <a href="#PAGE">PAGE</a>,
  303. <a href="#PAGEWIDTH">PAGEWIDTH</a>
  304. or
  305. <a href="#PAPER">PAPER</a>
  306. without invoking <strong>R_MARGIN</strong> afterwards,
  307. <strong>mom</strong> automatically sets <strong>R_MARGIN</strong>
  308. to 1 inch. If you set a line length after these macros (with
  309. <a href="#LINELENGTH">LL</a>),
  310. the line length calculated by <strong>R_MARGIN</strong> is, of course,
  311. overridden.
  312. <p>
  313. <strong>IMPORTANT: R_MARGIN</strong>, if used, MUST come after
  314. <a href="#PAPER">PAPER</a>,
  315. <a href="#PAGEWIDTH">PAGEWIDTH</a>,
  316. <a href="#L_MARGIN">L_MARGIN</a>
  317. and/or
  318. <a href="#PAGE">PAGE</a>
  319. (if a right margin isn't given to <strong>PAGE</strong>).
  320. The reason is that <strong>R_MARGIN</strong> calculates line
  321. length from the overall page dimensions and the left margin.
  322. Obviously, it can't make the calculation if it doesn't know the page
  323. width and the left margin.
  324. <p>
  325. <strong>NOTE: R_MARGIN</strong> behaves in a special way
  326. when you're using the
  327. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
  328. See
  329. <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a>
  330. for an explanation.
  331. <p>
  332. <!---T_MARGIN--->
  333. <hr width="66%" align="left">
  334. <a name="T_MARGIN"><h3><u>Top margin</u></h3></a>
  335. <br>
  336. <nobr>Macro: <strong>T_MARGIN</strong> &lt;top margin&gt;</nobr>
  337. <br>
  338. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  339. <p>
  340. <strong>T_MARGIN</strong> establishes the distance from the top of
  341. the printer sheet at which you want your type to start. It requires
  342. a unit of measure, and decimal fractions are allowed. To set a top
  343. margin of 2-1/2 centimetres, you'd enter
  344. <p>
  345. <pre>
  346. .T_MARGIN 2.5c
  347. </pre>
  348. <strong>T_MARGIN</strong> calculates the vertical position of the
  349. first line of type on a page by treating the top edge of the printer
  350. sheet as a <a href="definitions.html#TERMS_BASELINE">baseline</a>. Therefore,
  351. <p>
  352. <pre>
  353. .T_MARGIN 1.5i
  354. </pre>
  355. puts the baseline of the first line of type 1-1/2 inches beneath
  356. the top of the page.
  357. <p>
  358. <strong>IMPORTANT:</strong> <strong>T_MARGIN</strong> does two
  359. things: it establishes the top margin for pages that come after
  360. it AND it moves to that position on the current page. Therefore,
  361. <strong>T_MARGIN</strong> should only be used at the top of a file
  362. (prior to entering text) or after
  363. <a href="#NEWPAGE">NEWPAGE</a>,
  364. like this:
  365. <p>
  366. <pre>
  367. .NEWPAGE
  368. .T_MARGIN 6P
  369. &lt;text&gt;
  370. </pre>
  371. <strong>NOTE:</strong> <strong>T_MARGIN</strong> means something
  372. slightly different when you're using the
  373. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
  374. See
  375. <a href="typemacdoc.html#TB_MARGINS">Top and bottom margins in document processing</a>
  376. for an explanation.
  377. <p>
  378. <!---B_MARGIN--->
  379. <hr width="66%" align="left">
  380. <a name="B_MARGIN"><h3><u>Bottom margin</u></h3></a>
  381. <br>
  382. <nobr>Macro: <strong>B_MARGIN</strong> &lt;bottom margin&gt;</nobr>
  383. <br>
  384. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  385. <p>
  386. <strong>B_MARGIN</strong> sets a nominal position at the bottom
  387. of the page beyond which you don't want your type to go. When the
  388. bottom margin is reached, <strong>mom</strong> starts a new page.
  389. <strong>B_MARGIN</strong> requires a unit of measure. Decimal
  390. fractions are allowed. To set a nominal bottom margin of 3/4 inch,
  391. enter
  392. <p>
  393. <pre>
  394. .B_MARGIN .75i
  395. </pre>
  396. Obviously, if you haven't spaced the type on your pages so that
  397. the last lines fall perfectly at the bottom margin, the margin will
  398. vary from page to page. Usually, but not always, the last line of
  399. type that fits on a page <em>before</em> the bottom margin causes
  400. <strong>mom</strong> to start a new page.
  401. <p>
  402. Occasionally, owing to a peculiarity in <strong>groff</strong>,
  403. an extra line will fall below the nominal bottom margin. If you're
  404. using the
  405. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>,
  406. this is unlikely to happen; the document processing macros are very
  407. hard-nosed about aligning bottom margins.
  408. <p>
  409. <strong>NOTE:</strong> The meaning of <strong>B_MARGIN</strong> is
  410. slightly different when you're using the document processing macros.
  411. See
  412. <a href="typemacdoc.html#TB_MARGINS">Top and bottom margins in document processing</a>
  413. for an explanation.
  414. <p>
  415. <!---PAGE--->
  416. <hr width="66%" align="left">
  417. <a name="PAGE"><h3><u>Page</u></h3></a>
  418. <br>
  419. Macro: <strong>PAGE</strong>
  420. <nobr>&lt;width&gt;&nbsp;[ &lt;length&gt; [ &lt;lm&gt; [ &lt;rm&gt; [ &lt;tm&gt; [ &lt;bm&gt; ] ] ] ] ]</nobr>
  421. <br>
  422. <em>*All arguments require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  423. <p>
  424. <strong>PAGE</strong> lets you establish paper dimensions and page
  425. margins with a single macro. The only required argument is page width.
  426. The rest are optional, <strong>but they must appear in order and you can't
  427. skip over any.</strong> <nobr>&lt;lm&gt;, &lt;rm&gt;, &lt;tm&gt;</nobr>
  428. and <nobr>&lt;bm&gt; refer to the left, right, top and bottom</nobr>
  429. margins respectively.
  430. <p>
  431. Assuming your page dimensions are 11 inches by 17 inches, and that's
  432. all you want to set, enter
  433. <p>
  434. <pre>
  435. .PAGE 11i 17i
  436. </pre>
  437. If you want to set the left margin as well, say, at 1 inch,
  438. <strong>PAGE</strong> would look like this:
  439. <p>
  440. <pre>
  441. .PAGE 11i 17i 1i
  442. </pre>
  443. Now suppose you also want to set the top margin, say, at 1-1/2
  444. inches. <nobr>&lt;tm&gt; comes after <nobr>&lt;rm&gt;</nobr></nobr>
  445. in the optional arguments, but you can't skip over any arguments,
  446. therefore to set the top margin, you must also give a right margin.
  447. The <strong>PAGE</strong> macro would look like this:
  448. <p>
  449. <pre>
  450. .PAGE 11i 17i 1i 1i 1.5i
  451. | |
  452. required right___| |___top margin
  453. margin
  454. </pre>
  455. Clearly, <strong>PAGE</strong> is best used when you want a convenient
  456. way to tell <strong>mom</strong> just the dimensions of your printer
  457. sheet (width and length), or when you want to tell her everything
  458. about the page (dimensions and all the margins), for example
  459. <p>
  460. <pre>
  461. .PAGE 8.5i 11i 45p 45p 45p 45p
  462. </pre>
  463. This sets up an 8-1/2 by 11 inch page with margins of 45 points
  464. (5/8-inch) all around.
  465. <p>
  466. <strong>NOTE:</strong> Only use <strong>PAGE</strong> at the
  467. start of a document, before entering any text. And remember,
  468. when you're using the
  469. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>,
  470. top margin and bottom margin mean something slightly different than
  471. when you're using just the typesetting macros (see
  472. <a href="typemacdoc.html#TB_MARGINS">Top and bottom margins in document processing</a>).
  473. <p>
  474. Additionally, if you invoke <strong>PAGE</strong> with a top margin
  475. argument, any macros you invoke after <strong>PAGE</strong> will
  476. almost certainly move the
  477. <a href="definitions.html#TERMS_BASELINE">baseline</a>
  478. of the first line of text down by one linespace. To compensate, do
  479. <p>
  480. <pre>
  481. .RLD 1v
  482. </pre>
  483. immediately before entering any text, or, if it's feasible, make
  484. <strong>PAGE</strong> the last macro you invoke prior to entering text.
  485. <p>
  486. <!---NEWPAGE--->
  487. <hr width="66%" align="left">
  488. <a name="NEWPAGE"><h3><u>Start a new page</u></h3></a>
  489. <br>
  490. Macro: <strong>NEWPAGE</strong>
  491. <p>
  492. Whenever you want to start a new page, use <strong>NEWPAGE</strong>, by
  493. itself with no argument. <strong>Mom</strong> will finish up
  494. processing the current page and move you to the top of a new one
  495. (subject to the top margin set with
  496. <a href="#T_MARGIN">T_MARGIN</a>.
  497. <p>
  498. <strong>Experts:</strong> Prior to version 1.1.9,
  499. <strong>NEWPAGE</strong> was simply an alias of
  500. <strong>.bp</strong>. As of 1.1.9, <strong>NEWPAGE</strong>,
  501. is its own <strong>mom</strong> macro. While the new macro
  502. should be backwardly compatible with documents created using
  503. pre-1.1.9 <strong>mom</strong>s, I suggest that from this version
  504. onward, if you were in the habit of using <strong>.bp</strong>
  505. whenever you wanted to break to a new page, you now begin to use
  506. <strong>NEWPAGE</strong> instead.
  507. <p>
  508. <hr>
  509. <!====================================================================>
  510. <a name="INTRO_BASIC_PARAMS"></a>
  511. <a name="BASIC_PARAMS">
  512. <h2><u>Basic Typesetting Parameters</u></h2>
  513. </a>
  514. Basic parameter macros deal with the fundamental requirements
  515. for setting type: family, font, point size, leading and line length.
  516. <p>
  517. If you're using the typesetting macros only, the arguments passed
  518. to the basic parameter macros remain in effect until you change them.
  519. The document processing macros handle things differently. See
  520. <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a>
  521. for an explanation.
  522. <p>
  523. <a name="INDEX_BASIC"><h3><u>Basic parameter macros list</u></h3></a>
  524. <ul>
  525. <li><a href="#FAMILY">FAMILY</a> (type family)
  526. <li><a href="#FONT">FONT</a> (font)
  527. <li><a href="#FALLBACK_FONT">FALLBACK_FONT</a> (for invalid fonts)
  528. <li><a href="#PS">PT_SIZE</a> (point size of type)
  529. <li><a href="#LEADING">LS</a> (line spacing/leading)
  530. <li><a href="#AUTOLEAD">AUTOLEAD</a> (automatic line spacing)
  531. <li><a href="#LINELENGTH">LL</a> (line length)
  532. </ul>
  533. <!---FAMILY--->
  534. <hr width="66%" align="left">
  535. <a name="FAMILY"><h3><u>Type family</u></h3></a>
  536. <br>
  537. <nobr>Macro: <strong>FAMILY</strong> &lt;family&gt;</nobr>
  538. <br>
  539. Alias: <strong>FAM</strong>
  540. <p>
  541. <strong>FAMILY</strong> takes one argument: the name of the
  542. <a href="definitions.html#TERMS_FAMILY">family</a>
  543. you want. Groff comes with a number of PostScript families, each
  544. identified by a 1-, 2- or 3-letter mnemonic. The standard families
  545. are:
  546. <table valign="baseline" summary="family">
  547. <tr><td width="15"><td><strong>A</strong><td>Avant Garde
  548. <tr><td><td><strong>BM</strong> <td>Bookman
  549. <tr><td><td><strong>H</strong><td>Helvetica
  550. <tr><td><td><strong>HN</strong><td>Helvetica Narrow
  551. <tr><td><td><strong>N</strong><td>New Century Schoolbook
  552. <tr><td><td><strong>P</strong><td>Palatino
  553. <tr><td><td><strong>T</strong><td>Times Roman</td></tr>
  554. <tr><td><td><strong>ZCM</strong><td>Zapf Chancery</td></tr>
  555. </table>
  556. <p>
  557. The argument you pass to <strong>FAMILY</strong> is the identifier at
  558. left, above. For example, if you want Helvetica, enter
  559. <p>
  560. <pre>
  561. .FAMILY H
  562. </pre>
  563. <strong>NOTE:</strong> The
  564. <a href="#FONT">font macro</a>
  565. (<strong>FT</strong>) lets you specify both the type family
  566. and the desired font with a single macro. While this saves a few
  567. keystrokes, I recommend using <strong>FAMILY</strong> for family,
  568. and <strong>FT</strong> for font, except where doing so is genuinely
  569. inconvenient. <strong>ZCM</strong>, for example, only exists in one
  570. style: Italic (<strong>I</strong>). Therefore, <kbd>.FT ZCMI</kbd>
  571. makes more sense than setting the family to &quot;ZCM&quot;, then
  572. setting the font to &quot;I&quot;.
  573. <p>
  574. <a name="FAM_ADD_NOTE"></a>
  575. <strong>ADDITIONAL NOTE:</strong> As of <strong>mom, version
  576. 1.1.9-a</strong>, if you are running a version of groff lower
  577. than 1.19.2, you <em>MUST</em> follow all <strong>FAMILY</strong>
  578. requests with a <strong>FT</strong> request, otherwise
  579. <strong>mom</strong> will set all type up to the next
  580. <strong>FT</strong> request in the
  581. <a href="#FALLBACK_FONT">fallback font</a>.
  582. <p>
  583. If you are running a version of groff greater than or equal
  584. to 1.19.2, when you invoke the <strong>FAMILY</strong> macro,
  585. <strong>mom</strong> &quot;remembers&quot; the font style (Roman,
  586. Italic, etc) currently in use (if the font style exists in the new
  587. family) and will continue to use the same font style in the new
  588. family. For example:
  589. <p>
  590. <pre>
  591. .FAMILY BM \" Bookman family
  592. .FT I \" Medium Italic
  593. &lt;some text&gt; \" Bookman Medium Italic
  594. .FAMILY H \" Helvetica family
  595. &lt;more text&gt; \" Helvetica Medium Italic
  596. </pre>
  597. However, if the font style does not exist in the new family,
  598. <strong>mom</strong> will set all subsequent type in the
  599. <a href="#FALLBACK_FONT">fallback font</a>
  600. (by default, Courier Medium Roman) until she encounters a
  601. <a href="#FONT">.FT</a>
  602. request that's valid for the family. For example, assuming
  603. you don't have the font &quot;Medium Condensed Roman&quot;
  604. (<strong>mom</strong> extension &quot;<strong>CD</strong>&quot;)
  605. in the Helvetica family:
  606. <p>
  607. <pre>
  608. .FAMILY UN \" Univers family
  609. .FT CD \" Medium Condensed
  610. &lt;some text&gt; \" Univers Medium Condensed
  611. .FAMILY H \" Helvetica family
  612. &lt;more text&gt; \" Courier Medium Roman!
  613. </pre>
  614. In the above example, you must follow <kbd>.FAMILY H</kbd> with a
  615. <strong>FT</strong> request that's valid for Helvetica.
  616. <p>
  617. <strong>Experts:</strong>
  618. <br>
  619. If you add other PostScript families to groff's /font/devps directory,
  620. I recommend following the groff standard for naming families and fonts.
  621. For example, if you add the Garamond family, name the font files
  622. <p>
  623. <pre>
  624. GARAMONDR
  625. GARAMONDI
  626. GARAMONDB
  627. GARAMONDBI
  628. </pre>
  629. GARAMOND then becomes a legal family name you can pass to
  630. <strong>FAMILY</strong>. (You could, of course, shorten GARAMOND to just
  631. G, or GD.) R, I, B, and BI after GARAMOND are the roman, italic,
  632. bold and bold-italic fonts respectively.
  633. <p>
  634. Please see the Appendices,
  635. <a href="appendices.html#FONTS">Adding PostScript fonts to groff</a>,
  636. for information on adding fonts and families to groff, as well as
  637. to see a list of the extensions <strong>mom</strong> provides to
  638. groff's basic <strong>R, I, B, BI</strong> styles.
  639. <p>
  640. <!---FT--->
  641. <hr width="66%" align="left">
  642. <a name="FONT"><h3><u>Font</u></h3></a>
  643. <br>
  644. <nobr>Macro: <strong>FT</strong> R | I | B | BI | &lt;any other valid font style&gt;</nobr>
  645. <p>
  646. By default, groff permits <strong>FT</strong> to take one of four
  647. possible arguments specifying the desired font:
  648. <table valign="baseline" summary="font">
  649. <tr><td width="15"><td><strong>R</strong><td> = <td>(Medium) Roman
  650. <tr><td><td><strong>I</strong><td> = <td>(Medium) Italic
  651. <tr><td><td><strong>B</strong><td> = <td>Bold (Roman)
  652. <tr><td><td><strong>BI</strong><td> = <td>Bold Italic</td></tr>
  653. </table>
  654. <p>
  655. For example, if your
  656. <a href="definitions.html#TERMS_FAMILY">family</a>
  657. is Helvetica, entering
  658. <p>
  659. <pre>
  660. .FT B
  661. </pre>
  662. will give you the Helvetica bold
  663. <a href="definitions.html#TERMS_FONT">font</a>.
  664. If your family were Palatino, you'd get the Palatino bold font.
  665. <p>
  666. (As of <strong>mom, version 1.1.9-a,</strong> the range of arguments
  667. that can be passed to <strong>FT</strong> has been considerably
  668. extended, allowing access to a greater variety of font
  669. <a href="definitions.html#TERMS_WEIGHT">weights</a>
  670. and
  671. <a href="definitions.html#TERMS_SHAPE">shapes</a>.
  672. Please see the
  673. <a href="#FONT_NOTE">NOTE</a>,
  674. below.)
  675. <p>
  676. How <strong>mom</strong> reacts to an invalid argument to
  677. <strong>FT</strong> depends on which version of groff you're using.
  678. If your groff version is greater than or equal to 1.19.2,
  679. <strong>mom</strong> will issue a warning and, depending on how
  680. you've set up the
  681. <a href="#FALLBACK_FONT">fallback font</a>,
  682. either continue processing using the fallback font, or abort
  683. (allowing you to correct the problem). If your groff version is less
  684. than 1.19.2, <strong>mom</strong> will silently continue processing,
  685. using either the fallback font or the font that was in effect prior
  686. to the invalid <strong>FT</strong> call.
  687. <p>
  688. <strong>FT</strong> will also accept, as an argument, a full
  689. family+font name. For example,
  690. <p>
  691. <pre>
  692. .FT HB
  693. </pre>
  694. will set subsequent type in Helvetica Bold. However, I strongly
  695. recommend keeping family and font separate except where doing so is
  696. genuinely inconvenient.
  697. <p>
  698. For inline control of fonts, see
  699. <a href="inlines.html#INLINE_FONTS_MOM">Inline Escapes, font control</a>.
  700. <p>
  701. <a name="FONT_NOTE"></a>
  702. <strong>NOTE: mom, versions 1.1.9-a</strong> and higher,
  703. considerably extends the range of arguments you can pass to
  704. <strong>FT</strong>, making it more convenient to add and access
  705. fonts of differing
  706. <a href="definitions.html#TERMS_WEIGHT">weights</a>
  707. and
  708. <a href="definitions.html#TERMS_SHAPE">shapes</a>
  709. within the same family. Have a look
  710. <a href="appendices.html#STYLE_EXTENSIONS">here</a>
  711. for a list of the weight/style arguments <strong>mom</strong>
  712. allows.
  713. <p>
  714. Be aware, though, that you must have the fonts, correctly
  715. installed and named, in order to use the arguments. (See
  716. <a href="appendices.html#HOWTO">How to create a PostScript font for use with groff</a>
  717. for how to add fonts to groff.) Please also read the
  718. <a href="#FAM_ADD_NOTE">ADDITIONAL NOTE</a>
  719. found in the description of the <strong>FAMILY</strong> macro.
  720. <p>
  721. <!---FALLBACK_FONT--->
  722. <hr width="66%" align="left">
  723. <a name="FALLBACK_FONT"><h3><u>Fallback font</u></h3></a>
  724. <br>
  725. <nobr>Macro: <strong>FALLBACK_FONT</strong> &lt;fallback font&gt; [ ABORT | WARN ] | ABORT | WARN</nobr>
  726. <p>
  727. In the event that you pass an invalid argument to
  728. <a href="#FONT">.FAMILY</a>
  729. (i.e. a non-existent family), <strong>mom</strong>, by default, uses
  730. the fallback font, Courier Medium Roman (CR), in order to continue
  731. processing your file.
  732. <p>
  733. If you'd prefer another fallback font, pass
  734. <strong>FALLBACK_FONT</strong> the <strong>full family+font name
  735. of the font you'd like</strong>. For example, if you'd rather the
  736. fallback font were Times Roman Medium Roman,
  737. <pre>
  738. .FALLBACK_FONT TR
  739. </pre>
  740. <p>
  741. would do the trick.
  742. <p>
  743. Additionally, if your version of groff accepts accepts &quot;if
  744. F&quot; and &quot;if S&quot; (see
  745. <a href="#FAM_ADD_NOTE">above</a>),
  746. <strong>mom</strong> issues a warning whenever a
  747. <strong>font style</strong> set with
  748. <a href="#FONT">.FT</a>
  749. does not exist, either because you haven't registered the style
  750. (see
  751. <a href="appendices.html#REGISTER_STYLE">here</a>
  752. for instructions on registering styles), or because the font style
  753. does not exist in the current family set with
  754. <a href="#FAMILY">.FAMILY</a>.
  755. By default, <strong>mom</strong> then aborts, which allows you to
  756. correct the problem.
  757. <p>
  758. If you'd prefer that <strong>mom</strong> not abort on non-existent
  759. fonts, but rather continue processing using a fallback font,
  760. you can pass <strong>FALLBACK_FONT</strong> the argument
  761. <strong>WARN</strong>, either by itself, or in conjunction with your
  762. chosen fallback font.
  763. <p>
  764. <strong>Some examples of invoking FALLBACK_FONT:</strong>
  765. <br>
  766. <ul>
  767. <li><kbd>.FALLBACK_FONT WARN</kbd>
  768. <br>
  769. <strong>mom</strong> will issue a warning whenever you try
  770. to access a non-existent font but will continue processing
  771. your file with the default fallback font, Courier Medium Roman.
  772. <li><kbd>.FALLBACK_FONT TR WARN</kbd>
  773. <br>
  774. <strong>mom</strong> will issue a warning whenever you try
  775. to access a non-existent font but will continue processing
  776. your file with a fallback font of Times Roman Medium Roman;
  777. additionally, &quot;TR&quot; will be the fallback font whenever
  778. you try to access a <strong>family</strong> that does not exist.
  779. <li><kbd>.FALLBACK_FONT TR ABORT</kbd>
  780. <br>
  781. <strong>mom</strong> will abort whenever you try to access a
  782. non-existent font, and will use the fallback font
  783. &quot;TR&quot; whenever you try to access a <strong>family</strong>
  784. that does not exist.
  785. </ul>
  786. <p>
  787. If, for some reason, you want to revert to ABORT, just enter
  788. <kbd>.FALLBACK_FONT ABORT</kbd> and <strong>mom</strong> will once
  789. again abort on font errors.
  790. <p>
  791. <!---PT_SIZE--->
  792. <hr width="66%" align="left">
  793. <a name="PS"><h3><u>Point size of type</u></h3></a>
  794. <br>
  795. <nobr>Macro: <strong>PT_SIZE</strong> &lt;size of type in points&gt;</nobr>
  796. <br>
  797. <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  798. <p>
  799. <strong>PT_SIZE</strong> (Point Size) takes one argument: the size of type
  800. in points. Unlike most other macros that establish the size or measure
  801. of something, <strong>PT_SIZE</strong> does not require that you supply a
  802. unit of measure since it's a near universal convention that type size
  803. is measured in points. Therefore, to change the type size to, say,
  804. 11 points, enter
  805. <p>
  806. <pre>
  807. .PT_SIZE 11
  808. </pre>
  809. Point sizes may be fractional (e.g. 10.25 or 12.5).
  810. <p>
  811. You can prepend a plus or a minus sign to the argument to
  812. <strong>PT_SIZE</strong>, in which case the point size will be changed by +
  813. or - the original value. For example, if the point size is 12,
  814. and you want 14, you can do
  815. <p>
  816. <pre>
  817. .PT_SIZE +2
  818. </pre>
  819. then later reset it to 12 with
  820. <p>
  821. <pre>
  822. .PT_SIZE -2
  823. </pre>
  824. The size of type can also be changed inline. See
  825. <a href="inlines.html#INLINE_SIZE_MOM">Inline Escapes, changing point size</a>.
  826. <p>
  827. <strong>NOTE:</strong> It is unfortunate that the <kbd>pic</kbd>
  828. pre-processor uses <strong>PS</strong>, and thus
  829. <strong>mom</strong>'s macro for setting point sizes can't use it.
  830. However, if you aren't using <kbd>pic</kbd>, you might want to
  831. alias <strong>PT_SIZE</strong> as <strong>PS</strong>, since
  832. there'd be no conflict.
  833. <p>
  834. <pre>
  835. .ALIAS PS PT_SIZE
  836. </pre>
  837. would allow you to set point sizes with <kbd>.PS</kbd>.
  838. <p>
  839. <!---LS--->
  840. <hr width="66%" align="left">
  841. <a name="LEADING"><h3><u>Line spacing/leading</u></h3></a>
  842. <br>
  843. <nobr>Macro: <strong>LS</strong> &lt;distance between lines&gt;</nobr>
  844. <br>
  845. <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  846. <p>
  847. <strong>LS</strong> (Line Space) takes one argument: the distance you want, typically
  848. in points, from baseline to baseline of type. The argument may
  849. be fractional (e.g. 12.25 or 14.5). Like <strong>PT_SIZE</strong>,
  850. <strong>LS</strong> does not require a unit of measure, since
  851. <a href="definitions.html#TERMS_LEADING">leading</a>
  852. is most often given in points. Therefore, to set the linespace to
  853. 14 points, you would enter
  854. <p>
  855. <pre>
  856. .LS 14
  857. </pre>
  858. However, if you wish, you may specify a unit of measure by appending
  859. it directly to the argument passed to <strong>LS</strong>. For example,
  860. if you want a linespace of 1/4 of an inch, enter
  861. <p>
  862. <pre>
  863. .LS .25i
  864. </pre>
  865. You can prepend a plus or a minus sign to the argument to
  866. <strong>LS</strong>, in which case the line spacing will be changed
  867. by + or - the original value. For example, if the line spacing is
  868. 14 points, and you want 17 points, you can do
  869. <p>
  870. <pre>
  871. .LS +3
  872. </pre>
  873. then later reset it to 14 points with
  874. <p>
  875. <pre>
  876. .LS -3
  877. </pre>
  878. <strong>Experts:</strong>
  879. <br>
  880. <strong>LS</strong> should not be confused with the groff primitive
  881. <strong>ls</strong>. <strong>LS</strong> acts like <strong>vs</strong>.
  882. <strong>mom</strong> does not provide a macro analogous to
  883. <strong>ls</strong>.
  884. <p>
  885. <!---AUTOLEAD--->
  886. <hr width="66%" align="left">
  887. <a name="AUTOLEAD"><h3><u>Automatic line spacing</u></h3></a>
  888. <br>
  889. <nobr>Macro: <strong>AUTOLEAD</strong> &lt;amount of automatic leading&gt; [FACTOR]</nobr>
  890. <br>
  891. <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  892. <p>
  893. Without the <strong>FACTOR</strong> argument, <strong>AUTOLEAD</strong>
  894. calculates the linespace for you by adding its argument to the
  895. current point size of type. All subsequent <strong>PT_SIZE</strong>
  896. requests automatically update the linespacing by the autolead amount.
  897. <p>
  898. Used in this way, <strong>AUTOLEAD</strong> does not require a unit
  899. of measure; points is assumed. However, you may use an alternate
  900. unit of measure by appending it to the argument. The argument may
  901. be a decimal fraction (e.g. .5 or 2.75).
  902. <p>
  903. As an example, if your current point size of type is 12, entering
  904. <p>
  905. <pre>
  906. .AUTOLEAD 2
  907. </pre>
  908. changes the linespace to 14 points, regardless any linespacing
  909. already in effect. From here on, every change to the size of type
  910. (with <strong>PT_SIZE</strong>, not
  911. <a href="definitions.html#TERMS_INLINES">inline</a>)
  912. changes the linespace as well. If you decrease the type size to 9
  913. points, the leading decreases to 11 points. If you increase the type
  914. size to 16 points, the leading increases to 18 points.
  915. <p>
  916. Automatic updating of the linespacing continues until you enter a
  917. &quot;manual&quot; line space value with <strong>LS</strong>.
  918. <p>
  919. If you give <strong>AUTOLEAD</strong> the optional
  920. <strong>FACTOR</strong> argument, <strong>AUTOLEAD</strong>
  921. calculates the line space as a factor of the
  922. <a href="definitions.html#TERMS_NUMERICARGUMENT">numeric argument</a>
  923. you gave <strong>AUTOLEAD</strong>. For example, if your point
  924. size is 12,
  925. <p>
  926. <pre>
  927. .AUTOLEAD 1.125 FACTOR
  928. </pre>
  929. sets the leading at 13.5 points. If you change the point size
  930. to 14, the leading automatically changes to 15.75 (14 x 1.125).
  931. <p>
  932. <strong>NOTE:</strong> There's no need to prepend a plus sign (+)
  933. to <strong>AUTOLEAD</strong>'s argument, although you may do so if you
  934. wish.
  935. <p>
  936. <!---LL--->
  937. <hr width="66%" align="left">
  938. <a name="LINELENGTH"><h3><u>Line length</u></h3></a>
  939. <br>
  940. <nobr>Macro: <strong>LL</strong> &lt;line length&gt;</nobr>
  941. <br>
  942. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  943. <p>
  944. <strong>LL</strong> (Line Length) takes one argument: the distance from the
  945. left margin of the page to the maximum allowable point on the
  946. right at which groff should place type. The line length, in
  947. other words, as the macro suggests.
  948. <p>
  949. <strong>LL</strong> requires a unit of measure. Therefore, to set the line
  950. length to 39 picas, you would enter
  951. <p>
  952. <pre>
  953. .LL 39P
  954. </pre>
  955. As with other macros that require a unit of measure, the argument to
  956. <strong>LL</strong> may be fractional. For example,
  957. <p>
  958. <pre>
  959. .LL 4.5i
  960. </pre>
  961. sets the line length to 4-1/2 inches.
  962. <p>
  963. Additionally, you may express a new line length relative to the
  964. current line length by prepending a plus or minus sign to the
  965. argument. Thus, if you wanted to increase the line length by 3
  966. <a href="definitions.html#TERMS_PICASPOINTS">points</a>, you could
  967. do
  968. <p>
  969. <pre>
  970. .LL +3p
  971. </pre>
  972. This is especially handy when you want to &quot;hang&quot;
  973. punctuation outside the right margin since you can pass groff's
  974. <a href="inlines.html#INLINE_STRINGWIDTH_GROFF"><strong>\w</strong></a>
  975. escape as the argument to <strong>LL</strong>, like this:
  976. <p>
  977. <pre>
  978. .LL +\w'.'u
  979. </pre>
  980. The above example increases the current line length by the width of
  981. a period. Notice that you must append the
  982. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
  983. <strong>u</strong>, to the escape since .LL requires a unit of
  984. measure.
  985. <p>
  986. <strong>NOTE:</strong> The <a href="#R_MARGIN">right margin
  987. macro</a> (<strong>R_MARGIN</strong>) can also be used to set line
  988. length.
  989. <p>
  990. <hr>
  991. <!====================================================================>
  992. <a name="INTRO_JUST_QUAD_FILL"></a>
  993. <a name="JUST_QUAD_FILL">
  994. <h2><u>Justifying, quadding, filling and breaking lines</u></h2>
  995. </a>
  996. The justification and quadding macros deal with how type aligns along
  997. the left and right margins. In a nutshell, type either aligns at the
  998. left margin, at the right margin, at both margins, or at neither margin
  999. (centred).
  1000. <p>
  1001. These macros also determine whether or not
  1002. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>
  1003. are joined and
  1004. <a href="definitions.html#TERMS_FILLED">filled</a>
  1005. during output.
  1006. <p>
  1007. Additionally, macros that deal with how to break
  1008. <a href="definitions.html#TERMS_OUTPUTLINE">output lines</a>
  1009. are covered in this section, as is the
  1010. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  1011. for joining input lines.
  1012. <p>
  1013. You may encounter some words here that are unfamiliar. Refer to
  1014. <a href="definitions.html#TERMS_TYPESETTING">Typesetting terms</a>
  1015. and
  1016. <a href="definitions.html#TERMS_GROFF">Groff terms</a>
  1017. for an explanation.
  1018. <a name="INDEX_JUST"><h3><u>Justification, quad, fill, and break macro list</u></h3></a>
  1019. <p>
  1020. <ul>
  1021. <li><strong>Fill modes</strong>
  1022. <ul>
  1023. <li><a href="#JUSTIFY">JUSTIFY</a> (set lines justified)
  1024. <li><a href="#QUAD">QUAD</a> (set filled lines flush left, right or centred)
  1025. </ul>
  1026. <li><strong>Nofill modes</strong>
  1027. <ul>
  1028. <li><a href="#LRC">LEFT</a> (set non-filled lines flush left)
  1029. <li><a href="#LRC">RIGHT</a> (set non-filled lines flush right)
  1030. <li><a href="#LRC">CENTER</a> (set non-filled lines centred)
  1031. </ul>
  1032. <li><strong>Breaking lines</strong>
  1033. <ul>
  1034. <li><a href="#BR">BR</a> (manually break an output line)
  1035. <li><a href="#EL">EL</a> (break a line without advancing to the next output line)
  1036. <li><a href="#SPACE">SPACE</a> (break a line and add space before the next output line)
  1037. <li><a href="#SPREAD">SPREAD</a> (break and force-justify an output line)
  1038. </ul>
  1039. <li><strong>Joining input lines in
  1040. <a href="definitions.html#TERMS_NOFILL">nofill mode</a></strong>
  1041. <ul>
  1042. <li><a href="#JOIN">\c</a> inline escape
  1043. </ul>
  1044. </ul>
  1045. <!---JUSTIFY--->
  1046. <hr width="66%" align="left">
  1047. <a name="JUSTIFY"><h3><u>Justify lines</u></h3></a>
  1048. <br>
  1049. Macro: <strong>JUSTIFY</strong>
  1050. <br>
  1051. <a href="definitions.html#TERMS_FILLED"><em>Fill mode</em></a>
  1052. <p>
  1053. <strong>JUSTIFY</strong> doesn't take an argument.
  1054. <a href="definitions.html#TERMS_INPUTLINE">Input lines</a>
  1055. after <strong>JUSTIFY</strong> are
  1056. <a href="definitions.html#TERMS_FILLED">filled</a> and
  1057. <a href="definitions.html#TERMS_JUST">justified</a>
  1058. upon output.
  1059. <p>
  1060. To break lines and prevent them from being filled and justified,
  1061. use the
  1062. <a href="#BR">BR</a> macro.
  1063. <p>
  1064. <!---QUAD--->
  1065. <hr width="66%" align="left">
  1066. <a name="QUAD"><h3><u>Quad lines left, right, or centre</u></h3></a>
  1067. <br>
  1068. <nobr>Macro: <strong>QUAD</strong> L | LEFT | R | RIGHT | C | CENTER | J | JUSTIFY</nobr>
  1069. <br>
  1070. Alias: <strong>FILL</strong>
  1071. <br>
  1072. <a href="definitions.html#TERMS_FILLED"><em>Fill mode</em></a>
  1073. <p>
  1074. <strong>QUAD</strong> takes one argument: the direction in which lines
  1075. should be
  1076. <a href="definitions.html#TERMS_QUAD">quadded</a>.
  1077. <a href="definitions.html#TERMS_INPUTLINE">Input lines</a>
  1078. after <strong>QUAD</strong> are
  1079. <a href="definitions.html#TERMS_FILLED">filled</a>
  1080. upon output.
  1081. <p>
  1082. If <strong>L</strong> or <strong>LEFT</strong>, type is set flush
  1083. along the left margin.
  1084. <p>
  1085. If <strong>R</strong> or <strong>RIGHT</strong>, type is
  1086. set flush along the right margin.
  1087. <p>
  1088. If <strong>C</strong> or <strong>CENTER</strong> type is set centred
  1089. on the current line length.
  1090. <p>
  1091. <strong>J</strong> and <strong>JUSTIFY</strong> justify text,
  1092. and are included as a convenience only. Obviously, if text is
  1093. justified, it isn't quadded. <strong>QUAD J</strong> and
  1094. <strong>QUAD JUSTIFY</strong> have exactly the same effect as <a
  1095. href="#JUSTIFY">JUSTIFY</a>.
  1096. <p>
  1097. To break lines and prevent them from being filled, use the
  1098. <a href="#BR">BR</a> macro.
  1099. <p>
  1100. <!---LEFT, RIGHT, CENTER--->
  1101. <hr width="66%" align="left">
  1102. <a name="LRC"><h3><u>Set non-filled lines flush left, right, or centred</u></h3></a>
  1103. <br>
  1104. Macro: <strong>LEFT</strong>
  1105. &nbsp;&nbsp;Macro: <strong>RIGHT</strong>
  1106. &nbsp;&nbsp;Macro: <strong>CENTER</strong>
  1107. &nbsp;(alias <strong>CENTRE</strong>)
  1108. <br>
  1109. <a href="definitions.html#TERMS_NOFILL"><em>Nofill mode</em></a>
  1110. <p>
  1111. <strong>LEFT</strong>, <strong>RIGHT</strong> and
  1112. <strong>CENTER</strong> let you enter text on a line for line basis
  1113. without having to use the
  1114. <a href="#BR">BR</a> macro after each line.
  1115. Consider the following:
  1116. <p>
  1117. <pre>
  1118. .QUAD LEFT
  1119. So runs my dream, but what am I?
  1120. .BR
  1121. An infant crying in the night
  1122. .BR
  1123. An infant crying for the light
  1124. .BR
  1125. And with no language but a cry.
  1126. .BR
  1127. </pre>
  1128. Because text after <strong>QUAD</strong> is
  1129. <a href="definitions.html#TERMS_FILLED">filled</a>, you have to use the
  1130. <a href="#BR">BR</a>
  1131. macro to prevent the lines from running together. Not only is this
  1132. annoying to type, it's awkward to read in a text editor. Much better
  1133. to do
  1134. <p>
  1135. <pre>
  1136. .LEFT
  1137. So runs my dream, but what am I?
  1138. An infant crying in the night
  1139. An infant crying for the light
  1140. And with no language but a cry.
  1141. </pre>
  1142. <strong>IMPORTANT:</strong> Because <strong>LEFT</strong>,
  1143. <strong>RIGHT</strong> and <strong>CENTER</strong> are nofill
  1144. modes, groff does not always respect the current line length.
  1145. <a href="definitions.html#TERMS_INPUTLINE">Input lines</a>
  1146. that run long may exceed it, or get broken in undesirable ways.
  1147. Therefore, when using these three macros, you should preview your
  1148. work to ensure that all lines fit as expected.
  1149. <p>
  1150. <!---BR--->
  1151. <hr width="66%" align="left">
  1152. <a name="BR"><h3><u>Manually break lines</u></h3></a>
  1153. <br>
  1154. Macro: <strong>BR</strong>
  1155. <p>
  1156. When using <strong>JUSTIFY</strong> or <strong>QUAD</strong>,
  1157. <strong>BR</strong> tells <strong>mom</strong> about partial lines
  1158. that you want broken (as opposed to
  1159. <a href="definitions.html#TERMS_FILLED">filled</a>).
  1160. Any partial
  1161. <a href="definitions.html#TERMS_OUTPUTLINE">output line</a>
  1162. that immediately precedes <strong>BR</strong> will be
  1163. <a href="definitions.html#TERMS_QUAD">quadded</a>
  1164. in the direction of the current quad, or set flush left if text is
  1165. <a href="definitions.html#TERMS_JUST">justified</a>.
  1166. <p>
  1167. Most of the time, you won't need the <strong>BR</strong> macro.
  1168. In fill modes, <strong>mom</strong> tries to be sensible about
  1169. where breaks are needed. If the nature of a macro is such that under
  1170. most circumstances you'd expect a break, <strong>mom</strong> puts
  1171. it in herself. Equally, in macros where a break isn't normally
  1172. desirable, no break occurs. This means text files don't get cluttered
  1173. with annoying <strong>BR</strong>'s.
  1174. <p>
  1175. <strong>NOTE:</strong> Lines of text in
  1176. <a href="definitions.html#TERMS_NOFILL">nofill mode</a>
  1177. never require a <strong>BR</strong>. Furthermore, in nofill mode,
  1178. ALL macros cause a break. If a break is not desired, use the
  1179. <a href="#JOIN">\c</a>
  1180. <a href="definitions.html#TERMS_INLINES">inline escape</a>.
  1181. <p>
  1182. <strong>Experts: BR</strong> is an alias for <strong>br</strong>.
  1183. You can use either, or mix 'n' match with impunity.
  1184. <p>
  1185. <!---EL--->
  1186. <hr width="66%" align="left">
  1187. <a name="EL"><h3><u>Manually break a line without advancing on the page</u></h3></a>
  1188. <br>
  1189. Macro: <strong>EL</strong>
  1190. <br>
  1191. <em>*In nofill modes (LEFT, RIGHT, CENTER), you must terminate the
  1192. line input preceding EL with the </em><kbd>\c</kbd><em> inline
  1193. escape. See
  1194. <a href="#EL_NOTES">NOTES</a>,
  1195. below.
  1196. <br>
  1197. *If you find remembering whether to put in the <kbd>\c</kbd>
  1198. bothersome, you may prefer to use the
  1199. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  1200. alternative to
  1201. <kbd>.EL</kbd>,
  1202. <a href="inlines.html#B">\*[B]</a>,
  1203. which works consistently regardless of the fill mode.
  1204. <br>
  1205. *EL does not work after the PAD macro.
  1206. See
  1207. <a href="goodies.html#PAD">PAD</a>
  1208. for the way around this</em>.
  1209. <p>
  1210. The mnemonic "EL" is borrowed from old Compugraphic typesetting
  1211. systems, where it stood for "End Line." Conceptually,
  1212. <strong>EL</strong> is equivalent to the notion of a carriage return
  1213. with no linefeed.
  1214. <p>
  1215. <em>Note to groff jocks:</em> <strong>EL</strong> is
  1216. unrelated to groff's <strong>.el</strong>. If you find the
  1217. similarity confusing, you may want to alias <strong>EL</strong> as
  1218. something else (but don't use <strong>EOL</strong>; it's already
  1219. taken.)
  1220. <p>
  1221. <strong>EL</strong>'s function is simple: it breaks a line without
  1222. advancing on the page.
  1223. <a name="EL_EXAMPLE">As</a>
  1224. an example of where you might use it,
  1225. imagine that you're working from marked-up copy. The markup
  1226. indicates 24 points of space between two given lines, but the
  1227. prevailing line spacing is 12.5 points. You may find it more
  1228. convenient to break the first line with <strong>EL</strong> and
  1229. instruct <strong>mom</strong> to advance 24 points to the next line
  1230. instead of calculating the lead that needs to be added to 12.5 to
  1231. get 24. To demonstrate:
  1232. <p>
  1233. <pre>
  1234. .LEFT
  1235. .LS 12.5
  1236. A line of text.\c
  1237. .EL
  1238. .ALD 24p
  1239. The next line of text.
  1240. </pre>
  1241. may be more intuitive than
  1242. <p>
  1243. <pre>
  1244. .LEFT
  1245. .LS 12.5
  1246. A line of text.
  1247. .ALD 11.5p
  1248. The next line of text.
  1249. </pre>
  1250. The first example has the further advantage that should you wish
  1251. to change the prevailing line space but keep the 24 points lead,
  1252. you don't have to recalculate the extra space.
  1253. <p>
  1254. "ALD" in the above examples stands for "<strong>A</strong>dvance
  1255. <strong>L</strong>ea<strong>D</strong>" (another mnemonic borrowed
  1256. from Compugraphic), which is covered in the section
  1257. <a href="#ALDRLD">Vertical movement</a>.
  1258. <p>
  1259. <a name="EL_NOTES"><strong>NOTES:</strong></a>
  1260. <p>
  1261. In versions of mom prior to 1.1.9, <strong>EL</strong> did not
  1262. always work as advertised on the last
  1263. <a name="TERMS_OUTPUTLINE">output line</a>
  1264. of pages that contained a footer trap (e.g. one set with
  1265. <a href="#B_MARGIN">B_MARGIN</a>
  1266. or in documents formatted using the
  1267. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>).
  1268. <p>
  1269. <strong>EL</strong> has been re-written so that this should no longer be the
  1270. case. However, in order for it to work in the
  1271. <a href="definitions.html#TERMS_NOFILL">nofill</a>
  1272. modes
  1273. (<a href="#LRC">LEFT</a>,
  1274. <a href="#LRC">RIGHT</a>
  1275. or
  1276. <a href="#LRC">CENTER</a>),
  1277. you must always &quot;join&quot; <strong>.EL</strong> to the line
  1278. before it using the
  1279. <a href="#JOIN">\c</a>
  1280. <a href="definitions.html#TERMS_INLINES">inline escape</a>,
  1281. like this:
  1282. <p>
  1283. <pre>
  1284. .LEFT
  1285. A line I don't want to advance\c
  1286. .EL
  1287. </pre>
  1288. Conversely, in
  1289. <a href="definitions.html#TERMS_FILLED">fill modes</a>
  1290. (<a href="#QUAD">QUAD LEFT</a>,
  1291. <a href="#QUAD">QUAD RIGHT</a>,
  1292. <a href="#QUAD">QUAD CENTER</a>
  1293. or
  1294. <a href="#JUSTIFY">JUSTIFY</a>),
  1295. the <strong>\c</strong> must not be used.
  1296. <p>
  1297. If <strong>EL</strong> is used after most macros or groff
  1298. <a href="definitions.html#TERMS_PRIMITIVES">primitives</a>
  1299. (see the exception, below), you don't have to worry about this,
  1300. regardless of the fill mode. Just type <kbd>.EL</kbd>
  1301. <br>
  1302. <!---SP--->
  1303. <hr width="66%" align="left">
  1304. <a name="SPACE"><h3><u>Break lines and add space between</u></h3></a>
  1305. <br>
  1306. <nobr>Macro: <strong>SPACE</strong> &lt;space to add between lines&gt;</nobr>
  1307. <br>
  1308. Alias: <strong>SP</strong>
  1309. <p>
  1310. <strong>SPACE</strong> breaks a line, just like
  1311. <strong>BR</strong>, then adds space after the line. With no
  1312. argument, it adds an extra line space of a value equal to the
  1313. current
  1314. <a href="definitions.html#TERMS_LEADING">leading</a>.
  1315. If you pass it a numeric argument without supplying a
  1316. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
  1317. it advances that number of extra line spaces. For example:
  1318. <p>
  1319. <pre>
  1320. .SPACE
  1321. </pre>
  1322. breaks the line then adds an extra linespace, whereas
  1323. <p>
  1324. <pre>
  1325. .SPACE 2
  1326. </pre>
  1327. breaks the line and adds two extra linespaces.
  1328. <p>
  1329. If you supply a unit of measure, <strong>SPACE</strong> breaks the
  1330. line then advances one linespace (at the current
  1331. <a href="definitions.html#TERMS_LEADING">leading</a>)
  1332. PLUS the specified amount of extra space given to
  1333. <strong>SPACE</strong>,
  1334. as in
  1335. <p>
  1336. <pre>
  1337. .SPACE 6p
  1338. </pre>
  1339. which breaks the line and advances one full linespace plus six
  1340. points.
  1341. <p>
  1342. <strong>SUGGESTION: SPACE</strong> and
  1343. <a href="#ALD">ALD</a>
  1344. can be used interchangeably (<code>.SPACE&nbsp;6p</code> and
  1345. <code>.ALD&nbsp;6p</code> are equivalent). However,
  1346. <strong>ALD</strong> without an argument does nothing, whereas
  1347. <strong>SPACE</strong> without an argument adds an extra line
  1348. space. I recommend using <strong>SPACE</strong> when you
  1349. want an extra line space (or multiple thereof), and
  1350. <strong>ALD</strong> whenever you want some other value of space
  1351. after a line.
  1352. <p>
  1353. <strong>Experts: SPACE</strong> is an alias of <strong>sp</strong>.
  1354. You can use either, or mix 'n' match with impunity.
  1355. <p>
  1356. <!---SPREAD--->
  1357. <hr width="66%" align="left">
  1358. <a name="SPREAD"><h3><u>Break and force justify (spread) lines</u></h3></a>
  1359. <br>
  1360. Macro: <strong>SPREAD</strong>
  1361. <p>
  1362. Sometimes, you need to break a line of
  1363. <a href="definitions.html#TERMS_JUST">justified</a>
  1364. text and have it come out fully justified, not
  1365. <a href="definitions.html#TERMS_QUAD">quadded</a>
  1366. left the way it would be with the <strong>BR</strong> macro.
  1367. An example of where you'd do this would be when you want to prevent a
  1368. word at the end of a line from being hyphenated (say, a proper name).
  1369. <strong>SPREAD</strong> is the macro that lets you break the line
  1370. and have it came out fully justified.
  1371. <p>
  1372. <strong>Experts: SPREAD</strong> is an alias for <strong>brp</strong>.
  1373. You can use either, or mix 'n' match with impunity.
  1374. <p>
  1375. <!---JOIN--->
  1376. <hr width="66%" align="left">
  1377. <a name="JOIN"><h3><u>Join input lines</u></h3></a>
  1378. <br>
  1379. Inline: <strong>\c</strong>
  1380. <p>
  1381. Sometimes, especially when in one of the
  1382. <a href="definitions.html#TERMS_NOFILL">nofill modes</a>,
  1383. a macro will cause a break where you don't want one. In order
  1384. to prevent this from happening (in other words, to join
  1385. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>
  1386. together, forming one
  1387. <a href="definitions.html#TERMS_OUTPUTLINE">output line</a>),
  1388. use the groff
  1389. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  1390. <strong>\c</strong> at the end of each input line to
  1391. be joined to another, like this:
  1392. <p>
  1393. <pre>
  1394. .LEFT
  1395. .FAMILY T
  1396. .FT R
  1397. Some lines of text to be \c
  1398. .FAMILY H
  1399. .FT B
  1400. joined \c
  1401. .FAMILY T
  1402. .FT R
  1403. together.
  1404. </pre>
  1405. Upon output, the lines will be joined together to read
  1406. <p>
  1407. <pre>
  1408. Some lines of text to be joined together.
  1409. </pre>
  1410. with the word &quot;joined&quot; in Helvetica bold. Note the
  1411. space before <strong>\c</strong>. Without it, the last three
  1412. words of the output line would read
  1413. <p>
  1414. <pre>
  1415. bejoinedtogether
  1416. </pre>
  1417. Please also note that had the example been in one of the
  1418. <a href="definitions.html#TERMS_FILLED">fill modes</a>,
  1419. there'd have been no need for the <strong>\c</strong>.
  1420. <p>
  1421. <strong>Addendum:</strong> The example, above, is designed to
  1422. demonstrate the use of <strong>\c</strong>. However, an easier and
  1423. more intuitive way to accomplish the family/font change in the
  1424. example would be with the groff
  1425. <a href="definitions.html#TERMS_INLINES">inline escape</a>,
  1426. <a href="inlines.html#INLINE_FONTS_GROFF">\f</a>.
  1427. <p>
  1428. <pre>
  1429. Some lines of text to be \f[HB]joined\*[PREV] together.
  1430. </pre>
  1431. <p>
  1432. <hr>
  1433. <!====================================================================>
  1434. <a name="INTRO_REFINEMENTS"></a>
  1435. <a name="REFINEMENTS">
  1436. <h2><u>Typographic refinements</u></h2>
  1437. </a>
  1438. The macros in this section help you tweak groff's behaviour,
  1439. ensuring that your documents look typographically professional.
  1440. <br>
  1441. <a name="INDEX_REFINEMENTS">
  1442. <h3><u>Typographic refinements macro list</u></h3>
  1443. </a>
  1444. <ul>
  1445. <li><strong>Word and sentence spacing</strong>
  1446. <ul>
  1447. <li><a href="#WS">WS</a> (word spacing)
  1448. <li><a href="#SS">SS</a> (sentence space)
  1449. </ul>
  1450. <li><strong>Letter spacing (track kerning)</strong>
  1451. <ul>
  1452. <li><a href="#RW">RW</a> (reduce whitespace)
  1453. <li><a href="#EW">EW</a> (expand whitespace)
  1454. <li><a href="#BR_AT_LINE_KERN">BR_AT_LINE_KERN</a>
  1455. </ul>
  1456. <li><strong>Hyphenation</strong>
  1457. <ul>
  1458. <li><a href="#HY">HY</a> (turn auto hyphenation on/off, or set specific hyphenation parameters)
  1459. <li><a href="#HY_SET">HY_SET</a> (set all hyphenation parameters)
  1460. </ul>
  1461. <li><strong>Automatic kerning and ligatures</strong>
  1462. <ul>
  1463. <li><a href="#KERN">KERN</a> (turn automatic pairwise kerning on or off)
  1464. <li><a href="#LIGATURES">LIGATURES</a> (turn automatic generation of ligatures on or off)
  1465. </ul>
  1466. </ul>
  1467. <!---WS--->
  1468. <hr width="66%" align="left">
  1469. <a name="WS"><h3><u>Word spacing</u></h3></a>
  1470. <br>
  1471. <nobr>Macro: <strong>WS</strong> &lt;+|-wordspace&gt; | DEFAULT</nobr>
  1472. <p>
  1473. <strong>WS</strong> (Word Space) increases or decreases the amount
  1474. of space between words. In
  1475. <a href="definitions.html#TERMS_NOFILL">nofill modes</a>,
  1476. or if
  1477. <a href="#QUAD">QUAD</a>
  1478. is in effect, the space between words is fixed. Therefore, if you
  1479. change the word spacing with <strong>WS</strong>, the change applies
  1480. uniformly to the space between every word on every line. However,
  1481. when text is
  1482. <a href="definitions.html#TERMS_JUST">justified</a>,
  1483. the space between words varies from line to line (in order to justify
  1484. the text). Consequently, the change you make with <strong>WS</strong>
  1485. represents the minimum (and ideal) space groff will try to put between
  1486. words before deciding whether to hyphenate a final word or to stretch
  1487. the word spacing.
  1488. <p>
  1489. Word space is relative to type size. Knowing how it's calculated is
  1490. unimportant. What matters is having a sense of how the value passed
  1491. to <strong>WS</strong> affects the look of your type. Generally,
  1492. in/decreasing the word space by a value of 1 or 2 produces a difference
  1493. that in many cases is scarcely visible; in/decreasing by a value of 5
  1494. or so produces a subtle but noticeable difference; and in/decreasing
  1495. by a value greater than 10 is always apparent. You should preview
  1496. your work to assess the effect of <strong>WS</strong>.
  1497. <p>
  1498. <a name="WS_USAGE"><strong>WS</strong></a>
  1499. takes as its argument a whole number preceded by a plus or minus sign.
  1500. Therefore, to decrease the word space slightly, you might enter
  1501. <p>
  1502. <pre>
  1503. .WS -4
  1504. </pre>
  1505. To increase it by a noticeable amount, you might enter
  1506. <p>
  1507. <pre>
  1508. .WS +12
  1509. </pre>
  1510. You can reset the word spacing to its previous value by switching
  1511. the plus or minus sign, like this:
  1512. <p>
  1513. <pre>
  1514. .WS +4
  1515. A line of text
  1516. .WS -4
  1517. </pre>
  1518. The <code>.WS -4</code> undoes the effect of <code>.WS
  1519. +4</code>. You can also reset <strong>WS</strong> to
  1520. its groff default by entering
  1521. <p>
  1522. <pre>
  1523. .WS DEFAULT
  1524. </pre>
  1525. This can be particularly useful if you've been playing around
  1526. with plus and minus values, and can't remember by how much you
  1527. have to in/decrease the word space to get it back to normal.
  1528. <p>
  1529. <!---SS--->
  1530. <hr width="66%" align="left">
  1531. <a name="SS"><h3><u>Sentence space</u></h3></a>
  1532. <br>
  1533. <nobr>Macro: <strong>SS</strong> &lt;+sentence space&gt; | 0 | DEFAULT</nobr>
  1534. <p>
  1535. <strong>SS</strong> (Sentence Space) tells groff how to treat double
  1536. spaces it encounters between sentences in
  1537. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>.
  1538. If you use <strong>SS</strong>, input sentences with two spaces
  1539. after them AND input sentences that fall at the end of input lines
  1540. all receive a normal word space plus an additional amount of space
  1541. whose size is determined by the + value passed as an argument to
  1542. <strong>SS</strong>. Thus,
  1543. <p>
  1544. <pre>
  1545. .SS +2
  1546. </pre>
  1547. means that input sentences with two spaces after them receive a normal
  1548. word space PLUS the +2 value passed to <strong>SS</strong>.
  1549. <p>
  1550. Like
  1551. <strong>WS</strong>, increasing the sentence space by a value of
  1552. 1 or 2 produces a difference that in many cases is scarcely visible;
  1553. increasing by a value of 5 or so produces a subtle but noticeable
  1554. difference (i.e. the space between double-spaced input sentences will
  1555. be slightly but visibly greater than the space between words); and
  1556. increasing by a value greater than 10 is always apparent. You should
  1557. preview your work to assess the effect of <strong>SS</strong>.
  1558. <p>
  1559. There's an additional argument you can pass <strong>SS</strong>:
  1560. the number zero (without the + sign). It's the argument you'll
  1561. use most often. Typeset copy should never have two spaces between
  1562. sentences, and the "zero" argument tells groff to give the extra
  1563. spaces no space at all (effectively removing them). Therefore,
  1564. if you double-space your sentences (as you should when writing in a
  1565. text editor), get in the habit of putting
  1566. <p>
  1567. <pre>
  1568. .SS 0
  1569. </pre>
  1570. at the top of your files.
  1571. <p>
  1572. If you do use <strong>SS</strong> for something other than ensuring
  1573. that you don't get unwanted sentence spaces in output copy, you
  1574. can set or reset the sentence space to the groff default (the same
  1575. width as a word space, i.e. double-spaced input sentences will appear
  1576. double-spaced on output as well) with
  1577. <p>
  1578. <pre>
  1579. .SS DEFAULT
  1580. </pre>
  1581. If you're using the
  1582. <a href="docprocessing.html">document processing macros</a>
  1583. and your
  1584. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a>
  1585. is <strong>TYPEWRITE</strong>, <code>.SS DEFAULT</code> is the default,
  1586. because you <em>do</em> want double spaces between sentences in copy
  1587. that imitates the look of a typewritten document.
  1588. <p>
  1589. <strong>IMPORTANT: SS</strong> with an argument other than
  1590. &quot;0&quot; should only be used if you're of the old (and wise)
  1591. school of typists that puts two spaces between sentences. If you
  1592. ignore this advice and use <strong>SS</strong> when you habitually
  1593. put only one space between sentences, you risk producing output where
  1594. the space between sentences is not equal.
  1595. <p>
  1596. <!---HY--->
  1597. <hr width="66%" align="left">
  1598. <a name="HY"><h3><u>Automatic hyphenation control</u></h3></a>
  1599. <br>
  1600. <nobr>Macro: <strong>HY</strong> toggle</nobr>
  1601. <br>
  1602. <nobr>Macro: <strong>HY</strong> LINES &lt;max. number of consecutive hyphenated lines&gt;</nobr>
  1603. <br>
  1604. <nobr>Macro: <strong>HY</strong> MARGIN &lt;size of hyphenation margin&gt;</nobr>
  1605. <br>
  1606. <nobr>Macro: <strong>HY</strong> SPACE &lt;extra interword spacing to prevent hyphenation&gt;</nobr>
  1607. <br>
  1608. <nobr>Macro: <strong>HY</strong> DEFAULT</nobr>
  1609. <br>
  1610. Aliases: <strong>HYPHENATE, HYPHENATION</strong>
  1611. <p>
  1612. <strong>HY</strong>, as you can see, can be invoked with a number of
  1613. arguments. In all cases, the aliases <strong>HYPHENATE</strong>
  1614. or <strong>HYPHENATION</strong> can be used in place of
  1615. <strong>HY</strong>. To aid in understanding the various arguments
  1616. you can pass to <strong>HY</strong>, I've broken them down into
  1617. separate sections.
  1618. <h3><u>1. HY</u></h3>
  1619. <strong>HY</strong> by itself (i.e. with no argument) simply turns
  1620. automatic hyphenation on. Any argument other than <strong>LINES,
  1621. MARGIN, SPACE</strong> or <strong>DEFAULT</strong>, turns automatic
  1622. hyphenation off. For example, as explained in
  1623. <a href="intro.html#MACRO_ARGS">How to read macro arguments</a>,
  1624. you could turn <strong>HY</strong> off by entering
  1625. <p>
  1626. <pre>
  1627. .HY OFF
  1628. or
  1629. .HY X
  1630. or
  1631. .HY END
  1632. </pre>
  1633. <strong>HY</strong> observes the following default hyphenation rules:
  1634. <br>
  1635. <ol>
  1636. <li>Last lines (i.e. ones that will spring a trap--typically
  1637. the last line on a page) will not be hyphenated.
  1638. <li>The first and last two characters of a word are never
  1639. split off.
  1640. </ol>
  1641. <h3><u>2. HY LINES</u></h3>
  1642. <strong>HY LINES</strong> sets the maximum number of consecutive
  1643. hyphenated lines that will appear in output copy. 2 is a very
  1644. good choice, and you'd set it with
  1645. <p>
  1646. <pre>
  1647. .HY LINES 2
  1648. </pre>
  1649. By default, when you turn automatic hyphenation on, there is no
  1650. limit to the number of consecutive hyphenated lines.
  1651. <p>
  1652. <strong>NOTE:</strong>
  1653. <a href="definitions.html#TERMS_DISCRETIONARYHYPHEN">Discretionary hyphens</a>
  1654. count when groff is figuring out how many lines to hyphenate;
  1655. explicit hyphens do not.
  1656. <h3><u>3. HY MARGIN</u></h3>
  1657. <strong>HY MARGIN</strong> sets the amount of room allowed at
  1658. the end of a line before hyphenation is tripped (e.g. if there's
  1659. only 6 points left at the end of a line, groff won't try to hyphenate
  1660. the next word). <strong>HY MARGIN</strong> only applies if you're
  1661. using
  1662. <a href="#QUAD">QUAD</a>, and is really only useful if you're
  1663. using <strong>QUAD LEFT</strong>.
  1664. <p>
  1665. As an example, if you don't want groff to hyphenate words when there's
  1666. only 18 points of space left at the end of a left-quadded line,
  1667. you'd enter
  1668. <p>
  1669. <pre>
  1670. .HY MARGIN 18p
  1671. </pre>
  1672. <strong>NOTE:</strong> The numeric argument after <strong>HY
  1673. MARGIN</strong> requires a
  1674. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
  1675. <h3><u>4. HY SPACE</u></h3>
  1676. <strong>HY SPACE</strong> sets an amount of extra interword
  1677. space that groff will <em>try</em> to put between words on a
  1678. line in order to PREVENT hyphenation. <strong>HY SPACE</strong>
  1679. applies only to
  1680. <a href="definitions.html#TERMS_JUST">justified lines</a>. Generally speaking,
  1681. you'll want this value to be quite small, since too big a value
  1682. will result in lines with gaping holes between the words. A reasonable
  1683. value might be half a point, or one point, which you'd set with
  1684. <p>
  1685. <pre>
  1686. .HY SPACE .5p
  1687. or
  1688. .HY SPACE 1p
  1689. </pre>
  1690. <strong>NOTE:</strong> The numeric argument after <strong>HY
  1691. SPACE</strong> requires a
  1692. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
  1693. <h3><u>5. HY DEFAULT</u></h3>
  1694. <strong>HY DEFAULT</strong> resets automatic hyphenation to its
  1695. default behaviour, cancelling any changes made with <strong>LINES,
  1696. MARGIN,</strong> and/or <strong>SPACE</strong>.
  1697. <h3><u>A note on hyphenation in general</u></h3>
  1698. Hyphenation is a necessary evil. If it can be avoided, it should be.
  1699. If it can't be, it should occur infrequently. That's the reason for
  1700. the number of parameters you can set with <strong>HY</strong>.
  1701. <p>
  1702. Furthermore, hyphenation in
  1703. <a href="definitions.html#TERMS_RAG">rag</a>
  1704. copy requires a great deal of attention. At best, it should be
  1705. avoided completely by individually adjusting the number of words
  1706. on consecutive lines to achieve a pleasing, natural-looking rag.
  1707. Since such adjustments are often too fussy for document
  1708. processing, I recommend playing around with <strong>HY MARGIN</strong>
  1709. a bit if your copy looks hyphen-heavy.
  1710. <p>
  1711. <!---HY_SET--->
  1712. <hr width="66%" align="left">
  1713. <a name="HY_SET"><h3><u>Set hyphenation parameters all at once</u></h3></a>
  1714. <br>
  1715. <nobr>Macro: <strong>HY_SET</strong> &lt;lines&gt; [ &lt;margin&gt; [ &lt;space&gt; ] ]</nobr>
  1716. <br>
  1717. Alias: <strong>HYSET</strong>
  1718. <p>
  1719. <strong>HY_SET</strong> lets you set the parameters for hyphenation
  1720. with a single macro. &lt;lines&gt;, &lt;margin&gt; and &lt;space&gt;
  1721. correspond to the numeric values required by
  1722. <strong>LINES</strong>, <strong>MARGIN</strong> and
  1723. <strong>SPACE</strong> as described
  1724. <a href="#HY">above</a>.
  1725. <p>
  1726. To set just the maximum number of consecutive hyphenated lines,
  1727. you'd enter
  1728. <p>
  1729. <pre>
  1730. .HY_SET 2
  1731. </pre>
  1732. If you wanted the same number of maximum consecutive hyphenated lines
  1733. and a hyphenation margin for use with
  1734. <a href="definitions.html#TERMS_RAG">rag</a>
  1735. copy,
  1736. <p>
  1737. <pre>
  1738. .HY_SET 2 36p
  1739. </pre>
  1740. would set the hyphenation margin to 36 points.
  1741. <p>
  1742. If you wanted the same number of maximum consecutive hyphenated
  1743. lines and a hyphenation space of 2 points for use with
  1744. <a href="definitions.html#TERMS_JUST">justified</a>
  1745. copy,
  1746. <p>
  1747. <pre>
  1748. .HYSET 2 0 2p
  1749. </pre>
  1750. is how you'd do it.
  1751. <p>
  1752. <!---RW--->
  1753. <hr width="66%" align="left">
  1754. <a name="RW"><h3><u>Reduce whitespace</u></h3></a>
  1755. <br>
  1756. <nobr>Macro: <strong>RW</strong> &lt;amount of whitespace reduction between letters&gt;</nobr>
  1757. <br>
  1758. <p>
  1759. <strong>RW</strong> (Reduce Whitespace) and its corresponding macro,
  1760. <strong>EW</strong> (Expand Whitespace), allow you to tighten
  1761. (or loosen)
  1762. <a href="definitions.html#TERMS_OUTPUTLINE">output lines</a>
  1763. by uniformly reducing or expanding the space between characters.
  1764. This is particularly useful when you want to squeeze or stretch
  1765. lines on a narrow measure.
  1766. <p>
  1767. The value passed to <strong>RW</strong> may be a whole number or a
  1768. decimal fraction. Since a value of 1 produces a noticeable reduction
  1769. in the space between letters at text sizes, you'll most likely use
  1770. small decimal values when tightening lines. For example,
  1771. <p>
  1772. <pre>
  1773. .RW .1
  1774. or
  1775. .RW .2
  1776. </pre>
  1777. may be just enough to squeeze an extra character or two on a
  1778. line without the change in letter spacing being obvious. I
  1779. highly recommend previewing your work to assess the effect of
  1780. <strong>RW</strong>.
  1781. <p>
  1782. <p>
  1783. <strong>IMPORTANT:</strong> In versions prior to 1.1.9-a,
  1784. <strong>RW</strong> affected all
  1785. <a href="definitions.html#TERMS_FONT">fonts</a>
  1786. in the
  1787. <a href="definitions.html#TERMS_FAMILY">family</a>
  1788. current at the time it was invoked. As of 1.1.9-a, this behaviour
  1789. has been changed. <strong>RW</strong> affects only the font
  1790. current at the time it's invoked, and remains in effect for that
  1791. font every time the font is called, hence must be reset to zero to
  1792. cancel its effect (<code>.RW 0</code>) on that font.
  1793. <p>
  1794. <strong>NOTE:</strong> By default, <strong>RW</strong> does not deposit a
  1795. <a href="#BR">break</a>
  1796. (<strong>BR</strong>) when it's invoked if you're in one of the
  1797. <a href="definitions.html#TERMS_FILL">fill</a>
  1798. modes (i.e.
  1799. <a href="#QUAD">QUAD</a>
  1800. <strong>L, R, C, J</strong> or
  1801. <a href="#JUSTIFY">JUSTIFY</a>).
  1802. If you want
  1803. <strong>RW</strong> to break at the ends of the previous
  1804. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>
  1805. while you're in a fill mode, tell <strong>mom</strong>
  1806. that's what you want by invoking the
  1807. <a href="#BR_AT_LINE_KERN">BR_AT_LINE_KERN</a>
  1808. toggle macro.
  1809. <p>
  1810. <!---EW--->
  1811. <hr width="66%" align="left">
  1812. <a name="EW"><h3><u>Expand whitespace</u></h3></a>
  1813. <br>
  1814. <nobr>Macro: <strong>EW</strong> &lt;amount of whitespace expansion between letters&gt;</nobr>
  1815. <br>
  1816. <p>
  1817. <strong>EW</strong> (Expand Whitespace) expands the amount of
  1818. whitespace between letters, effectively &quot;loosening&quot; lines
  1819. of type.
  1820. <p>
  1821. The value passed to <strong>EW</strong> may be a whole number or a
  1822. decimal fraction. Since a value of 1 produces a noticeable
  1823. expansion in the space between letters at text sizes, you'll most likely use
  1824. small decimal values when loosening lines. For example,
  1825. <p>
  1826. <pre>
  1827. .EW .1
  1828. or
  1829. .EW .2
  1830. </pre>
  1831. may be just enough to open up a line without the change in letter
  1832. spacing being obvious. I highly recommend previewing your work to
  1833. assess the effect of <strong>EW</strong>.
  1834. <p>
  1835. <strong>IMPORTANT:</strong> In versions prior to 1.1.9-a,
  1836. <strong>EW</strong> affected all
  1837. <a href="definitions.html#TERMS_FONT">fonts</a>
  1838. in the
  1839. <a href="definitions.html#TERMS_FAMILY">family</a>
  1840. current at the time it was invoked. As of 1.1.9-a, this behaviour
  1841. has been changed. <strong>EW</strong> affects only the font
  1842. current at the time it's invoked, and remains in effect for that
  1843. font every time the font is called, hence must be reset to zero to
  1844. cancel its effect (<code>.EW 0</code>) on that font.
  1845. <p>
  1846. <strong>NOTE:</strong> By default, <strong>EW</strong> does not deposit a
  1847. <a href="#BR">break</a>
  1848. (<strong>BR</strong>) when it's invoked if you're in one of the
  1849. <a href="definitions.html#TERMS_FILL">fill</a>
  1850. modes (i.e.
  1851. <a href="#QUAD">QUAD</a>
  1852. <strong>L, R, C, J</strong> or
  1853. <a href="#JUSTIFY">JUSTIFY</a>).
  1854. If you want
  1855. <strong>EW</strong> to break at the ends of the previous
  1856. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>
  1857. while you're in a fill mode, tell <strong>mom</strong>
  1858. that's what you want by invoking the
  1859. <a href="#BR_AT_LINE_KERN">BR_AT_LINE_KERN</a>
  1860. toggle macro.
  1861. <p>
  1862. <!---BR_AT_LINE_KERN--->
  1863. <hr width="66%" align="left">
  1864. <a name="BR_AT_LINE_KERN"><h3><u>Break before line kerning</u></h3></a>
  1865. <br>
  1866. <nobr>Macro: <strong>BR_AT_LINE_KERN</strong> toggle</nobr>
  1867. <br>
  1868. <p>
  1869. By default, in
  1870. <a href="definitions.html#TERMS_FILLED">fill</a>
  1871. modes (i.e.
  1872. <a href="#QUAD">QUAD</a>
  1873. <strong>L, R, C, J</strong> or
  1874. <a href="#JUSTIFY">JUSTIFY</a>)
  1875. <strong>mom</strong> does not break
  1876. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>
  1877. when you invoke <strong>RW</strong> or <strong>EW</strong>.
  1878. If you'd like her to break input lines prior to <strong>RW</strong>
  1879. or <strong>EW</strong>, invoke <strong>BR_AT_INPUT_LINE</strong>
  1880. without any argument. To disable the breaks, invoke
  1881. <strong>BR_AT_INPUT_LINE</strong> with any argument (<strong>OFF,
  1882. QUIT, Q, X</strong>...), like this
  1883. <p>
  1884. <pre>
  1885. .BR_AT_LINE_KERN OFF
  1886. or
  1887. .BR_AT_LINE_KERN X
  1888. </pre>
  1889. In <strong>QUAD L, R</strong> or <strong>C</strong>,
  1890. <strong>mom</strong> simply breaks the line. In <strong>QUAD J</strong>
  1891. (or <strong>JUSTIFY</strong>, which is the same thing), she breaks
  1892. and
  1893. <a href="definitions.html#TERMS_FORCE">force justifies</a>
  1894. the line prior to <strong>EW</strong> or <strong>RW</strong>.
  1895. <br>
  1896. <!---KERN--->
  1897. <hr width="66%" align="left">
  1898. <a name="KERN"><h3><u>Automatic kerning</u></h3></a>
  1899. <br>
  1900. <nobr>Macro: <strong>KERN</strong> toggle</nobr>
  1901. <br>
  1902. <p>
  1903. By itself (i.e. with no argument), <strong>KERN</strong> turns
  1904. automatic pairwise
  1905. <a href="definitions.html#TERMS_KERN">kerning</a>
  1906. on. With any argument (e.g. OFF, Q, X), pairwise kerning is turned
  1907. off.
  1908. <p>
  1909. Kerning of individual character pairs can be controlled with the
  1910. <a href="definitions.html#TERMS_INLINES">inline escapes</a>
  1911. <strong>\*[BU &lt;n&gt;]</strong> and <strong>\*[FU &lt;n&gt;]</strong>. See
  1912. <a href="inlines.html#INLINE_KERNING_MOM">Inline Escapes, kerning</a>.
  1913. <p>
  1914. <!---LIGATURES--->
  1915. <hr width="66%" align="left">
  1916. <a name="LIGATURES"><h3><u>Automatic ligature generation</u></h3></a>
  1917. <br>
  1918. <nobr>Macro: <strong>LIGATURES</strong> toggle</nobr>
  1919. <br>
  1920. Alias: <strong>LIG</strong>
  1921. <p>
  1922. Provided your current font has
  1923. <a href="definitions.html#TERMS_LIGATURES">ligatures</a>,
  1924. <strong>LIGATURES</strong>, by itself, turns on automatic
  1925. generation of ligatures. When automatic ligature generation is
  1926. on, simply typing the letters of a ligature combination will
  1927. produce the correct ligature upon output. For example, if you
  1928. type the word &quot;finally&quot;, the fi combination will be
  1929. output as an fi ligature. Generally speaking, ligatures are A
  1930. Good Thing, hence <strong>mom</strong> has them on by default.
  1931. <p>
  1932. <strong>LIGATURES</strong> with any argument turns automatic
  1933. ligature generation off.
  1934. <p>
  1935. <strong>NOTE:</strong> Not all fonts support ligatures.
  1936. <p>
  1937. <hr>
  1938. <!====================================================================>
  1939. <a name="INTRO_MODIFICATIONS"></a>
  1940. <a name="MODIFICATIONS">
  1941. <h2><u>Type modifications: pseudo-italic, -bold, -condensed, -extended</u></h2>
  1942. </a>
  1943. It sometimes happens that a PostScript
  1944. <a href="definitions.html#TERMS_FAMILY">family</a>
  1945. doesn't contain all the fonts you need. You might, for example,
  1946. be missing an italic font, or a bold font. Or you might not be able
  1947. to get your hands on a condensed family. That's where these macros
  1948. and inline escapes come in. With them, you can fake the fonts
  1949. you're missing. A word of caution, though: &quot;faked&quot;
  1950. fonts are just that--faked. You should only use them as a
  1951. last resort, and then only sparingly. A word or two or a line
  1952. or two in a faked font will pass unnoticed; large patches of
  1953. type in a faked font look typographically cheap.
  1954. <br>
  1955. <a name="INDEX_MODIFICATIONS">
  1956. <h3><u>Type modifications macro list</u></h3>
  1957. </a>
  1958. <ul>
  1959. <li><strong>Pseudo italic</strong>
  1960. <ul>
  1961. <li><a href="#SETSLANT">SETSLANT</a> -- degree of pseudo-italicizing
  1962. <li><a href="#SLANT_INLINE">\*[SLANT]</a> -- inline escape for pseudo-italicizing type
  1963. </ul>
  1964. <li><strong>Pseudo bold</strong>
  1965. <ul>
  1966. <li><a href="#SETBOLDER">SETBOLDER</a> -- amount of emboldening
  1967. <li><a href="#BOLDER_INLINE">\*[BOLDER]</a> -- inline escape for emboldening type
  1968. </ul>
  1969. <li><strong>Pseudo condensed</strong>
  1970. <ul>
  1971. <li><a href="#CONDENSE">CONDENSE</a> -- percentage for pseudo-condensed type
  1972. <li><a href="#COND_INLINE">\*[COND]</a> -- inline escape for pseudo-condensed type
  1973. </ul>
  1974. <li><strong>Pseudo extended</strong>
  1975. <ul>
  1976. <li><a href="#EXTEND">EXTEND</a> -- percentage for pseudo-extended type
  1977. <li><a href="#EXT_INLINE">\*[EXT]</a> -- inline escape for pseudo-extending
  1978. </ul>
  1979. </ul>
  1980. <!---SETSLANT--->
  1981. <hr width="66%" align="left">
  1982. <a name="SETSLANT"><h3><u>Set degree of slant for pseudo-italicizing</u></h3></a>
  1983. <br>
  1984. <nobr>Macro: <strong>SETSLANT</strong> &lt;degrees to slant type&gt; | RESET</nobr>
  1985. <p>
  1986. Pseudo-italicizing of type is accomplished by slanting a roman font
  1987. a certain number of degrees to the right. <strong>SETSLANT</strong>
  1988. lets you fix the number of degrees. <strong>Mom</strong>'s
  1989. default is 15, which produces an acceptable approximation of an
  1990. italic font. If you want another value -- say, 13 degrees --
  1991. you'd set it by entering
  1992. <p>
  1993. <pre>
  1994. .SETSLANT 13
  1995. </pre>
  1996. If you change the degree of slant and later want to set it back
  1997. to the <strong>mom</strong> default, do
  1998. <p>
  1999. <pre>
  2000. .SETSLANT RESET
  2001. </pre>
  2002. <strong>NOTE:</strong> By itself, <strong>SETSLANT</strong>
  2003. will not start pseudo-italicizing type; it merely tells
  2004. <strong>mom</strong> what degree of slant you want. To start
  2005. pseudo-italicizing, use the
  2006. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  2007. <strong>\*[SLANT]</strong>.
  2008. <p>
  2009. <!---\*[SLANT]--->
  2010. <hr width="66%" align="left">
  2011. <a name="SLANT_INLINE"><h3><u>Pseudo italic on/off</u></h3></a>
  2012. <br>
  2013. Inline: <strong>\*[SLANT] -- turn pseudo-italic on</strong>
  2014. <br>
  2015. Inline: <strong>\*[SLANTX] -- turn pseudo-italic off</strong>
  2016. <p>
  2017. <strong>\*[SLANT]</strong> begins pseudo-italicizing type.
  2018. <strong>\*[SLANTX]</strong> turns the feature off. Both are
  2019. <a href="definitions.html#TERMS_INLINES">inline escapes</a>,
  2020. therefore they should not appear as separate lines, but rather
  2021. be embedded in text lines, like this:
  2022. <p>
  2023. <pre>
  2024. Not \*[SLANT]everything\*[SLANTX] is as it seems.
  2025. </pre>
  2026. Alternatively, if you wanted the whole line pseudo-italicized,
  2027. you'd do
  2028. <p>
  2029. <pre>
  2030. \*[SLANT]Not everything is as it seems.\*[SLANTX]
  2031. </pre>
  2032. Once <strong>\*[SLANT]</strong> is invoked, it remains in effect
  2033. until turned off.
  2034. <p>
  2035. <strong>NOTE:</strong> If you're using the
  2036. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>
  2037. with
  2038. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  2039. <strong>mom</strong> underlines pseudo-italics by default. To
  2040. change this behaviour, use the special macro
  2041. <a href="docprocessing.html#SLANT_MEANS_SLANT">SLANT_MEANS_SLANT</a>.
  2042. <p>
  2043. <!---SETBOLDER--->
  2044. <hr width="66%" align="left">
  2045. <a name="SETBOLDER"><h3><u>Set amount of emboldening</u></h3></a>
  2046. <br>
  2047. <nobr>Macro: <strong>SETBOLDER</strong> &lt;amount of emboldening, in machine units&gt; | RESET</nobr>
  2048. <p>
  2049. Emboldening of type is accomplished by printing characters
  2050. twice; the second printing is slightly offset from the first,
  2051. effectively &quot;thickening&quot; the character.
  2052. <strong>SETBOLDER</strong> lets you set the number of
  2053. <a href="definitions.html#TERMS_UNITS">machine units</a>
  2054. for the offset. <strong>Mom</strong>'s default is 700 units, which
  2055. produces an acceptable approximation of a bold font. If you want
  2056. another value -- say, 500 units -- you'd set it by entering
  2057. <p>
  2058. <pre>
  2059. .SETBOLDER 500
  2060. </pre>
  2061. If you change the emboldening offset and later want to set it back
  2062. to the <strong>mom</strong> default, do
  2063. <p>
  2064. <pre>
  2065. .SETBOLDER RESET
  2066. </pre>
  2067. <strong>NOTE:</strong> By itself, <strong>SETBOLDER</strong>
  2068. will not start emboldening type; it merely tells
  2069. <strong>mom</strong> what you want the emboldening offset to be.
  2070. To start emboldening, use the
  2071. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  2072. <strong>\*[BOLDER]</strong>.
  2073. <p>
  2074. <!---\*[BOLDER]--->
  2075. <hr width="66%" align="left">
  2076. <a name="BOLDER_INLINE"><h3><u>Emboldening on/off</u></h3></a>
  2077. <br>
  2078. Inline: <strong>\*[BOLDER] -- turn emboldening on</strong>
  2079. <br>
  2080. Inline: <strong>\*[BOLDERX] -- turn emboldening off</strong>
  2081. <p>
  2082. <strong>\*[BOLDER]</strong> begins emboldening type.
  2083. <strong>\*[BOLDERX]</strong> turns the feature off. Both are
  2084. <a href="definitions.html#TERMS_INLINES">inline escapes</a>,
  2085. therefore they should not appear as separate lines, but rather
  2086. be embedded in text lines, like this:
  2087. <p>
  2088. <pre>
  2089. Not \*[BOLDER]everything\*[BOLDERX] is as it seems.
  2090. </pre>
  2091. Alternatively, if you wanted the whole line emboldened,
  2092. you'd do
  2093. <p>
  2094. <pre>
  2095. \*[BOLDER]Not everything is as it seems.\*[BOLDERX]
  2096. </pre>
  2097. Once <strong>\*[BOLDER]</strong> is invoked, it remains in effect
  2098. until turned off.
  2099. <p>
  2100. <strong>NOTE:</strong> If you're using the
  2101. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>
  2102. with
  2103. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  2104. <strong>mom</strong> ignores <strong>\*[BOLDER]</strong>
  2105. requests.
  2106. <p>
  2107. <!---CONDENSE--->
  2108. <hr width="66%" align="left">
  2109. <a name="CONDENSE"><h3><u>Set percentage for pseudo-condensed type</u></h3></a>
  2110. <br>
  2111. <nobr>Macro: <strong>CONDENSE</strong> &lt;pseudo-condense percentage&gt;</nobr>
  2112. <p>
  2113. Pseudo-condensing of type is accomplished by reducing the width of
  2114. characters at a given point size without reducing their height,
  2115. effectively narrowing them so they look like condensed type.
  2116. <strong>CONDENSE</strong> tells <strong>mom</strong> what
  2117. percentage of the normal character width you want the characters
  2118. to be condensed.
  2119. <p>
  2120. <strong>Mom</strong> has no default value for
  2121. <strong>CONDENSE</strong>, therefore you must set it before using the
  2122. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  2123. <a href="#COND_INLINE">\*[COND]</a>.
  2124. 80 percent of the normal character width is a good value, and
  2125. you'd set it like this:
  2126. <p>
  2127. <pre>
  2128. .CONDENSE 80
  2129. </pre>
  2130. <strong>NOTE:</strong> By itself, <strong>CONDENSE</strong>
  2131. will not start pseudo-condensing type; it merely tells
  2132. <strong>mom</strong> what percentage of the normal character
  2133. width you want characters to be condensed.
  2134. To start pseudo-condensing, use the
  2135. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  2136. <strong>\*[COND]</strong>.
  2137. <p>
  2138. <strong>Additional note:</strong> Make sure that pseudo-condensing
  2139. is off (with
  2140. <a href="#COND_INLINE">\*[CONDX]</a>)
  2141. before before making any changes to the pseudo-condense percentage
  2142. with <strong>CONDENSE</strong>.
  2143. <p>
  2144. <!---\*[COND]--->
  2145. <hr width="66%" align="left">
  2146. <a name="COND_INLINE"><h3><u>Pseudo-condensing on/off</u></h3></a>
  2147. <br>
  2148. Inline: <strong>\*[COND] -- turn pseudo-condensing on</strong>
  2149. <br>
  2150. Inline: <strong>\*[CONDX] -- turn pseudo-condensing off</strong>
  2151. <p>
  2152. <strong>\*[COND]</strong> begins pseudo-condensing type.
  2153. <strong>\*[CONDX]</strong> turns the feature off. Both are
  2154. <a href="definitions.html#TERMS_INLINES">inline escapes</a>,
  2155. therefore they should not appear as separate lines, but rather
  2156. be embedded in text lines, like this:
  2157. <p>
  2158. <pre>
  2159. \*[COND]Not everything is as it seems.\*[CONDX]
  2160. </pre>
  2161. <strong>\*[COND]</strong> remains in effect until you turn it
  2162. off with <strong>\*[CONDX]</strong>.
  2163. <p>
  2164. <strong>IMPORTANT:</strong> You MUST turn <strong>\*[COND]</strong>
  2165. off before making any changes to the point size of your type, either
  2166. via the
  2167. <a href="#PS">PT_SIZE</a>
  2168. macro or with the <strong>\s</strong> inline escape. If you wish
  2169. the new point size to be pseudo-condensed, simply reinvoke
  2170. <strong>\*[COND]</strong> afterwards. Equally,
  2171. <strong>\*[COND]</strong> must be turned off before changing the
  2172. condense percentage with <a href="#CONDENSE">CONDENSE</a>.
  2173. <p>
  2174. <strong>NOTE:</strong> If you're using the
  2175. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>
  2176. with
  2177. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  2178. <strong>mom</strong> ignores <strong>\*[COND]</strong>
  2179. requests.
  2180. <p>
  2181. <!---EXTEND--->
  2182. <hr width="66%" align="left">
  2183. <a name="EXTEND"><h3><u>Set percentage for pseudo-extended type</u></h3></a>
  2184. <br>
  2185. <nobr>Macro: <strong>EXTEND</strong> &lt;pseudo-extend percentage&gt;</nobr>
  2186. <p>
  2187. Pseudo-extending of type is accomplished by increasing the width of
  2188. characters at a given point size without increasing their height,
  2189. effectively widening them so they look like extended type.
  2190. <strong>EXTEND</strong> tells <strong>mom</strong> what
  2191. percentage of the normal character width you want the characters
  2192. to be extended.
  2193. <p>
  2194. <strong>Mom</strong> has no default value for
  2195. <strong>EXTEND</strong>, therefore you must set it before using the
  2196. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  2197. <a href="#EXT_INLINE">\*[EXT]</a>.
  2198. 120% of the normal character width is a good value, and
  2199. you'd set it like this:
  2200. <p>
  2201. <pre>
  2202. .EXTEND 120
  2203. </pre>
  2204. <strong>NOTE:</strong> By itself, <strong>EXTEND</strong>
  2205. will not start pseudo-extending type; it merely tells
  2206. <strong>mom</strong> what percentage of the normal character
  2207. width you want characters to be extended.
  2208. To start pseudo-extending, use the
  2209. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  2210. <strong>\*[EXT]</strong>.
  2211. <p>
  2212. <strong>Additional note:</strong> Make sure that
  2213. pseudo-extending is off (with
  2214. <a href="#EXT_INLINE">\*[EXTX]</a>)
  2215. before before making any changes to the pseudo-extend percentage
  2216. with <strong>EXTEND</strong>.
  2217. <p>
  2218. <!---\*[EXT]--->
  2219. <hr width="66%" align="left">
  2220. <a name="EXT_INLINE"><h3><u>Pseudo-extending on/off</u></h3></a>
  2221. <br>
  2222. Inline: <strong>\*[EXT] -- turn pseudo-extending on</strong>
  2223. <br>
  2224. Inline: <strong>\*[EXTX] -- turn pseudo-extending off</strong>
  2225. <p>
  2226. <strong>\*[EXT]</strong> begins pseudo-extending type.
  2227. <strong>\*[EXTX]</strong> turns the feature off. Both are
  2228. <a href="definitions.html#TERMS_INLINES">inline escapes</a>,
  2229. therefore they should not appear as separate lines, but rather
  2230. be embedded in text lines, like this:
  2231. <p>
  2232. <pre>
  2233. \*[EXT]Not everything is as it seems.\*[EXTX]
  2234. </pre>
  2235. <strong>\*[EXT]</strong> remains in effect until you turn it
  2236. off with <strong>\*[EXTX]</strong>.
  2237. <p>
  2238. <strong>IMPORTANT:</strong> You MUST turn <strong>\*[EXT]</strong>
  2239. off before making any changes to the point size of your type, either
  2240. via the
  2241. <a href="#PS">PT_SIZE</a>
  2242. macro or with the <strong>\s</strong> inline escape. If you wish
  2243. the new point size to be pseudo-extended, simply reinvoke
  2244. <strong>\*[EXT]</strong> afterwards. Equally,
  2245. <strong>\*[EXT]</strong> must be turned off before changing the
  2246. extend percentage with <a href="#EXTEND">EXTEND</a>.
  2247. <p>
  2248. <strong>NOTE:</strong> If you're using the
  2249. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>
  2250. with
  2251. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  2252. <strong>mom</strong> ignores <strong>\*[EXT]</strong>
  2253. requests.
  2254. <p>
  2255. <hr>
  2256. <!====================================================================>
  2257. <a name="INTRO_ALDRLD"></a>
  2258. <a name="ALDRLD">
  2259. <h2><u>Vertical movement</u></h2>
  2260. </a>
  2261. The two macros in this section allow you to move down or up on the page
  2262. relative to the current
  2263. <a href="definitions.html#TERMS_BASELINE">baseline</a>.
  2264. <a name="INDEX_ALDRLD">
  2265. <h3><u>Vertical movement macro list</u></h3>
  2266. </a>
  2267. <ul>
  2268. <li><a href="#ALD">ALD</a> -- Advance Lead
  2269. <li><a href="#RLD">RLD</a> -- Reverse Lead
  2270. </ul>
  2271. <!---ALD--->
  2272. <hr width="66%" align="left">
  2273. <a name="ALD"><h3><u>Advance Lead (move downward)</u></h3></a>
  2274. <br>
  2275. <nobr>Macro: <strong>ALD</strong> &lt;distance to move downward&gt;</nobr>
  2276. <br>
  2277. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  2278. <p>
  2279. <strong>ALD</strong> takes one argument: the distance to move downward
  2280. on the page relative to the current vertical position.
  2281. <p>
  2282. Used by itself, or preceded by
  2283. <a href="#BR">BR</a>,
  2284. <strong>ALD</strong> will advance by one line space plus the
  2285. distance you specify. Preceded by
  2286. <a href="#EL">EL</a>,
  2287. it will advance by exactly the distance you specify.
  2288. <p>
  2289. <strong>ALD</strong> requires a unit of measure. Decimal fractions
  2290. are allowed, and values may be combined. Therefore, to move down
  2291. on the page by 1/4 of an inch, you could enter either
  2292. <p>
  2293. <pre>
  2294. .ALD .25i
  2295. or
  2296. .ALD 1P+6p
  2297. </pre>
  2298. As the mnemonic (<strong>A</strong>dvance
  2299. <strong>L</strong>ea<strong>D</strong>) suggests, you'll most often
  2300. use <strong>ALD</strong> with
  2301. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
  2302. of lead.
  2303. <p>
  2304. <strong>NOTE:</strong> if you want to use <strong>ALD</strong>
  2305. at the top of a page (i.e. to advance to the starting position
  2306. of type on a page), combine the value you want with -1v (minus
  2307. one line space), like this:
  2308. <p>
  2309. <pre>
  2310. .ALD 1i-1v
  2311. </pre>
  2312. At the top of a page, this will advance one inch from the
  2313. top edge of the paper. Without the -1v, the same command would
  2314. advance one inch from the top of the page plus the distance of
  2315. one line space.
  2316. <p>
  2317. <strong>Important:</strong> Do NOT use <strong>ALD</strong> in this
  2318. way if you have set a top margin with
  2319. <a href="#T_MARGIN">T_MARGIN</a>
  2320. or
  2321. <a href="#PAGE">PAGE</a>.
  2322. <p>
  2323. <!---RLD--->
  2324. <hr width="66%" align="left">
  2325. <a name="RLD"><h3><u>Reverse Lead (move upward)</u></h3></a>
  2326. <br>
  2327. <nobr>Macro: <strong>RLD</strong> &lt;distance to move upward&gt;</nobr>
  2328. <br>
  2329. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  2330. <p>
  2331. <strong>RLD</strong> takes one argument: the distance to move
  2332. upward on the page relative to the current vertical position.
  2333. <p>
  2334. Used by itself, or preceded by
  2335. <a href="#BR">BR</a>,
  2336. <strong>RLD</strong> will advance by one line space, then
  2337. reverse by the distance you specify. Preceded by
  2338. <a href="#EL">EL</a>,
  2339. it will reverse by exactly the distance you specify.
  2340. <p>
  2341. <strong>RLD</strong> requires a unit of measure. Decimal fractions
  2342. are allowed, and values may be combined. Therefore, to move up
  2343. on the page by 1/4 of an inch, you could enter either
  2344. <p>
  2345. <pre>
  2346. .RLD .25i
  2347. or
  2348. .RLD 1P+6p
  2349. </pre>
  2350. As the mnemonic (<strong>R</strong>dvance
  2351. <strong>L</strong>ea<strong>D</strong>) suggests, you'll most often
  2352. use <strong>RLD</strong> with
  2353. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
  2354. of lead.
  2355. <p>
  2356. <hr>
  2357. <!====================================================================>
  2358. <a name="INTRO_TABS"></a>
  2359. <a name="TABS">
  2360. <h2><u>Tabs</u></h2>
  2361. </a>
  2362. <strong>Mom</strong> provides two different kinds of tab setup:
  2363. typesetting tabs and string tabs. Neither one has anything to
  2364. do with the tab key on your keyboard, and both are utterly
  2365. divorced from groff's notion of tabs. I recommend reading this
  2366. section carefully in order to understand how
  2367. <strong>mom</strong> handles tabs.
  2368. <p>
  2369. <strong>NOTE:</strong> see the section
  2370. <a href="typemacdoc.html#TYPESETTING">Using typesetting macros during document processing</a>
  2371. for re-assuring information on the use of tabs during
  2372. <a href="docprocessing.html#DOCPROCESSING">document processing</a>.
  2373. <p>
  2374. <a name="TYPESETTING_TABS"><h3><u>Typesetting tabs</u></h3></a>
  2375. <p>
  2376. Typesetting tabs are defined by both an indent from the left margin and
  2377. a line length. This is quite different from typewriter-style tab stops
  2378. (the groff norm) that only define the left indent. In conjunction
  2379. with the
  2380. <a href="#MULTI_COLUMNS">multi-column macros</a>,
  2381. typesetting tabs significantly facilitate
  2382. tabular and columnar work.
  2383. <p>
  2384. Typesetting tabs are created with the
  2385. <a href="#TAB_SET">TAB_SET</a>
  2386. macro. <strong>TAB_SET</strong> identifies the tab (by number),
  2387. establishes its left indent and line length, and optionally sets
  2388. a quad direction and fill mode. After tabs have been created with
  2389. <strong>TAB_SET</strong>, they can be called at any time with the
  2390. <a href="#TAB">TAB</a>
  2391. macro.
  2392. <p>
  2393. <a name="TYPESETTING_TABS_TUT"><h3><u>Quickie tutorial on typesetting tabs</u></h3></a>
  2394. <p>
  2395. Say you want to set up three tabs to produce an employee evaluation
  2396. that looks something like this:
  2397. <p>
  2398. <a name="TYPSETTING_TABS_SAMPLE"></a>
  2399. <pre>
  2400. CRITERION EVALUATION COMMENTS
  2401. Service Good Many clients specifically request
  2402. support from Joe by name.
  2403. Punctuality Satisfactory Tends to arrive after 8:00am, but
  2404. often works through lunch hour.
  2405. Team spirit Needs work Persistently gives higher priority
  2406. to helping clients than respecting
  2407. organizational hierarchy.
  2408. </pre>
  2409. You want the first tab (&quot;CRITERION&quot;)
  2410. <br>
  2411. <ul>
  2412. <li>to begin at the left margin of the page (i.e. no indent)
  2413. <li>to have a line length of 5 picas
  2414. <li>to be set flush left
  2415. </ul>
  2416. <br>
  2417. Tabs must be numbered, and each has to be set up with a separate
  2418. <a href="#TAB_SET">TAB_SET</a>
  2419. line. Therefore, to set up tab 1, you enter
  2420. <p>
  2421. <pre>
  2422. .TAB_SET 1 0 5P L
  2423. | | | |
  2424. tab #__| | | |__direction
  2425. | |
  2426. indent__| |__length
  2427. </pre>
  2428. You want the second tab (&quot;EVALUATION&quot;)
  2429. <br>
  2430. <ul>
  2431. <li>to begin 8 picas from the left margin
  2432. <li>to have a length of 9 picas
  2433. <li>to be set centred.
  2434. </ul>
  2435. <br>
  2436. You set it up like this:
  2437. <p>
  2438. <pre>
  2439. .TAB_SET 2 8P 9P C
  2440. | | | |
  2441. tab #__| | | |__direction
  2442. | |
  2443. indent__| |__length
  2444. </pre>
  2445. You want the third tab (&quot;COMMENTS&quot;)
  2446. <br>
  2447. <ul>
  2448. <li>to begin 19 picas from the left margin
  2449. <li>to have a length of 17 picas
  2450. <li>to be set flush left, <a href="definitions.html#TERMS_FILLED">filled</a>
  2451. </ul>
  2452. <br>
  2453. The setup looks like this:
  2454. <p>
  2455. <pre>
  2456. .TAB_SET 3 19P 17P L QUAD
  2457. | | | | |
  2458. | | | | |__fill output lines
  2459. | | | |
  2460. tab #__| | | |__direction
  2461. | |
  2462. indent__| |__length
  2463. </pre>
  2464. Once the tabs are set up, you can call them in one of two ways:
  2465. <br>
  2466. <ul>
  2467. <li><a href="#TAB">TAB</a> (with the tab
  2468. number as an argument) breaks the current line,
  2469. advances one linespace, and calls the tab.
  2470. <li><a href="#TN">TN</a> (Tab Next) keeps
  2471. you on the current line and moves over to the next
  2472. tab in sequence (i.e. from 1 to 2, 2 to 3, etc.).
  2473. </ul>
  2474. <br>
  2475. To exit from tabs and restore your original left margin, line length,
  2476. quad direction and fill mode, use
  2477. <a href="#TQ">TQ</a>
  2478. (Tab Quit).
  2479. <p>
  2480. Here's how the input for our sample employee evaluation looks
  2481. (with some introductory parameters):
  2482. <p>
  2483. <pre>
  2484. .PAGE 8.5i 11i 1i 1i 1i
  2485. .FAMILY T
  2486. .FT R
  2487. .PT_SIZE 14
  2488. .LS 16
  2489. .QUAD LEFT
  2490. .KERN
  2491. .HY OFF
  2492. .SS 0
  2493. .TAB_SET 1 0 5P L
  2494. .TAB_SET 2 8P 9P C
  2495. .TAB_SET 3 19P 17P L QUAD
  2496. .TAB 1
  2497. CRITERION
  2498. .TN
  2499. EVALUATION
  2500. .TN
  2501. COMMENTS
  2502. .SP
  2503. .TAB 1
  2504. Service
  2505. .TN
  2506. Good
  2507. .TN
  2508. Many clients specifically request support from Joe by name.
  2509. .SP
  2510. .TAB 1
  2511. Punctuality
  2512. .TN
  2513. Satisfactory
  2514. .TN
  2515. Tends to arrive after 8:00am, but often works through lunch hour.
  2516. .SP
  2517. .TAB 1
  2518. Team spirit
  2519. .TN
  2520. Needs work
  2521. .TN
  2522. Persistently gives higher priority to helping clients
  2523. than respecting organizational hierarchy.
  2524. .TQ
  2525. </pre>
  2526. Try setting this up and previewing it with
  2527. <p>
  2528. <pre>
  2529. groff -mom -X &lt;filename&gt;
  2530. </pre>
  2531. Notice how <kbd>.TN</kbd> simply moves over to the next tab,
  2532. while the combination <kbd>.SP/.TAB 1</kbd> breaks the
  2533. line, advances by one extra linespace, and calls the first tab.
  2534. <p>
  2535. Notice, too, how the <kbd>QUAD</kbd> argument passed to
  2536. tab 3 means you don't have to worry about the length of
  2537. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>;
  2538. <strong>mom</strong>
  2539. <a href="definitions.html#TERMS_FILLED">fills</a>
  2540. the tab and sets the type flush left.
  2541. <p>
  2542. <a name="STRING_TABS"><h3><u>String tabs (autotabs)</u></h3></a>
  2543. <p>
  2544. String tabs let you mark off tab positions with
  2545. <a href="definitions.html#TERMS_INLINES">inline escapes</a>
  2546. embedded in
  2547. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>.
  2548. Left indents and line lengths are calculated from the beginning and
  2549. end positions of the marks. This is especially useful when tab
  2550. indents and lengths need to be determined from the text that goes in
  2551. each tab.
  2552. <p>
  2553. Setting up string tabs is a two-step procedure. First, you enter an
  2554. input line in which you mark off where you want tabs to begin and end.
  2555. (This is often best done in conjunction with the
  2556. <a href="goodies.html#SILENT">SILENT</a>
  2557. macro.)
  2558. <p>
  2559. Next, you invoke the
  2560. <a href="#ST">ST</a>
  2561. macro for every string tab you defined, and optionally pass quad and
  2562. fill information to it. That done, string tabs are called with
  2563. the
  2564. <a href="#TAB">TAB</a>
  2565. macro, just like typesetting tabs.
  2566. <p>
  2567. In combination with the
  2568. <a href="goodies.html#PAD">PAD</a>
  2569. macro and the groff inline escape
  2570. <a href="inlines.html#INLINE_HORIZONTAL_GROFF">\h</a>
  2571. (move horizontally across the page) or <strong>mom</strong>'s
  2572. <a href="inlines.html#INLINE_HORIZONTAL_MOM">\*[FWD &lt;distance&gt;]</a>
  2573. (move forward) inline, string tabs provide
  2574. tremendous flexibility in setting up complex tab structures.
  2575. <p>
  2576. <a name="STRING_TABS_TUT"><h3><u>Quickie tutorial on string tabs</u></h3></a>
  2577. <p>
  2578. Say you want to set up tabs for the
  2579. <a href="#TYPSETTING_TABS_SAMPLE">employee evaluation form</a>
  2580. used as an example in the
  2581. <a href="#TYPESETTING_TABS_TUT">typesetting tabs tutorial</a>.
  2582. This time, though, you want to play around with the point size of
  2583. type, so you can't know exactly how long the tabs will be or where
  2584. they should start. All you know is
  2585. <br>
  2586. <ul>
  2587. <li>CRITERION is the longest line in tab 1
  2588. <li>EVALUATION is the longest line in tab 2
  2589. <li>tab 3 should extend to the current right margin
  2590. <li>you want a 1 pica gutter between each tab
  2591. </ul>
  2592. <br>
  2593. This is an ideal job for string tabs.
  2594. <p>
  2595. The first thing you need for string tabs is an
  2596. <a href="definitions.html#TERMS_INPUTLINE">input line</a>
  2597. with tab positions marked on it. Tabs are marked with the
  2598. <a href="definitions.html#TERMS_INLINES">inline escapes</a>
  2599. <a href="#ST_INLINE">\*[ST&lt;n&gt;]</a>
  2600. and
  2601. <a href="#ST_INLINE">\*[ST&lt;n&gt;X]</a>,
  2602. where <strong>&lt;n&gt;</strong>
  2603. is the number you want the tab to have. (In this example, we
  2604. enclose the input line with the
  2605. <a href="goodies.html#SILENT">SILENT</a>
  2606. macro so the line doesn't print. We also use the
  2607. <a href="goodies.html#PAD">PAD</a>
  2608. macro to permit defining tab 3 as simply &quot;the amount of
  2609. space remaining on the input line.&quot;)
  2610. <p>
  2611. The setup looks like this:
  2612. <p>
  2613. <pre>
  2614. .SILENT
  2615. .PAD "\*[ST1]CRITERION\*[ST1X]\*[FWD 12p]\*[ST2]EVALUATION\*[ST2X]\*[FWD 12p]\*[ST3]#\*[ST3X]"
  2616. .SILENT OFF
  2617. </pre>
  2618. The long line after <kbd>.PAD</kbd> looks scary, but it isn't.
  2619. Here's what it means when broken down into its component parts:
  2620. <br>
  2621. <ul>
  2622. <li>The longest line in tab 1 is &quot;CRITERION&quot;, so we
  2623. enclose CRITERION with begin/end markers for string tab 1:
  2624. <p>
  2625. <kbd>\*[ST1]CRITERION\*[ST1X]</kbd>
  2626. <br>
  2627. <li>We want a 1 pica (12 points) gutter between tab 1 and 2,
  2628. so we insert 12 points of space with \*[FWD 12p]
  2629. (<strong>F</strong>or<strong>W</strong>ar<strong>D</strong> 12 points):
  2630. <p>
  2631. <kbd>\*[FWD 12p]</kbd>
  2632. <br>
  2633. <li>The longest line in tab 2 is &quot;EVALUATION&quot;, so
  2634. we enclose EVALUATION with begin/end markers for string
  2635. tab 2:
  2636. <p>
  2637. <kbd>\*[ST2]EVALUATION\*[ST2X]</kbd>
  2638. <br>
  2639. <li>We want 1 pica (12 points) between tab 2 and 3, so we
  2640. insert 12 points of space with another \*[FWD 12p]:
  2641. <p>
  2642. <kbd>\*[FWD 12p]</kbd>
  2643. <br>
  2644. <li>We want tab 3 to be as long as whatever space remains on
  2645. the current line length, so we enclose the
  2646. <a href="goodies.html#PAD_MARKER">pad marker</a>
  2647. (#) with begin/end markers for string tab 3:
  2648. <p>
  2649. <kbd>\*[ST3]#\*[ST3X]</kbd>
  2650. <br>
  2651. </ul>
  2652. <br>
  2653. The tabs are now defined, but they require
  2654. <a href="definitions.html#TERMS_QUAD">quad direction</a>
  2655. and
  2656. <a href="definitions.html#TERMS_FILLED">fill</a>
  2657. information. For each string tab defined above, enter a
  2658. separate
  2659. <a href="#ST">ST</a>
  2660. line, like this:
  2661. <p>
  2662. <pre>
  2663. .ST 1 L
  2664. .ST 2 L
  2665. .ST 3 L QUAD
  2666. | | |
  2667. | | |__fill output lines
  2668. | |
  2669. tab__| |__direction
  2670. number
  2671. </pre>
  2672. From here on in, you call the tabs with
  2673. <a href="#TAB">TAB</a>
  2674. and
  2675. <a href="#TN">TN</a>
  2676. just like typesetting tabs (see
  2677. <a href="#TYPESETTING_TABS_TUT">typesetting tabs tutorial</a>).
  2678. <p>
  2679. Here's the complete setup and entry for the sample employee
  2680. evaluation form utilizing string tabs.
  2681. <p>
  2682. <pre>
  2683. .PAGE 8.5i 11i 1i 1i 1i
  2684. .FAMILY T
  2685. .FT R
  2686. .PT_SIZE 14
  2687. .LS 16
  2688. .QUAD LEFT
  2689. .KERN
  2690. .HY OFF
  2691. .SS 0
  2692. .SILENT
  2693. .PAD "\*[ST1]CRITERION\*[ST1X]\*[FWD 12p]\*[ST2]EVALUATION\*[ST2X]\*[FWD 12p]\*[ST3]#\*[ST3X]"
  2694. .SILENT OFF
  2695. .ST 1 L
  2696. .ST 2 L
  2697. .ST 3 L QUAD
  2698. .TAB 1
  2699. CRITERION
  2700. .TN
  2701. EVALUATION
  2702. .TN
  2703. COMMENTS
  2704. .SP
  2705. .TAB 1
  2706. Service
  2707. .TN
  2708. Good
  2709. .TN
  2710. Many clients specifically request support from Joe by name.
  2711. .SP
  2712. .TAB 1
  2713. Punctuality
  2714. .TN
  2715. Satisfactory
  2716. .TN
  2717. Tends to arrive after 8:00am, but often works through lunch hour.
  2718. .SP
  2719. .TAB 1
  2720. Team spirit
  2721. .TN
  2722. Needs work
  2723. .TN
  2724. Persistently gives higher priority to helping clients
  2725. than respecting organizational hierarchy.
  2726. .TQ
  2727. </pre>
  2728. Try setting this up and previewing it with
  2729. <p>
  2730. <pre>
  2731. groff -mom -X &lt;filename&gt;
  2732. </pre>
  2733. Now, change the point size of the above sample to 12 and preview
  2734. it again. You'll see that the tab structure remains identical (tab
  2735. 1=CRITERION, tab 2=EVALUATION, tab 3=space remaining, and the gutter
  2736. between tabs is still 1 pica), while the position and length
  2737. of the tabs have altered because of the new point size.
  2738. <p>
  2739. Now try increasing the gutters to 2 picas (<kbd>\*[FWD 24p]</kbd> or
  2740. <kbd>\*[FWD 2P]</kbd> instead of <kbd>\*[FWD 12p]</kbd>). Preview the
  2741. file again, and notice how the tab structure remains the same, but
  2742. the gutters are wider.
  2743. <p>
  2744. <a name="INDEX_TABS">
  2745. <h3><u>Tabs macro list</u></h3>
  2746. </a>
  2747. <ul>
  2748. <li><a href="#TAB_SET">TAB_SET</a> (create typesetting tabs)
  2749. <li><a href="#INLINE_ST">\*[ST]...\*[STX]</a> (inline escapes for marking String Tabs)
  2750. <li><a href="#ST">ST</a> (set String Tabs)
  2751. <li><a href="#TAB">TAB</a> (call tabs)
  2752. <li><a href="#TN">TN</a> (Tab Next; call next tab in a sequence)
  2753. <li><a href="#TQ">TQ</a> (Tab Quit)
  2754. </ul>
  2755. <!---TAB_SET--->
  2756. <hr width="66%" align="left">
  2757. <a name="TAB_SET"><h3><u>Set up typesetting tabs</u></h3></a>
  2758. <br>
  2759. <nobr>Macro: <strong>TAB_SET</strong> &lt;tab number&gt; &lt;indent&gt; &lt;length&gt; L | R | C | J [ QUAD ]</nobr>
  2760. <br>
  2761. <em>*&lt;indent&gt; and &lt;length&gt; require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  2762. <p>
  2763. <strong>TAB_SET</strong> creates typesetting tabs that later can be
  2764. called with
  2765. <a href="#TAB">TAB</a>.
  2766. Typesetting tabs are numbered, and defined by an indent, a length,
  2767. and a &quot;direction&quot;, hence <strong>TAB_SET</strong> has
  2768. four required arguments:
  2769. <br>
  2770. <ul>
  2771. <li>a tab number
  2772. <li>an indent (measured from the left margin of the page,
  2773. or, if you're already in a tab, from the left margin of the tab)
  2774. <li>a length
  2775. <li>a direction
  2776. </ul>
  2777. <br>
  2778. To set up a centred tab 6 picas long and 9 points from the left
  2779. margin, you'd enter
  2780. <p>
  2781. <pre>
  2782. .TAB_SET 1 9p 6P C
  2783. </pre>
  2784. The tab number in the above (&quot;1&quot;) is simply an
  2785. identifier. It could have been 4, or 17, or 296. There's no
  2786. need to set up tabs in numerical sequence.
  2787. <p>
  2788. By default, tabs are in
  2789. <a href="definitions.html#TERMS_NOFILL">nofill</a>
  2790. mode, meaning you can enter text in tabs on a line-for-line basis
  2791. without having to use the
  2792. <a href="#BR">BR</a>
  2793. macro. If you want a tab to be
  2794. <a href="definitions.html#TERMS_FILLED">filled</a>,
  2795. pass the optional argument <strong>QUAD</strong>, which will
  2796. make the tab behave as if you'd entered <kbd>.QUAD L | R |
  2797. C</kbd>.
  2798. <p>
  2799. For
  2800. <a href="definitions.html#TERMS_JUST">justified</a>
  2801. tabs, simply pass the argument <strong>J</strong> (without the
  2802. <strong>QUAD</strong> argument), like this:
  2803. <p>
  2804. <pre>
  2805. .TAB 1 9p 6P J
  2806. </pre>
  2807. Once tabs are set, they can be called at any time with the
  2808. <a href="#TAB">TAB #</a>
  2809. macro, where &quot;#&quot; is the number of the desired tab.
  2810. <p>
  2811. You can set up any number of typesetting tabs. However, be
  2812. aware that
  2813. <a href="#STRING_TABS">string tabs</a>
  2814. are also called with <strong>TAB #</strong>, so be careful that you
  2815. don't set up a typesetting tab numbered, say, 4, when you already
  2816. have a string tab numbered 4. Every tab, typesetting or string,
  2817. must have a unique numeric identifier.
  2818. <p>
  2819. <strong>NOTE:</strong> If you use <strong>TAB_SET</strong> while
  2820. you're currently inside a tab, the indent argument is the distance from
  2821. the tab's left margin, not the left margin of the page. Therefore,
  2822. you should exit tabs (with
  2823. <a href="#TQ">TQ</a>)
  2824. before creating new tabs (unless, of course, you want to set
  2825. up a tab structure within the confines of an existing tab).
  2826. <p>
  2827. <strong>IMPORTANT:</strong> Turn all indents off (see
  2828. <a href="#INDENTS">Indents</a>)
  2829. before setting up tabs with <strong>TAB_SET</strong>, or
  2830. <strong>mom</strong> may get confused.
  2831. <p>
  2832. <!---INLINE_ST--->
  2833. <hr width="66%" align="left">
  2834. <a name="INLINE_ST"><h3><u>Mark positions of string tabs</u></h3></a>
  2835. <br>
  2836. Inlines: <strong>\*[ST&lt;number&gt;]...\*[ST&lt;number&gt;X]</strong>
  2837. <br>
  2838. <em>*<a href="definitions.html#TERMS_QUAD">Quad</a>
  2839. direction must be LEFT or JUSTIFY (see
  2840. <a href="#QUAD">QUAD</a>
  2841. and
  2842. <a href="#JUSTIFY">JUSTIFY</a>)
  2843. or the
  2844. <a name="definitions.html#TERMS_NOFILL">no-fill mode</a>
  2845. set to
  2846. <a href="#LRC">LEFT</a>.
  2847. Please see
  2848. <a href="#IMPORTANT">IMPORTANT</a>,
  2849. below.</em>
  2850. <p>
  2851. String tabs need to be marked off with
  2852. <a href="definitions.html#TERMS_INLINES">inline escapes</a>
  2853. before being set up with the
  2854. <a href="#ST">ST</a>
  2855. macro. Any input line may contain string tab markers.
  2856. <i>&lt;number&gt;</i>, above, means the numeric identifier of
  2857. the tab. The following shows a sample input line with string
  2858. tab markers.
  2859. <p>
  2860. <pre>
  2861. \*[ST1]Now is the time\*[ST1X] for all \*[ST2]good men\*ST2X] to come to the aid of the party.
  2862. </pre>
  2863. String tab 1 begins at the start of the line and ends after the word
  2864. &quot;time&quot;. String tab 2 starts at &quot;good&quot; and ends
  2865. after &quot;men&quot;. Inline escapes (e.g. font or point size
  2866. changes, or horizontal movements, including
  2867. <a href="goodies.html#PAD">padding</a>)
  2868. are taken into account when <strong>mom</strong> determines the
  2869. position and length of string tabs.
  2870. <p>
  2871. Up to nineteen string tabs may be marked (not necessarily all on
  2872. the same line, of course), and they must be numbered between 1
  2873. and 19.
  2874. <p>
  2875. Once string tabs have been marked in input lines, they have to
  2876. be &quot;set&quot; with
  2877. <a href="#ST">ST</a>,
  2878. after which they may be called, by number, with
  2879. <a href="#TAB">TAB</a>.
  2880. <p>
  2881. <strong>NOTE:</strong> Lines with string tabs marked off in them
  2882. are normal input lines, i.e. they get printed, just like any
  2883. input line. If you want to set up string tabs without the line
  2884. printing, use the
  2885. <a href="#SILENT">SILENT</a>
  2886. macro.
  2887. <p>
  2888. <a name="IMPORTANT"><strong>IMPORTANT:</strong></a>
  2889. Owing to the way groff processes
  2890. <a href="definitions.html#TERMS_INPUTLINE">input lines</a>
  2891. and turns them into
  2892. <a href="definitions.html#TERMS_OUTPUTLINE">output lines</a>,
  2893. it is not possible for <strong>mom</strong> to &quot;guess&quot; the
  2894. correct starting position of string tabs marked off in lines that
  2895. are centered or set flush right.
  2896. <p>
  2897. Equally, she cannot guess the starting position if a line is fully
  2898. justified and broken with
  2899. <a href="#SPREAD">SPREAD</a>.
  2900. <p>
  2901. In other words, in order to use string tabs,
  2902. <a href="#LRC">LEFT</a>
  2903. must be active, or, if
  2904. <a href="#QUAD">QUAD LEFT</a>
  2905. or
  2906. <a href="#JUSTIFY">JUSTIFY</a>
  2907. are active, the line on which the string tabs are marked must be
  2908. broken &quot;manually&quot; with
  2909. <a href="#BR">BR</a>
  2910. (but not
  2911. <a href="#SPREAD">SPREAD</a>).
  2912. <p>
  2913. To circumvent this behaviour, I recommend using the
  2914. <a href="goodies.html#PAD">PAD</a>
  2915. to set up string tabs in centered or flush right lines. Say, for
  2916. example, you want to use a string tab to underscore the text of a
  2917. centered line with a rule. Rather than this,
  2918. <p>
  2919. <pre>
  2920. .CENTER
  2921. \*[ST1]A line of text\*[ST1X]\c
  2922. .EL
  2923. .ST 1
  2924. .TAB 1
  2925. .PT_SIZE 24
  2926. .ALD 3p
  2927. \*[RULE]
  2928. .RLD 3p
  2929. .TQ
  2930. </pre>
  2931. you should do:
  2932. <p>
  2933. <pre>
  2934. .QUAD CENTER
  2935. .PAD "#\*[ST1]A line of text\*[ST1X]#"
  2936. .EL
  2937. .ST 1
  2938. .TAB 1
  2939. .PT_SIZE 24
  2940. .ALD 3p
  2941. \*[RULE] \" Note that you can't use \*[UP ] or \*[DOWN] with \*[RULE]
  2942. .RLD 3p
  2943. .TQ
  2944. </pre>
  2945. <p>
  2946. <!---ST--->
  2947. <hr width="66%" align="left">
  2948. <a name="ST"><h3><u>Set string tabs</u></h3></a>
  2949. <br>
  2950. <nobr>Macro: <strong>ST</strong> &lt;tab number&gt; L | R | C | J [ QUAD ]</nobr>
  2951. <p>
  2952. After string tabs have been marked off on an input line (see
  2953. <a href="#INLINE_ST">\*[ST]...\*[STX]</a>),
  2954. you need to &quot;set&quot; them by giving them a direction
  2955. and, optionally, the <strong>QUAD</strong> argument. In this
  2956. respect, <strong>ST</strong> is like
  2957. <a href="#TAB_SET">TAB_SET</a>
  2958. except that you don't have to give <strong>ST</strong> an indent
  2959. or a line length (that's already taken care of, inline, by
  2960. <kbd>\*[ST]...\*[STX]</kbd>). If you want string tab 1 to be
  2961. left, enter
  2962. <p>
  2963. <pre>
  2964. .ST 1 L
  2965. </pre>
  2966. If you want it to be left and
  2967. <a href="definitions.html#TERMS_FILLED">filled</a>, enter
  2968. <p>
  2969. <pre>
  2970. .ST 1 L QUAD
  2971. </pre>
  2972. If you want it to be justified, enter
  2973. <p>
  2974. <pre>
  2975. .ST 1 J
  2976. </pre>
  2977. See the
  2978. <a href="#STRING_TABS_TUT">Quickie tutorial on string tabs</a>
  2979. for a full explanation of setting up string tabs.
  2980. <p>
  2981. <!---TAB--->
  2982. <hr width="66%" align="left">
  2983. <a name="TAB"><h3><u>Call tabs</u></h3></a>
  2984. <br>
  2985. <nobr>Macro: <strong>TAB</strong> &lt;tab number&gt;</nobr>
  2986. <br>
  2987. Alias: <strong>TB</strong>
  2988. <p>
  2989. After tabs have been defined (either with
  2990. <a href="#TAB_SET">TAB_SET</a>
  2991. or
  2992. <a href="#ST">ST</a>),
  2993. <strong>TAB</strong> moves to whatever tab number you pass it as
  2994. an argument. For example,
  2995. <p>
  2996. <pre>
  2997. .TAB 3
  2998. </pre>
  2999. moves you to tab 3.
  3000. <p>
  3001. <a name="NOTE_TN"></a>
  3002. <strong>NOTE:</strong> <strong>TAB</strong> breaks the line preceding
  3003. it and advances 1 linespace. Hence,
  3004. <p>
  3005. <pre>
  3006. .TAB 1
  3007. A line of text in tab 1.
  3008. .TAB 2
  3009. A line of text in tab 2.
  3010. </pre>
  3011. produces, on output
  3012. <p>
  3013. <pre>
  3014. A line of text in tab 1.
  3015. A line of text in tab 2.
  3016. </pre>
  3017. If you want the tabs to line up, use
  3018. <a href="#TN">TN</a>
  3019. (Tab Next), like this:
  3020. <p>
  3021. <pre>
  3022. .TAB 1
  3023. A line of text in tab 1.
  3024. .TN
  3025. A line of text in tab 2.
  3026. </pre>
  3027. which produces
  3028. <p>
  3029. <pre>
  3030. A line of text in tab 1. A line of text in tab 2.
  3031. </pre>
  3032. If the text in your tabs runs to several lines, and you want the
  3033. first lines of each tab to align, you must use the
  3034. <a href="#MULTI_COLUMNS">multi-column</a> macros.
  3035. <p>
  3036. <strong>ADDITIONAL NOTE:</strong> Any indents in effect prior to
  3037. calling a tab are automatically turned off by <strong>TAB</strong>.
  3038. If you were happily zipping down the page with a left indent of 2
  3039. picas turned on, and you call a tab whose indent from the left margin
  3040. is 6 picas, your new distance from the left margin will be 6 picas,
  3041. not 6 picas plus the 2 pica indent.
  3042. <p>
  3043. <!---TN--->
  3044. <hr width="66%" align="left">
  3045. <a name="TN"><h3><u>Tab Next</u></h3></a>
  3046. <br>
  3047. Macro: <strong>TN</strong>
  3048. <br>
  3049. <em>*In tabs that aren't given the QUAD argument when they're set up
  3050. with
  3051. <a href="#TAB_SET">TAB_SET</a>
  3052. or
  3053. <a href="#ST">ST</a>, you must terminate the line preceding
  3054. <kbd>TN</kbd> with the \c inline escape. See the
  3055. <a href="#TN_NOTE">ADDITIONAL NOTE</a>,
  3056. <br>
  3057. *If you find remembering whether to put in the <kbd>\c</kbd>
  3058. bothersome, you may prefer to use the
  3059. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  3060. alternative to
  3061. <kbd>.TN</kbd>,
  3062. <a href="inlines.html#TB+">\*[TB+]</a>,
  3063. which works consistently regardless of the fill mode.</em>
  3064. <p>
  3065. <strong>TN</strong> moves over to the next tab in numeric
  3066. sequence (tab n+1) without advancing on the page. See the
  3067. <a href="#NOTE_TN">NOTE</a>
  3068. in the description of the <strong>TAB</strong> macro for an
  3069. example of how <strong>TN</strong> works.
  3070. <p>
  3071. <strong>NOTE:</strong> You <em>must</em> put text in the
  3072. <a href="definitions.html#TERMS_INPUTLINE">input line</a>
  3073. immediately after <strong>TN</strong>. &quot;Stacking&quot; of
  3074. <strong>TN</strong>'s is not allowed. In other words, you cannot
  3075. do
  3076. <p>
  3077. <pre>
  3078. .TAB 1
  3079. Some text
  3080. .TN
  3081. Some more text
  3082. .TN
  3083. .TN
  3084. Yet more text
  3085. </pre>
  3086. The above example, assuming tabs numbered from 1 to 4, should be entered
  3087. <p>
  3088. <pre>
  3089. .TAB 1
  3090. Some text
  3091. .TN
  3092. Some more text
  3093. .TAB 4
  3094. Yet more text
  3095. </pre>
  3096. <p>
  3097. <a name="TN_NOTE"><strong>ADDITIONAL NOTE:</strong></a>
  3098. In versions of mom prior to 1.1.9, <strong>TN</strong> did not
  3099. always work as advertised on the last
  3100. <a name="TERMS_OUTPUTLINE">output line</a>
  3101. of pages that contained a footer trap (e.g. one set with
  3102. <a href="#B_MARGIN">B_MARGIN</a>
  3103. or in documents formatted using the
  3104. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>).
  3105. <p>
  3106. <strong>TN</strong> has been re-written so that this should no longer be the
  3107. case. However, in order for it to work in tabs that have not been
  3108. given a <kbd>QUAD</kbd> argument (see
  3109. <a href="#TAB_SET">TAB_SET</a>
  3110. and
  3111. <a href="#ST">ST</a>)
  3112. you must always &quot;join&quot; <strong>.TN</strong> to the line
  3113. before it using the
  3114. <a href="#JOIN">\c</a>
  3115. <a href="definitions.html#TERMS_INLINES">inline escape</a>,
  3116. as in the following example:
  3117. <p>
  3118. <pre>
  3119. .TAB_SET 1 0 1P L
  3120. .TAB_SET 2 1P 20P L
  3121. .TAB 1
  3122. 1.\c
  3123. .TN
  3124. The first rule of survival is &quot;make and keep good friends.&quot;
  3125. </pre>
  3126. When output, the example will look like this:
  3127. <p>
  3128. <pre>
  3129. 1. The first rule of survival is &quot;make and keep good friends.&quot;
  3130. </pre>
  3131. Conversely, if you did give a <kbd>QUAD</kbd> argument
  3132. to <strong>TAB_SET</strong> or <strong>ST</strong>, the
  3133. <strong>\c</strong> must not be used.
  3134. <p>
  3135. <!---TQ--->
  3136. <hr width="66%" align="left">
  3137. <a name="TQ"><h3><u>Tab Quit</u></h3></a>
  3138. <br>
  3139. Macro: <strong>TQ</strong>
  3140. <br>
  3141. <p>
  3142. <strong>TQ</strong> takes you out of whatever tab you were in,
  3143. advances 1 linespace, and restores the left margin, line length,
  3144. quad direction and
  3145. <a href="definitions.html#TERMS_FILLED">fill mode</a>
  3146. that were in effect prior to invoking any tabs.
  3147. <p>
  3148. <hr>
  3149. <!====================================================================>
  3150. <a name="INTRO_MULTI_COLUMNS"></a>
  3151. <a name="MULTI_COLUMNS">
  3152. <h2><u>Multi-Columns</u></h2>
  3153. </a>
  3154. Tabs are not by nature columnar, which is to say that if the text
  3155. inside a tab runs to several lines, calling another tab does not
  3156. automatically move to the
  3157. <a href="definitions.html#TERMS_BASELINE">baseline</a>
  3158. of the first line in the previous tab. To demonstrate:
  3159. <p>
  3160. <pre>
  3161. .TAB 1
  3162. Carrots
  3163. Potatoes
  3164. Broccoli
  3165. .TAB 2
  3166. $1.99/5 lbs
  3167. $0.25/lb
  3168. $0.99/bunch
  3169. </pre>
  3170. produces, on output
  3171. <p>
  3172. <pre>
  3173. Carrots
  3174. Potatoes
  3175. Broccoli
  3176. $1.99/5 lbs
  3177. $0.25/lb
  3178. $0.99/bunch
  3179. </pre>
  3180. The multi-column macros allow you to set tabs in columnar
  3181. fashion, rather than line by line. When you invoke multi-column
  3182. mode (with
  3183. <a href="#MCO">MCO</a>),
  3184. <strong>mom</strong> saves the position of the current baseline.
  3185. <a href="#MCR">MCR</a>
  3186. (Multi-column return) at any point while multi-columns are on
  3187. returns you to the saved position. Exiting multi-columns
  3188. (<a href="#MCX">MCX</a>)
  3189. quits the current tab (if you're in one) and moves you to the
  3190. bottom of the longest column. (Note that you do not have to use
  3191. multi-columns in conjunction with tabs.)
  3192. <p>
  3193. Using our example above, but setting it in multi-column mode,
  3194. <p>
  3195. <pre>
  3196. .MCO
  3197. .TAB 1
  3198. Carrots
  3199. Potatoes
  3200. Broccoli
  3201. .MCR
  3202. .TAB 2
  3203. $1.99/5 lbs
  3204. $0.25/lb
  3205. $0.99/bunch
  3206. .MCX
  3207. </pre>
  3208. produces
  3209. <p>
  3210. <pre>
  3211. Carrots $1.99/5 lbs
  3212. Potatoes $0.25/lb
  3213. Broccoli $0.99/bunch
  3214. </pre>
  3215. <strong>NOTE:</strong> Do not confuse <strong>MCO</strong> with
  3216. the
  3217. <a href="docprocessing.html#COLUMNS">COLUMNS</a>
  3218. macro in the
  3219. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
  3220. <p>
  3221. <a name="INDEX_MULTI_COLUMNS">
  3222. <h3><u>Columns macro list</u></h3>
  3223. </a>
  3224. <ul>
  3225. <li><a href="#MCO">MCO (begin multi-column setting)</a>
  3226. <li><a href="#MCR">MCR (return to top of column)</a>
  3227. <li><a href="#MCX">MCX (exit multi-columns)</a>
  3228. </ul>
  3229. <!---MCO--->
  3230. <hr width="66%" align="left">
  3231. <a name="MCO"><h3><u>Begin multi-column setting</u></h3></a>
  3232. <br>
  3233. Macro: <strong>MCO</strong>
  3234. <br>
  3235. <p>
  3236. <strong>MCO</strong>
  3237. (<strong>M</strong>ulti-<strong>C</strong>olumn <strong>O</strong>n)
  3238. is the macro you use to begin multi-column setting. It marks
  3239. the current
  3240. <a href="definitions.html#TERMS_BASELINE">baseline</a>
  3241. as the top of your columns, for use later with
  3242. <a href="#MCR">MCR</a>. See the
  3243. <a href="#MULTI_COLUMNS">introduction to columns</a>
  3244. for an explanation of multi-columns and some sample
  3245. input.
  3246. <p>
  3247. <strong>NOTE:</strong> Do not confuse <strong>MCO</strong> with
  3248. the
  3249. <a href="docprocessing.html#COLUMNS">COLUMNS</a>
  3250. macro in the
  3251. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
  3252. <p>
  3253. <!---MCR--->
  3254. <hr width="66%" align="left">
  3255. <a name="MCR"><h3><u>Return to top of column</u></h3></a>
  3256. <br>
  3257. Macro: <strong>MCR</strong>
  3258. <br>
  3259. <p>
  3260. Once you've turned multi-columns on (with
  3261. <a href="#MCO">MCO</a>),
  3262. <strong>MCR</strong>, at any time, returns you to the top of
  3263. your columns.
  3264. <p>
  3265. <!---MCX--->
  3266. <hr width="66%" align="left">
  3267. <a name="MCX"><h3><u>Exit multi-columns</u></h3></a>
  3268. <br>
  3269. <nobr>Macro: <strong>MCX</strong> [ &lt;distance to advance below longest column&gt; ]</nobr>
  3270. <br>
  3271. <em>*Optional argument requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  3272. <p>
  3273. <strong>MCX</strong> takes you out of any tab you were in (by silently
  3274. invoking
  3275. <a href="#TQ">TQ</a>) and advances to the bottom of the longest
  3276. column.
  3277. <p>
  3278. Without an argument, <strong>MCX</strong> advances 1 linespace
  3279. below the longest column. Linespace, in this instance, is the
  3280. <a href="definitions.html#TERMS_LEADING">leading</a>
  3281. in effect <em>at the moment <strong>MCX</strong> is
  3282. invoked.</em>
  3283. <p>
  3284. If you pass the <nobr>&lt;distance&gt; argument to</nobr>
  3285. <strong>MCX</strong>, it advances 1 linespace below the longest
  3286. column (see above) PLUS the distance specified by the argument.
  3287. The argument requires a unit of measure; therefore, to advance
  3288. an extra 6 points below where <strong>MCX</strong> would
  3289. normally place you, you'd enter
  3290. <p>
  3291. <pre>
  3292. .MCX 6p
  3293. </pre>
  3294. <strong>NOTE:</strong> If you wish to advance a precise distance
  3295. below the
  3296. <a href="definitions.html#TERMS_BASELINE">baseline</a>
  3297. of the longest column, use <strong>MCX</strong> with an
  3298. argument of 0 (zero; no unit of measure required) in conjunction
  3299. with the
  3300. <a href="#ALD">ALD</a>
  3301. macro, like this:
  3302. <p>
  3303. <pre>
  3304. .MCX 0
  3305. .ALD 24p
  3306. </pre>
  3307. The above advances to precisely 24 points below the baseline
  3308. of the longest column.
  3309. <p>
  3310. <hr>
  3311. <!====================================================================>
  3312. <a name="INTRO_INDENTS"></a>
  3313. <a name="INDENTS">
  3314. <h2><u>Indents</u></h2>
  3315. </a>
  3316. With <strong>mom</strong>'s indents, you can indent from the left,
  3317. the right, or both margins. In addition, <strong>mom</strong>
  3318. provides temporary left indents (i.e. only one line is indented,
  3319. as at the start of a paragraph) and &quot;hanging&quot; left indents
  3320. (the reverse of a temporary indent; the first line isn't indented,
  3321. subsequent lines are).
  3322. <p>
  3323. <a name="INDENTS_TUT"><h3><u>A brief explanation of how mom handles indents</u></h3></a>
  3324. <p>
  3325. <strong>Mom</strong> provides five kinds of indents: left, right,
  3326. both, temporary, and hanging. Each is invoked by its own name:
  3327. <br>
  3328. <ul>
  3329. <li><strong>IL</strong> = <strong>I</strong>ndent <strong>L</strong>eft
  3330. <li><strong>IR</strong> = <strong>I</strong>ndent <strong>R</strong>ight
  3331. <li><strong>IB</strong> = <strong>I</strong>ndent <strong>B</strong>oth
  3332. <li><strong>HI</strong> = <strong>H</strong>anging <strong>I</strong>ndent
  3333. <li><strong>TI</strong> = <strong>T</strong>emporary <strong>I</strong>ndent
  3334. </ul>
  3335. <br>
  3336. In addition, there are four macros to control exiting from
  3337. indents:
  3338. <br>
  3339. <ul>
  3340. <li><strong>IQ</strong>&nbsp;&nbsp;= quit all active indents
  3341. <li><strong>ILX</strong>&nbsp;= exit indent style left
  3342. <li><strong>IRX</strong>&nbsp;= exit indent style right
  3343. <li><strong>IBX</strong>&nbsp;= exit indent style both
  3344. </ul>
  3345. <br>
  3346. This section deals exclusively with <strong>IL, IR</strong> and
  3347. <strong>IB</strong>. For an explanation
  3348. of hanging and temporary indents -- how they work and how to use
  3349. them -- see
  3350. <a href="#HI">Hanging indents</a>
  3351. and
  3352. <a href="#TI">Temporary indents</a>.
  3353. <p>
  3354. The first time you invoke any of <strong>mom</strong>'s indents,
  3355. you must supply a measure. For example,
  3356. <p>
  3357. <pre>
  3358. .IL 2P
  3359. </pre>
  3360. indents text 2 picas from the left margin (or current tab
  3361. indent).
  3362. <p>
  3363. When you want to exit the above indent, use either
  3364. <p>
  3365. <pre>
  3366. .IQ
  3367. or
  3368. .ILX
  3369. </pre>
  3370. The next time you want the same indent, invoke it without the
  3371. argument, like this:
  3372. <p>
  3373. <pre>
  3374. .IL
  3375. </pre>
  3376. As you can see, once you've supplied a measure to an indent macro
  3377. <strong>mom</strong> stores the value, obviating the need to repeat
  3378. it on subsequent invocations. And <strong>mom</strong> doesn't just
  3379. store the measure -- she hangs on to it tenaciously. Arguments passed
  3380. to <strong>IL, IR</strong> and <strong>IB</strong> are additive.
  3381. Consider the following:
  3382. <p>
  3383. <pre>
  3384. .LL 20P
  3385. .IR 2P \"Indent right by 2 picas
  3386. A first block of text...
  3387. ...
  3388. ...
  3389. .IQ \"Turn indent off
  3390. A second block of text...
  3391. ...
  3392. ...
  3393. .IR 2P \"Indent right by an additional 2 picas (i.e. 4 picas)
  3394. A third block of text...
  3395. ...
  3396. ...
  3397. </pre>
  3398. The first block of text is right indented by 2 picas (i.e. the line
  3399. length is shortened by 2 picas to 18 picas). The second block of
  3400. text, after <strong>IQ</strong>, is, as you'd expect, set to the full
  3401. measure. The third block of text -- the one to pay attention to --
  3402. is not right indented by 2 picas, but rather by 4 picas.
  3403. <strong>Mom</strong> adds the value of arguments to <strong>IL,
  3404. IR</strong> and <strong>IB</strong> to whatever value is already
  3405. in effect.
  3406. <p>
  3407. If you wanted the third block of text in the example above to
  3408. be right indented by just 2 picas (the original measure given to
  3409. <strong>IR</strong>), you would enter <kbd>.IR</kbd> without an
  3410. argument.
  3411. <p>
  3412. Because indent arguments are additive, putting a minus sign in front
  3413. of the argument can be used to subtract from the current value.
  3414. In the following example, the first line is indented 18 points, the
  3415. second is indented 36 points (18+18), and the third is again indented
  3416. 18 points (36-18).
  3417. <p>
  3418. <pre>
  3419. .IL 18p \"Indent left by 18 points = 18 points
  3420. Now is the time
  3421. .IL 18p \"Indent left by 18 points more = 36 points
  3422. for all good men to come
  3423. .IL -18p \"Indent left by 18 points less = 18 points
  3424. to the aid of the party.
  3425. </pre>
  3426. Sometimes, you may want to clear out the stored indent values -- let
  3427. <strong>mom</strong> start indenting with a clean slate, as it were.
  3428. Giving the optional argument <kbd>CLEAR</kbd> to any of the
  3429. &quot;indent quit&quot; macros resets them to zero.
  3430. <br>
  3431. <ul>
  3432. <li><strong>IQ CLEAR</strong>&nbsp;&nbsp;= quit and clear all indents
  3433. <li><strong>ILX CLEAR</strong>&nbsp;= quit and clear indent style left
  3434. <li><strong>IRX CLEAR</strong>&nbsp;= quit and clear indent style right
  3435. <li><strong>IBX CLEAR</strong>&nbsp;= quit and clear indent style both
  3436. </ul>
  3437. <br>
  3438. Indent styles may be combined and manipulated separately. You could,
  3439. for example, have a left indent of 4 picas and a right indent of 6
  3440. picas and control each separately, as in the following example.
  3441. <p>
  3442. <pre>
  3443. .IL 4P \"Indent left 4 picas
  3444. .IR 6P \"Indent right 6 picas
  3445. Some text
  3446. .IRX \"Turn off the right indent only
  3447. More text \"Text is still indented 4 picas left
  3448. </pre>
  3449. If, at <kbd>.IRX</kbd>, you wanted the text afterwards to have no
  3450. indents (either left or right), you would enter <kbd>.IQ</kbd>,
  3451. which exits all indent styles at once.
  3452. <p>
  3453. <strong>A word of advice:</strong> Indents are best used only when
  3454. you have a compelling reason not to change the current left margin or
  3455. line length. In many instances where indents might seem expedient,
  3456. it's better to use tabs, or actually change the left margin or the
  3457. line length. <strong>Mom</strong>'s indenting macros are flexible
  3458. and powerful, but easy to get tangled up in. Personally, I don't
  3459. use them much, except for cutarounds and multi-level lists ŕ la html,
  3460. at which they excel.
  3461. <p>
  3462. <strong>NOTE:</strong> see the section
  3463. <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a>
  3464. for information and advice on using indents with the
  3465. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>.
  3466. <p>
  3467. <a name="INDEX_INDENTS"><h3><u>Indents macro list</u></h3>
  3468. <ul>
  3469. <li><a href="#IL">IL</a>&nbsp;&nbsp;(Indent left)
  3470. <li><a href="#IR">IR</a>&nbsp;&nbsp;(Indent right)
  3471. <li><a href="#IB">IB</a>&nbsp;&nbsp;(Indent both)
  3472. <li><a href="#TI">TI</a>&nbsp;&nbsp;(Temporary indent, left)
  3473. <li><a href="#HI">HI</a>&nbsp;&nbsp;(Hanging Indent)
  3474. <ul>
  3475. <li><a href="#NUM_LISTS">A recipe for numbered lists</a>
  3476. </ul>
  3477. <li><a href="#IQ">IQ</a>&nbsp;&nbsp;(Quit indents, all)
  3478. <li><a href="#IQ">ILX</a>&nbsp;(Exit indent style left)
  3479. <li><a href="#IQ">IRX</a>&nbsp;(Exit indent style right)
  3480. <li><a href="#IQ">IBX</a>&nbsp;(Exit indent style both)
  3481. </ul>
  3482. <!---IL--->
  3483. <hr width="66%" align="left">
  3484. <a name="IL"><h3><u>Indent left</u></h3></a>
  3485. <br>
  3486. <nobr>Macro: <strong>IL</strong> [ &lt;measure&gt; ]</nobr>
  3487. <br>
  3488. <em>*The optional argument requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  3489. <p>
  3490. <strong>IL</strong> indents text from the left margin of the page,
  3491. or if you're in a tab, from the left edge of the tab. Once
  3492. <strong>IL</strong> is on, the left indent is applied uniformly to
  3493. every subsequent line of text, even if you change the line length.
  3494. <p>
  3495. The first time you invoke <strong>IL</strong>, you must give it a
  3496. measure. Subsequent invocations with a measure add to the previous
  3497. measure. A minus sign may be prepended to the argument to subtract
  3498. from the current measure. The
  3499. <a href="inlines.html#INLINE_STRINGWIDTH_GROFF">\w</a>
  3500. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  3501. may be used to specify a text-dependent measure, in which case
  3502. no unit of measure is required. For example,
  3503. <p>
  3504. <pre>
  3505. .IL \w'margarine'
  3506. </pre>
  3507. indents text by the width of the word &quot;margarine&quot;.
  3508. <p>
  3509. With no argument, <strong>IL</strong> indents by its last
  3510. active value. See the
  3511. <a href="#INDENTS_TUT">brief explanation of how mom handles indents</a>
  3512. for more details.
  3513. <p>
  3514. <strong>NOTE:</strong> Calling a tab (with
  3515. <a href="#TAB">TAB</a>)
  3516. automatically cancels any active indents.
  3517. <p>
  3518. <strong>ADDITIONAL NOTE:</strong> Invoking <strong>IL</strong>
  3519. automatically turns off <strong>IB</strong>.
  3520. <p>
  3521. <!---IR--->
  3522. <hr width="66%" align="left">
  3523. <a name="IR"><h3><u>Indent right</u></h3></a>
  3524. <br>
  3525. <nobr>Macro: <strong>IR</strong> [ &lt;measure&gt; ]</nobr>
  3526. <br>
  3527. <em>*The optional argument requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  3528. <p>
  3529. <strong>IR</strong> indents text from the right margin of the
  3530. page, or if you're in a tab, from the end of the tab.
  3531. <p>
  3532. The first time you invoke <strong>IR</strong>, you must give it a
  3533. measure. Subsequent invocations with a measure add to the previous
  3534. indent measure. A minus sign may be prepended to the argument to
  3535. subtract from the current indent measure. The
  3536. <a href="inlines.html#INLINE_STRINGWIDTH_GROFF">\w</a>
  3537. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  3538. may be used to specify a text-dependent measure, in which case
  3539. no unit of measure is required. For example,
  3540. <p>
  3541. <pre>
  3542. .IR \w'jello'
  3543. </pre>
  3544. indents text by the width of the word &quot;jello&quot;.
  3545. <p>
  3546. With no argument, <strong>IR</strong> indents by its last
  3547. active value. See the
  3548. <a href="#INDENTS_TUT">brief explanation of how mom handles indents</a>
  3549. for more details.
  3550. <p>
  3551. <strong>NOTE:</strong> Calling a tab (with
  3552. <a href="#TAB">TAB</a>)
  3553. automatically cancels any active indents.
  3554. <p>
  3555. <strong>ADDITIONAL NOTE:</strong> Invoking <strong>IR</strong>
  3556. automatically turns off <strong>IB</strong>.
  3557. <p>
  3558. <!---IB--->
  3559. <hr width="66%" align="left">
  3560. <a name="IB"><h3><u>Indent both</u></h3></a>
  3561. <br>
  3562. <nobr>Macro: <strong>IB</strong> [ &lt;left measure&gt; &lt;right measure&gt; ]</nobr>
  3563. <br>
  3564. <em>*The optional arguments require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  3565. <p>
  3566. <strong>IB</strong> allows you to set or invoke a left and a right
  3567. indent at the same time.
  3568. <p>
  3569. At its first invocation, you must supply a measure for both indents;
  3570. at subsequent invocations when you wish to supply a measure, both must
  3571. be given again. As with <strong>IL</strong> and <strong>IR</strong>,
  3572. the measures are added to the values previously passed to the macro.
  3573. Hence, if you wish to change just one of the values, you must
  3574. give an argument of zero to the other.
  3575. <p>
  3576. <strong>A word of advice:</strong> If you need to manipulate left and
  3577. right indents separately, use a combination of <strong>IL</strong>
  3578. and <strong>IR</strong> instead of <strong>IB</strong>. You'll
  3579. save yourself a lot of grief.
  3580. <p>
  3581. A minus sign may be prepended to the arguments to subtract from their
  3582. current values. The
  3583. <a href="inlines.html#INLINE_STRINGWIDTH_GROFF">\w</a>
  3584. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  3585. may be used to specify text-dependent measures, in which case
  3586. no unit of measure is required. For example,
  3587. <p>
  3588. <pre>
  3589. .IB \w'margarine' \w'jello'
  3590. </pre>
  3591. left indents text by the width of the word &quot;margarine&quot;
  3592. and right indents by the width of &quot;jello&quot;.
  3593. <p>
  3594. Like <strong>IL</strong> and <strong>IR</strong>, <strong>IB</strong>
  3595. with no argument indents by its last active values. See the
  3596. <a href="#INDENTS_TUT">brief explanation of how mom handles indents</a>
  3597. for more details.
  3598. <p>
  3599. <strong>NOTE:</strong> Calling a tab (with
  3600. <a href="#TAB">TAB</a>)
  3601. automatically cancels any active indents.
  3602. <p>
  3603. <strong>ADDITIONAL NOTE:</strong> Invoking <strong>IB</strong>
  3604. automatically turns off <strong>IL</strong> and
  3605. <strong>IR</strong>.
  3606. <p>
  3607. <!---TI--->
  3608. <hr width="66%" align="left">
  3609. <a name="TI"><h3><u>Temporary (left) indent</u></h3></a>
  3610. <br>
  3611. <nobr>Macro: <strong>TI</strong> [ &lt;measure&gt; ]</nobr>
  3612. <br>
  3613. <em>*The optional argument requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  3614. <p>
  3615. A temporary indent is one that applies only to the first line of
  3616. text that comes after it. Its chief use is indenting the first
  3617. line of paragraphs. (<strong>Mom</strong>'s
  3618. <a href="docprocessing.html#PP">PP</a>
  3619. macro, for example, uses a temporary indent.)
  3620. <p>
  3621. The first time you invoke <strong>TI</strong>, you must give it
  3622. a measure. If you want to indent the first line of a
  3623. paragraph by, say, 2
  3624. <a href="definitions.html#TERMS_EM">ems</a>,
  3625. do
  3626. <p>
  3627. <pre>
  3628. .TI 2m
  3629. </pre>
  3630. Subsequent invocations of <strong>TI</strong> do not require you
  3631. to supply a measure; <strong>mom</strong> keeps track of the
  3632. last measure you gave it.
  3633. <p>
  3634. Because temporary indents are temporary, there's no need to turn
  3635. them off.
  3636. <p>
  3637. <strong>IMPORTANT:</strong> Unlike <strong>IL, IR</strong> and
  3638. <strong>IB</strong>, measures given to <strong>TI</strong>
  3639. are NOT additive. In the following example, the second <kbd>.TI
  3640. 2P</kbd> is exactly 2 picas.
  3641. <p>
  3642. <pre>
  3643. .TI 1P
  3644. The beginning of a paragraph...
  3645. .TI 2P
  3646. The beginning of another paragraph...
  3647. </pre>
  3648. <!---HI--->
  3649. <hr width="66%" align="left">
  3650. <a name="HI"><h3><u>Hanging indent</u></h3></a>
  3651. <br>
  3652. <nobr>Macro: <strong>HI</strong> [ &lt;measure&gt; ]</nobr>
  3653. <br>
  3654. <em>*The optional argument requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
  3655. <p>
  3656. A hanging indent looks like this:
  3657. <p>
  3658. <pre>
  3659. The thousand injuries of Fortunato I had borne as best I
  3660. could, but when he ventured upon insult, I vowed
  3661. revenge. You who so well know the nature of my soul
  3662. will not suppose, however, that I gave utterance to a
  3663. threat, at length I would be avenged...
  3664. </pre>
  3665. The first line of text &quot;hangs&quot; outside the left
  3666. margin.
  3667. <p>
  3668. In order to use hanging indents, you must first have a left indent
  3669. active (set with either
  3670. <a href="#IL">IL</a>
  3671. or
  3672. <a href="#IB">IB</a>).
  3673. <strong>Mom</strong> will not hang text outside the left margin set with
  3674. <a href="#L_MARGIN">L_MARGIN</a>
  3675. or outside the left margin of a tab.
  3676. <p>
  3677. The first time you invoke <strong>HI</strong>, you must give it
  3678. a measure. If you want the first line of a paragraph to hang by,
  3679. say, 1 pica, do
  3680. <p>
  3681. <pre>
  3682. .IL 1P
  3683. .HI 1P
  3684. </pre>
  3685. Subsequent invocations of <strong>HI</strong> do not require you
  3686. to supply a measure; <strong>mom</strong> keeps track of the
  3687. last measure you gave it.
  3688. <p>
  3689. Generally speaking, you should invoke <strong>HI</strong> immediately
  3690. prior to the line you want hung (i.e. without any intervening
  3691. <a href="definitions.html#TERMS_CONTROLLINES">control lines</a>).
  3692. And because hanging indents affect only one line, there's no need to turn
  3693. them off.
  3694. <p>
  3695. <a name="NUM_LISTS"><h3><u>A recipe for numbered lists</u></h3></a>
  3696. <p>
  3697. <strong>PLEASE NOTE: mom</strong> now has macros for setting lists (see
  3698. <a href="docelement.html#LIST_INTRO">Nested lists</a>),
  3699. making this recipe superfluous. It remains here in the hope that
  3700. it will clarify the use of hanging indents generally, if no longer
  3701. specifically.
  3702. <p>
  3703. Consider the following example:
  3704. <p>
  3705. <pre>
  3706. .PAGE 8.5i 11i 1i 1i 1i 1i
  3707. .FAMILY T
  3708. .FT R
  3709. .PT_SIZE 12
  3710. .LS 14
  3711. .JUSTIFY
  3712. .KERN
  3713. .SS 0
  3714. .IL \w'\0\0.' \"Indent left by 2 figure spaces and a period
  3715. .HI \w'\0\0.' \"Hang first line of text back by 2 figure spaces and a period
  3716. 1.\0The most important point to be considered is whether the
  3717. answer to the meaning of life, the universe, and everything
  3718. really is 42. We have no-one's word on the subject except
  3719. Mr. Adams'.
  3720. .HI
  3721. 2.\0If the answer to the meaning of life, the universe,
  3722. and everything is indeed 42, what impact does this have on
  3723. the politics of representation? 42 is, after all not a
  3724. prime number. Are we to infer that prime numbers don't
  3725. deserve equal rights and equal access in the universe?
  3726. .HI
  3727. 3.\0If 42 is deemed non-exclusionary, how do we present it
  3728. as the answer and, at the same time, forestall debate on its
  3729. exclusionary implications?
  3730. </pre>
  3731. First, we invoke a left indent with a measure equal to the width
  3732. of 2
  3733. <a href="definitions.html#TERMS_FIGURESPACE">figures spaces</a>
  3734. plus a period (using the
  3735. <a href="inlines.html#INLINE_STRINGWIDTH_GROFF">\w</a>
  3736. inline escape). At this point, the left indent is active; text
  3737. afterwards would normally be indented. However, we invoke a hanging
  3738. indent of exactly the same width, which hangs the first line (and
  3739. first line only!) to the left of the indent by the same distance
  3740. (in this case, that means &quot;out to the left margin&quot;).
  3741. Because we begin the first line with a number, a period, and a
  3742. figure space, the actual text (&quot;The most important point...&quot;)
  3743. starts at exactly the same spot as the indented lines that
  3744. follow.
  3745. <p>
  3746. Notice that subsequent invocations of <strong>HI</strong> without a
  3747. measure produce exactly the same effect.
  3748. <p>
  3749. Paste the example above into a file and preview it with <kbd>groff -mom -X
  3750. &lt;filename&gt;</kbd> to see hanging indents in action.
  3751. <p>
  3752. <strong>IMPORTANT:</strong> Unlike <strong>IL, IR</strong> and
  3753. <strong>IB</strong>, measures given to <strong>HI</strong>
  3754. are NOT additive. Each time you pass a measure to
  3755. <strong>HI</strong>, the measure is treated literally.
  3756. <p>
  3757. <!---IX--->
  3758. <hr width="66%" align="left">
  3759. <a name="IQ"><h3><u>Quitting indents</u></h3></a>
  3760. <br>
  3761. <nobr>Macro: <strong>IQ</strong>&nbsp;&nbsp;[ CLEAR ]&nbsp;&nbsp;(quit any/all indents -- see <strong>*IMPORTANT NOTE</strong>)</nobr>
  3762. <br>
  3763. <nobr>Macro: <strong>ILX</strong>&nbsp;[ CLEAR ]&nbsp;&nbsp;(exit <strong>I</strong>ndent <strong>L</strong>eft)</nobr>
  3764. <br>
  3765. <nobr>Macro: <strong>IRX</strong>&nbsp;[ CLEAR ]&nbsp;&nbsp;(exit <strong>I</strong>ndent <strong>R</strong>ight)</nobr>
  3766. <br>
  3767. <nobr>Macro: <strong>IBX</strong>&nbsp;[ CLEAR ]&nbsp;&nbsp;(exit <strong>I</strong>ndent <strong>B</strong>oth)</nobr>
  3768. <p>
  3769. <strong>*IMPORTANT NOTE:</strong>
  3770. <br>
  3771. &nbsp;&nbsp;&nbsp;&nbsp;<em>Formerly, the macro for quitting all indents was</em>
  3772. <strong>.IX</strong><em>. This usage is now deprecated, in favour
  3773. of</em> <strong>.IQ</strong><em>.</em> <strong>.IX</strong> <em>will
  3774. continue to behave as before, but</em> <strong>mom</strong> <em>will
  3775. issue a warning to stderr indicating that you should update your
  3776. documents.
  3777. <br>
  3778. &nbsp;&nbsp;&nbsp;&nbsp;As a consequence of this change,</em>
  3779. <strong>ILX, IRX</strong> <em>and</em> <strong>IBX</strong> <em>may
  3780. now also be invoked as</em> <strong>ILQ, IRQ</strong> <em>and</em>
  3781. <strong>IBQ</strong><em>. Both forms are acceptable.</em>
  3782. <p>
  3783. Without an argument, the macros to quit indents merely restore your
  3784. original margins and line length. The measures stored in the
  3785. indent macros themselves are saved so you can call them again without
  3786. having to supply a measure.
  3787. <p>
  3788. If you pass these macros the optional argument <strong>CLEAR</strong>,
  3789. they not only restore your original left margin and line length,
  3790. but also clear any values associated with a particular indent style.
  3791. The next time you need an indent of the same style, you have to supply
  3792. a measure again.
  3793. <p>
  3794. <strong>IQ CLEAR</strong>, as you'd suspect, quits and clears
  3795. the values for all indent styles at once.
  3796. <p>
  3797. <hr>
  3798. <a href="goodies.html#TOP">Next</a>&nbsp;&nbsp;
  3799. <a href="definitions.html#TOP">Prev</a>&nbsp;&nbsp;
  3800. <a href="#TOP">Top</a>&nbsp;&nbsp;
  3801. <a href="toc.html">Back to Table of Contents</a>
  3802. </body>
  3803. </html>