The <keywords> element contains a list of key words (using <indexterm> or <keyword> markup) that can be used by a search engine.
When DITA topics are output to XHTML, any <keyword> or <indexterm> elements in the <keywords> element are placed in the Web page metadata. The index terms in this context are also included in any generated index.
The following example is metadata from an installation task:
<prolog> <keywords> <keyword>installing</keyword> <keyword>uninstalling</keyword> <keyword>prerequisites</keyword> <keyword>helps</keyword> <keyword>wizards</keyword> </keywords> </prolog>
Doctype | Content model |
---|---|
ditabase, topic, task, reference, concept | ( indexterm or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle) (any number) |
map, bookmap | ( indexterm or keyword) (any number) |
Doctype | Parents |
---|---|
ditabase, topic, task, concept, reference | metadata |
bookmap | topicmeta, bookmeta |
map | topicmeta |
- topic/keywords
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) | A set of related attributes, described at %univ-atts; | parameter entity | PE not applicable | Not applicable |
%global-atts; (xtrf, xtrc) | A set of related attributes, described at %global-atts; | parameter entity | PE not applicable | Not applicable |
class | Common attribute described in Other common DITA attributes. |
Return to main page.
OASIS DITA Language Specification v1.1 -- Committee Draft 02, 8 May 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.