titleabbrev
titleabbrev — The abbreviation of a title.
Synopsis
titleabbrev ::=
- 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
abbrev
acronym
coref
date
emphasis
(db.emphasis)firstterm
(db._firstterm)firstterm
(db.firstterm)footnote
footnoteref
foreignphrase
(db.foreignphrase)glossterm
(db._glossterm)glossterm
(db.glossterm)phrase
(db.phrase)quote
(db.quote)revnumber
subscript
superscript
wordasword
- Technical inlines
- Ubiquitous inlines
abbrev
acronym
alt
anchor
annotation
biblioref
coref
date
emphasis
(db._emphasis)firstterm
(db._firstterm)footnote
footnoteref
foreignphrase
(db._foreignphrase)glossterm
(db._glossterm)indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
phrase
(db._phrase)quote
(db._quote)remark
subscript
superscript
trademark
wordasword
xref
Attributes
Common attributes and common linking attributes.
No additional attributes.
Description
A 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.
Titles are so common, and so often the only “info” elements
associated with their parent, that they (title
,
subtitle
, and titleabbrev
) are allowed outside
the info
element. This is a tradeoff favoring author
convenience over a small amount of additional complexity in
processing. However, the title elements must either all be outside of
the info
wrapper or all inside, you cannot have some
outside and some inside.
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 are suppressed everywhere else.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain titleabbrev
: abstract
, acknowledgements
, annotation
, appendix
, article
, assembly
, bibliodiv
, biblioentry
, bibliography
, bibliolist
, bibliomixed
, bibliomset
, biblioset
, blockquote
, book
, calloutlist
, caution
, chapter
, colophon
, constraintdef
, danger
, dedication
, equation
, example
, figure
, formalgroup
, formalpara
, glossary
, glossdiv
, glosslist
, important
, index
, indexdiv
, info
(db.info), info
(db.titleonly.info), info
(db.titleonlyreq.info), info
(db.titlereq.info), itemizedlist
, legalnotice
, merge
, msg
, msgexplan
, msgmain
, msgrel
, msgset
, msgsub
, note
, orderedlist
, part
, partintro
, personblurb
, preface
, procedure
, productionset
, qandadiv
, qandaentry
, qandaset
, reference
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, relationships
, revhistory
, screenshot
, sect1
, sect2
, sect3
, sect4
, sect5
, section
, segmentedlist
, set
, setindex
, sidebar
, simplesect
, step
, table
(db.cals.table), task
, taskprerequisites
, taskrelated
, tasksummary
, tip
, toc
, tocdiv
, topic
, transforms
, variablelist
, warning
.
Children
The following elements occur in titleabbrev
: 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
Examples
1 |<chapter xmlns='http://docbook.org/ns/docbook'>
|<info>
|<title>How to Configure the Menu Subsystem
|of the Graphical User Interface</title>
5 |<titleabbrev>Configuring Menus</titleabbrev>
|</info>
||
<para>Actual content.
|</para>
10 |</chapter>