lineannotation

lineannotation — A comment on a line in a verbatim listing

Synopsis

Content Model

lineannotation ::=

Zero or more of:
- text
- alt
- anchor
- annotation
- biblioref
- indexterm (db.indexterm.endofrange)
- indexterm (db.indexterm.singular)
- indexterm (db.indexterm.startofrange)
- inlinemediaobject
- link
- olink
- phrase (db._phrase)
- remark
- replaceable
- subscript
- superscript
- xref

Attributes

Common attributes and common linking attributes.

Description

A LineAnnotation is an author or editor's comment on a line in one of the verbatim environments. These are annotations added by the documentor, 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

The following elements occur in lineannotation: text, alt, anchor, annotation, biblioref, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), remark, replaceable, subscript, superscript, xref.

Examples

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

<screen>
&lt;entry>                <lineannotation>Error, cannot have a line break before a block element</lineannotation>
&lt;para>
A paragraph of text.
&lt;/para>&lt;/entry>
</screen>

</article>

<entry>                Error, cannot have a line break before a block element
<para>
A paragraph of text.
</para></entry>

ChangeLog

This alpha reference page is $Revision: 1.5 $ published $Date: 2005/10/31 18:42:46 $.


lineage		link