This document defines the Resource Directory Description Language (RDDL). A Resource Directory provides a text description of some class of resources and of individual resources related to that class. It also contains a directory of links to these related resources. An example of a class of resources is that defined by an XML Namespace. Examples of such related resources include schemas, stylesheets, and executable code. A Resource Directory Description is designed to be suitable for service as the body of a resource returned by dereferencing a URI serving as an XML Namespace name.
The Resource Directory Description Language is an extension of XHTML Basic
1.0 with an added element named resource.
This element serves as an XLink to the referenced resource, and contains
a human-readable description of the resource and machine readable links which describe
the purpose of the link and the nature of the resource being linked to.
The nature of the resource being linked to is indicated by the xlink:role attribute and the purpose of the link is indicated by the xlink:arcrole attribute.
A DTD for RDDL has been defined using Modularization for XHTML.
This document defines the syntax and semantics of the Resource Directory Description Language 1.0,
and also serves as a Resource Directory Description for the namespace http://www.rddl.org/.
This specification is subject to change without notice however each version is associated with a version specific URI.
Version specific RDDL namespace URIs are named as: "http://www.rddl.org/" + YYYYMMDD.
The Resource Directory Description Language was initially proposed and specified after discussion on the XML-DEV mailing list. Descriptions of the origins and historical context of RDDL may be found at the XML Cover Pages, <?xmlhack?>, and xml.com. Many people have contributed to RDDL.
This document has no official standing and has not been considered nor approved by any organization.
Related resources have a nature, a machine-readable label provided by
the value of the xlink:role attribute.
For example, the nature of an XML Schema designed for use with a namespace
would be given as xlink:role="http://www.w3.org/2000/10/XMLSchema".
In cases where there is only one resource with a particular nature, the purpose of the linked resource may be inferred from this nature. For example, if there is only one related resource for a particular namespace whose nature indicates that it is a schema, processing software might infer that its purpose is to validate elements in that namespace.
Related resources may have a purpose, a machine-readable label
provided by
the value of the xlink:arcrole attribute.
The purpose is designed to convey the intended usage of the related resource.
For example, two related resources might have natures that indicate they
are both schemas, but the purposes might indicate that one is designed to
validate
the "strict" version of the language, the other the "forgiving" form.
The base URI of a RDDL document may be specified according to the W3C XML Base recommendation.
The xml:base attribute may be specified on the root html element or on a rddl:resource element.
The language of a RDDL document may be specified by the xml:lang attribute on the html element or on a rddl:resource element.
An html tag in an XHTML document may specify both lang and xml:lang attributes,
but the lang attribute is not used by RDDL processors.
rddl:resource ElementThe resource element is in a namespace whose name
is http://www.rddl.org/.
In this discussion, we assume the use of the namespace prefix
rddl, and refer to this element as rddl:resource.
The rddl:resource element represents a simple xlink, using the
attributes defined in the XLink namespace.
The rddl:resource must occur in the content of the HTML body element.
In the RDDL DTD, the XHTML %Flow.mix entity has been
redefined to contain rddl:resource so it roughly may be placed anywhere a p element may be placed.
The rddl:resource element itself uses the %Flow.mix content model, and should have human-readable content
which describes the associated resource.
Here is a DTD fragment declaring the rddl:resource element,
edited for clarity.
<!ELEMENT rddl:resource (#PCDATA | %Flow.mix;)*> <!ATTLIST rddl:resource id ID #IMPLIED xml:lang NMTOKEN #IMPLIED xml:base CDATA #IMPLIED xmlns:rddl CDATA #FIXED "http://www.rddl.org/" xlink:type (simple) #FIXED "simple" xlink:arcrole CDATA #IMPLIED xlink:role CDATA "http://www.rddl.org/#resource" xlink:href CDATA #IMPLIED xlink:title CDATA #IMPLIED xlink:embed CDATA #FIXED "none" xlink:actuate CDATA #FIXED "none" > |
rddl:resourceThe value of this attribute must be a URI reference. A URI reference may contain a URI part and a fragment identifier. Per XLink, when present the URI part must be an absolute URI. It provides a machine-readable identifier for the nature of the related resource. Software may dispatch on this value.
When the related resource is an XML language for which a namespace name has been defined, and for which the namespace name adequately distinguishes the nature of the resource, the namespace name should be used as its nature.
When the related resource is not an XML document but is adequately distinguished by a MIME type, the value of the
xlink:role attribute may reflect this MIME type with values formed by the concatenation of the prefix
http://www.isi.edu/in-notes/iana/assignments/media-types/ with a MIME type e.g.
http://www.isi.edu/in-notes/iana/assignments/media-types/text/css.
It is anticipated that many related-resource natures will be well known. A list of well-known natures may be found in the RDDL directory http://www.rddl.org/natures.html.
If no nature is provided for a related resource, the default value is
http://www.rddl.org/#resource.
The value of this attribute must be a URI reference. A URI reference may contain a URI part and a fragment identifier. Per XLink, when present the URI part must be an absolute URI. It provides a machine-readable identifier for the purpose of the link to the related resource. Software may dispatch on this value.
It is anticipated that the purposes of many related resources will be well known. A list of well-known purposes may be found in the RDDL directory http://www.rddl.org/purposes.html.
This XLink locator attribute's value is a URI reference to the target related resource.
A human readable short descriptive title. This should be specified but not be seen as a replacement for descriptive content.
The xlink:type is always "simple" in this version of the specification.
Not used. The only legal value is "none".
The xml:lang attribute value may be provided to specify the
human language of the resource and descriptive text.
Where possible, human-readable descriptions should be provided in multiple languages.
Human readable descriptions in multiple languages can be provided using child div elements each labelled accordingly.
The xml:base attribute may be applied to the resource element.
The id attribute value may be used to give the resource description a name.