lineannotation
lineannotation — A comment on a line in a verbatim listing.
Synopsis
- Zero or more of:
- text
phrase
(db._phrase)replaceable
- Graphic inlines
- Ubiquitous inlines
Attributes
Description
A lineannotation
is an author’s or editor’s
comment on a line in one of the verbatim environments. These are
annotations added by the documentor; they are not part of the original
listing.
Processing expectations
Formatted inline. In verbatim environments like
programlisting
, which are often presented in a
fixed-width font, they may get special typographic treatment, such as
italics.
If several lineannotation
s occur in the same
listing, they may be aligned horizontally.
Parents
These elements contain lineannotation
: literallayout
, programlisting
.
Children
The following elements occur in lineannotation: text, inlinemediaobject
, phrase
(db._phrase), replaceable
, subscript
, superscript
.
See Also
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example lineannotation</title>
<screen>
<entry> <lineannotation>Error: No line break before block element</lineannotation>
<para>
A paragraph of text.
</para></entry>
</screen>
</article>