forked from jcgregorio/uri-templates
-
Notifications
You must be signed in to change notification settings - Fork 2
/
rfc2629-README.html
1529 lines (1411 loc) · 63.6 KB
/
rfc2629-README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
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
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en"><head><title>The README file: xml2rfc v1.36pre1</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="xml2rfc v1.36pre1">
<style type='text/css'><!--
body {
font-family: verdana, charcoal, helvetica, arial, sans-serif;
font-size: small; color: #000; background-color: #FFF;
margin: 2em;
}
h1, h2, h3, h4, h5, h6 {
font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
font-weight: bold; font-style: normal;
}
h1 { color: #900; background-color: transparent; text-align: right; }
h3 { color: #333; background-color: transparent; }
td.RFCbug {
font-size: x-small; text-decoration: none;
width: 30px; height: 30px; padding-top: 2px;
text-align: justify; vertical-align: middle;
background-color: #000;
}
td.RFCbug span.RFC {
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
font-weight: bold; color: #666;
}
td.RFCbug span.hotText {
font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
font-weight: normal; text-align: center; color: #FFF;
}
table.TOCbug { width: 30px; height: 15px; }
td.TOCbug {
text-align: center; width: 30px; height: 15px;
color: #FFF; background-color: #900;
}
td.TOCbug a {
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
font-weight: bold; font-size: x-small; text-decoration: none;
color: #FFF; background-color: transparent;
}
td.header {
font-family: arial, helvetica, sans-serif; font-size: x-small;
vertical-align: top; width: 33%;
color: #FFF; background-color: #666;
}
td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
td.author-text { font-size: x-small; }
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
a.info {
/* This is the key. */
position: relative;
z-index: 24;
text-decoration: none;
}
a.info:hover {
z-index: 25;
color: #FFF; background-color: #900;
}
a.info span { display: none; }
a.info:hover span.info {
/* The span will display just on :hover state. */
display: block;
position: absolute;
font-size: smaller;
top: 2em; left: -5em; width: 15em;
padding: 2px; border: 1px solid #333;
color: #900; background-color: #EEE;
text-align: left;
}
a { font-weight: bold; }
a:link { color: #900; background-color: transparent; }
a:visited { color: #633; background-color: transparent; }
a:active { color: #633; background-color: transparent; }
p { margin-left: 2em; margin-right: 2em; }
p.copyright { font-size: x-small; }
p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
ol.text { margin-left: 2em; margin-right: 2em; }
ul.text { margin-left: 2em; margin-right: 2em; }
li { margin-left: 3em; }
/* RFC-2629 <spanx>s and <artwork>s. */
em { font-style: italic; }
strong { font-weight: bold; }
dfn { font-weight: bold; font-style: normal; }
cite { font-weight: normal; font-style: normal; }
tt { color: #036; }
tt, pre, pre dfn, pre em, pre cite, pre span {
font-family: "Courier New", Courier, monospace; font-size: small;
}
pre {
text-align: left; padding: 4px;
color: #000; background-color: #CCC;
}
pre dfn { color: #900; }
pre em { color: #66F; background-color: #FFC; font-weight: normal; }
pre .key { color: #33C; font-weight: bold; }
pre .id { color: #900; }
pre .str { color: #000; background-color: #CFF; }
pre .val { color: #066; }
pre .rep { color: #909; }
pre .oth { color: #000; background-color: #FCF; }
pre .err { background-color: #FCC; }
/* RFC-2629 <texttable>s. */
table.all, table.full, table.headers, table.none {
font-size: small; text-align: center; border-width: 2px;
vertical-align: top; border-collapse: collapse;
}
table.all, table.full { border-style: solid; border-color: black; }
table.headers, table.none { border-style: none; }
th {
font-weight: bold; border-color: black;
border-width: 2px 2px 3px 2px;
}
table.all th, table.full th { border-style: solid; }
table.headers th { border-style: none none solid none; }
table.none th { border-style: none; }
table.all td {
border-style: solid; border-color: #333;
border-width: 1px 2px;
}
table.full td, table.headers td, table.none td { border-style: none; }
hr { height: 1px; }
hr.insert {
width: 80%; border-style: none; border-width: 0;
color: #CCC; background-color: #CCC;
}
--></style>
</head>
<body>
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
<tr><td class="header">The README file</td><td class="header">M. Rose</td></tr>
<tr><td class="header"> </td><td class="header">Dover Beach Consulting, Inc.</td></tr>
<tr><td class="header"> </td><td class="header">B. Fenner</td></tr>
<tr><td class="header"> </td><td class="header">Arista Networks, Inc.</td></tr>
<tr><td class="header"> </td><td class="header">C. Levert</td></tr>
<tr><td class="header"> </td><td class="header"> </td></tr>
<tr><td class="header"> </td><td class="header">T. Hansen</td></tr>
<tr><td class="header"> </td><td class="header">AT&T Labs</td></tr>
<tr><td class="header"> </td><td class="header">J. Reschke</td></tr>
<tr><td class="header"> </td><td class="header">greenbytes</td></tr>
<tr><td class="header"> </td><td class="header">January 2011</td></tr>
</table></td></tr></table>
<h1><br />xml2rfc v1.36pre1</h1>
<a name="toc"></a><br /><hr />
<h1>Table of Contents</h1>
<p class="toc">
<a href="#anchor1">1.</a>
Introduction<br />
<a href="#anchor2">2.</a>
Requirements<br />
<a href="#anchor3">3.</a>
Testing<br />
<a href="#anchor4">3.1.</a>
Testing under a windowing system<br />
<a href="#anchor5">3.2.</a>
Testing without a windowing system<br />
<a href="#anchor6">4.</a>
Next steps<br />
<a href="#processing.instructions">4.1.</a>
Processing Instructions<br />
<a href="#anchor7">4.1.1.</a>
Option Settings<br />
<a href="#include.file.facility">4.1.2.</a>
Include Files<br />
<a href="#anchor8">5.</a>
The Page Model<br />
<a href="#anchor9">6.</a>
Additions to RFC 2629<br />
<a href="#anchor10">6.1.</a>
Extra Attributes<br />
<a href="#anchor11">6.2.</a>
Typed-Artwork Interpretation<br />
<a href="#anchor12">7.</a>
Limitations of xml2rfc<br />
<a href="#rfc.references1">8.</a>
References<br />
<a href="#boilerplate">A.</a>
Producing the IETF 'Boilerplate'<br />
<a href="#attribute-ipr">A.1.</a>
The /rfc/@ipr Attribute<br />
<a href="#attribute-ipr-current">A.1.1.</a>
Current Values: '*trust200902'<br />
<a href="#attribute-ipr-historic">A.1.2.</a>
Historic Values<br />
<a href="#attribute-category">A.2.</a>
The /rfc/@category Attribute<br />
<a href="#attribute-submissiontype">A.3.</a>
The /rfc/@submissionType Attribute<br />
<a href="#attribute-consensus">A.4.</a>
The /rfc/@consensus Attribute<br />
<a href="#attribute-number">A.5.</a>
The /rfc/@number Attribute<br />
<a href="#attribute-docname">A.6.</a>
The /rfc/@docName Attribute<br />
<a href="#attribute-obsoletes">A.7.</a>
The /rfc/@obsoletes Attribute<br />
<a href="#attribute-updates">A.8.</a>
The /rfc/@updates Attribute<br />
<a href="#anchor14">B.</a>
MacOS 9 Installation (courtesy of Ned Freed)<br />
<a href="#rfc2629.xslt">C.</a>
rfc2629.xslt (courtesy of Julian Reschke)<br />
<a href="#cygwin">D.</a>
MS-Windows/Cygwin Installation (courtesy of Joe Touch)<br />
<a href="#anchor15">E.</a>
A Special Thanks<br />
<a href="#anchor16">F.</a>
Copyrights<br />
<a href="#rfc.index">§</a>
Index<br />
<a href="#rfc.authors">§</a>
Authors' Addresses<br />
</p>
<br clear="all" />
<a name="anchor1"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.1"></a><h1>1.
Introduction</h1>
<p>This is a package to convert memos written in XML to the RFC format.
</p>
<p>If you don't want to install any software,
you can use the
<a href='http://xml.resource.org/'>web-based service</a>.
</p>
<a name="anchor2"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.2"></a><h1>2.
Requirements</h1>
<p>You need to have Tcl/Tk version 8 running on your system.
Tcl is a scripting language,
Tk is Tcl with support for your windowing system.
</p>
<p>To get a source or binary distribution for your system,
go to the
<a href='http://www.tcl.tk/software/tcltk/8.4.html'>Tcl Developer Xchange website</a>
and install it.
If you get the binary distribution,
this is pretty simple.
</p>
<p>Of course,
you may already have Tcl version 8.
To find out,
try typing this command from the shell
(or the “MS-DOS Prompt”):
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
% tclsh
</pre></div>
<p>If the program launches,
you're good to go with Tcl version 8.
</p>
<p>If you are running under a windowing system (e.g., X or MS-Windows),
you can also try:
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
% wish
</pre></div>
<p>If a new window comes up along with a “Console” window,
then you're good to go with Tk version 8.
</p>
<p>Finally,
you may notice a file called <tt>xml2sgml.tcl</tt>
in the distribution.
It contains some extra functionality for a few special users —
so, if you don't know what it is, don't worry about it...
</p>
<a name="anchor3"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3"></a><h1>3.
Testing</h1>
<p>Now test your installation.
</p>
<a name="anchor4"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3.1"></a><h2>3.1.
Testing under a windowing system</h2>
<p>Type this command from the shell:
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
% xml2rfc.tcl
</pre></div>
<p>A new window should come up that looks like this:
</p><div style='text-align: center'><img src="xml2rfc-win.png" width="486" alt="[“Convert XML to RFC” window]" height="174" /></div>
</div>
<p>Fill-in the blanks and click on [Convert].
</p>
<a name="anchor5"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3.2"></a><h2>3.2.
Testing without a windowing system</h2>
<p>Type this command from the shell:
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
% tclsh
</pre></div>
<p>If the program launches, type this command to it:
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
% source xml2rfc.tcl
</pre></div>
<p>and you should see these five lines:
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
invoke as "xml2rfc input-file output-file"
or "xml2txt input-file"
or "xml2html input-file"
or "xml2nroff input-file"
or "xml2unpg input-file"
</pre></div>
<a name="anchor6"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.4"></a><h1>4.
Next steps</h1>
<p>Read the <a href='draft-mrose-writing-rfcs.html'>2629bis</a>
document.
In particular,
<a href='draft-mrose-writing-rfcs.html#anchor13'>Section 3</a>
has some good information.
</p>
<a name="processing.instructions"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.4.1"></a><h2>4.1.
Processing Instructions</h2>
<p>A <em>processing instruction</em> contains
directives to an XML application.
If you want to give directives to <strong>xml2rfc</strong>,
the processing instructions (PIs) look like this:
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
<?rfc keyword='value'?>
</pre></div>
<p>Of course,
if you like the default behavior,
you don't need any behavior-modifying directives in your input file!
Although <strong>xml2rfc</strong>
supports putting several attribute-like directives in one PI,
be warned that there are issues in
doing this for a non-include-file directive following an
<a class='info' href='#include.file.facility'>include-file directive<span> (</span><span class='info'>Include Files</span><span>)</span></a>.
It is good practice to always surround the value with either
single or double quotes.
</p>
<a name="anchor7"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.4.1.1"></a><h3>4.1.1.
Option Settings</h3>
<p style='text-align: left'>The list of valid keywords are:
</p><table class="full" align="left" border="0" cellpadding="2" cellspacing="2">
<col align="right"><col align="center"><col align="left">
<tr><th align="right">keyword</th><th align="center">default</th><th align="left">meaning</th></tr>
<tr>
<td align="right">artworkdelimiter</td>
<td align="center">""</td>
<td align="left">when producing txt or nroff files, use this string to delimit artwork</td>
</tr>
<tr>
<td align="right">artworklines</td>
<td align="center">0</td>
<td align="left">when producing txt or nroff files, add this many blank lines around artwork</td>
</tr>
<tr>
<td align="right">authorship</td>
<td align="center">yes</td>
<td align="left">render author information</td>
</tr>
<tr>
<td align="right">autobreaks</td>
<td align="center">yes</td>
<td align="left">automatically force page breaks to avoid widows and orphans (not perfect)</td>
</tr>
<tr>
<td align="right">background</td>
<td align="center">""</td>
<td align="left">when producing a html file, use this image</td>
</tr>
<tr>
<td align="right">colonspace</td>
<td align="center">no</td>
<td align="left">put two spaces instead of one after each colon (“:”) in txt or nroff files</td>
</tr>
<tr>
<td align="right">comments</td>
<td align="center">no</td>
<td align="left">render <cref> information</td>
</tr>
<tr>
<td align="right">compact</td>
<td align="center">(rfcedstyle)</td>
<td align="left">when producing a txt/nroff file, try to conserve vertical whitespace
(the default value is the current value of the rfcedstyle PI)</td>
</tr>
<tr>
<td align="right">docmapping</td>
<td align="center">no</td>
<td align="left">use hierarchical tags (e.g., <h1>, <h2>, etc.)
for (sub)section titles</td>
</tr>
<tr>
<td align="right">editing</td>
<td align="center">no</td>
<td align="left">insert editing marks for ease of discussing draft versions</td>
</tr>
<tr>
<td align="right">emoticonic</td>
<td align="center">no</td>
<td align="left">automatically replaces input sequences such as
<tt>|*text|</tt> by, e.g.,
<tt><strong>text</strong></tt>
in html output</td>
</tr>
<tr>
<td align="right">footer</td>
<td align="center">""</td>
<td align="left">override the center footer string</td>
</tr>
<tr>
<td align="right">header</td>
<td align="center">""</td>
<td align="left">override the leftmost header string</td>
</tr>
<tr>
<td align="right">include</td>
<td align="center">n/a</td>
<td align="left">see <a class='info' href='#include.file.facility'>Section 4.1.2<span> (</span><span class='info'>Include Files</span><span>)</span></a></td>
</tr>
<tr>
<td align="right">inline</td>
<td align="center">no</td>
<td align="left">if comments is "yes",
then render comments inline;
otherwise render them in an “Editorial Comments” section</td>
</tr>
<tr>
<td align="right">iprnotified</td>
<td align="center">no</td>
<td align="left">include boilerplate from Section 10.4(d) of <a class='info' href='#RFC2026'>[1]<span> (</span><span class='info'>Bradner, S., “The Internet Standards Process -- Revision 3,” October 1996.</span><span>)</span></a></td>
</tr>
<tr>
<td align="right">linkmailto</td>
<td align="center">yes</td>
<td align="left">generate mailto: URL, as appropriate</td>
</tr>
<tr>
<td align="right">linefile</td>
<td align="center">n/a</td>
<td align="left">a string like "35:file.xml" or just "35"
(file name then defaults to the containing file's real name
or to the latest linefile specification that changed it)
that will be used to override <strong>xml2rfc</strong>'s
reckoning of the current input position (right after this PI)
for warning and error reporting purposes (line numbers are 1-based)</td>
</tr>
<tr>
<td align="right">needLines</td>
<td align="center">n/a</td>
<td align="left">an integer hint indicating how many contiguous lines are needed at this point in the output</td>
</tr>
<tr>
<td align="right">notedraftinprogress</td>
<td align="center">yes</td>
<td align="left">generates "(work in progress)", as appropriate</td>
</tr>
<tr>
<td align="right">private</td>
<td align="center">""</td>
<td align="left">produce a private memo rather than an RFC or Internet-Draft</td>
</tr>
<tr>
<td align="right">refparent</td>
<td align="center">"References"</td>
<td align="left">title of the top-level section containing all references</td>
</tr>
<tr>
<td align="right">rfcedstyle</td>
<td align="center">no</td>
<td align="left">attempt to closely follow finer details
from the latest observable RFC-Editor style
so as to minimize the probability of
being sent back corrections after submission;
this directive is a kludge whose exact behavior
is likely to change on a regular basis
to match the current flavor of the month;
presently,
it will capitalize the adjective “This”
in automatically generated headings,
use the variant “acknowledgement” spelling instead of
Merriam Webster's main “acknowledgment” dictionary entry,
use the “eMail” spelling instead of
Knuth's more modern “email” spelling,
only put one blank line instead of two before top sections,
omit “Intellectual Property and Copyright Statements”
and “Author's Address” from the table of content,
and not limit the indentation to a maximum tag length
in <references> sections.
</td>
</tr>
<tr>
<td align="right">rfcprocack</td>
<td align="center">no</td>
<td align="left">if there already is an automatically generated Acknowledg(e)ment section,
pluralize its title and add a short sentence acknowledging that
<strong>xml2rfc</strong> was used in the document's production
to process an input XML source file in RFC-2629 format</td>
</tr>
<tr>
<td align="right">slides</td>
<td align="center">no</td>
<td align="left">when producing a html file, produce multiple files for a slide show</td>
</tr>
<tr>
<td align="right">sortrefs</td>
<td align="center">no</td>
<td align="left">sort references</td>
</tr>
<tr>
<td align="right">strict</td>
<td align="center">no</td>
<td align="left">try to enforce the ID-nits conventions and DTD validity</td>
</tr>
<tr>
<td align="right">subcompact</td>
<td align="center">(compact)</td>
<td align="left">if compact is "yes",
then you can make things a little less compact by setting this to "no"
(the default value is the current value of the compact PI)</td>
</tr>
<tr>
<td align="right">symrefs</td>
<td align="center">yes</td>
<td align="left">use anchors rather than numbers for references</td>
</tr>
<tr>
<td align="right">text-list-sybols</td>
<td align="center">o*+-</td>
<td align="left">modify the list of symbols used (when generated text) for list type="symbols".
For example, specifying "abcde" will cause "a" to be used for 1st level, "b" for the 2nd level, etc, cycling back to the first character "a" at the 6th level.
Specifying "o*" will cause the characters "o" and "*" to be alternated for each successive level.
</td>
</tr>
<tr>
<td align="right">toc</td>
<td align="center">no</td>
<td align="left">generate a table-of-contents</td>
</tr>
<tr>
<td align="right">tocappendix</td>
<td align="center">yes</td>
<td align="left">control whether the word “Appendix” appears in the table-of-content</td>
</tr>
<tr>
<td align="right">tocdepth</td>
<td align="center">3</td>
<td align="left">if toc is "yes", then this determines the depth of the table-of-contents</td>
</tr>
<tr>
<td align="right">tocindent</td>
<td align="center">yes</td>
<td align="left">if toc is "yes", then setting this to "yes" will indent subsections
in the table-of-contents</td>
</tr>
<tr>
<td align="right">tocnarrow</td>
<td align="center">yes</td>
<td align="left">affects horizontal spacing in the table-of-content</td>
</tr>
<tr>
<td align="right">tocompact</td>
<td align="center">yes</td>
<td align="left">if toc is "yes", then setting this to "no" will make it a little less compact</td>
</tr>
<tr>
<td align="right">topblock</td>
<td align="center">yes</td>
<td align="left">put the famous header block on the first page</td>
</tr>
<tr>
<td align="right">typeout</td>
<td align="center">n/a</td>
<td align="left">during processing pass 2, print the value to standard output
at that point in processing</td>
</tr>
<tr>
<td align="right">useobject</td>
<td align="center">no</td>
<td align="left">when producing a html file,
use the <tt><object></tt> html element with inner replacement content
instead of the <tt><img></tt> html element,
when a source xml element includes an <tt>src</tt> attribute</td>
</tr>
</table>
<br clear="all" />
<p style='text-align: left'>Remember that,
as with everything else in XML,
keywords and values are case-sensitive.
</p>
<p>With the exception of the <tt>needLines</tt>,
<tt>typeout</tt>, and
<tt>include</tt> directives,
you normally put all of these processing instructions at the beginning
of the document
(right after the XML declaration).
</p>
<a name="include.file.facility"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.4.1.2"></a><h3>4.1.2.
Include Files</h3>
<p><strong>xml2rfc</strong> has an include-file facility,
e.g.,
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
<?rfc include='file'?>
</pre></div>
<p><strong>xml2rfc</strong> will consult the
<tt>XML_LIBRARY</tt> environment variable for a
search path of where to look for files.
(If this environment variable isn't set,
the directory containing the file that contains the include-file
directive is used.)
The file's contents are inserted right after the PI.
Putting non-include-file directives (especially needLines ones)
after an include-file one in the same PI
may not work as expected because of this.
Remember that file names are generally case-sensitive and that
an input file that is distributed to the outside world may be
processed on a different operating system than that used by
its author.
</p>
<p>You can also have <strong>xml2rfc</strong> set
the <tt>XML_LIBRARY</tt> environment variable directly,
by creating a file called <tt>.xml2rfc.rc</tt> in
the directory where your
main file is,
e.g.,
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
global env tcl_platform
if {![string compare $tcl_platform(platform) windows]} {
set sep ";"
} else {
set sep ":"
}
if {[catch { set env(XML_LIBRARY) } library]} {
set library ""
foreach bibxmlD [lsort -dictionary \
[glob -nocomplain $HOME/rfcs/bibxml/*]] {
append library $sep$bibxmlD
}
}
set nativeD [file nativename $inputD]
if {[lsearch [split $library $sep] $nativeD] < 0} {
set library "$nativeD$sep$library"
}
set env(XML_LIBRARY) $library
</pre></div>
<p>There are links to various bibliographic databases (RFCs, I-Ds, and so on)
on the <strong>xml2rfc</strong>
<a href='http://xml.resource.org/'>homepage</a>.
</p>
<a name="anchor8"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.5"></a><h1>5.
The Page Model</h1>
<p>The <strong>html</strong>
rendering engine does not need to
have a tightly defined page model.
</p>
<p>The <strong>txt</strong> and
<strong>nr</strong> rendering engines
assume the following page model.
</p>
<p>Each line has at most 72 columns from the left edge,
including any left margin, but excluding the line terminator.
Every output character is from the ASCII repertoire
and the only control character used is the line-feed (LF);
the character-tabulation (HT) character is never used.
</p>
<p>Each page has the following lines
(in 1-based numbering, as reported to the user, but contrary to
<strong>xml2rfc</strong>'s
internal 0-based numbering):</p>
<blockquote class="text">
<p> 1: header line (blank line on first page)
</p>
<p> 2: blank line
</p>
<p> 3: blank line
</p>
<p> 4: 1st line of content
</p>
<p>...
</p>
<p>51: 48th line of content
</p>
<p>52: blank line
</p>
<p>53: blank line
</p>
<p>54: blank line
</p>
<p>55: footer line
</p>
<p>56: form-feed character (followed by line terminator)
</p>
</blockquote><p>
Once processed through <strong>nroff</strong>
and the <tt>fix.sh</tt> script (from
<a href='ftp://ftp.rfc-editor.org/in-notes/rfc-editor/2-nroff.template'>2-nroff.template</a>), the <strong>nr</strong>
output differs from this in two ways.
It has three extra blank lines
(that could be numbered -2, -1, and 0, for a total of six)
at the very beginning of the document
(so the first page is that much longer).
It also has no line terminator following the
very last form-feed character of the file.
These differences originate in the design of
the <tt>fix.sh</tt> script.
</p>
<p>Header and footer lines each have three parts:
left, center, and right.
</p>
<a name="anchor9"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.6"></a><h1>6.
Additions to RFC 2629</h1>
<p>A few additions have been made to the format originally defined in
RFC 2629.
In particular,
<a href='draft-mrose-writing-rfcs.html#anchor19'>Appendix C</a>
of the 2629bis document enumerates the additions.
</p>
<a name="anchor10"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.6.1"></a><h2>6.1.
Extra Attributes</h2>
<p>In addition,
<strong>xml2rfc</strong> recognizes the undocumented
<tt>src</tt>,
<tt>alt</tt>,
<tt>width</tt>, and
<tt>height</tt> attributes in the
<tt>figure</tt> and
<tt>artwork</tt> elements,
but only if HTML is being generated.
Here are two examples, one for each case.
</p>
<p>Here, the attributes are added to the
<tt>artwork</tt> element.
</p><div style='display: table; width: 0; margin-left: auto; margin-right: auto'><pre>
<figure>
<preamble>This is the preamble.</preamble>
<artwork src='layers.png'
alt='[picture of layers only]'>
.-----------.
| ASCII art |
`-----------'
</artwork>
<postamble>This is the postamble.</postamble>
</figure>
</pre></div>
<p>In this case, the
<tt>preamble</tt> and
<tt>postamble</tt> elements are kept and
an <tt>img</tt> tag is placed in the HTML output
to replace the whole <tt>artwork</tt> element
and its textual drawing, which are ignored.
</p>
<p>Here, the attributes are added to the
<tt>figure</tt> element.
</p><div style='display: table; width: 0; margin-left: auto; margin-right: auto'><pre>
<figure src='layers.png'
alt='[picture of layers and explanation]'>
<preamble>This is the preamble.</preamble>
<artwork>
.-----------.
| ASCII art |
`-----------'
</artwork>
<postamble>This is the postamble.</postamble>
</figure>
</pre></div>
<p>In this case,
an <tt>img</tt> tag is placed in the HTML output
to replace the whole contents of the
<tt>figure</tt> element
(the <tt>preamble</tt>,
<tt>artwork</tt>, and
<tt>postamble</tt> inner elements
and the textual drawing itself)
which are ignored.
</p>
<p><strong>xml2rfc</strong> also recognizes
an undocumented <tt>align</tt> attribute
(with possible values
<tt>left</tt>,
<tt>center</tt>, or
<tt>right</tt>)
in the
<tt>figure</tt> and
<tt>artwork</tt> elements.
It affects the whole content of the targeted element
for all types of generated output.
Its default is inherited from the parent of its element.
</p>
<a name="anchor11"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.6.2"></a><h2>6.2.
Typed-Artwork Interpretation</h2>
<p>The <tt>artwork</tt> element from RFC 2629
supports an optional <tt>type</tt> attribute.
While most possible values are just ignored,
including the special case
where the attribute is unspecified or just empty,
some values are recognized.
In particular, <tt>type='abnf'</tt>
can be used if the <tt>artwork</tt>
contains an Augmented Backus-Naur Form (ABNF)
syntax specification <a class='info' href='#RFC4234'>[3]<span> (</span><span class='info'>Crocker, D. and P. Overell, “Augmented BNF for Syntax Specifications: ABNF,” October 2005.</span><span>)</span></a>.
As a special extension in its <em>behavior</em>,
<strong>xml2rfc</strong> will attempt
to validate the syntax and colorize the HTML output of ABNF,
since it is so widely used in RFCs.
It does this colorizing by relying
on the full parsing it does right before,
not on a quick and partial (e.g., line-by-line) pattern-based hack.
ABNF is the only artwork type to benefit
from this kind of internal support at this time.
If the <tt>strict</tt> rfc-PI directive is activated,
invalid ABNF content will cause <strong>xml2rfc</strong>
to abort with an error message.
Omitting the <tt>type</tt> attribute altogether
is the obvious way to avoid having
this validation and colorizing performed.
</p>
<p style='text-align: left'>For example (to be viewed in HTML):
</p><div style='display: table; width: 0; margin-left: auto; margin-right: auto'><pre>
<dfn>char-val</dfn> = <cite class='key'>DQUOTE</cite> <span class='rep'>*</span>(<span class='val'>%x20-21</span> / <span class='val'>%x23-7E</span>) <cite class='key'>DQUOTE</cite>
<em>; quoted string of SP and VCHAR</em>
<cite class='id'>without</cite> <cite class='key'>DQUOTE</cite>
<dfn>num-val</dfn> = "<span class='str'>%</span>" (<cite class='id'>bin-val</cite> / <cite class='id'>dec-val</cite> / <cite class='id'>hex-val</cite>)
<dfn>bin-val</dfn> = "<span class='str'>b</span>" <span class='rep'>1*</span><cite class='key'>BIT</cite>
[ <span class='rep'>1*</span>("<span class='str'>.</span>" <span class='rep'>1*</span><cite class='key'>BIT</cite>) / ("<span class='str'>-</span>" <span class='rep'>1*</span><cite class='key'>BIT</cite>) ]
<em>; series of concatenated bit values</em>
<em>; or single ONEOF range</em>
<dfn>dec-val</dfn> = "<span class='str'>d</span>" <span class='rep'>1*</span><cite class='key'>DIGIT</cite>
[ <span class='rep'>1*</span>("<span class='str'>.</span>" <span class='rep'>1*</span><cite class='key'>DIGIT</cite>) / ("<span class='str'>-</span>" <span class='rep'>1*</span><cite class='key'>DIGIT</cite>) ]
<dfn>hex-val</dfn> = "<span class='str'>x</span>" <span class='rep'>1*</span><cite class='key'>HEXDIG</cite>
[ <span class='rep'>1*</span>("<span class='str'>.</span>" <span class='rep'>1*</span><cite class='key'>HEXDIG</cite>) / ("<span class='str'>-</span>" <span class='rep'>1*</span><cite class='key'>HEXDIG</cite>) ]
<dfn>prose-val</dfn> = "<span class='str'><</span>" <span class='rep'>*</span>(<span class='val'>%x20-3D</span> / <span class='val'>%x3F-7E</span>) "<span class='str'>></span>"
<em>; bracketed string of SP and VCHAR</em>
<cite class='id'>without</cite> <cite class='id'>angles</cite>
<em>; prose description, to be used as</em>
<cite class='id'>last</cite> <cite class='id'>resort</cite>
</pre></div>
<p style='text-align: left'>This is from the
original RFC on ABNF <a class='info' href='#RFC2234'>[2]<span> (</span><span class='info'>Crocker, D., Ed. and P. Overell, “Augmented BNF for Syntax Specifications: ABNF,” November 1997.</span><span>)</span></a>,
with its minor mistakes in manually folded comment lines
purposely left intact, for illustration.
Since the result is still valid ABNF
(but incorrect with respect to what was intended),
this showcases how colorizing might give a human author
(or editor or reader)
a better chance to spot the three mistakes
(and correct them, e.g., with extra semicolons,
as has been done in
a more recent version <a class='info' href='#RFC4234'>[3]<span> (</span><span class='info'>Crocker, D. and P. Overell, “Augmented BNF for Syntax Specifications: ABNF,” October 2005.</span><span>)</span></a>
of the ABNF specification).
Note that it is the white space characters
at the beginning of the subsequent lines
(including the commented ones)
that conspire to extend the reach of those rules
across several lines.
</p>
<a name="anchor12"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.7"></a><h1>7.
Limitations of xml2rfc</h1>
<p></p>
<ul class="text">
<li>The <tt>figure</tt> element's <tt>title</tt> attribute is ignored,
except when generating HTML.
</li>
<li>The <tt>xref</tt> element's
<tt>pageno</tt> attribute is ignored.
</li>
</ul>
<a name="rfc.references1"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<h1>8. References</h1>
<table width="99%" border="0">
<tr><td class="author-text" valign="top"><a name="RFC2026">[1]</a></td>
<td class="author-text"><a href="mailto:[email protected]">Bradner, S.</a>, “<a href="http://tools.ietf.org/html/rfc2026">The Internet Standards Process -- Revision 3</a>,” BCP 9, RFC 2026, October 1996 (<a href="ftp://ftp.isi.edu/in-notes/rfc2026.txt">TXT</a>).</td></tr>
<tr><td class="author-text" valign="top"><a name="RFC2234">[2]</a></td>
<td class="author-text"><a href="mailto:[email protected]">Crocker, D., Ed.</a> and <a href="mailto:[email protected]">P. Overell</a>, “<a href="http://tools.ietf.org/html/rfc2234">Augmented BNF for Syntax Specifications: ABNF</a>,” RFC 2234, November 1997 (<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">TXT</a>, <a href="http://xml.resource.org/public/rfc/html/rfc2234.html">HTML</a>, <a href="http://xml.resource.org/public/rfc/xml/rfc2234.xml">XML</a>).</td></tr>
<tr><td class="author-text" valign="top"><a name="RFC4234">[3]</a></td>
<td class="author-text">Crocker, D. and P. Overell, “<a href="http://tools.ietf.org/html/rfc4234">Augmented BNF for Syntax Specifications: ABNF</a>,” RFC 4234, October 2005 (<a href="ftp://ftp.isi.edu/in-notes/rfc4234.txt">TXT</a>).</td></tr>
<tr><td class="author-text" valign="top"><a name="RFC5741">[4]</a></td>
<td class="author-text">Daigle, L. and O. Kolkman, “<a href="http://tools.ietf.org/html/rfc5741">RFC Streams, Headers, and Boilerplates</a>,” RFC 5741, December 2009.</td></tr>
</table>
<a name="boilerplate"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.A"></a><h1>Appendix A.
Producing the IETF 'Boilerplate'</h1>
<p>
This section was borrowed from <a href='http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#boilerplate'>http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#boilerplate</a>.
</p>
<p>
Various attributes of the <tt><rfc></tt>
element plus some child elements of <tt><front></tt>
affect the automatically generated parts of the front page, such as the
tabular information at the beginning, the "Status Of This Memo", and the
"Copyright Notice".
</p>
<p>
When submitting an Internet Draft, this "boilerplate" is checked
by "Idnits" (<a href='http://tools.ietf.org/tools/idnits/'>http://tools.ietf.org/tools/idnits/</a>) for
compliance with the current Intellectual Property rules, and thus
it is important to set the correct values.
</p>
<p>
Furthermore, the RFC Production Center uses RFC2629-based tools to
generate the final RFC text, so the more accurate the supplied information
is, the less additional work is left, and the risk for errors in producing
the final (and immutable!) document is reduced.
</p>
<p></p>
<blockquote class="text">
<p>
Note: this only applies to the case when IETF documents are
produced. The "private" processing instruction <a name='anchor17'></a><a name='anchor18'></a>
allows to switch off most of the autogeneration logic.
</p>
</blockquote>
<a name="attribute-ipr"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.A.1"></a><h2>A.1.
The /rfc/@ipr Attribute</h2>
<p>
As of the time of this writing, this attribute value can take a long list of values. As
frequently, this is not the result of a grand plan, but simply for historic
reasons. Of these values, only a few are currently in use; all others are
supported by the various tools for backwards compatibility with old source
files.
</p>
<p></p>
<blockquote class="text">
<p>
Note: some variations of the boilerplate are selected based
on the document's date; therefore it is important to specify the "year",
"month" and "day" attributes of the <tt><date></tt> element
when archiving the XML source of an Internet Draft on the day of submission.
</p>
</blockquote>
<p>
<em>Disclaimer: THIS ONLY PROVIDES IMPLEMENTATION INFORMATION. IF YOU NEED
LEGAL ADVICE, PLEASE CONTACT A LAWYER.</em>
For further information, refer to <a href='http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf'>http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf</a>.