lineannotation

lineannotation — A comment on a line in a verbatim listing.

Synopsis

lineannotation ::=

Attributes

Common attributes and common linking 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 lineannotations 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

Related elements: computeroutput, literallayout, programlisting, userinput.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example lineannotation</title>
   | 
   |<screen>
 5 |&lt;entry>  <lineannotation>Error: No line break before block element</lineannotation>
   |&lt;para>
   |A paragraph of text.
   |&lt;/para>&lt;/entry>
   |</screen>
10 | 
   |</article>

  | 
  |<entry>  Error: No line break before block element
  |<para>
  |A paragraph of text.
  |</para></entry>