doc/glossary.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE chapter SYSTEM "../doc.dtd">
   3 <?xml-stylesheet type="text/css" href="xmldoc.css"?>
   4
   5 <!--
   6       XML documentation system
   7       Original author :  Arjen Baart - arjen@andromeda.nl
   8       Version         : $Revision: 1.1 $
   9 -->
  10
  11 <chapter>
  12 <heading>Glossary</heading>
  13
  14  <para>
  15  Alphabetical list of elements:
  16  </para>
  17  <description>
  18   <item tag='abstract'>
  19    Optional part of the <ref to='preamble'>title page</ref>. States in a few
  20    sentences what the document is about.
  21   </item>
  22
  23   <item tag='article'>
  24    One of the <ref to='overall'>document styles</ref>.
  25    Defines what kind of document this is.
  26   </item>
  27
  28   <item tag='author'>
  29    Part of the <ref to='preamble'>title page</ref>. States by whom the
  30    document was written. There must be at least one author on a title page.
  31   </item>
  32
  33   <item tag='book'>
  34    One of the <ref to='overall'>document styles</ref>.
  35    Defines what kind of document this is.
  36   </item>
  37
  38   <item tag='chapter'>
  39    The first level of <ref to='section'>sectioning</ref> elements.
  40   </item>
  41
  42   <item tag='code'>
  43    A form of <ref to='inline'>inline</ref> content for making <code>code</code>
  44    examples. Usually renders to a monospace font.
  45   </item>
  46
  47   <item tag='col'>
  48    A single cell of content in a <ref to='table'>table</ref>.
  49   </item>
  50
  51   <item tag='date'>
  52    Part of the <ref to='preamble'>title page</ref>. States when the
  53    document was written.
  54   </item>
  55
  56   <item tag='description'>
  57    Creates a <ref to='list'>list</ref> of descriptive items.
  58   </item>
  59
  60   <item tag='doc'>
  61    The single <ref to='overall'>root element</ref> of all XMLDoc documents.
  62   </item>
  63
  64   <item tag='docinfo'>
  65    Optional block of information about the document.
  66    Contains a list of one or more <code>infoitem</code> elements.
  67   </item>
  68
  69   <item tag='emph'>
  70    A form of <ref to='inline'>inline</ref> content for making <emph>emphasized</emph>
  71    text. Usually renders to some form of italic.
  72   </item>
  73
  74   <item tag='enumerate'>
  75    Creates a <ref to='list'>list</ref> of numbered items.
  76   </item>
  77
  78   <item tag='footnote'>
  79    Creates a numbered <ref to='footnote'>footnote</ref> at the bottom of the page.
  80   </item>
  81
  82   <item tag='heading'>
  83    Holds the heading of any one of the <ref to='section'>sectioning</ref> elements.
  84    This heading is printed in larger font at the top of the sectioning
  85    element and is used to create the table of contents (<code>toc</code>).
  86   </item>
  87
  88   <item tag='include'>
  89    Includes part of the document from another <ref to='include'>file</ref>.
  90   </item>
  91
  92   <item tag='infoitem'>
  93    An informational item on the <ref to='preamble'>title page</ref>. Holds
  94    additional information about the document, such as version number or
  95    organization.
  96   </item>
  97
  98   <item tag='item'>
  99    One item in a <ref to='list'>list</ref> of items.
 100   </item>
 101
 102   <item tag='itemize'>
 103    Creates a <ref to='list'>list</ref> of bulleted items.
 104   </item>
 105
 106   <item tag='label'>
 107    Used for <ref to='inref'>internal references</ref>.
 108    Marks a point in the document that can be referred to by a <code>ref</code>
 109    element.
 110    The <code>name</code> attribute sets the name that can be referred.
 111   </item>
 112
 113   <item tag='LaTeX'>
 114    LaTeX <ref to='escape'>escape</ref> element. Copies the content of the
 115    <code>command</code> attribute literally to the LaTeX output.
 116   </item>
 117
 118   <item tag='newline'>
 119    Forces a <ref to='break'>line break</ref> in the output document.
 120   </item>
 121
 122   <item tag='newpage'>
 123    Forces a <ref to='break'>page break</ref> in the output document.
 124    Used only for LaTeX output.
 125   </item>
 126
 127   <item tag='page'>
 128    Used for <ref to='inref'>internal references</ref>.
 129    Creates a page number to a <code>label</code> element.
 130    The name of the <code>label</code> is put in the <code>to</code> attribute.
 131    Used only for LaTeX output.
 132   </item>
 133
 134   <item tag='para'>
 135    The primary <ref to='block'>block-level</ref> element to hold the textual
 136    content of the document.
 137   </item>
 138
 139   <item tag='paragraph'>
 140    The fifth level of <ref to='section'>sectioning</ref> elements.
 141   </item>
 142
 143   <item tag='picture'>
 144    Imports <ref to='graphics'>pictures</ref> into the document.
 145   </item>
 146
 147   <item tag='quote'>
 148    A quotation is a slightly indented <ref to='block'>block</ref> of text.
 149   </item>
 150
 151   <item tag='ref'>
 152    Used for <ref to='inref'>internal references</ref>.
 153    Creates a reference to a <code>label</code> element.
 154    The name of the <code>label</code> is put in the <code>to</code> attribute.
 155   </item>
 156
 157   <item tag='reference'>
 158    Used for <ref to='exref'>external references</ref>.
 159    Creates a reference to an external document pointed to by the
 160    <code>href</code> attribute.
 161   </item>
 162
 163
 164   <item tag='remark'>
 165    A form of <ref to='inline'>inline</ref> content for making a <remark>remark</remark>
 166    that stands out from the rest of the text. The final rendering is not really
 167    defined and mey depend on other stylesheets.
 168    E.g. for HTML output, this creates a <code>span</code> tag with <code>remark</code>
 169    class attribute. The way this looks is determined by a CSS stylesheet.
 170   </item>
 171
 172   <item tag='report'>
 173    One of the <ref to='overall'>document styles</ref>.
 174    Defines what kind of document this is.
 175   </item>
 176
 177   <item tag='row'>
 178    A row of columns in a <ref to='table'>table</ref>.
 179   </item>
 180
 181   <item tag='section'>
 182    The second level of <ref to='section'>sectioning</ref> elements.
 183   </item>
 184
 185   <item tag='strong'>
 186    A form of <ref to='inline'>inline</ref> content for making
 187    <strong>strong</strong> text. Usually renderd in bold.
 188   </item>
 189
 190   <item tag='sub'>
 191    A form of <ref to='inline'>inline</ref> content for making
 192    <sub>subscript</sub> text.
 193   </item>
 194
 195   <item tag='subparagraph'>
 196    The sixth level of <ref to='section'>sectioning</ref> elements.
 197   </item>
 198
 199   <item tag='subsection'>
 200    The third level of <ref to='section'>sectioning</ref> elements.
 201   </item>
 202
 203   <item tag='subsubsection'>
 204    The fourth level of <ref to='section'>sectioning</ref> elements.
 205   </item>
 206
 207   <item tag='subtitle'>
 208    Optionally, a document can have any number of subtitles added to
 209    the <ref to='preamble'>title</ref>.
 210   </item>
 211
 212   <item tag='sup'>
 213    A form of <ref to='inline'>inline</ref> content for making
 214    <sup>superscript</sup> text.
 215   </item>
 216
 217   <item tag='table'>
 218    Creates <ref to='table'>tabular</ref> content.
 219   </item>
 220
 221   <item tag='thead'>
 222    Optional first header row of a <ref to='table'>table</ref>.
 223   </item>
 224
 225   <item tag='title'>
 226    Mandatory first element of the <ref to='preamble'>title page</ref>.
 227   </item>
 228
 229   <item tag='titlepage'>
 230    Optional <ref to='preamble'>title page</ref> to hold the document's
 231    title and author, along with some other information.
 232   </item>
 233
 234   <item tag='toc'>
 235    Automatically generated <ref to='preamble'>table of contents</ref>.
 236   </item>
 237
 238   <item tag='verbatim'>
 239    A <ref to='block'>block-level</ref> element to hold text with a
 240    pre-determined layout. Mainly used for coding examples.
 241   </item>
 242
 243  </description>
 244
 245 </chapter>