Reference. Reference for the DocBook DTD

[Prev] [Next]


Link

Name

Link---Hypertext link

Synopsis

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 Default Value
Endterm IDREF #IMPLIED  
Linkend IDREF #REQUIRED  
Type CDATA #IMPLIED  

Tag Minimization

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

Description

Hypertext link. It may contain in-line elements and has EndTerm, Linkend, and Type attributes.

Processing Expectations

The optional Endterm attribute specifies text that is to be fetched from elsewhere in the document to appear in the Link. Text for the same purpose may be supplied directly as the content of the Link, in which case the value of the Endterm attribute is to be ignored.

Parents

These elements contain Link: 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, and entry.

Children

Link 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.

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

Endterm

Endterm holds the ID of an element that contains text and which is to be fetched from elsewhere in the document to appear as the content of this element.

Linkend

ID of target pointed to by this element.

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>


[Prev] LineAnnotation
[Next] list.class
[Reference Home] [Davenport Group Home]