msgexplan

DocBook 5.1: The Definitive Guide (Version 1.5.3 for DocBook 5.1)

msgexplan

msgexplan — Explanatory material relating to a message in a message set.

Synopsis

msgexplan ::=

Sequence of:
- One of:
  - Sequence of:
    Interleave of:
    title?
    titleabbrev?
    info? (db.titleforbidden.info)
  - info (db.titleonly.info)
- One or more of:
  - annotation
  - bridgehead
  - remark
  - revhistory
  - Indexing inlines
    indexterm (db.indexterm.endofrange)
    indexterm (db.indexterm.singular)
    indexterm (db.indexterm.startofrange)
  - Admonition elements
    caution
    important
    note
    tip
    warning
  - Formal elements
    equation
    example
    figure
    table (db.cals.table)
    table (db.html.table)
  - Graphic elements
    mediaobject
    screenshot
  - Informal elements
    informalequation
    informalexample
    informalfigure
    informaltable (db.cals.informaltable)
    informaltable (db.html.informaltable)
  - List elements
    bibliolist
    calloutlist
    glosslist
    itemizedlist
    orderedlist
    procedure
    qandaset
    segmentedlist
    simplelist
    variablelist
  - Paragraph elements
    anchor
    formalpara
    para
    simpara
  - Publishing elements
    address
    blockquote
    epigraph
    sidebar
  - Synopsis elements
    classsynopsis
    cmdsynopsis
    constructorsynopsis
    destructorsynopsis
    fieldsynopsis
    funcsynopsis
    methodsynopsis
  - Technical elements
    constraintdef
    msgset
    procedure
    productionset
    task
  - Verbatim elements
    literallayout
    programlisting
    programlistingco
    screen
    screenco
    synopsis

Attributes

Common attributes and common linking attributes.

Additional Constraints

If this element is the root element, it must have a version attribute.

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.

Children

The following elements occur in msgexplan: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, variablelist, warning.