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

DocBook: The Definitive Guide
Prev		Next

MsgExplan

Name

MsgExplan -- Explanatory material relating to a message in a message set

Synopsis

Content Model

MsgExplan ::=
(Title?,
 (CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
  SimpleList|VariableList|Caution|Important|Note|Tip|Warning|
  LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|
  ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|
  SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject|
  MediaObjectCO|InformalEquation|InformalExample|InformalFigure|
  InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|
  Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|Abstract|
  AuthorBlurb|Epigraph|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

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

Description

A MsgExplan contains some sort of explanatory information about a Msg or a set of Msgs in a MsgEntry.

Processing expectations

Formatted as a displayed block. Sometimes suppressed.

If a MsgEntry contains multiple Msgs and multiple MsgExplans, DocBook makes no assertions about how they are related.

On the whole, the semantics of MsgSet are not clearly defined.

Parents

These elements contain MsgExplan: MsgEntry.

Children

The following elements occur in MsgExplan: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Tip, Title, VariableList, Warning.

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

In some contexts, the following elements are excluded: Caution, Equation, Example, Figure, Important, IndexTerm, InformalTable, Note, Table, Tip, Warning.

Examples

For examples, see MsgSet.

Prev	Home	Next
MsgEntry	Up	MsgInfo

Back to: DocBook: The Definitive Guide

O'Reilly Home | O'Reilly-Partnerbuchhandlungen | Bestellinformationen | Kontaktieren Sie uns
International | Über O'Reilly | Tochterfirmen

© 1999, O'Reilly & Associates, Inc.