doc/guide.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE doc SYSTEM "../doc.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../html.xsl"?>
   4 <doc style="main.css">
   5
   6 <!--
   7       XML documentation system
   8       Original author :  Arjen Baart - arjen@andromeda.nl
   9       Version         : $Revision: 1.1 $
  10
  11       This document is prepared for XMLDoc. Transform to HTML,
  12       LaTeX, Postscript or plain text with XMLDoc utilities and
  13       XSLT sheets from http://www.andromeda.nl/projects/xmldoc/
  14 -->
  15
  16 <report>
  17 <titlepage>
  18    <title>XML documentation system</title>
  19    <subtitle>Document preparation and conversion in XML</subtitle>
  20
  21    <author>Arjen Baart <code>&lt;arjen@andromeda.nl&gt;</code></author>
  22    <date>Aug 28, 2002</date>
  23    <docinfo>
  24       <infoitem label="Version">0.4</infoitem>
  25       <infoitem label="Organization">Andromeda Technology &amp; Automation</infoitem>
  26    </docinfo>
  27    <abstract>
  28    This guide explains the concepts of <strong>XMLDoc</strong> and discusses
  29    the features available to prepare documentation.
  30    <strong>XMLDoc</strong> uses XSLT transformations to turn the XML source
  31    document into a number of other formats.
  32    </abstract>
  33 </titlepage>
  34
  35 <toc/>
  36
  37 <include href="intro.xml"/>
  38
  39 <include href="overall.xml"/>
  40
  41 <include href="block.xml"/>
  42
  43 <include href="inline.xml"/>
  44
  45 <chapter>
  46 <heading>References</heading>
  47 <para>
  48 Creating hypertext references is as simple as it is in HTML.
  49 The element used for references is <strong>reference</strong>, which
  50 adheres to the <emph>XLink</emph> syntax.
  51 We need to add one more attribute to the usual <strong>href</strong>
  52 attribute.
  53 For example:
  54 <verbatim>
  55 &lt;reference xml:link="simple"
  56     href="http://www.andromeda.nl/project/xmldoc/xmldoc.html"&gt;
  57 The XMLDoc website
  58 &lt;/reference&gt;
  59 provide the installation instructions.
  60 </verbatim>
  61 <reference xml:link="simple"
  62     href="http://www.andromeda.nl/projects/xmldoc/xmldoc.html">
  63 The XMLDoc website
  64 </reference>
  65 provides the installation instructions.
  66 </para>
  67
  68 <para>
  69 Internal references with label, ref and page (page=LaTeX only).
  70 </para>
  71 </chapter>
  72
  73 <include href="multifiles.xml"/>
  74
  75 <chapter>
  76
  77 <heading>Things to do</heading>
  78 <itemize>
  79 <item>Internal cross-referencing</item>
  80 <item>Newline and newpage</item>
  81 <item>Center environment</item>
  82 <item>A utility to create XMLDoc tables from raw ASCII data</item>
  83 <item>Index generation</item>
  84 <item>Bibliographics</item>
  85 <item>Man pages</item>
  86 </itemize>
  87 </chapter>
  88 </report>
  89 </doc>