OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

xacml message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: XACML and OASIS document and naming guidelines


Prompted by Erik's question about formatting, naming, etc. of the 
delegation work, I went through the naming guidelines document and the 
specification format guidelines and tried to pull out what is relevant 
to our specifications with XACML examples.  Since the guidelines provide 
little guidance on specification titles or file name syntax, I have 
proposed a syntax for consistency.

Please let me know if there are other topics we need to agree on, if you 
disagree with any of the proposals, or if you have other comments on this.

Anne H. Anderson             Email: Anne.Anderson@Sun.COM
Sun Microsystems Laboratories
1 Network Drive,UBUR02-311     Tel: 781/442-0928
Burlington, MA 01803-0902 USA  Fax: 781/442-1692
Title: XACML and OASIS Guidelines

XACML and OASIS Guidelines

This is a review of OASIS Document and Naming Guidelines for applicability to XACML specifications, schemas, and names. It is based on the following references:

Reviewer:  Anne Anderson 
Version:   1.2
Updated:   06/09/28 (yy/mm/dd)


Introduction and General Notes

These guidelines apply only to documents to be stored under http://docs.oasis-open.org, so do not apply to our Working Drafts, although it will be easier to convert Working Drafts to the required format if they conform.

No names of schema elements, etc. are affected.

No underscores are allowed in names unless absolutely necessary, but camel case is allowed if you want.

Specification Format

OASIS provides specification templates at http://docs.oasis-open.org/templates/. The detailed instructions are only in Word and PDF formats under the "Microsoft Word Specification Template" section of the page.

Changes from older versions:

Specification Titles

There is no guidance on specification titles other than

  [Specification Title vX.X]

I propose:

File Names, and "Document Identifier"

Similarly there is not much guidance about document titles or file names. The following fit the guidelines, and will let our documents follow a consistent naming pattern.

General rough syntax for file names:

  xacml-<xacml version>-<topic>-<doctype>-<stage>-<draft version>-<language>.<format>

The "Document Identifier" is everything up through <draft version>.



  Core spec:      xacml-3.0-core-spec-wd-1-en.odt
  Core schema:    xacml-3.0-core-schema-policy-wd-1.xml

Profiles should identify the version of what is being profiled if relevant:

  Profile:        xacml-2.0-profile-ws-policy-1.0-spec-wd-1-en.odt
  Profile schema: xacml-2.0-profile-ws-policy-1.0-schema-wd-1.xml
  Profile:        xacml-2.0-profile-saml-2.0-spec-wd-1-en.odt

If we update a profile, give it an new version (v2, v3, etc.)

  Profile:        xacml-2.0-profile-saml-2.0-v2-spec-wd-1-en.odt
  Profile schema: xacml-2.0-profile-saml-2.0-v2-schema-assertion-wd-1.xml

"Persistent location"

OASIS administration will put documents under:



We can continue to use:




They recommend URIs of the following form:


Anne Anderson <Anne.Anderson@sun.com>
Last modified: Thu Sep 28 12:49:04 EDT 2006

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]