RE: [dss] Naming convention proposal

[Tim Moses <tim.moses@entrust.com>]

Nick - I have done my usual cursory research and concluded that there is no
common solution on which to draw.  The chairs did produce a draft proposal
for naming documents only.  It is linked from the OASIS Web page, but the
link didn't function when I tried it earlier this week.  Some on the chairs
list seem to think that the TAB or the OASIS board is progressing that work.
But, the out-going chair of the TAB thinks anyone holding that view is
mistaken.

For the time-being, while we have more than one author, and if we want
consistency amongst our names, it looks like we'll have to define our own
convention.

In the meantime, I did make some small revisions to my proposal, and the
latest version is included below.

All the best.  Tim.


Object naming guidelines

Basic form:

URI - "http://www.oasis-open.org/tc"/committee/major-version/
part/object/status/version.extension

Note: OASIS should ensure that (where appropriate) the object or information
about the object is retrieved by an HTTP GET operation using this URI.  It
is not currently possible to achieve this within KAVI.

Document identifier -
"oasis-tc"-committee-major-version-part-object-status-version.extension

Name of a file when not in a hierarchical file system -
"oasis-tc"-committee-major-version-part-object-status-version.extension

committee
The lower-case initials of the full name of the committee as listed on the
OASIS Web page.  (OASIS should ensure that no name clashes occur.)

major-version - "v"x.y
The proposed version number of the final committee specification with which
the document is associated.

part
	The name of a project sub-part (e.g. "core" or a profile name).

object
	Specification - "spec"
	Schema - "schema"
	Data model - "data-model"
	Attribute definition - "attribute"
	Conformance criteria - "conformance"
etc..

Note: No such list will ever be exhaustive.  A good attempt should be made
to complete the list.  But oftentimes, committees will have to define their
own special-purpose objects.  And any inconsistency that may arise will just
have to be accepted.

status
	Working draft - "wd"
	Committee specification - "cs"
	OASIS specification - "os" 

version - "v"x
x increments from 01.
Note: This component must be omitted from the final version of an object.

extension
	".doc"
	".pdf"
	".xsd"
	etc.

Note: each committee is responsible for ensuring that no name clashes occur
within the portion of a name over which they have control.

Example:

URI -
http://www.oasis-open.org/tc/dss/v1.0/timestamp-token/schema/wd/v01.xsd



-----Original Message-----
From: Nick Pope [mailto:pope@secstan.com]
Sent: Tuesday, August 26, 2003 10:32 AM
To: Rich Salz; Tim Moses
Cc: 'DSS'
Subject: RE: [dss] Naming convention proposal


I am very supprised that we are the first to get into this issue.  How do
other existing OASIS schema identify themselves?  Doesn't the OASIS web
master need to be involved so that the refences point to real objects?

Nick


> -----Original Message-----
> From: Rich Salz [mailto:rsalz@datapower.com]
> Sent: 25 August 2003 17:11
> To: Tim Moses
> Cc: 'DSS'
> Subject: Re: [dss] Naming convention proposal
>
>
> > Colleagues - Below, find a proposal for a convention for naming
> the objects
> > we will define.  To the best of my knowledge, this does not
> conflict with
> > any OASIS convention (indeed, we could lobby for this to become
> the OASIS
> > convention).  Any comments?  All the best.  Tim.
>
> Brilliant.  Lobbying is called for.  My only suggestion is to insert a
> fixed RDN before the committee part, so that it's easier to write a
> single URL redirection rule; the actual value doesn't matter.  But the
> example:
>    http://www.oasis-open.org/dss/v1.0/schema/timestamp-token/wd/v01.xsd
> could become something like (adding "/tc"):
>    http://www.oasis-open.org/tc/dss/v1.0/schema/timestamp-token/wd/v01.xsd
>
> You may leave a Technical Committee at any time by just sitting on yours
> hands....
>
> 	/r$
>
> --
> Rich Salz, Chief Security Architect
> DataPower Technology                           http://www.datapower.com
> XS40 XML Security Gateway   http://www.datapower.com/products/xs40.html
> XML Security Overview  http://www.datapower.com/xmldev/xmlsecurity.html
>
>
> You may leave a Technical Committee at any time by visiting
http://www.oasis-open.org/apps/org/workgroup/dss/members/leave_workgroup.php