Working Draft 01, 26 Apr 2002
- Editors:
- Norman Walsh <Norman.Walsh@Sun.COM>
Eve Maler <Eve.Maler@Sun.COM>
- Contributor:
- Best Karl, OASIS
- Status:
This is a Working Draft.
If you have comments about this document, please send them to Eve Maler <Eve.Maler@Sun.COM> and Norman Walsh <Norman.Walsh@Sun.COM>.
Copyright © 2002 The Organization for the Advancement of Structured Information Standards [OASIS]
Table of Contents
- 1. Introduction
- 2. Terminology
- 3. Standard Metadata
- 4. DocBook Specifications
- 5. Office Specifications
- 6. XHTML Specifications
- 7. Styling OASIS Standards
Appendixes
This document lays out the recommended best practices for writing OASIS standards-track documents in DocBook, "Office" applications, and XHTML.
This document is an instance of itself, that is to say, the XML source for this document is in DocBook and satisfies the recommendations specified herein.
The key words must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this document are to be interpreted as described in [RFC 2119].
Some specifications may choose to capitalize these words, or use other typographic conventions to make them stand out and to separate their use in a normative sense from their use in a natural-language sense. This document does not.
All standards-track documents must provide the following metadata:
- Title
The title of the document.
- Editorial Status
The editorial status of the document (Proposal, Working Draft, Committee Draft, Committee Specification, or OASIS Standard).
- Publication Date
The date of publication of this version of the document.
- Document Identifier
A unique identifier for the document. The recommended method for constructing a unique identifier is as follows:
{editorial status}-{committee name}-{short title}-{version}The standard abbreviations for the editorial status are, "p", "wd", "cd", and "cs" for Proposal, Working Draft, Committee Draft, and Committee Specification, respectively.
Proposals put forth by members of the committee should use some appropriate identifier based on the name(s) of the individual(s) instead of the committee name in the document identifier.
The unique identifier for documents with an editorial status of "Standard" may omit the editorial status indicator. They may also omit the version if the document title includes some form of version identifier.
Document identifiers provide a mechanism for distinguishing between multiple documents and multiple versions of the same document. Any given document may be available in several forms (XML, HTML, etc.) and related documents (versions with change bar markup, for example) may be also be available. Where appropriate, links should be provided to each of these parallel versions.
- Location
The location (base URI) of the "repository" where versions of this document can be retrieved.
- Editor(s)
The individuals credited as editors. This item is optional on documents that have authors.
- Author(s)
The individuals credited as authors. This item is optional on documents that have editors.
- Contributor(s)
The individuals credited with contributions (other than editorship or authorship) of this document. This item is optional.
- Abstract
A brief abstract of the document.
- Status
A statement of the status of the document. In addition to identifying the status, this section must include the email address to which comments should be sent. Documents published with an editorial status of "Committee Specification" or "Standard" must also include a link to the page where errata will be documented.
- Copyright
The OASIS copyright statement.
- Notices
The legal notices (intellectual property information, warranties, etc.) must be provided. In the interest of brevity on the title page, notices may be documented in an appendix.
OASIS standards-track documents encoded in DocBook can be styled with an [XSLT] processor to produce HTML or [XSL] versions. The HTML versions are styled by the appropriate OASIS CSS stylesheet. The XSL versions can subsequently be styled with an XSL Formatter to produce [PDF] and other hardcopy formats.
OASIS standards-track documents encoded in "Office" applications are styled by the appropriate OASIS template.
OASIS standards-track documents encoded in XHTML are styled by the appropriate OASIS CSS stylesheet.
A. OASIS Specification Tools (Non-Normative)
The following individuals helped in the formulation of this document:
Karl Best, OASIS
Eve Maler, Sun Microsystems
Norman Walsh, Sun Microsystems
B. Notices
Copyright © The Organization for the Advancement of Structured Information Standards [OASIS] 2001, 2002. All Rights Reserved.
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementors or users of this specification, can be obtained from the OASIS Executive Director.
OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS Executive Director.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document must be followed, or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS has been notified of intellectual property rights claimed in regard to some or all of the contents of this specification. For more information consult the online list of claimed rights.
Normative
[RFC 2119] IETF (Internet Engineering Task Force). RFC 2119: Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. 1997.
[XSLT] James Clark, editor. XSL Transformations (XSLT) Version 1.0. World Wide Web Consortium, 1999.
[XSL] Sharon Adler, Anders Berglund, Jeff Caruso, et. al., editors. Extensible Stylesheet Language (XSL) Version 1.0. World Wide Web Consortium, 2001.
Non-Normative
[PDF] Adobe Systems, Incorporated, editor. PDF Reference, Third Edition, Version 1.4. Addison Wesley. 0-201-75839-3. 2001.