DocBook: The Definitive Guide 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

---

BridgeHead

Name

BridgeHead -- A free-floating heading

Synopsis

Mixed Content Model

BridgeHead ::=
((#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

Name	Type	Default
Renderas	Enumeration: Other Sect1 Sect2 Sect3 Sect4 Sect5	None

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%admon.mix;	%bookcomponent.content;	%component.mix;
%divcomponent.mix;	%genobj.class;	%qandaset.mix;
%refcomponent.mix;	%sidebar.mix;

Description

Some documents, usually legacy documents, use headings that are not tied to the normal sectional hieararchy. These headings may be represented in DocBook with the BridgeHead element.

BridgeHeads may also be useful in fiction or journalistic works that don't have a nested hierarchy.

Processing expectations

A BridgeHead is formatted as a block, using the same display properties as the section heading which it masquerades as. The RenderAs attribute controls which heading it mimics.

 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 BridgeHead: Answer, Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caution, Chapter, Glossary, GlossDiv, Important, Index, ListItem, MsgExplan, MsgText, Note, PartIntro, Preface, Procedure, QandADiv, QandASet, Question, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step, Tip, Warning.

Children

The following elements occur in BridgeHead: 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.

Attributes

Renderas

The RenderAs attribute identifies how the BridgeHead should be rendered. In this way, a BridgeHead can be made to appear as a Sect1, for example.

See Also

Sect1, Sect2, Sect3, Sect4, Sect5, Section, SimpleSect

Examples

For examples, see Chapter.

---

Prev	Home	Next
BookInfo	Up	Callout

Back to: DocBook: The Definitive Guide