secondary

secondary — A secondary word or phrase in an index term.

Synopsis

secondary ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • sortas

Description

A secondary contains a secondary word or phrase in an indexterm. The text of a secondary term is less significant than the primary term, but more significant than the tertiary term for sorting and display purposes.

In indexterms, you can only have one primary, secondary, and tertiary term. If you want to index multiple secondary terms for the same primary, you must repeat the primary in another indexterm. You cannot place several secondarys in the same primary.

☝
Important

In DocBook 5.x, a secondary 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 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 secondary: indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange).

Children

The following elements occur in secondary: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, buildtarget, citation, citebiblioid, citerefentry, citetitle, classname, code, command, computeroutput, constant, coref, database, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), enumidentifier, enumname, enumvalue, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), function, glossterm (db._glossterm), glossterm (db.glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, link, literal, macroname, markup, menuchoice, methodname, modifier, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, org, orgname, package, parameter, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, prompt, property, quote (db._quote), quote (db.quote), remark, replaceable, returnvalue, revnumber, shortcut, subscript, superscript, symbol, systemitem, tag, templatename, termdef, token, trademark, type, typedefname, unionname, uri, userinput, varname, wordasword, xref.

See Also

Related elements: indexentry, indexterm, primary, primaryie, secondaryie, see, seealso, seealsoie, seeie, tertiary, tertiaryie.