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.
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 (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) |
machineryTask | (indexterm or keyword or wintitle) (any number) |
Contained by
Doctype | Content model |
---|---|
topic (base), topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), machineryTask, learningAssessment, learningContent, learningOverview, learningPlan, learningSummary | metadata |
map (base), map (technical content), classifyMap, subjectScheme, learningMap | metadata, topicmeta |
bookmap, learningBookmap | metadata, topicmeta, bookmeta |
Inheritance
- topic/keywords
Example
The following example is metadata from an installation task:
<prolog> <metadata> <keywords> <keyword>installing</keyword> <keyword>uninstalling</keyword> <keyword>prerequisites</keyword> <keyword>helps</keyword> <keyword>wizards</keyword> </keywords> </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 |