lineannotation

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

Synopsis

lineannotation ::=

Zero or more of:
- text
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  biblioref
  link
  olink
  xref
- Ubiquitous inlines
  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
  subscript
  superscript
  trademark
  wordasword
  xref

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: classsynopsisinfo, funcsynopsisinfo, literallayout, programlisting, rhs, screen, synopsis.

Children

This element contains 29 elements.

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>


lineage		link