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.2 $
   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='example'>
  79    A <ref to='block'>block-level</ref> element to hold text with a
  80    pre-determined layout. The block of text is surrounded by a border.
  81   </item>
  82
  83   <item tag='footnote'>
  84    Creates a numbered <ref to='footnote'>footnote</ref> at the bottom of the page.
  85   </item>
  86
  87   <item tag='heading'>
  88    Holds the heading of any one of the <ref to='section'>sectioning</ref> elements.
  89    This heading is printed in larger font at the top of the sectioning
  90    element and is used to create the table of contents (<code>toc</code>).
  91   </item>
  92
  93   <item tag='include'>
  94    Includes part of the document from another <ref to='include'>file</ref>.
  95    <emph>Deprecated</emph>. Use the standard XML Inclusion method instead.
  96   </item>
  97
  98   <item tag='infoitem'>
  99    An informational item on the <ref to='preamble'>title page</ref>. Holds
 100    additional information about the document, such as version number or
 101    organization.
 102   </item>
 103
 104   <item tag='item'>
 105    One item in a <ref to='list'>list</ref> of items.
 106   </item>
 107
 108   <item tag='itemize'>
 109    Creates a <ref to='list'>list</ref> of bulleted items.
 110   </item>
 111
 112   <item tag='label'>
 113    Used for <ref to='inref'>internal references</ref>.
 114    Marks a point in the document that can be referred to by a <code>ref</code>
 115    element.
 116    The <code>name</code> attribute sets the name that can be referred.
 117   </item>
 118
 119   <item tag='LaTeX'>
 120    LaTeX <ref to='escape'>escape</ref> element. Copies the content of the
 121    <code>command</code> attribute literally to the LaTeX output.
 122   </item>
 123
 124   <item tag='newline'>
 125    Forces a <ref to='break'>line break</ref> in the output document.
 126   </item>
 127
 128   <item tag='newpage'>
 129    Forces a <ref to='break'>page break</ref> in the output document.
 130    Used only for LaTeX output.
 131   </item>
 132
 133   <item tag='page'>
 134    Used for <ref to='inref'>internal references</ref>.
 135    Creates a page number to a <code>label</code> element.
 136    The name of the <code>label</code> is put in the <code>to</code> attribute.
 137    Used only for LaTeX output.
 138   </item>
 139
 140   <item tag='para'>
 141    The primary <ref to='block'>block-level</ref> element to hold the textual
 142    content of the document.
 143   </item>
 144
 145   <item tag='paragraph'>
 146    The fifth level of <ref to='section'>sectioning</ref> elements.
 147   </item>
 148
 149   <item tag='picture'>
 150    Imports <ref to='graphics'>pictures</ref> into the document.
 151   </item>
 152
 153   <item tag='quote'>
 154    A quotation is a slightly indented <ref to='block'>block</ref> of text.
 155   </item>
 156
 157   <item tag='ref'>
 158    Used for <ref to='inref'>internal references</ref>.
 159    Creates a reference to a <code>label</code> element.
 160    The name of the <code>label</code> is put in the <code>to</code> attribute.
 161   </item>
 162
 163   <item tag='reference'>
 164    Used for <ref to='exref'>external references</ref>.
 165    Creates a reference to an external document pointed to by the
 166    <code>href</code> attribute.
 167   </item>
 168
 169
 170   <item tag='remark'>
 171    A form of <ref to='inline'>inline</ref> content for making a <remark>remark</remark>
 172    that stands out from the rest of the text. The final rendering is not really
 173    defined and mey depend on other stylesheets.
 174    E.g. for HTML output, this creates a <code>span</code> tag with <code>remark</code>
 175    class attribute. The way this looks is determined by a CSS stylesheet.
 176   </item>
 177
 178   <item tag='report'>
 179    One of the <ref to='overall'>document styles</ref>.
 180    Defines what kind of document this is.
 181   </item>
 182
 183   <item tag='row'>
 184    A row of columns in a <ref to='table'>table</ref>.
 185   </item>
 186
 187   <item tag='section'>
 188    The second level of <ref to='section'>sectioning</ref> elements.
 189   </item>
 190
 191   <item tag='strong'>
 192    A form of <ref to='inline'>inline</ref> content for making
 193    <strong>strong</strong> text. Usually renderd in bold.
 194   </item>
 195
 196   <item tag='sub'>
 197    A form of <ref to='inline'>inline</ref> content for making
 198    <sub>subscript</sub> text.
 199   </item>
 200
 201   <item tag='subparagraph'>
 202    The sixth level of <ref to='section'>sectioning</ref> elements.
 203   </item>
 204
 205   <item tag='subsection'>
 206    The third level of <ref to='section'>sectioning</ref> elements.
 207   </item>
 208
 209   <item tag='subsubsection'>
 210    The fourth level of <ref to='section'>sectioning</ref> elements.
 211   </item>
 212
 213   <item tag='subtitle'>
 214    Optionally, a document can have any number of subtitles added to
 215    the <ref to='preamble'>title</ref>.
 216   </item>
 217
 218   <item tag='sup'>
 219    A form of <ref to='inline'>inline</ref> content for making
 220    <sup>superscript</sup> text.
 221   </item>
 222
 223   <item tag='svg'>
 224    <ref to='svg'>Scalable vector graphics</ref>
 225   </item>
 226
 227   <item tag='table'>
 228    Creates <ref to='table'>tabular</ref> content.
 229   </item>
 230
 231   <item tag='thead'>
 232    Optional first header row of a <ref to='table'>table</ref>.
 233   </item>
 234
 235   <item tag='title'>
 236    Mandatory first element of the <ref to='preamble'>title page</ref>.
 237   </item>
 238
 239   <item tag='titlepage'>
 240    Optional <ref to='preamble'>title page</ref> to hold the document's
 241    title and author, along with some other information.
 242   </item>
 243
 244   <item tag='toc'>
 245    Automatically generated <ref to='preamble'>table of contents</ref>.
 246   </item>
 247
 248   <item tag='verbatim'>
 249    A <ref to='block'>block-level</ref> element to hold text with a
 250    pre-determined layout. Mainly used for coding examples.
 251   </item>
 252
 253  </description>
 254
 255 </chapter>