LineAnnotation ::= ((#PCDATA|FootnoteRef|XRef|Abbrev|Acronym|Citation|CiteRefEntry| CiteTitle|Emphasis|FirstTerm|ForeignPhrase|GlossTerm|Footnote| Phrase|Quote|Trademark|WordAsWord|Link|OLink|ULink|Action| Application|ClassName|Command|ComputerOutput|Database|Email| EnVar|ErrorCode|ErrorName|ErrorType|Filename|Function|GUIButton| GUIIcon|GUILabel|GUIMenu|GUIMenuItem|GUISubmenu|Hardware| Interface|InterfaceDefinition|KeyCap|KeyCode|KeyCombo|KeySym| Literal|Constant|Markup|MediaLabel|MenuChoice|MouseButton| MsgText|Option|Optional|Parameter|Prompt|Property|Replaceable| ReturnValue|SGMLTag|StructField|StructName|Symbol|SystemItem| Token|Type|UserInput|VarName|Anchor|Author|AuthorInitials| CorpAuthor|ModeSpec|OtherCredit|ProductName|ProductNumber| RevHistory|Comment|Subscript|Superscript|InlineGraphic| InlineMediaObject|InlineEquation|Synopsis|CmdSynopsis| FuncSynopsis|IndexTerm)+)
Both the start- and end-tags are required for this element.
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: FuncSynopsisInfo, LiteralLayout, ProgramListing, Screen, Synopsis.
The following elements occur in LineAnnotation: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineEquation, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
In some contexts, the following elements are excluded: Acronym, Footnote, IndexTerm.
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 V3.1//EN"> <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>
Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.