DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

lineannotation

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

Synopsis

lineannotation ::= [x]  [+]

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.

Children

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

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example lineannotation</title>

<screen>
&lt;entry>  <lineannotation>Error: No line break before block element</lineannotation>
&lt;para>
A paragraph of text.
&lt;/para>&lt;/entry>
</screen>

</article>


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