$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
lineannotation — A comment on a line in a verbatim listing
lineannotation ::= (#PCDATA|footnoteref
|xref
|biblioref
|abbrev
|acronym
|citation
|citerefentry
|citetitle
|citebiblioid
|emphasis
|firstterm
|foreignphrase
|glossterm
|termdef
|footnote
|phrase
|orgname
|quote
|trademark
|wordasword
|personname
|link
|olink
|ulink
|action
|application
|classname
|methodname
|interfacename
|exceptionname
|ooclass
|oointerface
|ooexception
|package
|command
|computeroutput
|database
|envar
|errorcode
|errorname
|errortype
|errortext
|filename
|function
|guibutton
|guiicon
|guilabel
|guimenu
|guimenuitem
|guisubmenu
|hardware
|interface
|keycap
|keycode
|keycombo
|keysym
|literal
|code
|constant
|markup
|medialabel
|menuchoice
|mousebutton
|option
|optional
|parameter
|prompt
|property
|replaceable
|returnvalue
|sgmltag
|structfield
|structname
|symbol
|systemitem
|uri
|token
|type
|userinput
|varname
|nonterminal
|anchor
|author
|authorinitials
|corpauthor
|corpcredit
|modespec
|othercredit
|productname
|productnumber
|revhistory
|remark
|subscript
|superscript
|inlinegraphic
|inlinemediaobject
|inlineequation
|synopsis
|cmdsynopsis
|funcsynopsis
|classsynopsis
|fieldsynopsis
|constructorsynopsis
|destructorsynopsis
|methodsynopsis
|indexterm
|beginpage
)*
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.
The InterfaceDefinition
element will be discarded in DocBook V4.0. It will no longer be available
in the content model of this element.
These elements contain lineannotation:
classsynopsisinfo
, funcsynopsisinfo
, literallayout
, programlisting
, rhs
, screen
, synopsis
.
The following elements occur in lineannotation:
abbrev
, acronym
, action
, anchor
, application
, author
, authorinitials
, beginpage
, biblioref
, citation
, citebiblioid
, citerefentry
, citetitle
, classname
, classsynopsis
, cmdsynopsis
, code
, command
, computeroutput
, constant
, constructorsynopsis
, corpauthor
, corpcredit
, database
, destructorsynopsis
, email
, emphasis
, envar
, errorcode
, errorname
, errortext
, errortype
, exceptionname
, fieldsynopsis
, filename
, firstterm
, footnote
, footnoteref
, foreignphrase
, funcsynopsis
, function
, glossterm
, guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, indexterm
, inlineequation
, inlinegraphic
, inlinemediaobject
, interface
, interfacename
, keycap
, keycode
, keycombo
, keysym
, link
, literal
, markup
, medialabel
, menuchoice
, methodname
, methodsynopsis
, modespec
, mousebutton
, nonterminal
, olink
, ooclass
, ooexception
, oointerface
, option
, optional
, orgname
, othercredit
, package
, parameter
, personname
, phrase
, productname
, productnumber
, prompt
, property
, quote
, remark
, replaceable
, returnvalue
, revhistory
, sgmltag
, structfield
, structname
, subscript
, superscript
, symbol
, synopsis
, systemitem
, termdef
, token
, trademark
, type
, ulink
, uri
, userinput
, varname
, wordasword
, 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>
For additional examples, see also
productionset
.