topic
The <topic> element is the top-level
DITA element for a single-subject topic or article. Other top-level
DITA elements that are more content-specific are <concept>, <task>, <reference>,
and <glossentry>, all of which are specializations
of the <topic> element.
Contains
Note
These models represent only the default document types distributed by OASIS.
Actual content models will differ with each new document type.
| Doctype | Content model |
|---|---|
| topic, concept, glossary, glossentry, glossgroup, reference, task, machineryTask, learningAssessment, learningOverview, learningPlan, learningSummary | ( (title) then (titlealts) (optional) then (shortdesc or abstract) (optional) then (prolog) (optional) then (body) (optional) then (related-links) (optional) then (topic) (any number) ) |
| ditabase | ( (title) then (titlealts) (optional) then (shortdesc or abstract) (optional) then (prolog) (optional) then (body) (optional) then (related-links) (optional) then (topic or concept or task or reference or glossentry or glossgroup) (any number) ) |
| learningContent | ( (title) then (titlealts) (optional) then (shortdesc or abstract) (optional) then (prolog) (optional) then (body) (optional) then (related-links) (optional) then ( (no-topic-nesting) (optional) ) (any number) ) |
Contained by
| Doctype | Content model |
|---|---|
| topic (base), topic (technical content), concept, reference, task (strict), task (general), machineryTask | topic |
| ditabase | dita, topic, concept, task, reference |
| glossary, glossentry, glossgroup | topic, concept |
| learningAssessment, learningOverview, learningPlan, learningSummary | topic, learningBase |
| learningContent | learningBase, learningContent |
Inheritance
- topic/topic
Example
<topic id="topic"> <title>Some little topic</title> <body> <p>Here's a little topic.</p> <ul> <li>Some item</li> <li>Another item</li> </ul> </body> </topic>
Attributes
| Name | Description | Data Type | Default Value | Required? |
|---|---|---|---|---|
| id | This ID enables topics to be referenced uniquely by topicrefs in DITA maps. | ID | Yes | |
| conref-atts attribute group (conref, conrefend, conaction, conkeyref) | A set of related attributes; includes all of the attributes described in id-atts attribute group except for the id attribute. | |||
| xmlns:ditaarch | Declares the default DITA namespace. | "http://dita.oasis-open.org/architecture/2005/" | ||
| DITAArchVersion | Designates the version of the architecture that is in use. The default value will increase with each release of DITA. | CDATA | "1.2" | No |
| domains | Indicates the specialized domains that are included in the DTD or Schema. This value will differ depending on what domains are included in the current DTD or Schema. | CDATA | Varies based on the DTD or Schema; a sample value is "(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic indexing-d)" | No |
| select-atts attribute group (props, base, platform, product, audience, otherprops, importance, rev, status) | A set of related attributes, described in select-atts attribute group | |||
| localization-atts attribute group (translate, xml:lang, dir) | A set of related attributes, described in localization-atts attribute group. | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class, outputclass | Common attributes described in Other common DITA attributes |