schematronium 0.0.0-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,723 @@
1
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
+ <HTML>
3
+ <HEAD>
4
+ <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
5
+ <TITLE>The ISO Schematron Skeleton API</TITLE>
6
+ <META NAME="GENERATOR" CONTENT="OpenOffice.org 2.4 (Win32)">
7
+ <META NAME="CREATED" CONTENT="0;0">
8
+ <META NAME="CHANGED" CONTENT="20080808;2200065">
9
+ </HEAD>
10
+ <BODY LANG="en-AU" DIR="LTR">
11
+ <H1>API for ISO Schematron Skeleton</H1>
12
+ <H2><BR><BR>
13
+ </H2>
14
+ <P>Rick Jelliffe, 2010/04/14</P>
15
+ <P>This document provides documentation on the XSLT API available in
16
+ the implementation of Schematron called <TT>iso_schematron_skeleton.xsl</TT>.
17
+ (available in an XSLT1 and XSLT2 version). The API makes available as
18
+ much information from the schema, however there may be some edge
19
+ cases where it is not exhaustive.
20
+ </P>
21
+ <P>The <I>skeleton</I> is an XSLT script which provides all the basic
22
+ parsing and validating routines for compiling a Schematron schema
23
+ into XSLT. Schematron was designed to allow many different uses, and
24
+ the skeleton gives you a headstart in creating a customized
25
+ implementation. You just need to write XSLT templates to override the
26
+ default ones. (The program you write is sometimes called a
27
+ <I>meta-stylesheet</I>.) It is the meta-stylesheet that is called
28
+ as the XSLT script, not the skeleton. There are several
29
+ pre-processing stages which the Schematron schema should be processed
30
+ through first, to handle such things as include statements and
31
+ abstract patterns.
32
+ </P>
33
+ <P>Phases and error reporting for problems in the schema itself are
34
+ handled by the skeleton with no interaction with a &ldquo;meta-stylesheet&rdquo;.
35
+ Note that there is no guarantee that the context node is always the
36
+ element being handled: in most cases the only information available
37
+ is the information in the parameters.
38
+ </P>
39
+ <P>For an introductory tutorial on using this API, see Bob DuCharme's
40
+ <A HREF="http://www.xml.com/pub/a/2004/10/05/tr.html">Schematron 1.5:
41
+ Looking Under the Hood</A>
42
+ </P>
43
+ <H1>Superset of API for Schematron 1.5 and 1.6</H1>
44
+ <P>(This is an updated version of the API for the Schematron 1.5
45
+ implementation called <TT>skeleton1-5.xsl</TT>, which in turn comes
46
+ from the <I>new architecture</I> contributed by Oliver Becker for
47
+ Schematron 1.3.)</P>
48
+ <P>The current API contains only additions. Well-written
49
+ meta-stylesheets that use the new API will be be able to run on the
50
+ existing 1.5 and 1.6 skeletons. Similarly, it should be possible to
51
+ upgrade the skeleton from 1.5 or 1.6 to the iso-schematron-skeleton
52
+ only by correcting the import statement at the beginning of the
53
+ meta-stylsheet. Additions or re-groupings from the 1.5 schema are
54
+ shown in red. Deletions have overstrike.</P>
55
+ <P>Mooted addition: a parameter @action which for specifying
56
+ processing instructions on assertions and reports.</P>
57
+ <HR>
58
+ <H2><TT>process-prolog</TT></H2>
59
+ <P>The <TT>process-prolog</TT> template gets called at the start of
60
+ the validation session. It has no parameters. The default
61
+ implementation is no action.</P>
62
+ <HR>
63
+ <H2><TT>process-root</TT></H2>
64
+ <P>The <TT>process-root</TT> template processes the root element of
65
+ the schema (which is not the same thing as the root of the document /
66
+ and need not be the document element /*) .</P>
67
+ <DL>
68
+ <DT><TT><I>node-list</I></TT><TT> $contents</TT>
69
+ </DT><DT>
70
+ <TT><I>string</I></TT><TT> $schemaVersion</TT>
71
+ </DT><DD>
72
+ The version of the schema, perhaps a datestamp.
73
+ </DD><DT>
74
+ <TT><FONT COLOR="#ff0000"><I>&quot;xslt&quot; | &quot;xpath&quot; |
75
+ &quot;xslt2&quot; | ...</I></FONT></TT><TT><FONT COLOR="#ff0000">
76
+ $queryBinding</FONT></TT><FONT COLOR="#ff0000"> </FONT>
77
+ </DT><DD>
78
+ <FONT COLOR="#ff0000">The query language binding. </FONT>
79
+ </DD><DT>
80
+ <TT><I>string</I></TT><TT> $title</TT>
81
+ </DT><DD>
82
+ The title of this schema
83
+ </DD><DT>
84
+ <TT><FONT COLOR="#ff0000"><I>&quot;iso&quot; | &quot;1.5&quot; |
85
+ &quot;1.6&quot; | ...</I></FONT></TT><TT><FONT COLOR="#ff0000">
86
+ $version</FONT></TT><FONT COLOR="#ff0000"> </FONT>
87
+ </DT><DD STYLE="margin-bottom: 0.5cm">
88
+ <FONT COLOR="#ff0000">The version of Schematron being used. </FONT>
89
+ </DD></DL>
90
+ <P>
91
+ Rich properties:</P>
92
+ <DL>
93
+ <DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
94
+ $icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
95
+ </DT><DD>
96
+ <FONT COLOR="#ff0000">The URI of an icon </FONT>
97
+ </DD><DT>
98
+ <TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
99
+ $id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
100
+ </DT><DD>
101
+ <FONT COLOR="#ff0000">The unique identifier with the schema for the
102
+ </FONT><TT><FONT COLOR="#ff0000">schema</FONT></TT><FONT COLOR="#ff0000">
103
+ element. </FONT>
104
+ </DD><DT>
105
+ <TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
106
+ $fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
107
+ </DT><DD>
108
+ <FONT COLOR="#ff0000">The Formal Public Identifier for this schema. </FONT>
109
+ </DD><DT>
110
+ <TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
111
+ $lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
112
+ </DT><DD>
113
+ <FONT COLOR="#ff0000">The human language used in this schema, from
114
+ xml:lang </FONT>
115
+ </DD><DT>
116
+ <TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
117
+ $see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
118
+ </DT><DD>
119
+ <FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
120
+ </DD><DT>
121
+ <TT><FONT COLOR="#ff0000"><I>&quot;preserve&quot; | &quot;default&quot;</I></FONT></TT><TT><FONT COLOR="#ff0000">
122
+ $space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
123
+ </DT><DD STYLE="margin-bottom: 0.5cm">
124
+ <FONT COLOR="#ff0000">The value for xml:space </FONT>
125
+ </DD></DL>
126
+ <P>
127
+ To print the documentation paragraphs, use <TT>&lt;xsl:apply-templates
128
+ mode=&quot;do-schema-p&quot; /&gt;</TT></P>
129
+ <P>To output the results, use <TT>&lt;xsl:copy-of select=&quot;$contents&quot;
130
+ /&gt;</TT></P>
131
+ <HR>
132
+ <H2><TT>process-assert</TT></H2>
133
+ <P>The <TT>process-assert</TT> template handles asserts whose test
134
+ has failed.
135
+ </P>
136
+ <DL>
137
+ <DT><TT><I>XPath</I></TT><TT> $test</TT>
138
+ </DT><DD>
139
+ The test
140
+ </DD><DT>
141
+ <TT><I>XML IDREFS</I></TT><TT> $diagnostics</TT>
142
+ </DT><DD>
143
+ A list of the idrefs diagnostic elements related to the current
144
+ assertion
145
+ </DD><DT>
146
+ <TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
147
+ $flag</FONT></TT><FONT COLOR="#ff0000"> </FONT>
148
+ </DT><DD STYLE="margin-bottom: 0.5cm">
149
+ <FONT COLOR="#ff0000">The name of a flag that becomes true because
150
+ this assertion fails. The flag is true for the document if it is
151
+ flagged true on any assertion. For compatability, this parameter
152
+ should not be used with Schematron 1.5.</FONT>
153
+ </DD></DL>
154
+ <P>
155
+ Rich properties:</P>
156
+ <DL>
157
+ <DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
158
+ $icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
159
+ </DT><DD>
160
+ <FONT COLOR="#ff0000">The URI of an icon </FONT>
161
+ </DD><DT>
162
+ <TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
163
+ $id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
164
+ </DT><DD>
165
+ <FONT COLOR="#ff0000">The unique identifier with the schema for the
166
+ </FONT><TT><FONT COLOR="#ff0000">assert</FONT></TT><FONT COLOR="#ff0000">
167
+ element. </FONT>
168
+ </DD><DT>
169
+ <TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
170
+ $fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
171
+ </DT><DD>
172
+ <FONT COLOR="#ff0000">The Formal Public Identifier for this
173
+ assertion. </FONT>
174
+ </DD><DT>
175
+ <TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
176
+ $lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
177
+ </DT><DD>
178
+ <FONT COLOR="#ff0000">The human language used in this assertion,
179
+ from xml:lang </FONT>
180
+ </DD><DT>
181
+ <TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
182
+ $see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
183
+ </DT><DD>
184
+ <FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
185
+ </DD><DT>
186
+ <TT><FONT COLOR="#ff0000"><I>&quot;preserve&quot; | &quot;default&quot;</I></FONT></TT><TT><FONT COLOR="#ff0000">
187
+ $space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
188
+ </DT><DD STYLE="margin-bottom: 0.5cm">
189
+ <FONT COLOR="#ff0000">The value for xml:space </FONT>
190
+ </DD></DL>
191
+ <P>
192
+ Linking properties:</P>
193
+ <DL>
194
+ <DT><TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
195
+ $role</FONT></TT><FONT COLOR="#ff0000"> </FONT>
196
+ </DT><DD>
197
+ <FONT COLOR="#ff0000">A name for the generic role of this assertion.
198
+ The schema creator would have their own vocabulary. </FONT>
199
+ </DD><DT>
200
+ <TT><FONT COLOR="#ff0000"><I>XPath</I></FONT></TT><TT><FONT COLOR="#ff0000">
201
+ $subject</FONT></TT><FONT COLOR="#ff0000"> </FONT>
202
+ </DT><DD STYLE="margin-bottom: 0.5cm">
203
+ <FONT COLOR="#ff0000">A path relative to the current context to some
204
+ interesting node considered the subject. </FONT>
205
+ </DD></DL>
206
+ <P>
207
+ To print the text contents, use <TT>&lt;xsl:apply-templates
208
+ mode=&quot;text&quot; /&gt;</TT></P>
209
+ <HR>
210
+ <H2><TT>process-diagnostic</TT></H2>
211
+ <P>The <TT>process-diagnostic</TT> template handles diagnostic
212
+ messages for <TT>assert</TT> statements that have failed and <TT>report</TT>
213
+ statements that have succeeded. The diagnostics are evaluated in the
214
+ context of the rule.</P>
215
+ <P>Rich properties:</P>
216
+ <DL>
217
+ <DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
218
+ $icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
219
+ </DT><DD>
220
+ <FONT COLOR="#ff0000">The URI of an icon </FONT>
221
+ </DD><DT>
222
+ <TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
223
+ $id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
224
+ </DT><DD>
225
+ <FONT COLOR="#ff0000">The unique identifier with the schema for the
226
+ </FONT><TT><FONT COLOR="#ff0000">assert</FONT></TT><FONT COLOR="#ff0000">
227
+ element. </FONT>
228
+ </DD><DT>
229
+ <TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
230
+ $fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
231
+ </DT><DD>
232
+ <FONT COLOR="#ff0000">The Formal Public Identifier for this
233
+ assertion. </FONT>
234
+ </DD><DT>
235
+ <TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
236
+ $lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
237
+ </DT><DD>
238
+ <FONT COLOR="#ff0000">The human language used in this assertion,
239
+ from xml:lang </FONT>
240
+ </DD><DT>
241
+ <TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
242
+ $see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
243
+ </DT><DD>
244
+ <FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
245
+ </DD><DT>
246
+ <TT><FONT COLOR="#ff0000"><I>&quot;preserve&quot; | &quot;default&quot;</I></FONT></TT><TT><FONT COLOR="#ff0000">
247
+ $space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
248
+ </DT><DD STYLE="margin-bottom: 0.5cm">
249
+ <FONT COLOR="#ff0000">The value for xml:space </FONT>
250
+ </DD><HR>
251
+ </DL>
252
+ <H2><TT>process-dir</TT></H2>
253
+ <P>The <TT>process-dir</TT> template handles bi-directionality
254
+ markup, which is only needed by certain human scripts such as Arabic.</P>
255
+ <DL>
256
+ <DT><TT><I>&quot;ltr&quot; or &quot;rtl&quot; or &quot;&quot;</I></TT><TT>
257
+ $value</TT>
258
+ </DT><DD STYLE="margin-bottom: 0.5cm">
259
+ Left-to-right or right-to-left or unspecified
260
+ </DD><HR>
261
+ </DL>
262
+ <H2><TT>process-emph</TT></H2>
263
+ <P>The <TT>process-emph</TT> template handles the markup of
264
+ emphasized text in paragraphs, assertions and diagnostics. It has no
265
+ parameters.</P>
266
+ <HR>
267
+ <H2><TT>process-message</TT></H2>
268
+ <P>The <TT>process-message</TT> handles default outputing of text.</P>
269
+ <DL>
270
+ <DT><TT><I>string</I></TT><TT> $pattern</TT>
271
+ </DT><DD>
272
+ Some text that may be some kind of pattern
273
+ </DD><DT>
274
+ <TT><I>string</I></TT><TT> $role</TT>
275
+ </DT><DD STYLE="margin-bottom: 0.5cm">
276
+ Some text that may be some kind of role
277
+ </DD><HR>
278
+ </DL>
279
+ <H2><TT>process-name</TT></H2>
280
+ <P>The <TT>process-name</TT> templates handle name strings that can
281
+ be used in assertions. <TT>asssert</TT> and <TT>report</TT> only
282
+ provide <TT>name</TT> subelements rather than the more general
283
+ <TT>value-of</TT> elements to encourage plain language and generic
284
+ descriptions rather than specific diagnostics, for which purpose the
285
+ <TT>diagnostics</TT> elements are used.</P>
286
+ <DL>
287
+ <DT><TT><I>string</I></TT><TT> $name</TT>
288
+ </DT><DD STYLE="margin-bottom: 0.5cm">
289
+ The name of the current element, or of the node specified by a <TT>name</TT>
290
+ element
291
+ </DD><HR>
292
+ </DL>
293
+ <H2><TT>process-ns</TT></H2>
294
+ <P>The <TT>process-ns</TT> template reports on <TT>ns</TT>
295
+ declarations, which are used to transmit on namespace information by
296
+ the skeleton.</P>
297
+ <DL>
298
+ <DT><TT><I>Namespace NCName</I></TT><TT> $prefix</TT>
299
+ </DT><DD>
300
+ The prefix of a namespace
301
+ </DD><DT>
302
+ <TT><I>XML SystemId</I></TT><TT> $uri</TT>
303
+ </DT><DD STYLE="margin-bottom: 0.5cm">
304
+ The (internationalized) URI Reference of a namespace
305
+ </DD><HR>
306
+ </DL>
307
+ <H2><TT>process-p</TT></H2>
308
+ <P>The <TT>process-p</TT> template handles paragraphs.</P>
309
+ <DL>
310
+ <DT><TT><I>XML NMTOKEN</I></TT><TT> $class</TT>
311
+ </DT><DD>
312
+ An attribute that can be used for stylesheet style
313
+ </DD><DT>
314
+ <TT><I>XML ID</I></TT><TT> $id</TT>
315
+ </DT><DD>
316
+ The unique identifier with the schema for the <TT>p</TT> element.
317
+ </DD><DT>
318
+ <TT><I>XML SystemId</I></TT><TT> $icon</TT>
319
+ </DT><DD>
320
+ The URI of an icon
321
+ </DD><DT>
322
+ <TT><I>IETF Language</I></TT><TT> $lang</TT>
323
+ </DT><DD STYLE="margin-bottom: 0.5cm">
324
+ The human language used in this paragraph
325
+ </DD></DL>
326
+ <P>
327
+ To print the text contents, use <TT>&lt;xsl:apply-templates
328
+ mode=&quot;text&quot; /&gt;</TT>
329
+ </P>
330
+ <HR>
331
+ <H2><TT>process-pattern</TT></H2>
332
+ <P>The <TT>process-pattern</TT> reports on the start of evaluation of
333
+ a <TT>pattern</TT> element.</P>
334
+ <DL>
335
+ <DT><TT><I>string</I></TT><TT> $name</TT>
336
+ </DT><DD>
337
+ The title of the current pattern
338
+ </DD><DT>
339
+ <TT><I>XML NCNAMES</I></TT><TT> $is-a</TT>
340
+ </DT><DD STYLE="margin-bottom: 0.5cm">
341
+ Empty or not provided if the pattern is not derived from an abstract
342
+ pattern. Otherwise the name of the abstract pattern. A list may be
343
+ used if there was a sequence of abstract patterns.
344
+ </DD></DL>
345
+ <P>
346
+ Rich properties:</P>
347
+ <DL>
348
+ <DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
349
+ $icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
350
+ </DT><DD>
351
+ <FONT COLOR="#ff0000">The URI of an icon </FONT>
352
+ </DD><DT>
353
+ <TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
354
+ $id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
355
+ </DT><DD>
356
+ <FONT COLOR="#ff0000">The unique identifier with the schema for the
357
+ </FONT><TT><FONT COLOR="#ff0000">pattern</FONT></TT><FONT COLOR="#ff0000">
358
+ element. </FONT>
359
+ </DD><DT>
360
+ <TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
361
+ $fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
362
+ </DT><DD>
363
+ <FONT COLOR="#ff0000">The Formal Public Identifier for this pattern.
364
+ </FONT>
365
+ </DD><DT>
366
+ <TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
367
+ $lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
368
+ </DT><DD>
369
+ <FONT COLOR="#ff0000">The human language used in this pattern, from
370
+ xml:lang </FONT>
371
+ </DD><DT>
372
+ <TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
373
+ $see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
374
+ </DT><DD>
375
+ <FONT COLOR="#ff0000">A (internationalized) URI reference to some
376
+ supporting or defining documentation </FONT>
377
+ </DD><DT>
378
+ <TT><FONT COLOR="#ff0000"><I>&quot;preserve&quot; | &quot;default&quot;</I></FONT></TT><TT><FONT COLOR="#ff0000">
379
+ $space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
380
+ </DT><DD STYLE="margin-bottom: 0.5cm">
381
+ <FONT COLOR="#ff0000">The value for xml:space </FONT>
382
+ </DD></DL>
383
+ <P>
384
+ To print the documentation contents, use <TT>&lt;xsl:apply-templates
385
+ mode=&quot;do-pattern-p&quot;/&gt;</TT></P>
386
+ <HR>
387
+ <H2><TT>process-report</TT></H2>
388
+ <P>The <TT>process-report</TT> template handles <TT>report</TT> whose
389
+ test has succeeded.
390
+ </P>
391
+ <DL>
392
+ <DT><TT><I>XPath</I></TT><TT> $test</TT>
393
+ </DT><DD>
394
+ The test
395
+ </DD><DT>
396
+ <TT><I>XML IDREFS</I></TT><TT> $diagnostics</TT>
397
+ </DT><DD>
398
+ A list of the diagnostic elements related to the current assertion
399
+ </DD><DT>
400
+ <TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
401
+ $flag</FONT></TT><FONT COLOR="#ff0000"> </FONT>
402
+ </DT><DD STYLE="margin-bottom: 0.5cm">
403
+ <FONT COLOR="#ff0000">The name of a flag that becomes true because
404
+ this assertion fails. The flag is true for the document if it is
405
+ flagged true on any assertion. For compatability, this parameter
406
+ should not be used with Schematron 1.5.</FONT>
407
+ </DD></DL>
408
+ <P>
409
+ Rich properties:</P>
410
+ <DL>
411
+ <DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
412
+ $icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
413
+ </DT><DD>
414
+ <FONT COLOR="#ff0000">The URI of an icon </FONT>
415
+ </DD><DT>
416
+ <TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
417
+ $id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
418
+ </DT><DD>
419
+ <FONT COLOR="#ff0000">The unique identifier with the schema for the
420
+ </FONT><TT><FONT COLOR="#ff0000">report</FONT></TT><FONT COLOR="#ff0000">
421
+ element. </FONT>
422
+ </DD><DT>
423
+ <TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
424
+ $fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
425
+ </DT><DD>
426
+ <FONT COLOR="#ff0000">The Formal Public Identifier for this report. </FONT>
427
+ </DD><DT>
428
+ <TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
429
+ $lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
430
+ </DT><DD>
431
+ <FONT COLOR="#ff0000">The human language used in this report, from
432
+ xml:lang </FONT>
433
+ </DD><DT>
434
+ <TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
435
+ $see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
436
+ </DT><DD>
437
+ <FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
438
+ </DD><DT>
439
+ <TT><FONT COLOR="#ff0000"><I>&quot;preserve&quot; | &quot;default&quot;</I></FONT></TT><TT><FONT COLOR="#ff0000">
440
+ $space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
441
+ </DT><DD STYLE="margin-bottom: 0.5cm">
442
+ <FONT COLOR="#ff0000">The value for xml:space </FONT>
443
+ </DD></DL>
444
+ <P>
445
+ Linking properties:</P>
446
+ <DL>
447
+ <DT><TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
448
+ $role</FONT></TT><FONT COLOR="#ff0000"> </FONT>
449
+ </DT><DD>
450
+ <FONT COLOR="#ff0000">A name for the generic role of this assertion.
451
+ The schema creator would have their own vocabulary. </FONT>
452
+ </DD><DT>
453
+ <TT><FONT COLOR="#ff0000"><I>XPath</I></FONT></TT><TT><FONT COLOR="#ff0000">
454
+ $subject</FONT></TT><FONT COLOR="#ff0000"> </FONT>
455
+ </DT><DD STYLE="margin-bottom: 0.5cm">
456
+ <FONT COLOR="#ff0000">A path relative to the current context to some
457
+ interesting node considered the subject. </FONT>
458
+ </DD></DL>
459
+ <P>
460
+ To print the text contents, use <TT>&lt;xsl:apply-templates
461
+ mode=&quot;text&quot; /&gt;</TT></P>
462
+ <HR>
463
+ <H2><TT>process-rule</TT></H2>
464
+ <P>The <TT>process-rule</TT> reports that a <TT>rule</TT> element has
465
+ fired: its <TT>context</TT> attribute matched some nodes. .</P>
466
+ <DL>
467
+ <DT><TT><I>XSLT expression</I></TT><TT> $context</TT>
468
+ </DT><DD STYLE="margin-bottom: 0.5cm">
469
+ The expression that gives the context of the current
470
+ </DD></DL>
471
+ <P>
472
+ Rich properties:</P>
473
+ <DL>
474
+ <DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
475
+ $icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
476
+ </DT><DD>
477
+ <FONT COLOR="#ff0000">The URI of an icon </FONT>
478
+ </DD><DT>
479
+ <TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
480
+ $id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
481
+ </DT><DD>
482
+ <FONT COLOR="#ff0000">The unique identifier with the schema for this
483
+ </FONT><TT><FONT COLOR="#ff0000">rule</FONT></TT><FONT COLOR="#ff0000">
484
+ element. </FONT>
485
+ </DD><DT>
486
+ <TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
487
+ $fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
488
+ </DT><DD>
489
+ <FONT COLOR="#ff0000">The Formal Public Identifier for this rule. </FONT>
490
+ </DD><DT>
491
+ <TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
492
+ $lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
493
+ </DT><DD>
494
+ <FONT COLOR="#ff0000">The human language used in this rule, from
495
+ xml:lang </FONT>
496
+ </DD><DT>
497
+ <TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
498
+ $see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
499
+ </DT><DD>
500
+ <FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
501
+ </DD><DT>
502
+ <TT><FONT COLOR="#ff0000"><I>&quot;preserve&quot; | &quot;default&quot;</I></FONT></TT><TT><FONT COLOR="#ff0000">
503
+ $space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
504
+ </DT><DD STYLE="margin-bottom: 0.5cm">
505
+ <FONT COLOR="#ff0000">The value for xml:space </FONT>
506
+ </DD></DL>
507
+ <P>
508
+ Linking properties:</P>
509
+ <DL>
510
+ <DT><TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
511
+ $role</FONT></TT><FONT COLOR="#ff0000"> </FONT>
512
+ </DT><DD>
513
+ <FONT COLOR="#ff0000">A name for the generic role of this assertion.
514
+ The schema creator would have their own vocabulary. </FONT>
515
+ </DD><DT>
516
+ <TT><FONT COLOR="#ff0000"><I>XPath</I></FONT></TT><TT><FONT COLOR="#ff0000">
517
+ $subject</FONT></TT><FONT COLOR="#ff0000"> </FONT>
518
+ </DT><DD STYLE="margin-bottom: 0.5cm">
519
+ <FONT COLOR="#ff0000">A path relative to the current context to some
520
+ interesting node considered the subject. </FONT>
521
+ </DD><HR>
522
+ </DL>
523
+ <H2><TT>process-span</TT></H2>
524
+ <P>The <TT>process-span</TT> handles span elements, which are generic
525
+ elements for styling, like HTML's .</P>
526
+ <DL>
527
+ <DT><TT><I>XML NMTOKEN</I></TT><TT> $class</TT>
528
+ </DT><DD STYLE="margin-bottom: 0.5cm">
529
+ An attribute that can be used for stylesheet style
530
+ </DD><HR>
531
+ </DL>
532
+ <H2><TT>process-title</TT></H2>
533
+ <P>The <TT>process-title</TT> handles title elements, which are
534
+ generic elements for styling, like HTML's .</P>
535
+ <DL>
536
+ <DT><TT><I>XML NMTOKEN</I></TT><TT> $class</TT>
537
+ </DT><DD STYLE="margin-bottom: 0.5cm">
538
+ An attribute that can be used for stylesheet style
539
+ </DD></DL>
540
+ <P>
541
+ By default, titles are handled by invocing <TT>process-p</TT> with
542
+ the parameter class with a value &quot;title&quot;.</P>
543
+ <HR>
544
+ <H2><TT>process-value-of</TT></H2>
545
+ <P>The <TT>process-value-of</TT> template handles <TT>value-of</TT>
546
+ elements, which are used in diagnostic messages to allow very
547
+ specific hinting .</P>
548
+ <DL>
549
+ <DT><TT><I>XPath</I></TT><TT> $select</TT>
550
+ </DT><DD STYLE="margin-bottom: 0.5cm">
551
+ The path of some node that will be evaluated and printed.</DD><HR>
552
+ </DL>
553
+ <H1>Global Parameters</H1>
554
+ <P>There are several global parameters that may be available for use.
555
+ However, it is not a requirement to follow these, and implementations
556
+ may not supply them with any value. So a test of
557
+ string-length(<I>variable</I><SPAN STYLE="font-style: normal">) &lt;
558
+ 0 is appropriate in each case.</SPAN></P>
559
+ <P><BR><BR>
560
+ </P>
561
+ <TABLE WIDTH=557 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=1 CELLSPACING=0>
562
+ <COL WIDTH=132>
563
+ <COL WIDTH=77>
564
+ <COL WIDTH=340>
565
+ <TR>
566
+ <TD WIDTH=132>
567
+ <P ALIGN=CENTER><FONT SIZE=2><B>Parameter</B></FONT></P>
568
+ </TD>
569
+ <TD WIDTH=77>
570
+ <P ALIGN=CENTER><FONT SIZE=2><B>Value</B></FONT></P>
571
+ </TD>
572
+ <TD WIDTH=340>
573
+ <P ALIGN=CENTER><FONT SIZE=2><B>Description</B></FONT></P>
574
+ </TD>
575
+ </TR>
576
+ <TR>
577
+ <TD WIDTH=132>
578
+ <P><FONT SIZE=2>allow-foreign</FONT></P>
579
+ </TD>
580
+ <TD WIDTH=77>
581
+ <P><FONT SIZE=2>&quot;true&quot; | &quot;false&quot; (default) </FONT>
582
+ </P>
583
+ </TD>
584
+ <TD WIDTH=340>
585
+ <P><FONT SIZE=2>Pass non-Schematron elements to the generated
586
+ stylesheet. Pass the Schematron elements span, emph and dir: to
587
+ the output SVRL. </FONT>
588
+ </P>
589
+ </TD>
590
+ </TR>
591
+ <TR>
592
+ <TD WIDTH=132>
593
+ <P><FONT SIZE=2>fileNameParameter</FONT></P>
594
+ </TD>
595
+ <TD WIDTH=77>
596
+ <P><FONT SIZE=2>string</FONT></P>
597
+ </TD>
598
+ <TD WIDTH=340>
599
+ <P><FONT SIZE=2>A parameter passed to the Validator and
600
+ potentially available as a variable in Schematron schemas as
601
+ $fileNameParameter</FONT></P>
602
+ </TD>
603
+ </TR>
604
+ <TR>
605
+ <TD WIDTH=132>
606
+ <P><FONT SIZE=2>fileDirParameter</FONT></P>
607
+ </TD>
608
+ <TD WIDTH=77>
609
+ <P><FONT SIZE=2>string</FONT></P>
610
+ </TD>
611
+ <TD WIDTH=340>
612
+ <P><FONT SIZE=2>A parameter passed to the Validator and
613
+ potentially available as a variable in Schematron schemas as
614
+ $fileDirParameter</FONT></P>
615
+ </TD>
616
+ </TR>
617
+ <TR>
618
+ <TD WIDTH=132>
619
+ <P><FONT SIZE=2>archiveNamePaameter</FONT></P>
620
+ </TD>
621
+ <TD WIDTH=77>
622
+ <P><FONT SIZE=2>string</FONT></P>
623
+ </TD>
624
+ <TD WIDTH=340>
625
+ <P><FONT SIZE=2>A parameter passed to the Validator and
626
+ potentially available as a variable in Schematron schemas as
627
+ $archiveNameParameter</FONT></P>
628
+ </TD>
629
+ </TR>
630
+ <TR>
631
+ <TD WIDTH=132>
632
+ <P><FONT SIZE=2>archiveDirParameter</FONT></P>
633
+ </TD>
634
+ <TD WIDTH=77>
635
+ <P><FONT SIZE=2>string</FONT></P>
636
+ </TD>
637
+ <TD WIDTH=340>
638
+ <P><FONT SIZE=2>A parameter passed to the Validator and
639
+ potentially available as a variable in Schematron schemas as
640
+ $archivePathParameter</FONT></P>
641
+ </TD>
642
+ </TR>
643
+ <TR>
644
+ <TD WIDTH=132>
645
+ <P><FONT SIZE=2>debug </FONT>
646
+ </P>
647
+ </TD>
648
+ <TD WIDTH=77>
649
+ <P>&ldquo;<FONT SIZE=2>true&rdquo; | &ldquo;false&rdquo; (default)</FONT></P>
650
+ </TD>
651
+ <TD WIDTH=340>
652
+ <P><FONT SIZE=2>Verbose error messages (Note this may be
653
+ superceded by &ldquo;verbose&rdquo; at some stage in the future.)</FONT></P>
654
+ </TD>
655
+ </TR>
656
+ <TR>
657
+ <TD WIDTH=132>
658
+ <P><FONT SIZE=2>generate-paths</FONT></P>
659
+ </TD>
660
+ <TD WIDTH=77>
661
+ <P><FONT SIZE=2>true|false </FONT>
662
+ </P>
663
+ </TD>
664
+ <TD WIDTH=340>
665
+ <P><FONT SIZE=2>generate the SVRL @location attribute with XPaths</FONT></P>
666
+ </TD>
667
+ </TR>
668
+ <TR>
669
+ <TD WIDTH=132>
670
+ <P><FONT SIZE=2>diagnose</FONT></P>
671
+ </TD>
672
+ <TD WIDTH=77>
673
+ <P><FONT SIZE=2>yes | no </FONT>
674
+ </P>
675
+ </TD>
676
+ <TD WIDTH=340>
677
+ <P><FONT SIZE=2>Add the diagnostics to the assertion results</FONT></P>
678
+ </TD>
679
+ </TR>
680
+ <TR>
681
+ <TD WIDTH=132>
682
+ <P><A NAME="DDE_LINK"></A><FONT SIZE=2>terminate</FONT></P>
683
+ </TD>
684
+ <TD WIDTH=77>
685
+ <P><FONT SIZE=2>yes | no | true | false | assert</FONT>
686
+ </P>
687
+ </TD>
688
+ <TD WIDTH=340>
689
+ <P><FONT SIZE=2>Terminate on the first failed assertion or
690
+ successful report</FONT></P>
691
+ </TD>
692
+ </TR>
693
+ <TR>
694
+ <TD WIDTH=132>
695
+ <P><FONT SIZE=2>message-newline </FONT>
696
+ </P>
697
+ </TD>
698
+ <TD WIDTH=77>
699
+ <P><FONT SIZE=2>&quot;true&quot; (default) | &quot;false&quot; </FONT>
700
+ </P>
701
+ </TD>
702
+ <TD WIDTH=340>
703
+ <P><FONT SIZE=2>Generate an extra newline at the end of messages</FONT></P>
704
+ </TD>
705
+ </TR>
706
+ <TR>
707
+ <TD WIDTH=132>
708
+ <P><FONT SIZE=2>output-encoding</FONT></P>
709
+ </TD>
710
+ <TD WIDTH=77>
711
+ <P><FONT SIZE=2>string</FONT></P>
712
+ </TD>
713
+ <TD WIDTH=340>
714
+ <P><FONT SIZE=2>The encoding used for output, for example if the
715
+ output is XML</FONT></P>
716
+ </TD>
717
+ </TR>
718
+ </TABLE>
719
+ <DL>
720
+ <DD STYLE="margin-bottom: 0.5cm">
721
+ </DD></DL>
722
+ </BODY>
723
+ </HTML>