Keywords

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.


Contents

[edit] Example

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>

[edit] Contains

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)

[edit] Contained by

Doctype Parents
ditabase, topic, task, concept, reference metadata
bookmap topicmeta, bookmeta
map topicmeta

[edit] Inheritance:

- topic/keywords


[edit] Attributes

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 A common attribute described in Other common DITA attributes      

TOC: Language Specification 1.1
Parent topic: Prolog elements
Previous topic: featnum
Next topic: metadata

Retrieved from "http://www.ditawiki.org/index.php/Keywords"

This page has been accessed 181 times. This page was last modified 03:37, 13 July 2007.





This page
Discuss this page
Post a comment
Printable version
My pages
Log in / create account