DocBook V4.0 Example Document
Norman Walsh
DocBook V4.0 Example Document
by Norman Walsh
This document demonstrates the new tags in DocBook V4.0.
The focus of this document is to present examples of new elements,
minor changes such as the addition of new attribute values are not
included.
Table of Contents
1 Block-level Markup
2 Inline markup
Chapter 1. Block-level Markup
Chapter 1. Block-level Markup
There's a new simple-alternative for msgentry:
simplemsgentry.
<simplemsgentry>The text of a messageAn explanation of the message.</simplemsgentry>
<simplemsgentry>The text of a messageAn explanation of the message.</simplemsgentry>
Longer descriptions are possible in a revhistory:
<revhistory><revision><revnumber>2</revnumber><date>today</date><authorinitials>nwalsh</authorinitials><revdescription>
Here are a few paragraphs of description:
Did some stuff.
Did some other stuff.
</revdescription></revision><revision><revnumber>1</revnumber><date>yesterday</date><authorinitials>nwalsh</authorinitials><revdescription>
Here are a few paragraphs of description:
Did some stuff.
Did some other stuff.
</revdescription></revision></revhistory>
Ordered and itemized lists can have titles:
Itemized List
•
First thing
•
Second thing
•
Third thing
Ordered List
•
First thing
•
Second thing
•
Third thing
Linespecific environments can indicate line numbering:
<!ENTITY % linespecific.attrib
"format NOTATION
(linespecific) 'linespecific'
linenumbering (numbered|unnumbered) #IMPLIED">
Added classsynopsis for documenting
object-oriented programming language classes. Here's one example:
<classsynopsis><ooclass><modifier>public</modifier>TextFileWriter</ooclass><ooclass>HandlerBase</ooclass><fieldsynopsis><modifier>private</modifier>Writerwriter</fieldsynopsis><fieldsynopsis><modifier>public</modifier>StringwriterName<initializer>"MyWriter"</initializer></fieldsynopsis><methodsynopsis><modifier>static</modifier><modifier>public</modifier>();write<methodparam>ResultTreeFragmentfrag</methodparam><methodparam>Stringfile</methodparam>SAXException</methodsynopsis></classsynopsis>
Chapter 2. Inline markup
Chapter 2. Inline markup
The sgmltag element has new
class attribute values:
xmlpi and
emptytag. These produce
<?processing instructions?>
and <empty-tag/> markup
suitable for XML.