Home | History | Annotate | Line # | Download | only in momdoc
      1  1.1  christos <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
      2  1.1  christos <html>
      3  1.1  christos <head>
      4  1.1  christos <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
      5  1.1  christos <title>Mom -- Goodies</title>
      6  1.1  christos </head>
      7  1.1  christos <body bgcolor="#dfdfdf">
      8  1.1  christos 
      9  1.1  christos <!====================================================================>
     10  1.1  christos 
     11  1.1  christos <a href="inlines.html#TOP">Next</a>&nbsp;&nbsp;
     12  1.1  christos <a href="typesetting.html#TOP">Prev</a>&nbsp;&nbsp;
     13  1.1  christos <a href="toc.html">Back to Table of Contents</a>
     14  1.1  christos <p>
     15  1.1  christos <a name="TOP"></a>
     16  1.1  christos <a name="GOODIES">
     17  1.1  christos 	<h1 align="center"><u>Goodies</u></h1>
     18  1.1  christos </a>
     19  1.1  christos <p>
     20  1.1  christos <a name="INTRO_GOODIES"></a>
     21  1.1  christos The macros in this section are a collection of useful (and sometimes
     22  1.1  christos nearly indispensable) routines to simplify typesetting.
     23  1.1  christos <p>
     24  1.1  christos <a name="INDEX_GOODIES">
     25  1.1  christos 	<h3><u>Goodies list</u></h3>
     26  1.1  christos </a>
     27  1.1  christos 
     28  1.1  christos <ul>
     29  1.1  christos 	<li><a href="#ALIAS">ALIAS</a> (rename macros)
     30  1.1  christos 	<li><a href="#SILENT">SILENT</a> (&quot;hide&quot; input lines from output)
     31  1.1  christos 	<li><a href="#TRAP">TRAP</a> (suspend/re-invoke traps)
     32  1.1  christos 	<li><a href="#SMARTQUOTES">SMARTQUOTES</a> (convert typewriter doublequotes to proper doublequotes)
     33  1.1  christos 	<li><a href="#CAPS">CAPS</a> (convert to upper case)
     34  1.1  christos 	<li><a href="#STRING">STRING</a> (user-definable strings)
     35  1.1  christos 	<br>
     36  1.1  christos 	<li><strong>Underscore/underline</strong>
     37  1.1  christos 	<ul>
     38  1.1  christos 		<li><a href="#UNDERSCORE">UNDERSCORE</a> (single underscore)
     39  1.1  christos 		<li><a href="#UNDERSCORE2">UNDERSCORE2</a> (double underscore)
     40  1.1  christos 		<li><a href="#UNDERLINE">UNDERLINE</a> (underline -- Courier only!)
     41  1.1  christos 		<li><a href="#UL">\*[UL]</a> (inline escape to underline -- Courier only!)
     42  1.1  christos 	</ul>
     43  1.1  christos 	<li><strong>Padding</strong>
     44  1.1  christos 	<ul>
     45  1.1  christos 		<li><a href="#PAD">PAD</a> (insert equalized space into lines)
     46  1.1  christos 		<li><a href="#PAD_MARKER">PAD_MARKER</a> (change/set the marker used with <strong>PAD</strong>)
     47  1.1  christos 	</ul>
     48  1.1  christos 	<li><strong>Leaders</strong>
     49  1.1  christos 	<ul>
     50  1.1  christos 		<li><a href="#LEADER">\*[LEADER]</a> (inline escape to add leaders to a line)
     51  1.1  christos 		<li><a href="#LEADER_CHARACTER">LEADER_CHARACTER</a> (change/set the leader character)
     52  1.1  christos 	</ul>
     53  1.1  christos 	<li><strong>Drop caps</strong>
     54  1.1  christos 	<ul>
     55  1.1  christos 		<li><a href="#DROPCAP">DROPCAP</a> (set a drop cap)
     56  1.1  christos 		<li><strong>Support macros for DROPCAP</strong>
     57  1.1  christos 		<ul>
     58  1.1  christos 			<li><a href="#DROPCAP_FAMILY">DROPCAP_FAMILY</a> (change drop cap family)
     59  1.1  christos 			<li><a href="#DROPCAP_FONT">DROPCAP_FONT</a> (change drop cap font)
     60  1.1  christos 			<li><a href="#DROPCAP_ADJUST">DROPCAP_ADJUST</a> (alter size of drop cap)
     61  1.1  christos 			<li><a href="#DROPCAP_COLOR">DROPCAP_COLOR</a> (change colour of drop cap) 
     62  1.1  christos 			<li><a href="#DROPCAP_GUTTER">DROPCAP_GUTTER</a> (change space between drop cap and running text) 
     63  1.1  christos 		</ul>
     64  1.1  christos 	</ul>
     65  1.1  christos 	<li><strong>Superscripts</strong>
     66  1.1  christos 	<ul>
     67  1.1  christos 		<li><a href="#SUP">\*[SUP]</a> (set superscript)
     68  1.1  christos 		<li><a href="#CONDSUP">\*[CONDSUP]</a> (set condensed superscript)
     69  1.1  christos 		<li><a href="#EXTSUP">\*[EXTSUP]</a> (set extended superscript)
     70  1.1  christos 	</ul>
     71  1.1  christos 	<li><strong>Lists</strong>
     72  1.1  christos 	<ul>
     73  1.1  christos 		<li><a href="docelement.html#LIST_INTRO">Introduction to lists</a>
     74  1.1  christos 		<li><a href="docelement.html#LIST">LIST</a>
     75  1.1  christos 		<li><a href="docelement.html#ITEM">ITEM</a>
     76  1.1  christos 		<li><a href="docelement.html#SHIFT_LIST">SHIFT_LIST</a>
     77  1.1  christos 		<li><a href="docelement.html#RESET_LIST">RESET_LIST</a>
     78  1.1  christos 		<li><a href="docelement.html#PAD_LIST_DIGITS">PAD_LIST_DIGITS</a>
     79  1.1  christos 	</ul>
     80  1.1  christos </ul>
     81  1.1  christos 
     82  1.1  christos <!---ALIAS--->
     83  1.1  christos 
     84  1.1  christos <hr width="66%" align="left">
     85  1.1  christos <a name="ALIAS"><h3><u>Rename macros</u></h3></a>
     86  1.1  christos <br>
     87  1.1  christos <nobr>Macro: <strong>ALIAS</strong> &lt;new name&gt; &lt;old name&gt;</nobr>
     88  1.1  christos 
     89  1.1  christos <p>
     90  1.1  christos The <strong>ALIAS</strong> macro may well be your best friend.  With it,
     91  1.1  christos you can change the name of a macro to anything you like
     92  1.1  christos (provided the new name is not already being used by
     93  1.1  christos <strong>mom</strong>; see the
     94  1.1  christos <a href="reserved.html#RESERVED">list of reserved words</a>).
     95  1.1  christos <p>
     96  1.1  christos Groff has always been a bit intimidating for new users because
     97  1.1  christos its standard macro packages use very terse macro names.
     98  1.1  christos <strong>Mom</strong> doesn't like people to feel intimidated; she wants
     99  1.1  christos them to feel welcome.  Consequently, she tries for easy-to-grasp,
    100  1.1  christos self-explanatory macro names.  However, <strong>mom</strong> knows
    101  1.1  christos that people have their own ways of thinking, their own preferences,
    102  1.1  christos their own habits.  Some of her macro names may not suit you; they
    103  1.1  christos might be too long, or aren't what you automatically think of
    104  1.1  christos when you want to do a particular thing, or might conflict with habits
    105  1.1  christos you've developed over the years.
    106  1.1  christos <p>
    107  1.1  christos If you don't like one of <strong>mom</strong>'s macro names,
    108  1.1  christos say, PAGEWIDTH, change it, like this:
    109  1.1  christos <p>
    110  1.1  christos <pre>
    111  1.1  christos 	.ALIAS PW PAGEWIDTH
    112  1.1  christos 	       |      |
    113  1.1  christos 	  new__|      |__official
    114  1.1  christos 	 name            name
    115  1.1  christos </pre>
    116  1.1  christos 
    117  1.1  christos The first argument to <strong>ALIAS</strong> is the new name you want
    118  1.1  christos for a macro.  The second is the &quot;official&quot; name by
    119  1.1  christos which the macro is normally invoked.  After <strong>ALIAS</strong>,
    120  1.1  christos either can be used.
    121  1.1  christos <p>
    122  1.1  christos Note that in <strong>ALIAS</strong>, you do NOT include the period
    123  1.1  christos (dot) that precedes the macro when it's a
    124  1.1  christos <a href="definitions.html#TERMS_CONTROLLINES">control line</a>.
    125  1.1  christos <p>
    126  1.1  christos <strong>NOTE:</strong> If you use <strong>ALIAS</strong> a lot,
    127  1.1  christos and always for the same things, consider creating an aliases
    128  1.1  christos file of the form
    129  1.1  christos <p>
    130  1.1  christos <pre>
    131  1.1  christos 	.ALIAS &lt;new name&gt; &lt;old name&gt;
    132  1.1  christos 	.ALIAS &lt;new name&gt; &lt;old name&gt;
    133  1.1  christos 	.ALIAS &lt;new name&gt; &lt;old name&gt;
    134  1.1  christos 	...etc
    135  1.1  christos </pre>
    136  1.1  christos 
    137  1.1  christos Put the file someplace convenient and source it at the
    138  1.1  christos beginning of your documents using the groff
    139  1.1  christos <a href="definitions.html#TERMS_PRIMITIVES">primitive</a>
    140  1.1  christos <strong>.so</strong>.  Assuming that you've created an aliases file
    141  1.1  christos called mom_aliases in your home directory under a directory
    142  1.1  christos called <code>Mom</code>, you'd source it by placing
    143  1.1  christos <p>
    144  1.1  christos <pre>
    145  1.1  christos 	.so /home/&lt;username&gt;/Mom/mom_aliases
    146  1.1  christos </pre>
    147  1.1  christos 
    148  1.1  christos at the top of your documents.
    149  1.1  christos <p>
    150  1.1  christos If you share documents that make use of an alias file, remember that
    151  1.1  christos other people don't have the file!  Paste the whole thing at the top
    152  1.1  christos of your documents, please.
    153  1.1  christos <p>
    154  1.1  christos <strong>EXPERTS:</strong> <strong>ALIAS</strong> is an alias of
    155  1.1  christos <code>.als</code>.  You can use either, or mix 'n' match with
    156  1.1  christos impunity.
    157  1.1  christos <p>
    158  1.1  christos 
    159  1.1  christos <!---SILENT--->
    160  1.1  christos 
    161  1.1  christos <hr width="66%" align="left">
    162  1.1  christos <a name="SILENT"><h3><u>Hide input lines from output</u></h3></a>
    163  1.1  christos <br>
    164  1.1  christos <nobr>Macro: <strong>SILENT</strong> toggle</nobr>
    165  1.1  christos <br>
    166  1.1  christos Alias: <strong>COMMENT</strong>
    167  1.1  christos 
    168  1.1  christos <p>
    169  1.1  christos Sometimes, you want to &quot;hide&quot;
    170  1.1  christos <a href="definitions.html#TERMS_INPUTLINE">input lines</a>
    171  1.1  christos from final output.  This is most likely to be the case when setting
    172  1.1  christos up string tabs (see the
    173  1.1  christos <a href="STRING_TABS_TUT">quickie tutorial on string tabs</a>
    174  1.1  christos for an example), but there are other places where you might want input
    175  1.1  christos lines to be invisible as well.  Any place you don't want input lines
    176  1.1  christos to appear in the output, use the <strong>SILENT</strong> macro.
    177  1.1  christos <p>
    178  1.1  christos <strong>SILENT</strong> is a toggle.  Invoking it without an argument
    179  1.1  christos turns it on; any argument turns it off.  E.g.,
    180  1.1  christos <p>
    181  1.1  christos <pre>
    182  1.1  christos 	.SILENT
    183  1.1  christos 	A line of text
    184  1.1  christos 	.SILENT OFF
    185  1.1  christos </pre>
    186  1.1  christos 
    187  1.1  christos The line &quot;A line of text&quot; will not appear in the
    188  1.1  christos output copy.
    189  1.1  christos <p>
    190  1.1  christos <strong>SILENT</strong> is aliased as <strong>COMMENT</strong>.
    191  1.1  christos If you want to insert non-printing comments into your documents,
    192  1.1  christos you may prefer this.
    193  1.1  christos <p>
    194  1.1  christos <strong>NOTE: SILENT</strong> does not automatically break an
    195  1.1  christos <a href="definitions.html#TERMS_INPUTLINE">input line</a>
    196  1.1  christos (see
    197  1.1  christos <a href="typesetting.html#BR">BR</a>)
    198  1.1  christos when you're in one of the
    199  1.1  christos <a href="definitions.html#TERMS_FILLED">fill modes</a>
    200  1.1  christos (<a href="typesetting.html#JUSTIFY">JUSTIFY</a>
    201  1.1  christos or
    202  1.1  christos <a href="typesetting.html#QUAD">QUAD L | R | C | J</a>).
    203  1.1  christos The same applies to tabs
    204  1.1  christos (<a href="typesetting.html#TAB_SET">typesetting</a>
    205  1.1  christos or
    206  1.1  christos <a href="typesetting.html#ST">string</a>)
    207  1.1  christos to which you've passed the <strong>J</strong> or <strong>QUAD</strong>
    208  1.1  christos argument.  You must insert <code>.BR</code> yourself, or risk a
    209  1.1  christos portion of your text disappearing into a black hole.
    210  1.1  christos <p>
    211  1.1  christos 
    212  1.1  christos <!---TRAP--->
    213  1.1  christos 
    214  1.1  christos <hr width="66%" align="left">
    215  1.1  christos <a name="TRAP"><h3><u>Suspend/re-invoke traps</u></h3></a>
    216  1.1  christos <br>
    217  1.1  christos <nobr>Macro: <strong>TRAP</strong> toggle</nobr>
    218  1.1  christos 
    219  1.1  christos <p>
    220  1.1  christos Traps are vertical positions on the output page at which you or
    221  1.1  christos <strong>mom</strong> have instructed groff to start doing
    222  1.1  christos something automatically.  Commonly, this is near the bottom of
    223  1.1  christos the page, where automatic behind-the-scenes processing is needed
    224  1.1  christos in order for one page to finish and another to start.
    225  1.1  christos <p>
    226  1.1  christos Sometimes, traps get sprung when you don't want them.  If this
    227  1.1  christos happens, surround just the offending macros and input lines with
    228  1.1  christos <p>
    229  1.1  christos <pre>
    230  1.1  christos 	.TRAP OFF
    231  1.1  christos 	...
    232  1.1  christos 	.TRAP
    233  1.1  christos </pre>
    234  1.1  christos 
    235  1.1  christos <strong>TRAP</strong> is a toggle, therefore any argument 
    236  1.1  christos turns it off (i.e. suspends the trap), and no argument turns it
    237  1.1  christos (back) on.
    238  1.1  christos <p>
    239  1.1  christos 
    240  1.1  christos <!---SMARTQUOTES--->
    241  1.1  christos 
    242  1.1  christos <hr width="66%" align="left">
    243  1.1  christos <a name="SMARTQUOTES"><h3><u>Convert typewriter doublequotes to proper doublequotes</u></h3></a>
    244  1.1  christos <br>
    245  1.1  christos <nobr>Macro: <strong>SMARTQUOTES</strong> [&lt;off&gt;] [ ,, | &gt;&gt; | &lt;&lt; ]</nobr>
    246  1.1  christos <br>
    247  1.1  christos or
    248  1.1  christos <br>
    249  1.1  christos <nobr>Macro: <strong>SMARTQUOTES</strong> DA | DE | ES | FR | IT | NL | NO | PT | SV</nobr>
    250  1.1  christos 
    251  1.1  christos <p>
    252  1.1  christos If you invoke <strong>SMARTQUOTES</strong> without an argument,
    253  1.1  christos <strong>mom</strong> converts all instances of the inch-mark,
    254  1.1  christos (<kbd>"</kbd> -- also called a &quot;doublequote&quot;), into
    255  1.1  christos the appropriate instances of true Anglo-American open- and
    256  1.1  christos close-doublequotes.  (See
    257  1.1  christos <a href="#SQ_INTERNATIONAL">Internationalization</a>
    258  1.1  christos for how to get SMARTQUOTES to behave correctly for non-English
    259  1.1  christos quoting styles.)
    260  1.1  christos <p>
    261  1.1  christos Typographically, there is a difference between the inch-mark and
    262  1.1  christos doublequotes -- a BIG difference.  Sadly, typewriters and computer
    263  1.1  christos keyboards supply only one: the inch-mark.  While using inches for
    264  1.1  christos doublequotes is, and always has been, acceptable in typewriter-style
    265  1.1  christos copy, it has never been, and, God willing, never will be acceptable in
    266  1.1  christos typeset copy.  Failure to turn inches into quotes is the first thing
    267  1.1  christos a professional typesetter notices in documents prepared by amateurs.
    268  1.1  christos And you don't want to look like an amateur, do you?
    269  1.1  christos <p>
    270  1.1  christos <a name="SQ_INTERNATIONAL"><h3>Internationalization</h3></a>
    271  1.1  christos <p>
    272  1.1  christos If you invoke <strong>SMARTQUOTES</strong> with one of the optional
    273  1.1  christos arguments (<kbd>,,</kbd> or <kbd>&gt;&gt;</kbd> or
    274  1.1  christos <kbd>&lt;&lt;</kbd>) you can use <kbd>&quot;</kbd> as &quot;cheap&quot;
    275  1.1  christos open- and close-quotes when inputting text in a language other than
    276  1.1  christos English, and have <strong>mom</strong> convert them, on output,
    277  1.1  christos into the chosen open- and close-quote style.
    278  1.1  christos <p>
    279  1.1  christos <kbd>,,</kbd> opens quotes with &quot;lowered doublequotes&quot; and
    280  1.1  christos closes them with &quot;raised doublequotes&quot;, as in this ascii
    281  1.1  christos approximation:
    282  1.1  christos <p>
    283  1.1  christos <pre>
    284  1.1  christos 	,,Hilfe !``
    285  1.1  christos </pre>
    286  1.1  christos 
    287  1.1  christos <kbd>&gt;&gt;</kbd> opens quotes with guillemets pointing to the
    288  1.1  christos right, and closes them with guillemets pointing to the left, as in
    289  1.1  christos this ascii approximation:
    290  1.1  christos <p>
    291  1.1  christos <pre>
    292  1.1  christos 	&gt;&gt;Zurck !&lt;&lt;
    293  1.1  christos </pre>
    294  1.1  christos 
    295  1.1  christos <kbd>&lt;&lt;</kbd> opens quotes with guillemets pointing to the
    296  1.1  christos left, and closes them with guillemets pointing to the right, as in
    297  1.1  christos this ascii approximation:
    298  1.1  christos <p>
    299  1.1  christos <pre>
    300  1.1  christos 	&lt;&lt;Mais monsieur! Je ne suis pas ce genre de fille!&gt;&gt;
    301  1.1  christos </pre>
    302  1.1  christos 
    303  1.1  christos Please note: the above arguments to <strong>SMARTQUOTES</strong>
    304  1.1  christos are literal ASCII characters. <kbd>,,</kbd> is two commas,
    305  1.1  christos <kbd>&lt;&lt;</kbd> is two less-than signs and <kbd>&gt;&gt;</kbd>
    306  1.1  christos is two greater-than signs.
    307  1.1  christos <p>
    308  1.1  christos Alternatively, you can pass <strong>SMARTQUOTES</strong> the
    309  1.1  christos two-letter, ISO 639 abbreviation for the language you're writing in,
    310  1.1  christos and <strong>mom</strong> will output the correct quotes.
    311  1.1  christos <p>
    312  1.1  christos <pre>
    313  1.1  christos 	.SMARTQUOTES DA     = Danish      &gt;&gt;text&lt;&lt;
    314  1.1  christos 	.SMARTQUOTES DE     = German      ,,text``
    315  1.1  christos 	.SMARTQUOTES ES     = Spanish     ``text
    316  1.1  christos 	.SMARTQUOTES FR     = French      &lt;&lt; text &gt;&gt;
    317  1.1  christos 	.SMARTQUOTES IT     = Italian     &lt;&lt; text &gt;&gt;
    318  1.1  christos 	.SMARTQUOTES NL     = Dutch       text
    319  1.1  christos 	.SMARTQUOTES NO     = Norwegian   &lt;&lt;text&gt;&gt;
    320  1.1  christos 	.SMARTQUOTES PT     = Portuguese  &lt;&lt;text&gt;&gt;
    321  1.1  christos 	.SMARTQUOTES SV     = Swedish     &gt;&gt;text&gt;&gt;
    322  1.1  christos </pre>
    323  1.1  christos <p>
    324  1.1  christos Turn <strong>SMARTQUOTES</strong> off by passing it any argument
    325  1.1  christos <em>not</em> in the argument list (e.g. <strong>OFF</strong>,
    326  1.1  christos <strong>QUIT</strong>, <strong>X</strong>, etc.)
    327  1.1  christos <p>
    328  1.1  christos If you're using the
    329  1.1  christos <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>
    330  1.1  christos with
    331  1.1  christos <a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
    332  1.1  christos <strong>SMARTQUOTES</strong> is on by default (in the Anglo-American
    333  1.1  christos style); with
    334  1.1  christos <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    335  1.1  christos it's off by default (and should probably stay that way).
    336  1.1  christos <p>
    337  1.1  christos Finally, if you're fussy about the kerning of quote marks in
    338  1.1  christos relation to the text they surround, or have special quoting needs,
    339  1.1  christos you have to enter quote marks by hand using groff's native
    340  1.1  christos <a href="definitions.html#TERMS_INLINES">inline escapes</a>
    341  1.1  christos for special characters (see man groff_char for a complete list of
    342  1.1  christos special characters).  Entering quote marks this way allows you to
    343  1.1  christos use <strong>mom</strong>'s
    344  1.1  christos <a href="inlines.html#INLINE_KERNING_MOM">inline kerning escapes</a>
    345  1.1  christos to fine-tune the look of quotes.
    346  1.1  christos <p>
    347  1.1  christos <strong>NOTE:</strong> <strong>SMARTQUOTES</strong> does not work on
    348  1.1  christos single quotes, which most people input with the apostrophe (found at
    349  1.1  christos the right-hand end of the &quot;home row&quot; on a QWERTY keyboard).
    350  1.1  christos Groff will interpret all instances of the apostrophe as an apostrophe,
    351  1.1  christos making the symbol useless as an open-single-quote.  For open single
    352  1.1  christos quotes, input the backtick character typically found under the tilde
    353  1.1  christos on most keyboards.  (Pour nous autres, &quot;backtick&quot; veut dire
    354  1.1  christos l'accent grave.)
    355  1.1  christos Here's an example of correct input copy with single quotes:
    356  1.1  christos <p>
    357  1.1  christos <pre>
    358  1.1  christos 	"But she said, `I don't want to!'"	
    359  1.1  christos </pre>
    360  1.1  christos 
    361  1.1  christos <strong>ADDITIONAL NOTE:</strong> Whether or not you have
    362  1.1  christos <strong>SMARTQUOTES</strong> turned on, get into the habit of entering
    363  1.1  christos the foot- and inch-marks, when you need them, with the
    364  1.1  christos <a href="definitions.html#TERMS_INLINES">inline escapes</a>
    365  1.1  christos <strong>\*[FOOT]</strong> and <strong>\*[INCH]</strong>, instead
    366  1.1  christos of <kbd>'</kbd> and <kbd>"</kbd>.
    367  1.1  christos <p>
    368  1.1  christos 
    369  1.1  christos <!---CAPS--->
    370  1.1  christos 
    371  1.1  christos <hr width="66%" align="left">
    372  1.1  christos <a name="CAPS"><h3><u>Convert to upper case</u></h3></a>
    373  1.1  christos <br>
    374  1.1  christos <nobr>Macro: <strong>CAPS</strong> toggle</nobr>
    375  1.1  christos 
    376  1.1  christos <p>
    377  1.1  christos <strong>CAPS</strong> converts all lower case letters to upper
    378  1.1  christos case.  Primarily, it's a support macro used by the
    379  1.1  christos <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>,
    380  1.1  christos but you may find it helpful on occasion.  <strong>CAPS</strong>
    381  1.1  christos is a toggle, therefore no argument turns it on, any argument
    382  1.1  christos turns it off.
    383  1.1  christos <p>
    384  1.1  christos <pre>
    385  1.1  christos 	.CAPS
    386  1.1  christos 	All work and no play makes Jack a dull boy.
    387  1.1  christos 	.CAPS OFF
    388  1.1  christos </pre>
    389  1.1  christos 
    390  1.1  christos produces, on output
    391  1.1  christos <p>
    392  1.1  christos <pre>
    393  1.1  christos 	ALL WORK AND NO PLAY MAKES JACK A DULL BOY.
    394  1.1  christos </pre>
    395  1.1  christos 
    396  1.1  christos <!---STRING--->
    397  1.1  christos 
    398  1.1  christos <hr width="66%" align="left">
    399  1.1  christos <a name="STRING"><h3><u>User-defined strings</u></h3></a>
    400  1.1  christos <br>
    401  1.1  christos <nobr>Macro: <strong>STRING</strong> &lt;name&gt; &lt;what you want in the string&gt;</nobr>
    402  1.1  christos 
    403  1.1  christos <p>
    404  1.1  christos You may find sometimes that you have to type out portions of text
    405  1.1  christos repeatedly.  If you'd like not to wear out your fingers, you can
    406  1.1  christos define a &quot;string&quot; that, whenever you call it by name,
    407  1.1  christos outputs whatever you put into it.
    408  1.1  christos <p>
    409  1.1  christos For example, say you're creating a document that repeatedly uses
    410  1.1  christos the phrase &quot;the Montreal/Windsor corridor&quot;.  Instead of
    411  1.1  christos typing all that out every time, you could define a string, like
    412  1.1  christos this:
    413  1.1  christos <p>
    414  1.1  christos <pre>
    415  1.1  christos 	.STRING mw the Montreal/Windsor corridor
    416  1.1  christos </pre>
    417  1.1  christos 
    418  1.1  christos Once a string is defined, you can call it any time with the
    419  1.1  christos <a href="definitions.html#INLINES">inline escape</a>
    420  1.1  christos <kbd>\*[&lt;stringname&gt;]</kbd>.  Using the example string above
    421  1.1  christos <p>
    422  1.1  christos <pre>
    423  1.1  christos 	The schedule for trains along \*[mw]:
    424  1.1  christos </pre>
    425  1.1  christos 
    426  1.1  christos produces, on output
    427  1.1  christos <p>
    428  1.1  christos <pre>
    429  1.1  christos 	The schedule for trains along the Montreal/Windsor corridor:
    430  1.1  christos </pre>
    431  1.1  christos 
    432  1.1  christos <strong>NOTE:</strong> Be very careful not to put any spaces at the
    433  1.1  christos ends of strings you're defining, unless you want them.  Everything
    434  1.1  christos after the name argument you pass to <strong>STRING</strong> goes
    435  1.1  christos into the string, including trailing spaces.
    436  1.1  christos <p>
    437  1.1  christos <strong>Experts: STRING</strong> is an alias for <strong>ds</strong>.
    438  1.1  christos You can use either, or mix 'n' match with impunity.
    439  1.1  christos <p>
    440  1.1  christos 
    441  1.1  christos <!---UNDERSCORE--->
    442  1.1  christos 
    443  1.1  christos <hr width="66%" align="left">
    444  1.1  christos <a name="UNDERSCORE"><h3><u>Single underscore</u></h3></a>
    445  1.1  christos <br>
    446  1.1  christos <nobr>Macro: <strong>UNDERSCORE</strong> [ &lt;distance below baseline&gt; ] &quot;&lt;string&gt;&quot;</nobr>
    447  1.1  christos <br>
    448  1.1  christos <em>*Optional argument requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
    449  1.1  christos 
    450  1.1  christos <p>
    451  1.1  christos By default, <strong>UNDERSCORE</strong> places an underscore 2 points
    452  1.1  christos beneath the required
    453  1.1  christos <a href="definitions.html#TERMS_STRINGARGUMENT">string argument</a>.
    454  1.1  christos The string must be enclosed in double-quotes, like this:
    455  1.1  christos <p>
    456  1.1  christos <pre>
    457  1.1  christos 	.UNDERSCORE "Unmonitored monopolies breed high prices and poor products."
    458  1.1  christos </pre>
    459  1.1  christos 
    460  1.1  christos If you wish to change the distance of the rule from the
    461  1.1  christos baseline, use the optional argument <i>&lt;distance below
    462  1.1  christos baseline&gt;</i> (with a unit of measure).
    463  1.1  christos <p>
    464  1.1  christos <pre>
    465  1.1  christos 	.UNDERSCORE 3p "Unmonitored monopolies breed high prices and poor products."
    466  1.1  christos </pre>
    467  1.1  christos 
    468  1.1  christos The above places the underscore 3 points below the baseline.
    469  1.1  christos <p>
    470  1.1  christos <a name="NOTES_UNDERSCORE"></a>
    471  1.1  christos <strong>NOTES:</strong>
    472  1.1  christos <br>
    473  1.1  christos <strong>UNDERSCORE</strong> does not work across line breaks in output
    474  1.1  christos copy, which is to say that you can't underscore a multi-line passage
    475  1.1  christos simply by putting the text of the whole thing in the string you pass
    476  1.1  christos to <strong>UNDERSCORE</strong>.  Each
    477  1.1  christos <a href="definitions.html#TERMS_OUTPUTLINE">output line</a>
    478  1.1  christos or portion of an output line you want underscored must be plugged
    479  1.1  christos separately into <strong>UNDERSCORE</strong>.  Bear in mind, though,
    480  1.1  christos that underscoring should at best be an occasional effect in typeset
    481  1.1  christos copy.  If you want to emphasize an entire passage, it's much, much
    482  1.1  christos better to change fonts (e.g. to italic or bold).
    483  1.1  christos <p>
    484  1.1  christos You can easily and successfully underline entire passages in simulated
    485  1.1  christos typewriter-style copy (i.e. if your font is Courier, or you're using
    486  1.1  christos the document processing macro
    487  1.1  christos <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>),
    488  1.1  christos with the
    489  1.1  christos <a href="#UNDERLINE">UNDERLINE</a>
    490  1.1  christos macro.  <strong>UNDERLINE</strong> is designed specifically for this
    491  1.1  christos purpose, but works only with the Courier font.
    492  1.1  christos <p>
    493  1.1  christos <strong>Mom</strong> doesn't always get the position and length
    494  1.1  christos of the underscore precisely right in
    495  1.1  christos <a href="definitions.html#TERMS_JUST">justified</a>
    496  1.1  christos copy, although she's fine with all the other
    497  1.1  christos <a href="definitions.html#TERMS_FILLED">fill modes</a>,
    498  1.1  christos as well as with the no-fill modes.  As of this writing, I have
    499  1.1  christos no solution to the occasional problems with justified copy.
    500  1.1  christos <p>
    501  1.1  christos <strong>UNDERSCORE</strong> tends to confuse
    502  1.1  christos <strong>gxditview</strong>, even though the output, when
    503  1.1  christos printed, looks fine.  Generally, I recommend using <strong>gv</strong>
    504  1.1  christos to preview files anyway.  See the section on
    505  1.1  christos <a href="#PREVIEWING">previewing</a>.
    506  1.1  christos <p>
    507  1.1  christos 
    508  1.1  christos <!---UNDERSCORE2--->
    509  1.1  christos 
    510  1.1  christos <hr width="66%" align="left">
    511  1.1  christos <a name="UNDERSCORE2"><h3><u>Double underscore</u></h3></a>
    512  1.1  christos <br>
    513  1.1  christos <nobr>Macro: <strong>UNDERSCORE2</strong> [ &lt;distance below baseline&gt; [ &lt;distance between rules&gt; ] ] &quot;&lt;string&gt;&quot;</nobr>
    514  1.1  christos <br>
    515  1.1  christos <em>*Optional arguments require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
    516  1.1  christos 
    517  1.1  christos <p>
    518  1.1  christos By default, <strong>UNDERSCORE2</strong> places a double underscore
    519  1.1  christos 2 points beneath the required
    520  1.1  christos <a href="definitions.html#TERMS_STRINGARGUMENT">string argument</a>.
    521  1.1  christos The string must be enclosed in double-quotes, like this:
    522  1.1  christos <p>
    523  1.1  christos <pre>
    524  1.1  christos 	.UNDERSCORE2 "Unmonitored monopolies breed high prices and poor products."
    525  1.1  christos </pre>
    526  1.1  christos 
    527  1.1  christos The default distance between the two rules is 2 points.
    528  1.1  christos <p>
    529  1.1  christos If you wish to change the distance of the double underscore from
    530  1.1  christos the baseline, use the optional argument <i>&lt;distance below
    531  1.1  christos baseline&gt;</i> (with a unit of measure), e.g.,
    532  1.1  christos <p>
    533  1.1  christos <pre>
    534  1.1  christos 	.UNDERSCORE2 3p "Unmonitored monopolies breed high prices and poor products."
    535  1.1  christos </pre>
    536  1.1  christos 
    537  1.1  christos which places the double underscore 3 points below the baseline.
    538  1.1  christos <p>
    539  1.1  christos If you wish to change the distance between the two rules as
    540  1.1  christos well, use the second optional argument <i>&lt;distance between
    541  1.1  christos rules&gt;</i> (with a unit of measure).  Be aware that you must
    542  1.1  christos give a value for the first optional argument if you want to use
    543  1.1  christos the second.
    544  1.1  christos <p>
    545  1.1  christos <strong>NOTE:</strong> the same restrictions and caveats apply
    546  1.1  christos to <strong>UNDERSCORE2</strong> as to
    547  1.1  christos <strong>UNDERSCORE</strong>.  See the
    548  1.1  christos <a href="#NOTES_UNDERSCORE">NOTES</a>
    549  1.1  christos for <strong>UNDERSCORE</strong>.
    550  1.1  christos <p>
    551  1.1  christos 
    552  1.1  christos <!---UNDERLINE--->
    553  1.1  christos 
    554  1.1  christos <hr width="66%" align="left">
    555  1.1  christos <a name="UNDERLINE"><h3><u>Underline text -- Courier font only!</u></h3></a>
    556  1.1  christos <br>
    557  1.1  christos <nobr>Macro: <strong>UNDERLINE</strong> toggle</nobr>
    558  1.1  christos 
    559  1.1  christos <p>
    560  1.1  christos If your font is Courier, or you're using the document processing macro
    561  1.1  christos <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    562  1.1  christos <strong>UNDERLINE</strong> allows you to underline words and
    563  1.1  christos passages that, in typeset copy, would be italicized.  You invoke
    564  1.1  christos <strong>UNDERLINE</strong> as you do with all toggle macros --
    565  1.1  christos by itself (i.e. with no argument) to initiate underlining, and
    566  1.1  christos with any argument to turn underlining off.
    567  1.1  christos <p>
    568  1.1  christos When on, <strong>UNDERLINE</strong> underlines letters, words
    569  1.1  christos and numbers, but not punctuation or spaces.  This makes for more
    570  1.1  christos readable copy than a solid underline.
    571  1.1  christos <p>
    572  1.1  christos <strong>NOTE:</strong> Underlining may also be turned on and off
    573  1.1  christos <a href="definitions.html#TERMS_INLINES">inline</a>
    574  1.1  christos with the escapes
    575  1.1  christos <a href="#UL">\*[UL]...\*[ULX].</a>
    576  1.1  christos <p>
    577  1.1  christos 
    578  1.1  christos <!---UL--->
    579  1.1  christos 
    580  1.1  christos <hr width="66%" align="left">
    581  1.1  christos <a name="UL"><h3><u>Inline escape for underlining -- Courier font only!</u></h3></a>
    582  1.1  christos <br>
    583  1.1  christos Inline: <strong>\*[UL]...\*[ULX]</strong>
    584  1.1  christos 
    585  1.1  christos <p>
    586  1.1  christos If your font is Courier, or you're using the document processing macro
    587  1.1  christos <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    588  1.1  christos <strong>\*[UL]...\*[ULX]</strong> underlines words and
    589  1.1  christos passages that, in typeset copy, would be italicized.
    590  1.1  christos <p>
    591  1.1  christos <strong>\*[UL]</strong> underlines all letters, words and numbers
    592  1.1  christos following it, but not punctuation or spaces.  This makes for more
    593  1.1  christos readable copy than a solid underline.  When you no longer want
    594  1.1  christos underlining, <strong>\*[ULX]</strong> turns underlining off.
    595  1.1  christos <p>
    596  1.1  christos The macro
    597  1.1  christos <a href="#UNDERLINE">UNDERLINE</a>
    598  1.1  christos and the inline escape <strong>\*[UL]</strong> are functionally
    599  1.1  christos identical, hence
    600  1.1  christos <p>
    601  1.1  christos <pre>
    602  1.1  christos 	.FAM     C
    603  1.1  christos 	.FT      R
    604  1.1  christos 	.PT_SIZE 12
    605  1.1  christos 	.LS      24
    606  1.1  christos 	.SS      0
    607  1.1  christos 	.QUAD    LEFT
    608  1.1  christos 	Which should I heed?
    609  1.1  christos 	.UNDERLINE
    610  1.1  christos 	Just do it
    611  1.1  christos 	.UNDERLINE OFF
    612  1.1  christos 	or
    613  1.1  christos 	.UNDERLINE
    614  1.1  christos 	just say no?
    615  1.1  christos 	.UNDERLINE OFF
    616  1.1  christos </pre>
    617  1.1  christos 
    618  1.1  christos produces the same result as
    619  1.1  christos <p>
    620  1.1  christos <pre>
    621  1.1  christos 	.FAM     C
    622  1.1  christos 	.FT      R
    623  1.1  christos 	.PT_SIZE 12
    624  1.1  christos 	.LS      24
    625  1.1  christos 	.SS      0
    626  1.1  christos 	.QUAD    LEFT
    627  1.1  christos 	Which should I heed? \*[UL]Just do it\*[ULX] or \*[UL]just say no?\*[ULX]
    628  1.1  christos </pre>
    629  1.1  christos 
    630  1.1  christos <!---PAD--->
    631  1.1  christos 
    632  1.1  christos <hr width="66%" align="left">
    633  1.1  christos <a name="PAD"><h3><u>Insert space into lines</u></h3></a>
    634  1.1  christos <br>
    635  1.1  christos <nobr>Macro: <strong>PAD</strong> &quot;&lt;string with pad markers inserted&gt;&quot; [NOBREAK]</nobr>
    636  1.1  christos 
    637  1.1  christos <p>
    638  1.1  christos With <strong>PAD</strong>, you can insert unspecified amounts of
    639  1.1  christos whitespace into a line.  The optional <strong>NOBREAK</strong>
    640  1.1  christos argument tells <strong>mom</strong> not to advance on the page
    641  1.1  christos after the <strong>PAD</strong> macro has been invoked.
    642  1.1  christos <p>
    643  1.1  christos <strong>PAD</strong> calculates the difference between the length of
    644  1.1  christos text on the line and the distance remaining to its end, then inserts
    645  1.1  christos the difference (as whitespace) at the place(s) you specify.
    646  1.1  christos <p>
    647  1.1  christos Take, for example, the following relatively common typesetting
    648  1.1  christos situation, found at the bottom of legal agreements:
    649  1.1  christos <p>
    650  1.1  christos <pre>
    651  1.1  christos 	Date             Signature                               |
    652  1.1  christos </pre>
    653  1.1  christos 
    654  1.1  christos The person signing the agreement is supposed to fill in the date
    655  1.1  christos as well as a signature.  Space needs to be left for both, but
    656  1.1  christos the exact amount is neither known, nor important.  All that
    657  1.1  christos matters is that there be a little space after Date, and rather
    658  1.1  christos more space after Signature.  (In the above, | represents
    659  1.1  christos the end of the line at the prevailing line length.)
    660  1.1  christos <p>
    661  1.1  christos The
    662  1.1  christos <a href="#PADMARKER">pad marker</a>
    663  1.1  christos (see below) is # (the pound or number sign on your keyboard) and
    664  1.1  christos can be used multiple times in a line.  With that in mind, here's how
    665  1.1  christos you'd input the Date/Signature line (assuming a length of 30 picas):
    666  1.1  christos <p>
    667  1.1  christos <pre>
    668  1.1  christos 	.LL 30P
    669  1.1  christos 	.PAD "Date#Signature###"
    670  1.1  christos </pre>
    671  1.1  christos 
    672  1.1  christos When the line is output, the space remaining on the line, after
    673  1.1  christos &quot;Date&quot; and &quot;Signature&quot; have been taken into
    674  1.1  christos account, is split into four (because there are four # signs).
    675  1.1  christos One quarter of the space is inserted between Date and Signature,
    676  1.1  christos the remainder is inserted after Signature.
    677  1.1  christos <a name="PAD_EXAMPLE"></a>
    678  1.1  christos <p>
    679  1.1  christos One rarely wants merely to insert space in a line; one usually
    680  1.1  christos wants to fill it with something, hence <strong>PAD</strong> is
    681  1.1  christos particularly useful in conjunction with
    682  1.1  christos <a href="#STRING_TABS">string tabs</a>.
    683  1.1  christos The following uses the Date/Signature example above, but adds
    684  1.1  christos rules into the whitespace through the use of string tabs and
    685  1.1  christos <strong>mom</strong>'s
    686  1.1  christos <a href="definitions.html#TERMS_INLINES">inline escape</a>
    687  1.1  christos <a href="inlines.html#INLINE_RULE_MOM">\*[RULE]</a>.
    688  1.1  christos (Instead of <strong>\*[RULE]</strong>,
    689  1.1  christos groff's line drawing function,
    690  1.1  christos <a href="inlines.html#INLINE_LINEDRAWING_GROFF">\l</a>
    691  1.1  christos could be used.)
    692  1.1  christos <p>
    693  1.1  christos <pre>
    694  1.1  christos 	.LL 30P
    695  1.1  christos 	.PAD "Date \*[ST1]#\*[ST1X] Signature \*[ST2]###\*[ST2X]" NOBREAK
    696  1.1  christos 	.ST 1 J
    697  1.1  christos 	.ST 2 J
    698  1.1  christos 	.TAB 1
    699  1.1  christos 	\*[RULE]
    700  1.1  christos 	.TN
    701  1.1  christos 	\*[RULE]
    702  1.1  christos 	.TQ
    703  1.1  christos </pre>
    704  1.1  christos 
    705  1.1  christos If you're not a typesetter, and if you're new to groff, the
    706  1.1  christos example probably looks like gibberish.  My apologies.  However,
    707  1.1  christos remember that typesetting is a craft, and without having studied
    708  1.1  christos the craft, it takes a while to grasp its concepts.
    709  1.1  christos <p>
    710  1.1  christos Basically, what the example does is:
    711  1.1  christos <br>
    712  1.1  christos <ol>
    713  1.1  christos 	<li>Pads the Date/Signature line (using the pad marker #),
    714  1.1  christos 		encloses the padded space with two string tabs markers,
    715  1.1  christos 		and outputs the line.
    716  1.1  christos 	<br>
    717  1.1  christos 	<li>Sets the two string tabs (notice the use of
    718  1.1  christos 		<a href="#EL">EL</a>
    719  1.1  christos 		beforehand; you don't want <strong>mom</strong>
    720  1.1  christos 		to advance a line at this point).
    721  1.1  christos 	<br>
    722  1.1  christos 	<li>Calls the first string tab and draws a rule to its full
    723  1.1  christos 		length.
    724  1.1  christos 	<br>
    725  1.1  christos 	<li>Calls the second tab with
    726  1.1  christos 		<a href="#TN">TN</a>
    727  1.1  christos 		(which moves to tab 2 and stays on the same baseline)
    728  1.1  christos 		then draws a rule to the full length of string tab 2.
    729  1.1  christos </ol>
    730  1.1  christos <br>
    731  1.1  christos Often, when setting up string tabs this way, you don't want the
    732  1.1  christos padded line to print immediately.  To accomplish this, use
    733  1.1  christos <a href="#SILENT">SILENT</a>.
    734  1.1  christos See the <a href="#STRING_TABS_TUT">quickie tutorial on string tabs</a>
    735  1.1  christos for an example.
    736  1.1  christos <p>
    737  1.1  christos <strong>NOTE:</strong> Because the pound sign (#) is used as the pad
    738  1.1  christos marker, you can't use it as a literal part of the pad string.  If you
    739  1.1  christos need the sign to appear in the text of a padded line, change the pad
    740  1.1  christos marker with <a href="#PAD_MARKER">PAD_MARKER</a>.  Also, be aware
    741  1.1  christos that # as a pad marker only applies within the <strong>PAD</strong>
    742  1.1  christos macro; at all other times it prints literally, just as you'd expect.
    743  1.1  christos <p>
    744  1.1  christos Another important consideration when using <strong>PAD</strong> is that
    745  1.1  christos because the string must be enclosed in double-quotes, you can't use the
    746  1.1  christos double-quote (&quot;) as part of the string.  The way to circumvent
    747  1.1  christos this is to use the groff
    748  1.1  christos <a href="definitions.html#TERMS_INLINES">inline escapes</a>
    749  1.1  christos <strong>\(lq</strong> and <strong>\(rq</strong> (leftquote and
    750  1.1  christos rightquote respectively) whenever double-quotes are required in the
    751  1.1  christos string passed to <strong>PAD</strong>.
    752  1.1  christos <p>
    753  1.1  christos 
    754  1.1  christos <!---PAD_MARKER--->
    755  1.1  christos 
    756  1.1  christos <hr width="66%" align="left">
    757  1.1  christos <a name="PAD_MARKER"><h3><u>Change/set the marker used with PAD</u></h3></a>
    758  1.1  christos <br>
    759  1.1  christos <nobr>Macro: <strong>PAD_MARKER</strong> &lt;character to use as the pad marker&gt;</nobr>
    760  1.1  christos 
    761  1.1  christos <p>
    762  1.1  christos If you need to change <strong>mom</strong>'s default pad marker
    763  1.1  christos (#), either because you want a literal # in the padded line,
    764  1.1  christos or simply because you want to use another character instead, use
    765  1.1  christos <strong>PAD_MARKER</strong>, whose argument is the new pad marker
    766  1.1  christos character you want.
    767  1.1  christos <p>
    768  1.1  christos <pre>
    769  1.1  christos 	.PAD_MARKER @
    770  1.1  christos </pre>
    771  1.1  christos 
    772  1.1  christos changes the pad marker to @.
    773  1.1  christos <p>
    774  1.1  christos Once you've changed the pad marker, the new marker remains in
    775  1.1  christos effect for every instance of
    776  1.1  christos <a href="#PAD">PAD</a>
    777  1.1  christos until you change it again (say, back to the pound sign).
    778  1.1  christos <p>
    779  1.1  christos 
    780  1.1  christos <!---\*[LEADER]--->
    781  1.1  christos 
    782  1.1  christos <hr width="66%" align="left">
    783  1.1  christos <a name="LEADER"><h3><u>Inline escape to add leaders to a line</u></h3></a>
    784  1.1  christos <br>
    785  1.1  christos Inline: <strong>\*[LEADER]</strong>
    786  1.1  christos 
    787  1.1  christos <p>
    788  1.1  christos Whenever you want to fill a line or tab with
    789  1.1  christos <a href="definitions.html#TERMS_LEADER">leaders</a>,
    790  1.1  christos use the
    791  1.1  christos <a href="definitions.html#TERMS_INLINES">inline escape</a>
    792  1.1  christos <strong>\*[LEADER]</strong>.  The remainder of the line or tab will be
    793  1.1  christos filled with the leader character.  <strong>Mom</strong>'s
    794  1.1  christos default leader character is a period (dot), but you can change
    795  1.1  christos it to any character you like with
    796  1.1  christos <a href="#LEADER_CHARACTER">LEADER_CHARACTER</a>.
    797  1.1  christos <p>
    798  1.1  christos <strong>NOTE:</strong> <strong>\*[LEADER]</strong> fills lines
    799  1.1  christos or tabs right to their end.  You cannot insert leaders into a
    800  1.1  christos line or tab and have text following the leader on the same line
    801  1.1  christos or in the same tab.  Should you wish to achieve such an effect
    802  1.1  christos typographically, create tabs for each element of the line and
    803  1.1  christos fill them appropriately with the text and leaders you need.
    804  1.1  christos <a href="#STRING_TABS">String tabs</a> are perfect for this.  An
    805  1.1  christos example follows.
    806  1.1  christos <p>
    807  1.1  christos <pre>
    808  1.1  christos 	.LL 30P
    809  1.1  christos 	.PAD "Date\*[ST1]#\*[ST1X]Signature\*[ST2]###\*[ST2X]"
    810  1.1  christos 	.EL
    811  1.1  christos 	.ST 1 J
    812  1.1  christos 	.ST 2 J
    813  1.1  christos 	.TAB 1
    814  1.1  christos 	\*[LEADER]
    815  1.1  christos 	.TN
    816  1.1  christos 	\*[LEADER]
    817  1.1  christos 	.TQ
    818  1.1  christos </pre>
    819  1.1  christos 
    820  1.1  christos The <strong>PAD</strong> line sets the words Date and Signature,
    821  1.1  christos and marks string tabs around the pad space inserted in the line.
    822  1.1  christos The string tabs are then &quot;set&quot;, called, and filled
    823  1.1  christos with leaders.  The result looks like this:
    824  1.1  christos <p>
    825  1.1  christos <pre>
    826  1.1  christos 	Date.............Signature.....................................
    827  1.1  christos </pre>
    828  1.1  christos 
    829  1.1  christos <!---LEADER_CHARACTER--->
    830  1.1  christos 
    831  1.1  christos <hr width="66%" align="left">
    832  1.1  christos <a name="LEADER_CHARACTER"><h3><u>Change/set the leader character</u></h3></a>
    833  1.1  christos <br>
    834  1.1  christos <nobr>Macro: <strong>LEADER_CHARACTER</strong> &lt;character&gt;</nobr>
    835  1.1  christos 
    836  1.1  christos <p>
    837  1.1  christos <strong>LEADER_CHARACTER</strong> takes one argument: a single
    838  1.1  christos character you would like to be used for
    839  1.1  christos <a href="definitions.html#TERMS_LEADER">leaders</a>.
    840  1.1  christos (See
    841  1.1  christos <a href="#LEADER">\*[LEADER]</a> for an explanation of how to
    842  1.1  christos fill lines with leaders.)
    843  1.1  christos <p>
    844  1.1  christos For example, to change the leader character from <strong>mom</strong>'s
    845  1.1  christos default (a period) to the underscore character, enter
    846  1.1  christos <p>
    847  1.1  christos <pre>
    848  1.1  christos 	.LEADER_CHARACTER _
    849  1.1  christos </pre>
    850  1.1  christos 
    851  1.1  christos <!---DROPCAP--->
    852  1.1  christos 
    853  1.1  christos <hr width="66%" align="left">
    854  1.1  christos <a name="DROPCAP"><h3><u>Drop caps</u></h3></a>
    855  1.1  christos <br>
    856  1.1  christos <nobr>Macro: <strong>DROPCAP</strong> &lt;dropcap letter&gt; &lt;number of lines to drop&gt; [ COND &lt;percentage&gt; | EXT &lt;percentage&gt; ]</nobr>
    857  1.1  christos 
    858  1.1  christos <p>
    859  1.1  christos The first two arguments to <strong>DROPCAP</strong> are the letter you
    860  1.1  christos want to be the
    861  1.1  christos <a href="definitions.html#TERMS_DROPCAP">drop cap</a>
    862  1.1  christos and the number of lines you want it to drop.  By default,
    863  1.1  christos <strong>mom</strong> uses the current family and font for the drop cap.
    864  1.1  christos <p>
    865  1.1  christos The optional argument (COND or EXT) indicates that you want the
    866  1.1  christos drop cap condensed (narrower) or extended (wider).  If you use
    867  1.1  christos <strong>COND</strong> or <strong>EXT</strong>, you must follow the
    868  1.1  christos argument with the percentage of the letter's normal width you want
    869  1.1  christos it condensed or extended.  No percent sign (%) is required.
    870  1.1  christos <p>
    871  1.1  christos <strong>Mom</strong> will do her very best to get the drop cap to
    872  1.1  christos line up with the first line of text indented beside it, then set
    873  1.1  christos the correct number of indented lines, and restore your left margin
    874  1.1  christos when the number of drop cap lines has been reached.
    875  1.1  christos <p>
    876  1.1  christos Beginning a paragraph with a drop cap &quot;T&quot; looks
    877  1.1  christos like this:
    878  1.1  christos <p>
    879  1.1  christos <pre>
    880  1.1  christos 	.DROPCAP T 3 COND 90
    881  1.1  christos 	he thousand injuries of Fortunato I had borne as best I
    882  1.1  christos 	could, but when he ventured upon insult, I vowed revenge.
    883  1.1  christos 	You who so well know the nature of my soul will not suppose,
    884  1.1  christos 	however, that I gave utterance to a threat...
    885  1.1  christos </pre>
    886  1.1  christos 
    887  1.1  christos The drop cap, slightly condensed but in the current family and font,
    888  1.1  christos will be three lines tall, with whatever text fills those three
    889  1.1  christos lines indented to the right of the letter.  The remainder of the
    890  1.1  christos paragraph's text will revert to the left margin.
    891  1.1  christos <p>
    892  1.1  christos <strong>NOTE:</strong> When using the
    893  1.1  christos <a href="docprocessing.html#DOCPROCESSING">document processing macro</a>
    894  1.1  christos <a href="#PP">PP</a>,
    895  1.1  christos <strong>DROPCAP</strong> only works
    896  1.1  christos <br>
    897  1.1  christos <ul>
    898  1.1  christos 	<li>with initial paragraphs (i.e. at the start of the document,
    899  1.1  christos 		or after
    900  1.1  christos 		<a href="#HEAD">HEAD</a>),
    901  1.1  christos 	<li>when <strong>DROPCAP</strong> comes immediately after <strong>PP</strong>,
    902  1.1  christos 	<li>and when the
    903  1.1  christos 		<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a>
    904  1.1  christos 		is TYPESET.
    905  1.1  christos </ul>
    906  1.1  christos <br>
    907  1.1  christos If these conditions aren't met, <strong>DROPCAP</strong> is silently ignored.
    908  1.1  christos <p>
    909  1.1  christos <strong>WARNING:</strong> <strong>DROPCAP</strong> puts a bit of
    910  1.1  christos a strain on resource-challenged systems.  If you have such a
    911  1.1  christos system and use drop caps extensively in a document, be prepared
    912  1.1  christos for a wait while <strong>mom</strong> does her thing.
    913  1.1  christos 
    914  1.1  christos <h3><a name="DROPCAP_SUPPORT"><u>Support macros for DROPCAP</u></a></h3>
    915  1.1  christos Drop caps are the bane of most typesetters' existence.  It's
    916  1.1  christos very difficult to get the size of the drop cap right for the
    917  1.1  christos number of drop lines, especially if the drop cap is in a
    918  1.1  christos different family from the prevailing family of running text.
    919  1.1  christos Not only that, but there's the gutter around the drop cap to
    920  1.1  christos take into account, plus the fact that the letter may be too wide
    921  1.1  christos or too narrow to look anything but odd or misplaced.
    922  1.1  christos <p>
    923  1.1  christos <strong>Mom</strong> solves the last of these problems with the
    924  1.1  christos <strong>COND</strong> and <strong>EXT</strong> arguments.  The
    925  1.1  christos rest she solves with macros that change the default behaviour of
    926  1.1  christos <strong>DROPCAP</strong>, namely
    927  1.1  christos <p>
    928  1.1  christos <a href="#DROPCAP_FAMILY">DROPCAP_FAMILY</a>,
    929  1.1  christos <br>
    930  1.1  christos <a href="#DROPCAP_FONT">DROPCAP_FONT</a>,
    931  1.1  christos <br>
    932  1.1  christos <a href="#DROPCAP_COLOR">DROPCAP_COLOR</a>,
    933  1.1  christos <br>
    934  1.1  christos <a href="#DROPCAP_ADJUST">DROPCAP_ADJUST</a>
    935  1.1  christos <br>
    936  1.1  christos and
    937  1.1  christos <br>
    938  1.1  christos <a href="#DROPCAP_GUTTER">DROPCAP_GUTTER</a>.
    939  1.1  christos <p>
    940  1.1  christos These macros must, of course, come before you invoke
    941  1.1  christos <strong>DROPCAP</strong>.
    942  1.1  christos 
    943  1.1  christos <h3><a name="DROPCAP_FAMILY"><u>DROPCAP_FAMILY</u></a></h3>
    944  1.1  christos 
    945  1.1  christos Set the drop cap family by giving
    946  1.1  christos <strong>DROPCAP_FAMILY</strong> the name of the family you want,
    947  1.1  christos e.g.
    948  1.1  christos <p>
    949  1.1  christos <pre>
    950  1.1  christos 	.DROPCAP_FAMILY H
    951  1.1  christos </pre>
    952  1.1  christos 
    953  1.1  christos which will set the family to Helvetica for the drop cap only.
    954  1.1  christos 
    955  1.1  christos <h3><a name="DROPCAP_FONT"><u>DROPCAP_FONT</u></a></h3>
    956  1.1  christos 
    957  1.1  christos Set the drop cap font by giving
    958  1.1  christos <strong>DROPCAP_FONT</strong> the name of the font you want,
    959  1.1  christos e.g.
    960  1.1  christos <p>
    961  1.1  christos <pre>
    962  1.1  christos 	.DROPCAP_FONT I
    963  1.1  christos </pre>
    964  1.1  christos 
    965  1.1  christos which will set the font to italic for the drop cap only.
    966  1.1  christos 
    967  1.1  christos <h3><a name="DROPCAP_ADJUST"><u>DROPCAP_ADJUST</u></a></h3>
    968  1.1  christos 
    969  1.1  christos If the size <strong>mom</strong> calculates for the drop cap
    970  1.1  christos isn't precisely what you want, you can increase or decrease it
    971  1.1  christos with <strong>DROPCAP_ADJUST</strong>, like this:
    972  1.1  christos e.g.
    973  1.1  christos <p>
    974  1.1  christos <pre>
    975  1.1  christos 	.DROPCAP_ADJUST +1
    976  1.1  christos 	    or
    977  1.1  christos 	.DROPCAP_ADJUST -.75
    978  1.1  christos </pre>
    979  1.1  christos 
    980  1.1  christos <strong>DROPCAP_ADJUST</strong> only understands
    981  1.1  christos <a href="definitions.html#TERMS_PICASPOINTS">points</a>,
    982  1.1  christos therefore do not append any
    983  1.1  christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    984  1.1  christos to the argument.  And always be sure to prepend the plus or
    985  1.1  christos minus sign, depending on whether you want the drop cap larger or
    986  1.1  christos smaller.
    987  1.1  christos 
    988  1.1  christos 
    989  1.1  christos <h3><a name="DROPCAP_COLOR"><u>DROPCAP_COLOR</u></a></h3>
    990  1.1  christos 
    991  1.1  christos If you'd like your drop cap colourized, simply invoke
    992  1.1  christos <strong>DROPCAP_COLOR</strong> with the name of a colour you've already
    993  1.1  christos created (&quot;initialized&quot;) with
    994  1.1  christos <a href="color.html#NEWCOLOR">NEWCOLOR</a>
    995  1.1  christos or
    996  1.1  christos <a href="color.html#XCOLOR">XCOLOR</a>.  Only the drop cap will be
    997  1.1  christos colourized; all other text will remain at the current colour
    998  1.1  christos default (usually black).
    999  1.1  christos 
   1000  1.1  christos <h3><a name="DROPCAP_GUTTER"><u>DROPCAP_GUTTER</u></a></h3>
   1001  1.1  christos 
   1002  1.1  christos By default, <strong>mom</strong> puts three points of space
   1003  1.1  christos between the drop cap and the text indented beside it.  If you
   1004  1.1  christos want another value, use <strong>DROPCAP_GUTTER</strong> (with a
   1005  1.1  christos unit of measure), like this:
   1006  1.1  christos <p>
   1007  1.1  christos <pre>
   1008  1.1  christos 	.DROPCAP_GUTTER 6p
   1009  1.1  christos </pre>
   1010  1.1  christos 
   1011  1.1  christos <!---\*[SUP]--->
   1012  1.1  christos 
   1013  1.1  christos <hr width="66%" align="left">
   1014  1.1  christos <a name="SUP"><h3><u>Superscript</u></h3></a>
   1015  1.1  christos <br>
   1016  1.1  christos Inlines: <strong>\*[SUP]...\*[SUPX]</strong>
   1017  1.1  christos 
   1018  1.1  christos <p>
   1019  1.1  christos Superscripts are accomplished
   1020  1.1  christos <a href="definitions.html#TERMS_INLINES">inline</a>.
   1021  1.1  christos Whenever you need one, typically for numerals, all you need to
   1022  1.1  christos do is surround the superscript with the inlines above.
   1023  1.1  christos <strong>\*[SUP]</strong> begins superscripting;
   1024  1.1  christos <strong>\*[SUPX]</strong> turns it off.
   1025  1.1  christos <a name="CONDSUP"></a>
   1026  1.1  christos <a name="EXTSUP"></a>
   1027  1.1  christos <p>
   1028  1.1  christos If your running type is
   1029  1.1  christos <a href="#COND_INLINE">pseudo-condensed</a>
   1030  1.1  christos or
   1031  1.1  christos <a href="#EXT_INLINE">pseudo-extended</a>
   1032  1.1  christos and you want your superscripts to be equivalently pseudo-condensed or
   1033  1.1  christos -extended, use <strong>\*[CONDSUP]...\*[CONDSUPX]</strong> or
   1034  1.1  christos <strong>\*[EXTSUP]...\*[EXTSUPX]</strong>.
   1035  1.1  christos <p>
   1036  1.1  christos The superscript inlines are primarily used by the
   1037  1.1  christos <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>
   1038  1.1  christos for automatic generation of numbered footnotes.  However, you may
   1039  1.1  christos find them useful for other purposes.
   1040  1.1  christos <p>
   1041  1.1  christos <strong>NOTE:</strong> <strong>Mom</strong> does a pretty fine job of
   1042  1.1  christos making superscripts look good in any font and at any size.  If you're
   1043  1.1  christos fussy, though (and I am), about precise vertical placement, kerning,
   1044  1.1  christos weight, size, and so on, you may want to roll your own solution.
   1045  1.1  christos And sorry, there's no <strong>mom</strong> equivalent for subscripts.
   1046  1.1  christos I'm neither a mathematician nor a chemist, so I don't need them.
   1047  1.1  christos Of course, anyone who wishes to contribute a subscript routine to
   1048  1.1  christos <strong>mom</strong> will receive eternal blessings not only in this
   1049  1.1  christos lifetime, but in all lifetimes to come.
   1050  1.1  christos <p>
   1051  1.1  christos <hr>
   1052  1.1  christos <a href="inlines.html#TOP">Next</a>&nbsp;&nbsp;
   1053  1.1  christos <a href="typesetting.html#TOP">Prev</a>&nbsp;&nbsp;
   1054  1.1  christos <a href="#TOP">Top</a>&nbsp;&nbsp;
   1055  1.1  christos <a href="toc.html">Back to Table of Contents</a>
   1056  1.1  christos </body>
   1057  1.1  christos </html>
   1058