errortext
errortext — An error message..
Synopsis
errortext ::=
- Zero or more of:
- text
replaceable- Graphic inlines
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
abbrevacronymaltanchorannotationbibliorefcorefdateemphasis(db._emphasis)firstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase(db._phrase)quote(db._quote)remarksubscriptsuperscripttrademarkwordaswordxref
Attributes
Common attributes and common linking attributes.
No additional attributes.
Description
An 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.
Processing expectations
Formatted inline.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain errortext: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), link, literallayout, member, meta (db.meta.content), olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote (db.quote), refdescriptor, refentrytitle, refname, refpurpose, remark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, synopsisinfo, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry.
Children
The following elements occur in errortext: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.