1
2 Sample
3 Working 2002
4 Document identifier:
5 wd-spectools-word-sample-04
6 Location:
7 to the xxx-comment@[Link] list. To subscribe, send an email message to
8 xxx-comment-request@[Link] with the word "subscribe" as the body of the
9 message.
10 [This is boilerplate; to use, fix the hyperlinks:] For information on whether any patents
11 have been disclosed that may be essential to implementing this specification, and any
12 offers of patent licensing terms, please refer to the Intellectual Property Rights section of
13 the XXX TC web page ([Link]
14 [If a Committee
15 Table of Contents
16 Introduction..................................................................................................................................... 3
17 1.1 Terminology.......................................................................................................................... 3
18 2 Word Styles............................................................................................................................ 4
19 2.1 Overall Style......................................................................................................................... 4
20 2.2 Title Page............................................................................................................................. 4
21 2.3 Headings.............................................................................................................................. 4
22 2.4 Paragraphs........................................................................................................................... 4
23 ]
24 Appendix A. Acknowledgments...................................................................................................... 7
25 Appendix B. Revision History.......................................................................................................... 8
26 Appendix C. Notices....................................................................................................................... 9
27
1 wd-spectools-word-sample-03 12 June 2002
2 Copyright © OASIS Open 2002. All Rights Reserved. Page 1 of 7
28 Introduction
29 [Provide an introductory chapter, indicating if any parts of it are non-normative.]
30 1.1 Terminology
31 [The following is boilerplate. Most specifications will need this and the corresponding bibliography
32 entry.] The key words must, must not, required, shall, shall not, should, should not,
33 recommended, may, and optional in this document are to be interpreted as described in
34 [RFC2119].
3 wd-spectools-word-sample-03 12 June 2002
4 Copyright © OASIS Open 2002. All Rights Reserved. Page 2 of 7
34 2 Word Styles
35 [This section is provided to explain and demonstrate the styles available in the Word template
36 attached to this sample document. It is important to use the styles provided in the template
37 consistently and to avoid defining new styles or using raw formatting.
38 Delete this entire section when using this sample document to begin writing a new specification.]
39 2.1 Overall Style
40 The paper size is set to Letter, which is 8 ½ x 11. You may change this to A4 or whatever other
41 size suits your needs.
42 The document identifier and publication date information in the footer needs to be updated every
43 time you publish.
44 Line numbers are enabled by default for easy reference by specification commenters. You may
45 turn line numbering off.
46 2.2 Title Page
47 The title page is designed to fit a lot of metadata compactly. If you wish to create a “true” title
48 page, you may insert a page break after the subtitle.
49 2.3 Headings
50 Heading 1 through Heading 9 and AppendixHeading have been defined with a special
51 appearance. Headings are numbered and appear in the Table of Contents. Pressing Return after
52 a heading inserts
53 List continue.
54 – List bullet 2
55 List continue 2.
56 For bibliography lists, use the Ref paragraph style. Use the Ref term character style for the
57 bracketed text that serves as the bibliography entry key, and make each reference term into a
58 bookmark for use as references from the text. For example, [RFC2119] is a generated cross-
59 reference to the IETF RFC 2119 bibliography entry in Section 3.1 of this sample.
60 2.4 Tables
61 Use the following style for most tables: [To be supplied; suggestions welcome!]
62 2.5 Code Examples
63 For schema code and other normative code, use the Code paragraph style. It fits 71 characters.
64 For example:
65 12345678901234567890123456789012345678901234567890123456789012345678901
66 1 2 3 4 5 6 7
67 <simpleType name="DecisionType">
68 <restriction base="string">
69 <enumeration value="Permit"/>
70 <enumeration value="Deny"/>
71 <enumeration value="Indeterminate"/>
72 </restriction>
5 wd-spectools-word-sample-03 12 June 2002
6 Copyright © OASIS Open 2002. All Rights Reserved. Page 3 of 7
73 </simpleType>
74 Use the Code small style if the code has very long lines. It fits 80 characters. For example:
75 12345678901234567890123456789012345678901234567890123456789012345678901234567890
76 1 2 3 4 5 6 7 8
77 <simpleType name="DecisionType">
78 <restriction base="string">
79 <enumeration value="Permit"/>
80 <enumeration value="Deny"/>
81 <enumeration value="Indeterminate"/>
82 </restriction>
83 </simpleType>
84 For non-normative examples, use the Example paragraph style. For example:
85 GET [Link] name and path>?TARGET=<Target>...<HTTP-Version>
86 <other HTTP 1.0 or 1.1 components>
87 Use the Example small style if the example has very long lines. For example:
88 GET [Link] name and path>?TARGET=<Target>...<HTTP-Version>
89 <other HTTP 1.0 or 1.1 components>
90 ) for variable names
7 wd-spectools-word-sample-03 12 June 2002
8 Copyright © OASIS Open 2002. All Rights Reserved. Page 4 of 7
91 3 References
92 3.1 Normative
93 [RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels,
94 [Link] IETF RFC 2119, March 1997.
9 wd-spectools-word-sample-03 12 June 2002
10 Copyright © OASIS Open 2002. All Rights Reserved. Page 5 of 7
95 Appendix A. Acknowledgments
96 The following individuals were members of the committee during the development of this
97 specification:
98 Jane Doe, Example Corp.
99 A. Nonymous (chair), Example Corp.
100 John Smith, Example Corp.
101 Karl Best, OASIS
102 John Doe, Other Examples, Inc.
103 Eve Maler, Sun Microsystems
104 Norman Walsh, Sun Microsystems
105 In addition, the following people made contributions to this specification:
106 Joe Blow, Example Corp.
11 wd-spectools-word-sample-03 12 June 2002
12 Copyright © OASIS Open 2002. All Rights Reserved. Page 6 of 7
107 Appendix B. Revision History
108 [This appendix is optional, but helpful. It should be removed for specifications that are at OASIS
109 Standard level.]
Rev Date By Whom What
wd-00 2002-04-26 Eve Maler Initial version
wd-03 2002-06-12 Eve Maler Incorporates decision to put IPR
boilerplate in the Status section and
comments from Drummond Group.
Wd-04 2002-08-16 Eve Maler Updated the copyright statements to
meet legal requirements.
110
13 wd-spectools-word-sample-03 12 June 2002
14 Copyright © OASIS Open 2002. All Rights Reserved. Page 7 of 7