OLink

Guide to the DocBook DTD
Prev		Next

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.

Name	Value(s)	Type
LinkMode	IDREF	#IMPLIED
LocalInfo	CDATA	#IMPLIED
TargetDocEnt	ENTITY	#IMPLIED
Type	CDATA	#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 in parent elements. Similarly, in some contexts, some of these elements may be invalid due to exclusions in parent elements.

Examples

<NOTE>
<TITLE>A Low Note</TITLE>
<PARA>Take care with all you do.
</PARA>
</NOTE>