<keywords>

Key words are terms that apply to the topic or map.

The content of the <keywords> element can be used to optimize the rendered output:

  • Processors might add metadata to the output format to facilitate search engine optimization.
  • Processors might use the content of <indexterm> elements to generate an index for a document.

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 it is used to specify keywords that apply to the topic.

All <keyword> and <indexterm> elements contained in the <keywords> element are considered part of the topic or map metadata. How the content of these elements is processed depends on the output medium.

The following attributes are available on this element: universal attributes.

Example

The following code sample shows how several key words can be associated with a topic that is related to installing software:

<prolog>
    <metadata>
        <keywords>
            <keyword>installing</keyword>
            <keyword>prerequisites</keyword>
            <keyword>wizards</keyword>
        </keywords>
    </metadata>
</prolog>