Added a glossary with an alphabethical list of elements

[xmldoc.git] / doc / intro.xml

diff --git a/doc/intro.xml b/doc/intro.xml
index 6e80a81..5dc1c92 100644 (file)
--- a/doc/intro.xml
+++ b/doc/intro.xml
@@ -5,7 +5,7 @@
 <!--
       XML documentation system
       Original author :  Arjen Baart - arjen@andromeda.nl
-      Version         : $Revision: 1.1 $
+      Version         : $Revision: 1.2 $
 -->
 
 <chapter>
@@ -14,7 +14,7 @@
 <para>
 <LaTeX command='\setlength{\parindent}{0cm}'/>
 <LaTeX command='\setlength{\parskip}{0.4cm}'/>
-XML-doc is a collection of stylesheets and utilities, resembling a
+XMLDoc is a collection of stylesheets and utilities, resembling a
 documentation system like sgmltools and Linuxdoc.
 The objective is to prepare documentation in XML format.
 Other formats, like LaTeX, PostScript or HTML are then generated by
@@ -24,7 +24,7 @@ XSL stylesheets for a specific output format.
 </para>
 
 <section>
-<heading>XML-doc concepts</heading>
+<heading>XMLDoc concepts</heading>
 
 <para>
 Writing documents in XML is rather like writing them in HTML.
@@ -42,4 +42,32 @@ There is a certain amount of structure you must adhere to.
 This structure is defined in the <emph>Document Type Definition (DTD)</emph>.
 </para>
 </section>
+
+<section>
+<heading>XMLDoc in practice</heading>
+<para>
+Using XMLDoc is fairly simple.
+To use XMLDoc, all you need is a plain text editor, such as vim or emacs
+and a working installation of the XMLDoc utilities and stylesheets.
+The utilities constitute a special form of XSLT processor and a few
+shell scripts that invoke this XSLT processor with the proper style sheets.
+</para>
+
+<para>
+Since there are three XSLT sheets, there are also three shell scripts:
+<code>xml2html</code>, <code>xml2latex</code> and <code>xml2text</code>.
+These scripts transform the XMLDoc document into HTML, LaTeX and plain
+text output, respcetively.
+All you need to do is create your XML source document and use one of these
+scripts to transform the document an another format.
+For example, to transform this guide into a LaTeX document, you could
+use:
+
+<verbatim>
+   xml2latex guide.xml >guide.tex
+</verbatim>
+
+Note that the transformed document is written to standard output.
+</para>
+</section>
 </chapter>