errorname

errorname — An error name.

Synopsis

errorname ::= [-]

Description

An errorname holds the symbolic name of an error.

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 symbolic names, so the errortext element was added and the semantics of the error elements adjusted slightly.

Processing expectations

Formatted inline.

Children

The following elements occur in errorname: 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.

Last revised by Norman Walsh on 28 Apr 2016 (git hash: 8efbb30ec1f2a59299576c057927c2032216aea4)