[5.1]topic

topic — A modular unit of documentation not part of any particular narrative flow.

Synopsis

topic ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • label
  • status
  • type

Additional Constraints

  • If this element is the root element, it must have a version attribute.

Description

The topic element is a general-purpose container designed to be semantically neutral with respect to any narrative flow. Like most “component level” elements in DocBook, it can hold block elements optionally followed by one or more sections.

Topics are most often associated with topic-oriented authoring methodologies. Topic-oriented authoring is discussed in more detail in Chapter 6, DocBook Assemblies.

Processing expectations

Formatted as a displayed block. Sometimes topics are numbered.

Attributes

Common attributes and common linking attributes.

label

Specifies an identifying string for presentation purposes

status

Identifies the editorial or publication status of the element on which it occurs

type

Identifies the topic type

Parents

These elements contain topic: appendix, book, chapter, part.

Examples

<topic xmlns='http://docbook.org/ns/docbook' version="5.1">
<info>
  <title>Troubleshooting</title>
</info>

<para>If your <citetitle>Joo Janta 200 Super-Chromatic Peril Sensitive
Sunglasses</citetitle> become opaque, do not be alarmed. That's more
or less the point.</para>

</topic>