`<keywords>`

The <keywords> element contains a list of terms from a controlled or uncontrolled subject vocabulary that applies to the topic or map. The keywords can 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 (non-normative):

While the <keyword> element can 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.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- topic/keywords

Example

This section is non-normative.

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>

Content model

(<indexterm> | <keyword>)*

Contained by

<metadata>

Zero or more of the following

<indexterm>
<keyword>

Contained by

<metadata>

Inheritance

- topic/keywords

The <keywords> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: Universal attribute group.