Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

OLink
Guide to the DocBook DTD
PrevNext

OLink

Name

OLink -- Link that addresses its target by use of an entity

Content Model

  (#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.

NameValue(s)TypeDefault Value
LinkModeIDREF#IMPLIED 
LocalInfoCDATA#IMPLIED 
TargetDocEntENTITY#IMPLIED 
TypeCDATA#IMPLIED 

Tag Minimization

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

Description

Link that addresses its target by use of an entity. OLink may contain in-line elements and has common, TargetDocEnt, LinkMode, Type, and LocalInfo attributes.

In contrast to Link, OLink has no Linkend attribute, but rather a TargetDocEnt, the value of which is the name of a text or data entity already defined by the user. The LinkMode attribute points by ID to a ModeSpec; for convenience, ModeSpecs are located in the BookInfo. ModeSpec contains instructions (probably application-specific) for operating on the entity named by TargetDocEnt. e.g., the TargetDocEnt is another Book, and the ModeSpec specifies that all the second-level headings should be searched for a phrase. The LocalInfo attribute may be used to hold such a Phrase, which may be thought of as a replacement for some variable in ModeSpec.

Parents

These elements contain OLink: Abbrev, Acronym, Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, Figure, Filename, FirstTerm, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, IndexDiv, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, ManVolNum, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefEntry, RefEntryTitle, RefNameDiv, RefPurpose, Replaceable, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subscript, Subtitle, Superscript, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput, WordAsWord, entry.

Children

OLink 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, XRef.

In some contexts, additional elements may be allowed by inclusions in parent elements. Similarly, in some contexts, some of these elements may be invalid due to exclusions in parent elements.

Attributes

TargetDocEnt

TargetDocEnt holds the name of an entity that is to be the target of the OLink.

LinkMode

LinkMode holds the ID of a ModeSpec that contains instructions for operating on the entity named by TargetDocEnt.

LocalInfo

LocalInfo hold information that may be passed to the applicable ModeSpec when resolving the OLink.

Type

Type indicates how the Members of the SimpleList should be formatted: Inline (Members separated by commas, etc., inline), Vert (top to bottom in the number of columns indicated by the Columns attribute), or Horiz (right to left or left to right, depending on current text flow) in the number of columns indicated by the Columns attribute). The default is Vert. If Column is 1 or #IMPLIED, Type=Vert and Type=Horiz give the same results.

Examples

<PARA><MODESPEC ID="mo123" APPLICATION="FAX">usenumericipaddr</MODESPEC>
To warm up, we provide a <ANCHOR ID="proan123"> target in
<PHRASE ID="proan124">the same place</PHRASE>, pretty much.
To go there,
<LINK LINKEND="proan123" TYPE="info">click here</LINK>
and say goodbye.  Or click to go to
<LINK LINKEND="proan123" ENDTERM="proan124"></LINK>.
You may prefer to 
<ULINK URL="http://foo.bar.com/index.html" TYPE="alternate">click
here</ULINK> instead.  And if that doesn't work, just
<OLINK TARGETDOCENT="foobar" LINKMODE="mo123" 
LOCALINFO="noretry" TYPE="desperate">click here</OLINK>
and give up all hope.
</PARA>
PrevHomeNext
NoteUpOption