Sei sulla pagina 1di 27

1

2 Word Specification Sample


3Working Draft 04, 16 August 2002
4Document identifier:
5 wd-spectools-word-sample-04
6Location:
7 http://www.oasis-open.org/spectools/docs/
8Editor:
9 [List your editors here; check whether “Editor” header should be plural]
10 Eve Maler, Sun Microsystems <eve.maler@sun.com>
11Contributors:
12 [List your contributors here]
13 [Optionally list them in the Acknowledgments appendix instead]
14 Karl Best, OASIS
15 Norman Walsh, Sun Microsystems
16Abstract:
17 [Supply your own summary of the technical purpose of the document.] This document
18 provides a working MS Word 2000 sample from which you can start editing your own
19 OASIS-published document. Instructions are provided as italic text in brackets, which
20 should be deleted before publication. Full instructions are provided in the body of the
21 document.
22Status:
23 [Describe the status and stability of the specification and where to send comments.] This
24 document is updated periodically on no particular schedule. Send comments to the editor.
25 [This is boilerplate; to use, fix the hyperlinks:] Committee members should send
26 comments on this specification to the xxx@lists.oasis-open.org list. Others should
27 subscribe to and send comments to the xxx-comment@lists.oasis-open.org list. To
28 subscribe, send an email message to xxx-comment-request@lists.oasis-open.org with
29 the word "subscribe" as the body of the message.
30 [This is boilerplate; to use, fix the hyperlinks:] For information on whether any patents
31 have been disclosed that may be essential to implementing this specification, and any
32 offers of patent licensing terms, please refer to the Intellectual Property Rights section of
33 the XXX TC web page (http://www.oasis-open.org/committees/xxx/).
34 [If a Committee Specification or OASIS Standard:] The errata page for this specification is
35 at http://www.oasis-open.org/committees/xxx/yyy.

1wd-spectools-word-sample-03 12 June 2002


2Copyright © OASIS Open 2002. All Rights Reserved. Page 1 of 27
36Table of Contents
37Introduction..................................................................................................................................... 3
38 1.1 Terminology.......................................................................................................................... 3
392 Word Styles............................................................................................................................ 4
40 2.1 Overall Style......................................................................................................................... 4
41 2.2 Title Page.............................................................................................................................. 4
42 2.3 Headings.............................................................................................................................. 4
43 2.4 Paragraphs........................................................................................................................... 4
44 2.5 Lists...................................................................................................................................... 4
45 2.6 Tables................................................................................................................................... 5
46 2.7 Code Examples.................................................................................................................... 5
47 2.8 Character Styles................................................................................................................... 5
483 References............................................................................................................................. 6
49 3.1 Normative............................................................................................................................. 6
50Appendix A. Acknowledgments....................................................................................................... 7
51Appendix B. Revision History.......................................................................................................... 8
52Appendix C. Notices....................................................................................................................... 9
53

3wd-spectools-word-sample-03 12 June 2002


4Copyright © OASIS Open 2002. All Rights Reserved. Page 2 of 27
54Introduction
55[Provide an introductory chapter, indicating if any parts of it are non-normative.]

561.1 Terminology
57[The following is boilerplate. Most specifications will need this and the corresponding bibliography
58entry.] The key words must, must not, required, shall, shall not, should, should not,
59recommended, may, and optional in this document are to be interpreted as described in
60[RFC2119].

5wd-spectools-word-sample-03 12 June 2002


6Copyright © OASIS Open 2002. All Rights Reserved. Page 3 of 27
602 Word Styles
61[This section is provided to explain and demonstrate the styles available in the Word template
62attached to this sample document. It is important to use the styles provided in the template
63consistently and to avoid defining new styles or using raw formatting.
64Delete this entire section when using this sample document to begin writing a new specification.]

652.1 Overall Style


66The paper size is set to Letter, which is 8 ½ x 11. You may change this to A4 or whatever other
67size suits your needs.
68The document identifier and publication date information in the footer needs to be updated every
69time you publish.
70Line numbers are enabled by default for easy reference by specification commenters. You may
71turn line numbering off.

722.2 Title Page


73The title page is designed to fit a lot of metadata compactly. If you wish to create a “true” title
74page, you may insert a page break after the subtitle.

752.3 Headings
76Heading 1 through Heading 9 and AppendixHeading have been defined with a special
77appearance. Headings are numbered and appear in the Table of Contents. Pressing Return after
78a heading inserts a Normal paragraph style directly after.
79This template sets Heading 1 and AppendixHeading to start on a new page. You may set the
80Heading 1 style not to start on a new page if you wish. Major headings have a horizontal rule
81above them.

822.4 Paragraphs
83The font in the Normal paragraph style is 10-pt Arial. You may change this to 11-pt Times New
84Roman if you prefer a serif font; changing these two settings should change all the other relevant
85styles.

862.5 Lists
87The Definition term and Definition paragraph styles are defined specially for this template. They
88produce a definition list with a hanging appearance. Pressing Return after one inserts the other
89directly after.
90Definition term
91 Definition for the term.
92Use List bullet for first-level bulleted lists. Use List bullet 2 for second-level bulleted lists. Use
93List continue for continued paragraphs in list items.
94 List bullet
95 List continue.
96 – List bullet 2
97 List continue 2.

7wd-spectools-word-sample-03 12 June 2002


8Copyright © OASIS Open 2002. All Rights Reserved. Page 4 of 27
98For bibliography lists, use the Ref paragraph style. Use the Ref term character style for the
99bracketed text that serves as the bibliography entry key, and make each reference term into a
100bookmark for use as references from the text. For example, [RFC2119] is a generated cross-
101reference to the IETF RFC 2119 bibliography entry in Section 3.1 of this sample.

1022.6 Tables
103Use the following style for most tables: [To be supplied; suggestions welcome!]

1042.7 Code Examples


105For schema code and other normative code, use the Code paragraph style. It fits 71 characters.
106For example:
107 12345678901234567890123456789012345678901234567890123456789012345678901
108 1 2 3 4 5 6 7
109 <simpleType name="DecisionType">
110 <restriction base="string">
111 <enumeration value="Permit"/>
112 <enumeration value="Deny"/>
113 <enumeration value="Indeterminate"/>
114 </restriction>
115 </simpleType>

116Use the Code small style if the code has very long lines. It fits 80 characters. For example:
117 12345678901234567890123456789012345678901234567890123456789012345678901234567890
118 1 2 3 4 5 6 7 8
119 <simpleType name="DecisionType">
120 <restriction base="string">
121 <enumeration value="Permit"/>
122 <enumeration value="Deny"/>
123 <enumeration value="Indeterminate"/>
124 </restriction>
125 </simpleType>

126For non-normative examples, use the Example paragraph style. For example:
127 GET http://<host name and path>?TARGET=<Target>...<HTTP-Version>
128 <other HTTP 1.0 or 1.1 components>
129Use the Example small style if the example has very long lines. For example:
130 GET http://<host name and path>?TARGET=<Target>...<HTTP-Version>
131 <other HTTP 1.0 or 1.1 components>

1322.8 Character Styles


133This template defines several character styles for general text use:
134 Element style (shortcut Ctrl-Shift-E) for <NativeElement> names and
135 <ns:ForeignElement> names; add the angle brackets yourself
136 Attribute style (shortcut Ctrl-Shift-A) for attributeNames
137 Datatype style (shortcut Ctrl-Shift-Alt-D) for DataType names
138 Keyword style (shortcut Ctrl-Shift-K) for OtherKeyword names
139 Variable style (shortcut Ctrl-Shift-Alt-V) for variable names

9wd-spectools-word-sample-03 12 June 2002


10Copyright © OASIS Open 2002. All Rights Reserved. Page 5 of 27
1403 References
1413.1 Normative
142 [RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels,
143 http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.

11wd-spectools-word-sample-03 12 June 2002


12Copyright © OASIS Open 2002. All Rights Reserved. Page 6 of 27
144Appendix A. Acknowledgments
145The following individuals were members of the committee during the development of this
146specification:
147 Jane Doe, Example Corp.
148 A. Nonymous (chair), Example Corp.
149 John Smith, Example Corp.
150 Karl Best, OASIS
151 John Doe, Other Examples, Inc.
152 Eve Maler, Sun Microsystems
153 Norman Walsh, Sun Microsystems
154In addition, the following people made contributions to this specification:
155 Joe Blow, Example Corp.

13wd-spectools-word-sample-03 12 June 2002


14Copyright © OASIS Open 2002. All Rights Reserved. Page 7 of 27
156Appendix B. Revision History
157[This appendix is optional, but helpful. It should be removed for specifications that are at OASIS
158Standard 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.

159

15wd-spectools-word-sample-03 12 June 2002


16Copyright © OASIS Open 2002. All Rights Reserved. Page 8 of 27
160Appendix C. Notices
161OASIS takes no position regarding the validity or scope of any intellectual property or other rights
162that might be claimed to pertain to the implementation or use of the technology described in this
163document or the extent to which any license under such rights might or might not be available;
164neither does it represent that it has made any effort to identify any such rights. Information on
165OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS
166website. Copies of claims of rights made available for publication and any assurances of licenses
167to be made available, or the result of an attempt made to obtain a general license or permission
168for the use of such proprietary rights by implementors or users of this specification, can be
169obtained from the OASIS Executive Director.
170OASIS invites any interested party to bring to its attention any copyrights, patents or patent
171applications, or other proprietary rights which may cover technology that may be required to
172implement this specification. Please address the information to the OASIS Executive Director.
173Copyright © OASIS Open 2002. All Rights Reserved.
174This document and translations of it may be copied and furnished to others, and derivative works
175that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
176published and distributed, in whole or in part, without restriction of any kind, provided that the
177above copyright notice and this paragraph are included on all such copies and derivative works.
178However, this document itself does not be modified in any way, such as by removing the
179copyright notice or references to OASIS, except as needed for the purpose of developing OASIS
180specifications, in which case the procedures for copyrights defined in the OASIS Intellectual
181Property Rights document must be followed, or as required to translate it into languages other
182than English.
183The limited permissions granted above are perpetual and will not be revoked by OASIS or its
184successors or assigns.
185This document and the information contained herein is provided on an “AS IS” basis and OASIS
186DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
187ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
188RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
189PARTICULAR PURPOSE.

190

191Word Specification Sample


192Working Draft 04, 16 August 2002

17wd-spectools-word-sample-03 12 June 2002


18Copyright © OASIS Open 2002. All Rights Reserved. Page 9 of 27
193Document identifier:
194 wd-spectools-word-sample-04
195Location:
196 http://www.oasis-open.org/spectools/docs/
197Editor:
198 [List your editors here; check whether “Editor” header should be plural]
199 Eve Maler, Sun Microsystems <eve.maler@sun.com>
200Contributors:
201 [List your contributors here]
202 [Optionally list them in the Acknowledgments appendix instead]
203 Karl Best, OASIS
204 Norman Walsh, Sun Microsystems
205Abstract:
206 [Supply your own summary of the technical purpose of the document.] This document
207 provides a working MS Word 2000 sample from which you can start editing your own
208 OASIS-published document. Instructions are provided as italic text in brackets, which
209 should be deleted before publication. Full instructions are provided in the body of the
210 document.
211Status:
212 [Describe the status and stability of the specification and where to send comments.] This
213 document is updated periodically on no particular schedule. Send comments to the editor.
214 [This is boilerplate; to use, fix the hyperlinks:] Committee members should send
215 comments on this specification to the xxx@lists.oasis-open.org list. Others should
216 subscribe to and send comments to the xxx-comment@lists.oasis-open.org list. To
217 subscribe, send an email message to xxx-comment-request@lists.oasis-open.org with
218 the word "subscribe" as the body of the message.
219 [This is boilerplate; to use, fix the hyperlinks:] For information on whether any patents
220 have been disclosed that may be essential to implementing this specification, and any
221 offers of patent licensing terms, please refer to the Intellectual Property Rights section of
222 the XXX TC web page (http://www.oasis-open.org/committees/xxx/).
223 [If a Committee Specification or OASIS Standard:] The errata page for this specification is
224 at http://www.oasis-open.org/committees/xxx/yyy.

19wd-spectools-word-sample-03 12 June 2002


20Copyright © OASIS Open 2002. All Rights Reserved. Page 10 of 27
225Table of Contents
226Introduction..................................................................................................................................... 3
227 1.1 Terminology.......................................................................................................................... 3
2282 Word Styles............................................................................................................................ 4
229 2.1 Overall Style......................................................................................................................... 4
230 2.2 Title Page.............................................................................................................................. 4
231 2.3 Headings.............................................................................................................................. 4
232 2.4 Paragraphs........................................................................................................................... 4
233 2.5 Lists...................................................................................................................................... 4
234 2.6 Tables................................................................................................................................... 5
235 2.7 Code Examples.................................................................................................................... 5
236 2.8 Character Styles................................................................................................................... 5
2373 References............................................................................................................................. 6
238 3.1 Normative............................................................................................................................. 6
239Appendix A. Acknowledgments....................................................................................................... 7
240Appendix B. Revision History.......................................................................................................... 8
241Appendix C. Notices....................................................................................................................... 9
242

21wd-spectools-word-sample-03 12 June 2002


22Copyright © OASIS Open 2002. All Rights Reserved. Page 11 of 27
243Introduction
244[Provide an introductory chapter, indicating if any parts of it are non-normative.]

2453.2 Terminology
246[The following is boilerplate. Most specifications will need this and the corresponding bibliography
247entry.] The key words must, must not, required, shall, shall not, should, should not,
248recommended, may, and optional in this document are to be interpreted as described in
249[RFC2119].

23wd-spectools-word-sample-03 12 June 2002


24Copyright © OASIS Open 2002. All Rights Reserved. Page 12 of 27
2494 Word Styles
250[This section is provided to explain and demonstrate the styles available in the Word template
251attached to this sample document. It is important to use the styles provided in the template
252consistently and to avoid defining new styles or using raw formatting.
253Delete this entire section when using this sample document to begin writing a new specification.]

2544.1 Overall Style


255The paper size is set to Letter, which is 8 ½ x 11. You may change this to A4 or whatever other
256size suits your needs.
257The document identifier and publication date information in the footer needs to be updated every
258time you publish.
259Line numbers are enabled by default for easy reference by specification commenters. You may
260turn line numbering off.

2614.2 Title Page


262The title page is designed to fit a lot of metadata compactly. If you wish to create a “true” title
263page, you may insert a page break after the subtitle.

2644.3 Headings
265Heading 1 through Heading 9 and AppendixHeading have been defined with a special
266appearance. Headings are numbered and appear in the Table of Contents. Pressing Return after
267a heading inserts a Normal paragraph style directly after.
268This template sets Heading 1 and AppendixHeading to start on a new page. You may set the
269Heading 1 style not to start on a new page if you wish. Major headings have a horizontal rule
270above them.

2714.4 Paragraphs
272The font in the Normal paragraph style is 10-pt Arial. You may change this to 11-pt Times New
273Roman if you prefer a serif font; changing these two settings should change all the other relevant
274styles.

2754.5 Lists
276The Definition term and Definition paragraph styles are defined specially for this template. They
277produce a definition list with a hanging appearance. Pressing Return after one inserts the other
278directly after.
279Definition term
280 Definition for the term.
281Use List bullet for first-level bulleted lists. Use List bullet 2 for second-level bulleted lists. Use
282List continue for continued paragraphs in list items.
283 List bullet
284 List continue.
285 – List bullet 2
286 List continue 2.

25wd-spectools-word-sample-03 12 June 2002


26Copyright © OASIS Open 2002. All Rights Reserved. Page 13 of 27
287For bibliography lists, use the Ref paragraph style. Use the Ref term character style for the
288bracketed text that serves as the bibliography entry key, and make each reference term into a
289bookmark for use as references from the text. For example, [RFC2119] is a generated cross-
290reference to the IETF RFC 2119 bibliography entry in Section 3.1 of this sample.

2914.6 Tables
292Use the following style for most tables: [To be supplied; suggestions welcome!]

2934.7 Code Examples


294For schema code and other normative code, use the Code paragraph style. It fits 71 characters.
295For example:
296 12345678901234567890123456789012345678901234567890123456789012345678901
297 1 2 3 4 5 6 7
298 <simpleType name="DecisionType">
299 <restriction base="string">
300 <enumeration value="Permit"/>
301 <enumeration value="Deny"/>
302 <enumeration value="Indeterminate"/>
303 </restriction>
304 </simpleType>

305Use the Code small style if the code has very long lines. It fits 80 characters. For example:
306 12345678901234567890123456789012345678901234567890123456789012345678901234567890
307 1 2 3 4 5 6 7 8
308 <simpleType name="DecisionType">
309 <restriction base="string">
310 <enumeration value="Permit"/>
311 <enumeration value="Deny"/>
312 <enumeration value="Indeterminate"/>
313 </restriction>
314 </simpleType>

315For non-normative examples, use the Example paragraph style. For example:
316 GET http://<host name and path>?TARGET=<Target>...<HTTP-Version>
317 <other HTTP 1.0 or 1.1 components>
318Use the Example small style if the example has very long lines. For example:
319 GET http://<host name and path>?TARGET=<Target>...<HTTP-Version>
320 <other HTTP 1.0 or 1.1 components>

3214.8 Character Styles


322This template defines several character styles for general text use:
323 Element style (shortcut Ctrl-Shift-E) for <NativeElement> names and
324 <ns:ForeignElement> names; add the angle brackets yourself
325 Attribute style (shortcut Ctrl-Shift-A) for attributeNames
326 Datatype style (shortcut Ctrl-Shift-Alt-D) for DataType names
327 Keyword style (shortcut Ctrl-Shift-K) for OtherKeyword names
328 Variable style (shortcut Ctrl-Shift-Alt-V) for variable names

27wd-spectools-word-sample-03 12 June 2002


28Copyright © OASIS Open 2002. All Rights Reserved. Page 14 of 27
3295 References
3305.1 Normative
331 [RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels,
332 http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.

29wd-spectools-word-sample-03 12 June 2002


30Copyright © OASIS Open 2002. All Rights Reserved. Page 15 of 27
333Appendix D. Acknowledgments
334The following individuals were members of the committee during the development of this
335specification:
336 Jane Doe, Example Corp.
337 A. Nonymous (chair), Example Corp.
338 John Smith, Example Corp.
339 Karl Best, OASIS
340 John Doe, Other Examples, Inc.
341 Eve Maler, Sun Microsystems
342 Norman Walsh, Sun Microsystems
343In addition, the following people made contributions to this specification:
344 Joe Blow, Example Corp.

31wd-spectools-word-sample-03 12 June 2002


32Copyright © OASIS Open 2002. All Rights Reserved. Page 16 of 27
345Appendix E. Revision History
346[This appendix is optional, but helpful. It should be removed for specifications that are at OASIS
347Standard 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.

348

33wd-spectools-word-sample-03 12 June 2002


34Copyright © OASIS Open 2002. All Rights Reserved. Page 17 of 27
349Appendix F. Notices
350OASIS takes no position regarding the validity or scope of any intellectual property or other rights
351that might be claimed to pertain to the implementation or use of the technology described in this
352document or the extent to which any license under such rights might or might not be available;
353neither does it represent that it has made any effort to identify any such rights. Information on
354OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS
355website. Copies of claims of rights made available for publication and any assurances of licenses
356to be made available, or the result of an attempt made to obtain a general license or permission
357for the use of such proprietary rights by implementors or users of this specification, can be
358obtained from the OASIS Executive Director.
359OASIS invites any interested party to bring to its attention any copyrights, patents or patent
360applications, or other proprietary rights which may cover technology that may be required to
361implement this specification. Please address the information to the OASIS Executive Director.
362Copyright © OASIS Open 2002. All Rights Reserved.
363This document and translations of it may be copied and furnished to others, and derivative works
364that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
365published and distributed, in whole or in part, without restriction of any kind, provided that the
366above copyright notice and this paragraph are included on all such copies and derivative works.
367However, this document itself does not be modified in any way, such as by removing the
368copyright notice or references to OASIS, except as needed for the purpose of developing OASIS
369specifications, in which case the procedures for copyrights defined in the OASIS Intellectual
370Property Rights document must be followed, or as required to translate it into languages other
371than English.
372The limited permissions granted above are perpetual and will not be revoked by OASIS or its
373successors or assigns.
374This document and the information contained herein is provided on an “AS IS” basis and OASIS
375DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
376ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
377RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
378PARTICULAR PURPOSE.
379

380

381Word Specification Sample


382Working Draft 04, 16 August 2002

35wd-spectools-word-sample-03 12 June 2002


36Copyright © OASIS Open 2002. All Rights Reserved. Page 18 of 27
383Document identifier:
384 wd-spectools-word-sample-04
385Location:
386 http://www.oasis-open.org/spectools/docs/
387Editor:
388 [List your editors here; check whether “Editor” header should be plural]
389 Eve Maler, Sun Microsystems <eve.maler@sun.com>
390Contributors:
391 [List your contributors here]
392 [Optionally list them in the Acknowledgments appendix instead]
393 Karl Best, OASIS
394 Norman Walsh, Sun Microsystems
395Abstract:
396 [Supply your own summary of the technical purpose of the document.] This document
397 provides a working MS Word 2000 sample from which you can start editing your own
398 OASIS-published document. Instructions are provided as italic text in brackets, which
399 should be deleted before publication. Full instructions are provided in the body of the
400 document.
401Status:
402 [Describe the status and stability of the specification and where to send comments.] This
403 document is updated periodically on no particular schedule. Send comments to the editor.
404 [This is boilerplate; to use, fix the hyperlinks:] Committee members should send
405 comments on this specification to the xxx@lists.oasis-open.org list. Others should
406 subscribe to and send comments to the xxx-comment@lists.oasis-open.org list. To
407 subscribe, send an email message to xxx-comment-request@lists.oasis-open.org with
408 the word "subscribe" as the body of the message.
409 [This is boilerplate; to use, fix the hyperlinks:] For information on whether any patents
410 have been disclosed that may be essential to implementing this specification, and any
411 offers of patent licensing terms, please refer to the Intellectual Property Rights section of
412 the XXX TC web page (http://www.oasis-open.org/committees/xxx/).
413 [If a Committee Specification or OASIS Standard:] The errata page for this specification is
414 at http://www.oasis-open.org/committees/xxx/yyy.

37wd-spectools-word-sample-03 12 June 2002


38Copyright © OASIS Open 2002. All Rights Reserved. Page 19 of 27
415Table of Contents
416Introduction..................................................................................................................................... 3
417 1.1 Terminology.......................................................................................................................... 3
4182 Word Styles............................................................................................................................ 4
419 2.1 Overall Style......................................................................................................................... 4
420 2.2 Title Page.............................................................................................................................. 4
421 2.3 Headings.............................................................................................................................. 4
422 2.4 Paragraphs........................................................................................................................... 4
423 2.5 Lists...................................................................................................................................... 4
424 2.6 Tables................................................................................................................................... 5
425 2.7 Code Examples.................................................................................................................... 5
426 2.8 Character Styles................................................................................................................... 5
4273 References............................................................................................................................. 6
428 3.1 Normative............................................................................................................................. 6
429Appendix A. Acknowledgments....................................................................................................... 7
430Appendix B. Revision History.......................................................................................................... 8
431Appendix C. Notices....................................................................................................................... 9
432

39wd-spectools-word-sample-03 12 June 2002


40Copyright © OASIS Open 2002. All Rights Reserved. Page 20 of 27
433Introduction
434[Provide an introductory chapter, indicating if any parts of it are non-normative.]

4355.2 Terminology
436[The following is boilerplate. Most specifications will need this and the corresponding bibliography
437entry.] The key words must, must not, required, shall, shall not, should, should not,
438recommended, may, and optional in this document are to be interpreted as described in
439[RFC2119].

41wd-spectools-word-sample-03 12 June 2002


42Copyright © OASIS Open 2002. All Rights Reserved. Page 21 of 27
4396 Word Styles
440[This section is provided to explain and demonstrate the styles available in the Word template
441attached to this sample document. It is important to use the styles provided in the template
442consistently and to avoid defining new styles or using raw formatting.
443Delete this entire section when using this sample document to begin writing a new specification.]

4446.1 Overall Style


445The paper size is set to Letter, which is 8 ½ x 11. You may change this to A4 or whatever other
446size suits your needs.
447The document identifier and publication date information in the footer needs to be updated every
448time you publish.
449Line numbers are enabled by default for easy reference by specification commenters. You may
450turn line numbering off.

4516.2 Title Page


452The title page is designed to fit a lot of metadata compactly. If you wish to create a “true” title
453page, you may insert a page break after the subtitle.

4546.3 Headings
455Heading 1 through Heading 9 and AppendixHeading have been defined with a special
456appearance. Headings are numbered and appear in the Table of Contents. Pressing Return after
457a heading inserts a Normal paragraph style directly after.
458This template sets Heading 1 and AppendixHeading to start on a new page. You may set the
459Heading 1 style not to start on a new page if you wish. Major headings have a horizontal rule
460above them.

4616.4 Paragraphs
462The font in the Normal paragraph style is 10-pt Arial. You may change this to 11-pt Times New
463Roman if you prefer a serif font; changing these two settings should change all the other relevant
464styles.

4656.5 Lists
466The Definition term and Definition paragraph styles are defined specially for this template. They
467produce a definition list with a hanging appearance. Pressing Return after one inserts the other
468directly after.
469Definition term
470 Definition for the term.
471Use List bullet for first-level bulleted lists. Use List bullet 2 for second-level bulleted lists. Use
472List continue for continued paragraphs in list items.
473 List bullet
474 List continue.
475 – List bullet 2
476 List continue 2.

43wd-spectools-word-sample-03 12 June 2002


44Copyright © OASIS Open 2002. All Rights Reserved. Page 22 of 27
477For bibliography lists, use the Ref paragraph style. Use the Ref term character style for the
478bracketed text that serves as the bibliography entry key, and make each reference term into a
479bookmark for use as references from the text. For example, [RFC2119] is a generated cross-
480reference to the IETF RFC 2119 bibliography entry in Section 3.1 of this sample.

4816.6 Tables
482Use the following style for most tables: [To be supplied; suggestions welcome!]

4836.7 Code Examples


484For schema code and other normative code, use the Code paragraph style. It fits 71 characters.
485For example:
486 12345678901234567890123456789012345678901234567890123456789012345678901
487 1 2 3 4 5 6 7
488 <simpleType name="DecisionType">
489 <restriction base="string">
490 <enumeration value="Permit"/>
491 <enumeration value="Deny"/>
492 <enumeration value="Indeterminate"/>
493 </restriction>
494 </simpleType>

495Use the Code small style if the code has very long lines. It fits 80 characters. For example:
496 12345678901234567890123456789012345678901234567890123456789012345678901234567890
497 1 2 3 4 5 6 7 8
498 <simpleType name="DecisionType">
499 <restriction base="string">
500 <enumeration value="Permit"/>
501 <enumeration value="Deny"/>
502 <enumeration value="Indeterminate"/>
503 </restriction>
504 </simpleType>

505For non-normative examples, use the Example paragraph style. For example:
506 GET http://<host name and path>?TARGET=<Target>...<HTTP-Version>
507 <other HTTP 1.0 or 1.1 components>
508Use the Example small style if the example has very long lines. For example:
509 GET http://<host name and path>?TARGET=<Target>...<HTTP-Version>
510 <other HTTP 1.0 or 1.1 components>

5116.8 Character Styles


512This template defines several character styles for general text use:
513 Element style (shortcut Ctrl-Shift-E) for <NativeElement> names and
514 <ns:ForeignElement> names; add the angle brackets yourself
515 Attribute style (shortcut Ctrl-Shift-A) for attributeNames
516 Datatype style (shortcut Ctrl-Shift-Alt-D) for DataType names
517 Keyword style (shortcut Ctrl-Shift-K) for OtherKeyword names
518 Variable style (shortcut Ctrl-Shift-Alt-V) for variable names

45wd-spectools-word-sample-03 12 June 2002


46Copyright © OASIS Open 2002. All Rights Reserved. Page 23 of 27
5197 References
5207.1 Normative
521 [RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels,
522 http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.

47wd-spectools-word-sample-03 12 June 2002


48Copyright © OASIS Open 2002. All Rights Reserved. Page 24 of 27
523Appendix G. Acknowledgments
524The following individuals were members of the committee during the development of this
525specification:
526 Jane Doe, Example Corp.
527 A. Nonymous (chair), Example Corp.
528 John Smith, Example Corp.
529 Karl Best, OASIS
530 John Doe, Other Examples, Inc.
531 Eve Maler, Sun Microsystems
532 Norman Walsh, Sun Microsystems
533In addition, the following people made contributions to this specification:
534 Joe Blow, Example Corp.

49wd-spectools-word-sample-03 12 June 2002


50Copyright © OASIS Open 2002. All Rights Reserved. Page 25 of 27
535Appendix H. Revision History
536[This appendix is optional, but helpful. It should be removed for specifications that are at OASIS
537Standard 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.

538

51wd-spectools-word-sample-03 12 June 2002


52Copyright © OASIS Open 2002. All Rights Reserved. Page 26 of 27
539Appendix I. Notices
540OASIS takes no position regarding the validity or scope of any intellectual property or other rights
541that might be claimed to pertain to the implementation or use of the technology described in this
542document or the extent to which any license under such rights might or might not be available;
543neither does it represent that it has made any effort to identify any such rights. Information on
544OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS
545website. Copies of claims of rights made available for publication and any assurances of licenses
546to be made available, or the result of an attempt made to obtain a general license or permission
547for the use of such proprietary rights by implementors or users of this specification, can be
548obtained from the OASIS Executive Director.
549OASIS invites any interested party to bring to its attention any copyrights, patents or patent
550applications, or other proprietary rights which may cover technology that may be required to
551implement this specification. Please address the information to the OASIS Executive Director.
552Copyright © OASIS Open 2002. All Rights Reserved.
553This document and translations of it may be copied and furnished to others, and derivative works
554that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
555published and distributed, in whole or in part, without restriction of any kind, provided that the
556above copyright notice and this paragraph are included on all such copies and derivative works.
557However, this document itself does not be modified in any way, such as by removing the
558copyright notice or references to OASIS, except as needed for the purpose of developing OASIS
559specifications, in which case the procedures for copyrights defined in the OASIS Intellectual
560Property Rights document must be followed, or as required to translate it into languages other
561than English.
562The limited permissions granted above are perpetual and will not be revoked by OASIS or its
563successors or assigns.
564This document and the information contained herein is provided on an “AS IS” basis and OASIS
565DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
566ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
567RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
568PARTICULAR PURPOSE.
569

53wd-spectools-word-sample-03 12 June 2002


54Copyright © OASIS Open 2002. All Rights Reserved. Page 27 of 27

Potrebbero piacerti anche