V5.1topic
topic — A modular unit of documentation not part of any particular narrative flow.
Synopsis
topic ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
- One of:
- Zero or more of:
- One of:
- Sequence of:
- One or more of:
annotationbridgeheadremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- Optionally one of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- Sequence of:
- One or more of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- Sequence of:
- Zero or more of:
- One of:
Attributes
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
Children
The following elements occur in topic: address, anchor, annotation, bibliography, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glossary, glosslist, important, index, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titlereq.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, refentry, remark, revhistory, screen, screenco, screenshot, sect1, section, segmentedlist, sidebar, simpara, simplelist, simplesect, subtitle, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, toc, variablelist, warning.
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>