DocBook: The Definitive Guide
Prev		Next

MsgSet

Name

MsgSet -- A detailed set of messages, usually error messages

Synopsis

Content Model

MsgSet ::=
((Title,TitleAbbrev?)?,
 MsgEntry+)

Attributes

Common attributes

Tag Minimization

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

Parameter Entities

`%bookcomponent.content;`	`%component.mix;`	`%compound.class;`
`%divcomponent.mix;`	`%refcomponent.mix;`

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: Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Chapter, Glossary, GlossDiv, Index, ListItem, MsgExplan, MsgText, PartIntro, Preface, Procedure, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, SimpleSect, Step.

Children

The following elements occur in MsgSet: MsgEntry, Title, TitleAbbrev.

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

Examples

<!DOCTYPE msgset PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<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>

Record failed CRC

Record n in database

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.

Prev	Home	Next
MsgRel	Up	MsgSub


	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