msgexplan

$Revision: 1.3 $

$Date: 2002/06/12 11:18:18 $

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|classsynopsis|
  fieldsynopsis|constructorsynopsis|destructorsynopsis|
  methodsynopsis|formalpara|para|simpara|address|blockquote|
  graphic|graphicco|mediaobject|mediaobjectco|informalequation|
  informalexample|informalfigure|informaltable|equation|example|
  figure|table|msgset|procedure|sidebar|qandaset|task|
  productionset|constraintdef|anchor|bridgehead|remark|highlights|
  abstract|authorblurb|epigraph|indexterm|beginpage)+)

Attributes

Common attributes

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, simplemsgentry.

Examples

For examples, see msgset.