    |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
| |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
olink — A link that addresses its target indirectly
olink ::= ![[-]](graphics/down.gif)
![[+]](graphics/right.gif)
abbrevacronymcorefdateemphasis (db.emphasis)firsttermfootnotefootnoterefforeignphraseglosstermphrase (db.phrase)quotesubscriptsuperscriptwordasword
altanchorannotationbibliorefindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxrefUnlike 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 a 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.
Formatted inline.
An olink points to its target primarily with the targetdoc attribute. The targetdoc is a URI that identifies a target document.
The semantics of the link are controlled by three other attributes: targetptr, localinfo, and type. The targetptr attribute points into the document in some fashion.
The values of localinfo and type may also influence the application. For example, if the targetptr describes some sort of query, localinfo might hold the query text.
Linking elements must not be nested within other linking elements (including themselves). The processing of nested linking elements is undefined.
Holds additional information that may be used by the applicatoin when resolving the link
Specifies the URI of the document in which the link target appears
Specifies the location of the link target in the document
Identifies application-specific customization of the link behavior
Specifies a keyword or keywords identifying additional style information
These elements contain olink: abbrev, accel, acronym, address, application, arg, artpagenums, attribution, authorinitials, bibliocoverage, biblioid, bibliomisc, bibliomset, bibliorelation, bibliosource, bridgehead, caption (db.html.caption), citation, citebiblioid, citetitle, city, classname, classsynopsisinfo, code, command, computeroutput, confdates, confnum, confsponsor, conftitle, constant, contractnum, contractsponsor, contrib, country, database, edition, email, emphasis (db._emphasis), emphasis (db.emphasis), entry, envar, errorcode, errorname, errortext, errortype, exceptionname, fax, filename, firstname, firstterm, foreignphrase, funcdef, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, guibutton, guiicon,
guilabel, guimenu, guimenuitem, guisubmenu, hardware, holder, honorific, html:button, html:label, html:legend, initializer, interfacename, issuenum, jobtitle, keycap, keycode, keysym, label, lineage, lineannotation, link, literal, literallayout, manvolnum, markup, mathphrase, member, methodname, modifier, mousebutton, msgaud, msglevel, msgorig, olink, option, optional, orgdiv, orgname, otheraddr, othername, package, pagenums, para, paramdef, parameter, personname, phone, phrase (db._phrase), phrase (db.phrase), pob, postcode, primary, primaryie, productname, productnumber, programlisting, prompt, property, publishername, quote, refdescriptor, refentrytitle, refmiscinfo, refname, refpurpose, releaseinfo, remark, replaceable, returnvalue, revnumber,
revremark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, seriesvolnums, shortaffil, simpara, state, street, subscript, subtitle, superscript, surname, symbol,
synopsis, systemitem, tag, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, token, trademark,
type, uri, userinput, varname, volumenum, wordasword, year.
The following elements occur in olink: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, citation, citebiblioid, citerefentry,
citetitle, classname, code, command, computeroutput, constant, coref, database, date, editor, email, emphasis (db.emphasis), envar,
errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm, footnote, footnoteref, foreignphrase, function, glossterm, guibutton,
guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, html:button, html:fieldset, html:input, html:label, html:select, html:textarea, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, link, literal, markup, menuchoice, methodname,
modifier, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, org, orgname, package, parameter, person, personname, phrase (db.phrase), productname, productnumber, prompt, property, quote, remark, replaceable, returnvalue, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, token, trademark,
type, uri, userinput, varname, wordasword, xref.
| |
|
|
| note | |
ooclass |