msgset

msgset — A detailed set of messages, usually error messages

Synopsis

Content Model

msgset ::=

Sequence of:
- One of:
  - Sequence of:
    Interleave of:
    title?
    titleabbrev?
    info? (db.titleforbidden.info)
  - info (db.titleonly.info)
- One of:
  - One or more of:
    msgentry
  - One or more of:
    simplemsgentry

Attributes

Common attributes and common linking attributes.

Description

MsgSet is a complex structure designed to hold a detailed set of messages, usually error messages. In addition to the actual text of each message, it can contain additional information about each message and the messages related to it.

Processing expectations

Formatted as a displayed block.

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

Parents

These elements contain msgset: annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.

Children

The following elements occur in msgset: info (db.titleforbidden.info), info (db.titleonly.info), msgentry, simplemsgentry, title, titleabbrev.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example msgset</title>

<msgset>
  <msgentry>
    <msg>
       <msgmain>
          <msgtext><para>Record failed CRC</para></msgtext>
       </msgmain>
       <msgsub>
          <msgtext><para>Record <replaceable>n</replaceable>
                    in <replaceable>database</replaceable></para></msgtext>
       </msgsub>
       <msgrel>
          <msgtext><para>File read error on 
                   <replaceable>database</replaceable></para></msgtext>
       </msgrel>
       <msgrel>
          <msgtext><para>Panic! Corrupt record!</para></msgtext>
       </msgrel>
     </msg>
     <msginfo>
        <msglevel>severe</msglevel>
        <msgorig>server</msgorig>
        <msgaud>all</msgaud>
     </msginfo>
     <msgexplan>
        <para>        Indicates that some sort of error occurred while attempting to load
        a record from the database.  Retry.  If failure persists,
        contact the database administrator.
        </para>
     </msgexplan>
 </msgentry>
 <!-- more entries -->
</msgset>

</article>

Record failed CRC

Record n in database

File read error on database

Panic! Corrupt record!

Level: severe

Origin: server

Audience: all

Indicates that some sort of error occurred while attempting to load a record from the database. Retry. If failure persists, contact the database administrator.

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:55 $.


msgrel		msgsub