Name

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

Synopsis

primary ::= (text | Bibliography inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines)*

Attribute synopsis

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.

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.

sortas

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

See Also

indexentry, indexterm, primaryie, secondary, secondaryie, see, seealso, seealsoie, seeie, tertiary, tertiaryie

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.