keyword

<keyword> represents a word or phrase with special significance in a particular domain. In the general case, <keyword> elements typically do not have any special semantics and processing associated with them, but can still be useful for organizing content for reuse or special processing. <keyword> specializations are more meaningful and are therefore preferable. <keyword> in the <keywords> element distinguishes a word or phrase that describes the content of a topic (a topic description keyword). Topic description keywords are typically used for searching, retrieval and classification purposes.

Specialized elements derived from <keyword> may also have extended processing, such as different formatting or automatic indexing. If the keyref attribute is used, or some other method of key-based lookup based on the value of the element itself, then the keyword can be turned into a hyperlink on output (not currently supported).

When DITA topics are output to XHTML, any <keyword> elements in the <keywords> element are placed in the Web page metadata.

Contains

( text data or tm) (any number)

Contained by

title, navtitle, searchtitle, shortdesc, section, example, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, cite, xref, linktext, linkinfo, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, indexterm, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, uicontrol, screen, b, u, i, tt, sup, sub, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput, coords

Inheritance

topic/keyword

Attributes

Name	Description	Data Type	Default Value	Required?
keyref	Currently not implemented in DITA processors. Provides a key that a process can use to associate the <keyword> with another topic that provides more details for that particular keyword.	NMTOKEN	#IMPLIED	No
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang)	A set of related attributes, described at %univ-atts;	parameter entity	PE not applicable	Not applicable
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class, outputclass	Common attributes described in Other common DITA attributes

Example

<p>The <keyword>assert</keyword> pragma statement allows messages to be passed
to the emulator, pre-compiler, etc..