contrib/mom/momdoc/macrolist.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!--
   3 This file is part of groff, the GNU roff type-setting system.
   4
   5 Copyright (C) 2004-2018 Free Software Foundation, Inc.
   6 Written by Peter Schaffter (peter@schaffter.ca).
   7
   8 Permission is granted to copy, distribute and/or modify this document
   9 under the terms of the GNU Free Documentation License, Version 1.3 or
  10 any later version published by the Free Software Foundation; with no
  11 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  12 Texts.
  13
  14 A copy of the Free Documentation License is included as a file called
  15 FDL in the main directory of the groff source package.
  16 -->
  17
  18 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  19 <html xmlns="http://www.w3.org/1999/xhtml">
  20
  21 <head>
  22   <meta http-equiv="content-type" content="text/html;charset=utf-8"/>
  23   <title>Mom -- Quick reference guide</title>
  24   <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  25 </head>
  26
  27 <body style="background-color: #f5faff;">
  28
  29 <!-- ==================================================================== -->
  30
  31 <div id="top" class="page" style="width: 800px">
  32
  33 <!-- Navigation links -->
  34 <table style="width: 100%;">
  35 <tr>
  36   <td><a href="toc.html">Back to Table of Contents</a></td>
  37   <td style="text-align: right;"><a href="appendices.html#top">Next: Appendices</a></td>
  38 </tr>
  39 </table>
  40
  41 <h1 class="docs">Quick reference guide</h1>
  42
  43 <p>
  44 Once you know your way around mom, you may find this guide
  45 preferable to using the Table of Contents.  It lists mom&#8217;s
  46 major user-space macros.  The links point to references found
  47 elsewhere in the documentation.
  48 </p>
  49
  50 <div class="macro-list-container" style="padding-left: 9px; padding-right: 9px; padding-bottom: 1px;">
  51 <h2 class="docs" style="text-align: center; padding-top: 15px;">Index to the quick reference guide</h2>
  52 <div style="width: 50%; float: left; margin-right: 9px;">
  53 <h3 class="docs" style="margin-top: 1.25em;">TYPESETTING MACROS</h3>
  54 <ul style="margin-top: .5em; margin-left: 0; padding-left: 0; list-style-type: none;">
  55   <li><a href="#qr-1">Paper size, margins, line length</a></li>
  56   <li><a href="#qr-2">Family, font, point size</a></li>
  57   <li><a href="#qr-3">Font modifications</a></li>
  58   <li><a href="#qr-4">Linespacing (leading)</a></li>
  59   <li><a href="#qr-5">Justification, quad, breaking lines</a></li>
  60   <li><a href="#qr-6">Hyphenation</a></li>
  61   <li><a href="#qr-7">Word and sentence spacing</a></li>
  62   <li><a href="#qr-8">Kerning, ligatures, smartquotes</a></li>
  63   <li><a href="#qr-9">Horizontal/vertical motions, columns</a></li>
  64   <li><a href="#qr-10">Indents</a></li>
  65   <li><a href="#qr-11">Tabs</a></li>
  66   <li><a href="#qr-12">Underscoring, underlining</a></li>
  67   <li><a href="#qr-13">Superscipts</a></li>
  68   <li><a href="#qr-14">Nested lists</a></li>
  69   <li><a href="#qr-15">Colour</a></li>
  70   <li><a href="#qr-16">Dropcaps</a></li>
  71   <li><a href="#qr-56">Smallcaps</a></li>
  72   <li><a href="#qr-17">Utilities</a></li>
  73   <li><a href="#qr-18">Graphical objects and images</a></li>
  74 </ul>
  75 <h3 class="docs" style="margin-top: -.5em;">DOCUMENT PROCESSING MACROS</h3>
  76 <ul style="margin-top: .5em; margin-left: 0; padding-left: 0; list-style-type: none;">
  77   <li><a href="#qr-19">Reference macros (metadata)</a></li>
  78   <li><a href="#qr-20">Document type and initial defaults</a></li>
  79   <li><a href="#qr-59">&nbsp;&nbsp;&ndash;&nbsp;Slides</a></li>
  80   <li><a href="#qr-23">TYPEWRITE control macros</a></li>
  81   <li><a href="#qr-57">Vertical whitespace management</a></li>
  82   <li><a href="#qr-47">Document and section cover (title) pages</a></li>
  83   <li><a href="#qr-22">Set documents in columns</a></li>
  84   <li><a href="#qr-21">Line numbering</a></li>
  85   <li><a href="#qr-24">Initiate document processing</a></li>
  86 </ul>
  87 </div>
  88 <ul style="margin-top: 2.75em; margin-left: 0; padding-left: 0; list-style-type: none;">
  89   <li><a href="#qr-42">Global print style changes after START</a></li>
  90   <li><a href="#qr-43">Managing the docheader</a></li>
  91   <li><a href="#qr-25">Epigraphs</a></li>
  92   <li><a href="#qr-26">Headings</a></li>
  93   <li><a href="#qr-30">Paragraphs</a></li>
  94   <li><a href="#qr-31">Quotes (line for line quotes)</a> </li>
  95   <li><a href="#qr-32">Blockquotes (cited passages of text)</a></li>
  96   <li><a href="#qr-33">Code snippets (inserting bits of programming code)</a></li>
  97   <li><a href="#qr-34">Author linebreaks (section breaks)</a></li>
  98   <li><a href="#qr-35">Document termination string</a></li>
  99   <li><a href="#qr-36">Footnotes</a></li>
 100   <li><a href="#qr-37">Endnotes</a></li>
 101   <li><a href="#qr-38">Margin notes</a></li>
 102   <li><a href="#qr-49">Floats</a></li>
 103   <li><a href="#qr-53">Images and graphics</a></li>
 104   <li><a href="#qr-51">eqn support</a></li>
 105   <li><a href="#qr-52">pic support</a></li>
 106   <li><a href="#qr-58">grap support</a></li>
 107   <li><a href="#qr-50">tbl support</a></li>
 108   <li><a href="#qr-54">Captions and labels</a></li>
 109   <li><a href="#qr-39">Bibliographic references</a></li>
 110   <li><a href="#qr-40">Tables of contents</a></li>
 111   <li><a href="#qr-55">Lists of Figures, Tables, and Equations</a></li>
 112   <li><a href="#qr-41">Letter (correspondence) macros</a></li>
 113   <li><a href="#qr-44">Managing page headers and footers</a></li>
 114   <li><a href="#qr-45">Recto/verso page headers and footers</a></li>
 115   <li><a href="#qr-46">Pagination</a></li>
 116   <li><a href="#qr-48">Utilities</a></li>
 117 </ul>
 118 <br/>
 119 </div>
 120
 121 <h2 class="docs">Quick reference guide</h2>
 122
 123 <div style="display: inline-block; margin-top: 1em; margin-bottom: .5em; border-bottom: 2px solid #302419;"><kbd>TYPESETTING MACROS</kbd></div>
 124
 125 <table class="quick-ref">
 126 <tr>
 127 <th id="qr-1" class="quick-ref" colspan="2">
 128 <a href="typesetting.html#page-setup-intro">+++ Paper size, margins, line length</a></th>
 129 </tr>
 130 <tr>
 131 <td><a href="typesetting.html#paper">PAPER</a></td><td>-- set common paper sizes (letter, A4, etc)</td>
 132 </tr>
 133 <tr>
 134 <td><a href="typesetting.html#pagewidth">PAGEWIDTH</a></td><td>-- set a custom page width</td>
 135 </tr>
 136 <tr>
 137 <td><a href="typesetting.html#pagelength">PAGELENGTH</a></td><td>-- set a custom page length</td>
 138 </tr>
 139 <tr>
 140 <td><a href="typesetting.html#page">PAGE</a></td><td>-- set explicit page dimensions and margins</td>
 141 </tr>
 142 <tr>
 143 <td><a href="typesetting.html#t-margin">T_MARGIN</a></td><td>-- set a top margin</td>
 144 </tr>
 145 <tr>
 146 <td><a href="typesetting.html#b-margin">B_MARGIN</a></td><td>-- set a bottom margin</td>
 147 </tr>
 148 <tr>
 149 <td><a href="typesetting.html#l-margin">L_MARGIN</a></td><td>-- set a left margin (page offset)</td>
 150 </tr>
 151 <tr>
 152 <td><a href="typesetting.html#r-margin">R_MARGIN</a></td><td>-- set a right margin</td>
 153 </tr>
 154 <tr>
 155 <td><a href="typesetting.html#linelength">LL</a></td><td>-- set a line length</td>
 156 </tr>
 157 </table>
 158
 159 <table class="quick-ref">
 160 <tr><th id="qr-2" class="quick-ref" colspan="2">
 161 <a href="typesetting.html#basic-params-intro">+++ Family, font, point size</a></th></tr>
 162 <tr>
 163 <td><a href="typesetting.html#family">FAMILY</a></td><td>-- set the family of type</td>
 164 </tr>
 165 <tr>
 166 <td><a href="typesetting.html#font">FT</a></td><td>-- set the font style (roman, italic, etc)</td>
 167 </tr>
 168 <tr>
 169 <td><a href="typesetting.html#fallback-font">FALLBACK_FONT</a></td><td>-- establish a fallback font (for missing fonts)</td>
 170 </tr>
 171 <tr>
 172 <td><a href="typesetting.html#ps">PT_SIZE</a></td><td>-- set the point size</td>
 173 </tr>
 174 <tr>
 175 <td><a href="inlines.html#inline-size-mom">\*[SIZE n]</a></td><td>-- change the point size inline</td>
 176 </tr>
 177 </table>
 178
 179 <table class="quick-ref">
 180 <tr>
 181 <th id="qr-3" class="quick-ref" colspan="2">
 182 <a href="typesetting.html#modifications-intro">+++ Font modifications</a></th>
 183 </tr>
 184 <tr><td style="padding-left: 0;">Pseudo italic</td></tr>
 185 <tr>
 186 <td><a href="typesetting.html#setslant">SETSLANT</a></td><td>-- set the degree of slant</td>
 187 </tr>
 188 <tr>
 189 <td><a href="typesetting.html#slant-inline">\*[SLANT]</a></td><td>-- invoke pseudo italic inline</td>
 190 </tr>
 191 <tr>
 192 <td><a href="typesetting.html#slant-inline">\*[SLANTX]</a></td><td>-- turn off pseudo italic inline</td>
 193 </tr>
 194 <tr><td style="padding-left: 0;">Pseudo bold</td></tr>
 195 <tr>
 196 <td><a href="typesetting.html#setbolder">SETBOLDER</a></td><td>-- set the amount of emboldening</td>
 197 </tr>
 198 <tr>
 199 <td><a href="typesetting.html#bolder-inline">\*[BOLDER]</a></td><td>-- invoke pseudo bold inline</td>
 200 </tr>
 201 <tr>
 202 <td><a href="typesetting.html#bolder-inline">\*[BOLDERX]</a></td><td>-- turn off pseudo bold inline</td>
 203 </tr>
 204 <tr><td style="padding-left: 0;">Pseudo condensed</td></tr>
 205 <tr>
 206 <td><a href="typesetting.html#condense">CONDENSE</a></td><td>-- set the amount to pseudo condense</td>
 207 </tr>
 208 <tr>
 209 <td><a href="typesetting.html#cond-inline">\*[COND]</a></td><td>-- invoke pseudo condensing inline</td>
 210 </tr>
 211 <tr>
 212 <td><a href="typesetting.html#cond-inline">\*[CONDX]</a></td><td>-- turn off pseudo condensing inline</td>
 213 </tr>
 214 <tr><td style="padding-left: 0;">Pseudo extended</td></tr>
 215 <tr>
 216 <td><a href="typesetting.html#extend">EXTEND</a></td><td>-- set the amount to pseudo extend</td>
 217 </tr>
 218 <tr>
 219 <td><a href="typesetting.html#ext-inline">\*[EXT]</a></td><td>-- invoke pseudo extending inline</td>
 220 </tr>
 221 <tr>
 222 <td><a href="typesetting.html#ext-inline">\*[EXTX]</a></td><td>-- turn off pseudo condensing inline</td>
 223 </tr>
 224 </table>
 225
 226 <table class="quick-ref">
 227 <tr>
 228 <th id="qr-4" class="quick-ref" colspan="2">
 229 <a href="typesetting.html#leading">+++ Linespacing (leading)</a></th>
 230 </tr>
 231 <tr>
 232 <td><a href="typesetting.html#leading">LS</a></td><td>-- set the linespacing (leading)</td>
 233 </tr>
 234 <tr>
 235 <td><a href="typesetting.html#autolead">AUTOLEAD</a></td><td>-- set the linespacing relative to the point size</td>
 236 </tr>
 237 </table>
 238
 239 <table class="quick-ref">
 240 <tr>
 241 <th id="qr-5" class="quick-ref" colspan="2">
 242 <a href="typesetting.html#justification-intro">+++ Justification, quad direction, line-by-line setting, breaking lines</a></th>
 243 </tr>
 244 <tr>
 245 <td><a href="typesetting.html#justify">JUSTIFY</a></td><td>-- justify text to both margins</td>
 246 </tr>
 247 <tr>
 248 <td><a href="typesetting.html#quad">QUAD</a></td><td>-- "justify" text left, centre, or right</td>
 249 </tr>
 250 <tr>
 251 <td><a href="typesetting.html#lrc">LEFT</a></td><td>-- set line-by-line quad left</td>
 252 </tr>
 253 <tr>
 254 <td><a href="typesetting.html#lrc">CENTER</a></td><td>-- set line-by-line quad centre</td>
 255 </tr>
 256 <tr>
 257 <td><a href="typesetting.html#lrc">RIGHT</a></td><td>-- set line-by-line quad right</td>
 258 </tr>
 259 <tr>
 260 <td><a href="typesetting.html#br">BR</a></td><td>-- break a justified line</td>
 261 </tr>
 262 <tr>
 263 <td><a href="typesetting.html#spread">SPREAD</a></td><td>-- force justify a line</td>
 264 </tr>
 265 <tr>
 266 <td><a href="typesetting.html#el">EL</a></td><td>-- break a line without advancing on the page</td>
 267 </tr>
 268 </table>
 269
 270 <table class="quick-ref">
 271 <tr>
 272 <th id="qr-6" class="quick-ref" colspan="2">
 273 <a href="typesetting.html#hy">+++ Hyphenation</a></th>
 274 </tr>
 275 <tr>
 276 <td><a href="typesetting.html#hy">HY</a></td><td>-- automatic hyphenation on/off</td>
 277 </tr>
 278 <tr>
 279 <td><a href="typesetting.html#hy-set">HY_SET</a></td><td>-- set automatic hyphenation parameters</td>
 280 </tr>
 281 </table>
 282
 283 <table class="quick-ref">
 284 <tr>
 285 <th id="qr-7" class="quick-ref" colspan="2">
 286 <a href="typesetting.html#ws">+++ Word and sentence spacing</a></th>
 287 </tr>
 288 <tr>
 289 <td><a href="typesetting.html#ws">WS</a></td><td>-- set the minimum word space size</td>
 290 </tr>
 291 <tr>
 292 <td><a href="typesetting.html#ss">SS</a></td><td>-- set the sentence space size</td>
 293 </tr>
 294 </table>
 295
 296 <table class="quick-ref">
 297 <tr>
 298 <th id="qr-8" class="quick-ref" colspan="2">
 299 <a href="typesetting.html#kern">+++ Kerning, ligatures, smartquotes</a></th>
 300 </tr>
 301 <tr>
 302 <td><a href="typesetting.html#kern">KERN</a></td><td>-- automatic character pair kerning on/off</td>
 303 </tr>
 304 <tr>
 305 <td><a href="inlines.html#inline-kerning-mom">\*[BU n]</a></td><td>-- move characters pairs closer together inline</td>
 306 </tr>
 307 <tr>
 308 <td><a href="inlines.html#inline-kerning-mom">\*[FU n]</a></td><td>-- move character pairs further apart inline</td>
 309 </tr>
 310 <tr>
 311 <td><a href="typesetting.html#rw">RW</a></td><td>-- uniformly tighten space between characters</td>
 312 </tr>
 313 <tr>
 314 <td><a href="typesetting.html#ew">EW</a></td><td>-- uniformly loosen space between characters</td>
 315 </tr>
 316 <tr>
 317 <td><a href="typesetting.html#br-at-line-kern">BR_AT_LINE_KERN</a></td><td>-- break previous line when RW or EW is invoked</td>
 318 </tr>
 319 <tr>
 320 <td><a href="typesetting.html#ligatures">LIGATURES</a></td><td>-- automatic generation of ligatures on/off</td>
 321 </tr>
 322 <tr>
 323 <td><a href="goodies.html#smartquotes">SMARTQUOTES</a></td><td>-- smartquoting on/off</td>
 324 </tr>
 325 </table>
 326
 327 <table class="quick-ref">
 328 <tr>
 329 <th id="qr-9" class="quick-ref" colspan="2">
 330 <a href="typesetting.html#aldrld-intro">+++ Horizontal and vertical movements, columnar setting</a></th>
 331 </tr>
 332 <tr>
 333 <td><a href="typesetting.html#ald">ALD</a></td><td>-- move downards on the page</td>
 334 </tr>
 335 <tr>
 336 <td><a href="typesetting.html#rld">RLD</a></td><td>-- move upwards on the page</td>
 337 </tr>
 338 <tr>
 339 <td><a href="typesetting.html#space">SPACE</a></td><td>-- insert space between lines on a page</td>
 340 </tr>
 341 <tr>
 342 <td><a href="inlines.html#down">\*[DOWN n]</a></td><td>-- temporarily move downwards in a line</td>
 343 </tr>
 344 <tr>
 345 <td><a href="inlines.html#up">\*[UP n]</a></td><td>-- temporarily move upwards in a line</td>
 346 </tr>
 347 <tr>
 348 <td><a href="inlines.html#fwd">\*[FWD n]</a></td><td>-- move forward in a line</td>
 349 </tr>
 350 <tr>
 351 <td><a href="inlines.html#bck">\*[BCK n]</a></td><td>-- move backwards in a line</td>
 352 </tr>
 353 <tr>
 354 <td><a href="typesetting.html#mco">MCO</a></td><td>-- multiple columns on</td>
 355 </tr>
 356 <tr>
 357 <td><a href="typesetting.html#mcr">MCR</a></td><td>-- recto vertical position of column start</td>
 358 </tr>
 359 <tr>
 360 <td><a href="typesetting.html#mcx">MCX</a></td><td>-- multiple columns off, advance past longest column</td>
 361 </tr>
 362 </table>
 363
 364 <table class="quick-ref">
 365 <tr>
 366 <th id="qr-10" class="quick-ref" colspan="2">
 367 <a href="typesetting.html#indents-intro">+++ Indents</a></th>
 368 </tr>
 369 <tr>
 370 <td><a href="typesetting.html#il">IL</a></td><td>-- set and turn on a left indent</td>
 371 </tr>
 372 <tr>
 373 <td><a href="typesetting.html#ir">IR</a></td><td>-- set and turn on a right indent</td>
 374 </tr>
 375 <tr>
 376 <td><a href="typesetting.html#ib">IB</a></td><td>-- set and turn on indents both left and right</td>
 377 </tr>
 378 <tr>
 379 <td><a href="typesetting.html#iq">IQ</a></td><td>-- quit (exit) all indents</td>
 380 </tr>
 381 <tr>
 382 <td><a href="typesetting.html#ti">TI</a></td><td>-- set and turn on a temporary (one line) indent</td>
 383 </tr>
 384 <tr>
 385 <td><a href="typesetting.html#hi">HI</a></td><td>-- set and turn on a hanging indent</td>
 386 </tr>
 387 <tr>
 388 <td><a href="typesetting.html#iq">ILX</a></td><td>-- left indents off</td>
 389 </tr>
 390 <tr>
 391 <td><a href="typesetting.html#iq">IRX</a></td><td>-- right indents off</td>
 392 </tr>
 393 <tr>
 394 <td><a href="typesetting.html#iq">IBX</a></td><td>-- both left and right indents off</td>
 395 </tr>
 396 </table>
 397
 398 <table class="quick-ref">
 399 <tr>
 400 <th id="qr-11" class="quick-ref" colspan="2">
 401 <a href="typesetting.html#tabs-intro">+++ Tabs</a></th>
 402 </tr>
 403 <tr>
 404 <td><a href="typesetting.html#tab-set">TAB_SET</a></td><td>-- set up a typesetting tab</td>
 405 </tr>
 406 <tr>
 407 <td><a href="typesetting.html#tab">TAB &lt;n&gt;</a></td><td>-- call tab &lt;n&gt;</td>
 408 </tr>
 409 <tr>
 410 <td><a href="typesetting.html#tq">TQ</a></td><td>-- quit (exit) tabs</td>
 411 </tr>
 412 <tr>
 413 <td><a href="typesetting.html#inline-st">\*[ST&lt;n&gt;]...</a></td><td>-- string tabs (mark tab positions inline)</td>
 414 </tr>
 415 <tr>
 416 <td><a href="typesetting.html#inline-st">\*[ST&lt;n&gt;X]</a>
 417 </tr>
 418 <tr>
 419 <td><a href="typesetting.html#tn">TN</a></td><td>-- move to tab&lt;n+1&gt; without advancing on the page</td>
 420 </tr>
 421 <tr>
 422 <td><a href="typesetting.html#st">ST</a></td><td>-- set quad/fill for string tabs</td>
 423 </tr>
 424 </table>
 425
 426 <table class="quick-ref">
 427 <tr>
 428 <th id="qr-12" class="quick-ref" colspan="2">
 429 <a href="goodies.html#underscore">+++ Underscoring, underlining</a></th>
 430 </tr>
 431 <tr>
 432 <td><a href="goodies.html#underscore">UNDERSCORE</a></td><td>-- underscore</td>
 433 </tr>
 434 <tr>
 435 <td><a href="goodies.html#underscore2">UNDERSCORE2</a></td><td>-- double underscore</td>
 436 </tr>
 437 <tr>
 438 <td><a href="goodies.html#underline">UNDERLINE</a></td><td>-- underline (fixed width fonts only)</td>
 439 </tr>
 440 <tr>
 441 <td><a href="goodies.html#ul">\*[UL]...</a></td><td>-- invoke underlining inline (fixed width fonts only)</td>
 442 </tr>
 443 <tr>
 444 <td><a href="goodies.html#ul">\*[ULX]</a></td>
 445 </tr>
 446 </table>
 447
 448 <table class="quick-ref">
 449 <tr>
 450 <th id="qr-13" class="quick-ref" colspan="2">
 451 <a href="goodies.html#sup">+++ Superscipts</a></th>
 452 </tr>
 453 <tr>
 454 <td><a href="goodies.html#sup">\*[SUP]...\*[SUPX]</a></td><td>-- superscript</td>
 455 </tr>
 456 <tr>
 457 <td><a href="goodies.html#sup">\*[CONDSUP]...\*[CONDSUPX]</a></td><td>-- pseudo-condensed superscript</td>
 458 </tr>
 459 <tr>
 460 <td><a href="goodies.html#sup">\*[EXTSUP]...\*[EXTSUPX]</a></td><td>-- pseudo extended supercript</td>
 461 </tr>
 462 <tr>
 463 <td><a href="goodies.html#sup-raise">SUPERSCRIPT_RAISE_AMOUNT</a></td><td>-- vertical offset of superscripts</td>
 464 </tr>
 465 </table>
 466
 467 <table class="quick-ref">
 468 <tr>
 469 <th id="qr-14" class="quick-ref" colspan="2">
 470 <a href="docelement.html#list-intro">+++ Nested lists</a></th>
 471 </tr>
 472 <tr>
 473 <td><a href="docelement.html#list">LIST</a></td><td>-- begin a list</td>
 474 </tr>
 475 <tr>
 476 <td><a href="docelement.html#item">ITEM</a></td><td>-- begin an item in a list</td>
 477 </tr>
 478 <tr>
 479 <td><a href="docelement.html#shift-list">SHIFT_LIST</a></td><td>-- change the indent of a list</td>
 480 </tr>
 481 <tr>
 482 <td><a href="docelement.html#reset-list">RESET_LIST</a></td><td>-- clear and reset a list&#8217;s enumerator</td>
 483 </tr>
 484 <tr>
 485 <td><a href="docelement.html#pad-list-digits">PAD_LIST_DIGITS</a></td><td>-- reserve space for digits</td>
 486 </tr>
 487 </table>
 488
 489 <table class="quick-ref">
 490 <tr>
 491 <th id="qr-15" class="quick-ref" colspan="2">
 492 <a href="color.html#color-intro">+++ Colour</a></th>
 493 </tr>
 494 <tr>
 495 <td><a href="color.html#newcolor">NEWCOLOR</a></td><td>-- initialize (define) a colour</td>
 496 </tr>
 497 <tr>
 498 <td><a href="color.html#color">COLOR</a></td><td>-- begin using an initialized colour</td>
 499 </tr>
 500 <tr>
 501 <td><a href="color.html#xcolor">XCOLOR</a></td><td>-- initialize a "named" X colour</td>
 502 </tr>
 503 <tr>
 504 <td><a href="color.html#color-inline">\*[&lt;colorname&gt;]</a></td><td>-- begin using an initialized colour inline</td>
 505 </tr>
 506 </table>
 507
 508 <table class="quick-ref">
 509 <tr>
 510 <th id="qr-16" class="quick-ref" colspan="2">
 511 <a href="goodies.html#dropcap">+++ Dropcaps</a></th>
 512 </tr>
 513 <tr>
 514 <td><a href="goodies.html#dropcap">DROPCAP</a></td><td>-- set a dropcap</td>
 515 </tr>
 516 <tr>
 517 <td><a href="goodies.html#dropcap-family">DROPCAP_FAMILY</a></td><td>-- set a dropcap&#8217;s family</td>
 518 </tr>
 519 <tr>
 520 <td><a href="goodies.html#dropcap-font">DROPCAP_FONT</a></td><td>-- set a dropcap&#8217;s font style</td>
 521 </tr>
 522 <tr>
 523 <td><a href="goodies.html#dropcap-color">DROPCAP_COLOR</a></td><td>-- set a dropcap&#8217;s colour</td>
 524 </tr>
 525 <tr>
 526 <td><a href="goodies.html#dropcap-adjust">DROPCAP_ADJUST</a></td><td>-- adjust size of a dropcap</td>
 527 </tr>
 528 <tr>
 529 <td><a href="goodies.html#dropcap-gutter">DROPCAP_GUTTER</a></td><td>-- adjust space between a dropcap and regular text</td>
 530 </tr>
 531 </table>
 532
 533 <table class="quick-ref">
 534 <tr>
 535 <th id="qr-56" class="quick-ref" colspan="2">
 536 <a href="typesetting.html#smallcaps">+++ Smallcaps</a></th>
 537 </tr>
 538 <tr>
 539 <td><a href="typesetting.html#smallcaps">SMALLCAPS</a></td>
 540 </tr>
 541 <tr>
 542 <td><a href="typesetting.html#smallcaps-style">SMALLCAPS_STYLE</a></td>
 543 </tr>
 544 </table>
 545
 546
 547 <table class="quick-ref">
 548 <tr>
 549 <th id="qr-17" class="quick-ref" colspan="2">+++ Utilities</th>
 550 </tr>
 551 <tr>
 552 <td><a href="goodies.html#alias">ALIAS</a></td><td>-- give a macro a new name</td>
 553 </tr>
 554 <tr>
 555 <td><a href="goodies.html#caps">CAPS</a></td><td>-- set type all caps</td>
 556 </tr>
 557 <tr>
 558 <td><a href="goodies.html#silent">COMMENT</a></td><td>-- silently embed comments in a document</td>
 559 </tr>
 560 <tr>
 561 <td><a href="goodies.html#esc-char">ESC_CHAR</a></td><td>-- change the default escape character</td>
 562 </tr>
 563 <tr>
 564 <td><a href="goodies.html#leader">\*[LEADER]</a></td><td>-- insert leaders at the end of a line</td>
 565 </tr>
 566 <tr>
 567 <td><a href="goodies.html#leader-character">LEADER_CHARACTER</a></td><td>-- change the character used for leaders</td>
 568 </tr>
 569 <tr>
 570 <td><a href="typesetting.html#newpage">NEWPAGE</a></td><td>-- break to a new page</td>
 571 </tr>
 572 <tr>
 573 <td><a href="docprocessing.html#newslide">NEWSLIDE</a></td><td>-- break to a new slide</td>
 574 </tr>
 575 <tr>
 576 <td><a href="docprocessing.html#pause">PAUSE</a></td><td>-- pause slide presentation</td>
 577 </tr>
 578 <tr>
 579 <td><a href="docprocessing.html#transition">TRANSITION</a></td><td>-- transition effect for slides</td>
 580 </tr>
 581 <tr>
 582 <td><a href="goodies.html#pad">PAD</a></td><td>-- insert equalized whitespace into a line</td>
 583 </tr>
 584 <tr>
 585 <td><a href="goodies.html#pad-marker">PAD_MARKER</a></td><td>-- change the pad marker</td>
 586 </tr>
 587 <tr>
 588 <td><a href="inlines.html#inline-rule-mom">\*[RULE]</a></td><td>-- draw a full measure rule</td>
 589 </tr>
 590 <tr>
 591 <td><a href="goodies.html#sizespecs">SIZESPECS</a></td><td>-- get cap-height, x-height and descender depth</td>
 592 </tr>
 593 <tr>
 594 <td><a href="goodies.html#silent">SILENT</a></td><td>-- output processing off or on</td>
 595 </tr>
 596 <tr>
 597 <td><a href="goodies.html#trap">TRAP</a></td><td>-- enable or disable page position traps</td>
 598 </tr>
 599 </table>
 600
 601 <table class="quick-ref">
 602 <tr>
 603 <th id="qr-18" class="quick-ref" colspan="2">
 604 <a href="graphical.html#intro-graphical">+++ Graphical objects and images</a></th>
 605 </tr>
 606 <tr>
 607 <td><a href="graphical.html#drh">DRH</a></td><td>-- draw a horizontal rule</td>
 608 </tr>
 609 <tr>
 610 <td><a href="graphical.html#drv">DRV</a></td><td>-- draw a vertical rule</td>
 611 </tr>
 612 <tr>
 613 <td><a href="graphical.html#dbx">DBX</a></td><td>-- draw a box</td>
 614 </tr>
 615 <tr>
 616 <td><a href="graphical.html#dcl">DCL</a></td><td>-- draw a circle (ellipse)</td>
 617 </tr>
 618 <tr>
 619 <td><a href="inlines.html#rule-weight">RULE_WEIGHT</a></td><td>-- set weight of rules drawn with \*[RULE]</td>
 620 </tr>
 621 <tr>
 622 <td><a href="images.html#pdf-image">PDF_IMAGE</a></td><td>-- insert a PDF image</td>
 623 </tr>
 624 <tr>
 625 <td><a href="images.html#pspic">PSPIC</a></td><td>-- insert a PostScript image</td>
 626 </tr>
 627 </table>
 628
 629 <div style="display: inline-block; margin-top: 1em; margin-bottom: .5em; border-bottom: 2px solid #302419;"><kbd>DOCUMENT PROCESSING MACROS</kbd></div>
 630
 631 <table class="quick-ref">
 632 <tr>
 633 <th id="qr-19" class="quick-ref" colspan="2">
 634 <a href="docprocessing.html#reference-macros">+++ Reference macros</a></th>
 635 </tr>
 636 <tr>
 637 <td><a href="docprocessing.html#title">TITLE</a></td><td>-- document title</td>
 638 </tr>
 639 <tr>
 640 <td><a href="docprocessing.html#doc-title">DOCTITLE</a></td><td>-- overall document title (if different from TITLE)</td>
 641 </tr>
 642 <tr>
 643 <td><a href="docelement.html#endnote-title">ENDNOTE_TITLE</a></td><td>-- document/chapter id string for endnotes</td>
 644 </tr>
 645 <tr>
 646 <td><a href="docprocessing.html#chapter">CHAPTER</a></td><td>-- chapter number</td>
 647 </tr>
 648 <tr>
 649 <td><a href="docprocessing.html#chapter-title">CHAPTER_TITLE</a></td><td>-- chapter title</td>
 650 </tr>
 651 <tr>
 652 <td><a href="docprocessing.html#chapter-string">CHAPTER_STRING</a></td><td>-- what to use in place of &#8220;Chapter&#8221;</td>
 653 </tr>
 654 <tr>
 655 <td><a href="docprocessing.html#subtitle">SUBTITLE</a></td><td>-- document subtitle</td>
 656 </tr>
 657 <tr>
 658 <td><a href="docprocessing.html#author">AUTHOR</a></td><td>-- document author(s)</td>
 659 </tr>
 660 <tr>
 661 <td><a href="docprocessing.html#covertitle">DOC_COVERTITLE</a></td><td>-- document title cover</td>
 662 </tr>
 663 <tr>
 664 <td><a href="docprocessing.html#covertitle">COVERTITLE</a></td><td>-- section cover title</td>
 665 </tr>
 666 <tr>
 667 <td><a href="docprocessing.html#copyright">COPYRIGHT</a></td><td>-- copyright</td>
 668 </tr>
 669 <tr>
 670 <td><a href="docprocessing.html#misc">MISC</a></td><td>-- miscellaneous cover information</td>
 671 </tr>
 672 <tr>
 673 <td><a href="docprocessing.html#draft">DRAFT</a></td><td>-- document&#8217;s draft number</td>
 674 </tr>
 675 <tr>
 676 <td><a href="docprocessing.html#draft-string">DRAFT_STRING</a></td><td>-- what to use in place of &#8220;Draft&#8221;</td>
 677 </tr>
 678 <tr>
 679 <td><a href="docprocessing.html#revision">REVISION</a></td><td>-- document&#8217;s revision number</td>
 680 </tr>
 681 <tr>
 682 <td><a href="docprocessing.html#revision-string">REVISION_STRING</a></td><td>-- what to use in place of &#8220;Revision&#8221;</td>
 683 </tr>
 684 </table>
 685
 686 <table class="quick-ref">
 687 <tr>
 688 <th id="qr-20" class="quick-ref" colspan="2">
 689 <a href="docprocessing.html#docstyle-macros">+++ General document formatting directives</a></th>
 690 </tr>
 691 <tr>
 692 <td><a href="docprocessing.html#doctype">DOCTYPE</a></td><td>-- general document type</td>
 693 </tr>
 694 <tr>
 695 <td id="qr-59"><a href="docprocessing.html#slides">DOCTYPE SLIDES</a></td><td>-- create slide presentation</td>
 696 </tr>
 697 <tr>
 698 <td><a href="docprocessing.html#copystyle">COPYSTYLE</a></td><td>-- draft or final copy</td>
 699 </tr>
 700 <tr>
 701 <td><a href="docprocessing.html#printstyle">PRINTSTYLE</a></td><td>-- typeset or &#8220;typewritten&#8221;</td>
 702 </tr>
 703 </table>
 704
 705 <table class="quick-ref">
 706 <tr>
 707 <th id="qr-21" class="quick-ref" colspan="2">
 708 <a href="docelement.html#number-lines-intro">+++ Line numbering</a></th>
 709 </tr>
 710 <tr>
 711 <td><a href="docelement.html#number-lines">NUMBER_LINES</a></td><td>-- automatic line numbering on/off</td>
 712 </tr>
 713 <tr>
 714 <td><a href="docelement.html#number-quote-lines">NUMBER_QUOTE_LINES</a></td><td>-- numbering of QUOTE lines on/off</td>
 715 </tr>
 716 <tr>
 717 <td><a href="docelement.html#number-blockquote-lines">NUMBER_BLOCKQUOTE_LINES</a></td><td>-- numbering of BLOCKQUOTE lines on/off</td>
 718 </tr>
 719 <tr>
 720 <td><a href="docelement.html#number-lines-control">Control macros</a></td><td>-- numbering of BLOCKQUOTE lines on/off</td>
 721 </tr>
 722 </table>
 723
 724 <table class="quick-ref">
 725 <tr>
 726 <th id="qr-22" class="quick-ref" colspan="2">
 727 <a href="docprocessing.html#columns-intro">+++ Set documents in columns</a></th>
 728 </tr>
 729 <tr>
 730 <td><a href="docprocessing.html#columns">COLUMNS</a></td>
 731 </tr>
 732 <tr>
 733 <td><a href="docprocessing.html#col-next">COL_NEXT</a></td>
 734 </tr>
 735 <tr>
 736 <td><a href="docprocessing.html#col-break">COL_BREAK</a></td>
 737 </tr>
 738 </table>
 739
 740 <table class="quick-ref">
 741 <tr>
 742 <th id="qr-23" class="quick-ref" colspan="2">+++ TYPEWRITE control macros</th>
 743 </tr>
 744 <tr>
 745 <td><a href="docprocessing.html#typewriter-underlining">UNDERLINE_ITALIC</a></td><td>--  underlining of italics on</td>
 746 </tr>
 747 <tr>
 748 <td><a href="docprocessing.html#printstyle-italics">UNDERLINE_QUOTES</a></td><td>--  underlining of QUOTEs on/off</td>
 749 </tr>
 750 <tr>
 751 <td><a href="docprocessing.html#printstyle-italics">ITALIC_MEANS_ITALIC</a></td><td>--  use real italics (not underlining)</td>
 752 </tr>
 753 <tr>
 754 <td><a href="docprocessing.html#typewriter-underlining">UNDERLINE_SLANT</a></td><td>--  underlining of pseudo-italics on</td>
 755 </tr>
 756 <tr>
 757 <td><a href="docprocessing.html#typewriter-underlining">SLANT_MEANS_SLANT</a></td><td>--  use pseudo italics (not underlining)</td>
 758 </tr>
 759 </table>
 760
 761 <table class="quick-ref">
 762 <tr>
 763 <th id="qr-24" class="quick-ref" colspan="2">
 764 <a href="docprocessing.html#start-macro">+++ Initiate document processing</a></th>
 765 </tr>
 766 <tr>
 767 <td><a href="docprocessing.html#start">START</a></td><td>-- begin document processing</td>
 768 </tr>
 769 </table>
 770
 771 <table class="quick-ref">
 772 <tr>
 773 <th id="qr-25" class="quick-ref" colspan="2">
 774 <a href="docelement.html#epigraph-intro">+++ Epigraphs</a></th>
 775 </tr>
 776 <tr>
 777 <td><a href="docelement.html#epigraph">EPIGRAPH</a></td><td>-- set an epigraph underneath the docheader</td>
 778 </tr>
 779 <tr>
 780 <td><a href="docelement.html#epigraph-control">Control macros</a></td><td>-- change default style of epigraphs</td>
 781 </tr>
 782 </table>
 783
 784 <table class="quick-ref">
 785 <tr>
 786 <th id="qr-26" class="quick-ref" colspan="2">
 787 <a href="docelement.html#heading-intro">+++ Headings</a></th>
 788 </tr>
 789 <tr>
 790 <td><a href="docelement.html#heading">HEADING</a></td><td>-- hierarchical headings</td>
 791 </tr>
 792 <tr>
 793 <td><a href="docelement.html#heading-control">Control macros</a></td><td>-- style heading levels</td>
 794 </tr>
 795 <td><a href="docelement.html#heading-style">&nbsp;HEADING_STYLE</a></td><td>-- set style parameters for heading levels</td>
 796 </tr>
 797 <td><a href="docelement.html#prefix-chapter-number">&nbsp;PREFIX_CHAPTER_NUMBER</a></td><td>-- add chapter number to heading numbering</td>
 798 </tr>
 799 </table>
 800
 801 <table class="quick-ref">
 802 <tr>
 803 <th id="qr-30" class="quick-ref" colspan="2">
 804 <a href="docelement.html#pp-intro">+++ Paragraphs</a></th>
 805 </tr>
 806 <tr>
 807 <td><a href="docelement.html#pp">PP</a></td><td>-- set a paragraph</td>
 808 </tr>
 809 <tr>
 810 <td><a href="docelement.html#pp-control">Control macros</a></td><td>-- managing paragraph style concerns</td>
 811 </tr>
 812 <tr>
 813 <td><a href="docelement.html#pp-font">&nbsp;PP_FONT</a></td><td>-- globally change font of regular paragraphs</td>
 814 </tr>
 815 <tr>
 816 <td><a href="docelement.html#para-indent">&nbsp;PARA_INDENT</a></td><td>-- set the paragraph first-line indent</td>
 817 </tr>
 818 <tr>
 819 <td><a href="docelement.html#para-indent-first">&nbsp;INDENT_FIRST_PARAS</a></td><td>-- indenting of paragraph first-lines on/off</td>
 820 </tr>
 821 <tr>
 822 <td><a href="docelement.html#pp-space">&nbsp;PARA_SPACE</a></td><td>-- linespace between paragraphs on/off</td>
 823 </tr>
 824 </table>
 825
 826 <table class="quick-ref">
 827 <tr>
 828 <th id="qr-31" class="quick-ref" colspan="2">
 829 <a href="docelement.html#quote-intro">+++ Quotes (line for line verbatim quotes)</a></th>
 830 </tr>
 831 <tr>
 832 <td><a href="docelement.html#quote">QUOTE</a></td><td>-- set quoted text line for line </td>
 833 </tr>
 834 <tr>
 835 <td><a href="docelement.html#quote-general">Control macros</a></td><td>-- change default style of quotes</td>
 836 </tr>
 837 <tr>
 838 <td><a href="docelement.html#always-fullspace-quotes">&nbsp;ALWAYS_FULLSPACE_QUOTES</a></td><td>-- control vertical space around quotes</td>
 839 </tr>
 840 </table>
 841
 842 <table class="quick-ref">
 843 <tr>
 844 <th id="qr-32" class="quick-ref" colspan="2">
 845 <a href="docelement.html#blockquote-intro">+++ Blockquotes (cited passages of text)</a></th>
 846 </tr>
 847 <tr>
 848 <td><a href="docelement.html#blockquote">BLOCKQUOTE</a></td><td>-- set longer passages of cited text</td>
 849 </tr>
 850 <tr>
 851 <td><a href="docelement.html#blockquote-general">Control macros</a></td><td>-- change default blockquote style</td>
 852 </tr>
 853 <tr>
 854 <td><a href="docelement.html#always-fullspace-quotes">&nbsp;ALWAYS_FULLSPACE_BLOCKQUOTES</a></td><td>-- control vertical spacing</td>
 855 </tr>
 856 </table>
 857
 858 <table class="quick-ref">
 859 <tr>
 860 <th id="qr-49" class="quick-ref" colspan="2">
 861 <a href="images.html#floats-intro">+++ Floats</a></th>
 862 </tr>
 863 <tr>
 864 <td style="vertical-align: top"><a href="images.html#float">FLOAT</a></td><td>-- keep blocks of input together, output on next page
 865 <br/>
 866 &nbsp;&nbsp;&nbsp;if necessary</td>
 867 </tr>
 868 </table>
 869
 870 <table class="quick-ref">
 871 <tr>
 872 <th id="qr-53" class="quick-ref" colspan="2">
 873 <a href="images.html#images-intro">+++ Images and graphics</a></th>
 874 </tr>
 875 <tr>
 876 <td style="vertical-align: top"><a href="images.html#pdf">PDF_IMAGE</a></td><td>-- inserting pdf images
 877 </tr>
 878 <tr>
 879 <td style="vertical-align: top"><a href="images.html#pdf-image-frame">&nbsp;PDF_IMAGE_FRAME</a></td><td>-- set parameters for pdf image frames
 880 </tr>
 881 <tr>
 882 <td style="vertical-align: top"><a href="images.html#pspic">PSPIC</a></td><td>-- inserting PostScript images
 883 </tr>
 884 </table>
 885
 886 <table class="quick-ref">
 887 <tr>
 888 <th id="qr-51" class="quick-ref" colspan="2">
 889 <a href="images.html#eqn">+++ eqn support</a></th>
 890 </tr>
 891 <tr>
 892 <td><a href="images.html#eq-en">EQ</a></td><td>-- begin an eqn block</td>
 893 </tr>
 894 <tr>
 895 <td><a href="images.html#eq-en">EN</a></td><td>-- end an eqn block</td>
 896 </tr>
 897 </table>
 898
 899 <table class="quick-ref">
 900 <tr>
 901 <th id="qr-52" class="quick-ref" colspan="2">
 902 <a href="images.html#pic">+++ pic support</a></th>
 903 </tr>
 904 <tr>
 905 <td><a href="images.html#ps-pe">PS</a></td><td>-- begin a pic block</td>
 906 </tr>
 907 <tr>
 908 <td><a href="images.html#ps-pe">PE</a></td><td>-- end a pic block</td>
 909 </tr>
 910 <tr>
 911 <td><a href="images.html#pic-text-style">PIC_TEXT_STYLE</a></td><td>-- set style for pic text</td>
 912 </tr>
 913 </table>
 914
 915 <table class="quick-ref">
 916 <tr>
 917 <th id="qr-58" class="quick-ref" colspan="2">
 918 <a href="images.html#grap">+++ grap support</a></th>
 919 </tr>
 920 <tr>
 921 <td><a href="images.html#grap">G1</a></td><td>-- begin a grap block</td>
 922 </tr>
 923 <tr>
 924 <td><a href="images.html#grap">G2</a></td><td>-- end a grap block</td>
 925 </tr>
 926 </table>
 927
 928 <table class="quick-ref">
 929 <tr>
 930 <th id="qr-50" class="quick-ref" colspan="2">
 931 <a href="images.html#tbl">+++ tbl support</a></th>
 932 </tr>
 933 <tr>
 934 <td><a href="images.html#ts-te">TS</a></td><td>-- begin a tbl block</td>
 935 </tr>
 936 <tr>
 937 <td><a href="images.html#ts-te">TH</a></td><td>-- running table header (after TS H)</td>
 938 </tr>
 939 <tr>
 940 <td><a href="images.html#ts-te">TE</a></td><td>-- end tbl block</td>
 941 </tr>
 942 </table>
 943
 944 <table class="quick-ref">
 945 <tr>
 946 <th id="qr-54" class="quick-ref" colspan="2">
 947 <a href="images.html#captions-and-labels">+++ Captions and labels</a></th>
 948 </tr>
 949 <tr>
 950 <td><a href="images.html#autolabel">AUTOLABEL</a></td><td>-- auto-label figures, tables, equations</td>
 951 </tr>
 952 <tr>
 953 <td><a href="images.html#set-autolabel">SET_AUTOLABEL</a></td><td>-- set or reset autolabel numbers</td>
 954 </tr>
 955 <tr>
 956 <td><a href="images.html#caption-after-label">CAPTION_AFTER_LABEL</a></td><td>-- place captions after labels</td>
 957 </tr>
 958 <tr>
 959 <td><a href="images.html#mla">MLA</a></td><td>-- MLA-style labelling and captioning</td>
 960 </tr>
 961 <tr>
 962 <td><a href="images.html#caption">CAPTION</a></td><td>-- add a caption to a float or (block)quote</td>
 963 </tr>
 964 <tr>
 965 <td><a href="images.html#label">LABEL</a></td><td>-- add a label to a float or (block)quote</td>
 966 </tr>
 967 <tr>
 968 <td><a href="images.html#captions-labels-sources">CAPTIONS</a></td><td>-- set style for captions</td>
 969 </tr>
 970 <tr>
 971 <td><a href="images.html#captions-labels-sources">LABELS</a></td><td>-- set style for labels</td>
 972 </tr>
 973 <tr>
 974 <td><a href="images.html#captions-labels-sources">SOURCES</a></td><td>-- set style for sources (tbl only)</td>
 975 </tr>
 976 </table>
 977
 978 <table class="quick-ref">
 979 <tr>
 980 <th id="qr-55" class="quick-ref" colspan="2">
 981 <a href="images.html#lists-of">+++ Lists of Figures, Tables, and Equations</a></th>
 982 </tr>
 983 <tr>
 984 <td><a href="images.html#lists-macros">LIST_OF_FIGURES</a></td><td>-- generate a List of Figures</td>
 985 </tr>
 986 <tr>
 987 <td><a href="images.html#lists-macros">LIST_OF_TABLES</a></td><td>-- generate a List of Tables</td>
 988 </tr>
 989 <tr>
 990 <td><a href="images.html#lists-macros">LIST_OF_EQUATIONS</a></td><td>-- generate a List of Equations</td>
 991 </tr>
 992 <tr>
 993 <td><a href="images.html#lists-style">LISTS_STYLE</a></td><td>-- set style parameters for Lists</td>
 994 </tr>
 995 </table>
 996
 997 <table class="quick-ref">
 998 <tr>
 999 <th id="qr-33" class="quick-ref" colspan="2">
1000 <a href="docelement.html#code-intro">+++ Code snippets</a></th>
1001 </tr>
1002 <tr>
1003 <td><a href="docelement.html#code">CODE</a></td><td>-- set a code snippet</td>
1004 </tr>
1005 <tr>
1006 <td><a href="docelement.html#code-control">Control macros</a></td><td>-- change default style of code snippets</td>
1007 </tr>
1008 <tr>
1009 <td><a href="docelement.html#code-general">&nbsp;General</a></td><td>-- family, font, and colour</td>
1010 </tr>
1011 <tr>
1012 <td><a href="docelement.html#code-size">&nbsp;CODE_SIZE</a></td><td>-- code size as a percentage of prevailing text</td>
1013 </tr>
1014 </table>
1015
1016 <table class="quick-ref">
1017 <tr>
1018 <th id="qr-34" class="quick-ref" colspan="2">
1019 <a href="docelement.html#linebreak-intro">+++ Author linebreaks (section breaks)</a></th>
1020 </tr>
1021 <tr>
1022 <td><a href="docelement.html#linebreak">LINEBREAK</a></td><td>-- insert an author linebreak (section break)</td>
1023 </tr>
1024 <tr>
1025 <td><a href="docelement.html#linebreak-control">Control macros</a></td><td>-- change default style of linebreaks</td>
1026 </tr>
1027 <tr>
1028 <td><a href="docelement.html#linebreak-char">&nbsp;LINEBREAK_CHAR</a></td><td>-- character to use for author linebreaks</td>
1029 </tr>
1030 <tr>
1031 <td><a href="docelement.html#linebreak-color">&nbsp;LINEBREAK_COLOR</a></td><td>-- colour of author linebreak character</td>
1032 </tr>
1033 </table>
1034
1035 <table class="quick-ref">
1036 <tr>
1037 <th id="qr-35" class="quick-ref" colspan="2">
1038 <a href="docelement.html#finis-intro">+++ Document termination string</a></th>
1039 </tr>
1040 <tr>
1041 <td><a href="docelement.html#finis">FINIS</a></td><td>-- insert a document termination string</td>
1042 </tr>
1043 <tr>
1044 <td><a href="docelement.html#finis-control">Control macros</a></td><td>-- change default style finis string</td>
1045 </tr>
1046 <tr>
1047 <td><a href="docelement.html#finis-string">&nbsp;FINIS_STRING</a></td><td>-- set the document termination string</td>
1048 </tr>
1049 <tr>
1050 <td><a href="docelement.html#finis-string-caps">&nbsp;FINIS_STRING_CAPS</a></td><td>-- capitalization of termination string</td>
1051 </tr>
1052 <tr>
1053 <td><a href="docelement.html#finis-color">&nbsp;FINIS_COLOR</a></td><td>-- set the document termination string colour</td>
1054 </tr>
1055 </table>
1056
1057 <table class="quick-ref">
1058 <tr>
1059 <th id="qr-36" class="quick-ref" colspan="2">
1060 <a href="docelement.html#footnote-intro">+++ Footnotes</a></th>
1061 </tr>
1062 <tr>
1063 <td><a href="docelement.html#footnote">FOOTNOTE</a></td><td>-- set a footnote</td>
1064 </tr>
1065 <tr>
1066 <td><a href="docelement.html#footnote-general">Control macros</a></td><td>-- change default style of footnotes</td>
1067 </tr>
1068 <tr>
1069 <td><a href="docelement.html#footnote-markers">&nbsp;FOOTNOTE_MARKERS</a></td><td>-- footnote markers on/off</td>
1070 </tr>
1071 <tr>
1072 <td><a href="docelement.html#footnote-marker-style">&nbsp;FOOTNOTE_MARKER_STYLE</a></td><td>-- type of footnote marker to use</td>
1073 </tr>
1074 <tr>
1075 <td><a href="docelement.html#reset-footnote-number">&nbsp;RESET_FOOTNOTE_NUMBER</a></td><td>-- reset footnote numbering</td>
1076 </tr>
1077 <tr>
1078 <td><a href="docelement.html#footnote-rule">&nbsp;FOOTNOTE_RULE</a></td><td>-- footnote separator rule on/off</td>
1079 </tr>
1080 <tr>
1081 <td><a href="docelement.html#footnote-rule-adj">&nbsp;FOOTNOTE_RULE_ADJ</a></td><td>-- adjust position of footnote rule</td>
1082 </tr>
1083 <tr>
1084 <td><a href="docelement.html#footnote-rule-length">&nbsp;FOOTNOTE_RULE_LENGTH</a></td><td>-- adjust length of footnote rule</td>
1085 </tr>
1086 <tr>
1087 <td style="vertical-align: top;"><a href="docelement.html#footnotes-run-on">&nbsp;FOOTNOTES_RUN_ON</a></td>
1088   <td>-- instruct footnotes to be continuous</td>
1089 </tr>
1090 </table>
1091
1092 <table class="quick-ref">
1093 <tr>
1094 <th id="qr-37" class="quick-ref" colspan="2">
1095 <a href="docelement.html#endnote-intro">+++ Endnotes</a></th>
1096 </tr>
1097 <tr>
1098 <td><a href="docelement.html#endnote">ENDNOTE</a></td><td>-- set an endnote</td>
1099 </tr>
1100 <tr>
1101 <td style="vertical-align: top;"><a href="docelement.html#en-mark">\*[EN-MARK]</a></td>
1102   <td>-- mark initial line of a range of line numbers<br />
1103 &nbsp;&nbsp;&nbsp;(for use with line numbered endnotes)</td>
1104 </tr>
1105 <tr>
1106 <td><a href="docelement.html#endnotes">ENDNOTES</a></td><td>-- output endnotes</td>
1107 </tr>
1108 <tr>
1109 <td><a href="docelement.html#endnote-control">Control macros</a></td><td></td>
1110 </tr>
1111 </table>
1112
1113 <table class="quick-ref" style="margin-top: -.5em; margin-left: 1em;">
1114 <tr>
1115 <td><a href="docelement.html#endnotes-general">General style control</a></td>
1116 </tr>
1117 <tr>
1118 <td><a href="docelement.html#endnotes-pagination">Pagination</a></td>
1119 </tr>
1120 <tr>
1121 <td><a href="docelement.html#endnotes-header-control">Header/footer control</a></td>
1122 </tr>
1123 <tr>
1124 <td><a href="docelement.html#endnotes-header-string-control">Title control</a></td>
1125 </tr>
1126 <tr>
1127 <td><a href="docelement.html#endnotes-doc-title">Document/section identification control</a></td>
1128 </tr>
1129 <tr>
1130 <td><a href="docelement.html#endnotes-numbering">Identification style</a></td>
1131 </tr>
1132 </table>
1133
1134 <table class="quick-ref">
1135 <tr>
1136 <th id="qr-38" class="quick-ref" colspan="2">
1137 <a href="docelement.html#margin-notes-intro">+++ Margin notes</a></th>
1138 </tr>
1139 <tr>
1140 <td><a href="docelement.html#mn-init">MN_INIT</a></td><td>-- initialize margin notes</td>
1141 </tr>
1142 <tr>
1143 <td><a href="docelement.html#mn">MN</a></td><td>-- set a margin note</td>
1144 </tr>
1145 </table>
1146
1147 <table class="quick-ref">
1148 <tr>
1149 <th id="qr-39" class="quick-ref" colspan="2">
1150 <a href="refer.html#intro-ref">+++ Bibliographic references</a></th>
1151 </tr>
1152 <tr>
1153 <td><a href="refer.html#ref">REF</a></td><td>-- begin a reference</td>
1154 </tr>
1155 <tr>
1156 <td><a href="refer.html#footnote-refs">FOOTNOTE_REFS</a></td><td>-- place references in footnotes</td>
1157 </tr>
1158 <tr>
1159 <td><a href="refer.html#endnote-refs">ENDNOTE_REFS</a></td><td>-- place references in endnotes</td>
1160 </tr>
1161 <tr>
1162 <td><a href="refer.html#bracket-refs">REF( / REF)</a></td><td>-- put parentheses around embedded references</td>
1163 </tr>
1164 <tr>
1165 <td><a href="refer.html#bracket-refs">REF[ / REF]</a></td><td>-- put square brackets around embedded references</td>
1166 </tr>
1167 <tr>
1168 <td><a href="refer.html#bracket-refs">REF{ / REF}</a></td><td>-- put curly braces around embedded references</td>
1169 </tr>
1170 <tr>
1171 <td><a href="refer.html#bibliography">BIBLIOGRAPHY</a></td><td>-- output a bibliography</td>
1172 </tr>
1173 <tr>
1174 <td><a href="refer.html#biblio-control">Control macros</a></td>
1175 </tr>
1176 </table>
1177
1178 <table class="quick-ref" style="margin-top: -.5em; margin-left: 1em;">
1179 <tr>
1180 <td><a href="refer.html#bibliography-type">BIBLIOGRAPHY_TYPE</a>&nbsp;-- "plain" or enumerated list</td>
1181 </tr>
1182 <tr>
1183 <td><a href="refer.html#biblio-general">General style control</a></td>
1184 </tr>
1185 <tr>
1186 <td><a href="refer.html#biblio-header-control">Header/footer control</a></td>
1187 </tr>
1188 <tr>
1189 <td><a href="refer.html#biblio-main-title">Main head control</a></td>
1190 </tr>
1191 </table>
1192
1193 <table class="quick-ref">
1194 <tr>
1195 <th id="qr-40" class="quick-ref" colspan="2">
1196 <a href="tables-of-contents.html">+++ Tables of contents</a></th>
1197 </tr>
1198 <tr>
1199 <td><a href="tables-of-contents.html#toc">TOC</a></td><td>-- output a table of contents</td>
1200 </tr>
1201 <tr>
1202 <td><a href="tables-of-contents.html#index-toc-control">Control macros</a></td>
1203 </tr>
1204 </table>
1205
1206 <table class="quick-ref" style="margin-top: -.5em; margin-left: 1em;">
1207 <tr>
1208 <td><a href="tables-of-contents.html#toc-general">General style control</a></td>
1209 </tr>
1210 <tr>
1211 <td><a href="tables-of-contents.html#toc-pagenumbering">Page numbering</a></td>
1212 </tr>
1213 <tr>
1214 <td><a href="tables-of-contents.html#toc-header">Header string control</a></td>
1215 </tr>
1216 <tr>
1217 <td><a href="tables-of-contents.html#toc-style">Entries and reference page numbers style control</a></td>
1218 </tr>
1219 <tr>
1220 <td><a href="tables-of-contents.html#toc-title-style">TOC_TITLE_STYLE</a></td>
1221 </tr>
1222 <tr>
1223 <td><a href="tables-of-contents.html#toc-entry-style">TOC_ENTRY_STYLE</a></td>
1224 </tr>
1225 <tr>
1226 <td><a href="tables-of-contents.html#toc-additional">Additional table of contents control macros</a></td>
1227 </tr>
1228 </table>
1229
1230 <table class="quick-ref">
1231 <tr>
1232 <th id="qr-41" class="quick-ref" colspan="2">
1233 <a href="letters.html">+++ Letter (correspondence) macros</a></th>
1234 </tr>
1235 <tr>
1236 <td><a href="letters.html#date">DATE</a></td><td>-- letter&#8217;s date</td>
1237 </tr>
1238 <tr>
1239 <td><a href="letters.html#from">FROM</a></td><td>-- letter&#8217;s addresser</td>
1240 </tr>
1241 <tr>
1242 <td><a href="letters.html#to">TO</a></td><td>-- letter&#8217;s addressee</td>
1243 </tr>
1244 <tr>
1245 <td><a href="letters.html#greeting">GREETING</a></td><td>-- letter&#8217;s salutation</td>
1246 </tr>
1247 <tr>
1248 <td><a href="letters.html#closing">CLOSING</a></td><td>-- letter&#8217;s closing salutation</td>
1249 </tr>
1250 <tr>
1251 <td><a href="letters.html#closing-indent">CLOSING_INDENT</a></td><td>-- indentation of the closing salutation</td>
1252 </tr>
1253 <tr>
1254 <td><a href="letters.html#signature-space">SIGNATURE_SPACE</a></td><td>-- room to leave for the signature</td>
1255 </tr>
1256 <tr>
1257 <td><a href="letters.html#no-suite">NO_SUITE</a></td><td>-- printing of &quot;next page number&quot; off or on</td>
1258 </tr>
1259 </table>
1260
1261 <table class="quick-ref">
1262 <tr>
1263 <th id="qr-42" class="quick-ref" colspan="2">
1264 <a href="docprocessing.html#style-after-start">+++ Changing global print style parameters after START</a></th>
1265 </tr>
1266 <tr>
1267 <td><a href="docprocessing.html#doc-left-margin">DOC_LEFT_MARGIN</a></td><td>-- left margin of everything on the page</td>
1268 </tr>
1269 <tr>
1270 <td><a href="docprocessing.html#doc-right-margin">DOC_RIGHT_MARGIN</a></td><td>-- right margin of everything on the page</td>
1271 </tr>
1272 <tr>
1273 <td><a href="docprocessing.html#doc-line-length">DOC_LINE_LENGTH</a></td><td>-- document&#8217;s base line length</td>
1274 </tr>
1275 <tr>
1276 <td><a href="docprocessing.html#doc-family">DOC_FAMILY</a></td><td>-- document&#8217;s base family</td>
1277 </tr>
1278 <tr>
1279 <td><a href="docprocessing.html#doc-pt-size">DOC_PT_SIZE</a></td><td>-- document&#8217;s base point size</td>
1280 </tr>
1281 <tr>
1282 <td><a href="docprocessing.html#doc-lead">DOC_LEAD</a></td><td>-- document&#8217;s base lead</td>
1283 </tr>
1284 <tr>
1285 <td><a href="docprocessing.html#doc-quad">DOC_QUAD</a></td><td>-- document&#8217;s base quad directions</td>
1286 </tr>
1287 </table>
1288
1289 <table class="quick-ref">
1290 <tr>
1291 <th id="qr-43" class="quick-ref" colspan="2">
1292 <a href="docprocessing.html#docheader">+++ Managing a document&#8217;s first-page header<a></th>
1293 </tr>
1294 <tr>
1295 <td><a href="docprocessing.html#docheader">DOCHEADER</a></td><td>-- document first-page header on/off</td>
1296 </tr>
1297 <tr>
1298 <td><a href="docprocessing.html#index-docheader-control">Control macros</a></td><td>-- change default style of docheader elements</td>
1299 </tr>
1300 </table>
1301
1302 <table class="quick-ref">
1303 <tr>
1304 <th id="qr-44" class="quick-ref" colspan="2">
1305 <a href="headfootpage.html#headfoot-management">+++ Managing page headers and footers</a></th>
1306 </tr>
1307 <tr>
1308 <td><a href="headfootpage.html#headers">HEADERS</a></td><td>-- page headers on/off</td>
1309 </tr>
1310 <tr>
1311 <td><a href="headfootpage.html#footers">FOOTERS</a></td><td>-- page footers on/off</td>
1312 </tr>
1313 <tr>
1314 <td style="vertical-align: top;"><a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a></td><td>-- enable generation of both headers and</br>
1315 &nbsp;&nbsp;&nbsp;footers</td>
1316 </tr>
1317 <tr>
1318 <td><a href="headfootpage.html#headfoot-control">Control macros</a></td>
1319 </tr>
1320 </table>
1321
1322 <table class="quick-ref" style="margin-top: -.5em; margin-left: 1em;">
1323 <tr>
1324 <td><a href="headfootpage.html#hdrftr-strings">Strings</a></td><td>-- left-right-center strings</td>
1325 </tr>
1326 <tr>
1327 <td><a href="headfootpage.html#hdrftr-style">Style</a></td><td>-- change defaults for headers and/or footers</td>
1328 </tr>
1329 <tr>
1330 <td><a href="headfootpage.html#hdrftr-style-global">Global</a></td><td>-- global style changes</td>
1331 </tr>
1332 <tr>
1333 <td><a href="headfootpage.html#hdrftr-style-part">Part-by-part</a></td><td>-- part-by-part style changes</td>
1334 </tr>
1335 <tr>
1336 <td><a href="headfootpage.html#vertical-spacing">Vertical placement</a></td><td>-- adjust position of headers and/or footers</td>
1337 </tr>
1338 <tr>
1339 <td><a href="headfootpage.html#hdrftr-separator">Separator rule</a></td><td>-- manage the header/footer separator rule</td>
1340 </tr>
1341 </table>
1342
1343 <table class="quick-ref">
1344 <tr>
1345 <th id="qr-45" class="quick-ref" colspan="2">
1346 <a href="rectoverso.html">+++ Recto/verso page headers and footers</a></th>
1347 </tr>
1348 <tr>
1349 <td><a href="rectoverso.html#recto-verso">RECTO_VERSO</a></td><td>-- recto/verso headers and/or footers on/off</td>
1350 </tr>
1351 <tr>
1352 <td><a href="rectoverso.html#force-recto">FORCE_RECTO</a></td><td>-- insert blank pages so chapters start recto</td>
1353 </tr>
1354 <tr>
1355 <td><a href="rectoverso.html#switch-hdrftr">SWITCH_HEADERS</a></td><td>-- switch recto or verso header</td>
1356 </tr>
1357 <tr>
1358 <td><a href="rectoverso.html#switch-hdrftr">SWITCH_FOOTERS</a></td><td>-- switch recto or verso footer</td>
1359 </tr>
1360 <tr>
1361 <td><a href="headfootpage.html#hdrftr-recto">HEADER_RECTO</a></td><td>-- string that constitutes a recto header</td>
1362 </tr>
1363 <tr>
1364 <td><a href="headfootpage.html#hdrftr-verso">HEADER_VERSO</a></td><td>-- string that constitutes a verso header</td>
1365 </tr>
1366 <tr>
1367 <td><a href="headfootpage.html#hdrftr-recto">FOOTER_RECTO</a></td><td>-- string that constitutes a recto footer</td>
1368 </tr>
1369 <tr>
1370 <td><a href="headfootpage.html#hdrftr-verso">FOOTER_VERSO</a></td><td>-- string that constitutes a recto footer</td>
1371 </tr>
1372 </table>
1373
1374 <table class="quick-ref">
1375 <tr>
1376 <th id="qr-46" class="quick-ref" colspan="2">
1377 <a href="headfootpage.html#pagination-intro">+++ Pagination</a></th>
1378 </tr>
1379 <tr>
1380 <td><a href="headfootpage.html#paginate">PAGINATE</a></td><td>-- pagination on/off</td>
1381 </tr>
1382 <tr>
1383 <td><a href="headfootpage.html#index-paginate-control">Control macros</a></td><td>-- change default style for pagination</td>
1384 </tr>
1385 <tr>
1386 <td><a href="headfootpage.html#pagenumber">&nbsp;PAGENUMBER</a></td><td>-- user-defined (starting) page number</td>
1387 </tr>
1388 <tr>
1389 <td><a href="headfootpage.html#pagenum-style">&nbsp;PAGENUM_STYLE</a></td><td>-- digits, roman numerals, etc</td>
1390 </tr>
1391 <tr>
1392 <td><a href="headfootpage.html#pagenumber-string">&nbsp;PAGENUMBER_STRING</a></td><td>-- user-defined page numbering string</td>
1393 </tr>
1394 <tr>
1395 <td><a href="headfootpage.html#pagenum-on-first-page">&nbsp;PAGENUM_ON_FIRST_PAGE</a></td><td>-- when page numbering is at page top</td>
1396 </tr>
1397 <tr>
1398 <td style="vertical-align: top;"><a href="headfootpage.html#draft-with-pagenumber">&nbsp;DRAFT_WITH_PAGENUMBER</a></td><td>-- attach draft/revision to page number</td>
1399 </tr>
1400 </table>
1401
1402 <table class="quick-ref">
1403 <tr>
1404 <th id="qr-57" class="quick-ref" colspan="2">
1405 <a href="docprocessing.html#vertical-whitespace-management">+++ Vertical whitespace management</a></th>
1406 </tr>
1407 <tr>
1408 <td><a href="docprocessing.html#shim">SHIM</a></td><td>-- align to the baseline grid</td>
1409 </tr>
1410 <tr>
1411 <td><a href="docprocessing.html#flex">FLEX</a></td><td>-- insert flexible whitespace</td>
1412 </tr>
1413 </table>
1414
1415
1416 <table class="quick-ref">
1417 <tr>
1418 <th id="qr-47" class="quick-ref" colspan="2">
1419 <a href="cover.html">+++ Document and section cover (title) pages</a></th>
1420 </tr>
1421 <tr>
1422 <td><a href="cover.html#cover">DOC_COVER</a></td><td>-- information to include in a document cover</td>
1423 </tr>
1424 <tr>
1425 <td><a href="cover.html#cover">COVER</a></td><td>-- information to include in a section cover</td>
1426 </tr>
1427 <tr>
1428 <td><a href="cover.html#on-off">DOC_COVERS</a></td><td>-- printing of document covers on/off</td>
1429 </tr>
1430 <tr>
1431 <td><a href="cover.html#on-off">COVERS</a></td><td>-- printing of section covers on/off</td>
1432 </tr>
1433 <tr>
1434 <td><a href="cover.html#covertext">DOC_COVERTEXT</a></td><td>-- user-added text for document covers</td>
1435 </tr>
1436 <tr>
1437 <td><a href="cover.html#covertext">COVERTEXT</a></td><td>-- user-added text for section covers</td>
1438 </tr>
1439 <tr>
1440 <td><a href="cover.html#coverimage">DOC_COVER_IMAGE</a></td><td>-- add images to document covers</td>
1441 </tr>
1442 <tr>
1443 <td><a href="cover.html#coverimage">COVER_IMAGE</a></td><td>-- add images to document covers</td>
1444 </tr>
1445 <tr>
1446 <td><a href="cover.html#cover-control">Control macros</a></td><td>-- change style defaults for covers</td>
1447 </tr>
1448 </table>
1449
1450 <table class="quick-ref">
1451 <tr>
1452 <th id="qr-48" class="quick-ref" colspan="2">+++ Utilities</th>
1453 </tr>
1454 <tr>
1455 <td><a href="docprocessing.html#add-space">ADD_SPACE</a></td><td>-- add space to the top of a page</td>
1456 </tr>
1457 <tr>
1458 <td><a href="docprocessing.html#add-space">RESTORE_SPACE</a></td><td>-- restore spacing at the top of a page</td>
1459 </tr>
1460 <tr>
1461 <td><a href="headfootpage.html#blank-pages">BLANKPAGE</a></td><td>-- output one or more blank pages</td>
1462 </tr>
1463 <tr>
1464 <td><a href="docprocessing.html#doc-lead-adjust">DOC_LEAD_ADJUST</a></td><td>-- adjust leading to fill pages</td>
1465 </tr>
1466 <tr>
1467 <td><a href="rectoverso.html#collate">COLLATE</a></td><td>-- join documents (chapters/sections)</td>
1468 </tr>
1469 <tr>
1470 <td><a href="goodies.html#center-block">CENTER_BLOCK</a></td><td>-- centre blocks of type</td>
1471 </tr>
1472 <tr>
1473 <td><a href="goodies.html#left-hang">LEFT_HANG / \*[HANG c]</a></td><td>-- hanging punctuation</td>
1474 </tr>
1475 </table>
1476
1477 <div class="rule-long"><hr/></div>
1478
1479 <!-- Navigation links -->
1480 <table style="width: 100%; margin-top: 12px;">
1481 <tr>
1482   <td style="width: 33%;"><a href="toc.html">Back to Table of Contents</a></td>
1483   <td style="width: 33%; text-align: center;"><a href="#top">Top</a></td>
1484   <td style="width: 33%; text-align: right;"><a href="appendices.html">Next: Appendices</a></td>
1485 </tr>
1486 </table>
1487
1488 </div>
1489
1490 <div class="bottom-spacer"><br/></div>
1491
1492 </body>
1493 </html>