-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-iab-xml2rfc-bis.txt
8904 lines (6096 loc) · 244 KB
/
draft-iab-xml2rfc-bis.txt
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
Network Working Group P. Hoffman
Internet-Draft ICANN
Obsoletes: 7749 (if approved) August 4, 2016
Intended status: Informational
Expires: February 5, 2017
The "xml2rfc" version 3 Vocabulary
draft-iab-xml2rfc-latest
Abstract
This document defines the "xml2rfc" version 3 vocabulary: an XML-
based language used for writing RFCs and Internet-Drafts. It is
heavily derived from the version 2 vocabulary that is also under
discussion. This document obsoletes the v2 grammar described in RFC
2629 and its followup, RFC 7749.
This document is the successor to draft-iab-xml2rfc-latest, which is
currently in the RFC Editor's queue for publication. This -bis draft
will be used for making changes based on implementation experience
with the earlier draft.
Editorial Note (To be removed by RFC Editor)
Discussion of this draft takes place on the rfc-interest mailing list
(rfc-interest@rfc-editor.org), which has its home page at
<https://www.rfc-editor.org/mailman/listinfo/rfc-interest>.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on February 5, 2017.
Copyright Notice
Hoffman Expires February 5, 2017 [Page 1]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1. Expected Updates to the Specification . . . . . . . . . . 5
1.2. Design Criteria for the Changes in v3 . . . . . . . . . . 5
1.3. Differences from v2 to v3 . . . . . . . . . . . . . . . . 6
1.3.1. New Elements in v3 . . . . . . . . . . . . . . . . . 6
1.3.2. New Attributes for Existing Elements . . . . . . . . 7
1.3.3. Elements and Attributes Deprecated from v2 . . . . . 8
1.3.4. Additional Changes from v2 . . . . . . . . . . . . . 9
1.4. Syntax Notation . . . . . . . . . . . . . . . . . . . . . 10
2. Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.1. <abstract> . . . . . . . . . . . . . . . . . . . . . . . 11
2.2. <address> . . . . . . . . . . . . . . . . . . . . . . . . 11
2.3. <annotation> . . . . . . . . . . . . . . . . . . . . . . 12
2.4. <area> . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.5. <artwork> . . . . . . . . . . . . . . . . . . . . . . . . 13
2.6. <aside> . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.7. <author> . . . . . . . . . . . . . . . . . . . . . . . . 17
2.8. <back> . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.9. <bcp14> . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.10. <blockquote> . . . . . . . . . . . . . . . . . . . . . . 19
2.11. <boilerplate> . . . . . . . . . . . . . . . . . . . . . . 21
2.12. <br> . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.13. <city> . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.14. <code> . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.15. <country> . . . . . . . . . . . . . . . . . . . . . . . . 22
2.16. <cref> . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.17. <date> . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.18. <dd> . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.19. <displayreference> . . . . . . . . . . . . . . . . . . . 26
2.20. <dl> . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.21. <dt> . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.22. <em> . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.23. <email> . . . . . . . . . . . . . . . . . . . . . . . . . 30
Hoffman Expires February 5, 2017 [Page 2]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
2.24. <eref> . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.25. <figure> . . . . . . . . . . . . . . . . . . . . . . . . 31
2.26. <front> . . . . . . . . . . . . . . . . . . . . . . . . . 33
2.27. <iref> . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.28. <keyword> . . . . . . . . . . . . . . . . . . . . . . . . 35
2.29. <li> . . . . . . . . . . . . . . . . . . . . . . . . . . 35
2.30. <link> . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.31. <middle> . . . . . . . . . . . . . . . . . . . . . . . . 37
2.32. <name> . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.33. <note> . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.34. <ol> . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.35. <organization> . . . . . . . . . . . . . . . . . . . . . 41
2.36. <phone> . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.37. <postal> . . . . . . . . . . . . . . . . . . . . . . . . 42
2.38. <postalLine> . . . . . . . . . . . . . . . . . . . . . . 42
2.39. <refcontent> . . . . . . . . . . . . . . . . . . . . . . 43
2.40. <reference> . . . . . . . . . . . . . . . . . . . . . . . 43
2.41. <referencegroup> . . . . . . . . . . . . . . . . . . . . 44
2.42. <references> . . . . . . . . . . . . . . . . . . . . . . 45
2.43. <region> . . . . . . . . . . . . . . . . . . . . . . . . 46
2.44. <relref> . . . . . . . . . . . . . . . . . . . . . . . . 46
2.45. <rfc> . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.46. <section> . . . . . . . . . . . . . . . . . . . . . . . . 53
2.47. <seriesInfo> . . . . . . . . . . . . . . . . . . . . . . 55
2.48. <sourcecode> . . . . . . . . . . . . . . . . . . . . . . 57
2.49. <street> . . . . . . . . . . . . . . . . . . . . . . . . 59
2.50. <strong> . . . . . . . . . . . . . . . . . . . . . . . . 59
2.51. <sub> . . . . . . . . . . . . . . . . . . . . . . . . . . 60
2.52. <sup> . . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.53. <t> . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2.54. <table> . . . . . . . . . . . . . . . . . . . . . . . . . 64
2.55. <tbody> . . . . . . . . . . . . . . . . . . . . . . . . . 64
2.56. <td> . . . . . . . . . . . . . . . . . . . . . . . . . . 65
2.57. <tfoot> . . . . . . . . . . . . . . . . . . . . . . . . . 66
2.58. <th> . . . . . . . . . . . . . . . . . . . . . . . . . . 67
2.59. <thead> . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.60. <title> . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.61. <tr> . . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.62. <tt> . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.63. <ul> . . . . . . . . . . . . . . . . . . . . . . . . . . 71
2.64. <uri> . . . . . . . . . . . . . . . . . . . . . . . . . . 72
2.65. <workgroup> . . . . . . . . . . . . . . . . . . . . . . . 72
2.66. <xref> . . . . . . . . . . . . . . . . . . . . . . . . . 72
3. Elements from v2 That Have Been Deprecated . . . . . . . . . 74
3.1. <c> . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
3.2. <facsimile> . . . . . . . . . . . . . . . . . . . . . . . 75
3.3. <format> . . . . . . . . . . . . . . . . . . . . . . . . 75
3.4. <list> . . . . . . . . . . . . . . . . . . . . . . . . . 76
Hoffman Expires February 5, 2017 [Page 3]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
3.5. <postamble> . . . . . . . . . . . . . . . . . . . . . . . 76
3.6. <preamble> . . . . . . . . . . . . . . . . . . . . . . . 77
3.7. <spanx> . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.8. <texttable> . . . . . . . . . . . . . . . . . . . . . . . 78
3.9. <ttcol> . . . . . . . . . . . . . . . . . . . . . . . . . 80
3.10. <vspace> . . . . . . . . . . . . . . . . . . . . . . . . 80
4. SVG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5. Use of CDATA Structures and Escaping . . . . . . . . . . . . 81
6. Internationalization Considerations . . . . . . . . . . . . . 81
7. Security Considerations . . . . . . . . . . . . . . . . . . . 82
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 82
8.1. Internet Media Type Registration . . . . . . . . . . . . 82
8.2. Link Relation Registration . . . . . . . . . . . . . . . 84
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 84
9.1. Normative References . . . . . . . . . . . . . . . . . . 84
9.2. Informative References . . . . . . . . . . . . . . . . . 84
Appendix A. Front-Page ("Boilerplate") Generation . . . . . . . 88
A.1. The "ipr" Attribute . . . . . . . . . . . . . . . . . . . 88
A.1.1. Current Values: "*trust200902" . . . . . . . . . . . 89
A.1.2. Historic Values . . . . . . . . . . . . . . . . . . . 90
A.2. The "submissionType" Attribute . . . . . . . . . . . . . 91
A.3. The "consensus" Attribute . . . . . . . . . . . . . . . . 92
Appendix B. The v3 Format and Processing Tools . . . . . . . . . 92
B.1. Including External Text with XInclude . . . . . . . . . . 93
B.2. Anchors and IDs . . . . . . . . . . . . . . . . . . . . . 94
B.2.1. Overlapping Values . . . . . . . . . . . . . . . . . 95
B.3. Attributes Controlled by the Prep Tool . . . . . . . . . 96
Appendix C. Relax NG Schema . . . . . . . . . . . . . . . . . . 97
Appendix D. Schema Differences from v2 . . . . . . . . . . . . . 117
Appendix E. Acknowledgments . . . . . . . . . . . . . . . . . . 137
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Hoffman Expires February 5, 2017 [Page 4]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
1. Introduction
This document describes version 3 ("v3") of the "xml2rfc" vocabulary;
an XML-based language ("Extensible Markup Language", [XML]) used for
writing RFCs ([RFC7322]) and Internet-Drafts ([IDGUIDE]).
This document obsoletes the version 2 vocabulary ("v2") [RFC7749],
which contains the extended language definition. That document in
turn obsoletes the original version ("v1") [RFC2629]. This document
directly copies the material from [RFC7749] where possible; as that
document makes its way toward RFC publication, this document will
incorporate as many of the changes as possible.
The v3 format will be used as part of the new RFC series format
described in [RFC6949]. The new format will be handled by one or
more new tools for preparing the XML and converting it to other
representations. Features of the expected tools are described in
Appendix B. That section defines some terms used throughout this
document, such as "prep tool" and "formatter".
Note that the vocabulary contains certain constructs that might not
be used when generating the final text; however, they can provide
useful data for other uses (such as index generation, populating a
keyword database, or syntax checks).
In this document, the term "format" is used when describing types of
documents, primarily XML and HTML. The term "representation" is used
when talking about a specific instatiation of a format, such as an
XML document or an HTML document that was created by an XML document.
1.1. Expected Updates to the Specification
Non-interoperable changes in later versions of this specification are
likely based on experience gained in implementing the RFC production
center toolset. Revised documents will be published capturing those
changes as the toolset is completed. Other implementers must not
expect those changes to remain backwards-compatible with the details
described in this document.
1.2. Design Criteria for the Changes in v3
The design criteria of the changes from v2 to v3 are:
o The intention is that starting and editing a v3 document will be
easier than for a v2 document.
o There will be good v2-to-v3 conversion tools for when an author
wants to change versions.
Hoffman Expires February 5, 2017 [Page 5]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
o There are no current plans to make v3 XML the required submission
format for drafts or RFCs. That might happen eventually, but it
is likely to be years away.
There is a desire to keep as much of the v2 grammar as makes sense
within the above design criteria and not to make gratuitous changes
to the v2 grammar. Another way to say this is "we would rather
encourage backward compatibility but not be constrained by it".
Still, the goal of starting and editing a v3 document being easier
than for a v2 document is more important than backwards compatibility
with v2, given the latter two design criteria.
v3 is upwards compatible with v2, meaning that a v2 document is meant
to be a valid v3 document as well. However, some features of v2 are
deprecated in v3 in favor of new elements. Deprecated features are
listed in Section 1.3.3, and are described in [RFC7749].
1.3. Differences from v2 to v3
This is a a hopefully-complete list of all the technical changes
between [RFC7749] and this document.
1.3.1. New Elements in v3
o Add <dl>, <ul>, and <ol> as new ways to make lists. This is a
significant change from v2 in that the child under these elements
is <li>, not <t>. <li> has a model of either containing one or
more <t> elements, or containing the flowing text normally found
in <t>. These lists are children of <section>s and other lists
instead of <t>.
o Add <strong>, <em>, <tt>, <sub>, and <sup> for character
formatting.
o Add <aside> for incidental text that will be indented when
displayed.
o Add <sourcecode> to differentiate from <artwork>.
o Add <table>, <thead>, <tbody>, <tfoot>, <tr>, <td>, and <th> to
give table functionality like that in HTML.
o Add <boilerplate> to hold the automatically-generated boilerplate
text.
o Add <blockquote> to indicate a quotation as in a paragraph-like
format.
Hoffman Expires February 5, 2017 [Page 6]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
o Add <name> to sections, notes, figures, and texttables to allow
character formatting (fixed-width font) in their titles, and to
allow references in the names.
o Add <postalLine>, free text that represents one line of the
address.
o Add <displayreference> to allow display of more mnemonic anchor
names for automatically-included references.
o Add <refcontent> to allow better control of text in a reference.
o Add <referencegroup> to allow referencing multi-RFC documents such
as STDs and BCPs.
o Add <relref> to allow referencing specific sections or anchors in
references.
o Add <link> to point to a resource related to the RFC.
o Add <br> to allow line breaks (but not blank lines) in the
generated output for table cells.
o Add <svg> to allow easy inclusion of SVG drawings in <artwork>.
1.3.2. New Attributes for Existing Elements
o Add "sortRefs", "symRefs", "tocDepth", and "tocInclude" attributes
to <rfc> to cover Processing Instructions (PIs) that were in v2
that are still needed in the grammar. Add "prepTime" to indicate
the time that the XML went through a preparation step. Add
"version" to indicate the version of xml2rfc vocabulary used in
the document. Add "scripts" to indicate which scripts are needed
to render the document. Add "expiresDate" when an Internet-Draft
expires.
o Add "ascii" attributes to <email>, <organization>, <street>,
<city>, <region>, <country>, and <code>. Also add
"asciiFullname", "asciiInitials", and "asciiSurname" to <author>.
This allows an author to specify their information in their native
scripts as the primary entry and still allow the ASCII-equivalent
values to appear in the processed documents.
o Add "anchor" attributes to many block elements to allow them to be
linked with <relref> and <xref>.
o Add the "section", "relative", and "sectionFormat" attributes to
<xref>.
Hoffman Expires February 5, 2017 [Page 7]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
o Add the "numbered" and "removeInRFC" attributes to <section>.
o Add the "removeInRFC" attribute to <note>.
o Add "pn" to <artwork>, <aside>, <blockquote>, <boilerplate>,<dt>,
<figure>, <iref>, <li>, <references>, <section>, <sourcecode>,
<t>, and <table> to hold automatically generated numbers for items
in a section that don't have their own numbering (namely figures
and tables).
o Add "display" to <cref> to indicate to tools whether or not to
display the comment.
o Add "keepWithNext" and "keepWithPrevious" to <t> as a hint to
tools that do pagination that they should try to keep the
paragraph with the next/previous element.
1.3.3. Elements and Attributes Deprecated from v2
Deprecated elements and attributes are legacy vocabulary from v2 that
are supported for input to v3 tools. They are likely to be removed
from those tools in the future. Instead of being listed in
Section 2, they are listed in Section 3. See Appendix B for more
information on tools and how they will handle deprecated features.
o Deprecate <list> in favor of <dl>, <ul>, and <ol>.
o Deprecate <spanx>; replace it with <strong>, <em>, and <tt>.
o Deprecate <vspace> because the major use for it, creating pseudo-
paragraph-breaks in lists, is now handled properly.
o Deprecate <texttable>, <ttcol>, and <c>; replace them with the new
table elements (<table> and the elements that can be contained
within it).
o Deprecate <facsimile> because it is rarely used.
o Deprecate <format> because it is not useful and has caused
surprise for authors in the past. If the goal is to provide a
single URI (Uniform Resource Identifier) for a reference, use the
"target" attribute on <reference> instead.
o Deprecate <preamble> and <postamble> in favor of simply using <t>
before or after the figure. This also deprecates the "align"
attribute in <figure>.
Hoffman Expires February 5, 2017 [Page 8]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
o Deprecate the "title" attribute in <section>, <note>, <figure>,
<references>, and <texttable> in favor of the new <name>.
o Deprecate the "alt", and "src" attributes in <figure> because they
overlap with the attributes in <artwork>.
o Deprecate the "xml:space" attribute in <artwork> because there was
only one useful value. Deprecate "height" and "width" attribute
in both <artwork> and <figure> because they are not needed for the
new output formats.
o Deprecate the "pageno" attribute in <xref> because it was unused
in v2. Deprecate the "none" values for the "format" attribute in
<xref> because it makes no sense semantically.
1.3.4. Additional Changes from v2
o Allow non-ASCII characters in the format; the characters that are
actually allowed will be determined by the RFC Series Editor.
o Allow <artwork> and <sourcecode> to be used on their own in
<section> (no longer confine them to a figure).
o Give more specifics of handling the "type" attribute in <artwork>.
o Allow <strong>, <em>, <tt>, <eref>, and <xref> in <cref>.
o Allow the sub-elements inside a <reference> to be in any order.
o Turned off the autogeneration of anchors in <cref> because there
is no use case for them that cannot be achieved in other ways.
o Allow more than one <artwork>, or more than one <sourcecode>, in
<figure>.
o In <front>, make <date> optional.
o In <date>, added restrictions to the "date" and "year" attribute
when used in the <front> for the document's boilerplate text.
o In <postal>, allow the sub-elements to be in any order. Also
allow the inclusion of the new <postalLine> instead of the older
elements.
o In <section>, restricted the names of the anchors that can be used
on some types of sections.
Hoffman Expires February 5, 2017 [Page 9]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
o Made <seriesInfo> a child of <front>, and deprecated it as a child
of <reference>. This also deprecates some of the attributes from
<rfc> and moves them into <seriesInfo>.
o <t> now only contains non-block elements, so it no longer contains
<figure> elements.
o Do not generate the grammar from a DTD, but instead get it
directly from the Relax Next Generation (RNG) grammar [RNG].
1.4. Syntax Notation
The XML vocabulary here is defined in prose, based on the Relax NG
schema ([RNC]) contained in Appendix C (specified in Relax NG Compact
Notation, (RNC)).
Note that the schema can be used for automated validity checks, but
certain constraints are only described in prose (example: the
conditionally required presence of the "abbrev" attribute).
2. Elements
The sections below describe all elements and their attributes.
Note that attributes not labeled "mandatory" are optional.
Many elements have an optional "anchor" attribute. In all cases, the
value of the "anchor" attribute needs to be a valid XML "Name"
(Section 2.3 of [XML]), additionally constrained to US-ASCII
characters ([USASCII]). Thus, the character repertoire consists of
"A-Z", "a-z", "0-9", "_", "-", ".", and ":", where "0-9", ".", and
"-" are disallowed as start characters. Anchors are described in
more detail in Appendix B.2.
Tools interpreting the XML described here will collapse horizontal
whitespace and line breaks to a single whitespace (except inside
<artwork> and <sourcecode>), and will trim leading and trailing
whitespace. Tab characters (U+0009) inside <artwork> and
<sourcecode> are prohibited.
Some of the elements have attributes that are not described in this
section because those attributes are specific to the prep tool.
People writing tools to process this format should read all of the
appendices for a complete description of these attributes.
Every element in the v3 vocabulary can have an "xml:lang" attribute,
an "xml:base" attribute, or both. The xml:lang attribute specifies
the language used in the element. This is sometimes useful for
Hoffman Expires February 5, 2017 [Page 10]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
renderers which display different fonts for ideographic characters
used in China and Japan. The xml:base attribute is sometimes added
to an XML file when doing XML-to-XML conversion where the base file
has XInclude atttributes (see Appendix B.1).
2.1. <abstract>
Contains the Abstract of the document. See [RFC7322] for more
information on restrictions for the Abstract.
This element appears as a child element of <front> (Section 2.26).
Content model:
In any order, but at least one of:
o <dl> elements (Section 2.20)
o <ol> elements (Section 2.34)
o <t> elements (Section 2.53)
o <ul> elements (Section 2.63)
2.1.1. "anchor" Attribute
Document-wide unique identifier for the Abstract.
2.2. <address>
Provides address information for the author.
This element appears as a child element of <author> (Section 2.7).
Content model:
In this order:
1. One optional <postal> element (Section 2.37)
2. One optional <phone> element (Section 2.36)
3. One optional <facsimile> element (Section 3.2)
4. One optional <email> element (Section 2.23)
5. One optional <uri> element (Section 2.64)
Hoffman Expires February 5, 2017 [Page 11]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
2.3. <annotation>
Provides additional prose augmenting a bibliographical reference.
This text is intended to be shown after the rest of the generated
reference text.
This element appears as a child element of <reference>
(Section 2.40).
Content model:
In any order:
o Text
o <bcp14> elements (Section 2.9)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27)
o <relref> elements (Section 2.44)
o <spanx> elements (Section 3.7)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.4. <area>
Provides information about the IETF area to which this document
relates (currently not used when generating documents).
The value ought to be either the full name or the abbreviation of one
of the IETF areas as listed on <http://www.ietf.org/iesg/area.html>.
The list will be kept by the RFC Series Editor.
Hoffman Expires February 5, 2017 [Page 12]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
This element appears as a child element of <front> (Section 2.26).
Content model: only text content.
2.5. <artwork>
This element allows the inclusion of "artwork" in the document.
<artwork> provides full control of horizontal whitespace and line
breaks; thus is used for a variety of things, such as diagrams ("line
art") and protocol unit diagrams. Tab characters (U+0009) inside of
this element are prohibited.
Alternatively, the "src" attribute allows referencing an external
graphics file, such as a vector drawing in SVG or a bitmap graphic
file, using a URI. In this case, the textual content acts as a
fallback for output representations that do not support graphics;
thus, it ought to contain either (1) a "line art" variant of the
graphics or (2) prose that describes the included image in sufficient
detail.
In [RFC7749], the <artwork> element was also used for source code and
formal languages; in v3, this is now done with <sourcecode>.
There are at least five ways to include SVG in artwork in Internet-
Drafts:
o Inline, by including all of the SVG in the content of the element,
such as: <artwork type="svg"><svg
xmlns="http://www.w3.org/2000/svg" ...">
o Inline, but using XInclude (see Appendix B.1), such as: <artwork
type="svg"><xi:include href=...>
o As a data: URI, such as: <artwork type="svg" src="data:image/
svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3...">
o As a URI to an external entity, such as: <artwork type="svg"
src="http://www.example.com/...">
o As a local file, such as: <artwork type="svg" src="diagram12.svg">
The use of SVG in Internet-Drafts and RFCs is covered in much more
detail in [SVGforRFCs].
The above methods for inclusion of SVG art can also be used for
including text artwork, but using a data: URI is probably confusing
for text artwork.
Hoffman Expires February 5, 2017 [Page 13]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
Formatters that do pagination should attempt to keep artwork on a
single page. This is to prevent artwork that is split across pages
from looking like two separate pieces of artwork.
See Section 5 for a description of to deal with issues of using "&"
and "<" characters in artwork.
This element appears as a child element of <aside> (Section 2.6),
<blockquote> (Section 2.10), <dd> (Section 2.18), <figure>
(Section 2.25), <li> (Section 2.29), <section> (Section 2.46), <td>
(Section 2.56), and <th> (Section 2.58).
Content model:
Either:
Text
Or:
<svg> elements (Section 4)
2.5.1. "align" Attribute
Controls whether the artwork appears left justified (default),
centered, or right justified. Artwork is aligned relative to left
margin of document.
Allowed values:
o "left" (default)
o "center"
o "right"
2.5.2. "alt" Attribute
Alternative text description of the artwork (which is more than just
a summary or caption). When the art comes from the "src" attribute,
and the format of that artwork supports alternate text, the
alternative text comes from the text of the artwork itself, not from
this attribute. The contents of this attribute are important to
readers who are visually impaired, as well as those reading on
devices that cannot show the artwork well, or at all.
Hoffman Expires February 5, 2017 [Page 14]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
2.5.3. "anchor" Attribute
Document-wide unique identifier for this artwork.
2.5.4. "height" Attribute
Deprecated.
2.5.5. "name" Attribute
A filename suitable for the contents (such as for extraction to a
local file). This attribute can be helpful for other kinds of tools
(such as automated syntax checkers, which work by extracting the
artwork). Note that the "name" attribute does not need to be unique
for artwork elements in a document. If multiple artwork elements
have the same name attribute, a processing tool might assume that the
elements are all fragments of a single file, and the tool can collect
those fragments for later processing. See Section 7 for a discussion
of possible problems with the value of this attribute.
2.5.6. "src" Attribute
The URI reference of a graphics file ([RFC3986]), or the name of a
file on the local disk. This can be a "data" URI [RFC2397] that
contains the contents of the graphics file. Note that the inclusion
of art with the "src" attribute depends on the capabilities of the
processing tool reading the XML document. Tools need to be able to
handle the file: URI, and should be able to handle http: and https:
URIs as well. The prep tool will be able to handle reading the "src"
attribute.
If no URI scheme is given in the attribute, the attribute is
considered to be a local file name relative to the current directory.
Processing tools must be careful to not accept dangerous values for
the filename, particularly those that contain absolute references
outside the current directory. Document creators should think hard
before using relative URIs due to possible later problems if files
move around on the disk. Also, documents should most likely use
explicit URI schemes wherever possible.
In some cases, the prep tool may remove the "src" attribute after
processing its value. See [PREPTOOL] for a description of this.
It is an error to have both a "src" attribute and content in the
<artwork> element.
Hoffman Expires February 5, 2017 [Page 15]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
2.5.7. "type" Attribute
Specifies the type of the artwork. The value of this attribute is
free text with certain values designated as preferred.
The preferred values for <artwork> types are:
o ascii-art
o binary-art
o call-flow
o hex-dump
o svg
The RFC Series Editor will maintain a complete list of the preferred
values on its web site, and that list is expected to be updated over
time. Thus, a consumer of v3 XML should not cause a failure when it
encounters an unexpected type or no type is specified. The table
will also indicate which type of art can appear in plaintext output
(for example, type="svg" cannot).
2.5.8. "width" Attribute
Deprecated.
2.5.9. "xml:space" Attribute
Deprecated.
2.6. <aside>
This element is a container for content that is semantically less
important or tangential to the content that surrounds it.
This element appears as a child element of <section> (Section 2.46).
Content model:
In any order:
o <artwork> elements (Section 2.5)
o <dl> elements (Section 2.20)
Hoffman Expires February 5, 2017 [Page 16]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
o <figure> elements (Section 2.25)
o <iref> elements (Section 2.27)
o <list> elements (Section 3.4)
o <ol> elements (Section 2.34)
o <t> elements (Section 2.53)
o <table> elements (Section 2.54)
o <ul> elements (Section 2.63)
2.6.1. "anchor" Attribute
Document-wide unique identifier for this aside.
2.7. <author>
Provides information about a document's author. This is used both
for the document itself (at the beginning of the document) and for
referenced documents.
The <author> elements contained within the document's <front> element
are used to fill the boilerplate, and also to generate the "Author's
Address" section (see [RFC7322]).
Note that an "author" can also be just an organization (by not
specifying any of the name attributes, but adding the <organization>
child element).
Furthermore, the "role" attribute can be used to mark an author as
"editor". This is reflected both on the front page and in the
"Author's Address" section, as well as in bibliographical references.
Note that this specification does not define a precise meaning for
the term "editor".
See Section "Authors vs. Contributors" of [RFC7322] for more
information.
This element appears as a child element of <front> (Section 2.26).
Content model:
In this order:
Hoffman Expires February 5, 2017 [Page 17]
Internet-Draft The "xml2rfc" version 3 Vocabulary August 2016
1. One optional <organization> element (Section 2.35)
2. One optional <address> element (Section 2.2)
2.7.1. "asciiFullname" Attribute
The ASCII equivalent of the author's full name.
2.7.2. "asciiInitials" Attribute
The ASCII equivalent of the author's initials, to be used in
conjunction with the separately specified asciiSurname.
2.7.3. "asciiSurname" Attribute
The ASCII equivalent of the author's surname, to be used in
conjunction with the separately specified asciiInitials.
2.7.4. "fullname" Attribute
The full name (used in the automatically generated "Author's Address"
section). Although this attribute is optional, if one or more of the
"asciiFullname", "asciiInitials", or "asciiSurname" attributes have
values, the "fullname" attribute is required.
2.7.5. "initials" Attribute
An abbreviated variant of the given name(s), to be used in
conjunction with the separately specified surname. It usually
appears on the front page, in footers, and in references.
Some processors will post-process the value, for instance when it
only contains a single letter (in which case they might add a
trailing dot). Relying on this kind of post-processing can lead to
results varying across formatters and thus ought to be avoided.
2.7.6. "role" Attribute
Specifies the role the author had in creating the document.
Allowed values:
o "editor"