/
oasis-specification-0.6-wd04-relative.html
409 lines (395 loc) · 70.1 KB
/
oasis-specification-0.6-wd04-relative.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>OASIS Specification Publishing in DocBook XML Version 0.6</title><link rel="stylesheet" href="css/oasis-spec.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"><meta name="description" content="Abstract This working draft describes an environment for writing and publishing an OASIS specification using DocBook XML. It is an internal OASIS support document and not the basis of an OASIS specification in and of itself."><meta name="cvsinfo" content="Id: oasis-specification-0.6-wd04.xml,v 1.2 2012/06/14 01:57:23 admin Exp "></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><p class="logo"><a href="http://www.oasis-open.org/"><img src="OASISLogo.jpg" alt="OASIS" border="0"></a></p><div><hr style="margin-bottom:0pt"><h1 class="title"><a name="d0e3"></a>OASIS Specification Publishing in DocBook XML Version 0.6</h1></div><div><h2>Working Draft 04</h2><h2>14 June 2012</h2></div><div></div><div><!--
$Id: oasis-specification-0.6-wd04.xml,v 1.2 2012/06/14 01:57:23 admin Exp $
--></div><div><dl><dt><span class="uri-heading">
Specification URIs
</span></dt></dl><dl><dt><span class="loc-heading">This version:</span></dt><dd><a href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.html">http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.html</a>
(Authoritative)
<br><a href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.pdf">http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.pdf</a><br><a href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.xml">http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.xml</a><br></dd></dl><dl><dt><span class="loc-heading">Previous version:</span></dt><dd><a href="http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification-0.5.html">http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification-0.5.html</a>
(Authoritative)
<br><a href="http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification-0.5.pdf">http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification-0.5.pdf</a><br><a href="http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification-0.5.xml">http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification-0.5.xml</a><br></dd></dl><dl><dt><span class="loc-heading">Latest version:</span></dt><dd><a href="http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.html">http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.html</a>
(Authoritative)
<br><a href="http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.pdf">http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.pdf</a><br><a href="http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.xml">http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.xml</a><br></dd></dl></div><div></div><div></div><div></div><div></div><div></div><div></div><div></div><div></div><div><dl><dt><span class="loc-heading">Technical Committee:</span></dt><dd><a href="http://www.oasis-open.org/" target="_top">OASIS TC Administration</a></dd></dl></div><div><dl><dt><span class="editor-heading">Editor:</span></dt><dd><span class="firstname">G. Ken</span> <span class="surname">Holman</span> (<a href="mailto:gkholman@CraneSoftwrights.com">gkholman@CraneSoftwrights.com</a>), Associate member</dd></dl></div><div><dl><dt><a name="d0e73"></a><span class="status-heading">Additional artifacts:</span></dt><dd><p>This prose specification is one component of a Work Product which also includes:</p><div class="itemizedlist"><ul type="disc" compact><li><p>
publishing materials: <a href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.zip" target="_top">http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.zip</a></p></li></ul></div></dd></dl></div><div><dl><dt><a name="d0e85"></a><span class="status-heading">Related work:</span></dt><dd><p>This methodology supersedes guidelines for the DocBook XML-based authoring and publishing of OASIS specifications described in <a href="http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification-0.5.html" target="_top">http://docs.oasis-open.org/templates/DocBook/spec-0.5/oasis-specification.html</a>.</p></dd></dl></div><div><dl><dt><a name="d0e94"></a><span class="abstract-heading">Abstract:</span></dt><dd><p>This working draft describes an environment for writing and publishing an OASIS specification using DocBook XML. It is an internal OASIS support document and not the basis of an OASIS specification in and of itself.</p></dd></dl></div><div><dl><dt><a name="d0e100"></a><span class="status-heading">Status:</span></dt><dd><p>This is a work in progress contributed to the OASIS TC administration
and does not at this time represent
the consensus of any particular OASIS Technical Committee. There are no plans to make this a formal Committee Specification as it is merely an internal document made available to committee members to support the publishing process.</p></dd></dl></div><div><dl><dt><a name="d0e106"></a><span class="status-heading">Citation format:</span></dt><dd><p>When referencing this specification the following citation format should be used:</p><div class="bibliomixed"><p class="bibliomixed">[<b><span class="abbrev">OASIS-DOCBOOK-TEMPLATE-V0.6</span></b>]
<i>OASIS DocBook Template V0.6. </i>
<span class="date">14 June 2012. </span>
<span class="releaseinfo">OASIS Working Draft 04. </span>
<span class="citetitle"><em class="citetitle"><a href="http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.html" target="_top">http://docs.oasis-open.org/templates/DocBook/oasis-specification/oasis-specification.html</a>.</em></span>
</p></div></dd></dl></div><div><hr><h2 class="notices-heading">Notices</h2><p>Copyright © OASIS® Open 2012. All Rights Reserved.
</p><p>All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at <a href="http://www.oasis-open.org/who/intellectualproperty.php" target="_top">http://www.oasis-open.org/who/intellectualproperty.php</a>.</p><p>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 section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.</p><p>The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.</p><p>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 OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p><p>OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.</p><p>OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.</p><p>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' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on 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 implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.</p><p>The name "OASIS" is a trademark of <a href="http://www.oasis-open.org" target="_top">OASIS</a>, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see <a href="http://www.oasis-open.org/who/trademark.php" target="_top">http://www.oasis-open.org/who/trademark.php</a> for above guidance.</p></div></div><hr></div><div class="toc"><h2>Table of Contents</h2><dl><dt><span class="section"><a href="#s.intro">1 Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e182">1.1 Terminology</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e185">1.1.1
Key words</a></span></dt></dl></dd><dt><span class="section"><a href="#d0e222">1.2 Normative References</a></span></dt><dt><span class="section"><a href="#d0e366">1.3 Non-Normative References</a></span></dt></dl></dd><dt><span class="section"><a href="#d0e416">2 Installation and use</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e444">2.1 Package contents</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e521">2.1.1 Runtime package contents</a></span></dt></dl></dd><dt><span class="section"><a href="#d0e548">2.2 Engaging the DocBook DTD</a></span></dt><dt><span class="section"><a href="#d0e569">2.3 The OASIS specification HTML stylesheets</a></span></dt><dt><span class="section"><a href="#d0e588">2.4 The OASIS specification XSL-FO stylesheet</a></span></dt><dt><span class="section"><a href="#invokeparam">2.5 Stylesheet invocation parameters</a></span></dt></dl></dd><dt><span class="section"><a href="#d0e704">3
Authoring in XML</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e724">3.1
DocBook vocabulary</a></span></dt><dt><span class="section"><a href="#augmentations">3.2 DocBook augmentations for OASIS specifications</a></span></dt><dt><span class="section"><a href="#proforma">3.3 Pro forma template</a></span></dt><dt><span class="section"><a href="#sassoc">3.4
Stylesheet association</a></span></dt></dl></dd></dl><h3>Appendixes</h3><dl><dt><span class="appendix"><a href="#a.committee">A Acknowledgments (Non-Normative)</a></span></dt><dt><span class="appendix"><a href="#template">B Sample specification template</a></span></dt><dt><span class="appendix"><a href="#orch">C Publishing choreography and orchestration (Non-Normative)</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e1228">C.1
Windows batch file preparation</a></span></dt><dt><span class="section"><a href="#d0e1246">C.2
Linux shell script preparation</a></span></dt><dt><span class="section"><a href="#d0e1264">C.3
Sample invocations</a></span></dt></dl></dd></dl></div><hr><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="s.intro"></a>1 Introduction</h2></div></div></div><p>
This document details an environment [<a href="#spec-ZIP" title="[Spec-0.6-ZIP]"><b><span class="abbrev">Spec-0.6-ZIP</span></b></a>] and methodology for writing an OASIS specification document using XML markup, and publishing the resulting document to HTML and printed results conforming to OASIS layout conventions.</p><p>
While this has been prepared before, a new version of this environment and methodology is required to accommodate the latest conventions adopted by the OASIS TC Administration.</p><p>
The stylesheets for this version of this environment will remain static while the prose methodology documents and samples may be revised from time to time. Should it be necessary to revise the stylesheets, this version of the environment will left unchanged on the OASIS web site and a new version of the stylesheets and prose documents will be started. Check the persistent location noted above for any revisions to this environment.</p><p>
These stylesheets use XSLT [<a href="#xslt" title="[XSLT]"><b><span class="abbrev">XSLT</span></b></a>] as the transformation expression language to produce the final HTML result. XSLT is also used to produce the intermediate XSL-FO [<a href="#xsl-fo" title="[XSL-FO]"><b><span class="abbrev">XSL-FO</span></b></a>] pagination semantics, which in turn are available to be processed to produce printable results.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e182"></a>1.1 Terminology</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e185"></a>1.1.1
Key words</h4></div></div></div><p>The key words <em class="glossterm">must</em>, <em class="glossterm">must
not</em>, <em class="glossterm">required</em>,
<em class="glossterm">shall</em>, <em class="glossterm">shall not</em>,
<em class="glossterm">should</em>, <em class="glossterm">should not</em>,
<em class="glossterm">recommended</em>, <em class="glossterm">may</em>, and
<em class="glossterm">optional</em> are to be
interpreted as described in [<a href="#rfc2119" title="[RFC 2119]"><b><span class="abbrev">RFC 2119</span></b></a>]. Note that for
reasons of style, these words are not capitalized in this
document.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e222"></a>1.2 Normative References</h3></div></div></div><div class="bibliomixed"><a name="docbook"></a><p class="bibliomixed">[<b><span class="abbrev">DocBook</span></b>]
OASIS Committee Draft 4.4 <i><a href="http://www.docbook.org/specs/cd-docbook-docbook-4.4.pdf" target="_top">The DocBook 4.4 Document type</a></i>, OASIS January 27, 2005,
<span class="citetitle"><em class="citetitle"><a href="http://www.docbook.org/specs/cd-docbook-docbook-4.4.html" target="_top">OASIS DocBook 4.4 Document Type 27 Jan 2005 HTML</a>,
</em></span>,
<span class="citetitle"><em class="citetitle"><a href="http://www.docbook.org/xml/4.4/docbook-xml-4.4.zip" target="_top">DocBook 4.4 XML DTD</a>,
</em></span>,
<span class="citetitle"><em class="citetitle"><a href="http://sourceforge.net/projects/docbook/files/docbook-xsl-doc/1.69.1/" target="_top">DocBook Stylesheets Version 1.69.1</a></em></span>. </p></div><div class="bibliomixed"><a name="spec-ZIP"></a><p class="bibliomixed">[<b><span class="abbrev">Spec-0.6-ZIP</span></b>]
<i>OASIS Specification Publishing in DocBook XML Version 0.6. ZIP package. </i>
<span class="date">14 June 2012. </span>
<span class="citetitle"><em class="citetitle"><a href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.zip" target="_top">http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.zip</a></em></span>
</p></div><div class="bibliomixed"><a name="rfc2119"></a><p class="bibliomixed">[<b><span class="abbrev">RFC 2119</span></b>]
<i>Key words for use in RFCs to Indicate Requirement Levels</i>,
<span class="date">March 1997. </span>
<span class="author"><span class="firstname">S. </span><span class="surname">Bradner</span></span>.
<span class="releaseinfo">IETF (Internet Engineering Task Force) RFC 2119, </span>
<span class="citetitle"><em class="citetitle"><a href="http://www.ietf.org/rfc/rfc2119.txt" target="_top">http://www.ietf.org/rfc/rfc2119.txt</a></em></span>
</p></div><div class="bibliomixed"><a name="xml-assoc"></a><p class="bibliomixed">[<b><span class="abbrev">xml-assoc</span></b>]
<i>Associating Style Sheets with XML documents Version 1.0. </i>
<span class="date">29 June 1999. </span>
<span class="author"><span class="firstname">James </span><span class="surname">Clark</span></span>.
<span class="releaseinfo">W3C Recommendation. </span>
<span class="citetitle"><em class="citetitle"><a href="http://www.w3.org/1999/06/REC-xml-stylesheet-19990629" target="_top">http://www.w3.org/1999/06/REC-xml-stylesheet-19990629</a></em></span>
</p></div><div class="bibliomixed"><a name="xsl-fo"></a><p class="bibliomixed">[<b><span class="abbrev">XSL-FO</span></b>]
<i>Extensible Stylesheet Language (XSL) Version 1.1. </i>
<span class="date"> 5 December 2006. </span>
<span class="author"><span class="firstname">Anders </span><span class="surname">Berglund</span></span>.
<span class="releaseinfo">W3C Recommendation. </span>
<span class="citetitle"><em class="citetitle"><a href="http://www.w3.org/TR/2001/REC-xsl-20011015/" target="_top">http://www.w3.org/TR/2001/REC-xsl-20011015/</a></em></span>
</p></div><div class="bibliomixed"><a name="xslt"></a><p class="bibliomixed">[<b><span class="abbrev">XSLT</span></b>]
<i>XSL Transformations (XSLT) Version 1.0. </i>
<span class="date">16 November 1999. </span>
<span class="author"><span class="firstname">James </span><span class="surname">Clark</span></span>.
<span class="releaseinfo">W3C Recommendation. </span>
<span class="citetitle"><em class="citetitle"><a href="http://www.w3.org/TR/1999/REC-xslt-19991116" target="_top">http://www.w3.org/TR/1999/REC-xslt-19991116</a></em></span>
</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e366"></a>1.3 Non-Normative References</h3></div></div></div><div class="bibliomixed"><a name="ant"></a><p class="bibliomixed">[<b><span class="abbrev">ant</span></b>] Apache Software Foundation
<i><a href="http://ant.apache.org" target="_top">Ant Java-based Build Tool</a></i>
(Another Neat Tool).</p></div><div class="bibliomixed"><a name="fop"></a><p class="bibliomixed">[<b><span class="abbrev">FOP</span></b>] Apache Software Foundation
<i><a href="http://xmlgraphics.apache.org/fop" target="_top">Formatting Objects Processor</a></i>.</p></div><div class="bibliomixed"><a name="ibex-ss"></a><p class="bibliomixed">[<b><span class="abbrev">Ibex Signature Edition</span></b>] Visual Programming Limited. <i><a href="http://www.xmlpdf.com/ibex-downloads-signed.html" target="_top">Ibex XSL-FO Processor</a></i>.</p></div><div class="bibliomixed"><a name="saxon"></a><p class="bibliomixed">[<b><span class="abbrev">Saxon</span></b>] Michael Kay <i><a href="http://saxon.sourceforge.net/saxon6.5.5/index.html" target="_top">Saxon 6.5.5 XSLT 1.0 Processor</a></i>.</p></div><div class="bibliomixed"><a name="xjparse"></a><p class="bibliomixed">[<b><span class="abbrev">xjparse</span></b>] Norm Walsh <i><a href="http://nwalsh.com/java/xjparse" target="_top">xjparse XML validation invocation</a></i>.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e416"></a>2 Installation and use</h2></div></div></div><p>These stylesheets are zipped [<a href="#spec-ZIP" title="[Spec-0.6-ZIP]"><b><span class="abbrev">Spec-0.6-ZIP</span></b></a>] in a turnkey
environment ready to unpack for offline use. The environment is used to
validate DocBook XML, render HTML and create XSL-FO suitable for
processing with an XSL-FO engine (which is not included). Of course one
is not obliged to use the processors referenced as one can use any XML
DTD validation tool and any XSLT processor.</p><p>The package can be downloaded from <a href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.zip" target="_top">http://docs.oasis-open.org/templates/DocBook/spec-0.6/oasis-specification-0.6-wd04.zip</a> and is expected to be
unzipped into a local directory for offline use. The examples in this
documentation assume the package is unzipped in a Windows environment
into the <code class="literal">c:\</code> directory, and in a Linux environment in
one's home directory. For example purposes, it is assumed that the ZIP
file contents (all files starting with <code class="literal">spec-0.6/</code>) are
installed in the <code class="literal">c:\oasis\spec-0.6\</code> directory or
<code class="literal">~/oasis/spec-0.6/</code>.</p><p>See <a href="#orch" title="Appendix C Publishing choreography and orchestration (Non-Normative)">Appendix C, <i>Publishing choreography and orchestration (Non-Normative)</i></a> for details on a set of invocations for validating OASIS specification documents and producing an HTML rendering suitable for web browsers and an XSL-FO result suitable for an XSL-FO engine. Neither a browser nor an XSL-FO engine are themselves included in the package.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e444"></a>2.1 Package contents</h3></div></div></div><p>The significant directories of the package are as follows, shown for a
Windows environment but identical in a Linux environment:</p><pre class="programlisting">c:\oasis\ <span class="emphasis"><em>- base directory for complete installation</em></span>
\spec-0.6 <span class="emphasis"><em>- base directory for rendering</em></span>
\spec-0.6\css <span class="emphasis"><em>- HTML appearance</em></span>
\spec-0.6\stylesheets <span class="emphasis"><em>- HTML and XSL-FO production stylesheets</em></span>
\spec-0.6\template <span class="emphasis"><em>- example specification in XML</em></span>
\spec-0.6\docbook <span class="emphasis"><em>- base directory for DocBook DTD</em></span>
\spec-0.6\docbook\xsl <span class="emphasis"><em>- base directory for stylesheet library</em></span>
\spec-0.6\docbook\xsl\fo <span class="emphasis"><em>- base directory for XSL-FO library</em></span>
\spec-0.6\docbook\xsl\html <span class="emphasis"><em>- base directory for HTML library</em></span>
\spec-0.6\htmlruntime <span class="emphasis"><em>- embedded installation in a distribution</em></span>
</pre><p>The DocBook DTD components in the <code class="literal">docbook/</code> directory were obtained from <a href="http://www.docbook.org/xml/4.4/docbook-xml-4.4.zip" target="_top">http://www.docbook.org/xml/4.4/docbook-xml-4.4.zip</a>.</p><p>The DocBook XSL components in the <code class="literal">docbook/xsl/</code> directory were obtained from <a href="http://prdownloads.sourceforge.net/docbook/docbook-xsl-1.69.1.zip" target="_top">http://prdownloads.sourceforge.net/docbook/docbook-xsl-1.69.1.zip</a>, where the base directory of the unzipped package is renamed "<code class="literal">xsl/</code>". This allows one to obtain another release of the DocBook stylesheets, unzip them into a directory, rename the base directory and replace the <code class="literal">xsl/</code> installation directory. The <code class="literal">xsl/fo/</code> and <code class="literal">xsl/html/</code> directories should be in place when the unpacking, renaming and replacing is completed. Note that three installation files <code class="literal">install.sh</code>, <code class="literal">.CatalogManager.properties.example</code>, and <code class="literal">.urilist</code> have been removed from the 1.69.1 directories per the instructions in the <code class="literal">INSTALL</code> file, as two of them violate OASIS file naming guidelines.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e521"></a>2.1.1 Runtime package contents</h4></div></div></div><p>The <code class="literal">htmlruntime/</code> directory is a suitable subset of
the other directories for use when distributing the HTML subset of
this publishing environment embedded in your specification
distribution for runtime rendering of XML documents in HTML. The
directory name "<code class="literal">htmlruntime</code>" can be renamed as
desired to be anything at all. The XML of the specification uses
stylesheet association (see <a href="#sassoc" title="3.4 
Stylesheet association">Section 3.4, “
Stylesheet association”</a>) to point to the
HTML stylesheet in the runtime package directory distributed with the
XML.</p><p>An example of the use of this runtime configuration is in <a href="http://docs.oasis-open.org/ubl/prd2-UBL-2.1/" target="_top">http://docs.oasis-open.org/ubl/prd2-UBL-2.1/</a> where the
file <code class="literal">UBL-2.1.xml</code> includes a stylesheet association
directive to engage the HTML stylesheets in the
"<code class="literal">db/</code>" directory (having renamed it from
"<code class="literal">htmlruntime/</code>").</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e548"></a>2.2 Engaging the DocBook DTD</h3></div></div></div><p>The DocBook Document Type Definition (DTD) expresses the
constraints of using elements and attributes, but not necessarily the
conventions imposed by the OASIS TC Administration. Just having your
specification validate with the DTD does not guarantee that you've used
the correct or appropriate DocBook constructs to produce the required
output. This package includes <a href="#proforma" title="3.3 Pro forma template">Section 3.3, “ Pro forma template”</a> illustrating
the conventional use of the DocBook constructs.</p><p>To assert in the online OASIS environment that your XML document satisfies the constraints of DocBook, point to the posted copy of the DTD:</p><pre class="programlisting"><!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"</pre><p>To assert in an embedded environment that your XML document satisfies the constraints of DocBook, point to the embedded copy of the DTD:</p><pre class="programlisting"><!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"htmlruntime/spec-0.6/docbook/docbookx.dtd"</pre><p>To assert in an offline local environment that your XML document satisfies the constraints of DocBook, point to the installation copy of the DTD:</p><pre class="programlisting"><!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"file:///c:/oasis/spec-0.6/docbook/docbookx.dtd"</pre><p>Validating the XML document using the embedded DTD reference will report
any DocBook constraint violations in your XML.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e569"></a>2.3 The OASIS specification HTML stylesheets</h3></div></div></div><p>There are two stylesheets you must choose from in order to create
one of two versions of the rendering based on how that rendering will
be used.</p><p>Use this stylesheet during development and local review to create a
test instance (this will use local CSS stylesheets and the local base
URI):</p><pre class="programlisting">c:\oasis\spec-0.6\stylesheets\oasis-specification-html-offline.xsl
</pre><p>Use this stylesheet in the offline environment to create the final online
version to send to OASIS TC Administration (this will use embedded
references to online CSS stylesheets and the online base URI in
accordance with OASIS TC Administration requirements):</p><pre class="programlisting">c:\oasis\spec-0.6\stylesheets\oasis-specification-html.xsl
</pre><p>When the distribution includes the embedded rendering environment,
the same online stylesheet is referenced with a relative URI (note the
use of forward slashes rather than backslashes); of course the path
will need to be adjusted based on your choice of where the stylesheets
are embedded in your distribution:</p><pre class="programlisting">htmlruntime/spec-0.6/stylesheets/oasis-specification-html.xsl
</pre><p>In each case the resulting file should be suitable for viewing in a web browser.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e588"></a>2.4 The OASIS specification XSL-FO stylesheet</h3></div></div></div><p>To convert a DocBook instance following the conventions used in this specification into an instance of XSL-FO assuming A4 page dimensions or US-letter page dimensions, use one of these stylesheets:</p><pre class="programlisting">c:\oasis\spec-0.6\stylesheets\oasis-specification-fo-a4.xsl
c:\oasis\spec-0.6\stylesheets\oasis-specification-fo-us.xsl
</pre><p>The resulting file should be suitable for an XSL-FO engine to render into a printed format such as a PDF file.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some XSL-FO engines will automatically translate relative URI strings in links to absolute URI strings as part of the formatting process. This will leave absolute references to your local file system in the generated PDF, rather than the desired relative URI strings needed. Usually the resulting PDF, when not encrypted or locked, can be hacked to manually translate the absolute URI strings to the required relative URI strings.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="invokeparam"></a>2.5 Stylesheet invocation parameters</h3></div></div></div><p>There are four typical invocation parameters with defaults:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">automatic-output-filename=<strong class="userinput"><code>yes-or-no</code></strong></code></p><div class="itemizedlist"><ul type="circle"><li><p>when set to "<code class="literal">no</code>" (the default) the stylesheet
processor invocation output target is not ignored</p></li><li><p>when set to "<code class="literal">yes</code>" the stylesheets will ignore the invocation output target and will automatically produce the output file named using the content of two child elements of <code class="literal"><article-info></code> as follows:</p><div class="blockquote"><blockquote class="blockquote"><p><code class="literal"><productname>-<productnumber></code></p></blockquote></div></li></ul></div></li><li><p><code class="literal">oasis-base=<strong class="userinput"><code>yes-or-no</code></strong></code>
(HTML only)</p><div class="itemizedlist"><ul type="circle"><li><p>when set to "<code class="literal">no</code>" (the default) there is no addition of
a <code class="literal"><base></code> metadata element in the HTML
result</p></li><li><p>when set to "<code class="literal">yes</code>" the stylesheets will
create an HTML <code class="literal"><base></code> metadata element
extracting the URI from the first
<code class="literal"><articleinfo><release-info></code> element
where the <code class="literal">role=</code> attribute contains the
reserved partial string
"<code class="literal">OASIS-specification-this</code>" and the URI
contains the string "<code class="literal">.htm</code>"</p></li></ul></div></li><li><p><code class="literal">html.stylesheet=<strong class="userinput"><code>URI-string-to-OASIS-CSS-file</code></strong></code>
(HTML only)</p><div class="itemizedlist"><ul type="circle"><li><p>use this to inject a relative URI or other URI to your
placement of the OASIS CSS file usually found in the publishing
environment at "<code class="literal">css/oasis-spec.css</code>"</p></li><li><p>when not specified the URI that is used is hardwired to
either your local publishing environment (when using the
offline HTML stylesheet) or hardwired to the OASIS server
publishing environment (when using the online HTML
stylesheet)</p></li></ul></div></li><li><p><code class="literal">oasis.logo=<strong class="userinput"><code>URI-string-to-OASIS-logo-jpg</code></strong></code>
(HTML only)</p><div class="itemizedlist"><ul type="circle"><li><p>use this to inject a relative URI or other URI to your
placement of the OASIS logo file usually found in the
publishing environment base directory at
"<code class="literal">OASISLogo.jpg</code>"</p></li><li><p>when not specified the URI that is used is hardwired to
either your local publishing environment (when using the
offline HTML stylesheet) or hardwired to the OASIS server
publishing environment (when using the online HTML
stylesheet)</p></li></ul></div></li></ul></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e704"></a>3
Authoring in XML</h2></div></div></div><p>
An important objective of using XML markup when writing content is to separate what you are writing from how it is formatted and presented. Moreover, describing the individual components of your writing uniquely can allow machine processing of your content. Such machine processing can identify constructs and process them individually as required for the processed result.</p><p>
The vocabulary of XML markup is the level of granularity used to identify constituent information items, and the collection of element and attribute labels applied to the granules.</p><p>
Applying styling to documents is an example of machine processing. The processed result is a formatted representation of your document. When many authors use the same vocabulary, or a given author creates many documents with the same vocabulary, a single set of processes will produce consistently formatted results across the document set.</p><p>
This process is analogous to using styles found in most desktop publishing applications, however by removing from the author the ability to inject arbitrary formatting of information items in their content, two benefits are realized: (a) the author no longer needs to think about formatting, only about appropriately labeling the information items in the content; and (b) authors cannot inadvertently format components of a document with incorrect or inconsistent results.</p><p>
Many writers do, however, prefer the use of their favorite desktop publishing applications and OASIS has posted at <a href="http://docs.oasis-open.org/templates/" target="_top">http://docs.oasis-open.org/templates/</a> a number of templates for widely-adopted word processing programs to be used in the creation of OASIS specifications. Users must be diligent in the use of styles in order to ensure their work conforms to the presentation conventions requested of OASIS. There is an obligation incumbent on the writer to verify their work has not violated the requested conventions, and there are no automated tools with which to validate the constraints have been respected.</p><p> When creating OASIS specifications using XML the burden of formatting is
placed on the stylesheets, not on the writer. The obligation of the
writer is only to be conformant to the DocBook document model for which
the included stylesheets have been designed, and there are automated
validation tools with which the writer can validate the constraints have
not been respected. The writer is also obligated to follow conventions
that reflect the requirements of the OASIS TC Administration for
specification documents, though these are not validated by the DocBook
document models. The conventions are, however, reflected in a template
included in this package.</p><p>
Any resulting violations to the formatting conventions can usually be ascribed to the stylesheets and, when repaired, the authored content usually does not need to change (barring any need to distinguish in the XML an ambiguity that is then being distinguished in the stylesheets).</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e724"></a>3.1
DocBook vocabulary</h3></div></div></div><p> This environment and methodology is based on using the
<code class="sgmltag-element"><article></code> document type of the DocBook 4.4
[<a href="#docbook" title="[DocBook]"><b><span class="abbrev">DocBook</span></b></a>] vocabulary for authoring the content in XML
markup. These explanatory documents do not attempt to teach the DocBook
vocabulary, as there are many online and printed references and manuals
on the use of DocBook.</p><p>
Note that there is a layer of additional constraints imposed on top of the DocBook metadata constructs in order to appropriately identify the constituent metadata components of the OASIS requirements for specifications. No validation constraints for this additional metadata layer are included in this environment, so it is the responsibility of the writer to visually confirm these needs have been satisfied in the rendered results. Missing components are typically the result of the writer not having correctly used the metadata indicators within the standard DocBook constructs.</p><p> The additional constraints are illustrated and documented in <a href="#proforma" title="3.3 Pro forma template">Section 3.3, “ Pro forma template”</a> and included with these materials.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="augmentations"></a>3.2 DocBook augmentations for OASIS specifications</h3></div></div></div><p>These OASIS specification stylesheets recognize the following additional facilities or interpretations when using the DocBook vocabulary:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal"><articleinfo><productname></code> (see <a href="#invokeparam" title="2.5 Stylesheet invocation parameters">Section 2.5, “Stylesheet invocation parameters”</a>)</p></li><li><p><code class="literal"><articleinfo><productnumber></code> (see <a href="#invokeparam" title="2.5 Stylesheet invocation parameters">Section 2.5, “Stylesheet invocation parameters”</a>)</p></li><li><p><code class="literal"><articleinfo><releaseinfo role="OASIS-specification-this"></code><span class="emphasis"><em><code class="literal">{uri}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>reserved role identifying a URI belonging under the "This Version" heading</p></li></ul></div></li><li><p><code class="literal"><articleinfo><releaseinfo role="OASIS-specification-previous"></code><span class="emphasis"><em><code class="literal">{uri}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>reserved role identifying a URI belonging under the "Previous Version" heading</p></li></ul></div></li><li><p><code class="literal"><articleinfo><releaseinfo role="OASIS-specification-latest"></code><span class="emphasis"><em><code class="literal">{uri}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>reserved role identifying a URI belonging under the "Latest Version" heading</p></li></ul></div></li><li><p>release information role suffix "<code class="literal">-draft</code>"</p><div class="itemizedlist"><ul type="circle"><li><p>the "<span class="emphasis"><em><code class="literal">{uri}</code></em></span>" content is not interpreted as a URI but only simply as DocBook content</p></li></ul></div></li><li><p>release information role suffix "<code class="literal">-authoritative</code>"</p><div class="itemizedlist"><ul type="circle"><li><p>the entry is suffixed with the string "(Authoritative)" as is required by OASIS conventions for one of the renditions</p></li></ul></div></li><li><p><code class="literal"><articleinfo><releaseinfo role="committee"></code><span class="emphasis"><em><code class="literal">{text}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>identifying the technical committee section</p></li></ul></div></li><li><p><code class="literal"><articleinfo><legalnotice role="related"></code><span class="emphasis"><em><code class="literal">{content}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>identifying the related work section</p></li></ul></div></li><li><p><code class="literal"><articleinfo><legalnotice role="namespaces"></code><span class="emphasis"><em><code class="literal">{content}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>identifying the namespaces section</p></li></ul></div></li><li><p><code class="literal"><articleinfo><legalnotice role="status"></code><span class="emphasis"><em><code class="literal">{content}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>identifying the status section</p></li></ul></div></li><li><p><code class="literal"><articleinfo><legalnotice role="notices"></code><span class="emphasis"><em><code class="literal">{content}</code></em></span></p><div class="itemizedlist"><ul type="circle"><li><p>identifying the notices section</p></li></ul></div></li><li><p><code class="literal"><phrase role="keyword"></code><span class="emphasis"><em><code class="literal">{text}</code></em></span></phrase></p><div class="itemizedlist"><ul type="circle"><li><p>uppercase the text assuming the text is in English</p></li></ul></div></li><li><p><code class="literal"><table role="font-size-XX"></code></p><div class="itemizedlist"><ul type="circle"><li><p>use a text font of XX for the content of cells in a table, as in <code class="literal"><table role="font-size-90%"></code>:</p><div class="table"><a name="d0e895"></a><p class="title"><i>Table 1. Table with font size of 90%</i></p><table summary="Table with font size of 90%" border="1"><colgroup><col><col></colgroup><tbody><tr><td><span style="font-size:90%">row 1, column 1</span></td><td><span style="font-size:90%">row 1, column 2</span></td></tr><tr><td><span style="font-size:90%">row 2, column 1</span></td><td><span style="font-size:90%">row 2, column 2</span></td></tr></tbody></table></div><p>or as in <code class="literal"><table role="font-size-50%"></code>:</p><div class="table"><a name="d0e915"></a><p class="title"><i>Table 2. Table with font size of 50%</i></p><table summary="Table with font size of 50%" border="1"><colgroup><col><col></colgroup><tbody><tr><td><span style="font-size:50%">row 1, column 1</span></td><td><span style="font-size:50%">row 1, column 2</span></td></tr><tr><td><span style="font-size:50%">row 2, column 1</span></td><td><span style="font-size:50%">row 2, column 2</span></td></tr></tbody></table></div><p>... rather than using the body font size:</p><div class="table"><a name="d0e932"></a><p class="title"><i>Table 3. Table with no use of font size role attribute</i></p><table summary="Table with no use of font size role attribute" border="1"><colgroup><col><col></colgroup><tbody><tr><td>row 1, column 1</td><td>row 1, column 2</td></tr><tr><td>row 2, column 1</td><td>row 2, column 2</td></tr></tbody></table></div></li><li><p>note that the font actually rendered is up to the user agent and so any given size may end up being rendered using a built-in size (e.g. 90% interpreted as 100%)</p></li></ul></div></li><li><p><code class="literal"><programlisting role="font-size-XX"></code></p><div class="itemizedlist"><ul type="circle"><li><p>use a text font of XX for the content of text in a program listing, as in <code class="literal"><programlisting role="font-size-80%"></code>:</p><pre class="programlisting"><span style="font-size:80%">This is the text of a program listing where
newlines are reflected in the output and spacing " " is preserved.
</span></pre><p>or as in <code class="literal"><programlisting role="font-size-50%"></code>:</p><pre class="programlisting"><span style="font-size:50%">This is the text of a program listing where
newlines are reflected in the output and spacing " " is preserved.
</span></pre><p>... rather than using the body font size:</p><pre class="programlisting">This is the text of a program listing where
newlines are reflected in the output and spacing " " is preserved.
</pre></li><li><p>note that the font actually rendered is up to the user agent and so any given size may end up being rendered using a built-in size (e.g. 90% interpreted as 100%)</p></li></ul></div></li><li><p><code class="literal"><?pb?></code></p><div class="itemizedlist"><ul type="circle"><li><p>inject a page break (PDF only)</p></li></ul></div></li><li><p><code class="literal"><?lb?></code></p><div class="itemizedlist"><ul type="circle"><li><p>inject a line break</p></li></ul></div></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="proforma"></a>3.3 Pro forma template</h3></div></div></div><p> This environment includes a pro forma template of a DocBook XML
instance with placeholders for all the OASIS specification metadata
found in the word processing templates. The XML template has one of
every item of metadata and can be used as a guideline when creating the
metadata for a new document. The prose of the document includes a
detailed narrative of the declaration and use of each of the metadata
components.</p><p> The template also includes some limited guidelines to the use of
the DocBook vocabulary that have been carried over from previous
versions of the documentation. With time it is hoped to embellish more
in this section for the benefit of the reader.</p><p> The pro forma template is included as part of the package of this
environment and if the document you are reading is part of a completely
installed collection then it can be found at <a href="template/spectools-docbook-template-wd04.xml" target="_top">template/spectools-docbook-template-wd04.xml</a> and rendered
at <a href="template/spectools-docbook-template-wd04.html" target="_top">template/spectools-docbook-template-wd04.html</a>. Please see
<a href="#template" title="Appendix B Sample specification template">Appendix B, <i>Sample specification template</i></a> for an analysis of the XML
document.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sassoc"></a>3.4
Stylesheet association</h3></div></div></div><p>
Not included in the final published XML source of OASIS specifications are the stylesheet association [<a href="#xml-assoc" title="[xml-assoc]"><b><span class="abbrev">xml-assoc</span></b></a>] processing instructions that are very handy conveniences to use during the authoring process. This methodology mandates their removal from the final published documents, but encourages their use when writing in order to streamline the writer's review of the formatted content.</p><p>
Stylesheet association is not widely employed in the general XML community, typically due to (a) limited awareness by writers of their benefit; and (b) limited conforming support in web browsers.</p><p>
An XSLT stylesheet association processing instruction is structured with two pseudo attributes as follows, indicating the type of the stylesheet being engaged and the location of the stylesheet file producing the HTML rendition:</p><pre class="programlisting"><?xml-stylesheet type="text/xsl" href="place-URL-here"?>
</pre><p>
The benefits of having embedded a stylesheet association processing instruction at the top of one's XML document are realized by opening the XML document being written in a web browser that (a) is aware of the processing instruction; (b) has a conforming XML processor with which to process the stylesheet files; and (c) has a conforming XSLT processor with which to engage the stylesheet files. The act of opening the XML document in the browser engages the HTML stylesheet against the XML content producing the HTML rendition on the browser canvas. At any time during the writing process, merely refreshing the web browser canvas re-engages the stylesheet producing the rendition of the revised content. This removes the necessity to engage the standalone invocation of the stylesheet environment to produce a reviewable rendition.</p><p>
For example, this document was authored in an environment where the locally-installed offline version of the publishing environment is available in the local directory <code class="literal">../spec-0.6/</code>, thus allowing the following stylesheet association processing instruction placed at the top of the XML file before the document type declaration to render the document in an XSLT-aware web browser:</p><pre class="programlisting"><?xml-stylesheet type="text/xsl" href="file:///c:/oasis/
spec-0.6/stylesheets/oasis-specification-html.xsl"?>
</pre><p>
When a document is being authored in an environment where a copy of this publishing environment is embedded with the document directories, the following stylesheet association processing instruction would point to the embedded copy of the stylesheet fragment:</p><pre class="programlisting"><span style="font-size:85%"><?xml-stylesheet type="text/xsl"
href="htmlruntime/spec-0.6/stylesheets/oasis-specification-html.xsl"?>
</span></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>When embedding this stylesheet environment in a document's distribution environment, it is important to prune the stylesheet directories to retain only that which is required for HTML rendering. The only directories needed in the spec-0.6/docbook/xsl directory are: xsl/common, xsl/html and xsl/lib. All other directories should be removed.</p></div><p>
When a document is being authored in an environment where the remotely-installed online version of the publishing environment is to be used, the following stylesheet association processing instruction would work (modulo the latency aspects of accessing resources over the Internet):</p><pre class="programlisting"><?xml-stylesheet type="text/xsl" href="http://docs.oasis-open.org/
templates/DocBook/spec-0.6/stylesheets/oasis-specification-html.xsl"?>
</pre><p>
Many people believe that stylesheet association is a transient property of an XML document and should not be included in any "official" normative XML content. This methodology, therefore, mandates that any such processing instruction that might be used by the author during the writing phase be removed from the final published XML instance.</p></div></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="a.committee"></a>Appendix A Acknowledgments (Non-Normative)</h2><p>This specification environment was written with the generous and appreciated assistance of Paul Knight, Chet Ensign, Mary McRae, Will Norris and Jon Bosak.</p></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="template"></a>Appendix B Sample specification template</h2><p>
This section describes the instance structure and metadata of the DocBook XML instance <a href="template/spectools-docbook-template-wd04.xml" target="_top">template/spectools-docbook-template-wd04.xml</a>, a template geared for use with the specification stylesheets. The summarized markup copied from the instance is split into successive <code class="sgmltag-element">programlisting</code> fragments interspersed with a narrative regarding how to use the markup in the fragment. Braces "<code class="literal">{}</code>" are used to indicate replaceable information and the braces should not be in the final document. There is no obligation to use the techniques used below, though what is below is successfully producing the result you are reading.</p><p> For the purposes of example in the code below, the locally-installed
copy of the OASIS publishing environment is in the directory
<code class="literal">c:/oasis/spec-0.6/</code>.</p><p>
The XML Declaration uses <code class="literal">ISO-8859-1</code> instead of <code class="literal">UTF-8</code> as the content is being typed and remembering the two-byte codes of <code class="literal">UTF-8</code> is sometimes awkward. Alternatively, using <code class="literal">US-ASCII</code> limits the typing entirely to 7-bit ASCII characters, requiring accented and other high-bit characters to be entered with entities.</p><pre class="programlisting"><?xml version="1.0" encoding="ISO-8859-1"?>
</pre><p>
The following is an editing convenience keeping in an XML comment the PUBLIC and SYSTEM identifiers for the document type declaration for each of the online publishing environment, the embedded publishing environment and the local publishing environment. Note how the actual identifiers in this snippet are for the local publishing environment while in the instance you will find the online publishing environment set being used in the document type declaration. When switching back and forth it is a convenience to have a few lines handy for copy/paste, and these are provided at the top of this file (note the URIs for the embedded environment need to be adjusted according to where the directory is located; this snippet is appropriate for this specification document but not for the template location):</p><pre class="programlisting"><span style="font-size:70%"><!--
For use when a committee document points at the OASIS web site for publishing:
<?xml-stylesheet type="text/xsl"
href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/stylesheets/oasis-specification-html.xsl"?>
<!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
For use when a committee document points to an embedded runtime installation:
<?xml-stylesheet type="text/xsl"
href="htmlruntime/spec-0.6/stylesheets/oasis-specification-html.xsl"?>
<!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"htmlruntime/spec-0.6/docbook/docbookx.dtd"
For use when a committee document is published in a local environment only
(note the instructions for local publishing require adjusting the stylesheet
and DocBook directories in these declarations):
<?xml-stylesheet type="text/xsl"
href="file:///c:/oasis/spec-0.6/stylesheets/oasis-specification-html-offline.xsl"?>
<!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"file:///c:/oasis/spec-0.6/docbook/docbookx.dtd"
-->
<?xml-stylesheet type="text/xsl"
href="http://docs.oasis-open.org/templates/DocBook/spec-0.6/stylesheets/oasis-specification-html.xsl"?>
<!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
</span></pre><p>
In the above the XML Stylesheet Association [<a href="#xml-assoc" title="[xml-assoc]"><b><span class="abbrev">xml-assoc</span></b></a>] processing instruction is used to render the XML as HTML for the reader. This is also useful during the authoring process as a convenience for reviewing the rendered version of the authored XML markup when the XML document is open in a conforming browser supporting the association of XSLT stylesheets. After saving any edits to the XML document it is only necessary to refresh the browser to view the rendered results, without requiring any intervening XSLT process.</p><p>
The internal declaration subset uses general entities in order to ensure consistent use of strings throughout the document. The <code class="literal">&name;</code> entity has the base name of the document. The <code class="literal">&version;</code> entity has the version of the document. The <code class="literal">&standard;</code> has the document status which is used in meta data and is often referenced in the prose along the lines of "<code class="literal">This &standard; includes the ...</code>".</p><pre class="programlisting"><span style="font-size:75%">[<!--the document properties-->
<!ENTITY name "spectools-docbook-template">
<!ENTITY pversion "0.3">
<!ENTITY version "0.6">
<!ENTITY stage "wd07">
<!ENTITY standard "Stage and revision / Alternate stage and revision">
<!ENTITY this-loc "http://docs.oasis-open.org/templates/DocBook/spec-&version;/template">
<!ENTITY previous-loc "http://docs.oasis-open.org/templates/DocBook/spec-&pversion;/template">
<!ENTITY latest-loc "http://docs.oasis-open.org/templates/DocBook/oasis-specification/template">
<!ENTITY pubdate "14 June 2012">
</span></pre><p>
The document element for OASIS standards is always <code class="sgmltag-element">article</code>. The status, which can have different simultaneous status values separated by "/", is reflected in an attribute:</p><pre class="programlisting"><article status="&standard;">
</pre><p>
The metadata is kept in the DocBook <code class="sgmltag-element">articleinfo</code> element, starting with the source code control, the name and the version of the document. The stylesheets can use the these information items in the synthesis of filenames (see <a href="#invokeparam" title="2.5 Stylesheet invocation parameters">Section 2.5, “Stylesheet invocation parameters”</a>). Note the use of the entity references for consistency.</p><pre class="programlisting"><span style="font-size:90%"><articleinfo>
<title>Specification Title Version X.X</title>
<releaseinfo role="cvs"> $Id: spectools-docbook-template-wd07.xml,v 1.7 2012/06/14 01:54:35 admin Exp $ </releaseinfo>
<productname>&name;</productname>
<productnumber>&stage;</productnumber>
<releaseinfo role="track">Standards Track Work Product</releaseinfo>
</span></pre><p>
The links to the various instantiations of the document and supporting materials are summarized using <code class="literal">releaseinfo</code> elements with the reserved roles (see <a href="#augmentations" title="3.2 DocBook augmentations for OASIS specifications">Section 3.2, “DocBook augmentations for OASIS specifications”</a>) for as many files as you have. OASIS rules require the identification of the authoritative publication. Note again the use of the entity references for consistency.</p><pre class="programlisting"><releaseinfo role="OASIS-specification-this-authoritative"
>&this-loc;/&name;-&stage;.html</releaseinfo>
<releaseinfo role="OASIS-specification-this"
>&this-loc;/&name;-&stage;.pdf</releaseinfo>
<releaseinfo role="OASIS-specification-this"
>&this-loc;/&name;-&stage;.xml</releaseinfo>
<releaseinfo role="OASIS-specification-previous"
>&previous-loc;/&name;.html</releaseinfo>
<releaseinfo role="OASIS-specification-previous"
>&previous-loc;/&name;.pdf</releaseinfo>
<releaseinfo role="OASIS-specification-previous"
>&previous-loc;/&name;.xml</releaseinfo>
<releaseinfo role="OASIS-specification-latest-authoritative"
>&latest-loc;/&name;.html</releaseinfo>
<releaseinfo role="OASIS-specification-latest"
>&latest-loc;/&name;.pdf</releaseinfo>
<releaseinfo role="OASIS-specification-latest"
>&latest-loc;/&name;.xml</releaseinfo>
</pre><p>
The committee is indicated using <code class="literal">role="committee"</code>.</p><pre class="programlisting"><releaseinfo role="committee"><ulink url="http://www.oasis-open.org/
committees/">OASIS {official name of technical committee} TC</ulink>
</releaseinfo>
</pre><p>
The various people sited in the document are in the <code class="sgmltag-element">authorgroup</code> element, using <code class="sgmltag-element">editor</code> and <code class="sgmltag-element">author</code> for their respective players, and the <code class="sgmltag-element">othercredit</code> element for the committee chairs.</p><pre class="programlisting"><span style="font-size:80%"><authorgroup>
<editor>
<firstname>Jane</firstname>
<surname>Doe</surname>
<affiliation>
<orgname><ulink url="www.example.com">Example
Corporation</ulink></orgname>
</affiliation>
<email>jane.doe@example.com</email>
</editor>
<othercredit>
<firstname>Mary</firstname>
<surname>Baker</surname>
<affiliation>
<orgname>Another Corporation</orgname>
</affiliation>
<email>mary.baker@example.com</email>
</othercredit>
<othercredit>
<firstname>James</firstname>
<surname>Butcher</surname>
<affiliation>
<orgname>Associate Member</orgname>
</affiliation>
<email>james.butcher@example.com</email>
</othercredit>
</authorgroup>
</span></pre><p>
The publishing date is constrained by OASIS conventions to the following format:</p><pre class="programlisting"><pubdate>&pubdate;</pubdate>
</pre><p>
The copyright information is embedded using the <code class="sgmltag-element">copyright</code> element, but note that this information has to be entered as well in the text of the notices.</p><pre class="programlisting"><copyright>
<year>YYYY</year>
<holder>OASIS Open, Inc. All Rights Reserved.</holder>
</copyright>
</pre><p>
When you want to relate this document to additional or related works use <code class="sgmltag-element">legalnotice</code> with <code class="literal">role="additional"</code> or <code class="literal">role="related"</code>.</p><pre class="programlisting"><span style="font-size:80%"><legalnotice role="additional"><title>Additional Work Product artifacts</title>
<para>This prose specification is one component of a Work Product which also includes:</para>
...
</legalnotice>
<legalnotice role="related"><title>Related Work</title>
<para>This specification replaces or supersedes:</para>
...
</legalnotice>
</span></pre><p>
When you want to document the namespaces use <code class="sgmltag-element">legalnotice</code> with <code class="literal">role="namespaces"</code>.</p><pre class="programlisting"><legalnotice role="namespaces">
<title>Declared XML namespaces</title>
<para><ulink url="http://docs.oasis-open.org/ns/{tc-shortname}/xxxx"
>http://docs.oasis-open.org/ns/{tc-shortname}/xxxx</ulink></para>
</legalnotice>
</pre><p>
The abstract has its own DocBook element.</p><pre class="programlisting"><abstract>
<para>{This specification defines...}</para>
</abstract>
</pre><p>
For the status use <code class="sgmltag-element">legalnotice</code> with <code class="literal">role="status"</code>.</p><pre class="programlisting"><legalnotice role="status"><title>Status</title>
<para>{Describe the status and stability ...}</para>
...
</legalnotice>
</pre><p>
For the notices use <code class="sgmltag-element">legalnotice</code> with <code class="literal">role="notices"</code> ensuring you use the appropriate version of the legal notices from the markup in this instance.</p><pre class="programlisting"><legalnotice role="notices"><title>Notices</title>
<para>Copyright © OASIS Open 20??. All Rights Reserved.</para>
...
</legalnotice>
</pre><p>
Thus ends the document metadata. The sections and annexes follow.</p><pre class="programlisting"></articleinfo>
<section id="s.introduction">
...
<appendix>
...
</pre></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="orch"></a>Appendix C Publishing choreography and orchestration (Non-Normative)</h2><p>
There is no obligation to automate the publishing process by choreographing the invocation of validation and production processes, however this methodology offers example orchestrations of these. Note that but for not having a core Ant [<a href="#ant" title="[ant]"><b><span class="abbrev">ant</span></b></a>] task for the invocation of an XSL-FO processor, these guidelines would include such an example using that cross-platform Java-based build tool. It that absence, therefore, this section describes both a Windows command prompt and a Linux shell prompt that you may wish to configure for your own use.</p><p>
The sample choreography invokes three separate processes in turn to produce the results. These processes are made available by Windows batch files and Linux shell scripts that are not included.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e1228"></a>C.1
Windows batch file preparation</h3></div></div></div><p>The example Windows batch file choreography in <a href="template/spectools-docbook-template.bat" target="_top">template/spectools-docbook-template.bat</a> assumes the presence of three support batch files on the command path summarized as follows:</p><div class="itemizedlist"><ul type="disc"><li><pre class="programlisting"> call xmldtd.bat input-XML-file
</pre></li><li><pre class="programlisting"> call xslt.bat input-XML-file stylesheet-XSL-file output-file
</pre></li><li><pre class="programlisting"> call xslfo-pdf.bat input-FO-file output-PDF-file
</pre></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e1246"></a>C.2
Linux shell script preparation</h3></div></div></div><p>The example Linux shell script choreography in <a href="template/spectools-docbook-template.sh" target="_top">template/spectools-docbook-template.sh</a> assumes the presence of three support shell scripts summarized as follows:</p><div class="itemizedlist"><ul type="disc"><li><pre class="programlisting"> sh xmldtd.sh input-XML-file
</pre></li><li><pre class="programlisting"> sh xslt.sh input-XML-file stylesheet-XSL-file output-file
</pre></li><li><pre class="programlisting"> sh xslfo-pdf.sh input-FO-file output-PDF-file
</pre></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e1264"></a>C.3
Sample invocations</h3></div></div></div><p>The stylesheets have been tested with Saxon for XSLT and Antenna House, Ibex and RenderX for XSL-FO.</p><p>
While any conforming XML, XSLT and XSL-FO engine can be used in a given environment, the following Java-based applications and their respective invocations are suitable. There is no obligation, however, to use these as any conforming implementations of validation, transformation and pagination can be used. Note these guidelines leave it up to the reader to download the required support and to appropriately set the required CLASSPATH environments for the following invocations to work.</p><p>
To validate that an XML instance conforms to the constraints of a formal DTD expression, xjparse [<a href="#xjparse" title="[xjparse]"><b><span class="abbrev">xjparse</span></b></a>] can be used to satisfy the <code class="literal">xmldtd</code> script as follows:</p><pre class="programlisting">java -jar xjparse.jar -v %1
</pre><p>
To transform and XML instance using and XSLT expression, Saxon [<a href="#saxon" title="[Saxon]"><b><span class="abbrev">Saxon</span></b></a>] can be used to satisfy the <code class="literal">xslt</code> script as follows:</p><pre class="programlisting">java -jar saxon.jar -o %3 %1 %2
</pre><p>
To transform an XSL-FO instance into a PDF file, FOP [<a href="#fop" title="[FOP]"><b><span class="abbrev">FOP</span></b></a>] can be used to satisfy the <code class="literal">xslfo-pdf</code> script as follows (though note that there may be some conformance challenges with FOP that might present some problems):</p><pre class="programlisting">java org.apache.fop.apps.Fop -fo %1 -pdf %2
</pre><p>To transform an XML instance into PDF in a single step, there is the <code class="literal">stylesheets/xslfo-xml-pdf.bat</code> example invocation file in the package. This invocation takes three arguments (in order): the XML input instance, "<code class="literal">us</code>" or "<code class="literal">a4</code>" (no quotes) to indicate the page size, and the name of the PDF output file. This requires the <code class="literal">saxon.jar</code> XSLT 1.0 executable[<a href="#saxon" title="[Saxon]"><b><span class="abbrev">Saxon</span></b></a>] and the Ibex Signature Edition created for stylesheets from Crane Softwrights[<a href="#ibex-ss" title="[Ibex Signature Edition]"><b><span class="abbrev">Ibex Signature Edition</span></b></a>] (renamed as <code class="literal">ibex-crane-ss.jar</code>). The digital signature manifest <code class="literal">oasis-specification-fo-manifest.xml</code> is tied to the stylesheets as published, thus the processor will not work with these stylesheets if they are modified in any way. The support file <code class="literal">ibexconfig.xml</code> is used to configure font information.</p></div></div></div><table style="font-size:80%" width="100%"><tr><td>oasis-specification-0.6-wd04<br>Non-standards Track Work Product</td><td style="text-align:center"><br>Copyright © OASIS 2012. All rights reserved.</td><td style="text-align:right">14 June 2012</td></tr></table></body></html>