<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>
)*
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.
<keyword>
element used to store a
product nameIn 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.
<keyword>
element referencing a
product nameIn 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>
<keyword>
element as metadataIn 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>