DocBook 5.2: The Definitive Guide  (Version 5.2.6 for DocBook 5.2b09a)

segtitle

segtitle — The title of an element of a list item in a segmented list.

Synopsis

segtitle ::= [-]

Description

Each heading in a segmentedlist is contained in its own segtitle.

The relationship between segtitles and segs is implicit in the document; the first segtitle goes with the first seg in each seglistitem, the second segtitle goes with the second seg, and so on.

Processing expectations

Segmented lists can be formatted in a number of ways. Two popular formats are tabular and as a list of repeated headings and elements. In a tabular presentation, each segtitle is a column heading. In the list presentation, each segtitle is repeated before the corresponding seg.

Parents

These elements contain segtitle: segmentedlist.

Children

The following elements occur in segtitle: 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, namespace, namespacename, 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, shortcut, subscript, superscript, symbol, systemitem, tag, templateid, termdef, token, trademark, type, typedefname, unionname, uri, userinput, varname, wordasword, xref.

Examples

See segmentedlist for an example that uses this element.