[Prev] [Next]

LineAnnotation

Name

Synopsis

  (#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 | Markup | MediaLabel
  | MenuChoice | MouseButton | MsgText | Option | Optional
  | Parameter | Prompt | Property | Replaceable | ReturnValue
  | SGMLTag | StructField | StructName | Symbol | SystemItem
  | Token | Type | UserInput | Anchor | Author | AuthorInitials
  | CorpAuthor | ModeSpec | OtherCredit | ProductName
  | ProductNumber | RevHistory | Comment | Subscript
  | Superscript | InlineGraphic | InlineEquation | Synopsis
  | CmdSynopsis
  | FuncSynopsis)+

Attributes

This element has common and Role attributes.

Tag Minimization

Both the start- and end-tags are required for this element.

Description

Writer's or editor's comment on a line of program code within an Example, ProgramListing, or Screen. LineAnnotations are a document author's comments on the code, not the comments written into the code itself by the code's author. LineAnnotation may contain plain text and in-line elements. It has common attributes.

Parents

These elements contain LineAnnotation: FuncSynopsisInfo, LiteralLayout, ProgramListing, Screen, and Synopsis.

Children

LineAnnotation contains these elements: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, GlossTerm, Hardware, InlineEquation, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, #PCDATA, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, WordAsWord, and XRef.

Examples

<EXAMPLE ID="EX-1002-5-4">
<TITLE>Example of switching graphics contexts
</TITLE>
<PROGRAMLISTING>GC gc1, gc2;
XGCValues values;<LINEANNOTATION>Note capitalization</LINEANNOTATION>
unsigned long valuemask;
        .
        .
        .
/* Open display, create window, etc. */
values.foreground = BlackPixel(display,screen_num);
values.background = WhitePixel(display,screen_num);
gc1 = XCreateGC(display, RootWindow(display, screen_num),
        (GCForeground | GCBackground), &amp;values);
values.foreground = WhitePixel(display,screen_num);
values.background = BlackPixel(display,screen_num);
gc2 = XCreateGC(display, RootWindow(display, screen_num),
        (GCForeground | GCBackground), &amp;values);
/* Now you can use either gc in drawing routines, thereby
 * quickly swapping the foreground and background colors */
</PROGRAMLISTING>
</EXAMPLE>

[Prev] Lineage
[Next] Link
[Reference Home] [Davenport Group Home]