DocBook Reference
This reference guide describes all XML elements, which can be used to structure an ARCWAY Cockpitdocument.
- Usable Elements
- Example
- XML-Elements
- Coding of special characters in XML
Usable Elements
The following tags of the whole DocBook XML-language are supported.
Examples
The XML-section below presents a simple example of the most important
elements.
<book>
<title>book's title</title>
<subtitle>book's subtitle</subtitle>
<chapter>
<title>capter's title</title>
<section>
<title>section's title</title>
<para>
This is a paragraph ....
</para>
<para>
<table>
<tgroup cols="2">
<colspec colwidth="35mm"/>
<colspec colwidth="70mm"/>
<thead>
<row>
<entry>column 1</entry><entry>column 2</entry>
</row>
</thead>
<tbody>
<row>
<entry>cell 1.1</entry><entry>cell 1.2</entry>
</row>
<row>
<entry>cell 2.1</entry><entry>cell 2.2</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
This paragraph contains a list
<simplelist type="inline">
<member>list element 1</member>
<member>list element 2</member>
<member>list element 3</member>
</simplelist>
</para>
</section>
</chapter>
</book>
XML elements
A "book"-tag is the root element of every report-template.
sub-nodes
super-nodes
none
attributes
none
A "capter"-tag defines a chapter within a report.
sub-nodes
super-nodes
attributes
none
A "section"-tag defines a section within a chapter.
sub-nodes
super-nodes
attributes
none
A "para"-tag defines a paragraph within a chapter or a section.
sub-nodes
super-nodes
attributes
- role: style name
| Value | Word format view | HTML/DocBook format view |
| style name | name of the word style-template | name of the style sheet-template |
A "table"-tag defines a table within a chapter or a section.
sub-nodes
super-nodes
attributes
- frame: table-border style
| Value | Word format view | HTML/DocBook format view |
| none | no border | no border |
| all | border around every cell and around the whole table | border around every cell and around the whole table |
| top | border around every cell and around the whole table | border only on top margin of table and cells |
| bottom | border around every cell and around the whole table | border only on bottom margin of table and cells |
| sides | border around every cell and around the whole table | border only on left and right margin of table and cells |
| topbot | border around every cell and around the whole table | border only on top and bottom margin of table and cells |
- tabstyle: table-content style
| Value | Word format view | HTML/DocBook format view |
| style name | name of the word style-template | name of the style sheet-template |
example
<table>
<tgroup cols="2">
<colspec colwidth="35mm"/>
<colspec colwidth="70mm"/>
<thead>
<row>
<entry>column 1</entry><entry>column 2</entry>
</row>
</thead>
<tbody>
<row>
<entry>cell 1.1</entry><entry>cell 1.2</entry>
</row>
<row>
<entry>cell 2.1</entry><entry>cell 2.2</entry>
</row>
</tbody>
</tgroup>
</table>
A "tgroup"-tag groups the content a table-content.
sub-nodes
super-nodes
attributes
cols: defines number of table-columns
A "colspec"-tag defines a table-column.
sub-nodes
none
super-nodes
attributes
colwidth: width of a table-column. Can be specified absolut (e.g. 10mm) or relative (e.g. 3*).
Beispiel
<colspec colwidth="35mm"/>
A "thead"-tag definies the head of a table (multiple lines are possible).
The Word format view will print table's head automatically bold.
sub-nodes
super-nodes
attributes
none
example
<thead>
<row>
<entry>table-head column 1</entry>
<entry>table-head column 2</entry>
<entry>table-head column 3</entry>
</row>
</thead>
A "tbody"-tag definies the body of a table (normally multiple lines).
sub-nodes
super-nodes
attributes
none
example
<tbody>
<row>
<entry>cell column 1</entry>
<entry>cell column 2</entry>
<entry>cell column 3</entry>
</row>
</tbody>
A "thead"-tag definies the foot of a table (multiple lines are possible).
sub-nodes
super-nodes
attributes
none
Beispiel
<tfoot>
<row>
<entry>cell column 1</entry>
<entry>cell column 2</entry>
<entry>cell column 3</entry>
</row>
</tfoot>
A "row"-tag definies a row of a table.
sub-nodes
super-nodes
attributes
none
Beispiel
<row>
<entry>cell column 1</entry>
<entry>cell column 2</entry>
<entry>cell column 3</entry>
</row>
A "entry"-tag definies the cells of a row.
sub-nodes
super-nodes
attributes
- role: style name
| Value | Word format view | HTML/DocBook format view |
| style name | name of the word style-template | name of the style sheet-template |
example
<entry>This is a cell.</entry>
A "simplelist"-tag definies a simple list.
sub-nodes
super-nodes
attributes
type: until now the value inline is supported. Elements are ordered one-after-another, sperated by commas.
example
<simplelist type="inline">
<member>list-element 1</member>
<member>list-element 2</member>
</simplelist>
A "member"-tag definies an element of a list.
sub-nodes
super-nodes
attributes
none
Beispiel
<member>This is a list-element.</member>
A "title"-tag definies the title of a book, chapter or section.
sub-nodes
super-nodes
attributes
none
Beispiel
<title>This is a title.</title>
A "subtitle"-tag definies the sub-title of a book, chapter or section.
sub-nodes
super-nodes
attributes
none
example
<subtitle>This is a sub-title.</subtitle>
A "link"-tag definies a hyperlink to a file or website.
sub-nodes
super-nodes
attributes
linkend: target URL
example
<link linked="http://www.arcway.com">Homepage of ARCWAY AG</linkend>
A link that addresses its target by means of a URL (Uniform Resource Locator).
sub-nodes
super-nodes
attributes
url: URL specifies the Uniform Resource Locator that is the target of the ULink.
example
<ulink url="http://www.arcway.com">ARCWAY AG Homepage</ulink>
A spot in the document.
sub-nodes
none
super-nodes
attributes
none
example
The anchor element<anchor id="example.anchor.1"/> is empty and contributes
nothing to the flow of the content in which it occurs. It is only useful
as a target.
Coding of special characters in XML
If you write your own report template, please note, that special characters
have to be encoded.
Use the report template header, to set the character encoding that is used by
your text editor. Thus a manual encoding of all special characters that are supported by
your editor is not necessary.
However, special characters that can not be handled by the character encoding of your editor
can still be encoded.
Verwandte Themen:
The Report Template Header
See also the german web page:
Zeichenreferenz auf SELFHTML
