Specification Template 1.0 (replace this!)

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document.

Although W3C has provided the template for this document for community use, the document is not affiliated with W3C in any way, and is not endorsed or approved by W3C.

This document is a draft of this specification, produced by an independent party. It is inappropriate to cite this specification as as a publication of the World Wide Web Consortium (W3C), or anything other than a work in progress by an independent entity.

Intent of this Specification

Briefly explain the rationale for writing this specification, its audience, and its intended use. For example, please state whether this specification constitutes a proposal to a particular Working Group.

Note: This template is intended as a format for proposals to W3C, but we recognize that it may be adapted for other uses by the community. A statement about any intent different than a proposal to W3C would be appropriate here.

Implementation Experience

Insert a short description of of existing implementation experience that informs this specification.

Changes Since the Previous Draft

Insert a list of substantive changes since the previous version of the specification, or state that no changes have been made.

Level of Endorsement by the Community

Please describe any community or organizational support enjoyed by the details of this specification.

Patent Information

Please describe the details of any known patents or other intellectual property which may affect the implementation of this specification, whether held by the author, the author's organization, or by any other party. Please state the terms by which these patents may be licensed, including whether they are potentially available under the Royalty Free 5 February 2004 W3C Patent Policy.

How to provide feedback

Please send comments on this specification to person-or-list@example.org.

Contents

1. 1. Introduction
2. 2. Conformance
3. 3. Use Cases and Requirements
   • 3.1. Use Cases
   • 3.2. Requirements
4. 4. Features
5. 5. Examples
6. 6. Security Considerations
7. 7. Glossary of Terms and Datatypes
8. 8. Schema
   • 8.1. RelaxNG Schema
   • 8.2. XML Schema
9. 9. References
   • 9.1. Normative References
   • 9.2. Informative References
10. 10. Acknowledgments

1. Introduction

This section is informative.

Describe the technology and specification here.

2. Conformance

This section is normative.

Describe different conformance classes here.

This document contains explicit conformance criteria that overlap with some RNG definitions in requirements. If there is any conflict between the two, the explicit conformance criteria are the definitive reference.

Within this specification, the key words "MUST, "MUST NOT", "REQUIRED, "SHALL, "SHALL NOT, "SHOULD, "SHOULD NOT", "RECOMMENDED, "MAY", and "OPTIONAL" are to be interpreted as described in RFC 2119 [RFC2119]. However, for readability, these words do not necessarily appear in uppercase in this specification.

3. Use Cases and Requirements

This section is informative.

3.1. Use Cases

The following usage scenarios illustrate some of the ways in which Specification Template might be used for various applications:

Insert Use Case 1: Explain use case 1.

Insert Use Case 2: Explain use case 2.

3.2. Requirements

Memory and processor requirements: What are the requirements on memory or processing resources?

Implementation commitments: How difficult, or what details are needed, for implementation?

Ease of authoring: What considerations need to be borne in mind for authors?

4. Features

This section is normative.

Please define the features of the specification here, including the necessary elements, attributes, attribute values, interfaces, methods, and other features.

Authors are encouraged to also describe features in terms of the IDL using Web IDL [WebIDL] blocks inline.

Note: Specification authors are encouraged to use the W3C Typographic Conventions for marking up and styling their documents.

5. Examples

This section is informative.

Provide examples of the usage of the technology here. Alternately, examples may be provided inline in the section on features, in which case, this section should be removed.

6. Security Considerations

This section is informative.

Provide security considerations for the implementation and authoring of this technology here.

7. Glossary of Terms and Datatypes

This section is normative.

Provide a glossary of terms and datatypes used in this specification.

8. Schema

Providing a schema is useful for machine processing of documents, be it document creation, transformation, or validation. Specification authors are encouraged to provide either or both of a RelaxNG or XML Schema, as appropriate. These schemas typically allow an author to more easily create a more expressive definition than with DTD (Document Type Definition).

8.1. RelaxNG Schema

Specification Template 1.0 provides a schema written in RelaxNG [RelaxNG], a namespace-aware schema language that uses the datatypes from XML Schema Part 2 [Schema2]. This allows namespaces and modularity to be much more naturally expressed than using DTD syntax. The RelaxNG schema for Specification Template 1.0 may be imported by other RelaxNG schemas, or combined with other schemas in other languages into a multi-namespace, multi-grammar schema using Namespace-based Validation Dispatching Language [NVDL].

Unlike a DTD, the schema used for validation is not hardcoded into the document instance. There is no equivalent to the DOCTYPE declaration. Simply point your editor or other validation tool to the IRI of the schema (or your local cached copy, as you prefer).

Please add a RelaxNG schema here, and link to external schema files, if made available.

8.2. XML Schema

Specification Template 1.0 provides a schema written in XML Schema [XMLSCHEMA], an XML schema language that uses the datatypes from XML Schema Part 2 [Schema2].

Please add an XML schema here, and link to external schema files, if made available.

9. References

9.1. Normative References

[RFC2119]

Key words for use in RFCs to Indicate Requirement Levels, S. Bradner, March 1997.
Available at http://tools.ietf.org/html/rfc2119.

[RELAXNG]

Document Schema Definition Languages (DSDL) — Part 2: Regular grammar-based validation — RELAX NG, ISO/IEC FDIS 19757-2:2002(E), J. Clark, 村田 真 (Murata M.), eds. International Organization for Standardization, 12 December 2002.
Available at http://www.y12.doe.gov/sgml/sc34/document/0362_files/relaxng-is.pdf.

[XMLSCHEMA]

XML Schema Part 1: Structures Second Edition, H. S. Thompson et al., eds., W3C Recommendation, 28 October 2004.
Available at: http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/
XML Schema Part 2: Datatypes Second Edition, P. V. Biron, A. Malhotra, eds., W3C Recommendation, 28 October 2004.
Available at: http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/

9.2. Informative References

[SCHEMA2]

XML Schema Part 2: Datatypes Second Edition. P. Biron, A. Malhotra, eds. World Wide Web Consortium, 28 October 2004. (See also Processing XML 1.1 documents with XML Schema 1.0 processors [XML11-SCHEMA].)
This edition of XML Schema Part 2 is http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/.
The latest edition of XML Schema Part 2 is available at http://www.w3.org/TR/xmlschema-2/.

[WebIDL]

WebIDL, C. McCormack, ed. World Wide Web Consortium, work in progress, 19 December 2008.
This edition of WebIDL is http://www.w3.org/TR/2008/WD-WebIDL-20081219/.
The latest edition of WebIDL is available at http://dev.w3.org/2006/webapi/WebIDL/.

10. Acknowledgments

The editors would like to acknowledge and thank the following people for substantive aid with this specification: list of names.