titleabbrev
titleabbrev — The abbreviation of a Title
Synopsis
Mixed Content Model
titleabbrev ::=
(#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
Description
TitleAbbrev holds an abbreviated version of a Title. One common use of TitleAbbrev is for the text used in running headers or footers, when the proper title is too long to be used conveniently.
Processing expectations
May be formatted inline or as a displayed block, depending on context. Abbreviated titles are usually used only in specific contexts, such as headers and footers, and suppressed everywhere else.
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 titleabbrev: appendix, appendixinfo, article, articleinfo, bibliodiv, biblioentry, bibliography, bibliographyinfo, bibliolist, bibliomixed, bibliomset, biblioset, blockinfo, book, bookinfo, calloutlist, chapter, chapterinfo, colophon, dedication, equation, example, figure, glossary, glossaryinfo, glossdiv, glosslist, index, indexdiv, indexinfo, itemizedlist, lot, msgset, objectinfo, orderedlist, part, partinfo, partintro, preface, prefaceinfo, procedure, productionset, qandadiv, qandaset, refentryinfo, reference, referenceinfo, refsect1, refsect1info, refsect2, refsect2info, refsect3, refsect3info, refsection, refsectioninfo, refsynopsisdiv, refsynopsisdivinfo, sect1, sect1info, sect2, sect2info, sect3, sect3info, sect4, sect4info, sect5, sect5info, section, sectioninfo, segmentedlist, set, setindex, setindexinfo, setinfo, sidebar, sidebarinfo, simplesect, table, task, taskprerequisites, taskrelated, tasksummary, toc, variablelist.
Children
The following elements occur in titleabbrev: abbrev, acronym, action, anchor, application, author, authorinitials, biblioref, citation, citebiblioid, citerefentry, citetitle, classname, code, command, computeroutput, constant, corpauthor, corpcredit, database, email, emphasis, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm, footnote, footnoteref, foreignphrase, function, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, inlineequation, inlinegraphic, inlinemediaobject, interface, interfacename, keycap, keycode, keycombo, keysym, link, literal, markup, medialabel, menuchoice, methodname, modespec, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, orgname, othercredit, package, parameter, personname, phrase, productname, productnumber, prompt, property, quote, remark, replaceable, returnvalue, revhistory, sgmltag, structfield, structname, subscript, superscript, symbol, systemitem, termdef, token, trademark, type, ulink, uri, userinput, varname, wordasword, xref.
Examples
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter><title>How to Configure the Menu Subsystem
of the Graphical User Interface</title>
<titleabbrev>Configuring Menus</titleabbrev>
<para>
Actual content.
</para>
</chapter>