prolog
The <prolog> element contains
information about the topic as an whole (for example, author information
or subject category) that is either entered by the author or maintained
by a software application. Much of the metadata inside the <prolog>
will not be displayed with the topic when the topic is rendered, but
may be used by processes that generate search indexes or customize
navigation.
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, ditabase, glossary, glossentry, glossgroup, reference, task, machineryTask | ( (author) (any number) then (source) (optional) then (publisher) (optional) then (copyright) (any number) then (critdates) (optional) then (permissions) (optional) then (metadata) (any number) then (resourceid) (any number) then (data or data-about or foreign or unknown) (any number) ) |
| learningAssessment, learningContent, learningOverview, learningPlan, learningSummary | ( (author) (any number) then (source) (optional) then (publisher) (optional) then (copyright) (any number) then (critdates) (optional) then (permissions) (optional) then (metadata or lcLom) (any number) then (resourceid) (any number) then (data or data-about or foreign or unknown) (any number) ) |
Contained by
| Doctype | Content model |
|---|---|
| topic (base), topic (technical content) | topic |
| concept | topic, concept |
| ditabase | topic, concept, task, reference, glossentry, glossgroup |
| glossary, glossentry | topic, concept, glossentry |
| glossgroup | topic, concept, glossentry, glossgroup |
| reference | topic, reference |
| task (strict), task (general), machineryTask | topic, task |
| learningAssessment | topic, learningBase, learningAssessment |
| learningContent | topic, learningBase, task, concept, reference, learningSummary, learningAssessment, learningContent |
| learningOverview | topic, learningBase, learningOverview |
| learningPlan | topic, learningBase, learningPlan |
| learningSummary | topic, learningBase, learningSummary |
Inheritance
- topic/prolog
<prolog>
<metadata>
<audience type="user" job="using" experiencelevel="novice"/>
</metadata>
</prolog>Attributes
| Name | Description | Data Type | Default Value | Required? |
|---|---|---|---|---|
| univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class | A common attribute described in Other common DITA attributes |