Language reference : Base architecture : Topic elements : Body elements : keyword
The <keyword> element identifies a keyword or token, such as a single value from an enumerated list, the name of a command or parameter, product name, or a lookup key for a message.
means any text that has a unique or key-like value, such as a product name. Where there is an element that has a better meaning for what you are describing, use that element. The keyword element is a generic element; use it when no other element applies. The keyword element can also be used to contain reusable text.
With DITA 1.2, another option for reusable text is the <text> element, which is designed to be free of any extra semantics. The <text> element is available within keyword, and it should be possible to use either keyword or text to reuse content in any situation.
Specific markup recommendations:
Use <apiname> for API names and <cmdname> for command names.
Use <term> to indicate what you are defining with inline paragraph definitions.
Use <ph> for general phrases when keyword is not appropriate.
Use <kwd> to indicate programming keywords in syntax diagrams and syntax phrases.
Specialized elements derived from <keyword> may also have extended processing, such as different formatting or automatic indexing.
All <keyword> or <indexterm> elements in the <keywords> metadata element are considered part of the topic's metadata and should be processed accordingly as appropriate for the given 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, map, concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary
( text data or text or tm) (any number)
Contained by
Content model
topic (base)
map (base), classifyMap, learningMap
topic (technical content), concept
map (technical content)
glossary, glossentry, glossgroup
task (strict), task (general)
learningAssessment, learningOverview, learningSummary
- topic/keyword
<p>The <keyword>assert</keyword> pragma statement allows messages to be passed
to the emulator, pre-compiler, etc..</p>
<p>The <keyword id="myProduct">AmazingProduct</keyword> can make use of
this feature to do really neat stuff.</p>
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
class, outputclass, keyref
Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. Class and outputclass are described in Other common DITA attributes