This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Draft proposal: new Uri element
- From: Michael Smith <smith at xml-doc dot org>
- To: docbook at lists dot oasis-open dot org
- Cc: Elliotte Rusty Harold <elharo at metalab dot unc dot edu>
- Date: Tue, 18 Mar 2003 18:45:19 +0900
- Subject: Draft proposal: new Uri element
Below is a draft proposal for a new 'uri' element, based mostly on an
informal proposal that Elliotte Rusty Harold posted to this list several
months ago.
I have submitted this for discussion with other members of the DocBook
Technical committee during our monthly telcon today.
If you have comments on the proposal, please post them to this list.
For background on this discussion, please see the following archived
messages:
http://sources.redhat.com/ml/docbook/2002-05/msg00105.html
http://sources.redhat.com/ml/docbook/2002-08/msg00157.html
----------------------------------------------------------------------
Uri -- A Uniform Resource Identifier (URI)
1. Description
--------------
A Uri is a literal Uniform Resource Identifier (URI)
that appears inline in the main narrative flow of a
document. It is not a link or cross-reference.
1.1 Processing expectations
Unlike the Ulink element, Uri is not rendered as
an actual hyperlink to the content found at the
location it references. Instead, it appears as
literal text, perhaps distinguished
typographically (for example, in monospace or
italic type).
2. Synopsis
-----------
2.1 Content model
-----------------
uri ::=
(#PCDATA)
2.2 Attributes
--------------
common attributes, plus the following:
class Enumeration: Default:
url none
urn
type CDATA none
2.3 Parameter Entities
----------------------
%tech.char.class
Note: Adding the Uri element to %tech.char.class will
make Uri valid anywhere where Systemitem is
valid.
3. Attributes discussion
------------------------
Class
Specifies whether the URI is a Uniform Resource
Locator (URL) or a Uniform Resource Name (URN).
Type
Specifies the type of URI. This attribute is
provided as a means for users to distinguish
categories of URIs from one another. For example,
the following set of potential values might be
useful under certain circumstances:
* xmlNamespace
* saxFeatureName
* saxPropertyName
* jaxpFeatureName
* soapAction
* rddlPurposes
* rddlNature
4. Examples
-----------
The correct system identifier to use when referring to
the Web location of the DocBook 4.2 DTD is <uri
>http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd</uri>.
----------------------------------------------------------------------