[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]
Subject: [chairs] Unique OASIS document identifiers
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
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]
Powered by eList eXpress LLC