Skip to main content
Version: DocBook V4.5

segtitle

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

Synopsis​

Mixed Content Model​

segtitle ::=
(#PCDATA|footnoteref|xref|biblioref|abbrev|acronym|citation|
citerefentry|citetitle|citebiblioid|emphasis|firstterm|
foreignphrase|glossterm|termdef|footnote|phrase|orgname|quote|
trademark|wordasword|personname|link|olink|ulink|action|
application|classname|methodname|interfacename|exceptionname|
ooclass|oointerface|ooexception|package|command|computeroutput|
database|email|envar|errorcode|errorname|errortype|errortext|
filename|function|guibutton|guiicon|guilabel|guimenu|guimenuitem|
guisubmenu|hardware|interface|keycap|keycode|keycombo|keysym|
literal|code|constant|markup|medialabel|menuchoice|mousebutton|
option|optional|parameter|prompt|property|replaceable|
returnvalue|sgmltag|structfield|structname|symbol|systemitem|uri|
token|type|userinput|varname|nonterminal|anchor|author|
authorinitials|corpauthor|corpcredit|modespec|othercredit|
productname|productnumber|revhistory|remark|subscript|
superscript|inlinegraphic|inlinemediaobject|inlineequation|
indexterm)*

Attributes​

Common attributes

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 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.

Future Changes​

The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

Parents​

These elements contain segtitle: segmentedlist.

Examples​

For examples, see segmentedlist.