Chapter 2. What is DocBook?

What is this “DocBook” you speak of?

“DocBook” is not an application in the sense that you're probably used to. It is not a program that runs on a computer like FrameMaker or Word.
Strictly speaking, DocBook is a set of rules that defines how to structure a document. These rules can be and are expressed in English prose, as a DTD (Document Type Definition), and in a few schema languages. The English prose version is useful for authors and stylesheet writers. The DTD and schemas are useful for applications such as XML editors, validators, and processors.
This structure is intended to provide the basis for the more specific needs of those who want to document computer software and hardware. You are expected to customize DocBook, at the very least removing some elements, there are two type of sections, recursive and non-recursive. You should pick one for your needs and remove the other.
- The set of rules is an open standard supported by Oasis (“OASIS is a not-for-profit, global consortium that drives the development, convergence and adoption of e-business standards.”).
- The set of rules has been officially released as an SGML and XML DTD (Document Type Definition).
- The DocBook DTD has been around since 1991. The current version is 4.2, so it is a mature content model.

2.1. What does DocBook look like?

A DocBook XML document looks a lot like the xhtml source—both are instances XML DTDs. The key difference is that DocBook is primarily semantic markup for describing software and hardware documentation. xhtml is more general and less focused on semantics.

Sample DocBook XML:

<para><command>ControlProcess</command> writes 
its trace information to <filename>
<envar>$BJROOT</envar>/logs/ControlProcess_
<replaceable>hostname</replaceable>.out</filename> 
(where <replaceable>hostname</replaceable> is the name 
of the activation host on which 
<command>ControlProcess</command> is running).</para>

Sample XHTML:

<p><tt>ControlProcess</tt> writes 
its trace information to <tt>
<i><tt>$BJROOT</tt></i>/logs/ControlProcess_
<i>hostname</i>.out</tt> 
(where <i>hostname</i> is the name 
of the activation host on which 
<tt>ControlProcess</tt> is running).</p>

The DocBook converted to html and rendered:

ControlProcess writes its trace information to $BJROOT/logs/ControlProcess_hostname.out (where hostname is the name of the activation host on which ControlProcess is running).


Chapter 1. Goals of this talk		2.2. Ok, but what is DocBook really?