DocBook 5: The Definitive Guide

Name

msgset — A detailed set of messages, usually error messages

Synopsis

msgset ::= ((((title? & titleabbrev?), info? ^{db.titleforbidden.info}) | info ^{db.titleonly.info}), (msgentry+ | simplemsgentry+))

Attribute synopsis

Common attributes and common linking attributes.

Description

A 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.

See Also

errorcode, errorname, errortext, errortype

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