titleabbrev
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# titleabbrev

## Name

titleabbrev — The abbreviation of a `Title`

##

# Synopsis

### Mixed Content Model

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

### Attributes

Common attributes

### Parameter Entities

The following parameter entities contain titleabbrev:

Parameter Entities
`%bibliocomponent.mix;` | `%bookcomponent.title.content;` | `%div.title.content;`
`%formalobject.title.content;` | `%refsect.title.content;` | `%sect.title.content;`
`%tbl.table.mdl;` |  |

## 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`, `bibliomixed`, `bibliomset`, `biblioset`, `book`, `bookinfo`, `calloutlist`, `chapter`, `chapterinfo`, `colophon`, `dedication`, `equation`, `example`, `figure`, `glossary`, `glossaryinfo`, `glossdiv`, `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`, `refsynopsisdiv`, `refsynopsisdivinfo`, `sect1`, `sect1info`, `sect2`, `sect2info`, `sect3`, `sect3info`, `sect4`, `sect4info`, `sect5`, `sect5info`, `section`, `sectioninfo`, `segmentedlist`, `set`, `setindex`, `setindexinfo`, `setinfo`, `sidebar`, `sidebarinfo`, `simplesect`, `table`, `toc`, `variablelist`.

### Children

The following elements occur in titleabbrev: `abbrev`, `acronym`, `action`, `anchor`, `application`, `author`, `authorinitials`, `citation`, `citerefentry`, `citetitle`, `classname`, `command`, `computeroutput`, `constant`, `corpauthor`, `database`, `email`, `emphasis`, `envar`, `errorcode`, `errorname`, `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`, `othercredit`, `parameter`, `phrase`, `productname`, `productnumber`, `prompt`, `property`, `quote`, `remark`, `replaceable`, `returnvalue`, `revhistory`, `sgmltag`, `structfield`, `structname`, `subscript`, `superscript`, `symbol`, `systemitem`, `token`, `trademark`, `type`, `ulink`, `userinput`, `varname`, `wordasword`, `xref`.

## See Also

`subtitle`, `title`.

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

For additional examples, see also `article`, `book`, `xref` .

Prev | Home | Next
title | Up | toc

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.