<!--
XML documentation system
Original author : Arjen Baart - arjen@andromeda.nl
- Version : $Revision: 1.1 $
+ Version : $Revision: 1.3 $
-->
<chapter>
To make several separate paragraphs, you must enclose each paragraph
in a <strong>para</strong> open tag and a <strong>para</strong> close tag.
Here is an example of two small paragraphs:
+</para>
+
<verbatim>
<para>
</verbatim>
-</para>
-
<para>
A second type of paragraph is a <strong>quote</strong>.
You can make a quote by using the <code>quote</code> element:
+</para>
<verbatim>
<quote>
</quote>
</verbatim>
+<para>
Which results in:
+</para>
<quote>
This is an example of a quote.
The text within a quoted paragraph is usually slightly indented on both
the left and the right margin.
</quote>
-</para>
<para>
A special kind of paragraph is the <strong>verbatim</strong> environment.
indentation and line breaks preserved.
The practical use for the <strong>verbatim</strong> element is to
include coding examples, such as:
+</para>
<verbatim>
<verbatim>
</verbatim>
</verbatim>
+<para>
Which comes out like this:
+</para>
<verbatim>
struct complex
double imaginary;
};
</verbatim>
+
+<para>
+A variation on the <strong>verbatim</strong> text is the <strong>example</strong>
+text.
+The only real difference is that <strong>example</strong> is placed inside
+a box to make it stand out a bit more.
+In fact, when converted to XHTML, only an attribute <code>class='example'</code>
+is added.
+It is up to the CSS linked to the XHTML page to add additional layout features.
+The default styling will only add a border.
+Here is the above example shown in an actual <strong>example</strong> element:
</para>
+
+<example>
+ <example>
+ struct complex
+ {
+ double real;
+ double imaginary;
+ };
+ </example>
+</example>
+
+<para>
+Which comes out like this:
+</para>
+
+<example>
+ struct complex
+ {
+ double real;
+ double imaginary;
+ };
+</example>
+
</section>
<section>
-<heading>Footnotes</heading>
+<heading><label name='footnote'/>Footnotes</heading>
<para>
Footnotes are created with the <strong>footnote</strong> element:
<footnote>This is an example of a footnote</footnote>
+</para>
<verbatim>
<footnote>This is an example of a footnote</footnote>
</verbatim>
+<para>
Within a footnote, you can use <emph>inline</emph> content <footnote>described in the
next chapter</footnote> to format the type
styles of the text in the footnote.
</section>
<section>
-<heading>Lists</heading>
+<heading><label name='list'/>Lists</heading>
<para>
-Two types of lists<footnote>A description list is not implemented yet</footnote> are supported:
+Three types of lists are supported:
+</para>
+
<itemize>
<item><code>itemize</code> for bulleted lists such as this one.</item>
<item><code>enumerate</code> for numbered lists.</item>
+<item><code>description</code> for tagged lists.</item>
</itemize>
-Each item in such a list must be in an <strong>item</strong> element.
-In fact, an <strong>item</strong> is the only element allowed in an
-<strong>itemize</strong> or <strong>enumerate</strong> element.
+<para>
+Each item in such a list must be in an <code>item</code> element.
+In fact, an <code>item</code> is the only element allowed in an
+<code>itemize</code>, <code>enumerate</code> or <code>description</code> element.
You should not put ordinary text or any other element in a list without
enclosing them in <code><item></code> and <code></item></code>.
Here is an example of a numbered list:
+</para>
<verbatim>
</verbatim>
+<para>
And this is what the list turns into:
+</para>
<enumerate>
- <item>First you need an enumerate or itemize tag.</item>
+ <item>First you need an enumerate, itemize or description tag.</item>
<item>Second, include one or more item elements.</item>
<item>Finally, put the content inside the items.</item>
</enumerate>
+<para>
+In a description list, you make your own tags for each item instead
+of the automatically generated bullts or numbers.
+The tags for each item go in the <code>tag</code> attribute of the
+<code>item</code> element.
+So, repeating the above list as a description list:
+</para>
+
+<verbatim>
+<description>
+ <item tag='itemize'> for bulleted lists such as this one.</item>
+ <item tag='enumerate'> for numbered lists.</item>
+ <item tag='description'> for tagged lists.</item>
+</description>
+</verbatim>
+
+<para>
+Which creates the following output:
+</para>
+
+<description>
+<item tag='itemize'> for bulleted lists.</item>
+<item tag='enumerate'> for numbered lists.</item>
+<item tag='description'> for tagged lists such as this one.</item>
+</description>
+
+<para>
+An item can contain inline content as well as block-level content.
</para>
</section>
<section>
-<heading>Including graphics</heading>
+<heading><label name='graphics'/>Including graphics</heading>
<para>
The empty element <strong>picture</strong> is used to include
graphics in your document, like this:
+</para>
<verbatim>
<picture src='diagram.png' eps='diagram' scale='0.5'/>
</verbatim>
+<para>
The two attributes are used in either HTML or LaTeX.
</para>
</section>
<section>
-<heading>Tables</heading>
+<heading><label name='table'/>Tables</heading>
<para>
Creating tables in XMLDoc is much like creating tables in HTML.
-First, there is the <strong>table</strong> element.
-The <strong>table</strong> element may contain any number of
-<strong>row</strong> elements, which may in turn contain any number
-of <strong>col</strong> elements.
-The <strong>col</strong> elements hold the actual content of
-the table, which must be inline content (see next chapter).
-To use the tables in LaTeX, you must supply a <strong>cpos</strong>
-attribute in the <strong>table</strong> tag.
-<para>
-<emph>...tune in next week for a table example...</emph>
+First, there is the <code>table</code> element.
+The <code>table</code> element may contain an optional <code>thead</code>
+and any number of <code>row</code> elements.
+Both the <code>thead</code> and the <code>row</code> elements must contain
+one or more <code>col</code> elements.
+The <code>col</code> elements hold the actual content of
+the table, which must be inline content (see next chapter) or block content.
+To use the tables in LaTeX, you must supply a <code>cpos</code>
+attribute in the <code>table</code> tag.
</para>
+
+<para>
+An example of a table is shown below:
</para>
+
+<verbatim>
+
+<table cpos='lr'>
+ <thead><col>Drink </col><col>Price</col></thead>
+ <row><col>Beer </col><col> 1.80</col></row>
+ <row><col>Wiskey </col><col> 3.50</col></row>
+ <row><col>Wine </col><col> 2.20</col></row>
+</table>
+
+</verbatim>
+
+<table cpos='lr'>
+ <thead><col>Drink </col><col>Price</col></thead>
+ <row><col>Beer </col><col> 1.80</col></row>
+ <row><col>Wiskey </col><col> 3.50</col></row>
+ <row><col>Wine </col><col> 2.20</col></row>
+</table>
+
</section>
</chapter>
projects / xmldoc.git / blobdiff