keywords

The <keywords> element contains a list of key words (using indexterm or keyword markup) that can be used by a search engine.

When DITA topics are output to XHTML, any <keyword> or <indexterm> elements in the <keywords> element are placed in the Web page metadata. The index terms in this context are also included in any generated index.

Contains

(indexterm or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle) (any number)

Contained by

metadata

Inheritance

topic/keywords

Attributes

Name Description Data Type Default Value Required?
%select-atts; (platform, product, audience, otherprops, importance, rev, status) A set of related attributes, described at %select-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 A common attribute described in Other common DITA attributes

Example

The following example is metadata from an installation task:

<prolog>
 <keywords>
  <keyword>installing</keyword>
  <keyword>uninstalling</keyword>
  <keyword>prerequisites</keyword> 
  <keyword>helps</keyword>
  <keyword>wizards</keyword>
 </keywords>
</prolog>

OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.