6e80a81372dc4a5eb7bf5d607476b319dc90d2da
[xmldoc.git] / doc / intro.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE chapter SYSTEM "../doc.dtd">
3 <?xml-stylesheet type="text/xsl" href="../html.xsl"?>
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>Introduction</heading>
13
14 <para>
15 <LaTeX command='\setlength{\parindent}{0cm}'/>
16 <LaTeX command='\setlength{\parskip}{0.4cm}'/>
17 XML-doc is a collection of stylesheets and utilities, resembling a
18 documentation system like sgmltools and Linuxdoc.
19 The objective is to prepare documentation in XML format.
20 Other formats, like LaTeX, PostScript or HTML are then generated by
21 transforming the XML source document into other formats.
22 The transformation is performed by an XSLT processor and using
23 XSL stylesheets for a specific output format.
24 </para>
25
26 <section>
27 <heading>XML-doc concepts</heading>
28
29 <para>
30 Writing documents in XML is rather like writing them in HTML.
31 The content is just plain text and the markup, or layout, is defined
32 with tags, which are marked in angle brackets (&lt; and &gt;).
33 A tag marks the beginning or end of an element, where an element is something
34 like a chapter, a section or a phrase of emphasized text.
35 The tags are processed by the XML parser and translated to the output
36 format commands, as defined by the XSL stylesheet.
37 </para>
38
39 <para>
40 You can not use every tag just anywhere in your document.
41 There is a certain amount of structure you must adhere to.
42 This structure is defined in the <emph>Document Type Definition (DTD)</emph>.
43 </para>
44 </section>
45 </chapter>