]>
XML Linking Language (XLink) Version 1.0 WD-xlink-19990527 World Wide Web Consortium Working Draft 29May1999

This draft is for public discussion.

http://www.w3.org/XML/Group/1999/05/WD-xlink-current http://www.w3.org/XML/Group/1999/05/WD-xlink-19990527 http://www.w3.org/XML/Group/1999/05/WD-xlink-19990505 http://www.w3.org/TR/1998/WD-xlink-19980303 http://www.w3.org/TR/WD-xml-link-970630 Steve DeRose Inso Corp. and Brown University Steven_DeRose@Brown.edu David Orchard IBM Corp. dorchard@ca.ibm.com Ben Trafford Invited Expert bent@exemplary.net

This is a W3C Working Draft for review by W3C members and other interested parties. It is a draft document and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use W3C Working Drafts as reference material or to cite them as other than "work in progress". A list of current W3C working drafts can be found at http://www.w3.org/TR.

Note: Since working drafts are subject to frequent change, you are advised to reference the above URI, rather than the URIs for working drafts themselves. Some of the work remaining is described in .

This work is part of the W3C XML Activity (for current status, see http://www.w3.org/XML/Activity ). For information about the XPointer language which is expected to be used with XLink, see http://www.w3.org/TR/WD-xptr.

See http://www.w3.org/TR/NOTE-xlink-principles for additional background on the design principles informing XLink.

Also see http://www.w3.org/TR/NOTE-xlink-req/ for the XLink requirements that this document attempts to satisfy.

This specification defines constructs that may be inserted into XML DTDs, schemas and document instances to describe links between objects. It uses XML syntax to create structures that can describe the simple unidirectional hyperlinks of today's HTML as well as more sophisticated links.

Burlington, Seekonk, et al.: World-Wide Web Consortium, XML Working Group, 1998.

Created in electronic form.

English Extended Backus-Naur Form (formal grammar) 1997-01-15 : Skeleton draft by TB 1997-01-24 : Fleshed out by sjd 1997-04-08 : Substantive draft 1997-06-30 : Public draft 1997-08-01 : Public draft 1997-08-05 : Prose/organization work by sjd 1997-10-14: Conformance and design principles; a bit of cleanup by elm 1997-11-07: Update for editorial issues per issues doc, by sjd. 1997-12-01: Update for editorial issues per issues doc in preparation for F2F meeting, by sjd. 1998-01-13: Editorial cleanup, addition of new design principles, by elm. 1998-02-27: Splitting out of XLink and XPointer, by elm. 1998-03-03: Moved most of the XPointer locator stuff here. elm 1999-04-24: Editorial rewrites to represent new ideas on XLink, especially the inclusion of arcs. bent 1999-05-05: Prose/organization work by dorchard. Moved much of the semantics section around, from: locators, link semantics, remote resource semantics, local resource semantics; to: resource semantics, locators, behavior semantics, link semantics, arc semantics 1999-05-12: Prose/organization work. Re-organized some of the sections, removed XML constructs from the document, added descriptive prose, edited document text for clarity. Rewrote the link recognition section. bent 1999-05-17: Further prose work. Added non-normative examples. Clarified arcs. bent 1999-05-23: Edited for grammar and clarity. bent 1999-05-27: Final once-over before sending to group. Fixed sjd's email address. bent
Introduction

This specification defines constructs that may be inserted into XML DTDs, schemas, and document instances to describe links between objects. A link, as the term is used here, is an explicit relationship between two or more data objects or portions of data objects. This specification is concerned with the syntax used to assert link existence and describe link characteristics. Implicit (unasserted) relationships, for example that of one word to the next or that of a word in a text to its entry in an on-line dictionary are obviously important, but outside its scope.

Links are asserted by elements contained in XML document instances. The simplest case is very like an HTML A link, and has these characteristics:

The link is expressed at one of its ends (similar to the A element in some document)

Users can only initiate travel from that end to the other

The link's effect on windows, frames, go-back lists, stylesheets in use, and so on is mainly determined by browsers, not by the link itself. For example, traveral of A links normally replaces the current view, perhaps with a user option to open a new window.

The link goes to only one destination (although a server may have great freedom in finding or dynamically creating that destination).

While this set of characteristics is already very powerful and obviously has proven itself highly useful and effective, each of these assumptions also limits the range of hypertext functionality. The linking model defined here provides ways to create links that go beyond each of these specific characteristics, thus providing features previously available mostly in dedicated hypermedia systems.

Origin and Goals

Following is a summary of the design principles governing XLink:

XLink must be straightforwardly usable over the Internet.

XLink must be usable by a wide variety of link usage domains and classes of linking application software.

XLink must support HTML 4.0 linking constructs.

The XLink expression language must be XML.

The XLink design must be formal, concise, and illustrative.

XLinks must be human-readable and human-writable.

XLinks may reside within or outside the documents in which the participating resources reside.

XLink must represent the abstract structure and significance of links.

XLink must be feasible to implement.

XLink must be informed by knowledge of established hypermedia systems and standards.

Relationship to Existing Standards

Three standards have been especially influential:

HTML: Defines several SGML element types that represent links.

HyTime: Defines inline and out-of-line link structures and some semantic features, including traversal control and presentation of objects.

Text Encoding Initiative Guidelines (TEI P3): Provides structures for creating links, aggregate objects, and link collections out of them.

Many other linking systems have also informed this design, especially Dexter, FRESS, MicroCosm, and InterMedia.

Terminology

The following basic terms apply in this document.

A symbolic representation of traversal behavior in links, especially the direction, context and timing of traversal.

A representation of the relevant structure specified by the tags and attributes in an XML document, based on "groves" as defined in the ISO DSSSL standard.

Abstractly, a link which serves as one of its own resources. Concretely, a link where the content of the linking element serves as a participating resource. HTML A, HyTime clink, and TEI XREF are all inline links.

An explicit relationship between two or more data objects or portions of data objects.

An element that asserts the existence and describes the characteristics of a link.

The content of an inlinelinking element. Note that the content of the linking element could be explicitly pointed to by means of a regular locator in the same linking element, in which case the resource is considered remote, not local.

Data, provided as part of a link, which identifies a resource.

A link whose traversal can be initiated from more than one of its participating resources. Note that being able to "go back" after following a one-directional link does not make the link multidirectional.

A link whose content does not serve as one of the link's participating resources . Such links presuppose a notion like extended link groups, which instruct application software where to look for links. Out-of-line links are generally required for supporting multidirectional traversal and for allowing read-only resources to have outgoing links.

In the context of link behavior, a parsed link is any link whose content is transcluded into the document where the link originated. The use of the term "parsed" directly refers to the concept in XML of a parsed entity.

A resource that belongs to a link. All resources are potential contributors to a link; participating resources are the actual contributors to a particular link.

Any participating resource of a link that is pointed to with a locator.

In the abstract sense, an addressable unit of information or service that is participating in a link. Examples include files, images, documents, programs, and query results. Concretely, anything reachable by the use of a locator in some linking element. Note that this term and its definition are taken from the basic specifications governing the World Wide Web.

A portion of a resource, pointed to as the precise destination of a link. As one example, a link might specify that an entire document be retrieved and displayed, but that some specific part(s) of it is the specific linked data, to be treated in an application-appropriate manner such as indication by highlighting, scrolling, etc.

The action of using a link; that is, of accessing a resource. Traversal may be initiated by a user action (for example, clicking on the displayed content of a linking element) or occur under program control.

Notation

The formal grammar for locators is given using a simple Extended Backus-Naur Form (EBNF) location, as described in the XML specification.

Locator Syntax

The locator for a resource is typically provided by means of a Uniform Resource Identifier, or URI. XPointers can be used in conjunction with the URI structure, as fragment identifiers, to specify a more precise sub-resource.

A locator generally contains a URI, as described in IETF RFCs and . As these RFCs state, the URI may include a trailing query (marked by a leading "?"), and be followed by a "#" and a fragment identifier, with the query interpreted by the host providing the indicated resource, and the interpretation of the fragment identifier dependent on the data type of the indicated resource.

In order to locate XML documents and portions of documents, a locator value may contain either a URI or a fragment identifier, or both. Any fragment identifier for pointing into XML must be an XPointer.

Special syntax may be used to request the use of particular processing models in accessing the locator's resource. This is designed to reflect the realities of network operation, where it may or may not be desirable to exercise fine control over the distribution of work between local and remote processors. Locator Locator URI | Connector (XPointer | Name) | URI Connector (XPointer | Name) Connector'#' | '|' URIURIchar*

In this discussion, the term designated resource refers to the resource which an entire locator serves to locate. The following rules apply:

The URI, if provided, locates a resource called the containing resource.

If the URI is not provided, the containing resource is considered to be the document in which the linking element is contained.

If an XPointer is provided, the designated resource is a sub-resource of the containing resource; otherwise the designated resource is the containing resource.

If the Connector is followed directly by a Name, the Name is shorthand for the XPointer"id(Name)"; that is, the sub-resource is the element in the containing resource that has an XML ID attribute whose value matches the Name. This shorthand is to encourage use of the robust id addressing mode.

If the connector is "#", this signals an intent that the containing resource is to be fetched as a whole from the host that provides it, and that the XPointer processing to extract the sub-resource is to be performed on the client, that is to say on the same system where the linking element is recognized and processed.

If the connector is "|", no intent is signaled as to what processing model is to be used to go about accessing the designated resource.

Note that the definition of a URI includes an optional query component.

In the case where the URI contains a query (to be interpreted by the server), information providers and authors of server software are urged to use queries as follows: Query Query'XML-XPTR=' ( XPointer | Name)

Link Recognition

The existence of a link is asserted by a linking element. Linking elements must be recognized reliably by application software in order to provide appropriate display and behavior. There are several ways link recognition could be accomplished: for example, reserving element type names, reserving attributes names, leaving the matter of recognition entirely up to stylesheets and application software, or using the XLink namespace to specify element names and attribute names that would be recognized by namespace and XLink-aware processors. Using element and attribute names within the XLink namespace provides a balance between giving users control of their own markup language design and keeping the identification of linking elements simple and unambiguous.

The two approaches to identifying linking elements are relatively simple to implement. For example, here's how the HTML A element would be declared using attributes within the XLink namespace, and then how an element within the XLink namespace might do the same: <A xlink:type="simple" xlink:href="http://www.w3.org/TR/wd-xlink/" xlink:title="The Xlink Working Draft">The XLink Working Draft.</A> <xlink:simple href="http://www.w3.org/TR/wd-xlink/" title="The XLink Working Draft">The XLink Working Draft</xlink:simple> Any arbitrary element can be made into an XLink by using the xlink:type attribute. And, of course, the explicit XLink elements may be used, as well. This document will go on to describe the linking attributes that are associated with linking elements. It may be assumed by the reader that these attributes would require the xlink namespace prefix if they existed within an arbitrary element, or that they may be used directly if they exist within an explicit Xlink element.

Linking Attributes

XLink has several attributes associated with the variety of links it may represent. These attributes define four main concepts: locators, arcs, behaviors, and semantics. Locators define where the actual resource is located. Arcs define the traversal of links. Where does the link come from? Where does it go to? All this information can be stored in the arc attributes. Behaviors define how the link is activated, and what the application should do with the resource being linked to. Semantics define useful information that the application may use, and enables the link for such specalized targets as constricted devices and accessibility software.

Locator Attributes

The only locator attribute at this time is href. This attribute must contain either a string in the form of a URI that defines the remote resource being linked to, a string containing a fragment identifier that links to a local resource, or a string containing a URI with a fragment identifier concacenated onto it.

Arc Attributes

Arcs contain two attributes, from and to. The from attribute may contain a string containing the content of a role attribute from the resource being linked from. The purpose of the from attribute is to define where this link is being actuated from.

The to attribute may contain a string containing the content of a role attribute from the resource being linked to. The purpose of the to attribute is to define where this link traverses to.

The application may use this information in a number of ways, especially in a complex hypertext system, but it is mainly useful in providing context for application behavior.

Behavior Attributes

There are two attributes associated with behavior: show and actuate. The show attribute defines how the remote resource is to be revealed to the user. It has three options: new, parsed, and replace. The new option indicates that the remote resource should be shown in a new window (or other device context) without replacing the previous content. The parsed option, relating directly to the XML concept of a parsed entity, indicates that the content should be integrated into the document from which the link was actuated. The replace option is the one most commonly seen on the World Wide Web, where the document being linked from is entirely replaced by the object being linked to.

The actuate attribute defines how the link is initiated. It has two options: user and auto. The user option indicates that the link must be initiated by some sort of human-initiated selection, such as clicking on an HTML anchor. The auto option indicates that the link is automatically initiated when the application deems that the user has reached the link. It then follows the behavior set out in the show option.

Semantic Attributes

There are two attributes associated with semantics, role and title. The role attribute is a generic string used to describe the function of the link's content. For example, a poem might have a link with a role="stanza". The role is also used as an identifier for the from and to attributes of arcs.

The title attribute is designed to provide human-readable text describing the link. It is very useful for those who have text-based applications, whether that be due to a constricted device that cannot display the link's content, or if it's being read by an application to a visually-impaired user, or if it's being used to create a table of links. The title attribute contains a simple, descriptive string.

Linking Elements

There are several kinds of linking elements in XLink: simple links, locators, arcs, and extended links. These elements may be instantiated via element declarations from the XLink namespace, or they may be instantiated via attribute declarations from the XLink namespace. Both kinds of instantiation are described in the definition of each linking element.

The simple link is used to declare a link that approximates the functionality of the HTML A element. It has, however, a few added features to increase its value, including the potential declaration of semantics and behavior. The locator elements are used to define the resource being linked to. Some links may contain multiple locators, representing a choice of potential links to be traversed. The arcs are used to define the traversal semantics of the link. Finally, an extended linking element differs from a simple link in that it can connect any number of resources, not just one local resource (optionally) and one remote resource, and in that extended links are more often out-of-line than simple links.

Simple Links

The following are two examples of linking elements, each showing all the possible attributes that can be associated with a simple link. Here is the explicit XLink simple linking element. <!ELEMENT xlink:simple ANY> <!ATTLIST xlink:slink href CDATA #REQUIRED role CDATA #IMPLIED title CDATA #IMPLIED show (new|parsed|replace) "replace" actuate (user|auto) "user" > And here is how to make an arbitrary element into a simple link. <!ELEMENT xlink:simple ANY> <!ATTLIST foo xlink:type (simple|extended|locator|arc) #FIXED "simple" xlink:href CDATA #REQUIRED xlink:role CDATA #IMPLIED xlink:title CDATA #IMPLIED xlink:show (new|parsed|replace) "replace" xlink:actuate (user|auto) "user" > Here is how the first example might look in a document: <xlink:simple href="http://www.w3.org/TR/wd-xlink" role="working draft" title="The XLink Working Draft" show="replace" actuate="user"> The XLink Working Draft.</xlink:simple> <foo xlink:href="http://www.w3.org/TR/wd-xlink" xlink:role="working draft" xlink:title="The XLink Working Draft" xlink:show="new" xlink:actuate="user"> The XLink Working Draft.</foo> Alternately, a simple link could be as terse as this: <foo xlink:href="#stanza1">The First Stanza.</foo>

There are no constraints on the contents of a simple linking element. In the sample declaration above, it is given a content model of ANY to illustrate that any content model or declared content is acceptable. In a valid document, every element that is significant to XLink must still conform to the constraints expressed in its governing DTD.

Note that it is meaningful to have an out-of-line simple link, although such links are uncommon. They are called "one-ended" and are typically used to associate discrete semantic properties with locations. The properties might be expressed by attributes on the link, the link's element type name, or in some other way, and are not considered full-fledged resources of the link. Most out-of-line links are extended links, as these have a far wider range of uses.

Extended Links

An extended link differs from a simple link in that it can connect any number of resources, not just one local resource (optionally) and one remote resource, and in that extended links are more often out-of-line than simple links.

These additional capabilities of extended links are required for:

Enabling outgoing links in documents that cannot be modified to add an inline link

Creating links to and from resources in formats with no native support for embedded links (such as most multimedia formats)

Applying and filtering sets of relevant links on demand

Enabling other advanced hypermedia capabilities

Application software might be expected to provide traversal among all of a link's participating resources (subject to semantic constraints outside the scope of this specification) and to signal the fact that a given resource or sub-resource participates in one or more links when it is displayed (even though there is no markup at exactly that point to signal it).

A linking element for an extended link contains a series of child elements that serve as locators and arcs. Because an extended link can have more than one remote resource, it separates out linking itself from the mechanisms used to locate each resource (whereas a simple link combines the two).

The xlink:type attribute value for an extended link must be extended, if the link is being instantiated on an arbitrary element. Note that extended links introduce variants of the show and actuate behavior attributes. These attributes, the showdefault and actuatedefault define the same behavior as their counterparts. However, in this case, they are considered to define the default behavior for all the linking elements that they contain.

However, when a linking element within an extended link has a show or actuate attribute of its own, that attribute overrides the defaults set on the extended linking element.

The extended linking element itself retains those attributes relevant to the link as a whole, and to its local resource if any. Following are two sample declaration for an extended link. The first is an example of the explicit XLink extended link: <!ELEMENT xlink:extended ((xlink:arc | xlink:locator)*)> <!ATTLIST xlink:extended role CDATA #IMPLIED title CDATA #IMPLIED showdefault (new|parsed|replace) #IMPLIED actuatedefault (user|auto) #IMPLIED > The second is an example of an arbitrary element being used an extended link: <!ELEMENT foo ((xlink:arc | xlink:locator)*)> <!ATTLIST foo xlink:type (simple|extended|locator|arc) #FIXED "extended" xlink:role CDATA #IMPLIED xlink:title CDATA #IMPLIED xlink:showdefault (new|parsed|replace) #IMPLIED xlink:actuatedefault (user|auto) #IMPLIED > The following two examples demonstrate how each of the above might appear within a document instance. Note that the content of these examples would be other elements. For brevity's sake, they've been left blank. The first example shows how the link might appear, using an explicit XLink extended link: <xlink:extended role="address book" title="Ben's Address Book" showdefault="replace" actuatedefault="user"> ... </xlink:extended> And the second shows how the link might appear, using an arbitrary element: <foo xlink:type="extended" xlink:role="address book" xlink:title="Ben's Address Book" xlink:showdefault="replace" xlink:actuatedefault="user"> ... </foo>

Arc Elements

An arc is contained within an extended link for the purpose of defining traversal behavior. More than one arc may be associated with a link. Otherwise, arc elements function exactly as the arc attributes might lead on to expect.

Conformance

An element conforms to XLink if:

The element has an xml:link attribute whose value is one of the attribute values prescribed by this specification, and

the element and all of its attributes and content adhere to the syntactic requirements imposed by the chosen xml:link attribute value, as prescribed in this specification.

Note that conformance is assessed at the level of individual elements, rather than whole XML documents, because XLink and non-XLink linking mechanisms may be used side by side in any one document.

An application conforms to XLink if it interprets XLink-conforming elements according to all required semantics prescribed by this specification and, for any optional semantics it chooses to support, supports them in the way prescribed.

Unfinished Work Structured Titles

The simple title mechanism described in this draft is insufficient to cope with internationalization or the use of multimedia in link titles. A future version will provide a mechanism for the use of structured link titles.

References Eve Maler and Steve DeRose, editors. XML Pointer Language (XPointer) V1.0. ArborText, Inso, and Brown University. Burlington, Seekonk, et al.: World Wide Web Consortium, 1998. (See http://www.w3.org/TR/WD-xptr .) ISO (International Organization for Standardization). ISO/IEC 10744-1992 (E). Information technology - Hypermedia/Time-based Structuring Language (HyTime). [Geneva]: International Organization for Standardization, 1992. Extended Facilities Annex. [Geneva]: International Organization for Standardization, 1996. (See http://www.ornl.go v/sgml/wg8/hytime/html/is10744r.html ). IETF (Internet Engineering Task Force). RFC 1738: Uniform Resource Locators. 1991. (See http://www.w3.org/Addressing/rfc1738.txt). IETF (Internet Engineering Task Force). RFC 1808: Relative Uniform Resource Locators. 1995. (See http://www.w3.org/Addressing/rfc 1808.txt ). C. M. Sperberg-McQueen and Lou Burnard, editors. Guidelines for Electronic Text Encoding and Interchange. Association for Computers and the Humanities (ACH), Association for Computational Linguistics (ACL), and Association for Literary and Linguistic Computing (ALLC). Chicago, Oxford: Text Encoding Initiative, 1994. ]Steven J. DeRose and David G. Durand. 1995. "The TEI Hypertext Guidelines." In Computing and the Humanities 29(3). Reprinted in Text Encoding Initiative: Background and Context, ed. Nancy Ide and Jean ronis , ISBN 0-7923-3704-2.