xmldoc.html

   1 <html>
   2 <head>
   3 <title>XMLDoc - XML Document preparation</title>
   4 </head>
   5 <body bgcolor='white'>
   6
   7 <h1>XMLDoc Introduction</h1>
   8
   9 <p>
  10 XML-doc is a collection of stylesheets and utilities, resembling a
  11 documentation system like sgmltools and Linuxdoc.
  12 The objective is to prepare documentation in XML format.
  13 Other formats, like LaTeX, PostScript or HTML are then generated by
  14 transforming the XML source document into other formats.
  15 The transformation is performed by an XSLT processor and using
  16 XSL stylesheets for a specific output format.
  17 </p>
  18
  19 <h1>Installing XMLDoc</h1>
  20
  21 <p>
  22 XMLDoc uses the XML and XSLT software libraries from
  23 <a href="http://www.gnome.org/">GNOME</a>.
  24 You first need to download, configure, make and install these packages
  25 from the <a href="ftp://xmlsoft.org/">XML C Library</a> site.
  26 Make sure you get the latest <strong>libxml2</strong> and
  27 <strong>libxslt</strong> libraries.
  28 </p>
  29 <p>
  30 The Gnome xml and xslt libraries are also included in the latest Linux
  31 distributions, such as <a href='http://www.redhat.com/'>RedHat</a> 7.x.
  32 You can install the <strong>libxml2</strong> and <strong>libxslt</strong>
  33 RPM packages if they are not already installled on your system.
  34 To compile the XSLT Processor <em>xp</em>, you also need to install the
  35 <strong>libxml2-devel</strong> and <strong>libxslt-devel</strong> packages.
  36 </p>
  37
  38 <p>
  39 Download and unpack the XMLDoc utilities, stylesheets and DTDs
  40 from <a href="xmldoc-0.4.tar.bz2">here</a>.
  41 The tarball unpacks into a directory 'xmldoc-0.4'.
  42 In there you will find:
  43 </p>
  44 <ul>
  45 <li>A special version of an XSLT Processor, called <strong>xp</strong>.
  46     This XSLT processor performs the translation of ASCII characters that have
  47     a special meaning in LaTeX and a number of UTF-8 sequences into
  48     escape sequences for LaTeX.
  49 </li>
  50 <li>The shell scripts <strong>xml2html</strong>, <strong>xml2latex</strong>
  51     and <strong>xml2text</strong>.
  52     These are pretty simple scripts that just call <strong>xp</strong>
  53     with the proper stylesheets.
  54 </li>
  55 <li>The XSL stylesheets <strong>html.xsl</strong>, <strong>latex.xsl</strong>
  56     and <strong>text.xsl</strong>
  57     that are used by the XSLT processor to transform the XML document
  58     into HTML or LaTeX.
  59 </li>
  60 <li>The Document Type Definitions <strong>doc.dtd</strong> and
  61     <strong>xsl.dtd</strong> to define the structure of the XML files.
  62 </li>
  63 <li>A <a href="guide.html">guide</a> in the <strong>doc</strong> subdirectory
  64     which explains the features in XMLDoc.
  65     You may want to use this guide and its makefile as an example.
  66 </li>
  67 </ul>
  68
  69 <p>
  70 XMLDoc uses <strong>automake</strong> and <strong>autoconf</strong> to
  71 compile and install the software.
  72 To install XMLDoc, you can do the usual <code>./configure</code>,
  73 <code>make</code> and (as root) <code>make install</code>.
  74 </p>
  75
  76 <p>
  77 The stylesheets and DTDs are installed in <code>/usr/local/xslt</code>.
  78 The utilities go into <code>/usr/local/bin</code>.
  79 A 'make install' will copy all necessary files to their proper place.
  80 If you want the stylesheets in a different place, you'll have to
  81 run the <code>configure</code> script with a <code>--prefix=/other/dir</code>
  82 argument.
  83
  84 </p>
  85
  86 <h1>Using XMLDoc</h1>
  87
  88 <p>
  89 You are now ready to start writing in XML.
  90 Prepare your documents with your favorite editor as usual, doing
  91 all the proper XML stuff and use the <a href="guide.html">guide</a>
  92 to see how you can make the structure and layout.
  93 Convert you document to HTML with <strong>xml2html filename.xml</strong>,
  94 to LaTeX with <strong>xml2latex filename.xml</strong> or to
  95 plain ASCII text with <strong>xml2text filename.xml</strong>.
  96 Both scripts accept a single argument and send their output to stdout.
  97 There is one option to these scripts: <em>-s stylesheet</em> allows
  98 you to use a stylesheet different from the default.
  99 That's all there is to it; enjoy.
 100 </p>
 101
 102 <p>
 103 If you encounter any problems or if you want to make suggestions,
 104 please don't hesitate to drop me an <a href="mailto:arjen@andromeda.nl">Email</a>
 105 </p>
 106 </body>
 107 </html>