Language reference : Base architecture : Metadata elements : Prolog (metadata) elements : keywords
The <keywords> element contains a list of terms from a controlled or uncontrolled subject vocabulary that applies to the topic or map. The keywords may be used by a search engine. The keywords are marked up using the <indexterm> and/or <keyword> elements.
All <keyword> and/or <indexterm> elements in the <keywords> element are considered part of the topic's metadata and should be reflected in the output as appropriate for the output medium.
Note: While the <keyword> element may be used inline, the <keywords> element is not an inline element. The <keywords> element only appears in the <topicmeta> or <prolog>, and is used to specify keywords that apply to the topic.
Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.
Content model
topic (base), map (base), classifyMap, subjectScheme, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary
(indexterm or keyword) (any number)
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap
(indexterm or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle) (any number)
(indexterm or keyword or wintitle) (any number)
Contained by
Content model
topic (base), topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), machineryTask, learningAssessment, learningContent, learningOverview, learningPlan, learningSummary
map (base), map (technical content), classifyMap, subjectScheme, learningMap
bookmap, learningBookmap
- topic/keywords
Example 118. Example
The following example is metadata from an installation task:
Data Type
Default Value
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
A common attribute described in Other common DITA attributes