Name
lineannotation — A comment on a line in a verbatim listing
Synopsis
lineannotation ::=
(text | phrase
db._phrase | replaceable
| Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*
Attribute synopsis
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 lineannotation
s occur in the same
listing, they may be aligned horizontally.
See Also
computeroutput
, literallayout
, programlisting
, screen
, screenshot
, synopsis
, userinput
Examples
<article xmlns='http://docbook.org/ns/docbook'> <title>Example lineannotation</title> <screen> <entry> <lineannotation>Error: No line break before block element</lineannotation> <para> A paragraph of text. </para></entry> </screen> </article>
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.