primary
primary — The primary word or phrase under which an index term should be sorted.
Synopsis
primary ::=
- Zero or more of:
- 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
abbrevacronymcorefdateemphasis(db.emphasis)firstterm(db._firstterm)firstterm(db.firstterm)footnotefootnoterefforeignphrase(db.foreignphrase)glossterm(db._glossterm)glossterm(db.glossterm)phrase(db.phrase)quote(db.quote)revnumbersubscriptsuperscriptwordasword
- Technical inlines
- Ubiquitous inlines
abbrevacronymaltanchorannotationbibliorefcorefdateemphasis(db._emphasis)firstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase(db._phrase)quote(db._quote)remarksubscriptsuperscripttrademarkwordaswordxref
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.
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, 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, primaryie, secondary, secondaryie, see, seealso, seealsoie, seeie, tertiary, tertiaryie.