OASIS logo

OASIS Specification Checklist

This checklist is intended to be used by Technical Committee Chairs, Secretaries, Editors or any Member who is responsible for the creation and maintenance of TC work products. As per the OASIS TC Process, all specifications must conform to the OASIS-supplied templates and policies.Templates are located at http://docs.oasis-open.org/templates/ and are supplied in several versions along with a User's Guide. Policy references include the Guidelines for Filenames, URIs, Namespaces and Metadata and the OASIS Naming Guidelines: Metadata and Versioning policies. Please forward any comments or questions to OASIS TC Administration or your TC Staff Contact.

Click on the hypertext links for further information, details, and examples.

Metadata

Specification Title and Version

Stage and Revision

Date

URIs

TC Name

Note that this should be a hypertext link to the TC Public Home Page.

Chair(s)

Editor(s)

Related Work

Namespaces

Abstract

Boilerplate

Status

Conforms to the boilerplate content provided in the template.

IPR URI

Link is well-formed and hyperlink is activated

Comment URI

Link is well-formed and hyperlink is activated

Errata URI

Link is well-formed and hyperlink is activated

Notices

Legacy/Current

The proper Notices section has been used - if the official date of the document was prior to the IPR Transition Effective Date, the legacy notice should be used. Otherwise, use the 15 Apr 2005 Notices section.

Trademark Terms

List any names or abbreviations related to the TC or specification in the last paragraph of the Notices section. Remove instructions (located within the square brackets).

Copyright line

Hyperlinks

Activated

Any references to http URIs must be active hypertext links - that is, a reader with internet connectivity should be able to click on the link and retrieve the content stored at that location.

Appropriate Link Targets

Hypertext links must dereference to the appropriate target location - that is, a reader with internet connectivity should be able to to clink on the link and retrieve the content expected.

Footers

Document Identifier

This should be filename without any filetype extension.

Copyright

The full Copyright line should appear at the bottom of each page of a specification.

Date

The date corresponds to the official date of the document (see metadata, above) in the format DD Month YYYY

Page Numbers

All pages must be numbered "# of #"

Layout

OASIS Logo

Page Layout

The OASIS templates define an overall "look and feel" which must be adhered to. Elements such as graphics or tables should not run past the inner page boundaries or overset on other elements.

Colors

The OASIS color to be used for headings is #66116D (purple).

Typestyle

The default typestyle for OASIS Specifications is 10pt Arial. Running footers are set in 8pt Arial.

Formats

XHTML

Technical Committees who are using a desktop application to produce their specifications may have difficulty in producing valid XHTML. Please contact TC Administration for assistance.

Editable Source

This refers to the format used to actually author/edit the specification files. It may be a desktop application such as OpenOffice or Word, or a particular XML vocabulary/grammar such as DITA, DocBook, or XHTML.

PDF

PDF files should have the same level of functionality expected from a desktop application. Table of Contents entries should link to the appropriate pages, hypertext links should be navigable, internal cross-references should function as expected.

Filenames

Legal Characters

No files will be accepted with spacebands in filenames. Please refer to the Naming Guidelines for more details.

Filename Construction

Namespaces

Approved Format

URL

URN

Namespace Document

Schemas and XML Instances

Separate Files

Valid or Well-Formed

Contributors

Approved by members

The list of contributors should initially be compiled by the chairs/editors, however any member of the TC may add or remove their name upon request.

Organizational Affiliation

Organizational Member

Only organizational members are provided the benefit of listing their organizational affiliation

Individual / Associate

Individual or Associate members should be identified as "Member Name, Individual" or "MemberName, Associate" as appropriate.

References

Normative

Non-Normative

Conformance Clauses

Rules related to Conformance Clauses go into effect 1 June 2007. A Template update and Best Practices Guide will be issued before the effective date.