This repository has been archived by the owner on Aug 30, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
/
schematron-skeleton-api.htm
723 lines (723 loc) · 26.4 KB
/
schematron-skeleton-api.htm
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
<TITLE>The ISO Schematron Skeleton API</TITLE>
<META NAME="GENERATOR" CONTENT="OpenOffice.org 2.4 (Win32)">
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGED" CONTENT="20080808;2200065">
</HEAD>
<BODY LANG="en-AU" DIR="LTR">
<H1>API for ISO Schematron Skeleton</H1>
<H2><BR><BR>
</H2>
<P>Rick Jelliffe, 2010/04/14</P>
<P>This document provides documentation on the XSLT API available in
the implementation of Schematron called <TT>iso_schematron_skeleton.xsl</TT>.
(available in an XSLT1 and XSLT2 version). The API makes available as
much information from the schema, however there may be some edge
cases where it is not exhaustive.
</P>
<P>The <I>skeleton</I> is an XSLT script which provides all the basic
parsing and validating routines for compiling a Schematron schema
into XSLT. Schematron was designed to allow many different uses, and
the skeleton gives you a headstart in creating a customized
implementation. You just need to write XSLT templates to override the
default ones. (The program you write is sometimes called a
<I>meta-stylesheet</I>.) It is the meta-stylesheet that is called
as the XSLT script, not the skeleton. There are several
pre-processing stages which the Schematron schema should be processed
through first, to handle such things as include statements and
abstract patterns.
</P>
<P>Phases and error reporting for problems in the schema itself are
handled by the skeleton with no interaction with a “meta-stylesheet”.
Note that there is no guarantee that the context node is always the
element being handled: in most cases the only information available
is the information in the parameters.
</P>
<P>For an introductory tutorial on using this API, see Bob DuCharme's
<A HREF="http://www.xml.com/pub/a/2004/10/05/tr.html">Schematron 1.5:
Looking Under the Hood</A>
</P>
<H1>Superset of API for Schematron 1.5 and 1.6</H1>
<P>(This is an updated version of the API for the Schematron 1.5
implementation called <TT>skeleton1-5.xsl</TT>, which in turn comes
from the <I>new architecture</I> contributed by Oliver Becker for
Schematron 1.3.)</P>
<P>The current API contains only additions. Well-written
meta-stylesheets that use the new API will be be able to run on the
existing 1.5 and 1.6 skeletons. Similarly, it should be possible to
upgrade the skeleton from 1.5 or 1.6 to the iso-schematron-skeleton
only by correcting the import statement at the beginning of the
meta-stylsheet. Additions or re-groupings from the 1.5 schema are
shown in red. Deletions have overstrike.</P>
<P>Mooted addition: a parameter @action which for specifying
processing instructions on assertions and reports.</P>
<HR>
<H2><TT>process-prolog</TT></H2>
<P>The <TT>process-prolog</TT> template gets called at the start of
the validation session. It has no parameters. The default
implementation is no action.</P>
<HR>
<H2><TT>process-root</TT></H2>
<P>The <TT>process-root</TT> template processes the root element of
the schema (which is not the same thing as the root of the document /
and need not be the document element /*) .</P>
<DL>
<DT><TT><I>node-list</I></TT><TT> $contents</TT>
</DT><DT>
<TT><I>string</I></TT><TT> $schemaVersion</TT>
</DT><DD>
The version of the schema, perhaps a datestamp.
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"xslt" | "xpath" |
"xslt2" | ...</I></FONT></TT><TT><FONT COLOR="#ff0000">
$queryBinding</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The query language binding. </FONT>
</DD><DT>
<TT><I>string</I></TT><TT> $title</TT>
</DT><DD>
The title of this schema
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"iso" | "1.5" |
"1.6" | ...</I></FONT></TT><TT><FONT COLOR="#ff0000">
$version</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The version of Schematron being used. </FONT>
</DD></DL>
<P>
Rich properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
$icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The URI of an icon </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
$id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The unique identifier with the schema for the
</FONT><TT><FONT COLOR="#ff0000">schema</FONT></TT><FONT COLOR="#ff0000">
element. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
$fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The Formal Public Identifier for this schema. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
$lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The human language used in this schema, from
xml:lang </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
$see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"preserve" | "default"</I></FONT></TT><TT><FONT COLOR="#ff0000">
$space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The value for xml:space </FONT>
</DD></DL>
<P>
To print the documentation paragraphs, use <TT><xsl:apply-templates
mode="do-schema-p" /></TT></P>
<P>To output the results, use <TT><xsl:copy-of select="$contents"
/></TT></P>
<HR>
<H2><TT>process-assert</TT></H2>
<P>The <TT>process-assert</TT> template handles asserts whose test
has failed.
</P>
<DL>
<DT><TT><I>XPath</I></TT><TT> $test</TT>
</DT><DD>
The test
</DD><DT>
<TT><I>XML IDREFS</I></TT><TT> $diagnostics</TT>
</DT><DD>
A list of the idrefs diagnostic elements related to the current
assertion
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
$flag</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The name of a flag that becomes true because
this assertion fails. The flag is true for the document if it is
flagged true on any assertion. For compatability, this parameter
should not be used with Schematron 1.5.</FONT>
</DD></DL>
<P>
Rich properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
$icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The URI of an icon </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
$id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The unique identifier with the schema for the
</FONT><TT><FONT COLOR="#ff0000">assert</FONT></TT><FONT COLOR="#ff0000">
element. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
$fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The Formal Public Identifier for this
assertion. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
$lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The human language used in this assertion,
from xml:lang </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
$see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"preserve" | "default"</I></FONT></TT><TT><FONT COLOR="#ff0000">
$space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The value for xml:space </FONT>
</DD></DL>
<P>
Linking properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
$role</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">A name for the generic role of this assertion.
The schema creator would have their own vocabulary. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XPath</I></FONT></TT><TT><FONT COLOR="#ff0000">
$subject</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">A path relative to the current context to some
interesting node considered the subject. </FONT>
</DD></DL>
<P>
To print the text contents, use <TT><xsl:apply-templates
mode="text" /></TT></P>
<HR>
<H2><TT>process-diagnostic</TT></H2>
<P>The <TT>process-diagnostic</TT> template handles diagnostic
messages for <TT>assert</TT> statements that have failed and <TT>report</TT>
statements that have succeeded. The diagnostics are evaluated in the
context of the rule.</P>
<P>Rich properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
$icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The URI of an icon </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
$id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The unique identifier with the schema for the
</FONT><TT><FONT COLOR="#ff0000">assert</FONT></TT><FONT COLOR="#ff0000">
element. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
$fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The Formal Public Identifier for this
assertion. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
$lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The human language used in this assertion,
from xml:lang </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
$see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"preserve" | "default"</I></FONT></TT><TT><FONT COLOR="#ff0000">
$space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The value for xml:space </FONT>
</DD><HR>
</DL>
<H2><TT>process-dir</TT></H2>
<P>The <TT>process-dir</TT> template handles bi-directionality
markup, which is only needed by certain human scripts such as Arabic.</P>
<DL>
<DT><TT><I>"ltr" or "rtl" or ""</I></TT><TT>
$value</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
Left-to-right or right-to-left or unspecified
</DD><HR>
</DL>
<H2><TT>process-emph</TT></H2>
<P>The <TT>process-emph</TT> template handles the markup of
emphasized text in paragraphs, assertions and diagnostics. It has no
parameters.</P>
<HR>
<H2><TT>process-message</TT></H2>
<P>The <TT>process-message</TT> handles default outputing of text.</P>
<DL>
<DT><TT><I>string</I></TT><TT> $pattern</TT>
</DT><DD>
Some text that may be some kind of pattern
</DD><DT>
<TT><I>string</I></TT><TT> $role</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
Some text that may be some kind of role
</DD><HR>
</DL>
<H2><TT>process-name</TT></H2>
<P>The <TT>process-name</TT> templates handle name strings that can
be used in assertions. <TT>asssert</TT> and <TT>report</TT> only
provide <TT>name</TT> subelements rather than the more general
<TT>value-of</TT> elements to encourage plain language and generic
descriptions rather than specific diagnostics, for which purpose the
<TT>diagnostics</TT> elements are used.</P>
<DL>
<DT><TT><I>string</I></TT><TT> $name</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
The name of the current element, or of the node specified by a <TT>name</TT>
element
</DD><HR>
</DL>
<H2><TT>process-ns</TT></H2>
<P>The <TT>process-ns</TT> template reports on <TT>ns</TT>
declarations, which are used to transmit on namespace information by
the skeleton.</P>
<DL>
<DT><TT><I>Namespace NCName</I></TT><TT> $prefix</TT>
</DT><DD>
The prefix of a namespace
</DD><DT>
<TT><I>XML SystemId</I></TT><TT> $uri</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
The (internationalized) URI Reference of a namespace
</DD><HR>
</DL>
<H2><TT>process-p</TT></H2>
<P>The <TT>process-p</TT> template handles paragraphs.</P>
<DL>
<DT><TT><I>XML NMTOKEN</I></TT><TT> $class</TT>
</DT><DD>
An attribute that can be used for stylesheet style
</DD><DT>
<TT><I>XML ID</I></TT><TT> $id</TT>
</DT><DD>
The unique identifier with the schema for the <TT>p</TT> element.
</DD><DT>
<TT><I>XML SystemId</I></TT><TT> $icon</TT>
</DT><DD>
The URI of an icon
</DD><DT>
<TT><I>IETF Language</I></TT><TT> $lang</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
The human language used in this paragraph
</DD></DL>
<P>
To print the text contents, use <TT><xsl:apply-templates
mode="text" /></TT>
</P>
<HR>
<H2><TT>process-pattern</TT></H2>
<P>The <TT>process-pattern</TT> reports on the start of evaluation of
a <TT>pattern</TT> element.</P>
<DL>
<DT><TT><I>string</I></TT><TT> $name</TT>
</DT><DD>
The title of the current pattern
</DD><DT>
<TT><I>XML NCNAMES</I></TT><TT> $is-a</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
Empty or not provided if the pattern is not derived from an abstract
pattern. Otherwise the name of the abstract pattern. A list may be
used if there was a sequence of abstract patterns.
</DD></DL>
<P>
Rich properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
$icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The URI of an icon </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
$id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The unique identifier with the schema for the
</FONT><TT><FONT COLOR="#ff0000">pattern</FONT></TT><FONT COLOR="#ff0000">
element. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
$fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The Formal Public Identifier for this pattern.
</FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
$lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The human language used in this pattern, from
xml:lang </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
$see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">A (internationalized) URI reference to some
supporting or defining documentation </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"preserve" | "default"</I></FONT></TT><TT><FONT COLOR="#ff0000">
$space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The value for xml:space </FONT>
</DD></DL>
<P>
To print the documentation contents, use <TT><xsl:apply-templates
mode="do-pattern-p"/></TT></P>
<HR>
<H2><TT>process-report</TT></H2>
<P>The <TT>process-report</TT> template handles <TT>report</TT> whose
test has succeeded.
</P>
<DL>
<DT><TT><I>XPath</I></TT><TT> $test</TT>
</DT><DD>
The test
</DD><DT>
<TT><I>XML IDREFS</I></TT><TT> $diagnostics</TT>
</DT><DD>
A list of the diagnostic elements related to the current assertion
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
$flag</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The name of a flag that becomes true because
this assertion fails. The flag is true for the document if it is
flagged true on any assertion. For compatability, this parameter
should not be used with Schematron 1.5.</FONT>
</DD></DL>
<P>
Rich properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
$icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The URI of an icon </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
$id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The unique identifier with the schema for the
</FONT><TT><FONT COLOR="#ff0000">report</FONT></TT><FONT COLOR="#ff0000">
element. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
$fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The Formal Public Identifier for this report. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
$lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The human language used in this report, from
xml:lang </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
$see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"preserve" | "default"</I></FONT></TT><TT><FONT COLOR="#ff0000">
$space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The value for xml:space </FONT>
</DD></DL>
<P>
Linking properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
$role</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">A name for the generic role of this assertion.
The schema creator would have their own vocabulary. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XPath</I></FONT></TT><TT><FONT COLOR="#ff0000">
$subject</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">A path relative to the current context to some
interesting node considered the subject. </FONT>
</DD></DL>
<P>
To print the text contents, use <TT><xsl:apply-templates
mode="text" /></TT></P>
<HR>
<H2><TT>process-rule</TT></H2>
<P>The <TT>process-rule</TT> reports that a <TT>rule</TT> element has
fired: its <TT>context</TT> attribute matched some nodes. .</P>
<DL>
<DT><TT><I>XSLT expression</I></TT><TT> $context</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
The expression that gives the context of the current
</DD></DL>
<P>
Rich properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML SystemId</I></FONT></TT><TT><FONT COLOR="#ff0000">
$icon</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The URI of an icon </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XML ID</I></FONT></TT><TT><FONT COLOR="#ff0000">
$id</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The unique identifier with the schema for this
</FONT><TT><FONT COLOR="#ff0000">rule</FONT></TT><FONT COLOR="#ff0000">
element. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>SGML FPI</I></FONT></TT><TT><FONT COLOR="#ff0000">
$fpi</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The Formal Public Identifier for this rule. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>IETF language</I></FONT></TT><TT><FONT COLOR="#ff0000">
$lang</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">The human language used in this rule, from
xml:lang </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>URL</I></FONT></TT><TT><FONT COLOR="#ff0000">
$see</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">Link to documentation on WWW or file </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>"preserve" | "default"</I></FONT></TT><TT><FONT COLOR="#ff0000">
$space</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">The value for xml:space </FONT>
</DD></DL>
<P>
Linking properties:</P>
<DL>
<DT><TT><FONT COLOR="#ff0000"><I>XML NMTOKEN</I></FONT></TT><TT><FONT COLOR="#ff0000">
$role</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD>
<FONT COLOR="#ff0000">A name for the generic role of this assertion.
The schema creator would have their own vocabulary. </FONT>
</DD><DT>
<TT><FONT COLOR="#ff0000"><I>XPath</I></FONT></TT><TT><FONT COLOR="#ff0000">
$subject</FONT></TT><FONT COLOR="#ff0000"> </FONT>
</DT><DD STYLE="margin-bottom: 0.5cm">
<FONT COLOR="#ff0000">A path relative to the current context to some
interesting node considered the subject. </FONT>
</DD><HR>
</DL>
<H2><TT>process-span</TT></H2>
<P>The <TT>process-span</TT> handles span elements, which are generic
elements for styling, like HTML's .</P>
<DL>
<DT><TT><I>XML NMTOKEN</I></TT><TT> $class</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
An attribute that can be used for stylesheet style
</DD><HR>
</DL>
<H2><TT>process-title</TT></H2>
<P>The <TT>process-title</TT> handles title elements, which are
generic elements for styling, like HTML's .</P>
<DL>
<DT><TT><I>XML NMTOKEN</I></TT><TT> $class</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
An attribute that can be used for stylesheet style
</DD></DL>
<P>
By default, titles are handled by invocing <TT>process-p</TT> with
the parameter class with a value "title".</P>
<HR>
<H2><TT>process-value-of</TT></H2>
<P>The <TT>process-value-of</TT> template handles <TT>value-of</TT>
elements, which are used in diagnostic messages to allow very
specific hinting .</P>
<DL>
<DT><TT><I>XPath</I></TT><TT> $select</TT>
</DT><DD STYLE="margin-bottom: 0.5cm">
The path of some node that will be evaluated and printed.</DD><HR>
</DL>
<H1>Global Parameters</H1>
<P>There are several global parameters that may be available for use.
However, it is not a requirement to follow these, and implementations
may not supply them with any value. So a test of
string-length(<I>variable</I><SPAN STYLE="font-style: normal">) <
0 is appropriate in each case.</SPAN></P>
<P><BR><BR>
</P>
<TABLE WIDTH=557 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=1 CELLSPACING=0>
<COL WIDTH=132>
<COL WIDTH=77>
<COL WIDTH=340>
<TR>
<TD WIDTH=132>
<P ALIGN=CENTER><FONT SIZE=2><B>Parameter</B></FONT></P>
</TD>
<TD WIDTH=77>
<P ALIGN=CENTER><FONT SIZE=2><B>Value</B></FONT></P>
</TD>
<TD WIDTH=340>
<P ALIGN=CENTER><FONT SIZE=2><B>Description</B></FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>allow-foreign</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>"true" | "false" (default) </FONT>
</P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>Pass non-Schematron elements to the generated
stylesheet. Pass the Schematron elements span, emph and dir: to
the output SVRL. </FONT>
</P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>fileNameParameter</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>string</FONT></P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>A parameter passed to the Validator and
potentially available as a variable in Schematron schemas as
$fileNameParameter</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>fileDirParameter</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>string</FONT></P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>A parameter passed to the Validator and
potentially available as a variable in Schematron schemas as
$fileDirParameter</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>archiveNamePaameter</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>string</FONT></P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>A parameter passed to the Validator and
potentially available as a variable in Schematron schemas as
$archiveNameParameter</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>archiveDirParameter</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>string</FONT></P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>A parameter passed to the Validator and
potentially available as a variable in Schematron schemas as
$archivePathParameter</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>debug </FONT>
</P>
</TD>
<TD WIDTH=77>
<P>“<FONT SIZE=2>true” | “false” (default)</FONT></P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>Verbose error messages (Note this may be
superceded by “verbose” at some stage in the future.)</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>generate-paths</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>true|false </FONT>
</P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>generate the SVRL @location attribute with XPaths</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>diagnose</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>yes | no </FONT>
</P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>Add the diagnostics to the assertion results</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><A NAME="DDE_LINK"></A><FONT SIZE=2>terminate</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>yes | no | true | false | assert</FONT>
</P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>Terminate on the first failed assertion or
successful report</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>message-newline </FONT>
</P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>"true" (default) | "false" </FONT>
</P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>Generate an extra newline at the end of messages</FONT></P>
</TD>
</TR>
<TR>
<TD WIDTH=132>
<P><FONT SIZE=2>output-encoding</FONT></P>
</TD>
<TD WIDTH=77>
<P><FONT SIZE=2>string</FONT></P>
</TD>
<TD WIDTH=340>
<P><FONT SIZE=2>The encoding used for output, for example if the
output is XML</FONT></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.5cm">
</DD></DL>
</BODY>
</HTML>