Name

keywordset — A set of keywords describing the content of a document

Synopsis

keywordset ::= keyword+

Attribute synopsis

Common attributes and common linking attributes.

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.

See Also

keyword, subject, subjectset, subjectterm

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example keywordset</title>
<info>
  <keywordset>
    <keyword>DocBook</keyword>
    <keyword>standard</keyword>
    <keyword>OASIS</keyword>
  </keywordset>
</info>
<para>...</para>

</article>

Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial