source: rfc2629xslt/rfc2629xslt.txt @ 573

Last change on this file since 573 was 573, checked in by julian.reschke@…, 10 years ago

update to latest version of rfc2629.xslt; bump up document dates

  • Property svn:eol-style set to native
File size: 108.3 KB
Line 
1
2
3
4RFC2629 through XSLT                                          J. Reschke
5                                                              greenbytes
6                                                           April 9, 2009
7
8
9            Transforming RFC2629-formatted XML through XSLT
10
11
12Table of Contents
13
14   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
15   2.  Supported RFC2629 elements . . . . . . . . . . . . . . . . . .  4
16     2.1.   Extension elements  . . . . . . . . . . . . . . . . . . .  4
17   3.  Processing Instructions  . . . . . . . . . . . . . . . . . . .  5
18     3.1.   Supported xml2rfc-compatible PIs  . . . . . . . . . . . .  6
19     3.2.   Unsupported xml2rfc-compatible PIs  . . . . . . . . . . .  7
20     3.3.   Extension PIs . . . . . . . . . . . . . . . . . . . . . .  8
21   4.  Anchors  . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
22   5.  Supported XSLT engines . . . . . . . . . . . . . . . . . . . . 14
23     5.1.   Standalone Engines  . . . . . . . . . . . . . . . . . . . 14
24     5.2.   In-Browser Engines  . . . . . . . . . . . . . . . . . . . 14
25   6.  Transforming to HTML . . . . . . . . . . . . . . . . . . . . . 16
26     6.1.   HTML compliance . . . . . . . . . . . . . . . . . . . . . 16
27     6.2.   Standard HTML LINK elements . . . . . . . . . . . . . . . 16
28     6.3.   Standard HTML metadata  . . . . . . . . . . . . . . . . . 17
29     6.4.   Dublin Core (RFC2731) metadata  . . . . . . . . . . . . . 17
30     6.5.   Experimental hCard support  . . . . . . . . . . . . . . . 17
31   7.  Transforming to XHTML  . . . . . . . . . . . . . . . . . . . . 18
32   8.  Transforming to CHM (Microsoft Compiled Help)  . . . . . . . . 19
33   9.  Transforming to PDF  . . . . . . . . . . . . . . . . . . . . . 20
34     9.1.   Via XSL-FO  . . . . . . . . . . . . . . . . . . . . . . . 20
35       9.1.1.  Extension feature matrix . . . . . . . . . . . . . . . 20
36       9.1.2.  Example: producing output for Apache FOP . . . . . . . 21
37     9.2.   Via X(HTML) . . . . . . . . . . . . . . . . . . . . . . . 21
38   10. Generic Extensions . . . . . . . . . . . . . . . . . . . . . . 22
39     10.1.  <abnf-char-sequence> element  . . . . . . . . . . . . . . 22
40     10.2.  <anchor-alias> element  . . . . . . . . . . . . . . . . . 22
41     10.3.  <bcp14> element . . . . . . . . . . . . . . . . . . . . . 22
42     10.4.  <bb> element  . . . . . . . . . . . . . . . . . . . . . . 23
43     10.5.  <bc> element  . . . . . . . . . . . . . . . . . . . . . . 23
44     10.6.  <blockquote> element  . . . . . . . . . . . . . . . . . . 23
45     10.7.  <boilerplate> element . . . . . . . . . . . . . . . . . . 23
46     10.8.  <bt> element  . . . . . . . . . . . . . . . . . . . . . . 24
47     10.9.  <dfn> element . . . . . . . . . . . . . . . . . . . . . . 24
48     10.10. <h> element . . . . . . . . . . . . . . . . . . . . . . . 24
49     10.11. <highlight> element . . . . . . . . . . . . . . . . . . . 24
50     10.12. <length-of> element . . . . . . . . . . . . . . . . . . . 24
51     10.13. <link> element  . . . . . . . . . . . . . . . . . . . . . 24
52
53
54
55Reschke                                                         [Page 1]
56
57Documentation             RFC2629 through XSLT                April 2009
58
59
60     10.14. <lt> element  . . . . . . . . . . . . . . . . . . . . . . 25
61     10.15. <note> element  . . . . . . . . . . . . . . . . . . . . . 25
62     10.16. <parse-xml> element . . . . . . . . . . . . . . . . . . . 25
63     10.17. <q> element . . . . . . . . . . . . . . . . . . . . . . . 25
64     10.18. <ref> element . . . . . . . . . . . . . . . . . . . . . . 25
65     10.19. <source> element  . . . . . . . . . . . . . . . . . . . . 26
66     10.20. <sup> element . . . . . . . . . . . . . . . . . . . . . . 26
67     10.21. Extensions to Xml2rfc <artwork> element . . . . . . . . . 26
68     10.22. Extensions to Xml2rfc <iref> element  . . . . . . . . . . 26
69     10.23. Extensions to Xml2rfc <list> element  . . . . . . . . . . 27
70     10.24. Extensions to Xml2rfc <rfc> element . . . . . . . . . . . 27
71     10.25. Extensions to Xml2rfc <section> element . . . . . . . . . 27
72     10.26. Extensions to Xml2rfc <xref> element  . . . . . . . . . . 27
73   11. Utilities  . . . . . . . . . . . . . . . . . . . . . . . . . . 29
74     11.1.  Checking References . . . . . . . . . . . . . . . . . . . 29
75     11.2.  Generating Graphs from References . . . . . . . . . . . . 31
76     11.3.  Producing reference entries for books . . . . . . . . . . 31
77     11.4.  Down-converting to RFC2629bis DTD . . . . . . . . . . . . 32
78     11.5.  Extracting artwork  . . . . . . . . . . . . . . . . . . . 32
79     11.6.  GRRDL . . . . . . . . . . . . . . . . . . . . . . . . . . 33
80   12. Informative References . . . . . . . . . . . . . . . . . . . . 34
81   Appendix A.  RELAX NG Compact Schema . . . . . . . . . . . . . . . 36
82   Appendix B.  Implementation Notes  . . . . . . . . . . . . . . . . 45
83     B.1.   Recognized type attributes for <artwork> element  . . . . 45
84   Appendix C.  License . . . . . . . . . . . . . . . . . . . . . . . 46
85   Appendix D.  Change Logs . . . . . . . . . . . . . . . . . . . . . 47
86     D.1.   Package . . . . . . . . . . . . . . . . . . . . . . . . . 47
87     D.2.   amazon-asin.xslt  . . . . . . . . . . . . . . . . . . . . 47
88     D.3.   check-references.xslt . . . . . . . . . . . . . . . . . . 47
89     D.4.   gen-reference-graph.xslt  . . . . . . . . . . . . . . . . 48
90     D.5.   rfc2629.xslt  . . . . . . . . . . . . . . . . . . . . . . 48
91     D.6.   rfc2629toFO.xslt  . . . . . . . . . . . . . . . . . . . . 59
92     D.7.   xsl11toAn.xslt  . . . . . . . . . . . . . . . . . . . . . 60
93     D.8.   xsl11toFop.xslt . . . . . . . . . . . . . . . . . . . . . 60
94     D.9.   xsl11toFop-0.93.xslt  . . . . . . . . . . . . . . . . . . 60
95     D.10.  xsl11toXep.xslt . . . . . . . . . . . . . . . . . . . . . 60
96   Index  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
97   Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 70
98
99
100
101
102
103
104
105
106
107
108
109
110
111Reschke                                                         [Page 2]
112
113Documentation             RFC2629 through XSLT                April 2009
114
115
1161.  Introduction
117
118   This document describes a set of XSLT transformations that can be
119   used to transform RFC2629-compliant XML (see [RFC2629]) to various
120   output formats, such as HTML and PDF.  The main topics are
121
122   o  compliance to the xml2rfc XML element set (Section 2),
123
124   o  support for xml2rfc processing instructions (Section 3),
125
126   o  the names of anchor elements generated in HTML and PDF output
127      (Section 4),
128
129   o  various XSLT engines that can be used (Section 5),
130
131   o  outputting HTML (Section 6) and XHTML (Section 7),
132
133   o  outputting CHM (Compiled Microsoft Help, Section 8),
134
135   o  outputting PDF (Section 9),
136
137   o  extensions to the xml2rfc vocabulary (Section 10).
138
139   o  various utilities (Section 11).
140
141   The full distribution is available at
142   <http://greenbytes.de/tech/webdav/rfc2629xslt.zip>.
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167Reschke                                                         [Page 3]
168
169Documentation             RFC2629 through XSLT                April 2009
170
171
1722.  Supported RFC2629 elements
173
174   "rfc2629.xslt" supports both all RFC2629 grammar elements and the
175   extensions implemented in xml2rfc 1.21.
176
1772.1.  Extension elements
178
179   "rfc2629.xslt" supports two kind of extension elements, using
180   different XML namespaces.
181
182   The first set contains (hopefully) generally useful extensions, see
183   Section 10.
184
185   The second set is used for change and issue tracking and currently is
186   not documented here.  Please email the author in case you're
187   interested in using these extensions.
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
223Reschke                                                         [Page 4]
224
225Documentation             RFC2629 through XSLT                April 2009
226
227
2283.  Processing Instructions
229
230   All PIs can be set as XSLT parameter as well, overriding any value
231   that is found in the source file to be transformed.
232
233   Using processing instructions:
234
235   <?rfc toc="yes"?>
236   <?rfc-ext support-rfc2731="no"?>
237
238   Using XSLT parameters (Saxon):
239
240   java -cp saxon.jar com.icl.saxon.StyleSheet source.xml rfc2629.xslt \
241     xml2rfc-toc=yes xml2rfc-ext-support-rfc2731=no > result.html
242
243   Using XSLT parameters (xsltproc):
244
245   xsltproc --param xml2rfc-toc '"yes"' \
246      --param xml2rfc-ext-support-rfc2731 '"no"' \
247      rfc2629.xslt source.xml > result.html
248
249   (note the required quoting of string parameters)
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
279Reschke                                                         [Page 5]
280
281Documentation             RFC2629 through XSLT                April 2009
282
283
2843.1.  Supported xml2rfc-compatible PIs
285
286   +-------+----------------+--------------------+---------+-----------+
287   | PI    | PI             | XSLT parameter     | default | comment   |
288   | targe | pseudo-attribu | name               |         |           |
289   | t     | te             |                    |         |           |
290   +-------+----------------+--------------------+---------+-----------+
291   | rfc   | background     | xml2rfc-background | (not    |           |
292   |       |                |                    | set)    |           |
293   |       |                |                    |         |           |
294   | rfc   | compact        | xml2rfc-compact    | "no"    | only      |
295   |       |                |                    |         | applies   |
296   |       |                |                    |         | to HTML   |
297   |       |                |                    |         | output    |
298   |       |                |                    |         | method    |
299   |       |                |                    |         | when      |
300   |       |                |                    |         | printing  |
301   |       |                |                    |         |           |
302   | rfc   | comments       | xml2rfc-comments   | (not    |           |
303   |       |                |                    | set)    |           |
304   |       |                |                    |         |           |
305   | rfc   | editing        | xml2rfc-editing    | "no"    |           |
306   |       |                |                    |         |           |
307   | rfc   | footer         | xml2rfc-footer     | (not    |           |
308   |       |                |                    | set)    |           |
309   |       |                |                    |         |           |
310   | rfc   | header         | xml2rfc-header     | (not    |           |
311   |       |                |                    | set)    |           |
312   |       |                |                    |         |           |
313   | rfc   | inline         | xml2rfc-inline     | (not    |           |
314   |       |                |                    | set)    |           |
315   |       |                |                    |         |           |
316   | rfc   | iprnotified    | xml2rfc-iprnotifie | "no"    |           |
317   |       |                | d                  |         |           |
318   |       |                |                    |         |           |
319   | rfc   | linkmailto     | xml2rfc-linkmailto | "yes"   |           |
320   |       |                |                    |         |           |
321   | rfc   | private        | xml2rfc-private    | (not    |           |
322   |       |                |                    | set)    |           |
323   |       |                |                    |         |           |
324   | rfc   | rfcedstyle     | xml2rfc-rfcedstyle | (not    | (limited  |
325   |       |                |                    | set)    | support)  |
326   |       |                |                    |         |           |
327   | rfc   | sortrefs       | xml2rfc-sortrefs   | "no"    |           |
328   |       |                |                    |         |           |
329
330
331
332
333
334
335Reschke                                                         [Page 6]
336
337Documentation             RFC2629 through XSLT                April 2009
338
339
340   | rfc   | symrefs        | xml2rfc-symrefs    | "yes"   | The       |
341   |       |                |                    |         | default   |
342   |       |                |                    |         | has       |
343   |       |                |                    |         | changed   |
344   |       |                |                    |         | from "no" |
345   |       |                |                    |         | to "yes"  |
346   |       |                |                    |         | as of     |
347   |       |                |                    |         | June 6,   |
348   |       |                |                    |         | 2007 and  |
349   |       |                |                    |         | xml2rfc   |
350   |       |                |                    |         | 1.33pre4. |
351   |       |                |                    |         |           |
352   | rfc   | toc            | xml2rfc-toc        | "no"    |           |
353   |       |                |                    |         |           |
354   | rfc   | tocdepth       | xml2rfc-tocdepth   | 99      |           |
355   |       |                |                    |         |           |
356   | rfc   | topblock       | xml2rfc-topblock   | "yes"   |           |
357   +-------+----------------+--------------------+---------+-----------+
358
3593.2.  Unsupported xml2rfc-compatible PIs
360
361   +----------+------------------+-------------------------------------+
362   | PI       | PI               | comment                             |
363   | target   | pseudo-attribute |                                     |
364   +----------+------------------+-------------------------------------+
365   | rfc      | include          | incompatible with XML/XSLT          |
366   |          |                  | processing model                    |
367   |          |                  |                                     |
368   | rfc      | needLines        |                                     |
369   |          |                  |                                     |
370   | rfc      | slides           |                                     |
371   |          |                  |                                     |
372   | rfc      | strict           |                                     |
373   |          |                  |                                     |
374   | rfc      | subcompact       |                                     |
375   |          |                  |                                     |
376   | rfc      | tocindent        | (defaults to "yes")                 |
377   |          |                  |                                     |
378   | rfc      | tocompact        |                                     |
379   +----------+------------------+-------------------------------------+
380
381
382
383
384
385
386
387
388
389
390
391Reschke                                                         [Page 7]
392
393Documentation             RFC2629 through XSLT                April 2009
394
395
3963.3.  Extension PIs
397
398   +------+-----------------+-----------------------+------+-----------+
399   | PI   | PI              | XSLT parameter name   | defa | descripti |
400   | targ | pseudo-attribut |                       | ult  | on        |
401   | et   | e               |                       |      |           |
402   +------+-----------------+-----------------------+------+-----------+
403   | rfc- | allow-markup-in | xml2rfc-allow-markup- | "no" | Enables   |
404   | ext  | -artwork        | in-artwork            |      | support   |
405   |      |                 |                       |      | for       |
406   |      |                 |                       |      | specific  |
407   |      |                 |                       |      | elements  |
408   |      |                 |                       |      | inside    |
409   |      |                 |                       |      | abstract  |
410   |      |                 |                       |      | elements  |
411   |      |                 |                       |      | (using    |
412   |      |                 |                       |      | this      |
413   |      |                 |                       |      | extension |
414   |      |                 |                       |      | makes the |
415   |      |                 |                       |      | document  |
416   |      |                 |                       |      | incompati |
417   |      |                 |                       |      | ble to    |
418   |      |                 |                       |      | the       |
419   |      |                 |                       |      | RFC2629bi |
420   |      |                 |                       |      | s DTD;    |
421   |      |                 |                       |      | see       |
422   |      |                 |                       |      | descripti |
423   |      |                 |                       |      | on of     |
424   |      |                 |                       |      | conversio |
425   |      |                 |                       |      | n XSLT in |
426   |      |                 |                       |      | Section 1 |
427   |      |                 |                       |      | 1.4).     |
428   |      |                 |                       |      |           |
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447Reschke                                                         [Page 8]
448
449Documentation             RFC2629 through XSLT                April 2009
450
451
452   | rfc- | authors-section | xml2rfc-ext-authors-s |      | When      |
453   | ext  |                 | ection                |      | "end",    |
454   |      |                 |                       |      | place the |
455   |      |                 |                       |      | authors   |
456   |      |                 |                       |      | section   |
457   |      |                 |                       |      | at the    |
458   |      |                 |                       |      | end (just |
459   |      |                 |                       |      | before    |
460   |      |                 |                       |      | the       |
461   |      |                 |                       |      | copyright |
462   |      |                 |                       |      | statement |
463   |      |                 |                       |      | s). This  |
464   |      |                 |                       |      | seems to  |
465   |      |                 |                       |      | be the    |
466   |      |                 |                       |      | preferred |
467   |      |                 |                       |      | order in  |
468   |      |                 |                       |      | the       |
469   |      |                 |                       |      | newest    |
470   |      |                 |                       |      | RFCs.     |
471   |      |                 |                       |      |           |
472   | rfc- | duplex          | xml2rfc-ext-duplex    | no   | When set  |
473   | ext  |                 |                       |      | to "yes", |
474   |      |                 |                       |      | format    |
475   |      |                 |                       |      | the PDF   |
476   |      |                 |                       |      | output    |
477   |      |                 |                       |      | for       |
478   |      |                 |                       |      | doublesid |
479   |      |                 |                       |      | ed        |
480   |      |                 |                       |      | printing. |
481   |      |                 |                       |      |           |
482   | rfc- | include-referen | xml2rfc-ext-include-r |      | When set  |
483   | ext  | ces-in-index    | eferences-in-index    |      | to "yes", |
484   |      |                 |                       |      | index     |
485   |      |                 |                       |      | entries   |
486   |      |                 |                       |      | are       |
487   |      |                 |                       |      | generated |
488   |      |                 |                       |      | for all   |
489   |      |                 |                       |      | reference |
490   |      |                 |                       |      | s.        |
491   |      |                 |                       |      |           |
492
493
494
495
496
497
498
499
500
501
502
503Reschke                                                         [Page 9]
504
505Documentation             RFC2629 through XSLT                April 2009
506
507
508   | rfc- | justification   | xml2rfc-ext-justifica | "nev | "never":  |
509   | ext  |                 | tion                  | er"  | never     |
510   |      |                 |                       |      | emit      |
511   |      |                 |                       |      | justified |
512   |      |                 |                       |      | text,     |
513   |      |                 |                       |      | "always": |
514   |      |                 |                       |      | always    |
515   |      |                 |                       |      | emit      |
516   |      |                 |                       |      | justified |
517   |      |                 |                       |      | text,     |
518   |      |                 |                       |      | "print":  |
519   |      |                 |                       |      | only emit |
520   |      |                 |                       |      | justified |
521   |      |                 |                       |      | text for  |
522   |      |                 |                       |      | print     |
523   |      |                 |                       |      | media.    |
524   |      |                 |                       |      |           |
525   | rfc- | parse-xml-in-ar | xml2rfc-parse-xml-in- | "no" | May be    |
526   | ext  | twork           | artwork               |      | used to   |
527   |      |                 |                       |      | enable    |
528   |      |                 |                       |      | parsing   |
529   |      |                 |                       |      | of XML    |
530   |      |                 |                       |      | content   |
531   |      |                 |                       |      | in        |
532   |      |                 |                       |      | figures   |
533   |      |                 |                       |      | (MSXML    |
534   |      |                 |                       |      | only).    |
535   |      |                 |                       |      |           |
536   | rfc- | support-rfc2731 | xml2rfc-ext-support-r | "yes | Decides   |
537   | ext  |                 | fc2731                | "    | whether   |
538   |      |                 |                       |      | the HTML  |
539   |      |                 |                       |      | transform |
540   |      |                 |                       |      | ation     |
541   |      |                 |                       |      | should    |
542   |      |                 |                       |      | generate  |
543   |      |                 |                       |      | META tags |
544   |      |                 |                       |      | according |
545   |      |                 |                       |      | Section 6 |
546   |      |                 |                       |      | .4.       |
547   |      |                 |                       |      |           |
548
549
550
551
552
553
554
555
556
557
558
559Reschke                                                        [Page 10]
560
561Documentation             RFC2629 through XSLT                April 2009
562
563
564   | rfc- | sec-no-trailing | xml2rfc-ext-sec-no-tr |      | When set  |
565   | ext  | -dots           | ailing-dots           |      | to "yes", |
566   |      |                 |                       |      | add       |
567   |      |                 |                       |      | trailing  |
568   |      |                 |                       |      | dots to   |
569   |      |                 |                       |      | section   |
570   |      |                 |                       |      | numbers.  |
571   |      |                 |                       |      | This      |
572   |      |                 |                       |      | seems to  |
573   |      |                 |                       |      | be the    |
574   |      |                 |                       |      | preferred |
575   |      |                 |                       |      | format in |
576   |      |                 |                       |      | the       |
577   |      |                 |                       |      | newest    |
578   |      |                 |                       |      | RFCs.     |
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
615Reschke                                                        [Page 11]
616
617Documentation             RFC2629 through XSLT                April 2009
618
619
6204.  Anchors
621
622   The transformation automatically generates anchors that are supposed
623   to be stable and predictable and that can be used to identify
624   specific parts of the document.  Anchors are generated both in HTML
625   and XSL-FO content (but the latter will only be used for PDF output
626   when the XSL-FO engine supports producing PDF anchors).
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
671Reschke                                                        [Page 12]
672
673Documentation             RFC2629 through XSLT                April 2009
674
675
676                 The following anchors get auto-generated:
677
678     +-----------------------+---------------------------------------+
679     | Anchor name           | Description                           |
680     +-----------------------+---------------------------------------+
681     | rfc.abstract          | Abstract                              |
682     |                       |                                       |
683     | rfc.authors           | Authors section                       |
684     |                       |                                       |
685     | rfc.copyright         | Copyright section                     |
686     |                       |                                       |
687     | rfc.copyrightnotice   | Copyright notice                      |
688     |                       |                                       |
689     | rfc.figure._n_        | Figures (titled)                      |
690     |                       |                                       |
691     | rfc.figure.u._n_      | Figures (untitled)                    |
692     |                       |                                       |
693     | rfc.index             | Index                                 |
694     |                       |                                       |
695     | rfc.ipr               | Intellectual Property                 |
696     |                       |                                       |
697     | rfc.iref._n_          | Internal references                   |
698     |                       |                                       |
699     | rfc.note._n_          | Notes (from front section)            |
700     |                       |                                       |
701     | rfc.references        | References                            |
702     |                       |                                       |
703     | rfc.references._n_    | Additional references                 |
704     |                       |                                       |
705     | rfc.section._n_       | Section _n_                           |
706     |                       |                                       |
707     | rfc.section._n_.p._m_ | Section _n_, paragraph _m_            |
708     |                       |                                       |
709     | rfc.status            | Status of memo                        |
710     |                       |                                       |
711     | rfc.table._n_         | Tables (titled)                       |
712     |                       |                                       |
713     | rfc.table.u._n_       | Tables (untitled)                     |
714     |                       |                                       |
715     | rfc.toc               | Table of contents                     |
716     |                       |                                       |
717     | rfc.xref._name_._n_   | References to reference _n_ to _name_ |
718     +-----------------------+---------------------------------------+
719
720
721
722
723
724
725
726
727Reschke                                                        [Page 13]
728
729Documentation             RFC2629 through XSLT                April 2009
730
731
7325.  Supported XSLT engines
733
734   The transformation requires a non-standard extension function (see
735   exsl:node-set [1]) which is however widely available.  XSLT
736   processors that do not support this extension (or a functional
737   equivalent) currently are not supported.
738
7395.1.  Standalone Engines
740
741   The following XSLT engines are believed to work well:
742
743   o  MSXML3 and MSXML4 (<http://msdn.microsoft.com/xml>; these
744      processors do not support exsl:node-set(), but have a similar
745      proprietary extension)
746
747   o  Saxon (<http://saxon.sourceforge.net/>)
748
749   o  Xalan (<http://xml.apache.org/xalan-j/>)
750
751   o  xsltproc (libxslt) (<http://xmlsoft.org/XSLT/>, make sure that you
752      have a current version)
753
7545.2.  In-Browser Engines
755
756   The following browsers seem to work fine:
757
758   o  Internet Explorer 5.5 (Windows version, if MSXML3 is installed)
759
760   o  Internet Explorer 6
761
762   o  Internet Explorer 7
763
764   o  Internet Explorer 8
765
766   o  Firefox 3.0
767
768   o  Safari 3 (starting with version 3.0.4)
769
770   o  Google Chrome (beta available)
771
772   o  Opera 10 (alpha version available)
773
774   The following browsers are known not to work properly:
775
776   o  Firefox 1.*/2.*: (missing extension function - see change request
777      at Mozilla BugZilla 193678 [2])
778
779
780
781
782
783Reschke                                                        [Page 14]
784
785Documentation             RFC2629 through XSLT                April 2009
786
787
788   o  Opera 9.21: execution fails, potentially to a somewhat complex
789      XPath expression (reported to Opera as bug 245725).
790
791   o  Opera 9.5 and 9.6: transformation appears to work, but CSS isn't
792      getting applied (reported to Opera as bug 337388 on 2008-06-12).
793
794   o  Safari 2.* supports client-side XSLT as of MacOS X 10.4, but
795      misses required extension functions.  A problem with stylesheets
796      producing non-ASCII output (such as NBSP characters) has been
797      fixed as of OSX 10.4.4.  Both problems have been reported through
798      Apple's bug tracking system, see <http://drakken.dbc.mtview.ca.us/
799      pipermail/xml2rfc/2005-May/002073.html> and
800      <http://bugs.webkit.org/show_bug.cgi?id=4079>.
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839Reschke                                                        [Page 15]
840
841Documentation             RFC2629 through XSLT                April 2009
842
843
8446.  Transforming to HTML
845
846   Transformation to HTML can be done inside the browser if it supports
847   XSLT.  To enable this, add the following processing instruction to
848   the start of the source file:
849
850     <?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
851
852   (and ensure that "rfc2629.xslt" is present).
853
8546.1.  HTML compliance
855
856   The transformation result is supposed to conform to the HTML 4.01
857   strict DTD [HTML].  This can be checked using the W3C's online
858   validator at <http://validator.w3.org>.
859
8606.2.  Standard HTML LINK elements
861
862   LINK elements exist since HTML 2.0.  They can be used to embed
863   content-independant links inside the document.  Unfortunately, only
864   few user agents support this element.  Firefox users may want to
865   check the Link Widgets [3] extension.
866
867                 The following LINK elements are produced:
868
869   +-----------+-------------------------------------------------------+
870   | LINK type | description                                           |
871   +-----------+-------------------------------------------------------+
872   | alternate | for RFCs, a link to the authorative ASCII version on  |
873   |           | the IETF web site                                     |
874   |           |                                                       |
875   | appendic  | pointer to all top-level appendics                    |
876   |           |                                                       |
877   | author    | pointer to "authors" section                          |
878   |           |                                                       |
879   | chapter   | pointer to all top-level sections                     |
880   |           |                                                       |
881   | contents  | pointer to table of contents                          |
882   |           |                                                       |
883   | copyright | pointer to copyright statement                        |
884   |           |                                                       |
885   | index     | pointer to index                                      |
886   +-----------+-------------------------------------------------------+
887
888   The figure below shows how Mozilla Firefox 1.0 displays the Site
889   Navigation Bar for rfc2396.xml.
890
891
892
893
894
895Reschke                                                        [Page 16]
896
897Documentation             RFC2629 through XSLT                April 2009
898
899
9006.3.  Standard HTML metadata
901
902          The following standard HTML META elements are produced:
903
904      +-----------+-------------------------------------------------+
905      | META name | description                                     |
906      +-----------+-------------------------------------------------+
907      | generator | from XSLT engine version and stylesheet version |
908      |           |                                                 |
909      | keywords  | from keyword elements in front section          |
910      +-----------+-------------------------------------------------+
911
9126.4.  Dublin Core (RFC2731) metadata
913
914   Unless turned off using the "rfc-ext support-rfc2731" processing
915   instruction, the transformation will generate metadata according to
916   [RFC2731] and [DC-HTML].
917
918                The following DCMI properties are produced:
919
920   +-------------------------+-----------------------------------------+
921   | META name               | description                             |
922   +-------------------------+-----------------------------------------+
923   | DC.Creator              | from author information in front        |
924   |                         | section                                 |
925   |                         |                                         |
926   | DC.Date.Issued          | from date information in front section  |
927   |                         |                                         |
928   | DC.Description.Abstract | from abstract                           |
929   |                         |                                         |
930   | DC.Identifier           | document URN [RFC2648] from "docName"   |
931   |                         | attribute                               |
932   |                         |                                         |
933   | DC.Relation.Replaces    | from "obsoletes" attribute              |
934   +-------------------------+-----------------------------------------+
935
9366.5.  Experimental hCard support
937
938   The generated author information is formatted in hCard [4] format.
939
940
941
942
943
944
945
946
947
948
949
950
951Reschke                                                        [Page 17]
952
953Documentation             RFC2629 through XSLT                April 2009
954
955
9567.  Transforming to XHTML
957
958   Transforming to XHTML requires slightly different XSLT output options
959   and is implemented by the derived transformation script
960   "rfc2629toXHTML.xslt".
961
962      Note: Microsoft Internet Explorer does _not_ support XHTML.
963      Therefore it usually makes more sense to generate plain old HTML.
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007Reschke                                                        [Page 18]
1008
1009Documentation             RFC2629 through XSLT                April 2009
1010
1011
10128.  Transforming to CHM (Microsoft Compiled Help)
1013
1014   To generate a CHM file using Microsoft's HTML Help Compiler (hhc),
1015   three files are required in addition to the HTML file.
1016
1017   1.  hhc - table of contents file (HTML)
1018
1019   2.  hhk - index file (HTML)
1020
1021   3.  hhp - project file (plain text)
1022
1023   The three files are generated with three specific transformations,
1024   each requiring the additional XSLT parameter "basename" to specify
1025   the filename prefix.
1026
1027   Example:
1028
1029   saxon rfc2616.xml rfc2629toHhp.xslt basename=rfc2616  > rfc2616.hhp
1030   saxon rfc2616.xml rfc2629toHhc.xslt basename=rfc2616  > rfc2616.hhc
1031   saxon rfc2616.xml rfc2629toHhk.xslt basename=rfc2616  > rfc2616.hhk
1032   hhc rfc2616.hhp
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063Reschke                                                        [Page 19]
1064
1065Documentation             RFC2629 through XSLT                April 2009
1066
1067
10689.  Transforming to PDF
1069
10709.1.  Via XSL-FO
1071
1072   Transformation to XSL-FO [XSL-FO] format is available through
1073   "rfc2629toFO.xslt" (which includes "rfc2629.xslt", so keep both in
1074   the same folder).
1075
1076   Compared to HTML user agents, XSL-FO engines unfortunately either
1077   come as open source (for instance, Apache FOP) or feature-complete
1078   (for instance, AntennaHouse XSL Formatter), but not both at the same
1079   time.
1080
1081   As Apache FOP needs special workarounds (page breaking, table
1082   layout), and some popular extensions aren't standardized yet, the
1083   translation produces a generic output (hopefully) conforming to
1084   [XSL-FO].  Specific backends ("xsl11toFop.xslt", "xsl11toXep.xslt",
1085   "xsl11toAn.xslt") then provide post-processing for the individual
1086   processors.
1087
1088      Note: the output is currently targeted at Apache FOP 0.95.
1089
10909.1.1.  Extension feature matrix
1091
1092   +------------+-------------+------------+-------------+-------------+
1093   |            | PDF anchors |     PDF    |     PDF     |    Index    |
1094   |            |             |  bookmarks |   document  |   cleanup   |
1095   |            |             |            | information |             |
1096   +------------+-------------+------------+-------------+-------------+
1097   | XSL 1.1    | no, but can |     yes    |   no, but   |     yes     |
1098   | WD [5]     |      be     |            |   uses XEP  |             |
1099   |            | auto-genera |            |    output   |             |
1100   |            |   ted from  |            |  extensions |             |
1101   |            |     "id"    |            |             |             |
1102   |            |  attributes |            |             |             |
1103   |            |             |            |             |             |
1104   | Antenna    |      no     |   yes [7]  |   yes [7]   |   yes [7]   |
1105   | House XSL  |             |  (from XSL |  (from XEP  |  (just page |
1106   | formatter  |             |     1.1    |   document  |  duplicate  |
1107   | [6]        |             | bookmarks) |    info)    | elimination |
1108   |            |             |            |             |  , from XSL |
1109   |            |             |            |             |   1.1 page  |
1110   |            |             |            |             |    index)   |
1111   |            |             |            |             |             |
1112   | Apache     |     yes     |  yes (from |     yes     |      no     |
1113   | FOP [8]    |             |   XSL 1.1  |             |             |
1114   |            |             | bookmarks) |             |             |
1115   |            |             |            |             |             |
1116
1117
1118
1119Reschke                                                        [Page 20]
1120
1121Documentation             RFC2629 through XSLT                April 2009
1122
1123
1124   | RenderX    |      no     |  yes [10]  |   yes [10]  |   yes [10]  |
1125   | XEP [9]    |             |  (from XSL |             |  (from XSL  |
1126   |            |             |     1.1    |             |   1.1 page  |
1127   |            |             | bookmarks) |             |    index)   |
1128   +------------+-------------+------------+-------------+-------------+
1129
11309.1.2.  Example: producing output for Apache FOP
1131
1132   Example:
1133
1134   saxon rfc2616.xml rfc2629toFo.xslt > tmp.fo
1135   saxon tmp.fo xsl11toFop.xslt > rfc2629.fo
1136
11379.2.  Via X(HTML)
1138
1139   PDF output can also be produced directly from (X)HTML.  One simple
1140   approach is to rely on the browser's printing function, and to use a
1141   printer driver that produces PDF.  Depending on the brower's CSS
1142   capabilities, the output will behave properly with respect to table
1143   breaks etc.
1144
1145   An alternative is PrinceXML (see <http://www.princexml.com/>), which
1146   can produce PDF directly from (X)HTML input, based on the CSS
1147   printing information.
1148
1149   For instance, PDF output with text justification turned on can be
1150   produced with:
1151
1152   saxon input.xml rfc2629toXHTML.xslt xml2rfc-ext-justification=print \
1153     > output.xhtml
1154   prince output.xhtml output.pdf
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175Reschke                                                        [Page 21]
1176
1177Documentation             RFC2629 through XSLT                April 2009
1178
1179
118010.  Generic Extensions
1181
1182   This section documents extensions implemented in "rfc2629.xslt",
1183   using the extension namespace "http://purl.org/net/xml2rfc/ext".
1184
118510.1.  <abnf-char-sequence> element
1186
1187   Converts the contained quoted string into a hex-encoded character
1188   sequence, for use in case-sensitive ABNF productions.
1189
1190   For instance, "<x:abnf-char-sequence>"HTTP"</x:abnf-char-sequence>"
1191   gets converted to "%x48.54.54.50".
1192
119310.2.  <anchor-alias> element
1194
1195   Using its "value" attribute, this element allows the definition of an
1196   internal link target alias for the enclosing element.  This alias can
1197   then be used with the <ref> element for intra-document references.
1198
1199   Note that the anchor alias is not subject to the naming constraints
1200   that apply to anchor elements (which are XML names).
1201
120210.3.  <bcp14> element
1203
1204   This element marks the content as being one of the normative keywords
1205   defined in [RFC2119].
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231Reschke                                                        [Page 22]
1232
1233Documentation             RFC2629 through XSLT                April 2009
1234
1235
1236   The DOCTYPE definition below allows using these keywords using XML
1237   entity expansion: such as in "...server &MUST; accept...".
1238
1239   <!DOCTYPE rfc [
1240    <!ENTITY MAY "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1241      >MAY</bcp14>">
1242    <!ENTITY MUST "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1243      >MUST</bcp14>">
1244    <!ENTITY MUST-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1245      >MUST NOT</bcp14>">
1246    <!ENTITY OPTIONAL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1247      >OPTIONAL</bcp14>">
1248    <!ENTITY RECOMMENDED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1249      >RECOMMENDED</bcp14>">
1250    <!ENTITY REQUIRED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1251      >REQUIRED</bcp14>">
1252    <!ENTITY SHALL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1253      >SHALL</bcp14>">
1254    <!ENTITY SHALL-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1255      >SHALL NOT</bcp14>">
1256    <!ENTITY SHOULD "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1257      >SHOULD</bcp14>">
1258    <!ENTITY SHOULD-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'
1259      >SHOULD NOT</bcp14>">]>
1260
126110.4.  <bb> element
1262
1263   Marking up a string as <bb> indicates that it represents the bottom
1264   line of a box drawing, replacing the "+" and "-" characters
1265   accordingly.
1266
126710.5.  <bc> element
1268
1269   Marking up a string as <bc> indicates that it represents a center
1270   line of a box drawing, replacing the "|" character accordingly.
1271
127210.6.  <blockquote> element
1273
1274   This element is like the "blockquote" element in [HTML] (note this is
1275   a block-level element!).  It should contain one or more <t> child
1276   elements.
1277
127810.7.  <boilerplate> element
1279
1280   Can be used to include boilerplate (status, copyright, ...) into the
1281   front or back section. <section> elements within <x:boilerplate>
1282   appear as unnumbered sections in the output.
1283
1284
1285
1286
1287Reschke                                                        [Page 23]
1288
1289Documentation             RFC2629 through XSLT                April 2009
1290
1291
1292   _This element currently can not be "down-translated" for use in
1293   xml2rfc!_
1294
129510.8.  <bt> element
1296
1297   Marking up a string as <bt> indicates that it represents the top line
1298   of a box drawing, replacing the "+" and "-" characters accordingly.
1299
130010.9.  <dfn> element
1301
1302   This element is like the "dfn" element in [HTML].
1303
130410.10.  <h> element
1305
1306   This element is like the "h" element in [XHTML2].
1307
130810.11.  <highlight> element
1309
1310   Used to highlight text passages, currently only allowed in <artwork>.
1311
1312   Note: this is stripped when generating input for xml2rfc, so please
1313   use with care.
1314
131510.12.  <length-of> element
1316
1317   This element can be used to insert the length of another formatted
1318   section (in decimal).
1319
1320   Example: computing the Content-Length header value
1321
1322   <artwork>
1323   ...
1324   Content-Length: <x:length-of target="req"/>
1325
1326   <x:span anchor="req">123456789
1327   <x:span><artwork/>
1328
1329   The lenght computation counts line ends as two characters (CRLF).
1330
1331   Note that indentation characters in artwork _will_ be counted.  The
1332   "indented" attribute allows to specify the amount of indentation to
1333   be substracted from the computed length.
1334
133510.13.  <link> element
1336
1337   This element can be added as a top-level child element below <rfc> to
1338   indicate additional link information.  It's currently used only when
1339   generating HTML output, in which case an HTML <link> element with
1340
1341
1342
1343Reschke                                                        [Page 24]
1344
1345Documentation             RFC2629 through XSLT                April 2009
1346
1347
1348   identical attributes gets generated.
1349
1350   Example: generating HTML link element
1351
1352           <x:link xmlns="http://purl.org/net/xml2rfc/ext"
1353               rel="Bookmark"
1354               title="IETF WEBDAV Working Group"
1355               href="http://ftp.ics.uci.edu/pub/ietf/webdav/"/>
1356
135710.14.  <lt> element
1358
1359   Used for grouping multiple <t> elements into a single list item.
1360
136110.15.  <note> element
1362
1363   Can be used to add a note, usually indented by a few characters.  It
1364   should contain one or more <t> child elements.
1365
136610.16.  <parse-xml> element
1367
1368   This element instructs the processor to parse the contents as XML and
1369   to warn when there's a problem (requires either MSXML or Saxon8 or
1370   newer).
1371
137210.17.  <q> element
1373
1374   This element is like the "q" element in [HTML].
1375
137610.18.  <ref> element
1377
1378   This element is a simplified variant of the <xref> element, in that
1379   no "target" attribute needs to be specified, instead the text
1380   contents acts as identifier.  That in itself wouldn't be terribly
1381   useful, but together with the <anchor-alias>, it allows referring to
1382   other parts of the document with minimal additional markup.
1383
1384   For instance, given an alias definition such as
1385
1386         <section title="Test" anchor="test">
1387           <x:anchor-alias value="alias1"/>
1388           <x:anchor-alias value="alias 2"/>
1389           ...
1390         </section>
1391
1392   the following simple references
1393
1394         <x:ref>test</x:ref>
1395         <x:ref>alias1</x:ref>
1396
1397
1398
1399Reschke                                                        [Page 25]
1400
1401Documentation             RFC2629 through XSLT                April 2009
1402
1403
1404         <x:ref>alias 2</x:ref>
1405
1406   are equivalent to...:
1407
1408         <xref target="test">test</xref>
1409         <xref target="test">alias1</xref>
1410         <xref target="test">alias 2</xref>
1411
141210.19.  <source> element
1413
1414   Can be used to enhance a <reference> with information about the
1415   location for the XML source.  This can be used by the <xref>
1416   processing code to automatically extract the target section number.
1417
1418   For example:
1419
1420         ...
1421         <xref target="RFC2616" x:fmt="of" x:rel="#PUT" />
1422         ...
1423
1424         <reference target="RFC2616"/>
1425           ...
1426           <x:source href="rfc2616.xml"/>
1427           ...
1428
142910.20.  <sup> element
1430
1431   This element is like the "sup" element in [HTML].
1432
1433   Note: the down conversion to RFC2629 format replaces "x^y" by "x^y".
1434
143510.21.  Extensions to Xml2rfc <artwork> element
1436
1437   Sometimes, artwork occurs inside lists.  To get it indent properly in
1438   xml2rfc's text output, it needs to be indented in the source.  This
1439   is sub-optimal, as this whitespace will also appear in the HTML
1440   output, where it's already indented due to HTML's semantics.
1441
1442   As a workaround, a "x:indent-with" attribute can be specified,
1443   containing a string that will be prepended to each line when
1444   "clean-for-DTD.xslt" is run (see Section 11.4).
1445
144610.22.  Extensions to Xml2rfc <iref> element
1447
1448   The extension attribute below is allowed on the standard <iref>
1449   element:
1450
1451
1452
1453
1454
1455Reschke                                                        [Page 26]
1456
1457Documentation             RFC2629 through XSLT                April 2009
1458
1459
1460   o  x:for-anchor specifies that the <iref> will also be automatically
1461      inserted whenever the specified anchor is cross-referenced -- this
1462      may save entering lots of <iref> instances.  As a special case, a
1463      value of "" (empty string) refers to the anchor attribute of the
1464      closest ancestor.
1465
146610.23.  Extensions to Xml2rfc <list> element
1467
1468   The extension attribute below is allowed on the standard <list>
1469   element:
1470
1471   o  x:indent specifies the amount of indentation for list items in
1472      hanging lists.  This can be useful when the output format, such as
1473      XSL-FO, does not support automatical formatting.  The value takes
1474      an XSL-FO width, such as "5em".  The default is _length of longest
1475      label in characters_ times _0.8em_.
1476
1477   Also, the <list> element can take <x:lt> child elements instead of
1478   <t>, allowing to insert multiple paragraphs into a single list item.
1479
148010.24.  Extensions to Xml2rfc <rfc> element
1481
1482   The extension attributes below are allowed on the standard <rfc>
1483   element:
1484
1485   o  grddl:transformation can be used to reference a GRDDL transform.
1486
1487   o  x:maturiy-level can be used to specify the IETF Standards Track
1488      Maturity Level of "proposed", "draft" or "internet" (see Section
1489      4.1 of [RFC2026]).
1490
149110.25.  Extensions to Xml2rfc <section> element
1492
1493   The extension attribute below is allowed on the standard <list>
1494   element:
1495
1496   o  x:fixed-section-number can be used to specify a fixed section
1497      number.  This can be useful when formatting historic documents
1498      that used a different numbering style.
1499
150010.26.  Extensions to Xml2rfc <xref> element
1501
1502   Three extension attributes are allowed on the standard <xref>
1503   element:
1504
1505   1.  x:sec can be specified to point to a specific section of the
1506       referenced document,
1507
1508
1509
1510
1511Reschke                                                        [Page 27]
1512
1513Documentation             RFC2629 through XSLT                April 2009
1514
1515
1516   2.  x:rel may specify a relative reference to use when linking into
1517       the referenced document (if linking by section number is not
1518       available),
1519
1520   3.  x:fmt defines the text format to be used.
1521
1522   The following formats are defined for the x:fmt attribute:
1523
1524   , (Comma)  [_reference_], Section _sec_
1525
1526   () [_reference_] (Section _sec_)
1527
1528   anchor  Like the default format, but without brackets.
1529
1530   of Section _sec_ of [_reference_]
1531
1532   number  _sec_
1533
1534   none  No output (can be used to have xrefs to references without
1535      having them rendered as such)
1536
1537   sec  Section _sec_
1538
1539   These extensions are currently only supported for <xref> elements
1540   without child nodes.
1541
1542   If the processor knows how to reference the target section, it will
1543   generate a link directly to the target section, such as in [RFC2119],
1544   Section 5.
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567Reschke                                                        [Page 28]
1568
1569Documentation             RFC2629 through XSLT                April 2009
1570
1571
157211.  Utilities
1573
157411.1.  Checking References
1575
1576   "check-references.xslt" can be used to check all references to RFC-
1577   and ID-series IETF publications and to W3C publications (note this
1578   script requires local copies of
1579   <ftp://ftp.isi.edu/in-notes/rfc-index.xml> and
1580   <http://www.w3.org/2002/01/tr-automation/tr.rdf> and will use the XML
1581   status information provided at <http://tools.ietf.org/>).
1582
1583   If the document is supposed to be published on the IETF standards
1584   track, the desired level can be specified using the parameter
1585   "intended-level" as 'proposed', 'draft' or 'internet'.
1586   Alternatively, it can be specified inside the document using the
1587   attribute x:maturity-level on the <rfc> element.
1588
1589   Note: Downward references should be annotated using the <annotate>
1590   element, containing an <xref> to [BCP97].
1591
1592   When an XSLT 2.0 processor is used, links in the document can be
1593   checked as well using the "link-check" paramerer ('yes' or 'no').
1594   Note that this only works for http links to documents of tytpe
1595   text/*.
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623Reschke                                                        [Page 29]
1624
1625Documentation             RFC2629 through XSLT                April 2009
1626
1627
1628   For instance, as of 2008-07-12, the script produces for
1629   <http://greenbytes.de/tech/webdav/rfc2518.xml>:
1630
1631   > saxon rfc2518.xml check-references.xslt intended-status=PROPOSED \
1632     link-check=yes
1633
1634   Normative References:
1635   ISO-11578: not checked
1636   ISO-639: not checked
1637   ISO-8601: not checked
1638   REC-xml-19980210: [FirstEdition] obsoleted by REC-xml-20001006
1639   REC-xml-names-19990114: [FirstEdition] obsoleted by
1640    REC-xml-names-20060816
1641   RFC1766: [PROPOSED STANDARD] obsoleted by RFC3066 RFC3282
1642   RFC2068: [PROPOSED STANDARD] obsoleted by RFC2616
1643   RFC2069: [PROPOSED STANDARD] obsoleted by RFC2617
1644   RFC2119: [BEST CURRENT PRACTICE] (-> BCP0014) ok
1645   RFC2141: [PROPOSED STANDARD] ok
1646   RFC2277: [BEST CURRENT PRACTICE] (-> BCP0018) ok
1647   RFC2396: [DRAFT STANDARD] obsoleted by RFC3986
1648   RFC2279: [DRAFT STANDARD] obsoleted by RFC3629
1649
1650   Informational References:
1651   REC-PICS-labels-961031: [REC] ok
1652   RFC1807: [INFORMATIONAL] ok
1653   RFC2026: [BEST CURRENT PRACTICE] (-> BCP0009) ok
1654   RFC2291: [INFORMATIONAL] ok
1655   RFC2376: [INFORMATIONAL] obsoleted by RFC3023
1656   RFC2413: [INFORMATIONAL] obsoleted by RFC5013
1657   USMARC: not checked
1658   WF: not checked
1659
1660   Link Targets
1661   <http://www.w3.org/TR/1998/REC-xml-19980210>: ok
1662   <http://www.w3.org/TR/1999/REC-xml-names-19990114>: ok
1663   <http://www.dlib.org/dlib/july96/lagoze/07lagoze.html>: ok
1664   <http://www.w3.org/pub/WWW/TR/REC-PICS-labels-961031.html>: ok
1665
1666   Recognized formats in the <seriesInfo> element are:
1667
1668   o  for RFCs, the name attribute must be "RFC", and the value
1669      attribute must be the number of the RFC,
1670
1671   o  for Internet Drafs, the name attribute must be "ID" or "Internet-
1672      Draft", and the value attribute must be the file name of the draft
1673      (including the two-digit running number, but excluding a file
1674      extension),
1675
1676
1677
1678
1679Reschke                                                        [Page 30]
1680
1681Documentation             RFC2629 through XSLT                April 2009
1682
1683
1684   o  for W3C documents, the name attribute must be "W3C", must start
1685      with "W3C ", or must start with "World Wide Web Consortium ", and
1686      the value attribute must be the "shorthand" name of the
1687      specification, such as "REC-xml-19980210".
1688
168911.2.  Generating Graphs from References
1690
1691   "gen-reference-graph.xslt" generates a graph of RFC dependencies,
1692   using the same base data as in "check-references.xslt" (see
1693   Section 11.1).  Its output is a "dot" file, to be processed by
1694   GraphViz (see <http://www.graphviz.org/>).
1695
1696   The picture below shows the RFC dependencies in RFC2629.
1697
1698
169911.3.  Producing reference entries for books
1700
1701   "amazon-asin.xslt" uses the Amazon web services to generate a
1702   <reference> element for a given ASIN (ISBN).
1703
1704   For instance:
1705
1706   <?xml version="1.0" encoding="utf-8"?>
1707   <references>
1708    <reference target="urn:isbn:0134516591">
1709      <front>
1710        <title>Simple Book, The: An Introduction to Internet Management,
1711                  Revised Second Edition</title>
1712        <author surname="Rose"
1713                   fullname="Marshall T. Rose" initials="M. T. ">
1714          <organization/>
1715        </author>
1716        <author surname="Marshall"
1717                   fullname="Rose T. Marshall" initials="R. T.">
1718          <organization/>
1719        </author>
1720        <date year="1996" month="March"/>
1721      </front>
1722      <seriesInfo name="Prentice Hall" value=""/>
1723    </reference>
1724   </references>
1725
1726   Note that the resulting XML usually requires checking, in this case
1727   Amazon's database is playing tricks with Marshall's name...
1728
1729
1730
1731
1732
1733
1734
1735Reschke                                                        [Page 31]
1736
1737Documentation             RFC2629 through XSLT                April 2009
1738
1739
174011.4.  Down-converting to RFC2629bis DTD
1741
1742   "clean-for-DTD.xslt" can be used to down-convert some extensions to a
1743   format that is supported by the base xml2rfc distribution.  Note that
1744   these extensions are experimental (feedback appreciated).
1745
1746   The following mappings are done:
1747
1748   o  <iref> elements inside <artwork> elements are moved in front of
1749      the enclosing <figure> element.
1750
1751   o  <xref> elements inside <artwork> are expanded just like in regular
1752      text (that is, the markup is stripped, but the element is replaced
1753      by the applicable replacement text).
1754
1755   o  <x:anchor-alias> elements get stripped.
1756
1757   o  <x:bcp14> elements get stripped.
1758
1759   o  <x:bb>, <x:bc> and <x:bt> elements get stripped.
1760
1761   o  <x:blockquote> elements get converted to indented text (through a
1762      <list> element).
1763
1764   o  <x:dfn> elements get stripped.
1765
1766   o  <x:h> elements get stripped.
1767
1768   o  <x:link> elements get stripped.
1769
1770   o  <x:note> elements get converted to indented text (through a <list>
1771      element).
1772
1773   o  <x:q> elements get stripped, with apostrophes added around the
1774      text.
1775
1776   o  <x:ref> elements get replaced by <xref> elements, targetting
1777      either the anchor or another anchor with matching <x:anchor-alias>
1778      child element.
1779
178011.5.  Extracting artwork
1781
1782   With "extract-artwork.xslt", artwork elements named through the
1783   "name" attribute can be extracted.  This can be used to automatically
1784   check their syntax (for instance, when ABNFs appear within a figure
1785   element).
1786
1787
1788
1789
1790
1791Reschke                                                        [Page 32]
1792
1793Documentation             RFC2629 through XSLT                April 2009
1794
1795
1796   For instance:
1797   saxon rfc3986.xml extract-artwork.xslt name=uri.abnf
1798
1799   In addition, artwork of a specific type can be extracted, such as
1800   with:
1801   saxon rfc3986.xml extract-artwork.xslt type=abnf
1802
180311.6.  GRRDL
1804
1805   "rfc2629grddl.xslt" extracts RDF information.  This is experimental
1806   work-in-progress.  See <http://www.w3.org/TR/grddl/> for more
1807   information.
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847Reschke                                                        [Page 33]
1848
1849Documentation             RFC2629 through XSLT                April 2009
1850
1851
185212.  Informative References
1853
1854   [BCP97]    Klensin, J. and S. Hartman, "Handling Normative References
1855              to Standards-Track Documents", BCP 97, RFC 4897,
1856              June 2007.
1857
1858   [DC-HTML]  Johnston, P. and A. Powell, "Expressing Dublin Core
1859              metadata using HTML/XHTML meta and link elements", Dublin
1860              Core Metadata Initiative , August 2008,
1861              <http://dublincore.org/documents/2008/08/04/dc-html/>.
1862
1863   [HTML]     Raggett, D., Hors, A., and I. Jacobs, "HTML 4.01
1864              Specification", W3C REC-html401-19991224, December 1999,
1865              <http://www.w3.org/TR/html401/>.
1866
1867   [RFC2026]  Bradner, S., "The Internet Standards Process -- Revision
1868              3", BCP 9, RFC 2026, October 1996.
1869
1870   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
1871              Requirement Levels", BCP 14, RFC 2119, March 1997.
1872
1873   [RFC2616]  Fielding, R., Gettys, J., Mogul, J., Nielsen, H.,
1874              Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
1875              Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
1876
1877   [RFC2629]  Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629,
1878              June 1999.
1879
1880   [RFC2648]  Moats, R., "A URN Namespace for IETF Documents", RFC 2648,
1881              August 1999.
1882
1883   [RFC2731]  Kunze, J., "Encoding Dublin Core Metadata in HTML",
1884              RFC 2731, December 1999.
1885
1886   [RFC5234]  Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
1887              Specifications: ABNF", STD 68, RFC 5234, January 2008.
1888
1889   [RNC]      Clark, J., "RELAX NG Compact Syntax", OASIS , Nov 2002, <h
1890              ttp://www.oasis-open.org/committees/relax-ng/
1891              compact-20021121.html>.
1892
1893   [XHTML2]   Axelsson, J., Birbeck, M., Dubinko, M., Epperson, B.,
1894              Ishikawa, M., McCarron, S., Navarro, A., and S. Pemberton,
1895              "XHTML[TM] 2.0", W3C WD-xhtml2-20060726, July 2006,
1896              <http://www.w3.org/TR/xhtml2>.
1897
1898   [XSL-FO]   Berglund, A., "Extensible Stylesheet Language (XSL)
1899              Version 1.1", W3C REC-xsl11-20061205, Dec 2006,
1900
1901
1902
1903Reschke                                                        [Page 34]
1904
1905Documentation             RFC2629 through XSLT                April 2009
1906
1907
1908              <http://www.w3.org/TR/2006/REC-xsl11-20061205/>.
1909
1910   [1]   <http://www.exslt.org/exsl/functions/node-set/
1911         exsl.node-set.html>
1912
1913   [2]   <http://bugzilla.mozilla.org/show_bug.cgi?id=193678>
1914
1915   [3]   <https://addons.mozilla.org/firefox/2933/>
1916
1917   [4]   <http://microformats.org/wiki/hcard>
1918
1919   [5]   <http://www.w3.org/TR/2003/WD-xsl11-20031217/>
1920
1921   [6]   <http://www.antennahouse.com/>
1922
1923   [7]   <http://www.antennahouse.com/XSL20/axf-extension.htm>
1924
1925   [8]   <http://xml.apache.org/fop/>
1926
1927   [9]   <http://xep.xattic.com/>
1928
1929   [10]  <http://xep.xattic.com/xep/spec.html>
1930
1931   [11]  <http://www.thaiopensource.com/relaxng/jing.html>
1932
1933   [12]  <http://dpcarlisle.blogspot.com/2007/05/
1934         exslt-node-set-function.html>
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959Reschke                                                        [Page 35]
1960
1961Documentation             RFC2629 through XSLT                April 2009
1962
1963
1964Appendix A.  RELAX NG Compact Schema
1965
1966   The RelaxNG schema ([RNC]) below can be used to validate input
1967   documents (for instance, with Jing [11]).
1968
1969   _Note that this is work in progress, and doesn't yet cover all
1970   extensions completely._
1971
1972  # WORK IN PROGRESS! PLEASE REPORT PROBLEMS TO THE AUTHOR.
1973
1974  # Define our extension namespace
1975  namespace x = "http://purl.org/net/xml2rfc/ext"
1976
1977  # Define GRDDL namespace
1978  namespace grddl = "http://www.w3.org/2003/g/data-view#"
1979
1980  # Define RDF namespace
1981  namespace rdf = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
1982
1983  # Include rfc2629bis RNC grammar
1984  include "rfc2629.rnc" {
1985
1986    # Redefine <artwork> to allow markup
1987    artwork =
1988      element artwork {
1989        attlist.artwork,
1990        (TEXT
1991          | eref
1992          | iref
1993          | spanx
1994          | xref
1995          | x_abnf-char-sequence
1996          | x_bb
1997          | x_bc
1998          | x_bt
1999          | x_highlight
2000          | x_length-of
2001          | x_parse-xml
2002          | x_ref
2003          | x_span
2004          | x_x)*
2005      }
2006
2007    # Redefine <back> to allow boilerplate
2008    back =
2009      element back {
2010        attlist.back,
2011        references*,
2012
2013
2014
2015Reschke                                                        [Page 36]
2016
2017Documentation             RFC2629 through XSLT                April 2009
2018
2019
2020        section*,
2021        x_boilerplate?
2022      }
2023
2024    # Redefine <c> to allow our extension elements
2025    c =
2026      element c {
2027        attlist.c,
2028        (TEXT
2029          | xref
2030          | eref
2031          | iref
2032          | cref
2033          | spanx
2034          | x_ref)*
2035      }
2036
2037    # Redefine <cref> to allow more child elements
2038    cref =
2039      element cref {
2040        attlist.cref,
2041        (TEXT
2042          | eref)*
2043      }
2044
2045    # Redefine <front> to allow boilerplate
2046    front =
2047      element front {
2048        attlist.front,
2049        title,
2050        author+,
2051        date,
2052        area*,
2053        workgroup*,
2054        keyword*,
2055        x_boilerplate?,
2056        abstract?,
2057        note*
2058      }
2059
2060    # Redefine <list> element to allow <x:lt> child elements
2061    \list =
2062      element list {
2063        attlist.list,
2064        (t+ | x_lt+)
2065      }
2066
2067    # Redefine <preamble> to allow our extension elements
2068
2069
2070
2071Reschke                                                        [Page 37]
2072
2073Documentation             RFC2629 through XSLT                April 2009
2074
2075
2076    preamble =
2077      element preamble {
2078        attlist.preamble,
2079        (TEXT
2080          | xref
2081          | eref
2082          | iref
2083          | cref
2084          | spanx
2085          | x_anchor-alias)*
2086      }
2087
2088    # Redefine <postamble> to allow our extension elements
2089    postamble =
2090      element postamble {
2091        attlist.postamble,
2092        (TEXT
2093          | xref
2094          | eref
2095          | iref
2096          | cref
2097          | spanx
2098          | x_bcp14)*
2099      }
2100
2101    # Redefine <reference> to allow our extension elements
2102    reference =
2103      element reference {
2104        attlist.reference,
2105        front,
2106        seriesInfo*,
2107        format*,
2108        annotation*,
2109        x_source?
2110      }
2111
2112    # Redefine <rfc> to allow our extension elements
2113    rfc =
2114      element rfc {
2115        attlist.rfc,
2116        x_link*,
2117        x_assign-section-number*,
2118        front,
2119        middle,
2120        back?
2121      }
2122
2123    # Redefine <section> to allow our extension elements
2124
2125
2126
2127Reschke                                                        [Page 38]
2128
2129Documentation             RFC2629 through XSLT                April 2009
2130
2131
2132    section =
2133      element section {
2134        attlist.section,
2135        (t
2136         | figure
2137         | texttable
2138         | iref
2139         | section
2140         | x_anchor-alias
2141         | x_blockquote
2142         | x_include-author
2143         | x_note
2144         | rdf_Description)*
2145      }
2146
2147    # Redefine <spanx> to allow some markup
2148    spanx =
2149      element spanx {
2150        attlist.spanx,
2151        (TEXT
2152          | iref
2153          | xref
2154          | x_ref)*
2155      }
2156
2157    # Redefine <t> to allow our extension elements
2158    t =
2159      element t {
2160        attlist.t,
2161        (TEXT
2162         | \list
2163         | figure
2164         | xref
2165         | eref
2166         | iref
2167         | cref
2168         | spanx
2169         | vspace
2170         | x_abnf-char-sequence
2171         | x_anchor-alias
2172         | x_bcp14
2173         | x_dfn
2174         | x_h
2175         | x_q
2176         | x_ref
2177         | x_sup)*
2178      }
2179  }
2180
2181
2182
2183Reschke                                                        [Page 39]
2184
2185Documentation             RFC2629 through XSLT                April 2009
2186
2187
2188  # Allow x:indent-with attribute on <artwork>
2189  attlist.artwork &=
2190    attribute x:indent-with { ATEXT }?
2191
2192  # Allow anchor attribute on <author>
2193  attlist.author &=
2194    attribute anchor { xsd:ID }?
2195
2196    # Extend attribute set for <iref> (see Section 10.22)
2197  attlist.iref &=
2198    attribute x:for-anchor { ATEXT }?
2199
2200  # Extend attribute set for <list> (see Section 10.23)
2201  attlist.list &=
2202    attribute x:indent { ATEXT }?
2203
2204  # Extend attribute set for <preamble>
2205  attlist.preamble &=
2206    attribute anchor { xsd:ID }?
2207
2208  # Extend attribute set for <rfc>
2209  attlist.rfc &=
2210    attribute grddl:transformation { ATEXT }?,
2211    attribute x:maturity-level { "proposed" | "draft" | "internet" }?
2212
2213  # Extend attribute set for <section> (see Section 10.25)
2214  attlist.section &=
2215    attribute x:fixed-section-number { ATEXT }?
2216
2217  # Allow anchor attribute on <spanx>
2218  attlist.spanx &=
2219    attribute anchor { xsd:ID }?
2220
2221  # Extend attribute set for <xref> (see Section 10.26)
2222  attlist.xref &=
2223    attribute x:fmt  { "()" | "," | "anchor" | "of" | "number" | "sec" |
2224                       "none" }?,
2225    attribute x:rel  { ATEXT }?,
2226    attribute x:sec  { ATEXT }?
2227
2228  # Conversion to ABNF char sequence (see Section 10.1)
2229  x_abnf-char-sequence =
2230    element x:abnf-char-sequence {
2231      TEXT
2232    }
2233
2234  # Aliasing of anchors (see Section 10.2)
2235  x_anchor-alias =
2236
2237
2238
2239Reschke                                                        [Page 40]
2240
2241Documentation             RFC2629 through XSLT                April 2009
2242
2243
2244    element x:anchor-alias {
2245      attribute value { TEXT },
2246      empty
2247    }
2248
2249  # Including Author information
2250  # (experimental)
2251  x_include-author =
2252    element x:include-author {
2253      attribute target { xsd:IDREF }
2254    }
2255
2256  # Setting section numbers for internally generated sections
2257  # (experimental)
2258  x_assign-section-number =
2259    element x:assign-section-number {
2260      attribute builtin-target { "authors" },
2261      attribute number { TEXT },
2262      empty
2263    }
2264
2265  # Bottom line of box drawing (see Section 10.4)
2266  x_bb =
2267    element x:bb {
2268      (TEXT
2269        | iref
2270        | xref
2271        | x_bb
2272        | x_bc
2273        | x_bt
2274        | x_ref)*
2275    }
2276
2277  # Center line of box drawing (see Section 10.5)
2278  x_bc =
2279    element x:bc {
2280      (TEXT
2281        | iref
2282        | xref
2283        | x_bb
2284        | x_bc
2285        | x_bt
2286        | x_ref)*
2287    }
2288
2289  # BCP14/RFC2119 keywords (see Section 10.3)
2290  x_bcp14 =
2291    element x:bcp14 {
2292
2293
2294
2295Reschke                                                        [Page 41]
2296
2297Documentation             RFC2629 through XSLT                April 2009
2298
2299
2300      "MAY"
2301      | "MUST"
2302      | "MUST NOT"
2303      | "NOT RECOMMENDED"
2304      | "OPTIONAL"
2305      | "RECOMMENDED"
2306      | "REQUIRED"
2307      | "SHALL"
2308      | "SHALL NOT"
2309      | "SHOULD"
2310      | "SHOULD NOT"
2311    }
2312
2313  # Blockquote (see Section 10.6)
2314  x_blockquote =
2315    element x:blockquote {
2316      attribute cite { URI }?,
2317      t+
2318    }
2319
2320  # Boilerplate (see Section 10.6)
2321  x_boilerplate =
2322    element x:boilerplate {
2323      section+
2324    }
2325
2326  # Top line of box drawing (see Section 10.8)
2327  x_bt =
2328    element x:bt {
2329      (TEXT
2330        | iref
2331        | xref
2332        | x_bb
2333        | x_bc
2334        | x_bt
2335        | x_ref)*
2336    }
2337
2338  # Definition (see Section 10.9)
2339  x_dfn =
2340    element x:dfn {
2341      attribute anchor { xsd:ID }?,
2342      (TEXT
2343        | iref)*
2344    }
2345
2346  # Heading (see Section 10.10)
2347  x_h =
2348
2349
2350
2351Reschke                                                        [Page 42]
2352
2353Documentation             RFC2629 through XSLT                April 2009
2354
2355
2356    element x:h {
2357      TEXT
2358    }
2359
2360  # Heading (see Section 10.11)
2361  x_highlight =
2362    element x:highlight {
2363      TEXT
2364    }
2365
2366  # Length Measurement (see Section 10.12)
2367  x_length-of =
2368    element x:length-of {
2369      attribute indented { NUMBER }?,
2370      attribute target { xsd:IDREF },
2371      empty
2372    }
2373
2374  # Link (see Section 10.13)
2375  x_link =
2376    element x:link {
2377      attribute href { URI },
2378      attribute title { TEXT }?,
2379      attribute rel { TEXT },
2380      empty
2381    }
2382
2383  # Extended list item (see Section 10.14)
2384  x_lt =
2385    element x:lt {
2386      attribute anchor { xsd:ID }?,
2387      attribute hangText { TEXT }?,
2388      t+
2389    }
2390
2391  # Note (see Section 10.15)
2392  x_note =
2393    element x:note {
2394      t+
2395    }
2396
2397  # Signal XML content (see Section 10.16)
2398  x_parse-xml =
2399    element x:parse-xml {
2400      TEXT
2401    }
2402
2403  # Inline quote (see Section 10.17)
2404
2405
2406
2407Reschke                                                        [Page 43]
2408
2409Documentation             RFC2629 through XSLT                April 2009
2410
2411
2412  x_q =
2413    element x:q {
2414      TEXT
2415    }
2416
2417  # Anchor reference (see Section 10.18)
2418  x_ref =
2419    element x:ref {
2420      TEXT
2421    }
2422
2423  # source information (see Section 10.19)
2424  x_source =
2425    element x:source {
2426      attribute basename { ATEXT }?,
2427      attribute href { URI },
2428      empty
2429    }
2430
2431  # superscript (see Section 10.20)
2432  x_sup =
2433    element x:sup {
2434      TEXT
2435    }
2436
2437  # Inline Span
2438  x_span =
2439    element x:span {
2440      attribute anchor { xsd:ID }?,
2441      (TEXT
2442        | x_parse-xml)*
2443    }
2444
2445  # Nop (for alignment in source)
2446  x_x =
2447    element x:x {
2448      empty
2449    }
2450
2451  # Embed RDF statements
2452  rdf_Description =
2453    element rdf:Description {
2454      rdf_content
2455    }
2456
2457  rdf_content =
2458    ( TEXT | element * { rdf_content })*
2459
2460
2461
2462
2463Reschke                                                        [Page 44]
2464
2465Documentation             RFC2629 through XSLT                April 2009
2466
2467
2468Appendix B.  Implementation Notes
2469
2470B.1.  Recognized type attributes for <artwork> element
2471
2472   Specific values in the <artwork> element's "type" attribute are
2473   recognized and cause a different visual style to be used:
2474
2475   +-------------------------------------+-----------------------------+
2476   | Media Type                          | Comment                     |
2477   +-------------------------------------+-----------------------------+
2478   | abnf                                | ABNF as per [RFC5234]       |
2479   |                                     |                             |
2480   | abnf2616                            | ABNF as per [RFC2616],      |
2481   |                                     | Section 2.1                 |
2482   |                                     |                             |
2483   | application/relax-ng-compact-syntax | Relax NG Compact Syntax as  |
2484   |                                     | per [RNC]                   |
2485   |                                     |                             |
2486   | application/xml-dtd                 | XML DTD                     |
2487   |                                     |                             |
2488   | message/http; msgtype="request"     | HTTP message, as per        |
2489   |                                     | [RFC2616], Section 19.1     |
2490   |                                     |                             |
2491   | message/http; msgtype="response"    | HTTP message, as per        |
2492   |                                     | [RFC2616], Section 19.1     |
2493   +-------------------------------------+-----------------------------+
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519Reschke                                                        [Page 45]
2520
2521Documentation             RFC2629 through XSLT                April 2009
2522
2523
2524Appendix C.  License
2525
2526   Copyright (c) 2006-2009, Julian Reschke
2527   (julian.reschke@greenbytes.de)
2528
2529   All rights reserved.
2530
2531   Redistribution and use in source and binary forms, with or without
2532   modification, are permitted provided that the following conditions
2533   are met:
2534
2535   o  Redistributions of source code must retain the above copyright
2536      notice, this list of conditions and the following disclaimer.
2537
2538   o  Redistributions in binary form must reproduce the above copyright
2539      notice, this list of conditions and the following disclaimer in
2540      the documentation and/or other materials provided with the
2541      distribution.
2542
2543   o  Neither the name of Julian Reschke nor the names of its
2544      contributors may be used to endorse or promote products derived
2545      from this software without specific prior written permission.
2546
2547   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
2548   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
2549   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
2550   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
2551   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2552   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2553   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2554   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2555   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2556   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2557   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575Reschke                                                        [Page 46]
2576
2577Documentation             RFC2629 through XSLT                April 2009
2578
2579
2580Appendix D.  Change Logs
2581
2582D.1.  Package
2583
2584   2006-01-01  Switch to BSD License.
2585
2586   2007-01-12  Update to xml2rfc v1.33pre2.
2587
2588   2007-03-31  Update to xml2rfc v1.33pre3.
2589
2590   2007-05-01  Add XSLT test cases.
2591
2592   2008-07-18  Experimental support for inlined rdf:Description elements
2593      (ignored by the formatter, extracted by rfc2629grddl).
2594
2595   2008-12-04  Update to xml2rfc v1.34pre2.
2596
2597   2009-02-24  Experimental support for February 2009 boilerplate
2598      changes, and for the x:boilerplate element.
2599
2600D.2.  amazon-asin.xslt
2601
2602   2003-11-16  Initial release.
2603
2604   2005-04-02  Fix two DTD issues.
2605
2606D.3.  check-references.xslt
2607
2608   2003-11-16  Initial release.
2609
2610   2004-05-11  Add document status; print references type.
2611
2612   2005-01-01  Add experimental check for ID status.
2613
2614   2005-04-01  Add fixes from Bill Fenner.
2615
2616   2005-12-03  Add checks against local copy of
2617      <http://www.w3.org/2002/01/tr-automation/tr.rdf>.
2618
2619   2006-07-22  Add checks for standards levels.
2620
2621   2006-08-06  "check-ietf-references.xslt" replaced by "check-
2622      references.xslt".
2623
2624   2007-01-04  Use information online at <http://tools.ietf.org/> to
2625      retrieve Internet-Draft status information.
2626
2627
2628
2629
2630
2631Reschke                                                        [Page 47]
2632
2633Documentation             RFC2629 through XSLT                April 2009
2634
2635
2636   2007-06-16  Fix bug looking up ref type when inside change markup.
2637
2638   2008-06-14  Enhance output when draft was updated, and then published
2639      as RFC.
2640
2641   2008-07-12  Add XSLT2-based link target checking.
2642
2643   2008-08-10  Change keywords for "intended-level" to proposed/draft/
2644      internet, optionall extract intended level from /rfc/@
2645      x:maturity-level attribute.
2646
2647D.4.  gen-reference-graph.xslt
2648
2649   2006-09-03  New.
2650
2651   2007-06-07  Use Carlisle method [12] to define exslt:node-set in
2652      msxsml (which means that the stylesheet can now be used with MSXML
2653      as well).
2654
2655   2007-10-15  Use W3C data from tr.rdf as well (experimental).
2656
2657D.5.  rfc2629.xslt
2658
2659   2001-03-28  Code rearranged, generate numbered section anchors for
2660      paragraphs (t) as well.  Fixes in index handling.
2661
2662   2001-04-12  Moved HTML output into XHTML namespace.
2663
2664   2001-10-02  Fixed default location for RFCs and numbering of section
2665      references.  Support ?rfc editing processing instruction.
2666
2667   2001-10-07  Made telephone number links active.
2668
2669   2001-10-08  Support for vspace element.
2670
2671   2001-10-09  Experimental support for rfc-issue PI.
2672
2673   2001-11-11  Support rfc private PI.  Removed bogus code reporting the
2674      WG in the header.
2675
2676   2001-11-11  Support rfc private PI.  Removed bogus code reporting the
2677      WG in the header.
2678
2679   2001-12-17  Support title attribute on references element
2680
2681
2682
2683
2684
2685
2686
2687Reschke                                                        [Page 48]
2688
2689Documentation             RFC2629 through XSLT                April 2009
2690
2691
2692   2002-01-05  Support for list/@style="@format"
2693
2694   2002-01-09  Display "closed" RFC issues as deleted
2695
2696   2002-01-14  Experimentally and optionally parse XML encountered in
2697      artwork elements (requires MSXSL).
2698
2699   2002-01-27  Some cleanup.  Moved RFC issues from PIs into namespaced
2700      elements.
2701
2702   2002-01-29  Added support for sortrefs PI.  Added support for figure
2703      names.
2704
2705   2002-02-07  Highlight parts of artwork which are too wide (72
2706      characters).
2707
2708   2002-02-12  Code rearrangement for static texts.  Fixes for section
2709      numbering.  TOC generation rewritten.
2710
2711   2002-02-15  Support for irefs in sections; support iref @primary=true
2712
2713   2002-03-03  Moved anchor prefix into a constant.  Added sanity checks
2714      on user anchor names.
2715
2716   2002-03-23  Bugfix in detection of matching org names when creating
2717      the header.  Fixed sorting in subitems.
2718
2719   2002-04-02  Fix TOC link HTML generation when no TOC is generated
2720      (created broken HTML table code).
2721
2722   2002-04-03  Made rendering of references more tolerant re: missing
2723      parts.
2724
2725   2002-04-08  Fixed reference numbering when references are split into
2726      separate sections.
2727
2728   2002-04-16  Fix default namespace (shouldn't be set for HTML output
2729      method).
2730
2731   2002-04-19  Lowercase internal CSS selectors for Mozilla compliance.
2732      Do not put TOC into ul element.
2733
2734   2002-04-21  Make numbered list inside numbered lists use alphanumeric
2735      numbering.
2736
2737
2738
2739
2740
2741
2742
2743Reschke                                                        [Page 49]
2744
2745Documentation             RFC2629 through XSLT                April 2009
2746
2747
2748   2002-05-05  Updated issue/editing support.
2749
2750   2002-05-15  Bugfix for section numbering after introduction of ed:
2751      replace
2752
2753   2002-06-21  When producing private documents, do not include document
2754      status, copyright etc.
2755
2756   2002-07-08  Fix xrefs to Appendices.
2757
2758   2002-07-19  Make artwork lightyellow for easier reading. (fielding)
2759
2760   2002-10-09  Translate references title to anchor name to avoid non-
2761      uri characters. (fielding)
2762
2763   2002-10-13  Support for tocdepth PI.
2764
2765   2002-11-03  Added temporariry workaround for Mozilla/Transformiix
2766      result tree fragment problem. (search for
2767      'http://bugzilla.mozilla.org/show_bug.cgi?id=143668')
2768
2769   2002-12-25  xref code: attempt to uppercase "section" and "appendix"
2770      when at the start of a sentence.
2771
2772   2003-02-02  fixed code for vspace blankLines="0", enhanced display
2773      for list with "format" style, got rid of HTML blockquote elements,
2774      added support for "hangIndent"
2775
2776   2003-04-10  experimental support for appendix and spanx elements
2777
2778   2003-04-19  fixed counting of list numbers in "format %" styles (one
2779      counter per unique format string).  Added more spanx styles.
2780
2781   2003-05-02  experimental texttable support
2782
2783   2003-05-02  Make mailto links optional (default = none) (jre: default
2784      and PI name changed) (fielding)
2785
2786   2003-05-04  experimental support for HTML link elements; fix default
2787      for table header alignment default
2788
2789   2003-05-06  support for "background" PI.
2790
2791   2003-05-11  change %c format to lowercase alphabetic. add support for
2792      keyword elements (generate META tag). fix various HTML conformance
2793      problems. added experimental support for role attribute. do not
2794      number paragraphs in unnumbered sections. update boilerplate
2795      texts. support for "iprnotified" PI. bugfix list numbering. strip
2796
2797
2798
2799Reschke                                                        [Page 50]
2800
2801Documentation             RFC2629 through XSLT                April 2009
2802
2803
2804      whitespace when building tel: URIs.
2805
2806   2003-05-12  more conformance fixes (layout moved into CSS, move lists
2807      and figures out of para content, do not use tables for list
2808      formatting)
2809
2810   2003-05-13  add DC.Creator meta tag, refactoring
2811
2812   2003-05-16  put nbsps between "section" and section number (xref).
2813
2814   2003-05-18  author summary: add missing comma.
2815
2816   2003-06-06  fix index generation bug (transposed characters in key
2817      generation).  Enhance sentence start detection (xref starting a
2818      section was using lowercase "section").
2819
2820   2003-06-22  exp. support for xref/@format.  Add missing support for
2821      eref w/o content. exp. support for annotations in reference
2822      elements.  Code cleanup reference table formatting.
2823
2824   2003-07-09  Another fix for DC.Creator meta tag creation based on
2825      RFC2731
2826
2827   2003-07-24  Fix namespace name for DC.Creator.
2828
2829   2003-08-06  Cleanup node-set support (only use exslt (saxon, xalan,
2830      libxslt) extension functions; remove Transformix workarounds that
2831      stopped to work in Moz 1.4)
2832
2833   2003-08-09  Generate HTML lang tag.
2834
2835   2003-08-10  Map spanx/verb to HTML "samp" element.  Fix author name
2836      display in references (reverse surname/initials for last author),
2837      add "Ed.".  Fix internal bookmark generation.
2838
2839   2003-08-17  Add DCMI dates, identifiers and abstract.  Add PI to
2840      suppress DCMI generation.  Do not add TOC entry to Copyright
2841      Statement when there is none.  Align RFC2629 PI names and
2842      parameter names.  Change style for inline URIs generated by eref.
2843      Add header and footer support.  Enhance CSS paging properties.
2844      Support topblock PI.  Added hooks for proper XHTML generation
2845      through separate XSLT.  Enhance warning and error messages.  Add
2846      support for artwork image display.  Table formatting fixes
2847      (borders, thead continuation).
2848
2849
2850
2851
2852
2853
2854
2855Reschke                                                        [Page 51]
2856
2857Documentation             RFC2629 through XSLT                April 2009
2858
2859
2860   2003-08-18  Add workaround for MSXML4 node-set and Mozilla node-set
2861      issues (fallback just displays are warning).
2862
2863   2003-10-06  Add workaround for broken pre/ins handling in Mozilla
2864      (see <http://bugzilla.mozilla.org/show_bug.cgi?id=204401>).  Make
2865      use of cite attribute on ed:replace.  CSS cleanup.
2866
2867   2003-10-08  Fix minor issue detecting the same org for the header
2868      (caused by IE's non-standard whitespace handling).  Fix default
2869      handling for /rfc/@category.
2870
2871   2003-11-09  Inherit ed:entered-by from ancestor elements.  Change CSS
2872      color for inserted text to green.  Generate issues-list anchor.
2873      Do not complain about missing targets when the xref element is
2874      below ed:del.  Remove code that attempted to distinguish section/
2875      Section when producing links - always use uppercase.  Fix date
2876      rendering for issue resolutions.
2877
2878   2003-11-29  Fix color values for table backgrounds for issue
2879      rendering.  Change rendering of issue links to use inline-styles.
2880      Add colored issue markers to issues.
2881
2882   2003-12-13  Fix inheritance of ed:entered-by attribute.  Display note
2883      elements inside change tracking as well.
2884
2885   2004-01-18  When PI compact = 'yes', make most CSS print page breaks
2886      conditional.
2887
2888   2004-02-20  Support for RFC3667 IPR changes (xml2rfc 1.22); see <http
2889      ://lists.xml.resource.org/pipermail/xml2rfc/2004-February/
2890      001088.html>.
2891
2892   2004-03-11  Add "(if approved)" to "updates" and "obsoletes" unless
2893      the document has an RFC number.
2894
2895   2004-04-01  Fix RFC3667 output, see <http://lists.xml.resource.org/
2896      pipermail/xml2rfc/2004-April/001208.html>.
2897
2898   2004-04-04  Add support for section/top attribute.  Move references
2899      into plain section container.
2900
2901   2004-04-06  Do not emit identical para anchors for deleted content.
2902
2903   2004-04-14  Fix references TOC generation when there are no
2904      references.
2905
2906
2907
2908
2909
2910
2911Reschke                                                        [Page 52]
2912
2913Documentation             RFC2629 through XSLT                April 2009
2914
2915
2916   2004-04-24  Fix RFC3667 output, see
2917      <http://xml.resource.org/pipermail/xml2rfc/2004-April/
2918      001246.html>.
2919
2920   2004-05-09  Add custom support for generating compound index
2921      documents.  Add anchors for each Index letter.  Add experimental
2922      cref support.  Fix conditional page breaks before References
2923      section.
2924
2925   2004-05-16  Refactor external index generation.
2926
2927   2004-05-20  Rewrite anchor generation for comments.
2928
2929   2004-05-22  Enhance issues rendering (add links to changes).
2930
2931   2004-05-30  Allow single quote as delimiter in processing
2932      instructions as well.  Move block-level issue pointers to floats.
2933      Disable issue pointers for print media.  Add "purple numbers".
2934      Add hrefs to section headings.  Add non-printing index key letter
2935      list to start of index.
2936
2937   2004-06-01  Use &#xb6; instead of # for PNs.
2938
2939   2004-07-18  Add support for list style=letters (thanks Roy F.).  Make
2940      PNs optional; add new PI.
2941
2942   2004-09-05  Fix index links into unnumbered sections.  Bring IPR
2943      boilerplate in-line with xml2rfc 1.25.  Add experimental CSS3
2944      paged media support.  Various HTML fixes.
2945
2946   2004-09-21  Enhance checking of artwork width.
2947
2948   2004-09-26  Add check for unused references.  Uppercase letters in
2949      list style letters when nested into another list.
2950
2951   2004-10-10  Fix internal change track pointers.
2952
2953   2004-11-01  Allow change tracking on references (as a whole).
2954      Rewrite artwork handling so that it allows change tracking inside
2955      artwork.  Also allow a subset of text markup inside artwork, such
2956      as xrefs (note this requires post-processing the source to make it
2957      compliant to RFC2629bis).
2958
2959   2004-11-03  Enhanced placement of iref anchors.
2960
2961
2962
2963
2964
2965
2966
2967Reschke                                                        [Page 53]
2968
2969Documentation             RFC2629 through XSLT                April 2009
2970
2971
2972   2004-11-06  Index: display irefs that appeared (with primary=true)
2973      inside artwork elements in a monospaced font.
2974
2975   2004-11-14  Add special code so that changes in section titles can be
2976      change-tracked.
2977
2978   2005-01-14  Bugfixes for HtmlToXhtml converter.
2979
2980   2005-01-22  Enhance generation of HTML h* elements (for Mozilla
2981      Outliner).
2982
2983   2005-01-31  Put vertical space around top-level TOC entries in TOC.
2984      Switch to pt-based CSS.  Re-arrange top section.  Make hr elements
2985      reflect new-page settings in TXT output (compact-PI).  Fix page
2986      number in footer (CSS print) and add some more experimental
2987      support for paged media (tested with Prince 4.1 alpha).  Rewrite
2988      TOC and Index generation to generate HTML lists.  Cleanup id
2989      generation for paragraphs.  Reduce whitespace in output.  Fix
2990      vspace implementation.  Use right/left dqoutes and copyright sign
2991      where appropriate.
2992
2993   2005-02-04  Add <link> element to references section.  Fix newly
2994      introduced bug in references processing.
2995
2996   2005-02-05  Integrate various fixes/enhancements by Roy Fielding:
2997      spelling of "Authors' Addresses", comma setting in references,
2998      position of "Authors" section, optionally place authors addresses
2999      at end (PI), trailing dots in section numbers, switch to verdana
3000      default font in CSS.  Add experimental support for centered
3001      artwork.
3002
3003   2005-02-09  Fixes in spacing and links of references section titles.
3004      Enhance sorting in references when change tracking is in place.
3005      Re-add figure centering support.  Add missing 2nd part of
3006      "Author's Adresses" fix.
3007
3008   2005-02-25  Align section number format with xml2rfc1.29.
3009
3010   2005-03-28  Get rid of table elements in Author's section.  Add
3011      experimental hCard (<http://developers.technorati.com/wiki/hCard>)
3012      support.
3013
3014   2005-04-03  Add RFC3978-style IPR statement support.
3015      (fenner@research.att.com)
3016
3017
3018
3019
3020
3021
3022
3023Reschke                                                        [Page 54]
3024
3025Documentation             RFC2629 through XSLT                April 2009
3026
3027
3028   2005-04-11  Cleanup author display. hCard related fixes.
3029
3030   2005-05-07  Minor fixes to allow change tracking in doc title.  Add
3031      experimental support for table border styles.  CSS cleanup.
3032
3033   2005-06-18  Implement missing support for references to texttables.
3034
3035   2005-09-25  Use (-moz-)column-count when printing the index.
3036
3037   2005-10-04  Report missing element templates with xsl:message.
3038
3039   2005-10-15  Process t/@anchor.
3040
3041   2005-10-23  More workarounds for Mozilla's broken del/ins handling
3042      (this time for figures).
3043
3044   2005-10-27  lowercase hCard class names
3045
3046   2005-11-22  Enhance diagnostics for XML-in-artwork extension
3047
3048   2005-11-26  Fix formatting of section numbers for sections inserted
3049      into <back>.
3050
3051   2005-12-12  Fix some validity problems when change tracking occured
3052      inside lists.
3053
3054   2005-12-18  Add change tracking inside the index.
3055
3056   2006-02-04  Add prev/next links to highlighted changes (change
3057      tracking extension).
3058
3059   2006-02-10  Catch errors instantiating MSXML component.
3060
3061   2006-02-11  References: add "work in progress" for Internet Drafts.
3062
3063   2006-02-27  Fix front matter (lowercase Internet-Draft, say "Intended
3064      status" for non-RFC documents).  Start work on experimental
3065      extension for simplified internal links.
3066
3067   2006-03-19  Tweaks to IESG Copyright stuff; support submissionType
3068      attribute.  Fix duplicate reference anchors in HTML output.
3069      Reduce HTML Tidy warnings.  Fix reference to normative ASCII
3070      version (now requires trailing ".txt").  Tweaks to hCard
3071      generation.  Started to move non-issue-tracking extensions into
3072      namespace "http://purl.org/net/xml2rfc/ext".
3073
3074
3075
3076
3077
3078
3079Reschke                                                        [Page 55]
3080
3081Documentation             RFC2629 through XSLT                April 2009
3082
3083
3084   2006-03-27  Moved "simple reference" extension into namespace
3085      "http://purl.org/net/xml2rfc/ext" and add documentation.  HTML
3086      conformance enhancements.
3087
3088   2006-04-02  Cleanup special code for automated XHTML XSLT generation.
3089
3090   2006-04-21  Generate <CITE> elements where appropiate.  Introduce
3091      x:blockquote, x:dfn, x:h and x:q elements.
3092
3093   2006-05-06  Introduce x:bcp14 element.
3094
3095   2006-05-14  Fix content model for x:blockquote.
3096
3097   2006-06-18  Add box drawing support (x:bt, x:bc, x:bb).
3098
3099   2006-06-20  HTML validity fixes (legal chars in anchors in index).
3100
3101   2006-06-24  Reduce leading empty lines in artwork.  Move <dt> style
3102      info into CSS.
3103
3104   2006-07-14  Fix rendering of multiple street address entries (missing
3105      line break).
3106
3107   2006-07-24  Add extension for deep linking into RFCs, do not generate
3108      empty list items in TOC output, avoid empty <dt> elements for list
3109      items without hangText attribute.
3110
3111   2006-08-01  Allow @anchor on more elements; start work on Relax NG
3112      grammar for extensions.  Reduce generated style elements (use CSS
3113      classes instead).  Consistently use "id" instead of "name".
3114      Change default target for RFC links to
3115      "http://tools.ietf.org/html/rfcNNNN".
3116
3117   2006-08-06  Include appendices defined in <appendix> elements in TOC
3118      (please consider them deprecated anyhow!).  Generate links to
3119      "http://tools.ietf.org/html/draft-*" for Internet Drafts.  Replace
3120      x:frag by x:rel, allowing any kind of relative reference instead
3121      of just fragments.
3122
3123   2006-08-30  Reduce textual differences between HTML output and what
3124      xml2rfc produces in TXT output mode (section refs/reference
3125      targets).  Add small workaround for Opera 9.0.1's problem with
3126      node-set().
3127
3128   2006-10-29  Fix problem generating internal links to change markup
3129      within references section.  Enhancements when generating numbered
3130      references for deleted references.  Allow inclusion of references
3131      into the index (through include-references-in-index extension).
3132
3133
3134
3135Reschke                                                        [Page 56]
3136
3137Documentation             RFC2629 through XSLT                April 2009
3138
3139
3140      Fix a bug that caused the newer version of the IETF boilerplate to
3141      be produced rather than the pre-RFC3667 one.  Update to RFC4287
3142      boilerplate.
3143
3144   2006-11-11  Add extension attribute x:for-anchor to <iref> handling.
3145
3146   2006-11-26  Experimental (and limited) support for <x:lt>.
3147
3148   2006-12-04  Fix bugs in processing documents that have both the ipr
3149      and the number attribute set on the rfc root element.  Add support
3150      for x:fmt='none' on xrefs.  Add different pre style based on
3151      artwork type attributes (experimental).
3152
3153   2006-12-13  Add x:fmt='anchor' for xref elements.
3154
3155   2007-01-07  Fix root template for compatibility for the exslt:node-
3156      set implementation in Firefox3.
3157
3158   2007-01-29  Avoid empty table entry in front matter when organization
3159      is not specified for an author.
3160
3161   2007-02-10  Allow change tracking in table rows.
3162
3163   2007-03-09  Add hcard profile URI (<http://www.w3.org/2006/03/hcard>)
3164      to head element.  Add warning for misplaced <t> elements (after
3165      section).
3166
3167   2007-03-21  Fix internal linking from reference entries in index for
3168      some xref types.  Minor CSS tweaks contributed by MTR.  Allow
3169      turning on text justification through a PI.  Improve iref anchor
3170      generation to generate less instable anchors.
3171
3172   2007-03-28  Fixes for numbering of ed:inserted references sections.
3173
3174   2007-05-04  Do not generate anchors for edits in deleted sections.
3175      Enhance HTML conformance.
3176
3177   2007-05-19  Enhance diagnostics when using Saxon (needs Saxon's "-l"
3178      command line parameter to keep line number information).  Add
3179      warning when symref PI is missing (default will change in the
3180      future).  Add support for overriding computed section numbers
3181      (when formatting historic documents).
3182
3183   2007-06-07  Change default for symrefs PI to "yes" (see change in
3184      xml2rfc 1.33pre4).  Warn about docName attributes that appear to
3185      contain a file extension.
3186
3187
3188
3189
3190
3191Reschke                                                        [Page 57]
3192
3193Documentation             RFC2629 through XSLT                April 2009
3194
3195
3196   2007-06-26  Workaround author/@initials values without trailing dot,
3197      as in xml2rfc.tcl.
3198
3199   2007-07-14  Enhance index generation for references that use @x:sec
3200      attribute.
3201
3202   2007-09-09  Fix: sortrefs is a nop when symrefs=no.
3203
3204   2007-10-17  Work in progress: add support for referencing sections in
3205      sibling documents by anchor name.
3206
3207   2007-10-17  Work in progress (continued): support for referencing
3208      sections in sibling documents by anchor name.
3209
3210   2007-12-31  Emit warning when updating/obsoleting stuff that's not
3211      referenced.
3212
3213   2008-02-03  Support xml2rfc-1.33pre5's suppress-title attribute on
3214      texttable and figure.
3215
3216   2008-02-06  Extension: allow <eref> below <cref>.
3217
3218   2008-02-17  Extensions: add x:span and x:length-of.
3219
3220   2008-02-20  Add new RFC boilerplate (as changed in 2007-08).
3221
3222   2008-02-27  Improve diagnostics for artwork width problems; add
3223      defaulting of publication dates (requires XSLT processor
3224      supporting exslt:date, or msxml).
3225
3226   2008-02-29  Enhance CSS for link elements in the front header, update
3227      rules for generating "Acknowledgment" statement.
3228
3229   2008-03-01  Use line numbers in diagnostics in Saxon8/9 as well.
3230
3231   2008-03-02  Fix a bug in the logic choosing the boilerplate,
3232      resulting in obsolete text being inserted into IDs.
3233
3234   2008-04-01  Add support for superscript element.
3235
3236   2008-06-28  Add sanity checks for email addresses, allow multiple
3237      email elements.
3238
3239   2008-07-06  Add x:abnf-char-sequence.
3240
3241
3242
3243
3244
3245
3246
3247Reschke                                                        [Page 58]
3248
3249Documentation             RFC2629 through XSLT                April 2009
3250
3251
3252   2008-08-21  Add x:note.
3253
3254   2008-09-06  Add experimental support for SVG images.
3255
3256   2008-09-17  Add experimental support for x:author.  Fix xref/@
3257      format=none.
3258
3259   2008-10-10  Fix a huge bug, causing text content after an XML comment
3260      to be ignored.
3261
3262   2009-02-24  Use table/caption when needed.
3263
3264   2009-03-07  Fix bug that caused text to disappear in the output in
3265      presence of processing instructions.
3266
3267   2009-03-12  Make inlined comments bookmarkable.
3268
3269   2009-04-09  Upgrade to DC-HTML from RFC 2731 (affects head/@profile).
3270
3271D.6.  rfc2629toFO.xslt
3272
3273   2003-11-16  Initial release.
3274
3275   2003-11-29  Enhance handling of unknown list styles.
3276
3277   2004-04-04  Update reference section handling.
3278
3279   2004-04-17  Use XSL-WD-1.1-style fo:bookmark and index handling and
3280      add postprocessors for existing implementations.  Unify PDF info
3281      generation by using XEP (postprocessors) will convert.
3282
3283   2004-04-20  Add experimental cref support.
3284
3285   2004-06-14  Set correct index-item defaults.
3286
3287   2004-07-18  Add list style=letters.
3288
3289   2004-09-03  Make URLs in text break where they are allowed to break
3290      by inserting zero-width spaces.
3291
3292   2004-09-26  Fix letter-style inside nested lists.
3293
3294   2004-10-31  Update handling of artwork.
3295
3296   2004-11-13  Fix handling of references inside ed:* markup.  Fix
3297      whitespace handling in artwork.
3298
3299
3300
3301
3302
3303Reschke                                                        [Page 59]
3304
3305Documentation             RFC2629 through XSLT                April 2009
3306
3307
3308   2004-11-27  Irefs in artwork generate monospaced entries in index.
3309
3310   2005-01-31  Fix TOC generation that was broken after changes in main
3311      XSLT.
3312
3313   2005-02-05  Bring in sync with cosmetic changes in rfc2629.xslt.
3314
3315   2005-05-07  Minor fix for change tracking in document title.  Support
3316      for table styles.
3317
3318   2005-06-18  Fix references to tables.
3319
3320   2005-10-15  Process t/@anchor.
3321
3322   2006-02-11  References: add "work in progress" for Internet Drafts.
3323
3324   2006-06-02  Use XSL 1.1 WD Feb 2006.
3325
3326   2007-03-21  Support optional text justification.
3327
3328   2007-05-19  Various improvements in spacing; also allow overriding
3329      the automatic list indentation via list/x:indent.
3330
3331   2009-04-08  Fix spacing in headers; add support for formatting for
3332      double-sided printing.
3333
3334D.7.  xsl11toAn.xslt
3335
3336   2004-05-17  Initial release.
3337
3338   2006-06-02  Use XSL 1.1 WD Feb 2006.
3339
3340D.8.  xsl11toFop.xslt
3341
3342   2004-05-17  Initial release.
3343
3344   2006-06-02  Use XSL 1.1 WD Feb 2006.
3345
3346D.9.  xsl11toFop-0.93.xslt
3347
3348   2008-03-15  Add a workaround to the fo:inline workaround (sigh).
3349
3350D.10.  xsl11toXep.xslt
3351
3352
3353
3354
3355
3356
3357
3358
3359Reschke                                                        [Page 60]
3360
3361Documentation             RFC2629 through XSLT                April 2009
3362
3363
3364   2004-05-17  Initial release.
3365
3366   2004-09-04  Fix xep:index-item attributes.
3367
3368   2006-06-02  Use XSL 1.1 WD Feb 2006.
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415Reschke                                                        [Page 61]
3416
3417Documentation             RFC2629 through XSLT                April 2009
3418
3419
3420Index
3421
3422   A
3423      abnf-char-sequence Extension Element  22, 36
3424      allow-markup-in-artwork PI pseudo-attribute  8
3425      alternate HTML LINK element  16
3426      anchor-alias Extension Element  22, 36
3427      Anchors
3428         rfc.abstract  13
3429         rfc.authors  13
3430         rfc.copyright  13
3431         rfc.copyrightnotice  13
3432         rfc.figure.n  13
3433         rfc.figure.u.n  13
3434         rfc.index  13
3435         rfc.ipr  13
3436         rfc.iref.n  13
3437         rfc.note.n  13
3438         rfc.references  13
3439         rfc.section.n  13
3440         rfc.section.n.p.m  13
3441         rfc.status  13
3442         rfc.toc  13
3443         rfc.xref.name.n  13
3444      AntennaHouse XSL Formatter  20
3445      Apache FOP  20
3446      appendix HTML LINK element  16
3447      assign-section-number Extension Element  36
3448      author HTML LINK element  16
3449      authors-section PI pseudo-attribute  8
3450
3451   B
3452      background PI pseudo-attribute  6
3453      bb Extension Element  23, 36
3454      bc Extension Element  23, 36
3455      bcp14 Extension Element  22, 36
3456      blockquote Extension Element  23, 36
3457      boilerplate Extension Element  23, 36
3458      bt Extension Element  24, 36
3459
3460   C
3461      chapter HTML LINK element  16
3462      CHM format  19
3463      comments PI pseudo-attribute  6
3464      compact PI pseudo-attribute  6
3465      contents HTML LINK element  16
3466      copyright HTML LINK element  16
3467      Creator DCMI property  17
3468
3469
3470
3471Reschke                                                        [Page 62]
3472
3473Documentation             RFC2629 through XSLT                April 2009
3474
3475
3476   D
3477      Date.Issued DCMI property  17
3478      DCMI properties
3479         Creator  17
3480         Date.Issued  17
3481         Description.Abstract  17
3482         Identifier  17
3483         Relation.Replaces  17
3484      Description.Abstract DCMI property  17
3485      dfn Extension Element  24, 36
3486      duplex PI pseudo-attribute  8
3487
3488   E
3489      editing PI pseudo-attribute  6
3490      Extension Elements
3491         abnf-char-sequence  22, 36
3492         anchor-alias  22, 36
3493         assign-section-number  36
3494         bb  23, 36
3495         bc  23, 36
3496         bcp14  22, 36
3497         blockquote  23, 36
3498         boilerplate  23, 36
3499         bt  24, 36
3500         dfn  24, 36
3501         h  24, 36
3502         highlight  24, 36
3503         include-author  36
3504         length-of  24, 36
3505         link  24, 36
3506         lt  25, 36
3507         note  25, 36
3508         parse-xml  25, 36
3509         q  25, 36
3510         rdf:Description  36
3511         ref  25, 36
3512         source  26, 36
3513         span  36
3514         sup  26, 36
3515         x  36
3516
3517   F
3518      Firefox
3519         1.*/2.*  14
3520         3.*  14
3521      footer PI pseudo-attribute  6
3522
3523   G
3524
3525
3526
3527Reschke                                                        [Page 63]
3528
3529Documentation             RFC2629 through XSLT                April 2009
3530
3531
3532      generator HTML META element  17
3533      Google Chrome  14
3534      Grammar  36
3535
3536   H
3537      h Extension Element  24, 36
3538      header PI pseudo-attribute  6
3539      highlight Extension Element  24, 36
3540      HTML compliance  16
3541      HTML LINK elements
3542         alternate  16
3543         appendix  16
3544         author  16
3545         chapter  16
3546         contents  16
3547         copyright  16
3548         index  16
3549      HTML META elements
3550         generator  17
3551         keywords  17
3552
3553   I
3554      Identifier DCMI property  17
3555      include PI pseudo-attribute  7
3556      include-author Extension Element  36
3557      include-references-in-index PI pseudo-attribute  8
3558      index HTML LINK element  16
3559      inline PI pseudo-attribute  6
3560      Internet Explorer 5.5  14
3561      Internet Explorer 6  14
3562      Internet Explorer 7  14
3563      Internet Explorer 8  14
3564      iprnotified PI pseudo-attribute  6
3565
3566   J
3567      justification PI pseudo-attribute  8
3568
3569   K
3570      keywords HTML META element  17
3571
3572   L
3573      length-of Extension Element  24, 36
3574      link Extension Element  24, 36
3575      linkmailto PI pseudo-attribute  6
3576      lt Extension Element  25, 36
3577
3578   M
3579      Microsoft Help  19
3580
3581
3582
3583Reschke                                                        [Page 64]
3584
3585Documentation             RFC2629 through XSLT                April 2009
3586
3587
3588      Mozilla  14
3589      MSXML3  14
3590      MSXML4  14
3591
3592   N
3593      needLines PI pseudo-attribute  7
3594      note Extension Element  25, 36
3595
3596   O
3597      Opera  14-15
3598
3599   P
3600      Parameters
3601         xml2rfc-background  6
3602         xml2rfc-comments  6
3603         xml2rfc-compact  6
3604         xml2rfc-editing  6
3605         xml2rfc-ext-allow-markup-in-artwork  8
3606         xml2rfc-ext-authors-section  8
3607         xml2rfc-ext-duplex  8
3608         xml2rfc-ext-include-references-in-index  8
3609         xml2rfc-ext-justification  8
3610         xml2rfc-ext-parse-xml-in-artwork  8
3611         xml2rfc-ext-sec-no-trailing-dots  8
3612         xml2rfc-ext-support-rfc2731  8
3613         xml2rfc-footer  6
3614         xml2rfc-header  6
3615         xml2rfc-inline  6
3616         xml2rfc-iprnotified  6
3617         xml2rfc-linkmailto  6
3618         xml2rfc-private  6
3619         xml2rfc-rfcedstyle  6
3620         xml2rfc-sortrefs  6
3621         xml2rfc-symrefs  6
3622         xml2rfc-toc  6
3623         xml2rfc-tocdepth  6
3624         xml2rfc-topblock  6
3625      parse-xml Extension Element  25, 36
3626      parse-xml-in-artwork PI pseudo-attribute  8
3627      private PI pseudo-attribute  6
3628      Processing Instruction pseudo attributes
3629         allow-markup-in-artwork  8
3630         authors-section  8
3631         background  6
3632         comments  6
3633         compact  6
3634         duplex  8
3635         editing  6
3636
3637
3638
3639Reschke                                                        [Page 65]
3640
3641Documentation             RFC2629 through XSLT                April 2009
3642
3643
3644         footer  6
3645         header  6
3646         ijustification  8
3647         include  7
3648         include-references-in-index  8
3649         inline  6
3650         iprnotified  6
3651         linkmailto  6
3652         needLines  7
3653         parse-xml-in-artwork  8
3654         private  6
3655         rfcedstyle  6
3656         sec-no-trailing-dots  8
3657         slides  7
3658         sortrefs  6
3659         strict  7
3660         subcompact  7
3661         support-rfc2731  8
3662         symrefs  6
3663         toc  6
3664         tocdepth  6
3665         tocindent  7
3666         tocompact  7
3667         topblock  6
3668
3669   Q
3670      q Extension Element  25, 36
3671
3672   R
3673      rdf:Description Extension Element  36
3674      ref Extension Element  25, 36
3675      Relation.Replaces DCMI property  17
3676      RELAX NG Compact Schema  36
3677      rfc.abstract anchor  13
3678      rfc.authors anchor  13
3679      rfc.copyright anchor  13
3680      rfc.copyrightnotice anchor  13
3681      rfc.figure.n anchor  13
3682      rfc.figure.u.n anchor  13
3683      rfc.index anchor  13
3684      rfc.ipr anchor  13
3685      rfc.iref.n anchor  13
3686      rfc.note.n anchor  13
3687      rfc.references anchor  13
3688      rfc.references.n anchor  13
3689      rfc.section.n anchor  13
3690      rfc.section.n.p.m anchor  13
3691      rfc.status anchor  13
3692
3693
3694
3695Reschke                                                        [Page 66]
3696
3697Documentation             RFC2629 through XSLT                April 2009
3698
3699
3700      rfc.toc anchor  13
3701      rfc.xref.name.n anchor  13
3702      rfcedstyle PI pseudo-attribute  6
3703
3704   S
3705      Safari  14-15
3706         3.*  14
3707      Saxon  14
3708      Schema  36
3709      sec-no-trailing-dots PI pseudo-attribute  8
3710      slides PI pseudo-attribute  7
3711      sortrefs PI pseudo-attribute  6
3712      source Extension Element  26, 36
3713      span Extension Element  36
3714      strict PI pseudo-attribute  7
3715      subcompact PI pseudo-attribute  7
3716      sup Extension Element  26, 36
3717      support-rfc2731 PI pseudo-attribute  8
3718      symrefs PI pseudo-attribute  6
3719
3720   T
3721      toc PI pseudo-attribute  6
3722      tocdepth PI pseudo-attribute  6
3723      tocindent PI pseudo-attribute  7
3724      tocompact PI pseudo-attribute  7
3725      topblock PI pseudo-attribute  6
3726
3727   X
3728      x Extension Element  36
3729      Xalan  14
3730      xml-stylesheet PI  16
3731      xml2rfc-background parameter  6
3732      xml2rfc-comments parameter  6
3733      xml2rfc-editing parameter  6
3734      xml2rfc-ext-allow-markup-in-artwork parameter  8
3735      xml2rfc-ext-authors-section parameter  8
3736      xml2rfc-ext-duplex  8
3737      xml2rfc-ext-include-references-in-index parameter  8
3738      xml2rfc-ext-justification parameter  8
3739      xml2rfc-ext-parse-xml-in-artwork parameter  8
3740      xml2rfc-ext-sec-no-trailing-dots parameter  8
3741      xml2rfc-ext-support-rfc2731 parameter  8
3742      xml2rfc-footer parameter  6
3743      xml2rfc-header parameter  6
3744      xml2rfc-inline parameter  6
3745      xml2rfc-iprnotified parameter  6
3746      xml2rfc-linkmailto parameter  6
3747      xml2rfc-private parameter  6
3748
3749
3750
3751Reschke                                                        [Page 67]
3752
3753Documentation             RFC2629 through XSLT                April 2009
3754
3755
3756      xml2rfc-rfcedstyle parameter  6
3757      xml2rfc-sortrefs parameter  6
3758      xml2rfc-symrefs parameter  6
3759      xml2rfc-toc parameter  6
3760      xml2rfc-tocdepth parameter  6
3761      xml2rfc-topblock parameter  6
3762      xsltproc  14
3763         passing parameters  5
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807Reschke                                                        [Page 68]
3808
3809Documentation             RFC2629 through XSLT                April 2009
3810
3811
3812Author's Address
3813
3814   Julian F. Reschke
3815   greenbytes GmbH
3816   Hafenweg 16
3817   Muenster, NW  48155
3818   Germany
3819
3820   Phone: +49 251 2807760
3821   Email: julian.reschke@greenbytes.de
3822   URI:   http://greenbytes.de/tech/webdav/
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863Reschke                                                        [Page 69]
3864
Note: See TracBrowser for help on using the repository browser.