A help topic is a unit of information identified with a unique
ID. Help topics are grouped into a logical framework that best describes
the product for which you are writing online help.
The hierarchy of elements provided by DocBook gives you the
framework for organizing the help topics you write. The hierarchy
of elements is as follows: Chapter, Sect1, Sect2, Sect3, Sect4,
and Sect5.
A topic's position within the hierarchy is determined by the
element which contains it, and how that element is embedded in higher
level elements. For example, if a topic that is tagged as Sect2
follows a topic tagged as Sect1, that makes it a subtopic of the
Sect1 topic.
An ID is required if the topic is to be accessed either from
the application (if you are writing application help) or from a
hyperlink. Typically both the element that contains the topic and
its title will be marked with IDs. ID is one of the attributes of
the elements Chapter, Sect1, Sect2, Sect3, Sect4, Sect5, and Title.
Example |
 |
The following line marks the start of a topic using the <Sect1>
tag:
<sect1 id="HRDC.WrTop.div.2"> |
A Title is required for the elements Chapter, Sect1, Sect2,
Sect3, Sect4, Sect5, and immediately follows the start tag of the
element. The markup would look like this:
<sect1 id="HRDC.WrTop.div.2">
<title>Help Topics</title> |
Printable version
