This document describes a tool for people who write documents using the DocBook system. Here at the New Mexico Tech Computer Center, the guide for DocBook authors is Writing documentation with DocBook-XML 4.3.
section element in a DocBook document
must carry an
id attribute. Here is an
<section id='intro'> <title>Introduction</title> ...
xref element is used to
cross-reference other locations within the same document.
In general, this element looks like this:
linkend attribute names the
id attribute of the cross-referenced section.
So, for example, to refer to the “Introduction”
shown above, you would say something like this:
See <xref linkend='intro'/> for more information.
Once you start writing sizeable documents, it can become
hard to remember the
id values for each
section. It helps to have some kind of convention, but
even so, there can be a lot of
in a document.
The docbookindex application is a program that reads your
.xml file and generates a
report, in PDF format, showing all the section
values, in an outline format.
As an example, here is the PDF of the index for the document you are now reading.