    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
errortype — The classification of an error message
errortype ::=
(%smallcptr.char.mix;)*The following parameter entities contain errortype:
| Parameter Entities | ||
%cptr.char.mix; | %ndxterm.char.mix; | %para.char.mix; |
%refinline.char.mix; | %refname.char.mix; | %tbl.entry.mdl; |
%tech.char.class; | %title.char.mix; | |
The ErrorType element identifies a class of error. The
exact classifications are naturally going to vary by system, but
“recoverable” and “fatal” are two possibilities.
DocBook provides four elements for identifying the parts of an error message:
ErrorCode, for the alphanumeric error code (e.g., “-2”);
ErrorName, for the symbolic name of the error
(e.g., “ENOENT”);
ErrorText, for the text of the error message (e.g., “file
not found”); and
ErrorType, for the error type (e.g., “recoverable”).
These elements contain errortype:
action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, systemitem, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.
The following elements occur in errortype:
beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.
| | | |
| errortext | | example |