primary

primary — The primary word or phrase under which an index term should be sorted.

Synopsis

primary ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • sortas

Description

In an indexterm, primary identifies the most significant word or words in the entry. All indexterms must have a primary.

☝
Important

In DocBook 5.x, a primary may contain nested indexterm elements. This is unsupported and will be removed in DocBook V6.0.

Processing expectations

Suppressed. This element provides data for processing but it is not rendered in the primary flow of text.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

sortas

Specifies the string by which the term is to be sorted; if unspecified, the term content is used

Parents

These elements contain primary: indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange).

Children

The following elements occur in primary: text, abbrev, acronym, alt, anchor, author, biblioref, citation, citebiblioid, citetitle, coref, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), glossterm (db._glossterm), glossterm (db.glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlineequation, inlinemediaobject, inlinestagedir, jobtitle, link, literal, olink, optional, org, orgname, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, quote (db._quote), quote (db.quote), remark, revnumber, subscript, superscript, templatename, termdef, trademark, uri, wordasword, xref.

See Also

Related elements: indexterm, secondary, see, seealso, tertiary.