$Revision: 1.3 $
$Date: 2002/06/12 11:18:16 $
lineannotation — A comment on a line in a verbatim listing
lineannotation ::= (#PCDATA|footnoteref|xref|abbrev|acronym|citetitle|emphasis| footnote|phrase|quote|trademark|link|ulink|command| computeroutput|email|filename|literal|option|replaceable| systemitem|userinput|inlinemediaobject)*
Common attributes
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.
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.
These elements contain lineannotation: literallayout, programlisting.
The following elements occur in lineannotation: abbrev, acronym, citetitle, command, computeroutput, email, emphasis, filename, footnote, footnoteref, inlinemediaobject, link, literal, option, phrase, quote, replaceable, systemitem, trademark, ulink, userinput, xref.
The following example, from the description of Entry, shows how LineAnnotation can be used to annotate a Screen listing:
<!DOCTYPE screen PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> <screen> <entry> <lineannotation>Error, cannot have a line break before a block element</lineannotation> <para> A paragraph of text. </para></entry> </screen>
<entry> Error, cannot have a line break before a block element <para> A paragraph of text. </para></entry>