KeywordSet

DocBook: The Definitive Guide
Prev	Version 1.0.3.	Next

Synopsis

Content Model

KeywordSet ::=
(Keyword+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Description

A set of keywords, provided by the author, editor, publisher, and so on, can be stored in the document meta-information in a KeywordSet.

Keywords can form an important part of an automated indexing or searching strategy for a collection of documents.

Processing expectations

May be formatted inline or as a displayed block, depending on context. Keywords are rarely displayed to a reader. Usually, they are reserved for searching and retrieval purposes.

Unlike SubjectTerms, which should be drawn from a controlled vocabulary, keywords may be chosen freely.

Although more than one KeywordSet may appear in the meta-information for a document, neither a relationship nor a specific facility for constructing a relationship is defined by DocBook.

Additionally, no relationship is defined between the KeywordSets of a document component and the KeywordSets of its parents or children.

Parents

These elements contain KeywordSet: ArtHeader, BookInfo, DocInfo, ObjectInfo, RefSect1Info, RefSect2Info, RefSect3Info, RefSynopsisDivInfo, Sect1Info, Sect2Info, Sect3Info, Sect4Info, Sect5Info, SectionInfo, SetInfo.

Children

The following elements occur in KeywordSet: Keyword.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.