<keyword>

A keyword is text or a token that has a unique value, such as a product name or unit of reusable text.

Processing expectations

When used within the <keywords> element, the content of a <keyword> element is considered to be metadata and should be processed as appropriate for the given output medium.

Elements that are specialized from the <keyword> element might have extended processing, such as specific formatting or automatic indexing.

Content model

(Text | <draft-comment> | <required-cleanup> | <text> | <tm> )*

Contained by

<abstract> , <alt> , <author> , <b> , <bodydiv> , <brand> , <category> , <cite> , <component> , <consequence> , <coords> , <copyrholder> , <data> , <dd> , <ddhd> , <desc> , <div> , <draft-comment> , <dt> , <dthd> , <em> , <entry> , <example> , <fallback> , <featnum> , <figgroup> , <fn> , <howtoavoid> , <i> , <index-see> , <index-see-also> , <indexterm> , <keywords> , <li> , <line-through> , <lines> , <linkinfo> , <linktext> , <linktitle> , <lq> , <navtitle> , <note> , <overline> , <p> , <ph> , <platform> , <pre> , <prodname> , <prognum> , <publisher> , <q> , <searchtitle> , <section> , <series> , <shortdesc> , <sli> , <sort-as> , <source> , <stentry> , <strong> , <sub> , <subtitle> , <sup> , <title> , <titlealt> , <titlehint> , <tt> , <typeofhazard> , <u> , <xref>

Zero or more of the following

Contained by

Inheritance

- topic/keyword

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

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@keyref
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See The keyref attribute for information on using this attribute.

Examples

This section is non-normative.

This section contains examples of how the <keyword> element can be used.

Example 1. <keyword> element used to store a product name

In the following code sample, the <keyword> element holds a product name that can be referenced using content reference (conref) or content key reference (conkeyref):

<keyword id="acme-bird-feeder">ACME Bird Feeder</keyword>

To enable referencing variable text using @keyref, store the product name in a <keytext> element.

Example 2. <keyword> element referencing a product name

In the following example, the <keyword> element references a product name using @conkeyref:

<p>To fill the <keyword conkeyref="productnames/acme-bird-feeder"/>, unscrew the top ...</p>
Example 3. <keyword> element as metadata

In the following code sample, "Big data" is specified as metadata that applies to the topic:

<prolog>
  <metadata>
    <keywords>
      <keyword>Big data</keyword>
    </keywords>
  </metadata>
</prolog>