titleabbrev

titleabbrev — The abbreviation of a title.

Synopsis

titleabbrev ::=

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, appendix, article, bibliodiv, biblioentry, bibliography, bibliolist, bibliomixed, bibliomset, biblioset, blockquote, book, calloutlist, caution, chapter, colophon, danger, dedication, dialogue, drama, equation, example, figure, formalgroup, formalpara, glossary, glossdiv, glosslist, important, index, info (db.info), info (db.titleonly.info), info (db.titleonlyreq.info), info (db.titlereq.info), itemizedlist, legalnotice, note, orderedlist, part, partintro, personblurb, poetry, preface, procedure, qandadiv, qandaentry, qandaset, revhistory, section, set, setindex, sidebar, simplesect, step, table, task, taskprerequisites, taskrelated, tasksummary, tip, toc, variablelist, warning.

Children

The following elements occur in titleabbrev: text, abbrev, acronym, alt, anchor, author, biblioref, citation, citebiblioid, citetitle, coref, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), glossterm (db._glossterm), glossterm (db.glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlineequation, inlinemediaobject, inlinestagedir, jobtitle, link, literal, olink, optional, org, orgname, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, quote (db._quote), quote (db.quote), remark, revnumber, subscript, superscript, templatename, termdef, trademark, uri, wordasword, xref.

See Also

Related elements: subtitle, title.

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>