    |
DocBook: The Definitive Guide 2.0.17 (Alpha) |
| |
DocBook: The Definitive Guide 2.0.17 (Alpha) |
![[4.2]](figures/rev_4.2.png)
errortext
$Revision$
$Date$
errortext — An error message.
errortext ::= (#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|beginpage)*
ErrorText holds the text of an error message.
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”).
Prior to DocBook V4.2, the ErrorName element was the
recommended element for error messages. However, this left no
element for symoblic names, so the ErrorText element was added
and the semantics of the error elements adjusted slightly.
These elements contain errortext:
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 errortext:
beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.
|
|
|
|
| errorname | |
errortype |