DocBook: The Definitive Guide

Table of content


	By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

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|Command|ComputerOutput|Database|Email|   EnVar|ErrorCode|ErrorName|ErrorType|Filename|Function|GUIButton|   GUIIcon|GUILabel|GUIMenu|GUIMenuItem|GUISubmenu|Hardware|   Interface|InterfaceDefinition|KeyCap|KeyCode|KeyCombo|KeySym|   Literal|Constant|Markup|MediaLabel|MenuChoice|MouseButton|   MsgText|Option|Optional|Parameter|Prompt|Property|Replaceable|   ReturnValue|SGMLTag|StructField|StructName|Symbol|SystemItem|   Token|Type|UserInput|VarName|Anchor|Author|AuthorInitials|   CorpAuthor|ModeSpec|OtherCredit|ProductName|ProductNumber|   RevHistory|Comment|Subscript|Superscript|InlineGraphic|   InlineMediaObject|InlineEquation|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

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, ArtHeader, Article, BiblioDiv, BiblioEntry, Bibliography, BiblioMixed, BiblioMSet, BiblioSet, Book, BookBiblio, BookInfo, CalloutList, Chapter, Colophon, Dedication, DocInfo, Equation, Example, Figure, Glossary, GlossDiv, Index, IndexDiv, LoT, MsgSet, ObjectInfo, Part, PartIntro, Preface, Procedure, QandADiv, QandASet, Reference, RefSect1, RefSect1Info, RefSect2, RefSect2Info, RefSect3, RefSect3Info, RefSynopsisDiv, RefSynopsisDivInfo, Sect1, Sect1Info, Sect2, Sect2Info, Sect3, Sect3Info, Sect4, Sect4Info, Sect5, Sect5Info, Section, SectionInfo, SegmentedList, SeriesInfo, Set, SetIndex, SetInfo, Sidebar, SimpleSect, Table, ToC, VariableList.

Children

The following elements occur in TitleAbbrev: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineEquation, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: Acronym, Footnote, IndexTerm.

Examples

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <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.