3.1.3.1.13 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 may 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.

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

Contains

Doctype

Content model

topic (base), map (base), classifyMap, subjectScheme, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary

(indexterm or keyword) (any number)

topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap

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

machineryTask

(indexterm or keyword or wintitle) (any number)

Contained by

Doctype

Content model

topic (base), topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), machineryTask, learningAssessment, learningContent, learningOverview, learningPlan, learningSummary

metadata

map (base), map (technical content), classifyMap, subjectScheme, learningMap

metadata, topicmeta

bookmap, learningBookmap

metadata, topicmeta, bookmeta

Inheritance

- topic/keywords

Example

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>
Attributes

Name

Description

Data Type

Default Value

Required?

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class

A common attribute described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.1.3.1.12 featnum

Next Topic:  3.1.3.1.14 metadata

Parent Topic:  3.1.3.1 Prolog (metadata) elements

Sibling Topics:

3.1.3.1.1 prolog

3.1.3.1.2 audience

3.1.3.1.3 author

3.1.3.1.4 brand

3.1.3.1.5 category

3.1.3.1.6 component

3.1.3.1.7 copyright

3.1.3.1.8 copyrholder

3.1.3.1.9 copyryear

3.1.3.1.10 created

3.1.3.1.11 critdates

3.1.3.1.12 featnum

3.1.3.1.14 metadata

3.1.3.1.15 othermeta

3.1.3.1.16 permissions

3.1.3.1.17 platform

3.1.3.1.18 prodinfo

3.1.3.1.19 prodname

3.1.3.1.20 prognum

3.1.3.1.21 publisher

3.1.3.1.22 resourceid

3.1.3.1.23 revised

3.1.3.1.24 series

3.1.3.1.25 source

3.1.3.1.26 vrmlist

3.1.3.1.27 vrm