O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

olink — A link that addresses its target indirectly

Synopsis

olink ::= (text | Bibliography inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines)*

Attribute synopsis

Common attributes.

Additional attributes:

  • localinfo

  • targetdoc (anyURI)

  • targetptr

  • type

  • xrefstyle

Description

Unlike link, the semantics of olink are application specific. The olink element provides a mechanism for establishing links across documents, where ID/IDREF linking is not possible and URI-based linking may be inappropriate.

In general terms, the strategy employed by olink is to point to the target document by URI, and point into that document in some application-specific way.

Other elements can also behave like olink by using the common linking attributes xlink:href and xlink:role. When an element has an xlink:role="http://docbook.org/xlink/role/olink" attribute, then its xlink:href attribute is interpreted using olink semantics. That is, the part of xlink:href before the fragment identifier (#) is interpreted as equivalent to an olink targetdoc attribute value instead of a URI, and the part after the fragment identifier as an olink targetptr attribute value.

Processing expectations

Formatted inline.

An olink points to its target primarily with the targetdoc attribute. ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required