PageRenderTime 104ms CodeModel.GetById 14ms app.highlight 73ms RepoModel.GetById 2ms app.codeStats 0ms

/doc/English/tags-reference.html

http://txt2tags.googlecode.com/
HTML | 2737 lines | 2329 code | 406 blank | 2 comment | 0 complexity | ee2cbfb0f5396e258acb153620cf0665 MD5 | raw file
   1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2<HTML>
   3<HEAD>
   4<META NAME="generator" CONTENT="http://txt2tags.org">
   5<TITLE>All TAGS Reference</TITLE>
   6</HEAD><BODY BGCOLOR="white" TEXT="black">
   7<CENTER>
   8<H1>All TAGS Reference</H1>
   9</CENTER>
  10
  11
  12<H1 ID="Introduction">Introduction</H1>
  13
  14<P>
  15This document is a reference for all available TAGS available to
  16developers for adding new targets, as found in the <I>getTags()</I> function.
  17It is intended for <B>advanced users</B> and <B>developers</B> who wish to
  18add a new target to Txt2tags without needing to know the source code
  19in detail.
  20</P>
  21<P>
  22This reference will describe all available tags, including how and
  23where they will appear in the final tagged document, how the various
  24rules in the <I>getRules()</I> function affect them, and what special
  25characters and macros are expanded in the output.
  26</P>
  27<P>
  28Txt2tags has fairly complex rules and gotchas, and it can be
  29difficult searching through the entire source code to see exactly
  30what each tag does. Often, when creating a new target, a developer
  31is surprised when the output is not quite how it was expected to be,
  32and in particular that certain tags did not behave as expected. It
  33is hoped that this reference will make it easier to create new
  34targets with fewer bugs and surprises, so txt2tags can continue to
  35grow as "one source, many targets".
  36</P>
  37
  38<H1 ID="chapter-ThePartsofaDocument">1. The Parts of a Document</H1>
  39
  40<P>
  41Before looking at the individual tags, it is important to understand
  42exactly how the different parts of a document fit together.
  43</P>
  44<P>
  45A document is built from a <B>template</B>, which is filled with the
  46document's <B>headers</B>, <B>body</B>, and an optional <B>table of contents</B>.
  47</P>
  48
  49<H2 ID="section-Template">1.1. Template</H2>
  50
  51<P>
  52The template of a document consists of the basic opening and closing
  53markup that all examples of that type of file must have. All
  54supported targets have a default template included in the source
  55code, in the <I>HEADER_TEMPLATE</I> area. Alternatively, the user may
  56use a custom header using the <I>--template</I> command line option.
  57</P>
  58<P>
  59Templates should make use of the <B>%(HEADER1)s</B>, <B>%(HEADER2)s</B>,
  60and <B>%(HEADER3)s</B> macros, as well as <B>%(ENCODING)s</B> and
  61<B>%(STYLE)s</B> if the target supports character encodings and
  62external stylesheets. These macros will be replaced with the
  63appropriate values from the source document. If any value is blank,
  64the entire line including the macro is removed unless the target has
  65included the rule <A HREF="#keepblankheaderline">'keepblankheaderline'</A>.
  66</P>
  67<P>
  68It is not required, but by convention <B>HEADER1</B> refers to the title,
  69<B>HEADER2</B> to the author, and <B>HEADER3</B> to the date the document was
  70created. Several targets reflect this convention in their use of the
  71<B>HEADER</B> metadata in their default templates.
  72</P>
  73<P>
  74Custom templates must also include the <B>%(BODY)s</B> macro, which
  75will be expanded to the fully tagged body of the document. The
  76default template should not include this, as it is automatically
  77added to the end of the <I>HEADER_TEMPLATE</I> text.
  78</P>
  79
  80<H2 ID="section-BodyText">1.2. Body Text</H2>
  81
  82<P>
  83The body of a document consists of the fully tagged text converted
  84from the original source document. It is nothing more or less than
  85the original document with all txt2tags markup removed, and replaced
  86with the target-specific markup. All of the tags from <I>getTags()</I>
  87end up in this section, along with all user text.
  88</P>
  89<P>
  90The document is parsed into blocks, and each block is processed line
  91by line. Note that this seraration of lines is kept throughout the
  92process, and in nearly all cases the final tagged text is broken in
  93the same locations as the original. This is important to remember,
  94as several tags depend on this line by line behaviour, and their
  95output changes that line it self, not the block.
  96</P>
  97
  98<H2 ID="section-TableofContents">1.3. Table of Contents</H2>
  99
 100<P>
 101Txt2tags is able to add a table of contents to the output document.
 102If the target supports creating a table of contents itself, Txt2tags
 103can take advantage of that. Otherwise, Txt2tags can generate a table
 104of contents automatically and insert it where appropriate.
 105</P>
 106<P>
 107If the command line option <I>--toc</I> is used, Txt2tags will add a
 108table of contents to the output. If the command line option
 109<I>--toc-only</I> is used, then the table of contents will be the only
 110thing output, and the rest of the body text will not.
 111</P>
 112<P>
 113By default, the table of contents will be emitted as the first text
 114in the body of the document. That is, it will be emitted directly
 115after <A HREF="#bodyOpen">bodyOpen</A> and before the main text. If this is not
 116appropriate, the user can insert the <B>%%toc</B> macro into the source
 117text, and it will be emitted there instead.
 118</P>
 119<P>
 120Full details on how the table of contents is emitted is given in the
 121section on the Table of Contents tags.
 122</P>
 123
 124<H2 ID="section-Escapes">1.4. Escapes</H2>
 125
 126<P>
 127One final note, though this is not really part of the document
 128structures. Most text is processed throught the functions
 129<I>doEscape()</I> and <I>doFinalEscape()</I> before being emitted in the
 130final output. This is used to allow certain characters that may give
 131problems in Txt2tags, such as backslashes or characters that are the
 132same as Txt2tags markup.
 133</P>
 134<P>
 135The emitted tags are not processed by these functions at all. Some
 136tags also prevent parts of the text from being processed by these
 137functions. The reference will note when this is the case.
 138</P>
 139
 140<H1 ID="chapter-BasicBlocks">2. Basic Blocks</H1>
 141
 142<H2 ID="section-Paragraphs">2.1. Paragraphs</H2>
 143
 144<P>
 145Paragraphs are the most common, and most basic of all text blocks.
 146They are the simple, regular body text of the document.
 147</P>
 148<P>
 149If the rule <A HREF="#blanksaroundpara">'blanksaroundpara'</A> is defined, an empty line will be
 150emitted before and after the paragraph and tags.
 151</P>
 152<P>
 153If the rule <A HREF="#onelinepara">'onelinepara'</A> is defined, the paragraph text will have
 154all newlines removed and replaced with spaces, emitting the
 155paragraph as a single line.
 156</P>
 157
 158<H3 ID="paragraphOpen">paragraphOpen</H3>
 159
 160<P>
 161This tag is emitted, on its own line, before each paragraph of body
 162text. If this tag (and <A HREF="#paragraphClose">paragraphClose</A>) are not defined for a
 163target, the body text is simply printed as unadorned plain text,
 164much like the source document.
 165</P>
 166
 167<DL>
 168<DT>Macros:</DT><DD>
 169  <DL>
 170  <DT><B>~D~</B></DT><DD>
 171    If this macro is included in the tag, it will be expanded to the
 172    value of the depth of that particular paragraph. Most paragraphs
 173    have depth '1', pargraphs inside a top-level list will have
 174    depth level '2', and so on.
 175  <P></P>
 176    If the rule <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A> is defined for the target,
 177    the depth value will be multiplied by that amount before being
 178    emitted. If the rule <A HREF="#depthmultiplyplus">'depthmultiplyplus'</A> is defined, then that
 179    value will be added to the depth before multiplying by
 180    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, but only if used with
 181    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>.
 182  <P></P>
 183    If the rule <A HREF="#zerodepthpara">'zerodepthpara'</A> is defined, then top-level
 184    paragraphs (those not nested inside a list) will always have
 185    <B>~D~</B> replaced with '0', regardless of the other rules.
 186  </DL>
 187</DL>
 188
 189<H3 ID="paragraphClose">paragraphClose</H3>
 190
 191<P>
 192This tag is emitted, on its own line, after each paragraph of body
 193text.
 194</P>
 195
 196<DL>
 197<DT>Macros</DT><DD>
 198  None
 199</DL>
 200
 201<H2 ID="section-BlockQuotations">2.2. Block Quotations</H2>
 202
 203<P>
 204Block quotes are paragraphs that are set apart from regular
 205paragraphs, usually to show that they are quoted from some external
 206source.
 207</P>
 208<P>
 209Note that, at this time, Txt2tags is not able to emit multiple
 210paragraphs within a single block quote. Each separate paragraph
 211will be emitted as a separate block quote with Open and Close tags.
 212</P>
 213<P>
 214Nested block quotes are allowed, unless the rule <A HREF="#quotenotnested">'quotenotnested'</A>
 215is defined for the target.
 216</P>
 217<P>
 218If the rule <A HREF="#keepquoteindent">'keepquoteindent'</A> is defined, then each line of the
 219block quote will have tab characters added before the text equal to
 220the depth of that quote.
 221</P>
 222<P>
 223If the rule <A HREF="#blanksaroundquote">'blanksaroundquote'</A> is defined, an extra blank line is
 224emitted before and after the block quote.
 225</P>
 226
 227<H3 ID="blockQuoteOpen">blockQuoteOpen</H3>
 228
 229<P>
 230This tag is emitted, on its own line, before each paragraph of a
 231block quote.
 232</P>
 233<P>
 234The block depth is given by a number of tab characters.
 235<CODE>blockQuoteOpen</CODE> will have these tabs inserted before the tag,
 236unless the rule <A HREF="#tagnotindentable">'tagnotindentable'</A> is defined.
 237</P>
 238
 239<DL>
 240<DT>Macros:</DT><DD>
 241  <DL>
 242  <DT><B>~D~</B></DT><DD>
 243    If this macro is included in the tag, it will be expanded to the
 244    value of the depth of that particular block quote paragraph. The
 245    first Block Quote has a depth level of '1'. A quote nested
 246    within the first will have a depth of '2', and so on.
 247  <P></P>
 248    If the rule <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A> is defined for the target,
 249    the depth value will be multiplied by that amount before being
 250    emitted. If the rule <A HREF="#depthmultiplyplus">'depthmultiplyplus'</A> is defined, then that
 251    value will be added to the depth before multiplying by
 252    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, but only if used with
 253    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>.
 254  </DL>
 255</DL>
 256
 257<H3 ID="blockQuoteLine">blockQuoteLine</H3>
 258
 259<P>
 260If this tag is present, it will be added before each line of the
 261block quote.
 262</P>
 263<P>
 264This tag is emitted multiple times for nested quotes, one copy of
 265the tag for each level of depth. For example, if the quote is
 266defined as '*', then for a third-level nested quote each line
 267will begin with '***'.
 268</P>
 269<P>
 270If the rule <A HREF="#keepquoteindent">'keepquoteindent'</A> is defined, all copies of this tag
 271are emitted after the tab characters and before the quote text.
 272</P>
 273
 274<DL>
 275<DT>Macros:</DT><DD>
 276  None
 277</DL>
 278
 279<H3 ID="blockQuoteClose">blockQuoteClose</H3>
 280
 281<P>
 282This tag is emitted, on its own line, at the end of each block
 283quote.
 284</P>
 285<P>
 286The block depth is given by a number of tab characters.
 287<CODE>blockQuoteClose</CODE> will have these tabs inserted before the tag,
 288unless the rule <A HREF="#tagnotindentable">'tagnotindentable'</A> is defined.
 289</P>
 290
 291<DL>
 292<DT>Macros:</DT><DD>
 293  None
 294</DL>
 295
 296<H2 ID="section-VerbatimBlocks">2.3. Verbatim Blocks</H2>
 297
 298<P>
 299Verbatim blocks are used when the user needs to keep control over
 300the spaces and line breaks of a block of text. Verbatim blocks are
 301usually emitted in a monospace font, and all spaces and line breaks
 302will be the same as in the source text. It is commonly used for
 303ASCII art and for source code listings.
 304</P>
 305<P>
 306Note that this is not the same as raw text. Raw text blocks are
 307emitted exactly as they are in the source text, with no processing.
 308Verbatim blocks are processed, and are emitted so that they
 309<I>appear</I> the same as in the source text.
 310</P>
 311<P>
 312By default, verbatim blocks are passed through <I>doEscape()</I> but
 313not <I>doFinalEscape()</I>. If the rule <A HREF="#verbblocknotescaped">'verbblocknotescaped'</A> is
 314defined, the text will not be passed through <I>doEscape()</I>. If the
 315rule <A HREF="#verbblockfinalescape">'verbblockfinalescape'</A> is defined, then the text will be be
 316passed through <I>doFinalEscape()</I>.
 317</P>
 318<P>
 319If the rule <A HREF="#indentverbblock">'indentverbblock'</A> is defined, then each line of the
 320text will be emitted with two spaces inserted before the text.
 321</P>
 322<P>
 323If the rule <A HREF="#blanksaroundverb">'blanksaroundverb'</A> is defined, an extra blank line
 324will be emitted before and after the verbatim block.
 325</P>
 326<P>
 327Note that the entire verbatim area is emitted as a single block.
 328Blank lines within a verbatim block do not separate paragraphs.
 329</P>
 330
 331<H3 ID="blockVerbOpen">blockVerbOpen</H3>
 332
 333<P>
 334This tag is emitted, on its own line, before each block of verbatim
 335text.
 336</P>
 337
 338<DL>
 339<DT>Macros:</DT><DD>
 340  None
 341</DL>
 342
 343<H3 ID="blockVerbLine">blockVerbLine</H3>
 344
 345<P>
 346This tag is emitted before each line of text in the verbatim block.
 347Some targets require this to keep the entire verbatim block
 348together, or to maintain formatting.
 349</P>
 350<P>
 351If the rule <A HREF="#indentverbblock">'indentverbblock'</A> is defined, this tag is emitted
 352after the spaces used for the indent, before the block text.
 353</P>
 354
 355<DL>
 356<DT>Macros:</DT><DD>
 357  None
 358</DL>
 359
 360<H3 ID="blockVerbSep">blockVerbSep</H3>
 361
 362<P>
 363This tag is emitted, on a line by itself, in between each line of
 364text in the verbatim block.
 365</P>
 366
 367<DL>
 368<DT>Macros:</DT><DD>
 369  None
 370</DL>
 371
 372<H3 ID="blockVerbClose">blockVerbClose</H3>
 373
 374<P>
 375This tag is emitted, on its own line, after each block of verbatim
 376text.
 377</P>
 378
 379<DL>
 380<DT>Macros:</DT><DD>
 381  None
 382</DL>
 383
 384<H1 ID="chapter-InlineTags">3. Inline Tags</H1>
 385
 386<P>
 387These tags are used to add additional formatting to text within the
 388basic blocks. They are useable within regular paragraphs and block
 389quotes, and unless otherwise noted, within lists and tables as
 390well.
 391</P>
 392<P>
 393All of these tags are inline, meaning that they do not begin or end
 394blocks and do not add or remove lines of text.
 395</P>
 396
 397<H2 ID="section-TextBeautifiers">3.1. Text Beautifiers</H2>
 398
 399<P>
 400These are the simple tags used to change how text appears in the
 401final output.
 402</P>
 403<P>
 404None of these tags use any special macros.
 405</P>
 406
 407<H3 ID="fontItalic">fontItalicOpen, fontItalicClose</H3>
 408
 409<P>
 410These tags are emitted, respectively, immediately before and after
 411some text that should appear in <I>italics</I> for emphasis.
 412</P>
 413
 414<H3 ID="fontBold">fontBoldOpen, fontBoldClose</H3>
 415
 416<P>
 417These tags are emitted, respectively, immediately before and after
 418some text that should appear in <B>bold</B> for strong emphasis.
 419</P>
 420
 421<H3 ID="fontUnderline">fontUnderlineOpen, fontUnderlineClose</H3>
 422
 423<P>
 424These tags are emitted, respectively, immediately before and after
 425some text that should appear <U>underlined</U>.
 426</P>
 427
 428<H3 ID="fontStrike">fontStrikeOpen, fontStrikeClose</H3>
 429
 430<P>
 431These tags are emitted, respectively, immediately before and after
 432some text that should appear <S>struck out</S>.
 433</P>
 434
 435<H3 ID="fontMono">fontMonoOpen, fontMonoClose</H3>
 436
 437<P>
 438These tags are emitted, respectively, immediately before and after
 439some text that should appear in a <CODE>monospaced</CODE> font, such as
 440inline source code.
 441</P>
 442
 443<H2 ID="section-Links">3.2. Links</H2>
 444
 445<P>
 446These tags are used to insert links to external files, pages, or
 447resources, as well as internal links within the document itself.
 448</P>
 449<P>
 450The link text itself is a <B>url</B>. Ordinarily, urls are not escaped
 451so as to preserve all characters within it exactly as typed. It the
 452rule <A HREF="#escapeurl">'escapeurl'</A> is defined for a target, the url will be passed
 453through <I>doEscape()</I> after all. Additionally, if the rule
 454<A HREF="#linkable">'linkable'</A> is not defined, signalling that this target does not
 455support true links, then the url will be escaped as well.
 456</P>
 457
 458<H3 ID="url">url</H3>
 459
 460<P>
 461This tag is used to insert a bare url without a label.
 462</P>
 463
 464<DL>
 465<DT>Macros:</DT><DD>
 466  <DL>
 467  <DT><B>\a</B></DT><DD>
 468    This mark within the tag will be expanded into the text of the
 469    url itself. For example, if the <CODE>url</CODE> tag is '[url=\a]'
 470    and the url in the source document in 'example.com', then
 471    the text '[url=example.com]' will be emitted.
 472  </DL>
 473</DL>
 474
 475<H3 ID="urlMark">urlMark</H3>
 476
 477<P>
 478This tag is used for a link with a label. The label will appear in
 479the final document, possibly formatted differently to set it apart,
 480but it will function as a link to the url.
 481</P>
 482
 483<DL>
 484<DT>Macros:</DT><DD>
 485  <DL>
 486  <DT><B>\a</B></DT><DD>
 487    This mark should appear twice in the tag. The first instance is
 488    expanded to the text of the url, the second instance is expanded
 489    to the text of the label.
 490  <P></P>
 491    If the rule <A HREF="#labelbeforelink">'labelbeforelink'</A> is defined for the target, then
 492    the first instance is the label, and the second instance is the
 493    url.
 494  <P></P>
 495    If the rule <A HREF="#imglinkable">'imglinkable'</A> is defined for the target, then an
 496    <A HREF="#img">img</A> tag (see below) is allowed as the label.
 497  </DL>
 498</DL>
 499
 500<H3 ID="urlMarkAnchor">urlMarkAnchor</H3>
 501
 502<P>
 503This tag is used if the url begins with a '#', designating an
 504internal link to an anchor within the document. Some targets require
 505a different tag for internal links than for external links.
 506</P>
 507<P>
 508This tag otherwise behaves identically as <A HREF="#urlMark">urlMark</A>, with the same
 509macro definitions.
 510</P>
 511
 512<H3 ID="email">email</H3>
 513
 514<P>
 515This tag is used if the url is detected as being for an email
 516address rather than to a webpage or file. Ordinarily Txt2tags will
 517detect automatically that the url represents an email address.
 518</P>
 519<P>
 520Just like <A HREF="#url">url</A>, this tag is used for a plain email with no label
 521defined.
 522</P>
 523
 524<DL>
 525<DT>Macros:</DT><DD>
 526  <DL>
 527  <DT><B>\a</B></DT><DD>
 528    This mark is expanded to the full text of the email address.
 529  </DL>
 530</DL>
 531
 532<H3 ID="emailMark">emailMark</H3>
 533
 534<P>
 535Similar to <A HREF="#urlMark">urlMark</A>, this tag is used for email addresses that
 536are assigned a label in the source document.
 537</P>
 538
 539<DL>
 540<DT>Macros:</DT><DD>
 541  <DL>
 542  <DT><B>\a</B></DT><DD>
 543    This mark appears twice in the tag, just like <A HREF="#urlMark">urlMark</A>. The
 544    first instance is expanded to the text of the email address, and
 545    the second instance to the text of the label. If the rule
 546    <A HREF="#labelbeforelink">'labelbeforelink'</A> is defined, then the first instance is the
 547    label and the second instance is the email address.
 548  </DL>
 549</DL>
 550
 551<H2 ID="section-Images">3.3. Images</H2>
 552
 553<P>
 554Many targets allow images to be included in documents, often with a
 555syntax similar to that of links. These tags are used to insert
 556images into your documents
 557</P>
 558
 559<H3 ID="img">img</H3>
 560
 561<P>
 562This is the basic tag used to insert an image into the output
 563document. The image is represented by a file path to the image file,
 564and is linked into the document.
 565</P>
 566<P>
 567The filename is not escaped, and is assumed to represent a real file
 568on the same filesystem as the document. As this time, links to
 569remote files are not supported.
 570</P>
 571
 572<DL>
 573<DT>Macros:</DT><DD>
 574  <DL>
 575  <DT><B>\a</B></DT><DD>
 576    This mark is expanded to the text of the file path pointing to
 577    the inserted image.
 578  <P></P>
 579  <DT><B>~A~</B></DT><DD>
 580    This mark represents the alignment of the image. If the rule
 581    <A HREF="#imgalignable">'imgalignable'</A> is defined for the target, then this mark will
 582    be replaced with the contents of <A HREF="#_imgAlign">_imgAlignLeft, _imgAlignRight, or _imgAlignCenter</A> as appropriate. (Note
 583    the underscore at the beginning of each tag.)
 584  </DL>
 585</DL>
 586
 587<H3 ID="_imgAlign">_imgAlignLeft, _imgAlignRight, _imgAlignCenter</H3>
 588
 589<P>
 590These tags are used to add alignment to the <A HREF="#img">img</A> tag. If the rule
 591<A HREF="#imgalignable">'imgalignable'</A> is defined, then whichever of these tags is
 592appropriate will replace the <B>~A~</B> mark within the <A HREF="#img">img</A> tag.
 593</P>
 594<P>
 595Note the underscores at the beginning of the tag names. Do not
 596confuse these with the <A HREF="#imgAlign">imgAlignLeft, imgAlignRight, and imgAlignCenter</A> tags, explained below.
 597</P>
 598
 599<DL>
 600<DT>Macros:</DT><DD>
 601  None
 602</DL>
 603
 604<H3 ID="imgAlign">imgAlignLeft, imgAlignRight, imgAlignCenter</H3>
 605
 606<P>
 607These tags are used if the alignment changes the image tags too much
 608to simply use <A HREF="#img">img</A> and <A HREF="#_imgAlign">_imgAlign*</A>.
 609</P>
 610<P>
 611If the rule <A HREF="#imgalignable">'imgalignable'</A> is defined and these tags are defined,
 612then they will be used <I>instead of</I> the <A HREF="#img">img</A> tag. Each of these
 613tags should have whatever markup is needed for image align in them,
 614and they will not have <B>~A~</B> expanded.
 615</P>
 616
 617<DL>
 618<DT>Macros:</DT><DD>
 619  <DL>
 620  <DT><B>\a</B></DT><DD>
 621    This mark is expanded to the file path of the image file, just
 622    as in the <A HREF="#img">img</A> tag.
 623  </DL>
 624</DL>
 625
 626<H3 ID="imgEmbed">imgEmbed</H3>
 627
 628<P>
 629This tag is used to embed image data directly into the document
 630itself, rather than to link to the image file externally. If the
 631command-line option <I>--embed-images</I> is used, then this tag will be
 632used <I>instead of</I> the <A HREF="#img">img</A> tag.
 633</P>
 634<P>
 635Currently this is only used by the <B>RTF</B> target, and will require
 636additional functionality to be added to Txt2tags to add support to
 637another target.
 638</P>
 639
 640<DL>
 641<DT>Macros:</DT><DD>
 642  <DL>
 643  <DT><B>\a</B></DT><DD>
 644    This mark is expanded into the full file data of the embedded
 645    image file, as well as whatever additional markup may be
 646    required to make it work with the target.
 647  </DL>
 648</DL>
 649
 650<H1 ID="chapter-TitlesandSections">4. Titles and Sections</H1>
 651
 652<P>
 653Txt2tags allows you to specify markup for separating documents into
 654sections, and for adding titles or headings to each section. It
 655accomplishes both these tasks with the <CODE>title</CODE> family of tags.
 656</P>
 657<P>
 658There are two methods used, depending on the tags and rules
 659specified. By default, the <A HREF="#title1">title*</A> tags are used simply to mark
 660up each section heading or subsection heading. Sections are implied
 661by these headings, but do not have explicit markup.
 662</P>
 663<P>
 664If the rule <A HREF="#titleblocks">'titleblocks'</A> is defined for the target, then the
 665<A HREF="#title1Open">title*Open*</A> and <A HREF="#blockTitle1Open">blockTitle*Open*</A> family of tags is used
 666instead. These explicitly separate sections and subsections and
 667allow additional markup for section commands as needed.
 668</P>
 669<P>
 670Either way, the titles are used to generate the automatic table of
 671contents, if desired. If the target supports its own table of
 672contents, then markup to add the titles/sections to it should be
 673included in the tags.
 674</P>
 675<P>
 676The title text itself does not support any additional Txt2tags
 677markup. That is, the user may not apply //italics// to the
 678title, as the marks will simply appear in the title as is. The title
 679text is escaped with the <I>doEscape()</I> function and, if the rule
 680<A HREF="#finalescapetitle">'finalescapetitle'</A> is defined, it is escaped by
 681<I>doFinalEscape()</I> as well.
 682</P>
 683
 684<H2 ID="section-TheAnchor">4.1. The Anchor</H2>
 685
 686<H3 ID="anchor">anchor</H3>
 687
 688<P>
 689This tag is used to add a linkable anchor the title heading, if the
 690target supports internal links. This should include all needed
 691markup to allow a <A HREF="#urlMark">urlMark</A> or <A HREF="#urlMarkAnchor">urlMarkAnchor</A> tag to link
 692directly to it from another part of the document.
 693</P>
 694<P>
 695If the command-line option <I>--toc</I> is specified, then all titles
 696will have anchors added to them (if they do not have one already)
 697and the table of contents will include direct links to each section
 698of the document.
 699</P>
 700
 701<DL>
 702<DT>Macros:</DT><DD>
 703  <DL>
 704  <DT><B>\a</B></DT><DD>
 705    This mark is expanded into the label text for the anchor, as
 706    specified by the user or generated automatically by Txt2tags if
 707    none has been specified and the <I>--toc</I> option is in effect.
 708  </DL>
 709</DL>
 710
 711<H2 ID="section-Titles">4.2. Titles</H2>
 712
 713<P>
 714The basic title tags are only used if the rule <A HREF="#titleblocks">'titleblocks'</A> is
 715not defined for the target. These are for simple markup of headings,
 716or simple section separators, for targets that do not require any
 717complicated markup for sections and subsections.
 718</P>
 719
 720<H3 ID="title1">title1, title2, title3, title4, title5</H3>
 721
 722<P>
 723These tags are for basic standard headings. <CODE>title1</CODE> is considered
 724the top level heading, <CODE>title2</CODE> the next level below it, and so
 725on.
 726</P>
 727<P>
 728If the rule <A HREF="#blanksaroundtitle">'blanksaroundtitle'</A> is defined, and extra blank line
 729will be emitted before and after this tag.
 730</P>
 731
 732<DL>
 733<DT>Macros:</DT><DD>
 734  <DL>
 735  <DT><B>\a</B></DT><DD>
 736    This mark is expanded into the text of the title itself,
 737    unchanged excepts for necessary escapes from the source
 738    document.
 739  <DT><B>~A~</B></DT><DD>
 740    This mark is expanded into the value of the <A HREF="#anchor">anchor</A> tag,
 741    along with the text of the label for that anchor. It is removed
 742    if the title does not have a label specified, and if txt2tags is
 743    not creating a tabel of contents.
 744  </DL>
 745</DL>
 746
 747<H3 ID="numtitle1">numtitle1, numtitle2, numtitle3, numtitle4, numtitle5</H3>
 748
 749<P>
 750These tags are used for sections heading that should be numbered.
 751They are otherwise treated the same as <A HREF="#title1">title*</A>.
 752</P>
 753<P>
 754If the rule <A HREF="#autonumbertitle">'autonumbertitle'</A> is defined, then these tags are
 755simply emitted as is, and the target is assumed to add the needed
 756numbers. If this rule is not defined for the target, then it is
 757assumed that the target does not have automatic numbering. In that
 758case, Txt2tags will automatically generate the correct
 759section/heading numbers and add that at the beginning of the title
 760text.
 761</P>
 762<P>
 763If the rule <A HREF="#blanksaroundnumtitle">'blanksaroundnumtitle'</A> is defined, an extra blank line
 764will be emitted before and after this tag.
 765</P>
 766
 767<DL>
 768<DT>Macros:</DT><DD>
 769  <DL>
 770  <DT><B>\a</B></DT><DD>
 771    This mark is expanded into the text of the title itself,
 772    unchanged excepts for necessary escapes from the source
 773    document.
 774  <DT><B>~A~</B></DT><DD>
 775    This mark is expanded into the value of the <A HREF="#anchor">anchor</A> tag,
 776    along with the text of the label for that anchor. It is removed
 777    if the title does not have a label specified, and if txt2tags is
 778    not creating a tabel of contents.
 779  </DL>
 780</DL>
 781
 782<H2 ID="section-SectioningTags">4.3. Sectioning Tags</H2>
 783
 784<P>
 785If the rule <A HREF="#titleblocks">'titleblocks'</A> is defined for the target, then the
 786above <A HREF="#title1">title*</A> tags are not used. Instead, the tags below are used
 787to separate the sections as a whole while also marking up the
 788section headings as needed.
 789</P>
 790
 791<H3 ID="title1Open">title1Open, title2Open, title3Open, title4Open, title5Open</H3>
 792
 793<P>
 794These tags are used to mark the beginning of a section or
 795subsection, as well as to mark up the heading for that section. They
 796work very similarly to the <A HREF="#title1">title*</A> tags above.
 797</P>
 798<P>
 799If the rule <A HREF="#blanksaroundtitle">'blanksaroundtitle'</A> is defined, an extra blank line
 800will be emitted before and after this tag.
 801</P>
 802
 803<DL>
 804<DT>Macros:</DT><DD>
 805  <DL>
 806  <DT><B>\a</B></DT><DD>
 807    This mark is expanded into the text of the title itself,
 808    unchanged excepts for necessary escapes from the source
 809    document.
 810  <DT><B>~A~</B></DT><DD>
 811    This mark is expanded into the value of the <A HREF="#anchor">anchor</A> tag,
 812    along with the text of the label for that anchor. It is removed
 813    if the title does not have a label specified, and if txt2tags is
 814    not creating a tabel of contents.
 815  </DL>
 816</DL>
 817
 818<H3 ID="title1Close">title1Close, title2Close, title3Close, title4Close, title5Close</H3>
 819
 820<P>
 821These tags are used to mark the end of a section that has been
 822opened with <A HREF="#title1Open">title*Open*</A>. It is emitted just before the opening
 823tag of the next section, as well as at the end of the document to
 824close all still-open sections.
 825</P>
 826<P>
 827Note that sections nest. If a second level section is specified just
 828after a first level section, and then another first level section,
 829the order of the tags will be: <CODE>title1Open</CODE>, <CODE>title2Open</CODE>,
 830<CODE>title2Close</CODE>, <CODE>title1Close</CODE>, <CODE>title1Open</CODE>, and so on.
 831</P>
 832
 833<DL>
 834<DT>Macros:</DT><DD>
 835  None
 836</DL>
 837
 838<H3 ID="blocktitle1Open">blocktitle1Open, blocktitle2Open, blocktitle3Open</H3>
 839
 840<P>
 841These tags are used to open a group of sections that are at the
 842same level. If multiple sections/titles are given in a row at the
 843same level, then the same level <CODE>blocktitle*Open</CODE> tag will be emitted
 844before the first <A HREF="#title1Open">title*Open*</A>.
 845</P>
 846
 847<DL>
 848<DT>Macros:</DT><DD>
 849  None
 850</DL>
 851
 852<H3 ID="blocktitle1Close">blocktitle1Close, blocktitle2Close, blocktitle3Close</H3>
 853
 854<P>
 855These tags are used to close a group of sections that are at the
 856same level. If multiple sections/titles are given in a row at the
 857same level, then the same level <CODE>blocktitle*Close</CODE> tag will be emitted
 858after the last <A HREF="#title1Close">title*Close*</A>.
 859</P>
 860
 861<DL>
 862<DT>Macros:</DT><DD>
 863  None
 864</DL>
 865
 866<H1 ID="chapter-Lists">5. Lists</H1>
 867
 868<P>
 869Lists are used to add structure to small groups of items. They can
 870be numbered or unnumbered, and they can be nested.
 871</P>
 872<P>
 873If the rule <A HREF="#compactlist">'compactlist'</A> is defined for a target, then lists will
 874be considered compact or wide, depending on whether or not an
 875item in the list includes multiple paragraphs. If even a simple list
 876item has more then one paragraph (that is, a blank line in the item
 877that is not immediately followed by another list item), then the
 878entire list is considered a wide list. If each item in the list is
 879contained within a single paragraph, then the list is considered
 880compact.
 881</P>
 882<P>
 883If the rule <A HREF="#compactlist">'compactlist'</A> is <I>not</I> defined, then there is no
 884difference bewteen wide and compact lists, and all lists are treated
 885as wide lists.
 886</P>
 887<P>
 888If the rule <A HREF="#parainsidelist">'parainsidelist'</A> is defined for a target, then the
 889blank lines in wide lists are emitted as an empty paragraph. That
 890is, <A HREF="#paragraphOpen">paragraphOpen</A> followed immediately by <A HREF="#paragraphClose">paragraphClose</A>.
 891</P>
 892<P>
 893The rule <A HREF="#spacedlistitem">'spacedlistitem'</A> appears to be intended to show that a
 894target supports wide or spaced lists. However, at this time the rule
 895appears to be unused by Txt2tags, and does not affect output at all.
 896</P>
 897<P>
 898The rule <A HREF="#listmaxdepth">'listmaxdepth'</A> is used to tell Txt2tags how many levels
 899of lists may be nested within one another for each target.
 900</P>
 901<P>
 902If the rule <A HREF="#listnotnested">'listnotnested'</A> is defined for a target, then it does
 903not support nested lists. Nested lists in the source are emitted as
 904if all items belonged to the same, top-level list.
 905</P>
 906<P>
 907If the rule <A HREF="#listitemnotnested">'listitemnotnested'</A> is defined for a target, then
 908list items are closed before emitting a nested list, rather than wrapping
 909around the nested list.
 910</P>
 911
 912<H2 ID="section-UnorderedLists">5.1. Unordered Lists</H2>
 913
 914<P>
 915These lists do not use numbers to separate each item. Typically each
 916list item is set off with a bullet symbol, though this can vary for
 917different targets.
 918</P>
 919<P>
 920If the rule <A HREF="#blanksaroundlist">'blanksaroundlist'</A> is defined for a target, an extra
 921blank line is emitted before and after the top level list. No
 922additional lines are emitted for nested lists with this rule.
 923</P>
 924<P>
 925If the rule <A HREF="#blanksaroundnestedlist">'blanksaroundnestedlist'</A> is defined for a target, an
 926extra blank line is emitted before and after all lists, including
 927nested lists.
 928</P>
 929
 930<H3 ID="listOpen">listOpen</H3>
 931
 932<P>
 933This tag is emitted to mark the start of a new bulleted list.
 934</P>
 935<P>
 936By default this tag is emitted on its own line. The rule
 937<A HREF="#notbreaklistopen">'notbreaklistopen'</A> is intended to allow
 938<CODE>listOpen</CODE> to be on the same line as its first item, however
 939this rule is not yet supported and does not affect the output.
 940</P>
 941<P>
 942By default, the indent of a nested list is added (in spaces) at the
 943beginning of the line this tag is on. If the rule
 944<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
 945not defined, these spaces are removed.
 946</P>
 947<P>
 948If the rule <A HREF="#compactlist">'compactlist'</A> is defined for a target, then this tag
 949is only used for wide lists. Otherwise it is used for both.
 950</P>
 951
 952<DL>
 953<DT>Macros:</DT><DD>
 954  None
 955</DL>
 956
 957<H3 ID="listCompactOpen">listCompactOpen</H3>
 958
 959<P>
 960This tag marks the beginning of a new compact bulleted list.
 961</P>
 962<P>
 963This tag is only used if the rule <A HREF="#compactlist">'compactlist'</A> is defined.
 964</P>
 965<P>
 966By default, the indent of a nested list is added (in spaces) at the
 967beginning of the line this tag is on. If the rule
 968<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
 969not defined, these spaces are removed.
 970</P>
 971
 972<DL>
 973<DT>Macros:</DT><DD>
 974  None
 975</DL>
 976
 977<H3 ID="listClose">listClose, listCompactClose</H3>
 978
 979<P>
 980These tags are emitted, on their own line, to close the list opened
 981by the previous tags.
 982</P>
 983<P>
 984By default, the indent of a nested list is added (in spaces) at the
 985beginning of the line this tag is on. If the rule
 986<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
 987not defined, these spaces are removed.
 988</P>
 989
 990<DL>
 991<DT>Macros:</DT><DD>
 992  None
 993</DL>
 994
 995<H3 ID="listItemOpen">listItemOpen</H3>
 996
 997<P>
 998This tag is emitted before each item within a bullet list.
 999</P>
1000<P>
1001By default, the indent of a nested list is added (in spaces) at the
1002beginning of the line this tag is on. If the rule
1003<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1004not defined, these spaces are removed.
1005</P>
1006<P>
1007If the tag <A HREF="#listItemLine">listItemLine</A> is defined, it will be emitted
1008immediately before <CODE>listItemOpen</CODE>. If the rule
1009<A HREF="#listlineafteropen">'listlineafteropen'</A> is defined,
1010<A HREF="#listItemLine">listItemLine</A> will be emitted after <CODE>listItemOpen</CODE>.
1011</P>
1012<P>
1013If the rule <A HREF="#spacedlistitemopen">'spacedlistitemopen'</A> is defined, then two spaces will
1014be emitted after <CODE>listItemOpen</CODE> and <A HREF="#listItemLine">listItemLine</A>, before the
1015list item text.
1016</P>
1017
1018<DL>
1019<DT>Macros:</DT><DD>
1020  <DL>
1021  <DT><B>~D~</B></DT><DD>
1022    If this macro is included in the tag, it will be expanded to the
1023    value of the depth of that particular list. Top level lists
1024    have depth '1', a nested list inside the top level would have
1025    depth level '2', and so on.
1026  <P></P>
1027    If the rule <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A> is defined for the target,
1028    the depth value will be multiplied by that amount before being
1029    emitted. If the rule <A HREF="#depthmultiplyplus">'depthmultiplyplus'</A> is defined, then that
1030    value will be added to the depth before multiplying by
1031    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, but only if used with
1032    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>.
1033  <DT><B>~V~</B></DT><DD>
1034    This macro will be expanded to the nesting level of the list. It
1035    is not affected by <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, so the numbers will
1036    always count one by one.
1037  <P></P>
1038    If the rule <A HREF="#listlevelzerobased">'listlevelzerobased'</A> is defined for a target, then
1039    the top level lists will be level '0', the next level '1',
1040    and so on. Otherwise, the top level is '1' and the next level
1041    '2' and so on.
1042  </DL>
1043</DL>
1044
1045<H3 ID="listItemLine">listItemLine</H3>
1046
1047<P>
1048This tag is emitted for each item in the list. It is emitted either
1049right before or after <A HREF="#listItemOpen">listItemOpen</A> (see above).
1050</P>
1051<P>
1052This is emitted a number of times equal to the depth level of the
1053list. For example, if <CODE>listItemLine</CODE> is defined as '*', then
1054each item in a list nested three levels deep would begin with
1055'***'.
1056</P>
1057<P>
1058Despite the name, this is only emitted at the beginning of each
1059item, and not for every line of the item.
1060</P>
1061
1062<DL>
1063<DT>Macros:</DT><DD>
1064  None
1065</DL>
1066
1067<H3 ID="listItemClose">listItemClose</H3>
1068
1069<P>
1070This tag is emitted after each item in the list.
1071</P>
1072
1073<DL>
1074<DT>Macros:</DT><DD>
1075  None
1076</DL>
1077
1078<H2 ID="section-NumberedLists">5.2. Numbered Lists</H2>
1079
1080<P>
1081Numbered lists behave much like unordered lists, except (as their
1082name implies) they have numbers instead of bullets.
1083</P>
1084<P>
1085Each item in the list will have its own number, counting from '1'.
1086By default, nested lists will use a dotted number format, as in
1087'1.', '2.', and so on. This can vary between different
1088targets, however.
1089</P>
1090<P>
1091If the rule <A HREF="#blanksaroundnumlist">'blanksaroundnumlist'</A> is defined for a target, an extra
1092blank line is emitted before and after the top level list. No
1093additional lines are emitted for nested lists.
1094</P>
1095<P>
1096If the rule <A HREF="#blanksaroundnestedlist">'blanksaroundnestedlist'</A> is defined for a target, an
1097extra blank line is emitted before and after all lists, including
1098nested lists.
1099</P>
1100
1101<H3 ID="numlistOpen">numlistOpen</H3>
1102
1103<P>
1104This tag is emitted to mark the start of a new numbered list.
1105</P>
1106<P>
1107By default this tag is emitted on its own line. The rule
1108<A HREF="#notbreaklistopen">'notbreaklistopen'</A> is intended to allow
1109<CODE>numlistOpen</CODE> to be on the same line as its first item, however
1110this rule is not yet supported and does not affect the output.
1111</P>
1112<P>
1113By default, the indent of a nested list is added (in spaces) at the
1114beginning of the line this tag is on. If the rule
1115<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1116not defined, these spaces are removed.
1117</P>
1118<P>
1119If the rule <A HREF="#compactlist">'compactlist'</A> is defined for a target, then this tag
1120is only used for wide lists. Otherwise it is used for both.
1121</P>
1122
1123<DL>
1124<DT>Macros:</DT><DD>
1125  None
1126</DL>
1127
1128<H3 ID="numlistCompactOpen">numlistCompactOpen</H3>
1129
1130<P>
1131This tag marks the beginning of a new compact numbered list.
1132</P>
1133<P>
1134This tag is only used if the rule <A HREF="#compactlist">'compactlist'</A> is defined.
1135</P>
1136<P>
1137By default, the indent of a nested list is added (in spaces) at the
1138beginning of the line this tag is on. If the rule
1139<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1140not defined, these spaces are removed.
1141</P>
1142
1143<DL>
1144<DT>Macros:</DT><DD>
1145  None
1146</DL>
1147
1148<H3 ID="numlistClose">numlistClose, numlistCompactClose</H3>
1149
1150<P>
1151These tags are emitted, on their own line, to close the list opened
1152by the previous tags.
1153</P>
1154<P>
1155By default, the indent of a nested list is added (in spaces) at the
1156beginning of the line this tag is on. If the rule
1157<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1158not defined, these spaces are removed.
1159</P>
1160
1161<DL>
1162<DT>Macros:</DT><DD>
1163  None
1164</DL>
1165
1166<H3 ID="numlistItemOpen">numlistItemOpen</H3>
1167
1168<P>
1169This tag is emitted before each item within a numbered list.
1170</P>
1171<P>
1172If the rule <A HREF="#autonumberlist">'autonumberlist'</A> is defined, then the target is
1173assumed to put the numbers in itself. In this case Txt2Tags simply
1174emits this tag just like <A HREF="#listItemOpen">listItemOpen</A>. If it is not defined,
1175then the correct number is calculated and inserted by Txt2tags. It
1176uses the default number format given at the beginning of this
1177subsection above.
1178</P>
1179<P>
1180By default, the indent of a nested list is added (in spaces) at the
1181beginning of the line this tag is on. If the rule
1182<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1183not defined, these spaces are removed.
1184</P>
1185<P>
1186If the tag <A HREF="#numlistItemLine">numlistItemLine</A> is defined, it will be emitted
1187immediately before <CODE>numlistItemOpen</CODE>. If the rule
1188<A HREF="#listlineafteropen">'listlineafteropen'</A> is defined, <A HREF="#numlistItemLine">numlistItemLine</A> will be emitted
1189after <CODE>numlistItemOpen</CODE>.
1190</P>
1191<P>
1192If the rule <A HREF="#spacednumlistitemopen">'spacednumlistitemopen'</A> is defined, then two spaces will
1193be emitted after <CODE>numlistItemOpen</CODE> and <A HREF="#numlistItemLine">numlistItemLine</A>, before the
1194list item text.
1195</P>
1196
1197<DL>
1198<DT>Macros:</DT><DD>
1199  <DL>
1200  <DT><B>\a</B></DT><DD>
1201    If the rule <A HREF="#autonumberlist">'autonumberlist'</A> is <I>not</I> defined, then this
1202    mark is expanded into the correct number for this list item.
1203  <DT><B>~D~</B></DT><DD>
1204    If this macro is included in the tag, it will be expanded to the
1205    value of the depth of that particular list. Top level lists
1206    have depth '1', a nested list inside the top level would have
1207    depth level '2', and so on.
1208  <P></P>
1209    If the rule <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A> is defined for the target,
1210    the depth value will be multiplied by that amount before being
1211    emitted. If the rule <A HREF="#depthmultiplyplus">'depthmultiplyplus'</A> is defined, then that
1212    value will be added to the depth before multiplying by
1213    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, but only if used with
1214    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>.
1215  <DT><B>~V~</B></DT><DD>
1216    This macro will be expanded to the nesting level of the list. It
1217    is not affected by <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, so the numbers will
1218    always count one by one.
1219  <P></P>
1220    If the rule <A HREF="#listlevelzerobased">'listlevelzerobased'</A> is defined for a target, then
1221    the top level lists will be level '0', the next level '1',
1222    and so on. Otherwise, the top level is '1' and the next level
1223    '2' and so on.
1224  </DL>
1225</DL>
1226
1227<H3 ID="numlistItemLine">numlistItemLine</H3>
1228
1229<P>
1230This tag is emitted for each item in the list. It is emitted either
1231right before or after <A HREF="#numlistItemOpen">numlistItemOpen</A> (see above).
1232</P>
1233<P>
1234This is emitted a number of times equal to the depth level of the
1235list. For example, if <CODE>numlistItemLine</CODE> is defined as '+', then
1236each item in a list nested three levels deep would begin with
1237'+++'.
1238</P>
1239<P>
1240Despite the name, this is only emitted at the beginning of each
1241item, and not for every line of the item.
1242</P>
1243
1244<DL>
1245<DT>Macros:</DT><DD>
1246  None
1247</DL>
1248
1249<H3 ID="numlistItemClose">numlistItemClose</H3>
1250
1251<P>
1252This tag is emitted after each item in the list.
1253</P>
1254
1255<DL>
1256<DT>Macros:</DT><DD>
1257  None
1258</DL>
1259
1260<H2 ID="section-DefinitionLists">5.3. Definition Lists</H2>
1261
1262<P>
1263Definition lists work a little bit differently from standard lists.
1264Each list item has two parts: the item or word to be defined, and
1265the definition itself.
1266</P>
1267<P>
1268If the rule <A HREF="#deflisttextstrip">'deflisttextstrip'</A> is defined, then each line of the
1269definition will have extra spaces stripped off, even if
1270<A HREF="#keeplistindent">'keeplistindent'</A> is also defined.
1271</P>
1272<P>
1273If the rule <A HREF="#blanksarounddeflist">'blanksarounddeflist'</A> is defined for a target, an extra
1274blank line is emitted before and after the top level list. No
1275additional lines are emitted for nested lists.
1276</P>
1277<P>
1278If the rule <A HREF="#blanksaroundnestedlist">'blanksaroundnestedlist'</A> is defined for a target, an
1279extra blank line is emitted before and after all lists, including
1280nested lists.
1281</P>
1282
1283<H3 ID="deflistOpen">deflistOpen</H3>
1284
1285<P>
1286This tag is emitted to mark the start of a new definition list.
1287</P>
1288<P>
1289By default this tag is emitted on its own line. The rule
1290<A HREF="#notbreaklistopen">'notbreaklistopen'</A> is intended to allow <A HREF="#listOpen">listOpen</A> to be on the
1291same line as its first item, however this rule is not yet supported
1292and does not affect the output.
1293</P>
1294<P>
1295By default, the indent of a nested list is added (in spaces) at the
1296beginning of the line this tag is on. If the rule
1297<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1298not defined, these spaces are removed.
1299</P>
1300<P>
1301If the rule <A HREF="#compactlist">'compactlist'</A> is defined for a target, then this tag
1302is only used for wide lists. Otherwise it is used for both.
1303</P>
1304
1305<DL>
1306<DT>Macros:</DT><DD>
1307  None
1308</DL>
1309
1310<H3 ID="deflistCompactOpen">deflistCompactOpen</H3>
1311
1312<P>
1313This tag marks the beginning of a new compact definition list.
1314</P>
1315<P>
1316This tag is only used if the rule <A HREF="#compactlist">'compactlist'</A> is defined.
1317</P>
1318<P>
1319By default, the indent of a nested list is added (in spaces) at the
1320beginning of the line this tag is on. If the rule
1321<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1322not defined, these spaces are removed.
1323</P>
1324
1325<DL>
1326<DT>Macros:</DT><DD>
1327  None
1328</DL>
1329
1330<H3 ID="deflistClose">deflistClose, deflistCompactClose</H3>
1331
1332<P>
1333These tags are emitted, on their own line, to close the list opened
1334by the previous tags.
1335</P>
1336<P>
1337By default, the indent of a nested list is added (in spaces) at the
1338beginning of the line this tag is on. If the rule
1339<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1340not defined, these spaces are removed.
1341</P>
1342
1343<DL>
1344<DT>Macros:</DT><DD>
1345  None
1346</DL>
1347
1348<H3 ID="deflistItem1Open">deflistItem1Open</H3>
1349
1350<P>
1351This tag is emitted before each item within a definition list. It is
1352specifically meant to go before the term to be defined.
1353</P>
1354<P>
1355By default, the indent of a nested list is added (in spaces) at the
1356beginning of the line this tag is on. If the rule
1357<A HREF="#tagnotindentable">'tagnotindentable'</A> is defined, or the rule <A HREF="#keeplistindent">'keeplistindent'</A> is
1358not defined, these spaces are removed.
1359</P>
1360<P>
1361If the rule <A HREF="#imgasdefterm">'imgasdefterm'</A> is defined, then a linked image is
1362allowed as the term to be defined. Otherwise, only text is allowed.
1363</P>
1364
1365<DL>
1366<DT>Macros:</DT><DD>
1367  <DL>
1368  <DT><B>~D~</B></DT><DD>
1369    If this macro is included in the tag, it will be expanded to the
1370    value of the depth of that particular list. Top level lists
1371    have depth '1', a nested list inside the top level would have
1372    depth level '2', and so on.
1373  <P></P>
1374    If the rule <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A> is defined for the target,
1375    the depth value will be multiplied by that amount before being
1376    emitted. If the rule <A HREF="#depthmultiplyplus">'depthmultiplyplus'</A> is defined, then that
1377    value will be added to the depth before multiplying by
1378    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, but only if used with
1379    <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>.
1380  <DT><B>~V~</B></DT><DD>
1381    This macro will be expanded to the nesting level of the list. It
1382    is not affected by <A HREF="#blockdepthmultiply">'blockdepthmultiply'</A>, so the numbers will
1383    always count one by one.
1384  <P></P>
1385    If the rule <A HREF="#listlevelzerobased">'listlevelzerobased'</A> is defined for a target, then
1386    the top level lists will be level '0', the next level '1',
1387    and so on. Otherwise, the top level is '1' and the next level
1388    '2' and so on.
1389  </DL>
1390</DL>
1391
1392<H3 ID="deflistItem1Close">deflistItem1Close</H3>
1393
1394<P>
1395This tag is emitted after each definition term, but before the
1396definition itself, for each item in the list.
1397</P>
1398
1399<DL>
1400<DT>Macros:</DT><DD>
1401  None
1402</DL>
1403
1404<H3 ID="deflistItem2Open">deflistItem2Open</H3>
1405
1406<P>
1407This tag is emitted directly after <A HREF="#deflistItem1Close">deflistItem1Close</A>, and is
1408used right before the definition text of the item.
1409</P>
1410
1411<DL>
1412<DT>Macros:</DT><DD>
1413  None
1414</DL>
1415
1416<H3 ID="deflistItem2LinePrefix">deflistItem2LinePrefix</H3>
1417
1418<P>
1419This tag is emitted at the beginning of each line of the definition
1420text for each item.
1421</P>
1422<P>
1423Note that it is not multiplied for nexted lists. It is the same for
1424every level of a nested list.
1425</P>
1426<P>
1427If the rule <A HREF="#keeplistindent">'keeplistindent'</A> is defined and <A HREF="#deflisttextstrip">'deflisttextstrip'</A>
1428is not defined, then this is emitted after the indent for each line
1429of the list.
1430</P>
1431
1432<DL>
1433<DT>Macros:</DT><DD>
1434  None
1435</DL>
1436
1437<H3 ID="deflistItem2Close">deflistItem2Close</H3>
1438
1439<P>
1440This tag is emitted at the end of each definition, and therefor at
1441the end of each item of the definition list.
1442</P>
1443<P>
1444For examples, the tags for a definition list are emitted as follows:
1445<CODE>deflistOpen</CODE>, <CODE>deflistItem1Open</CODE>, <CODE>deflistItem1Close</CODE>,
1446<CODE>deflistItem2Open</CODE>, (<CODE>deflistItem2LinePrefix</CODE> for each line),
1447<CODE>deflistItem2Close</CODE>, <CODE>deflistItem1Open</CODE>, and so on for the
1448entire list.
1449</P>
1450
1451<DL>
1452<DT>Macros:</DT><DD>
1453  None
1454</DL>
1455
1456<H1 ID="chapter-Tables">6. Tables</H1>
1457
1458<P>
1459Tables allow the user to arrange data in rows and columns for better
1460organization. Some targets support very complicated tables, while
1461others only support limited options within tables or do not support
1462tables at all. Txt2tags is limited to the most basic and most common
1463table options usable by the greatest number of targets.
1464</P>
1465<P>
1466If the rule <A HREF="#tableable">'tableable'</A> is <I>not</I> defined, then the table markup
1467is emitted unchanged from the source document and put inside a
1468verbatim block.
1469</P>
1470<P>
1471If the rule <A HREF="#blanksaroundtable">'blanksaroundtable'</A> is defined, then an extra blank
1472line will be emitted before and after the table markup.
1473</P>
1474
1475<H2 ID="section-Macros">6.1. Macros</H2>
1476
1477<P>
1478Because of how complicated most table markup can be, there are
1479several macro tags that can be defined that may be expanded by
1480several other tags. These tags will all be defined here to be easier
1481to find in this reference.
1482</P>
1483
1484<H3 ID="_tableBorder">_tableBorder</H3>
1485
1486<P>
1487This tag may be inserted into the outer table and row tags to
1488designate that this table should have a border.
1489</P>
1490<P>
1491For tags that support it, it will replace the macro <B>~B~</B>.
1492</P>
1493
1494<H3 ID="_tableCellBorder">_tableCellBorder</H3>
1495
1496<P>
1497This tag may be inserted into the markup of each individual cell to
1498designate that this table should have a border.
1499</P>
1500<P>
1501It will replace the macro <B>~B~</B>.
1502</P>
1503
1504<H3 ID="_tableAlign">_tableAlignLeft, _tableAlignCenter</H3>
1505
1506<P>
1507These tags may be inserted into the outer table and row tags to
1508designate how the entire table should be aligned within the
1509document, if the target supports table alignment.
1510</P>
1511<P>
1512Note that Txt2tags does not currently allow right-aligned tables.
1513</P>
1514<P>
1515Whichever tag is appropriate will replace the macro <B>~A~</B>.
1516</P>
1517
1518<H3 ID="_tableColAlign">_tableColAlignLeft, _tableColAlignRight, _tableColAlignCenter</H3>
1519
1520<P>
1521If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to the value <A HREF="#column">'column'</A>
1522for the target, then these tags may be inserted into the outer table
1523or row tags for that table.
1524</P>
1525<P>
1526These alignment settings will be used for each cell in the column,
1527for targets that do not support per-cell alignment.
1528</P>
1529<P>
1530The column alignment 'group' is made out of several copies of these
1531tags, one for each column in the table. They may be separated by
1532<A HREF="#tableColAlignSep">tableColAlignSep</A>. Then the entire group is inserted into the
1533appropriate opening tags of the table.
1534</P>
1535<P>
1536The column alignment group will replace the macro <B>~C~</B>.
1537</P>
1538
1539<H3 ID="tableColAlignSep">tableColAlignSep</H3>
1540
1541<P>
1542If the table has a border, then each item in the column alignment
1543group (see above) will be separated by this tag. It is also used in
1544multicolumn cells (see below) for the same purpose.
1545</P>
1546<P>
1547Note that, if the table does not have a border, then not only will
1548this tag not be inserted into the alignment group, but any copies of
1549the tag already in the relevant tags of the table will also be
1550removed.
1551</P>
1552
1553<H3 ID="_tableCellAlign">_tableCellAlignLeft, _tableCellAlignRight, _tableCellAlignCenter</H3>
1554
1555<P>
1556If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to the value <A HREF="#cell">'cell'</A>
1557for the target, then these tags may be inserted into the cell tags
1558for the table. This is for targets that support per-cell alignment.
1559</P>
1560<P>
1561The alignment tag will replace the macro <B>~A~</B>.
1562</P>
1563
1564<H3 ID="_tableCellColSpan">_tableCellColSpan</H3>
1565
1566<P>
1567If the rule <A HREF="#tablecellspannable">'tablecellspannable'</A> is defined for a target, then
1568this tag will be inserted into cells that span more than one column.
1569</P>
1570<P>
1571It replaces the macro <B>~S~</B>.
1572</P>
1573
1574<DL>
1575<DT>Macros:</DT><DD>
1576  <DL>
1577  <DT><B>\a</B></DT><DD>
1578    This mark is used inside the tag to give the span of the cell.
1579    It is replaced with the numeric value of the number of columns
1580    that this cell spans.
1581  <P></P>
1582    <CODE>_tableCellColSpan</CODE> will only be emitted for cells that have a
1583    span value greater than '1'.
1584  <P></P>
1585    If the rule <A HREF="#cellspancumulative">'cellspancumulative'</A> is defined for a target, then
1586    this value will grow for each cell in a row. That is, cell '1'
1587    will have a span value of '1', cell '2' will have a span value of
1588    '2', and so on, with spanned cells increasing the value more.
1589  <P></P>
1590    If the rule <A HREF="#cellspanmultiplier">'cellspanmultiplier'</A> is defined for a target, then
1591    the span value will be multiplied by this value, after
1592    accumulation if appropriate.
1593  </DL>
1594</DL>
1595
1596<H3 ID="_tableCellColSpanChar">_tableCellColSpanChar</H3>
1597
1598<P>
1599If the rule <A HREF="#tablecellspannable">'tablecellspannable'</A> is defined for a target and this
1600tag is also defined, it will be used instead of
1601<A HREF="#_tableCellColSpan">_tableCellColSpan</A>.
1602</P>
1603<P>
1604This tag will be emitted the same number of times as columns that
1605the cell spans, <I>minus 1</I>. For example, if the tag is defined as
1606'|', and a cell spans three columns, then '||' will be emitted.
1607</P>
1608<P>
1609The tag, however many need to be emitted, will replace the macro
1610<B>~S~</B>.
1611</P>
1612
1613<H3 ID="_tableAttrDelimiter">_tableAttrDelimiter</H3>
1614
1615<P>
1616This tag may be inserted into cells that have either a cell
1617alignment or a cell span to insert. This may be used to separate the
1618cell attributes from the body of the cell itself.
1619</P>
1620<P>
1621If the cell has neither an alignment or span to insert, then the
1622macro for this tag is removed.
1623</P>
1624<P>
1625This tag will replace the macro <B>~Z~</B>.
1626</P>
1627
1628<H2 ID="section-TableStructure">6.2. Table Structure</H2>
1629
1630<H3 ID="tableOpen">tableOpen, tableClose</H3>
1631
1632<P>
1633These tags are the first and last tag emitted for a table. They are
1634emitted on lines of their own, and are emitted only once for each table.
1635</P>
1636
1637<DL>
1638<DT>Macros:</DT><DD>
1639  <DL>
1640  <DT><B>~A~</B></DT><DD>
1641    This will be replaced with <A HREF="#_tableAlign">_tableAlign*</A> for a left or center
1642    aligned table.
1643  <DT><B>~B~</B></DT><DD>
1644    This will be replaced with the <A HREF="#_tableBorder">_tableBorder</A> tag for tables
1645    that have a border, or removed otherwise.
1646  <DT><B>~C~</B></DT><DD>
1647    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to <A HREF="#column">'column'</A>, then
1648    this will be replaced with the column alignment group for the
1649    table. (See <A HREF="#_tableColAlign">_tableColAlign*</A> above.)
1650  </DL>
1651</DL>
1652
1653<H3 ID="tableRowOpen">tableRowOpen</H3>
1654
1655<P>
1656This tag is emitted at the beginning of each row of cells.
1657</P>
1658<P>
1659By default each row is emitted on a single line. If the rule
1660<A HREF="#breaktablelineopen">'breaktablelineopen'</A> is defined, then a linebreak will be emitted
1661after this tag before the cells.
1662</P>
1663
1664<DL>
1665<DT>Macros:</DT><DD>
1666  <DL>
1667  <DT><B>~A~</B></DT><DD>
1668    This will be replaced with <A HREF="#_tableAlign">_tableAlign*</A> for a left or center
1669    aligned table.
1670  <DT><B>~B~</B></DT><DD>
1671    This will be replaced with the <A HREF="#_tableBorder">_tableBorder</A> tag for tables
1672    that have a border, or removed otherwise.
1673  <DT><B>~C~</B></DT><DD>
1674    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to <A HREF="#column">'column'</A>, then
1675    this will be replaced with the column alignment group for the
1676    table. (See <A HREF="#_tableColAlign">_tableColAlign*</A> above.)
1677  </DL>
1678</DL>
1679
1680<H3 ID="tableTitleRowOpen">tableTitleRowOpen</H3>
1681
1682<P>
1683This tag, if defined, will be used instead of <A HREF="#tableRowOpen">tableRowOpen</A> for
1684title rows. If it is not defined, <A HREF="#tableRowOpen">tableRowOpen</A> will be used for
1685all rows.
1686</P>
1687<P>
1688Note that title rows are not required, and do not need to be the
1689first row of a table.
1690</P>
1691<P>
1692If the rule <A HREF="#breaktablelineopen">'breaktablelineopen'</A> is defined, then a linebreak will
1693be emitted after this tag before the cells.
1694</P>
1695
1696<DL>
1697<DT>Macros:</DT><DD>
1698  <DL>
1699  <DT><B>~A~</B></DT><DD>
1700    This will be replaced with <A HREF="#_tableAlign">_tableAlign*</A> for a left or center
1701    aligned table.
1702  <DT><B>~B~</B></DT><DD>
1703    This will be replaced with the <A HREF="#_tableBorder">_tableBorder</A> tag for tables
1704    that have a border, or removed otherwise.
1705  <DT><B>~C~</B></DT><DD>
1706    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to <A HREF="#column">'column'</A>, then
1707    this will be replaced with the column alignment group for the
1708    table. (See <A HREF="#_tableColAlign">_tableColAlign*</A> above.)
1709  </DL>
1710</DL>
1711
1712<H3 ID="tableRowClose">tableRowClose, tableTitleRowClose</H3>
1713
1714<P>
1715These tags are emitted at the end of each row begun by the tags
1716above.
1717</P>
1718<P>
1719If <CODE>tableTitleRowClose</CODE> is not defined, <CODE>tableRowClose</CODE> will be
1720used instead.
1721</P>
1722
1723<DL>
1724<DT>Macros:</DT><DD>
1725  <DL>
1726  <DT><B>~A~</B></DT><DD>
1727    This will be replaced with <A HREF="#_tableAlign">_tableAlign*</A> for a left or center
1728    aligned table.
1729  <DT><B>~B~</B></DT><DD>
1730    This will be replaced with the <A HREF="#_tableBorder">_tableBorder</A> tag for tables
1731    that have a border, or removed otherwise.
1732  <DT><B>~C~</B></DT><DD>
1733    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to <A HREF="#column">'column'</A>, then
1734    this will be replaced with the column alignment group for the
1735    table. (See <A HREF="#_tableColAlign">_tableColAlign*</A> above.)
1736  </DL>
1737</DL>
1738
1739<H3 ID="tableRowSep">tableRowSep</H3>
1740
1741<P>
1742This tag will be emitted in between each row of cells.
1743</P>
1744<P>
1745Note that if this tag is defined, then <A HREF="#tableRowOpen">tableRowOpen</A> and
1746<A HREF="#tableRowClose">tableRowClose</A> will not be used at all.
1747</P>
1748
1749<DL>
1750<DT>Macros:</DT><DD>
1751  <DL>
1752  <DT><B>~A~</B></DT><DD>
1753    This will be replaced with <A HREF="#_tableAlign">_tableAlign*</A> for a left or center
1754    aligned table.
1755  <DT><B>~B~</B></DT><DD>
1756    This will be replaced with the <A HREF="#_tableBorder">_tableBorder</A> tag for tables
1757    that have a border, or removed otherwise.
1758  <DT><B>~C~</B></DT><DD>
1759    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to <A HREF="#column">'column'</A>, then
1760    this will be replaced with the column alignment group for the
1761    table. (See <A HREF="#_tableColAlign">_tableColAlign*</A> above.)
1762  </DL>
1763</DL>
1764
1765<H2 ID="section-Cells">6.3. Cells</H2>
1766
1767<P>
1768Each cell of data for a table may be marked up separately.
1769</P>
1770<P>
1771By default, each row of cells is emitted on a single line. If the
1772rule <A HREF="#breaktablecell">'breaktablecell'</A> is defined for a target, then a linebreak
1773will be emitted after each cell.
1774</P>
1775<P>
1776If the rule <A HREF="#tablecellstrip">'tablecellstrip'</A> is defined for a target, then any
1777extra spaces will be stripped from each cell before it is emitted.
1778Otherwise, all spaces from the source document (including that used
1779to determine cell alignment) will be included in the final output.
1780</P>
1781<P>
1782If the rule <A HREF="#tabletitlerowinbold">'tabletitlerowinbold'</A> is defined, then all cells
1783considered part of a title row will have their contents wrapped in
1784<A HREF="#fontBold">fontBoldOpen and fontBoldClose</A> tags.
1785</P>
1786
1787<H3 ID="tableCellOpen">tableCellOpen, tableTitleCellOpen</H3>
1788
1789<P>
1790These tags are emitted at the beginning of each cell within the
1791table. If <CODE>tableTitleCellOpen</CODE> is defined, then it will be used
1792for the cells on a title row. Otherwise, <CODE>tableCellOpen</CODE> will be
1793used for all cells.
1794</P>
1795
1796<DL>
1797<DT>Macros:</DT><DD>
1798  <DL>
1799  <DT><B>~A~</B></DT><DD>
1800    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to the value
1801    <A HREF="#cell">'cell'</A> for a target, then this will be replaced with the
1802    appropriate <A HREF="#_tableCellAlign">_tableCellAlign*</A> tag.
1803  <DT><B>~B~</B></DT><DD>
1804    If the table has a border, this will be replaced with the
1805    <A HREF="#_tableCellBorder">_tableCellBorder</A> tag, or removed if not.
1806  <DT><B>~S~</B></DT><DD>
1807    If the rule <A HREF="#tablecellspannable">'tablecellspannable'</A> is defined, and the cell
1808    spans multiple columns, then this tag will be replaced with the
1809    value of either <A HREF="#_tableCellColSpanChar">_tableCellColSpanChar</A> or
1810    <A HREF="#_tableCellColSpan">_tableCellColSpan</A> as appropriate.
1811  <DT><B>~Z~</B></DT><DD>
1812    If the cell has and alignment or column span to be inserted,
1813    then this tag will be replaced with <A HREF="#_tableAttrDelimiter">_tableAttrDelimiter</A>. If
1814    the cell has neither, then it will be removed.
1815  </DL>
1816</DL>
1817
1818<H3 ID="tableCellClose">tableCellClose, tableTitleCellClose</H3>
1819
1820<P>
1821These tags are emitted at the end of each cell within the table. If
1822<CODE>tableTitleCellClose</CODE> is defined, then it will be used for the
1823cells on a title row. Otherwise, <CODE>tableCellClose</CODE> will be used for
1824all cells.
1825</P>
1826
1827<DL>
1828<DT>Macros:</DT><DD>
1829  <DL>
1830  <DT><B>~A~</B></DT><DD>
1831    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to the value
1832    <A HREF="#cell">'cell'</A> for a target, then this will be replaced with the
1833    appropriate <A HREF="#_tableCellAlign">_tableCellAlign*</A> tag.
1834  <DT><B>~B~</B></DT><DD>
1835    If the table has a border, this will be replaced with the
1836    <A HREF="#_tableCellBorder">_tableCellBorder</A> tag, or removed if not.
1837  <DT><B>~S~</B></DT><DD>
1838    If the rule <A HREF="#tablecellspannable">'tablecellspannable'</A> is defined, and the cell
1839    spans multiple columns, then this tag will be replaced with the
1840    value of either <A HREF="#_tableCellColSpanChar">_tableCellColSpanChar</A> or
1841    <A HREF="#_tableCellColSpan">_tableCellColSpan</A> as appropriate.
1842  </DL>
1843</DL>
1844
1845<H3 ID="tableCellSep">tableCellSep, tableTitleCellSep</H3>
1846
1847<P>
1848These tags are emitted in between each cell of a row. If
1849<CODE>tableTitleCellSep</CODE> is defined, then it will be used for the cells
1850on a title row. Otherwise, <CODE>tableCellSep</CODE> will be used for all
1851cells.
1852</P>
1853<P>
1854These tags are only emited between cells. They do not appear before
1855the first cell of a row or after the last cell of a row.
1856</P>
1857<P>
1858Note that, unlike <A HREF="#tableRowSep">tableRowSep</A>, these tags are used as well as
1859<A HREF="#tableCellOpen">tableCellOpen</A> and <A HREF="#tableCellClose">tableCellClose</A>. If all are defined, then
1860<CODE>tableCellSep</CODE> will be emitted after <CODE>tableCellClose</CODE> and before
1861the next <CODE>tableCellOpen</CODE>.
1862</P>
1863
1864<DL>
1865<DT>Macros:</DT><DD>
1866  None
1867</DL>
1868
1869<H3 ID="_tableCellMulticolOpen">_tableCellMulticolOpen</H3>
1870
1871<P>
1872If the rule <A HREF="#tablecellmulticol">'tablecellmulticol'</A> is defined for a target, and a
1873cell spans more than one column, then this tag will be used instead
1874of <A HREF="#tableCellOpen">tableCellOpen</A>.
1875</P>
1876
1877<DL>
1878<DT>Macros:</DT><DD>
1879  <DL>
1880  <DT><B>\a</B></DT><DD>
1881    This will be replaced with the current cell's column span value.
1882    See <A HREF="#_tableCellColSpan">_tableCellColSpan</A> above for an explanation of this
1883    value.
1884  <DT><B>~A~</B></DT><DD>
1885    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to the value
1886    <A HREF="#cell">'cell'</A> for a target, then this will be replaced with the
1887    appropriate <A HREF="#_tableCellAlign">_tableCellAlign*</A> tag.
1888  <DT><B>~Z~</B></DT><DD>
1889    If the cell has an alignment or column span to be inserted,
1890    then this tag will be replaced with <A HREF="#_tableAttrDelimiter">_tableAttrDelimiter</A>. If
1891    the cell has neither, then it will be removed.
1892  </DL>
1893</DL>
1894
1895<H3 ID="_tableCellMulticolClose">_tableCellMulticolClose</H3>
1896
1897<P>
1898If the rule <A HREF="#tablecellmulticol">'tablecellmulticol'</A> is defined for a target, and a
1899cell spans more than one column, then this tag will be used instead
1900of <A HREF="#tableCellClose">tableCellClose</A>.
1901</P>
1902
1903<DL>
1904<DT>Macros:</DT><DD>
1905  None
1906</DL>
1907
1908<H3 ID="tableCellHead">tableCellHead, tableTitleCellHead</H3>
1909
1910<P>
1911These tags are use to define 'headers', one for each cell, that are
1912inserted at the beginning of a row before the cell data itself.
1913</P>
1914<P>
1915For example, the order of tags for a row with three cells may be
1916<CODE>tableRowOpen</CODE>, <CODE>tableCellHead</CODE>, <CODE>tableCellHead</CODE>,
1917<CODE>tableCellHead</CODE>, <CODE>tableCellOpen</CODE>, and so on.
1918</P>
1919<P>
1920If <CODE>tableTitleCellHead</CODE> is defined, it will be used for cells in a
1921title row, otherwise <CODE>tableCellHead</CODE> will be used for all rows.
1922</P>
1923
1924<DL>
1925<DT>Macros:</DT><DD>
1926  <DL>
1927  <DT><B>~A~</B></DT><DD>
1928    If the rule <A HREF="#tablecellaligntype">'tablecellaligntype'</A> is set to the value
1929    <A HREF="#cell">'cell'</A> for a target, then this will be replaced with the
1930    appropriate <A HREF="#_tableCellAlign">_tableCellAlign*</A> tag.
1931  <DT><B>~B~</B></DT><DD>
1932    If the table has a border, this will be replaced with the
1933    <A HREF="#_tableCellBorder">_tableCellBorder</A> tag, or removed if not.
1934  <DT><B>~S~</B></DT><DD>
1935    If the rule <A HREF="#tablecellspannable">'tablecellspannable'</A> is defined, and the cell
1936    spans multiple columns, then this tag will be replaced with the
1937    value of either <A HREF="#_tableCellColSpanChar">_tableCellColSpanChar</A> or
1938    <A HREF="#_tableCellColSpan">_tableCellColSpan</A> as appropriate.
1939  </DL>
1940</DL>
1941
1942<H3 ID="tableCellAlign">tableCellAlignLeft, tableCellAlignRight, tableCellAlignCenter</H3>
1943
1944<P>
1945If these tags are defined and a cell has an alignment attribute,
1946then the cell text will be wrapped by the appropriate tag before it
1947is emitted.
1948</P>
1949<P>
1950Note that these cells do not begin with an underscore. Do not get
1951them confused with the <A HREF="#_tableCellAlign">_tableCellAlign*</A> tags, which replace
1952macros within the other cell tags.
1953</P>
1954
1955<DL>
1956<DT>Macros:</DT><DD>
1957  <DL>
1958  <DT><B>\a</B></DT><DD>
1959    This will be replaced by the text of the cell itself.
1960  </DL>
1961</DL>
1962
1963<H1 ID="chapter-Miscellaneous">7. Miscellaneous</H1>
1964
1965<P>
1966These tags are useful or necessary for a fully implemented target,
1967but did not fit well within the other categories.
1968</P>
1969
1970<H2 ID="section-DocumentStructureandFormatting">7.1. Document Structure and Formatting</H2>
1971
1972<H3 ID="pageBreak">pageBreak</H3>
1973
1974<P>
1975For targets that support separation into pages, this tag is used to
1976force a page break in the output.
1977</P>
1978
1979<H3 ID="bar1">bar1, bar2</H3>
1980
1981<P>
1982These tags are used to insert a horizontal line in the output,
1983usually used as a lesser section break without beginning a new
1984section.
1985</P>
1986<P>
1987<CODE>bar1</CODE> is considered a normal line, and <CODE>bar2</CODE> is considered a
1988strong or thick line.
1989</P>
1990<P>
1991If the rule <A HREF="#barinsidequote">'barinsidequote'</A> is defined, then a bar is allowed
1992inside a block quote. Otherwise the block quote must be closed and
1993reopened around the bar.
1994</P>
1995<P>
1996If the rule <A HREF="#mapbar2pagebreak">'mapbar2pagebreak'</A> is defined, then the value of
1997<CODE>bar2</CODE> is ignored and a <A HREF="#pageBreak">pageBreak</A> is emitted instead.
1998</P>
1999
2000<DL>
2001<DT>Macros:</DT><DD>
2002  <DL>
2003  <DT><B>\a</B></DT><DD>
2004    If this mark is present, it will be replaced with the text of
2005    the actual marks used for the bar in the source document.
2006  </DL>
2007</DL>
2008
2009<H3 ID="EOD">EOD</H3>
2010
2011<P>
2012This is the End Of Document tag, and is the very last thing emitted
2013to the output.
2014</P>
2015<P>
2016Any tags that were opened in the default <I>HEADER_TEMPLATE</I> should be
2017closed in this tag.
2018</P>
2019<P>
2020If the command line option <I>--template</I> is used, then this tag is
2021not emitted. Anything necessary for a complete document should be
2022included in the template.
2023</P>
2024<P>
2025The default template can thus be considered: <I>HEADER_TEMPLATE</I> +
2026<B>%%body</B> + <CODE>EOD</CODE>.
2027</P>
2028
2029<H3 ID="bodyOpen">bodyOpen, bodyClose</H3>
2030
2031<P>
2032These are the first and last tags emitted for the document body text
2033itself. <CODE>bodyOpen</CODE> is emitted immediately after
2034<I>HEADER_TEMPLATE</I> and <CODE>bodyClose</CODE> is immediately before <A HREF="#EOD">EOD</A>.
2035</P>
2036
2037<H2 ID="section-HTML">7.2. HTML</H2>
2038
2039<H3 ID="cssOpen">cssOpen, cssClose</H3>
2040
2041<P>
2042These tags are used to insert a stylesheet directly into the text of
2043the output document itself.
2044</P>
2045<P>
2046If the command line option <I>--css-inside</I> is used, then the
2047contents of external stylesheets will be inserted into the document
2048header. Each stylesheet will be wrapped in these tags before being
2049emitted.
2050</P>
2051<P>
2052Currently this option, and these tags, are only used by the HTML
2053family of targets, are have no effect on any other target.
2054</P>
2055
2056<H2 ID="section-Comments">7.3. Comments</H2>
2057
2058<H3 ID="comment">comment</H3>
2059
2060<P>
2061This tag is used to insert a single line comment into the output. It
2062should be such that it will not appear to readers in the final
2063document, only in the tagged source of the document.
2064</P>
2065<P>
2066It is used, if available, to insert a comment at the end of the
2067docment stating the date and version of Txt2tags used to generate
2068the output document.
2069</P>
2070
2071<DL>
2072<DT>Macros:</DT><DD>
2073  <DL>
2074  <DT><B>\a</B></DT><DD>
2075    This is replaced with the text of the comment generated by
2076    Txt2tags.
2077  </DL>
2078</DL>
2079
2080<H3 ID="blockComment">blockCommentOpen, blockCommentClose</H3>
2081
2082<P>
2083These are intended to be used before and after multiline comments in
2084the output.
2085</P>
2086<P>
2087Currently, all comments in the source are ignored, so these tags are
2088unused.
2089</P>
2090
2091<H2 ID="section-TableOfContents">7.4. Table Of Contents</H2>
2092
2093<P>
2094The automatic table of contents is emitted as a <A HREF="#chapter-Lists">list</A>, with each
2095list item corresponding to a <A HREF="#title1">title*</A> within the document. Lower
2096level titles will be emitted as nested lists.
2097</P>
2098<P>
2099If the target supports them, each list item in the list will be a
2100link to the corresponding title. Each title will have an anchor
2101added automatically if they do not have one already.
2102</P>
2103<P>
2104If the rule <A HREF="#autotocwithbars">'autotocwithbars'</A> is defined, then a <A HREF="#bar1">bar1</A> will be
2105added before and after the table of contents.
2106</P>
2107<P>
2108If the rule <A HREF="#blankendautotoc">'blankendautotoc'</A> is defined, then an extra blank line
2109will be added after the table of contents.
2110</P>
2111<P>
2112If the rule <A HREF="#autotocnewpagebefore">'autotocnewpagebefore'</A> is defined, then a
2113<A HREF="#pageBreak">pageBreak</A> will be emitted before the table of contents.
2114</P>
2115<P>
2116If the rule <A HREF="#autotocnewpageafter">'autotocnewpageafter'</A> is defined, then a
2117<A HREF="#pageBreak">pageBreak</A> will be emitted after the table of contents.
2118</P>
2119
2120<H3 ID="tocOpen">tocOpen, tocClose</H3>
2121
2122<P>
2123These tags will be emitted directly before and after the
2124automatically generated table of contents.
2125</P>
2126
2127<H3 ID="TOC">TOC</H3>
2128
2129<P>
2130This tag is used for targets that support their own table of
2131contents. If this tag is defined, then it will be emitted, on its
2132own, instead of the automatically generated table of contents. No
2133other processing will be done and all of the rules pretaining to the
2134automatic table of contents will be ignored.
2135</P>
2136
2137<H1 ID="Appendix">Appendix: Rules</H1>
2138
2139<H3 ID="linkable">linkable</H3>
2140
2141<P>
2142This target supports external links.
2143</P>
2144<P>
2145It affects the output of <A HREF="#url">url</A>, <A HREF="#urlMark">urlMark</A>, <A HREF="#urlMarkAnchor">urlMarkAnchor</A>,
2146<A HREF="#email">email</A>, <A HREF="#emailMark">emailMark</A>.
2147</P>
2148
2149<H3 ID="tableable">tableable</H3>
2150
2151<P>
2152This target supports tables. If this is not defined, then all tags
2153in the <A HREF="#chapter-Tables">Table</A> section are ignored.
2154</P>
2155
2156<H3 ID="imglinkable">imglinkable</H3>
2157
2158<P>
2159This target supports images as links.
2160</P>
2161<P>
2162It may affect the output of <A HREF="#url">url</A> and <A HREF="#img">img</A>.
2163</P>
2164
2165<H3 ID="imgalignable">imgalignable</H3>
2166
2167<P>
2168This target supports image alignment. If it is not defined, then all
2169<A HREF="#_imgAlign">_imgAlign</A> and <A HREF="#imgAlign">imgAlign</A> tags are ignored.
2170</P>
2171<P>
2172It affects the output of <A HREF="#img">img</A>.
2173</P>
2174
2175<H3 ID="imgasdefterm">imgasdefterm</H3>
2176
2177<P>
2178This target supports images as definition terms.
2179</P>
2180<P>
2181It may affect the output of <A HREF="#deflistItem1Open">deflistItem1Open</A>.
2182</P>
2183
2184<H3 ID="autonumberlist">autonumberlist</H3>
2185
2186<P>
2187This target supports numbered lists natively. If this is defined,
2188then numbers will not be generated by Txt2tags for numbered lists.
2189</P>
2190<P>
2191It affects the output of <A HREF="#numlistItemOpen">numlistItemOpen</A>.
2192</P>
2193
2194<H3 ID="autonumbertitle">autonumbertitle</H3>
2195
2196<P>
2197This target supports numbered titles natively. If this is defined,
2198then numbers will not be generated by Txt2tags for numbered titles.
2199</P>
2200<P>
2201It affects the output of <A HREF="#numtitle1">numtitle*</A>.
2202</P>
2203
2204<H3 ID="stylable">stylable</H3>
2205
2206<P>
2207This target supports external style files. If this is defined, then
2208the <B>%(STYLE)s</B> macros may be expanded. Otherwise style
2209definitions are ignored.
2210</P>
2211<P>
2212It affects the output of the <A HREF="#section-Template">Template</A>
2213</P>
2214
2215<H3 ID="parainsidelist">parainsidelist</H3>
2216
2217<P>
2218This target supports paragraph tags inside lists. If this is
2219defined, then <A HREF="#paragraphOpen">paragraphOpen</A> and <A HREF="#paragraphClose">paragraphClose</A> tags may be
2220inserted into <A HREF="#chapter-Lists">lists</A>.
2221</P>
2222
2223<H3 ID="compactlist">compactlist</H3>
2224
2225<P>
2226This target has separate enclosing tags for compact lists. If this
2227is not defined, then <A HREF="#listCompactOpen">listCompactOpen</A>, <A HREF="#numlistCompactOpen">numlistCompactOpen</A>,
2228and <A HREF="#deflistCompactOpen">deflistCompactOpen</A> are ignored.
2229</P>
2230
2231<H3 ID="spacedlistitem">spacedlistitem</H3>
2232
2233<P>
2234This target supports blank lines between items in lists.
2235</P>
2236<P>
2237This rule is currently unused and ignored.
2238</P>
2239
2240<H3 ID="listnotnested">listnotnested</H3>
2241
2242<P>
2243This target does not support nested lists.
2244</P>
2245<P>
2246If this is defined, then all lists are emitted as a single,
2247top-level list. It affects the output of <A HREF="#chapter-Lists">lists</A>.
2248</P>
2249
2250<H3 ID="listitemnotnested">listitemnotnested</H3>
2251
2252<P>
2253This target does not allow nested lists to be inside a list
2254item.
2255</P>
2256<P>
2257If this is defined, then list items are closed before sublists
2258are emitted. If it is not defined, then list items are closed
2259after the sublists they contain. It affects the output of
2260<A HREF="#chapter-Lists">lists</A>.
2261</P>
2262
2263<H3 ID="quotenotnested">quotenotnested</H3>
2264
2265<P>
2266This target does not support nested quotes.
2267</P>
2268<P>
2269If this is defines, all block quotations are emitted at the same,
2270top level. If affects the output of <A HREF="#section-BlockQuotations">block quotes</A>.
2271</P>
2272
2273<H3 ID="verbblocknotescaped">verbblocknotescaped</H3>
2274
2275<P>
2276This target should not run verbatim blocks through <I>doEscape()</I>.
2277</P>
2278<P>
2279It affects the output of <A HREF="#section-VerbatimBlocks">verbatim blocks</A>.
2280</P>
2281
2282<H3 ID="verbblockfinalescape">verbblockfinalescape</H3>
2283
2284<P>
2285This target <I>should</I> run verbatim blocks through
2286<I>doFinalEscape()</I>.
2287</P>
2288<P>
2289It affects the output of <A HREF="#section-VerbatimBlocks">verbatim blocks</A>.
2290</P>
2291
2292<H3 ID="escapeurl">escapeurl</H3>
2293
2294<P>
2295This target should run <B>URLs</B> through <I>doEscape()</I>.
2296</P>
2297<P>
2298It affects the output of <A HREF="#url">url</A>, <A HREF="#urlMark">urlMark</A>, <A HREF="#urlMarkAnchor">urlMarkAnchor</A>,
2299<A HREF="#email">email</A>, and <A HREF="#emailMark">emailMark</A>.
2300</P>
2301
2302<H3 ID="labelbeforelink">labelbeforelink</H3>
2303
2304<P>
2305For this target, labels should come before the link in a <B>URL</B>.
2306</P>
2307<P>
2308It affects the output of <A HREF="#urlMark">urlMark</A>, <A HREF="#urlMarkAnchor">urlMarkAnchor</A>, and
2309<A HREF="#emailMark">emailMark</A>.
2310</P>
2311
2312<H3 ID="onelinepara">onelinepara</H3>
2313
2314<P>
2315This target should emit paragraphs as a single long line.
2316</P>
2317<P>
2318It affects the output of <A HREF="#section-Paragraphs">paragraphs</A>.
2319</P>
2320
2321<H3 ID="tabletitlerowinbold">tabletitlerowinbold</H3>
2322
2323<P>
2324This target should manually emit table title rows in bold face.
2325</P>
2326<P>
2327It affects the output of <A HREF="#section-Cells">table cells</A>.
2328</P>
2329
2330<H3 ID="tablecellstrip">tablecellstrip</H3>
2331
2332<P>
2333This target should strip extra spaces from each table cell.
2334</P>
2335<P>
2336It affects the output of <A HREF="#section-Cells">table cells</A>.
2337</P>
2338
2339<H3 ID="tablecellspannable">tablecellspannable</H3>
2340
2341<P>
2342This target supports the span attribute in table cells.
2343</P>
2344<P>
2345It may affect the output of <A HREF="#tableCellOpen">tableCellOpen</A>, <A HREF="#tableCellClose">tableCellClose</A>,
2346and <A HREF="#tableCellHead">tableCellHead</A>.
2347</P>
2348
2349<H3 ID="tablecellmulticol">tablecellmulticol</H3>
2350
2351<P>
2352This target has separate open and close tags for multicolumn cells.
2353</P>
2354<P>
2355If it is defined, then <A HREF="#_tableCellMulticolOpen">_tableCellMulticolOpen</A> will be used for
2356multicolumn cells instead of <A HREF="#tableCellOpen">tableCellOpen</A>.
2357</P>
2358
2359<H3 ID="barinsidequote">barinsidequote</H3>
2360
2361<P>
2362This target allows horizontal bars inside block quotes.
2363</P>
2364<P>
2365It affects the output of <A HREF="#section-BlockQuotations">block quotes</A>,
2366and uses <A HREF="#bar1">bar1</A>.
2367</P>
2368
2369<H3 ID="finalescapetitle">finalescapetitle</H3>
2370
2371<P>
2372This target should run the text of titles through
2373<I>doFinalEscape()</I>
2374</P>
2375<P>
2376It affects the output of <A HREF="#chapter-TitlesandSections">titles</A>.
2377</P>
2378
2379<H3 ID="autotocnewpagebefore">autotocnewpagebefore</H3>
2380
2381<P>
2382This target should emit a <A HREF="#pageBreak">pageBreak</A> before the automatic Table
2383of Contents.
2384</P>
2385
2386<H3 ID="autotocnewpageafter">autotocnewpageafter</H3>
2387
2388<P>
2389This target should emit a <A HREF="#pageBreak">pageBreak</A> after the automatic Table
2390of Contents.
2391</P>
2392
2393<H3 ID="autotocwithbars">autotocwithbars</H3>
2394
2395<P>
2396This target should emit a <A HREF="#bar1">bar1</A> before and after the automatic
2397Table of Contents.
2398</P>
2399
2400<H3 ID="mapbar2pagebreak">mapbar2pagebreak</H3>
2401
2402<P>
2403This target should use a <A HREF="#pageBreak">pageBreak</A> instead of <A HREF="#bar1">bar2</A>. If
2404it is defined, the anything defined for <CODE>bar2</CODE> is ignored.
2405</P>
2406
2407<H3 ID="titleblocks">titleblocks</H3>
2408
2409<P>
2410This target uses title and section blocks.
2411</P>
2412<P>
2413If it is defined, then <A HREF="#title1">title*</A> tags are ignored. Instead
2414<A HREF="#title1open">title*Open</A> and <A HREF="#blockTitle1Open">blockTitle*Open</A> tags
2415will be used to set off titles and sections.
2416</P>
2417<P>
2418This affects the output of <A HREF="#chapter-TitlesandSections">titles</A>.
2419</P>
2420
2421<H3 ID="listlineafteropen">listlineafteropen</H3>
2422
2423<P>
2424This target should emit <A HREF="#listItemLine">listItemLine</A> after <A HREF="#listItemOpen">listItemOpen</A>.
2425</P>
2426
2427<H3 ID="escapexmlchars">escapexmlchars</H3>
2428
2429<P>
2430This target should escape the XML special characters: &lt; &gt; &amp;
2431</P>
2432
2433<H3 ID="listlevelzerobased">listlevelzerobased</H3>
2434
2435<P>
2436This target should start list levels at 0 when encoding the level
2437into list tags.
2438</P>
2439<P>
2440It affects the output of <A HREF="#listItemOpen">listItemOpen</A>, <A HREF="#numlistItemOpen">numlistItemOpen</A>, and
2441<A HREF="#deflistItemOpen">deflistItemOpen</A>.
2442</P>
2443
2444<H3 ID="zerodepthparagraph">zerodepthparagraph</H3>
2445
2446<P>
2447For this target, non-nested paragraphs should have block depth of 0
2448instead of 1 when the block depth is encoded into the output.
2449</P>
2450<P>
2451This affects the output of <A HREF="#paragraphOpen">paragraphOpen</A>.
2452</P>
2453
2454<H3 ID="cellspancumulative">cellspancumulative</H3>
2455
2456<P>
2457For this target, cell span values add up for each cell of a row.
2458</P>
2459<P>
2460It affects the output of <A HREF="#_tableCellColSpan">_tableCellColSpan</A>, and from that it may
2461affect the output of <A HREF="#tableCellOpen">tableCellOpen</A>, <A HREF="#tableCellClose">tableCellClose</A>,
2462<A HREF="#tableCellHead">tableCellHead</A>, and <A HREF="#_tableCellMulticolOpen">_tableCellMulticolOpen</A>.
2463</P>
2464
2465<H3 ID="keepblankheaderline">keepblankheaderline</H3>
2466
2467<P>
2468For this target, template lines are not removed if the macros being
2469inserted are blank.
2470</P>
2471<P>
2472This affects the output of <A HREF="#section-Template">the template</A>.
2473</P>
2474
2475<H3 ID="indentverbblock">indentverbblock</H3>
2476
2477<P>
2478This target should add leading spaces to verb block lines.
2479</P>
2480<P>
2481It affects the output of <A HREF="#section-VerbatimBlocks">verbatim blocks</A>.
2482</P>
2483
2484<H3 ID="breaktablecell">breaktablecell</H3>
2485
2486<P>
2487This target should insert line breaks after every table cell.
2488</P>
2489<P>
2490If affects the output of <A HREF="#section-Cells">table cells</A>.
2491</P>
2492
2493<H3 ID="breaktablelineopen">breaktablelineopen</H3>
2494
2495<P>
2496This target should insert a line break after <A HREF="#tableRowOpen">tableRowOpen</A> and
2497<A HREF="#tableTitleRowOpen">tableTitleRowOpen</A>.
2498</P>
2499
2500<H3 ID="notbreaklistopen">notbreaklistopen</H3>
2501
2502<P>
2503This target should <I>not</I> insert a line break after <A HREF="#listOpen">listOpen</A>,
2504<A HREF="#numlistOpen">numlistOpen</A> or <A HREF="#deflistOpen">deflistOpen</A>.
2505</P>
2506
2507<H3 ID="keepquoteindent">keepquoteindent</H3>
2508
2509<P>
2510This target should not remove the leading TABs in block quotes.
2511</P>
2512<P>
2513It affects the output of <A HREF="#section-BlockQuotations">block quotations</A>.
2514</P>
2515
2516<H3 ID="keeplistindent">keeplistindent</H3>
2517
2518<P>
2519This target should not remove the leading spaces on list tags.
2520</P>
2521<P>
2522It affects the output of all tags for <A HREF="#chapter-Lists">lists</A>.
2523</P>
2524
2525<H3 ID="blankendautotoc">blankendautotoc</H3>
2526
2527<P>
2528This target should append a blank line at the end of the automatic
2529Table of Contents.
2530</P>
2531
2532<H3 ID="tagnotindentable">tagnotindentable</H3>
2533
2534<P>
2535For this target, tags must be placed at the line beginning.
2536</P>
2537<P>
2538If affects the tags for <A HREF="#section-BlockQuotations">block quotes</A> and
2539<A HREF="#chapter-Lists">lists</A>.
2540</P>
2541
2542<H3 ID="spacedlistitemopen">spacedlistitemopen</H3>
2543
2544<P>
2545This target should append a space after <A HREF="#listItemOpen">listItemOpen</A>.
2546</P>
2547
2548<H3 ID="spacednumlistitemopen">spacednumlistitemopen</H3>
2549
2550<P>
2551This target should append a space after <A HREF="#numlistItemOpen">numlistItemOpen</A>.
2552</P>
2553
2554<H3 ID="deflisttextstrip">deflisttextstrip</H3>
2555
2556<P>
2557This target should strip the whitespace off of the definition list
2558text.
2559</P>
2560<P>
2561It affects the output of <A HREF="#section-DefinitionLists">definition lists</A>.
2562</P>
2563
2564<H3 ID="blanksaroundpara">blanksaroundpara</H3>
2565
2566<P>
2567This target should put a blank line before and after paragraphs.
2568</P>
2569<P>
2570It affects the output of <A HREF="#section-Paragraphs">paragraphs</A>.
2571</P>
2572
2573<H3 ID="blanksaroundverb">blanksaroundverb</H3>
2574
2575<P>
2576This target should put a blank line before and after verb blocks.
2577</P>
2578<P>
2579It affects the output of <A HREF="#section-VerbatimBlocks">verbatim blocks</A>.
2580</P>
2581
2582<H3 ID="blanksaroundquote">blanksaroundquote</H3>
2583
2584<P>
2585This target should put a blank line before and after quotes.
2586</P>
2587<P>
2588It affects the output of <A HREF="#section-BlockQuotations">block quotations</A>.
2589</P>
2590
2591<H3 ID="blanksaroundlist">blanksaroundlist</H3>
2592
2593<P>
2594This target should put a blank line before and after lists.
2595</P>
2596<P>
2597It affects the output of <A HREF="#section-UnorderedLists">regular lists</A>.
2598</P>
2599
2600<H3 ID="blanksaroundnumlist">blanksaroundnumlist</H3>
2601
2602<P>
2603This target should put a blank line before and after numbered lists.
2604</P>
2605<P>
2606It affects the output of [numbered lists [#section-NumberedLists].
2607</P>
2608
2609<H3 ID="blanksarounddeflist">blanksarounddeflist</H3>
2610
2611<P>
2612This target should put a blank line before and after definition
2613lists.
2614</P>
2615<P>
2616It affects the output of [definition lists [#section-DefinitionLists].
2617</P>
2618
2619<H3 ID="blanksaroundnestedlist">blanksaroundnestedlist</H3>
2620
2621<P>
2622This target should put a blank line before and after all types of
2623nested lists.
2624</P>
2625<P>
2626It affects the output of all <A HREF="#chapter-Lists">lists</A>.
2627</P>
2628
2629<H3 ID="blanksaroundtable">blanksaroundtable</H3>
2630
2631<P>
2632This target should put a blank line before and after tables.
2633</P>
2634<P>
2635It affects the output of <A HREF="#chapter-Tables">tables</A>.
2636</P>
2637
2638<H3 ID="blanksaroundbar">blanksaroundbar</H3>
2639
2640<P>
2641This target should put a blank line before and after horizontal
2642lines.
2643</P>
2644<P>
2645It affects the output of <A HREF="#bar1">bar1 and bar2</A>.
2646</P>
2647
2648<H3 ID="blanksaroundtitle">blanksaroundtitle</H3>
2649
2650<P>
2651This target should put a blank line before and after titles.
2652</P>
2653<P>
2654It affects the output of <A HREF="#title1">title*</A> and <A HREF="#title1open">title*Open</A>.
2655</P>
2656
2657<H3 ID="blanksaroundnumtitle">blanksaroundnumtitle</H3>
2658
2659<P>
2660This target should put a blank line before and after numbered
2661titles.
2662</P>
2663<P>
2664If affects the output of <A HREF="#numtitle1">numtitle*</A>.
2665</P>
2666
2667<H3 ID="listmaxdepth">listmaxdepth</H3>
2668
2669<P>
2670This is a value rule defining the maximum nesting depth for lists.
2671</P>
2672<P>
2673It affects the output of <A HREF="#chapter-Lists">lists</A>.
2674</P>
2675
2676<H3 ID="quotemaxdepth">quotemaxdepth</H3>
2677
2678<P>
2679This is a value rule defining the maximum nesting depth for block
2680quotes.
2681</P>
2682<P>
2683It affects the output of <A HREF="#section-BlockQuotations">block quotations</A>.
2684</P>
2685
2686<H3 ID="tablecellaligntype">tablecellaligntype</H3>
2687
2688<P>
2689This is a value rule defining the type of alignment allowed for
2690tables cells. The legal values are 'cell' or 'column'.
2691</P>
2692<P>
2693Its value affects whether <A HREF="#_tableColAlign">_tableColAlign*</A> or
2694<A HREF="#_tableCellAlign">_tableCellAlign*</A> tags are used.
2695</P>
2696<P>
2697It may affect the output of <A HREF="#tableOpen">tableOpen</A>, <A HREF="#tableRowOpen">tableRowOpen</A>,
2698<A HREF="#tableRowSep">tableRowSep</A>, <A HREF="#tableCellOpen">tableCellOpen</A>, <A HREF="#_tableCellMulticolOpen">_tableCellMulticolOpen</A>,
2699<A HREF="#tableCellHead">tableCellHead</A>, and other related tags.
2700</P>
2701
2702<H3 ID="blockdepthmultiply">blockdepthmultiply</H3>
2703
2704<P>
2705This value rule changes the value of a blocks depth value, for
2706targets that encode depth into the output tags.
2707</P>
2708<P>
2709It may affect the output of <A HREF="#paragraphOpen">paragraphOpen</A>, <A HREF="#blockQuoteOpen">blockQuoteOpen</A>,
2710<A HREF="#listItemOpen">listItemOpen</A>, <A HREF="#numlistItemOpen">numlistItemOpen</A>, and <A HREF="#deflistItemOpen">deflistItemOpen</A>.
2711</P>
2712
2713<H3 ID="depthmultiplyplus">depthmultiplyplus</H3>
2714
2715<P>
2716This value rule is added to add to the block depth before
2717multiplying by 'blockdepthmultiply'.
2718</P>
2719<P>
2720It may affect the output of <A HREF="#paragraphOpen">paragraphOpen</A>, <A HREF="#blockQuoteOpen">blockQuoteOpen</A>,
2721<A HREF="#listItemOpen">listItemOpen</A>, <A HREF="#numlistItemOpen">numlistItemOpen</A>, and <A HREF="#deflistItemOpen">deflistItemOpen</A>.
2722</P>
2723
2724<H3 ID="cellspanmultiplier">cellspanmultiplier</H3>
2725
2726<P>
2727This value rule changes the value of a table cell span.
2728</P>
2729<P>
2730It affects the output of <A HREF="#_tableCellColSpan">_tableCellColSpan</A>, and from that may
2731affect the output of <A HREF="#tableCellOpen">tableCellOpen</A>, <A HREF="#tableCellClose">tableCellClose</A>,
2732<A HREF="#_tableCellMulticolOpen">_tableCellMulticolOpen</A> and <A HREF="#tableCellHead">tableCellHead</A>.
2733</P>
2734
2735<!-- html code generated by txt2tags 2.6.668 (http://txt2tags.org) -->
2736<!-- cmdline: txt2tags -t html doc/English/tags-reference.t2t -->
2737</BODY></HTML>