Re: [chairs] Unique OASIS document identifiers

[Rex Brooks <rexb@starbourne.com>]

Hi,

Having just completed such a document, which is now in the 30-day 
public comment period, HumanMarkup TC's first such document, I had 
planned to send a message or some messages to the spectools list on 
sevral issues related to this. So my first question is: Should I post 
those messages or an issue list, here?

The HumanMarkup TC's regular monthly telecon is next Wednesday, and 
this is the first weekend I've had without one or another document, 
list, item or other issue hasn't been claiming my attention. So I'm 
writing mainly to give you all a heads up that I will be airing the 
list of concerns I ran into, but it won't be until next week some 
time.

I can say that my main concerns are:

* namespace consistency in declarations and imports with some 
concerns about urns and schema locations that I noticed while 
researching practices;

* the issue you address here, e.g.,  document title shorthand, 
version numbering and TC shortnames (changing our very long one is 
one item on our agenda for next week);

*  better and more consistent bibliographic referencing practices for 
which I have had some comments directed to me already this week...

There are others, but my main suggestions were going to be that we 
work on standardizing procedures and practices.

Thanks for bringing this up and for the suggested naming scheme. 
Offhand I would suggest that the practice of decimal notation appears 
to have a lot of inertia behind it.

Ciao,
Rex

At 4:32 PM -0500 11/15/02, Eve L. Maler wrote:
>Hello folks,
>
>Karl Best has suggested that I use this list to open up a quick 
>discussion on ways that all the OASIS TCs can get some consistency 
>out of the ways they identify their specs.
>
>There is a set of OASIS specification template instructions here, 
>which Norm Walsh and I put together a little while ago:
>
>http://www.oasis-open.org/spectools/docs/wd-spectools-instructions-01.html
>
>We were guessing a little bit on some of the guidelines therein, and 
>we're also not sure who exactly is following them.  Though it would 
>be great to get input on that document as a whole, the matter of 
>most importance right now is the piece of metadata called the 
>"document identifier".  It is discussed in this section:
>
>http://www.oasis-open.org/spectools/docs/wd-spectools-instructions-01.html#s.metadata
>
>A scheme is proposed for assigning document identifiers (which are 
>intended to be used as the root of a filename, with the extension 
>reflecting the format used in the file).  The SAML TC and the UBL 
>Naming and Design Rules subcommittee have been trying to apply this 
>scheme as best they can, but experience has shown that it needs some 
>tweaking. I'm hoping you all can help in this endeavor.
>
>I'd like to propose the following scheme instead, and suggest that 
>we conduct an email discussion on this topic until December 2.  At 
>that time, I'll summarize and try to propose a revision of the 
>specification template instructions.
>
>	Eve
>
>			*		*		*
>
>- For contributions and proposals that are outputs of one or
>   more individuals/organizations but are not an output of the
>   TC in question:
>
>   p-{name_of_proposer}-{description}-nn
>
>   Where:
>
>   name_of_proposer
>     Is typically the last name of the main individual making
>     the proposal.
>
>   description
>     Is some descriptive text, possibly with embedded hyphens,
>     that identifies the proposal.
>
>   nn
>     Is a monotonically increasing number starting from 00
>     representing the revision of the document.
>
>- For outputs of a TC:
>
>   {type}-{name_of_TC}-{description}-nn
>
>   Where:
>
>   type
>     wp=white paper
>     wd=working draft (may not have reached consensus, is in progress)
>     cs=committee spec (has had 2/3 positive vote)
>     This list is not closed, but new type keywords should be added
>     only advisedly, and hopefully only after consultation with the
>     chairs list.
>
>   name_of_TC
>     Is some canonical shorthand for the TC name, or possibly one
>     of its subcommittees (though this may make the name too long).
>
>- For OASIS Standards:
>
>   {name_of_TC}-{description}-Vnn
>
>   Where:
>
>   Vnn
>     Is a representation of the version of the Standard, however the
>     TC wants to reflect that.
>
>Examples:
>
>wp-ubl-codelist-01
>   Is the second revision of the UBL TC's Code List white paper.
>
>cs-sstc-core-00
>   Is the first revision of the Security Services TC's core
>   specification in Committee Specificiation form.
>
>sstc-samlcore-v10
>   Is the SAML V1.0 core specification in OASIS Standard form.
>   (I've added "saml" to the description because "sstc" doesn't
>   mean much to some people).
>
>p-smith-docbooklinks-17
>   Is the seventeenth revision of Smith's proposal for DocBook
>   linking.
>
>--
>Eve Maler                                        +1 781 442 3190
>Sun Microsystems                            cell +1 781 354 9441
>Web Technologies and Standards               eve.maler @ sun.com
>
>
>----------------------------------------------------------------
>To subscribe or unsubscribe from this elist use the subscription
>manager: <http://lists.oasis-open.org/ob/adm.pl>


-- 
Rex Brooks
Starbourne Communications Design
1361-A Addison, Berkeley, CA 94702 *510-849-2309
http://www.starbourne.com * rexb@starbourne.com