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.

"Keyword" means any text that has a unique or key-like value. For example, a product name. Where there is a 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.

Specific markup recommendations:

Use apiname for API names and cmdname for command names.
Term should be used for inline paragraph definitions; to indicate what you're defining.
PH should be used for general phrases; when you think that keyword is not appropriate.
Inside syntax diagrams and syntax phrases, use kwd to indicate a programming keyword.
In metadata, a keyword is used to create additional XHTML metadata.

Specialized elements derived from <keyword> may also have extended processing, such as different formatting or automatic indexing.

When DITA topics are output to XHTML, any <keyword> or <indexterm> elements in the <keywords> metadata element are placed in the Web page metadata. In addition, any index terms in this context are also used for supported index processing (for example, for print versions).

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

Contains

Doctype	Content model
ditabase, topic, task, reference, concept, glossary, map, bookmap	( text data or tm) (any number)

Contained by

Doctype	Parents
bookmap	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, linktext, searchtitle, person, organization, summary, printlocation, bookpartno, booknumber, booklibrary, mainbooktitle, booktitlealt, index-see, index-see-also, index-sort-as, organizationname, otherinfo, addressdetails, locality, localityname, administrativearea, thoroughfare, emailaddress, url
map	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, linktext, searchtitle, index-see, index-see-also, index-sort-as
ditabase	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, navtitle, searchtitle, abstract, section, example, linktext, linkinfo, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, glossterm, glossdef, 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, index-see, index-see-also, index-sort-as
topic	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, navtitle, searchtitle, abstract, section, example, linktext, linkinfo, 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, index-see, index-see-also, index-sort-as
task	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, navtitle, searchtitle, abstract, section, example, linktext, linkinfo, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, 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, index-see, index-see-also, index-sort-as
concept	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, navtitle, searchtitle, abstract, section, example, linktext, linkinfo, 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, index-see, index-see-also, index-sort-as
reference	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, navtitle, searchtitle, abstract, section, example, linktext, linkinfo, 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, index-see, index-see-also, index-sort-as
glossary	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, navtitle, searchtitle, abstract, section, example, linktext, linkinfo, glossterm, glossdef, 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, index-see, index-see-also, index-sort-as

Inheritance:

- topic/keyword

Attributes

Name	Description	Data Type	Default Value	Required?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;)	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, keyref	Common attributes described in Other common DITA attributes.