Part 1: Filenames, URIs, Namespaces
Part 2: Metadata and Versioning
Date: 2007-03-31
Editor: Robin Cover
Version: 07
This Version: http://docs.oasis-open.org/specGuidelines/namingGuidelines/resourceNamingV07.html
Latest Version: http://docs.oasis-open.org/specGuidelines/namingGuidelines/resourceNaming.html
Previous Version: http://docs.oasis-open.org/specGuidelines/namingGuidelines/resourceNamingV06a.html
Status: The OASIS Board has approved the Guidelines for use as of 2006-08-02; OASIS Staff is authorized to update the guidelines from time to time as needed.
Review Comments: send to robin@oasis-open.org
This draft "Guidelines for Filenames, URIs, and Namespaces" presents the principal content from the document of 2006-06-30, limited to the statement of provisional rules. Commentary and examples are now provided, also unofficially, in "Commentary on Guidelines for Filenames, URIs, and Namespaces." Guidelines for the creation and use of metadata are being prepared as of 2006-07.
"Name Characters" here refers to characters used in URIs — including filenames, directory names, colon- or slash-delimited components within namespace URIs, delimiters, and possibly other URI subcomponents as may be labeled.
"Name construction" here refers to the lexical and syntactic structure of names, given the restricted character inventory. Motivations for the constraints include concerns for fidelity of interchange across file systems, minimizing the risks of common text-processing errors, usability (visual clarity), and other data QA. In other cases, arbitrary restriction of unbounded variablity serves the goal of simplicity through uniformity.
[Update 2006-09-30: see now OASIS Naming Guidelines: Metadata and Versioning]
ASIS document sections on metadata have been removed in this document, as metadata design has been targeted for work as a separate design effort
Version 07
Changed document title from "Guidelines for Filenames, URIs, Namespaces, and Metadata" to "OASIS Naming Guidelines: Filenames, URIs, Namespaces", to clarify that the OASIS Naming Guidelines is (as of 2007-03) in two parts. The companion document is OASIS Naming Guidelines: Metadata and Versioning
Added Specification URIs Model Example to show what a typical specification title page should include for Specification URIs.
Added a new section "Latest Version" URIs for Schemas, WSDLs, RDDLs, and Other Specification Components to provide guidance on the design and use of version-agnostic URIs for XML schemas and related ancillary file types. The corresponding rule in Part 1 for URI aliasing strategies was updated.
Added a new paragraph and reference to the draft RDDL Template in the section Metadata in Namespace Documents, suggesting required elements in RDDL namespace documents.
Improved the wording about URI and resource permanence, clarifying that resources installed on the file system (instantiated as regular files, directories, symbolic links) and associated with published (viz., publicly visible) URIs may not be altered by deletion, overwriting, renaming/moving, or by any other action which severs the relationship between the URI and the resource.
Clarified the rule about allowance for URN-based namespaces to remind TC editors that OASIS has no current plans to implement the online resolution system for URNs referenced in IETF RFC 3121.
Added a new rule about avoiding URI collision/confusion and semantic overloading at the point of a XML Namespace URI which could be mistaken for a regular directory URI, or vice versa: design of directory URIs and NS URIs should avoid contention by not storing resources at a collision point.
Added a new guideline about the preferred use of path components for creating new sets of specification URIs as a prose specification document and supporting files (e.g., XML schemas, DTD, WSDL, RDDL) progress through various stages and revisions.
Version 06a:
Added notes 2006-09-30 to reference the document supplement OASIS Naming Guidelines: Metadata and Versioning
Core content is identical to Version 06 with: (1) deletion of all instances of the section header text "Issues Resolved, Near Resolution, or with Substantial Agreement", per Board directive of 2006-08-02; (2) removal of the word "Draft" in the title; (3) update of the "Status" note; (4) minor cosmetic and administrative edits; (5) added note about versioning guidelines.
Version 06: added note about the meaning of tcShortName
Version 05: original posted version based upon 2006-06-30 combined document