rfc7991.txt   draft-iab-rfc7991bis-latest.txt 
Internet Architecture Board (IAB) P. Hoffman Network Working Group J. Levine, Ed.
Request for Comments: 7991 ICANN Internet-Draft Temporary RFC Series Project Manager
Obsoletes: 7749 December 2016 Obsoletes: 7991 (if approved) July 7, 2024
Category: Informational Intended status: Informational
ISSN: 2070-1721 Expires: January 8, 2025
The "xml2rfc" Version 3 Vocabulary The "xml2rfc" version 3 Vocabulary
draft-iab-rfc7991bis-05
Abstract Abstract
This document defines the "xml2rfc" version 3 vocabulary: an XML- This document defines the "xml2rfc" version 3 vocabulary: an XML-
based language used for writing RFCs and Internet-Drafts. It is based language used for writing RFCs and Internet-Drafts. It is
heavily derived from the version 2 vocabulary that is also under heavily derived from the version 2 vocabulary that is also under
discussion. This document obsoletes the v2 grammar described in RFC discussion. This document obsoletes the earlier v3 grammar described
7749. in RFC 7991, which in turn obsoleted the v2 grammar in RFC 7749.
Editorial Note
This note is to be removed before publishing as an RFC.
Discussion of this draft takes place on the rfc-interest@ietf.org
mailing list, which has its home page at
<https://www.ietf.org/mailman/listinfo/rfc-interest>.
Source code and issues list for this draft can be found at
<https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis>.
The changes in this draft are summarized in Appendix E.5.
Status of This Memo Status of This Memo
This document is not an Internet Standards Track specification; it is This Internet-Draft is submitted in full conformance with the
published for informational purposes. provisions of BCP 78 and BCP 79.
This document is a product of the Internet Architecture Board (IAB) Internet-Drafts are working documents of the Internet Engineering
and represents information that the IAB has deemed valuable to Task Force (IETF). Note that other groups may also distribute
provide for permanent record. It represents the consensus of the working documents as Internet-Drafts. The list of current Internet-
Internet Architecture Board (IAB). Documents approved for Drafts is at https://datatracker.ietf.org/drafts/current/.
publication by the IAB are not a candidate for any level of Internet
Standard; see Section 2 of RFC 7841.
Information about the current status of this document, any errata, Internet-Drafts are draft documents valid for a maximum of six months
and how to provide feedback on it may be obtained at and may be updated, replaced, or obsoleted by other documents at any
http://www.rfc-editor.org/info/rfc7991. 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 January 8, 2025.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. to this document.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1. Expected Updates to the Specification . . . . . . . . . . 5 1.1. Expected Updates to the Specification . . . . . . . . . . 5
1.2. Design Criteria for the Changes in v3 . . . . . . . . . . 5 1.2. Design Criteria for the Changes in v3 . . . . . . . . . . 5
1.3. Differences from v2 to v3 . . . . . . . . . . . . . . . . 6 1.3. Differences from RFC 7991 in This Document . . . . . . . 6
1.3.1. New Elements in v3 . . . . . . . . . . . . . . . . . 6 1.4. Differences from v2 to v3 . . . . . . . . . . . . . . . . 7
1.3.2. New Attributes for Existing Elements . . . . . . . . 7 1.4.1. New Elements in v3 . . . . . . . . . . . . . . . . . 7
1.3.3. Elements and Attributes Deprecated from v2 . . . . . 8 1.4.2. New Attributes for Existing Elements . . . . . . . . 8
1.3.4. Additional Changes from v2 . . . . . . . . . . . . . 9 1.4.3. Elements and Attributes Deprecated from Original v3 . 9
1.4. Syntax Notation . . . . . . . . . . . . . . . . . . . . . 10 1.4.4. Elements and Attributes Deprecated from v2 . . . . . 9
2. Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 10 1.4.5. Additional Changes from v2 . . . . . . . . . . . . . 10
2.1. <abstract> . . . . . . . . . . . . . . . . . . . . . . . 11 1.5. Syntax Notation . . . . . . . . . . . . . . . . . . . . . 11
2.2. <address> . . . . . . . . . . . . . . . . . . . . . . . . 11 2. Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.3. <annotation> . . . . . . . . . . . . . . . . . . . . . . 12 2.1. <abstract> . . . . . . . . . . . . . . . . . . . . . . . 12
2.4. <area> . . . . . . . . . . . . . . . . . . . . . . . . . 12 2.2. <address> . . . . . . . . . . . . . . . . . . . . . . . . 12
2.5. <artwork> . . . . . . . . . . . . . . . . . . . . . . . . 13 2.3. <annotation> . . . . . . . . . . . . . . . . . . . . . . 13
2.6. <aside> . . . . . . . . . . . . . . . . . . . . . . . . . 16 2.4. <area> . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.7. <author> . . . . . . . . . . . . . . . . . . . . . . . . 17 2.5. <artset> . . . . . . . . . . . . . . . . . . . . . . . . 14
2.8. <back> . . . . . . . . . . . . . . . . . . . . . . . . . 19 2.6. <artwork> . . . . . . . . . . . . . . . . . . . . . . . . 15
2.9. <bcp14> . . . . . . . . . . . . . . . . . . . . . . . . . 19 2.7. <aside> . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.10. <blockquote> . . . . . . . . . . . . . . . . . . . . . . 19 2.8. <author> . . . . . . . . . . . . . . . . . . . . . . . . 19
2.11. <boilerplate> . . . . . . . . . . . . . . . . . . . . . . 21 2.9. <back> . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.12. <br> . . . . . . . . . . . . . . . . . . . . . . . . . . 21 2.10. <bcp14> . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.13. <city> . . . . . . . . . . . . . . . . . . . . . . . . . 21 2.11. <blockquote> . . . . . . . . . . . . . . . . . . . . . . 21
2.14. <code> . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.12. <boilerplate> . . . . . . . . . . . . . . . . . . . . . . 23
2.15. <country> . . . . . . . . . . . . . . . . . . . . . . . . 22 2.13. <br> . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.16. <cref> . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.14. <contact> . . . . . . . . . . . . . . . . . . . . . . . . 24
2.17. <date> . . . . . . . . . . . . . . . . . . . . . . . . . 23 2.15. <country> . . . . . . . . . . . . . . . . . . . . . . . . 25
2.18. <dd> . . . . . . . . . . . . . . . . . . . . . . . . . . 24 2.16. <cref> . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.19. <displayreference> . . . . . . . . . . . . . . . . . . . 26 2.17. <date> . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.20. <dl> . . . . . . . . . . . . . . . . . . . . . . . . . . 26 2.18. <dd> . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.21. <dt> . . . . . . . . . . . . . . . . . . . . . . . . . . 28 2.19. <displayreference> . . . . . . . . . . . . . . . . . . . 29
2.22. <em> . . . . . . . . . . . . . . . . . . . . . . . . . . 28 2.20. <dl> . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.23. <email> . . . . . . . . . . . . . . . . . . . . . . . . . 29 2.21. <dt> . . . . . . . . . . . . . . . . . . . . . . . . . . 31
2.24. <eref> . . . . . . . . . . . . . . . . . . . . . . . . . 30 2.22. <em> . . . . . . . . . . . . . . . . . . . . . . . . . . 31
2.25. <figure> . . . . . . . . . . . . . . . . . . . . . . . . 31 2.23. <email> . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.26. <front> . . . . . . . . . . . . . . . . . . . . . . . . . 32 2.24. <eref> . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.27. <iref> . . . . . . . . . . . . . . . . . . . . . . . . . 33 2.25. <figure> . . . . . . . . . . . . . . . . . . . . . . . . 34
2.28. <keyword> . . . . . . . . . . . . . . . . . . . . . . . . 34 2.26. <front> . . . . . . . . . . . . . . . . . . . . . . . . . 35
2.29. <li> . . . . . . . . . . . . . . . . . . . . . . . . . . 35 2.27. <iref> . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.30. <link> . . . . . . . . . . . . . . . . . . . . . . . . . 36 2.28. <keyword> . . . . . . . . . . . . . . . . . . . . . . . . 37
2.31. <middle> . . . . . . . . . . . . . . . . . . . . . . . . 37 2.29. <li> . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.32. <name> . . . . . . . . . . . . . . . . . . . . . . . . . 37 2.30. <link> . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.33. <note> . . . . . . . . . . . . . . . . . . . . . . . . . 38 2.31. <middle> . . . . . . . . . . . . . . . . . . . . . . . . 39
2.34. <ol> . . . . . . . . . . . . . . . . . . . . . . . . . . 39 2.32. <name> . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.35. <organization> . . . . . . . . . . . . . . . . . . . . . 40 2.33. <note> . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.36. <phone> . . . . . . . . . . . . . . . . . . . . . . . . . 41 2.34. <ol> . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.37. <postal> . . . . . . . . . . . . . . . . . . . . . . . . 41 2.35. <organization> . . . . . . . . . . . . . . . . . . . . . 43
2.38. <postalLine> . . . . . . . . . . . . . . . . . . . . . . 42 2.36. <phone> . . . . . . . . . . . . . . . . . . . . . . . . . 44
2.39. <refcontent> . . . . . . . . . . . . . . . . . . . . . . 42 2.37. <postal> . . . . . . . . . . . . . . . . . . . . . . . . 44
2.40. <reference> . . . . . . . . . . . . . . . . . . . . . . . 43 2.38. <postalLine> . . . . . . . . . . . . . . . . . . . . . . 45
2.41. <referencegroup> . . . . . . . . . . . . . . . . . . . . 44 2.39. <refcontent> . . . . . . . . . . . . . . . . . . . . . . 45
2.42. <references> . . . . . . . . . . . . . . . . . . . . . . 44 2.40. <reference> . . . . . . . . . . . . . . . . . . . . . . . 46
2.43. <region> . . . . . . . . . . . . . . . . . . . . . . . . 45 2.41. <referencegroup> . . . . . . . . . . . . . . . . . . . . 48
2.44. <relref> . . . . . . . . . . . . . . . . . . . . . . . . 45 2.42. <references> . . . . . . . . . . . . . . . . . . . . . . 48
2.45. <rfc> . . . . . . . . . . . . . . . . . . . . . . . . . . 49 2.43. <rfc> . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.46. <section> . . . . . . . . . . . . . . . . . . . . . . . . 52 2.44. <section> . . . . . . . . . . . . . . . . . . . . . . . . 53
2.47. <seriesInfo> . . . . . . . . . . . . . . . . . . . . . . 54 2.45. <seriesInfo> . . . . . . . . . . . . . . . . . . . . . . 56
2.48. <sourcecode> . . . . . . . . . . . . . . . . . . . . . . 57 2.46. <sourcecode> . . . . . . . . . . . . . . . . . . . . . . 57
2.49. <street> . . . . . . . . . . . . . . . . . . . . . . . . 59 2.47. <stream> . . . . . . . . . . . . . . . . . . . . . . . . 60
2.50. <strong> . . . . . . . . . . . . . . . . . . . . . . . . 59 2.48. <strong> . . . . . . . . . . . . . . . . . . . . . . . . 60
2.51. <sub> . . . . . . . . . . . . . . . . . . . . . . . . . . 60 2.49. <sub> . . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.52. <sup> . . . . . . . . . . . . . . . . . . . . . . . . . . 61 2.50. <sup> . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2.53. <t> . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 2.51. <t> . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
2.54. <table> . . . . . . . . . . . . . . . . . . . . . . . . . 63 2.52. <table> . . . . . . . . . . . . . . . . . . . . . . . . . 65
2.55. <tbody> . . . . . . . . . . . . . . . . . . . . . . . . . 64 2.53. <tbody> . . . . . . . . . . . . . . . . . . . . . . . . . 66
2.56. <td> . . . . . . . . . . . . . . . . . . . . . . . . . . 64 2.54. <td> . . . . . . . . . . . . . . . . . . . . . . . . . . 66
2.57. <tfoot> . . . . . . . . . . . . . . . . . . . . . . . . . 66 2.55. <tfoot> . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.58. <th> . . . . . . . . . . . . . . . . . . . . . . . . . . 66 2.56. <th> . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.59. <thead> . . . . . . . . . . . . . . . . . . . . . . . . . 68 2.57. <thead> . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.60. <title> . . . . . . . . . . . . . . . . . . . . . . . . . 69 2.58. <title> . . . . . . . . . . . . . . . . . . . . . . . . . 71
2.61. <tr> . . . . . . . . . . . . . . . . . . . . . . . . . . 69 2.59. <toc> . . . . . . . . . . . . . . . . . . . . . . . . . . 71
2.62. <tt> . . . . . . . . . . . . . . . . . . . . . . . . . . 69 2.60. <tr> . . . . . . . . . . . . . . . . . . . . . . . . . . 72
2.63. <ul> . . . . . . . . . . . . . . . . . . . . . . . . . . 70 2.61. <tt> . . . . . . . . . . . . . . . . . . . . . . . . . . 72
2.64. <uri> . . . . . . . . . . . . . . . . . . . . . . . . . . 71 2.62. <u> . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
2.65. <workgroup> . . . . . . . . . . . . . . . . . . . . . . . 71 2.63. <ul> . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.66. <xref> . . . . . . . . . . . . . . . . . . . . . . . . . 72 2.64. <uri> . . . . . . . . . . . . . . . . . . . . . . . . . . 76
3. Elements from v2 That Have Been Deprecated . . . . . . . . . 74 2.65. <workgroup> . . . . . . . . . . . . . . . . . . . . . . . 76
3.1. <c> . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 2.66. <xref> . . . . . . . . . . . . . . . . . . . . . . . . . 76
3.2. <facsimile> . . . . . . . . . . . . . . . . . . . . . . . 75 3. Elements from v2 and original v3 That Have Been Deprecated . 81
3.3. <format> . . . . . . . . . . . . . . . . . . . . . . . . 75 3.1. <c> . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
3.4. <list> . . . . . . . . . . . . . . . . . . . . . . . . . 75 3.2. <city> . . . . . . . . . . . . . . . . . . . . . . . . . 81
3.5. <postamble> . . . . . . . . . . . . . . . . . . . . . . . 76 3.3. <cityarea> . . . . . . . . . . . . . . . . . . . . . . . 82
3.6. <preamble> . . . . . . . . . . . . . . . . . . . . . . . 77 3.4. <code> . . . . . . . . . . . . . . . . . . . . . . . . . 82
3.7. <spanx> . . . . . . . . . . . . . . . . . . . . . . . . . 78 3.5. <extaddr> . . . . . . . . . . . . . . . . . . . . . . . . 82
3.8. <texttable> . . . . . . . . . . . . . . . . . . . . . . . 78 3.6. <facsimile> . . . . . . . . . . . . . . . . . . . . . . . 82
3.9. <ttcol> . . . . . . . . . . . . . . . . . . . . . . . . . 79 3.7. <format> . . . . . . . . . . . . . . . . . . . . . . . . 83
3.10. <vspace> . . . . . . . . . . . . . . . . . . . . . . . . 80 3.8. <list> . . . . . . . . . . . . . . . . . . . . . . . . . 83
4. SVG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 3.9. <pobox> . . . . . . . . . . . . . . . . . . . . . . . . . 84
5. Use of CDATA Structures and Escaping . . . . . . . . . . . . 80 3.10. <postamble> . . . . . . . . . . . . . . . . . . . . . . . 84
6. Internationalization Considerations . . . . . . . . . . . . . 81 3.11. <preamble> . . . . . . . . . . . . . . . . . . . . . . . 84
7. Security Considerations . . . . . . . . . . . . . . . . . . . 81 3.12. <region> . . . . . . . . . . . . . . . . . . . . . . . . 85
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 82 3.13. <relref> . . . . . . . . . . . . . . . . . . . . . . . . 85
8.1. Internet Media Type Registration . . . . . . . . . . . . 82 3.14. <sortingcode> . . . . . . . . . . . . . . . . . . . . . . 89
8.2. Link Relation Registration . . . . . . . . . . . . . . . 83 3.15. <spanx> . . . . . . . . . . . . . . . . . . . . . . . . . 90
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 84 3.16. <street> . . . . . . . . . . . . . . . . . . . . . . . . 90
9.1. Normative References . . . . . . . . . . . . . . . . . . 84 3.17. <texttable> . . . . . . . . . . . . . . . . . . . . . . . 90
9.2. Informative References . . . . . . . . . . . . . . . . . 84 3.18. <ttcol> . . . . . . . . . . . . . . . . . . . . . . . . . 92
3.19. <vspace> . . . . . . . . . . . . . . . . . . . . . . . . 93
Appendix A. Front-Page ("Boilerplate") Generation . . . . . . . 88 4. SVG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
A.1. The "ipr" Attribute . . . . . . . . . . . . . . . . . . . 88 5. Use of CDATA Structures and Escaping . . . . . . . . . . . . 93
A.1.1. Current Values: "*trust200902" . . . . . . . . . . . 88 6. Internationalization Considerations . . . . . . . . . . . . . 94
A.1.2. Historic Values . . . . . . . . . . . . . . . . . . . 90 7. Security Considerations . . . . . . . . . . . . . . . . . . . 94
A.2. The "submissionType" Attribute . . . . . . . . . . . . . 91 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 95
A.3. The "consensus" Attribute . . . . . . . . . . . . . . . . 91 8.1. Internet Media Type Registration . . . . . . . . . . . . 95
Appendix B. The v3 Format and Processing Tools . . . . . . . . . 92 8.2. Link Relation Registration . . . . . . . . . . . . . . . 96
B.1. Including External Text with XInclude . . . . . . . . . . 93 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 96
B.2. Anchors and IDs . . . . . . . . . . . . . . . . . . . . . 94 9.1. Normative References . . . . . . . . . . . . . . . . . . 96
B.2.1. Overlapping Values . . . . . . . . . . . . . . . . . 95 9.2. Informative References . . . . . . . . . . . . . . . . . 97
B.3. Attributes Controlled by the Prep Tool . . . . . . . . . 96 9.3. Editorial References . . . . . . . . . . . . . . . . . . 101
Appendix C. RELAX NG Schema . . . . . . . . . . . . . . . . . . 97 Appendix A. Front-Page ("Boilerplate") Generation . . . . . . . 103
Appendix D. Schema Differences from v2 . . . . . . . . . . . . . 117 A.1. The "category" Attribute . . . . . . . . . . . . . . . . 103
Appendix E. IAB Members at the Time of Approval . . . . . . . . 137 A.2. The "ipr" Attribute . . . . . . . . . . . . . . . . . . . 103
Appendix F. Acknowledgments . . . . . . . . . . . . . . . . . . 138 A.2.1. Current Values: "*trust200902" . . . . . . . . . . . 103
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 A.2.2. Historic Values . . . . . . . . . . . . . . . . . . . 105
A.3. The "submissionType" Attribute . . . . . . . . . . . . . 106
A.4. The "consensus" Attribute . . . . . . . . . . . . . . . . 106
Appendix B. The v3 Format and Processing Tools . . . . . . . . . 107
B.1. Including External Text with XInclude . . . . . . . . . . 108
B.2. Anchors and IDs . . . . . . . . . . . . . . . . . . . . . 109
B.2.1. Overlapping Values . . . . . . . . . . . . . . . . . 110
B.3. Attributes Controlled by the Prep Tool . . . . . . . . . 111
Appendix C. RELAX NG Schema . . . . . . . . . . . . . . . . . . 113
Appendix D. Schema Differences from v2 . . . . . . . . . . . . . 136
Appendix E. Change Log . . . . . . . . . . . . . . . . . . . . . 160
E.1. Since draft-iab-rfc7991bis-00 . . . . . . . . . . . . . . 160
E.2. Since draft-iab-rfc7991bis-01 . . . . . . . . . . . . . . 161
E.3. Since draft-iab-rfc7991bis-02 . . . . . . . . . . . . . . 162
E.4. Since draft-iab-rfc7991bis-03 . . . . . . . . . . . . . . 162
E.5. Since draft-iab-rfc7991bis-04 . . . . . . . . . . . . . . 164
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
IAB Members at the Time of Approval . . . . . . . . . . . . . . . 189
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 189
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 189
1. Introduction 1. Introduction
This document describes version 3 ("v3") of the "xml2rfc" vocabulary: This document describes the updated version 3 ("v3") of the "xml2rfc"
an XML-based language ("Extensible Markup Language" [XML]) used for vocabulary: an XML-based language ("Extensible Markup Language"
writing RFCs [RFC7322] and Internet-Drafts [IDGUIDE]. [XML]) used for writing RFCs [RFC7322] and Internet-Drafts [IDGUIDE].
This document obsoletes the version 2 vocabulary ("v2") [RFC7749], This document obsoletes [RFC7991], [RFC7991] obsoleted the version 2
which contains the extended language definition. That document in vocabulary ("v2") [RFC7749], which contains the extended language
turn obsoletes the original version ("v1") [RFC2629]. This document definition. [RFC7749] obsoleted the original version ("v1")
directly copies the material from [RFC7749] where possible. [RFC2629]. This document directly copies the material from [RFC7749]
where possible.
The v3 format will be used as part of the new RFC Series format The v3 format is used as part of the new RFC Series format described
described in [RFC6949]. The new format will be handled by one or in [RFC6949]. The new format is handled by existing tools for
more new tools for preparing the XML and converting it to other preparing the XML and converting it to other representations.
representations. Features of the expected tools are described in Features of the tools are described in Appendix B. That section
Appendix B. That section defines some terms used throughout this defines some terms used throughout this document, such as "prep tool"
document, such as "prep tool" and "formatter". and "formatter".
Note that the vocabulary contains certain constructs that might not Note that the vocabulary contains certain constructs that might not
be used when generating the final text; however, they can provide be used when generating the final text; however, they can provide
useful data for other uses (such as index generation, populating a useful data for other uses (such as index generation, populating a
keyword database, or syntax checks). keyword database, or syntax checks).
In this document, the term "format" is used when describing types of In this document, the term "format" is used when describing types of
documents, primarily XML and HTML. The term "representation" is used documents, primarily XML and HTML. The term "representation" is used
when talking about a specific instantiation of a format, such as an when talking about a specific instantiation of a format, such as an
XML document or an HTML document that was created by an XML document. XML document or an HTML document that was created by an XML document.
skipping to change at page 5, line 44 skipping to change at page 5, line 48
Non-interoperable changes in later versions of this specification are Non-interoperable changes in later versions of this specification are
likely based on experience gained in implementing the new publication likely based on experience gained in implementing the new publication
toolsets. Revised documents will be published capturing those toolsets. Revised documents will be published capturing those
changes as the toolsets are completed. Other implementers must not changes as the toolsets are completed. Other implementers must not
expect those changes to remain backwards-compatible with the details expect those changes to remain backwards-compatible with the details
described in this document. described in this document.
1.2. Design Criteria for the Changes in v3 1.2. Design Criteria for the Changes in v3
The design criteria of the changes from v2 to v3 are as follows: The design criteria of the changes from v2 to v3 were as follows:
o The intention is that starting and editing a v3 document will be o The intention was that starting and editing a v3 document will be
easier than for a v2 document. easier than for a v2 document.
o There will be good v2-to-v3 conversion tools for when an author o There will be good v2-to-v3 conversion tools for when an author
wants to change versions. wants to change versions.
o There are no current plans to make v3 XML the required submission o There were no plans to make v3 XML the required submission format
format for drafts or RFCs. That might happen eventually, but it for drafts or RFCs. But starting in 2020, all RFCs were published
is likely to be years away. using v3, and any v2 submissions were mechanically converted to v3
before editing. Submissions in v3 are strongly preferred.
There is a desire to keep as much of the v2 grammar as makes sense 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 within the above design criteria and not to make gratuitous changes
to the v2 grammar. Another way to say this is "we would rather to the v2 grammar. Another way to say this is "we would rather
encourage backwards compatibility but not be constrained by it." encourage backwards compatibility but not be constrained by it."
Still, the goal of starting and editing a v3 document being easier Still, the goal of starting and editing a v3 document being easier
than for a v2 document is more important than backwards compatibility than for a v2 document is more important than backwards compatibility
with v2, given the latter two design criteria. with v2, given the latter two design criteria.
v3 is upwards compatible with v2, meaning that a v2 document is meant v3 is largely compatible with v2, meaning that a v2 document is
to be a valid v3 document as well. However, some features of v2 are mostly a valid v3 document as well. However, some features of v2
deprecated in v3 in favor of new elements. Deprecated features are were deprecated in v3 in favor of new elements, and a few elements
listed in Section 1.3.3 and are described in [RFC7749]. are used differently. Deprecated features are listed in
Section 1.4.4 and are described in [RFC7749].
1.3. Differences from v2 to v3 1.3. Differences from RFC 7991 in This Document
This is a (hopefully) complete list of all the technical changes
between [RFC7991] and this document.
o Changed the text about what this draft obsoletes and updates.
o Allow <blockquote> as a child of <aside> and <li>.
o Removed "It is an error to have both a "src" attribute and content
in the <artwork> element." from Section 2.6.6.
o Added <toc>, and <u> elements.
o Changed the "hanging" attribute of <dl> to "newline".
o Added the "indent" attribute to <dl>.
o Added the "align" attribute to <table>. Made the table title
centered under the table.
o The <name> element now allows many more elements inside of it.
o Redefined <references> to allow <references> within it. In the
typical case, an outer <references> will be used to hold an inner
<references> for normative references and an inner <references> to
hold informative references.
o Un-deprecated metadata attributes on the <rfc> element (with the
intent to restore v2 semantics of <seriesInfo> as well).
o Added <contact> element.
o Allowed multiple <email> elements in <address>.
o Added "markers" attribute to <sourcecode> element.
o Added "brackets" attribute to <eref> element.
1.4. Differences from v2 to v3
This is a (hopefully) complete list of all the technical changes This is a (hopefully) complete list of all the technical changes
between [RFC7749] and this document. between [RFC7749] and this document.
1.3.1. New Elements in v3 1.4.1. New Elements in v3
o Add <dl>, <ul>, and <ol> as new ways to make lists. This is a 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 significant change from v2 in that the child under these elements
is <li>, not <t>. <li> has a model of either containing one or is <li>, not <t>. <li> has a model of either containing one or
more <t> elements, or containing the flowing text normally found more <t> elements, or containing the flowing text normally found
in <t>. These lists are children of <section>s and other lists in <t>. These lists are children of <section>s and other lists
instead of <t>. instead of <t>.
o Add <strong>, <em>, <tt>, <sub>, and <sup> for character o Add <strong>, <em>, <tt>, <sub>, and <sup> for character
formatting. formatting.
o Add <aside> for incidental text that will be indented when o Add <aside> for incidental text that will be indented when
displayed. displayed.
skipping to change at page 7, line 30 skipping to change at page 8, line 26
o Add <relref> to allow referencing specific sections or anchors in o Add <relref> to allow referencing specific sections or anchors in
references. references.
o Add <link> to point to a resource related to the RFC. 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 o Add <br> to allow line breaks (but not blank lines) in the
generated output for table cells. generated output for table cells.
o Add <svg> to allow easy inclusion of SVG drawings in <artwork>. o Add <svg> to allow easy inclusion of SVG drawings in <artwork>.
1.3.2. New Attributes for Existing Elements o Add <artset> to allow support of alternative artwork formats.
1.4.2. New Attributes for Existing Elements
o Add "sortRefs", "symRefs", "tocDepth", and "tocInclude" attributes o Add "sortRefs", "symRefs", "tocDepth", and "tocInclude" attributes
to <rfc> to cover Processing Instructions (PIs) that were in v2 to <rfc> to cover Processing Instructions (PIs) that were in v2
that are still needed in the grammar. Add "prepTime" to indicate that are still needed in the grammar. Add "prepTime" to indicate
the time that the XML went through a preparation step. Add the time that the XML went through a preparation step. Add
"version" to indicate the version of xml2rfc vocabulary used in "version" to indicate the version of xml2rfc vocabulary used in
the document. Add "scripts" to indicate which scripts are needed the document. Add "scripts" to indicate which scripts are needed
to render the document. Add "expiresDate" when an Internet-Draft to render the document. Add "expiresDate" when an Internet-Draft
expires. expires.
skipping to change at page 8, line 22 skipping to change at page 9, line 20
in a section that don't have their own numbering (namely figures in a section that don't have their own numbering (namely figures
and tables). and tables).
o Add "display" to <cref> to indicate to tools whether or not to o Add "display" to <cref> to indicate to tools whether or not to
display the comment. display the comment.
o Add "keepWithNext" and "keepWithPrevious" to <t> as a hint to o Add "keepWithNext" and "keepWithPrevious" to <t> as a hint to
tools that do pagination that they should try to keep the tools that do pagination that they should try to keep the
paragraph with the next/previous element. paragraph with the next/previous element.
1.3.3. Elements and Attributes Deprecated from v2 o Add "indent" to <t> to allow for explicitly indented paragraphs.
1.4.3. Elements and Attributes Deprecated from Original v3
These elements were present in the original vocabulary for v3 but
have been deprecated. They are likely to be removed from tools in
the future. Deprecated attributes are still listed in Section 2, and
deprecated elements are listed in Section 3.
o Deprecate <city>, <cityarea>, <code>, <extaddr>, <pobox>,
<region>, <sortingcode>, and <street> in favor of <postalLine>.
These elements require an unsupported external library to format.
o Deprecate <relref>, in favor of <xref>.
1.4.4. Elements and Attributes Deprecated from v2
Deprecated elements and attributes are legacy vocabulary from v2 that Deprecated elements and attributes are legacy vocabulary from v2 that
are supported for input to v3 tools. They are likely to be removed are supported for input to v3 tools. They are likely to be removed
from those tools in the future. Deprecated attributes are still from those tools in the future. Deprecated attributes are still
listed in Section 2, and deprecated elements are listed in Section 3. listed in Section 2, and deprecated elements are listed in Section 3.
See Appendix B for more information on tools and how they will handle See Appendix B for more information on tools and how they will handle
deprecated features. deprecated features.
o Deprecate <list> in favor of <dl>, <ul>, and <ol>. o Deprecate <list> in favor of <dl>, <ul>, and <ol>.
skipping to change at page 9, line 17 skipping to change at page 10, line 32
o Deprecate the "alt" and "src" attributes in <figure> because they o Deprecate the "alt" and "src" attributes in <figure> because they
overlap with the attributes in <artwork>. overlap with the attributes in <artwork>.
o Deprecate the "xml:space" attribute in <artwork> because there was o Deprecate the "xml:space" attribute in <artwork> because there was
only one useful value. Deprecate the "height" and "width" only one useful value. Deprecate the "height" and "width"
attributes in both <artwork> and <figure> because they are not attributes in both <artwork> and <figure> because they are not
needed for the new output formats. needed for the new output formats.
o Deprecate the "pageno" attribute in <xref> because it was unused o Deprecate the "pageno" attribute in <xref> because it was unused
in v2. Deprecate the "none" values for the "format" attribute in in v2.
<xref> because it makes no sense semantically.
1.3.4. Additional Changes from v2 1.4.5. Additional Changes from v2
o Allow non-ASCII characters in the format; the characters that are o Allow non-ASCII characters in the format; the characters that are
actually allowed will be determined by the RFC Series Editor. actually allowed will be determined by the RFC Series Editor.
o Allow <artwork> and <sourcecode> to be used on their own in o Allow <artwork> and <sourcecode> to be used on their own in
<section> (no longer confine them to a figure). <section> (no longer confine them to a figure).
o Give more specifics of handling the "type" attribute in <artwork>. o Give more specifics of handling the "type" attribute in <artwork>.
o Allow <strong>, <em>, <tt>, <eref>, and <xref> in <cref>. o Allow <strong>, <em>, <tt>, <eref>, and <xref> in <cref>.
skipping to change at page 10, line 6 skipping to change at page 11, line 18
when used in the <front> for the document's boilerplate text. when used in the <front> for the document's boilerplate text.
o In <postal>, allow the sub-elements to be in any order. Also o In <postal>, allow the sub-elements to be in any order. Also
allow the inclusion of the new <postalLine> instead of the older allow the inclusion of the new <postalLine> instead of the older
elements. elements.
o In <section>, restrict the names of the anchors that can be used o In <section>, restrict the names of the anchors that can be used
on some types of sections. on some types of sections.
o Make <seriesInfo> a child of <front>, and deprecated it as a child o Make <seriesInfo> a child of <front>, and deprecated it as a child
of <reference>. This also deprecates some of the attributes from of <reference>.
<rfc> and moves them into <seriesInfo>.
o <t> now only contains non-block elements, so it no longer contains o <t> now only contains non-block elements, so it no longer contains
<figure> elements. <figure> elements.
o Do not generate the grammar from a DTD, but instead get it o Do not generate the grammar from a DTD, but instead get it
directly from the RELAX Next Generation (RNG) grammar [RNG]. directly from the RELAX Next Generation (RNG) grammar [RNG].
1.4. Syntax Notation 1.5. Syntax Notation
The XML vocabulary here is defined in prose, based on the RELAX NG The XML vocabulary here is defined in prose, based on the RELAX NG
schema [RNC] contained in Appendix C (specified in RELAX NG Compact schema [RNC] contained in Appendix C (specified in RELAX NG Compact
Notation (RNC)). Notation (RNC)).
Note that the schema can be used for automated validity checks, but Note that the schema can be used for automated validity checks, but
certain constraints are only described in prose (example: the certain constraints are only described in prose (example: the
conditionally required presence of the "abbrev" attribute). conditionally required presence of the "abbrev" attribute).
2. Elements 2. Elements
skipping to change at page 11, line 24 skipping to change at page 12, line 35
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26).
Content model: Content model:
In any order, but at least one of: In any order, but at least one of:
o <dl> elements (Section 2.20) o <dl> elements (Section 2.20)
o <ol> elements (Section 2.34) o <ol> elements (Section 2.34)
o <t> elements (Section 2.53) o <t> elements (Section 2.51)
o <ul> elements (Section 2.63) o <ul> elements (Section 2.63)
2.1.1. "anchor" Attribute 2.1.1. "anchor" Attribute
Document-wide unique identifier for the Abstract. Document-wide unique identifier for the Abstract.
2.2. <address> 2.2. <address>
Provides address information for the author. Provides address information for the author.
This element appears as a child element of <author> (Section 2.7). This element appears as a child element of <author> (Section 2.8) and
<contact> (Section 2.14).
Content model: Content model:
In this order: In this order:
1. One optional <postal> element (Section 2.37) 1. One optional <postal> element (Section 2.37)
2. One optional <phone> element (Section 2.36) 2. One optional <phone> element (Section 2.36)
3. One optional <facsimile> element (Section 3.2) 3. One optional <facsimile> element (Section 3.6)
4. One optional <email> element (Section 2.23) 4. Optional <email> elements (Section 2.23)
5. One optional <uri> element (Section 2.64) 5. One optional <uri> element (Section 2.64)
2.3. <annotation> 2.3. <annotation>
Provides additional prose augmenting a bibliographic reference. This Provides additional prose augmenting a bibliographic reference. This
text is intended to be shown after the rest of the generated text is intended to be shown after the rest of the generated
reference text. reference text.
This element appears as a child element of <reference> This element appears as a child element of <reference>
(Section 2.40). (Section 2.40).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <relref> elements (Section 2.44) o <relref> elements (Section 3.13)
o <spanx> elements (Section 3.7) o <spanx> elements (Section 3.15)
o <strong> elements (Section 2.50) o <strong> elements (Section 2.48)
o <sub> elements (Section 2.51) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.52) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.62) o <tt> elements (Section 2.61)
o <u> elements (Section 2.62)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.4. <area> 2.4. <area>
Provides information about the IETF area to which this document Provides information about the IETF area to which this document
relates (currently not used when generating documents). relates (currently not used when generating documents).
The value ought to be either the full name or the abbreviation of one 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>. of the IETF areas as listed on <http://www.ietf.org/iesg/area.html>.
A list of full names and abbreviations will be kept by the RFC Series A list of full names and abbreviations will be kept by the RFC Series
Editor. Editor.
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26).
Content model: only text content. Content model: only text content.
2.5. <artwork> 2.5. <artset>
This element allows for the support of alternative artwork formats.
This will allow the renderer to pick the most appropriate <artwork>
instance for its format from the alternatives present within an
<artset> element. Each of the <artwork> elements must have a "type"
attribute.
If more than one <artwork> element is found within an <artset>
element, with the same "type" attribute, the rendere could select the
first one, or possibly choose between the alternative instances based
on the output format and some quality of the alternative instances
that made one more suitable than the other for that particular
format, such as size, aspect ration, etc.
This element appears as a child element of <aside> (Section 2.7),
<blockquote> (Section 2.11), <dd> (Section 2.18), <figure>
(Section 2.25), <li> (Section 2.29), <section> (Section 2.44), <td>
(Section 2.54), and <th> (Section 2.56).
Content model:
One or more <artwork> elements (Section 2.6)
2.5.1. "anchor" Attribute
Same as for the <artwork> element (Section 2.6).
2.6. <artwork>
This element allows the inclusion of "artwork" in the document. This element allows the inclusion of "artwork" in the document.
<artwork> provides full control of horizontal whitespace and line <artwork> provides full control of horizontal whitespace and line
breaks; thus, it is used for a variety of things, such as diagrams breaks; thus, it is used for a variety of things, such as diagrams
("line art") and protocol unit diagrams. Tab characters (U+0009) ("line art") and protocol unit diagrams. Tab characters (U+0009)
inside of this element are prohibited. inside of this element are prohibited.
Alternatively, the "src" attribute allows referencing an external Alternatively, the "src" attribute allows referencing an external
graphics file, such as a vector drawing in SVG or a bitmap graphic 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 file, using a URI. In this case, the textual content acts as a
skipping to change at page 13, line 32 skipping to change at page 15, line 28
graphics or (2) prose that describes the included image in sufficient graphics or (2) prose that describes the included image in sufficient
detail. detail.
In [RFC7749], the <artwork> element was also used for source code and In [RFC7749], the <artwork> element was also used for source code and
formal languages; in v3, this is now done with <sourcecode>. formal languages; in v3, this is now done with <sourcecode>.
There are at least five ways to include SVG in artwork in Internet- There are at least five ways to include SVG in artwork in Internet-
Drafts: Drafts:
o Inline, by including all of the SVG in the content of the element, o Inline, by including all of the SVG in the content of the element,
such as: <artwork type="svg"><svg such as: <artwork type="svg"><svg xmlns="http://www.w3.org/2000/
xmlns="http://www.w3.org/2000/svg..."> svg...">
o Inline, but using XInclude (see Appendix B.1), such as: <artwork o Inline, but using XInclude (see Appendix B.1), such as: <artwork
type="svg"><xi:include href=...> type="svg"><xi:include href=...>
o As a data: URI, such as: <artwork type="svg" src="data:image/ o As a data: URI, such as: <artwork type="svg" src="data:image/
svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3..."> svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3...">
o As a URI to an external entity, such as: <artwork type="svg" o As a URI to an external entity, such as: <artwork type="svg"
src="http://www.example.com/..."> src="http://www.example.com/...">
skipping to change at page 14, line 12 skipping to change at page 16, line 8
including text artwork, but using a data: URI is probably confusing including text artwork, but using a data: URI is probably confusing
for text artwork. for text artwork.
Formatters that do pagination should attempt to keep artwork on a Formatters that do pagination should attempt to keep artwork on a
single page. This is to prevent artwork that is split across pages single page. This is to prevent artwork that is split across pages
from looking like two separate pieces of artwork. from looking like two separate pieces of artwork.
See Section 5 for a description of how to deal with issues of using See Section 5 for a description of how to deal with issues of using
"&" and "<" characters in artwork. "&" and "<" characters in artwork.
This element appears as a child element of <aside> (Section 2.6), This element appears as a child element of <artset> (Section 2.5),
<blockquote> (Section 2.10), <dd> (Section 2.18), <figure> <aside> (Section 2.7), <blockquote> (Section 2.11), <dd>
(Section 2.25), <li> (Section 2.29), <section> (Section 2.46), <td> (Section 2.18), <figure> (Section 2.25), <li> (Section 2.29),
(Section 2.56), and <th> (Section 2.58). <section> (Section 2.44), <td> (Section 2.54), and <th>
(Section 2.56).
Content model: Content model:
Either: Either:
Text Text
Or: Or:
<svg> elements (Section 4) <svg> elements (Section 4)
2.5.1. "align" Attribute 2.6.1. "align" Attribute
Controls whether the artwork appears left justified (default), Controls whether the artwork appears left justified (default),
centered, or right justified. Artwork is aligned relative to the centered, or right justified. Artwork is aligned relative to the
left margin of the document. left margin of the document.
Allowed values: Allowed values:
o "left" (default) o "left" (default)
o "center" o "center"
o "right" o "right"
2.5.2. "alt" Attribute 2.6.2. "alt" Attribute
Alternative text description of the artwork (which is more than just Alternative text description of the artwork (which is more than just
a summary or caption). When the art comes from the "src" attribute a summary or caption). When the art comes from the "src" attribute
and the format of that artwork supports alternate text, the and the format of that artwork supports alternate text, the
alternative text comes from the text of the artwork itself, not from alternative text comes from the text of the artwork itself, not from
this attribute. The contents of this attribute are important to this attribute. The contents of this attribute are important to
readers who are visually impaired, as well as those reading on readers who are visually impaired, as well as those reading on
devices that cannot show the artwork well, or at all. devices that cannot show the artwork well, or at all.
2.5.3. "anchor" Attribute 2.6.3. "anchor" Attribute
Document-wide unique identifier for this artwork. Document-wide unique identifier for this artwork.
2.5.4. "height" Attribute 2.6.4. "height" Attribute
Deprecated. Deprecated.
2.5.5. "name" Attribute 2.6.5. "name" Attribute
A filename suitable for the contents (such as for extraction to a A filename suitable for the contents (such as for extraction to a
local file). This attribute can be helpful for other kinds of tools local file). This attribute can be helpful for other kinds of tools
(such as automated syntax checkers, which work by extracting the (such as automated syntax checkers, which work by extracting the
artwork). Note that the "name" attribute does not need to be unique artwork). Note that the "name" attribute does not need to be unique
for <artwork> elements in a document. If multiple <artwork> elements for <artwork> elements in a document. If multiple <artwork> elements
have the same "name" attribute, a processing tool might assume that have the same "name" attribute, a processing tool might assume that
the elements are all fragments of a single file, and the tool can the elements are all fragments of a single file, and the tool can
collect those fragments for later processing. See Section 7 for a collect those fragments for later processing. See Section 7 for a
discussion of possible problems with the value of this attribute. discussion of possible problems with the value of this attribute.
2.5.6. "src" Attribute 2.6.6. "src" Attribute
The URI reference of a graphics file [RFC3986], or the name of a file 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 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 the contents of the graphics file. Note that the inclusion of art
with the "src" attribute depends on the capabilities of the with the "src" attribute depends on the capabilities of the
processing tool reading the XML document. Tools need to be able to processing tool reading the XML document. Tools need to be able to
handle the file: URI, and they should be able to handle http: and handle the file: URI, and they should be able to handle http: and
https: URIs as well. The prep tool will be able to handle reading https: URIs as well. The prep tool will be able to handle reading
the "src" attribute. the "src" attribute.
skipping to change at page 15, line 48 skipping to change at page 17, line 44
Processing tools must be careful to not accept dangerous values for Processing tools must be careful to not accept dangerous values for
the filename, particularly those that contain absolute references the filename, particularly those that contain absolute references
outside the current directory. Document creators should think hard outside the current directory. Document creators should think hard
before using relative URIs due to possible later problems if files before using relative URIs due to possible later problems if files
move around on the disk. Also, documents should most likely use move around on the disk. Also, documents should most likely use
explicit URI schemes wherever possible. explicit URI schemes wherever possible.
In some cases, the prep tool may remove the "src" attribute after In some cases, the prep tool may remove the "src" attribute after
processing its value. See [RFC7998] for a description of this. processing its value. See [RFC7998] for a description of this.
It is an error to have both a "src" attribute and content in the 2.6.7. "type" Attribute
<artwork> element.
2.5.7. "type" Attribute
Specifies the type of the artwork. The value of this attribute is Specifies the type of the artwork. The value of this attribute is
free text with certain values designated as preferred. free text with certain values designated as preferred.
The preferred values for <artwork> types are: The preferred values for <artwork> types are:
o ascii-art o ascii-art
o binary-art o binary-art
o call-flow o call-flow
o hex-dump o hex-dump
o svg o svg
The RFC Series Editor will maintain a complete list of the preferred The RFC Series Editor will maintain a complete list of the preferred
values on the RFC Editor web site, and that list is expected to be values on the RFC Editor web site, and that list is expected to be
updated over time. Thus, a consumer of v3 XML should not cause a updated over time. Thus, a consumer of v3 XML should not cause a
failure when it encounters an unexpected type or no type is failure when it encounters an unexpected type or no type is
specified. The table will also indicate which type of art can appear specified. The table will also indicate which type of art can appear
in plain-text output (for example, type="svg" cannot). in plain-text output (for example, type="svg" cannot).
2.5.8. "width" Attribute 2.6.8. "width" Attribute
Deprecated. Deprecated.
2.5.9. "xml:space" Attribute 2.6.9. "xml:space" Attribute
Deprecated. Deprecated.
2.6. <aside> 2.7. <aside>
This element is a container for content that is semantically less This element is a container for content that is semantically less
important or tangential to the content that surrounds it. important or tangential to the content that surrounds it.
This element appears as a child element of <section> (Section 2.46). This element appears as a child element of <dd> (Section 2.18), <li>
(Section 2.29), and <section> (Section 2.44).
Content model: Content model:
In any order: In any order:
o <artwork> elements (Section 2.5) o <artset> elements (Section 2.5)
o <artwork> elements (Section 2.6)
o <blockquote> elements (Section 2.11)
o <dl> elements (Section 2.20) o <dl> elements (Section 2.20)
o <figure> elements (Section 2.25) o <figure> elements (Section 2.25)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <list> elements (Section 3.4)
o <ol> elements (Section 2.34) o <ol> elements (Section 2.34)
o <t> elements (Section 2.51)
o <t> elements (Section 2.53) o <table> elements (Section 2.52)
o <table> elements (Section 2.54)
o <ul> elements (Section 2.63) o <ul> elements (Section 2.63)
2.6.1. "anchor" Attribute 2.7.1. "anchor" Attribute
Document-wide unique identifier for this aside. Document-wide unique identifier for this aside.
2.7. <author> 2.8. <author>
Provides information about a document's author. This is used both Provides information about a document's author. This is used both
for the document itself (at the beginning of the document) and for for the document itself (at the beginning of the document) and for
referenced documents. referenced documents.
The <author> elements contained within the document's <front> element The <author> elements contained within the document's <front> element
are used to fill the boilerplate and also to generate the "Author's are used to fill the boilerplate and also to generate the "Author's
Address" section (see [RFC7322]). Address" section (see [RFC7322]).
Note that an "author" can also be just an organization (by not Note that an "author" can also be just an organization (by not
specifying any of the "name" attributes, but adding the specifying any of the "name" attributes, but adding the
<organization> child element). <organization> child element).
Furthermore, the "role" attribute can be used to mark an author as Furthermore, the "role" attribute can be used to mark an author as
"editor". This is reflected both on the front page and in the "editor". This is reflected both on the front page and in the
"Author's Address" section, as well as in bibliographic references. "Author's Address" section, as well as in bibliographic references.
Note that this specification does not define a precise meaning for Note that this specification does not define a precise meaning for
the term "editor". the term "editor".
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26) and
<section> (Section 2.44).
Content model: Content model:
In this order: In this order:
1. One optional <organization> element (Section 2.35) 1. One optional <organization> element (Section 2.35)
2. One optional <address> element (Section 2.2) 2. One optional <address> element (Section 2.2)
2.7.1. "asciiFullname" Attribute 2.8.1. "anchor" Attribute
Document-wide unique identifier for this <author> element.
2.8.2. "asciiFullname" Attribute
The ASCII equivalent of the author's full name. The ASCII equivalent of the author's full name.
2.7.2. "asciiInitials" Attribute 2.8.3. "asciiInitials" Attribute
The ASCII equivalent of the author's initials, to be used in The ASCII equivalent of the author's initials, to be used in
conjunction with the separately specified asciiSurname. conjunction with the separately specified asciiSurname.
2.7.3. "asciiSurname" Attribute 2.8.4. "asciiSurname" Attribute
The ASCII equivalent of the author's surname, to be used in The ASCII equivalent of the author's surname, to be used in
conjunction with the separately specified asciiInitials. conjunction with the separately specified asciiInitials.
2.7.4. "fullname" Attribute 2.8.5. "fullname" Attribute
The full name (used in the automatically generated "Author's Address" The full name (used in the automatically generated "Author's Address"
section). Although this attribute is optional, if one or more of the section). Although this attribute is optional, if one or more of the
"asciiFullname", "asciiInitials", or "asciiSurname" attributes have "asciiFullname", "asciiInitials", or "asciiSurname" attributes have
values, the "fullname" attribute is required. values, the "fullname" attribute is required.
2.7.5. "initials" Attribute 2.8.6. "initials" Attribute
An abbreviated variant of the given name(s), to be used in An abbreviated variant of the given name(s), to be used in
conjunction with the separately specified surname. It usually conjunction with the separately specified surname. It usually
appears on the front page, in footers, and in references. appears on the front page, in footers, and in references.
Some processors will post-process the value -- for instance, when it Some processors will post-process the value -- for instance, when it
only contains a single letter (in which case they might add a only contains a single letter (in which case they might add a
trailing dot). Relying on this kind of post-processing can lead to trailing dot). Relying on this kind of post-processing can lead to
results varying across formatters and thus ought to be avoided. results varying across formatters and thus ought to be avoided.
2.7.6. "role" Attribute 2.8.7. "role" Attribute
Specifies the role the author had in creating the document. Specifies the role the author had in creating the document.
Allowed value: 2.8.8. "surname" Attribute
o "editor"
2.7.7. "surname" Attribute
The author's surname, to be used in conjunction with the separately The author's surname, to be used in conjunction with the separately
specified initials. It usually appears on the front page, in specified initials. It usually appears on the front page, in
footers, and in references. footers, and in references.
2.8. <back> 2.9. <back>
Contains the "back" part of the document: the references and Contains the "back" part of the document: the references and
appendices. In <back>, <section> elements indicate appendices. appendices. In <back>, <section> elements indicate appendices.
This element appears as a child element of <rfc> (Section 2.45). This element appears as a child element of <rfc> (Section 2.43).
Content model: Content model:
In this order: In this order:
1. Optional <displayreference> elements (Section 2.19) 1. Optional <displayreference> elements (Section 2.19)
2. Optional <references> elements (Section 2.42) 2. Optional <references> elements (Section 2.42)
3. Optional <section> elements (Section 2.46) 3. Optional <section> elements (Section 2.44)
2.9. <bcp14> 2.10. <bcp14>
Marks text that are phrases defined in [BCP14] such as "MUST", Marks text that are phrases defined in [BCP14] such as "MUST",
"SHOULD NOT", and so on. When shown in some of the output "SHOULD NOT", and so on. When shown in some of the output
representations, the text in this element might be highlighted. The representations, the text in this element might be highlighted. The
use of this element is optional. use of this element is optional.
This element is only to be used around the actual phrase from BCP 14, This element is only to be used around the actual phrase from BCP 14,
not the full definition of a requirement. For example, it is correct not the full definition of a requirement. For example, it is correct
to say "The packet <bcp14>MUST</bcp14> be dropped.", but it is not to say "The packet <bcp14>MUST</bcp14> be dropped.", but it is not
correct to say "<bcp14>The packet MUST be dropped.</bcp14>". correct to say "<bcp14>The packet MUST be dropped.</bcp14>".
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <dd> (Section 2.18), <dt> (Section 2.3), <blockquote> (Section 2.11), <dd> (Section 2.18), <dt>
(Section 2.21), <em> (Section 2.22), <li> (Section 2.29), <preamble> (Section 2.21), <em> (Section 2.22), <li> (Section 2.29), <name>
(Section 3.6), <refcontent> (Section 2.39), <strong> (Section 2.50), (Section 2.32), <preamble> (Section 3.11), <refcontent>
<sub> (Section 2.51), <sup> (Section 2.52), <t> (Section 2.53), <td> (Section 2.39), <strong> (Section 2.48), <sub> (Section 2.49), <sup>
(Section 2.56), <th> (Section 2.58), and <tt> (Section 2.62). (Section 2.50), <t> (Section 2.51), <td> (Section 2.54), <th>
(Section 2.56), and <tt> (Section 2.61).
Content model: only text content. Content model: only text content.
2.10. <blockquote> 2.11. <blockquote>
Specifies that a block of text is a quotation. Specifies that a block of text is a quotation.
This element appears as a child element of <section> (Section 2.46). This element appears as a child element of <aside> (Section 2.7),
<dd> (Section 2.18), <li> (Section 2.29), and <section>
(Section 2.44).
Content model: Content model:
Either: Either:
In any order, but at least one of: In any order, but at least one of:
* <artwork> elements (Section 2.5) * <artset> elements (Section 2.5)
* <artwork> elements (Section 2.6)
* <dl> elements (Section 2.20) * <dl> elements (Section 2.20)
* <figure> elements (Section 2.25) * <figure> elements (Section 2.25)
* <ol> elements (Section 2.34) * <ol> elements (Section 2.34)
* <sourcecode> elements (Section 2.48) * <sourcecode> elements (Section 2.46)
* <t> elements (Section 2.53) * <t> elements (Section 2.51)
* <ul> elements (Section 2.63) * <ul> elements (Section 2.63)
Or: Or:
In any order, but at least one of: In any order, but at least one of:
* Text * Text
* <bcp14> elements (Section 2.9) * <bcp14> elements (Section 2.10)
* <br> elements (Section 2.13)
* <cref> elements (Section 2.16) * <cref> elements (Section 2.16)
* <em> elements (Section 2.22) * <em> elements (Section 2.22)
* <eref> elements (Section 2.24) * <eref> elements (Section 2.24)
* <iref> elements (Section 2.27) * <iref> elements (Section 2.27)
* <relref> elements (Section 2.44) * <relref> elements (Section 3.13)
* <strong> elements (Section 2.50) * <strong> elements (Section 2.48)
* <sub> elements (Section 2.51) * <sub> elements (Section 2.49)
* <sup> elements (Section 2.52) * <sup> elements (Section 2.50)
* <tt> elements (Section 2.62) * <tt> elements (Section 2.61)
* <u> elements (Section 2.62)
* <xref> elements (Section 2.66) * <xref> elements (Section 2.66)
2.10.1. "anchor" Attribute 2.11.1. "anchor" Attribute
Document-wide unique identifier for this quotation. Document-wide unique identifier for this quotation.
2.10.2. "cite" Attribute 2.11.2. "cite" Attribute
The source of the citation. This must be a URI. If the "quotedFrom" The source of the citation. This must be a URI. If the "quotedFrom"
attribute is given, this URI will be used by processing tools as the attribute is given, this URI will be used by processing tools as the
link for the text of that attribute. link for the text of that attribute.
2.10.3. "quotedFrom" Attribute 2.11.3. "quotedFrom" Attribute
Name of person or document the text in this element is quoted from. Name of person or document the text in this element is quoted from.
A formatter should render this as visible text at the end of the A formatter should render this as visible text at the end of the
quotation. quotation.
2.11. <boilerplate> 2.12. <boilerplate>
Holds the boilerplate text for the document. This element is filled Holds the boilerplate text for the document. This element is filled
in by the prep tool. in by the prep tool.
This element contains <section> elements. Every <section> element in This element contains <section> elements. Every <section> element in
this element must have the "numbered" attribute set to "false". this element must have the "numbered" attribute set to "false".
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26).
Content model: Content model:
One or more <section> elements (Section 2.46) One or more <section> elements (Section 2.44)
2.12. <br> 2.13. <br>
Indicates that a line break should be inserted in the generated [[CREF1: Forces a line break. Since the layout and column widths of
output by a formatting tool. Multiple successive instances of this a document vary from one rendering to another, authors should use
element are ignored. this element sparingly and consider its effect in all of the likely
renderings. In some cases a U+200B, ZERO WIDTH SPACE character as a
hint as a place where a block of text might be broken is a better
choice.]]
This element appears as a child element of <td> (Section 2.56) and This element appears as a child element of <blockquote>
<th> (Section 2.58). (Section 2.11), <cref> (Section 2.16), <dd> (Section 2.18), <dt>
(Section 2.21), <em> (Section 2.22), <li> (Section 2.29), <name>
(Section 2.32), <strong> (Section 2.48), <t> (Section 2.51), <td>
(Section 2.54), <th> (Section 2.56), <title> (Section 2.58), and <tt>
(Section 2.61).
Content model: this element does not have any contents. Content model: this element does not have any contents.
2.13. <city> 2.14. <contact>
Gives the city name in a postal address. Provides information about a contact, such as a contributor to be
mentioned in an "Acknowledgements" section.
This element appears as a child element of <postal> (Section 2.37). This element appears as a child element of <section> (Section 2.44)
and <t> (Section 2.51).
Content model: only text content. Content model:
2.13.1. "ascii" Attribute In this order:
The ASCII equivalent of the city name. 1. One optional <organization> element (Section 2.35)
2.14. <code> 2. One optional <address> element (Section 2.2)
Gives the postal region code. 2.14.1. "anchor" Attribute
This element appears as a child element of <postal> (Section 2.37). Document-wide unique identifier for this comment.
Content model: only text content. 2.14.2. "asciiFullname" Attribute
2.14.1. "ascii" Attribute See the corresponding attribute on <author> element (Section 2.8.2).
The ASCII equivalent of the postal code. 2.14.3. "asciiInitials" Attribute
See the corresponding attribute on <author> element (Section 2.8.3).
2.14.4. "asciiSurname" Attribute
See the corresponding attribute on <author> element (Section 2.8.4).
2.14.5. "fullname" Attribute
See the corresponding attribute on <author> element (Section 2.8.5).
2.14.6. "initials" Attribute
See the corresponding attribute on <author> element (Section 2.8.6).
2.14.7. "surname" Attribute
See the corresponding attribute on <author> element (Section 2.8.8).
2.15. <country> 2.15. <country>
Gives the country name or code in a postal address. Gives the country name or code in a postal address.
This element appears as a child element of <postal> (Section 2.37). This element appears as a child element of <postal> (Section 2.37).
Content model: only text content. Content model: only text content.
2.15.1. "ascii" Attribute 2.15.1. "ascii" Attribute
skipping to change at page 22, line 42 skipping to change at page 25, line 30
2.16. <cref> 2.16. <cref>
Represents a comment. Represents a comment.
Comments can be used in a document while it is work in progress. Comments can be used in a document while it is work in progress.
They might appear either inline and visually highlighted, at the end They might appear either inline and visually highlighted, at the end
of the document, or not at all, depending on the formatting tool. of the document, or not at all, depending on the formatting tool.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <c> (Section 3.1), <dd> (Section 2.3), <blockquote> (Section 2.11), <c> (Section 3.1), <dd>
(Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
(Section 2.29), <name> (Section 2.32), <postamble> (Section 3.5), (Section 2.29), <name> (Section 2.32), <postamble> (Section 3.10),
<preamble> (Section 3.6), <strong> (Section 2.50), <sub> <preamble> (Section 3.11), <strong> (Section 2.48), <sub>
(Section 2.51), <sup> (Section 2.52), <t> (Section 2.53), <td> (Section 2.49), <sup> (Section 2.50), <t> (Section 2.51), <td>
(Section 2.56), <th> (Section 2.58), <tt> (Section 2.62), and <ttcol> (Section 2.54), <th> (Section 2.56), <tt> (Section 2.61), and <ttcol>
(Section 3.9). (Section 3.18).
Content model: Content model:
In any order: In any order:
o Text o Text
o <br> elements (Section 2.13)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <relref> elements (Section 2.44) o <relref> elements (Section 3.13)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51) o <strong> elements (Section 2.48)
o <sub> elements (Section 2.49)
o <sup> elements (Section 2.52) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.62) o <tt> elements (Section 2.61)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.16.1. "anchor" Attribute 2.16.1. "anchor" Attribute
Document-wide unique identifier for this comment. Document-wide unique identifier for this comment.
2.16.2. "display" Attribute 2.16.2. "display" Attribute
Suggests whether or not the comment should be displayed by formatting Suggests whether or not the comment should be displayed by formatting
tools. This might be set to "false" if you want to keep a comment in tools. This might be set to "false" if you want to keep a comment in
a document after the contents of the comment have already been dealt a document after the contents of the comment have already been dealt
with. with.
Cross-referencing (Section 2.66) a comment with "display" set to
"false" is an error.
Allowed values: Allowed values:
o "true" (default) o "true" (default)
o "false" o "false"
2.16.3. "source" Attribute 2.16.3. "source" Attribute
Holds the "source" of a comment, such as the name or the initials of Holds the "source" of a comment, such as the name or the initials of
the person who made the comment. the person who made the comment.
skipping to change at page 24, line 26 skipping to change at page 27, line 18
When the prep tool is used to create Internet-Drafts, it will When the prep tool is used to create Internet-Drafts, it will
reject a submitted Internet-Draft that has a <date> element in the reject a submitted Internet-Draft that has a <date> element in the
boilerplate for itself that is anything other than today. That boilerplate for itself that is anything other than today. That
is, the tool will not allow a submitter to specify a date other is, the tool will not allow a submitter to specify a date other
than the day of submission. To avoid this problem, authors might than the day of submission. To avoid this problem, authors might
simply not include a <date> element in the boilerplate. simply not include a <date> element in the boilerplate.
Bibliographic references: In dates in <reference> elements, the date Bibliographic references: In dates in <reference> elements, the date
information can have prose text for the month or year. For information can have prose text for the month or year. For
example, vague dates (year="ca. 2000"), date ranges (year="2012- example, vague dates (year="ca. 2000"), date ranges
2013"), non-specific months (month="Second quarter"), and so on (year="2012-2013"), non-specific months (month="Second quarter"),
are allowed. and so on are allowed.
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26).
Content model: this element does not have any contents. Content model: only text content.
2.17.1. "day" Attribute 2.17.1. "day" Attribute
The day of publication. The day of publication.
2.17.2. "month" Attribute 2.17.2. "month" Attribute
The month or months of publication. The month or months of publication.
2.17.3. "year" Attribute 2.17.3. "year" Attribute
skipping to change at page 25, line 9 skipping to change at page 27, line 50
The definition part of an entry in a definition list. The definition part of an entry in a definition list.
This element appears as a child element of <dl> (Section 2.20). This element appears as a child element of <dl> (Section 2.20).
Content model: Content model:
Either: Either:
In any order, but at least one of: In any order, but at least one of:
* <artwork> elements (Section 2.5) * <artset> elements (Section 2.5)
* <artwork> elements (Section 2.6)
* <aside> elements (Section 2.7)
* <blockquote> elements (Section 2.11)
* <dl> elements (Section 2.20) * <dl> elements (Section 2.20)
* <figure> elements (Section 2.25) * <figure> elements (Section 2.25)
* <ol> elements (Section 2.34) * <ol> elements (Section 2.34)
* <sourcecode> elements (Section 2.48) * <sourcecode> elements (Section 2.46)
* <t> elements (Section 2.53) * <t> elements (Section 2.51)
* <table> elements (Section 2.52)
* <ul> elements (Section 2.63) * <ul> elements (Section 2.63)
Or: Or:
In any order, but at least one of: In any order, but at least one of:
* Text * Text
* <bcp14> elements (Section 2.9) * <bcp14> elements (Section 2.10)
* <br> elements (Section 2.13)
* <cref> elements (Section 2.16) * <cref> elements (Section 2.16)
* <em> elements (Section 2.22) * <em> elements (Section 2.22)
* <eref> elements (Section 2.24) * <eref> elements (Section 2.24)
* <iref> elements (Section 2.27) * <iref> elements (Section 2.27)
* <relref> elements (Section 2.44) * <relref> elements (Section 3.13)
* <strong> elements (Section 2.50) * <strong> elements (Section 2.48)
* <sub> elements (Section 2.51) * <sub> elements (Section 2.49)
* <sup> elements (Section 2.50)
* <sup> elements (Section 2.52) * <tt> elements (Section 2.61)
* <u> elements (Section 2.62)
* <tt> elements (Section 2.62)
* <xref> elements (Section 2.66) * <xref> elements (Section 2.66)
2.18.1. "anchor" Attribute 2.18.1. "anchor" Attribute
Document-wide unique identifier for this definition. Document-wide unique identifier for this definition.
2.19. <displayreference> 2.19. <displayreference>
This element gives a mapping between the anchor of a reference and a This element gives a mapping between the anchor of a reference and a
name that will be displayed instead. This allows authors to display name that will be displayed instead. This allows authors to display
skipping to change at page 26, line 25 skipping to change at page 29, line 31
The mapping in this element only applies to <xref> elements whose The mapping in this element only applies to <xref> elements whose
format is "default". For example, if the reference uses the anchor format is "default". For example, if the reference uses the anchor
"RFC6949", the following would cause that anchor in the body of "RFC6949", the following would cause that anchor in the body of
displayed documents to be "RFC-dev": displayed documents to be "RFC-dev":
<displayreference target="RFC6949" to="RFC-dev"/> <displayreference target="RFC6949" to="RFC-dev"/>
If a reference section is sorted, this element changes the sort If a reference section is sorted, this element changes the sort
order. order.
It is expected that this element will only be valid in input Prep tools add a "derivedAnchor" attribute to the corresponding
documents. It will likely be removed by prep tools when preparing a <reference> element with the display anchor.
final version after those tools have replaced all of the associated
anchors, targets, and "derivedContent" attributes.
This element appears as a child element of <back> (Section 2.8). This element appears as a child element of <back> (Section 2.9).
Content model: this element does not have any contents. Content model: this element does not have any contents.
2.19.1. "target" Attribute (Mandatory) 2.19.1. "target" Attribute (Mandatory)
This attribute must be the name of an anchor in a <reference> or This attribute must be the name of an anchor in a <reference> or
<referencegroup> element. <referencegroup> element.
2.19.2. "to" Attribute (Mandatory) 2.19.2. "to" Attribute (Mandatory)
skipping to change at page 27, line 8 skipping to change at page 30, line 13
".", or "_". ".", or "_".
2.20. <dl> 2.20. <dl>
A definition list. Each entry has a pair of elements: a term (<dt>) A definition list. Each entry has a pair of elements: a term (<dt>)
and a definition (<dd>). (This is slightly different and simpler and a definition (<dd>). (This is slightly different and simpler
than the model used in HTML, which allows for multiple terms for a than the model used in HTML, which allows for multiple terms for a
single definition.) single definition.)
This element appears as a child element of <abstract> (Section 2.1), This element appears as a child element of <abstract> (Section 2.1),
<aside> (Section 2.6), <blockquote> (Section 2.10), <dd> <aside> (Section 2.7), <blockquote> (Section 2.11), <dd>
(Section 2.18), <li> (Section 2.29), <note> (Section 2.33), <section> (Section 2.18), <li> (Section 2.29), <note> (Section 2.33), <section>
(Section 2.46), <td> (Section 2.56), and <th> (Section 2.58). (Section 2.44), <td> (Section 2.54), and <th> (Section 2.56).
Content model: Content model:
One or more sequences of: One or more sequences of:
1. One <dt> element 1. One <dt> element
2. One <dd> element 2. One <dd> element
2.20.1. "anchor" Attribute 2.20.1. "anchor" Attribute
Document-wide unique identifier for the list. Document-wide unique identifier for the list.
2.20.2. "hanging" Attribute 2.20.2. "indent" Attribute
The "hanging" attribute defines whether or not the term appears on Default value: 3
the same line as the definition. hanging="true" indicates that the
term is to the left of the definition, while hanging="false"
indicates that the term will be on a separate line.
Allowed values: Indicates the indentation to be used for the rendering of the second
and following lines of the item (the first line starts with the term,
and is not indented). The indentation amount is interpreted as
characters when rendering plain-text documents, and en-space units
when rendering in formats that have richer typographic support such
as HTML or PDF. One en-space is assumed to be the length of 0.5 em-
space in CSS units.
o "false" 2.20.3. "newline" Attribute
o "true" (default) The "newline" attribute defines whether or not the term appears on
the same line as the definition. newline="false" indicates that the
term is to the left of the definition, while newline="true" indicates
that the term will be on a separate line.
2.20.3. "spacing" Attribute Allowed values:
o "false" (default)
o "true"
2.20.4. "spacing" Attribute
Defines whether or not there is a blank line between entries. Defines whether or not there is a blank line between entries.
spacing="normal" indicates a single blank line, while spacing="normal" indicates a single blank line, while
spacing="compact" indicates no space between. spacing="compact" indicates no space between.
Allowed values: Allowed values:
o "normal" (default) o "normal" (default)
o "compact" o "compact"
2.21. <dt> 2.21. <dt>
The term being defined in a definition list. The term being defined in a definition list.
This element appears as a child element of <dl> (Section 2.20). This element appears as a child element of <dl> (Section 2.20).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.10)
o <bcp14> elements (Section 2.9) o <br> elements (Section 2.13)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <relref> elements (Section 3.13)
o <relref> elements (Section 2.44) o <strong> elements (Section 2.48)
o <sub> elements (Section 2.49)
o <strong> elements (Section 2.50) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.61)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.21.1. "anchor" Attribute 2.21.1. "anchor" Attribute
Document-wide unique identifier for this term. Document-wide unique identifier for this term.
2.22. <em> 2.22. <em>
Indicates text that is semantically emphasized. Text enclosed within Indicates text that is semantically emphasized. Text enclosed within
this element will be displayed as italic after processing. This this element will be displayed as italic after processing. This
element can be combined with other character formatting elements, and element can be combined with other character formatting elements, and
the formatting will be additive. the formatting will be additive.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16), (Section 2.3), <blockquote> (Section 2.11), <cref> (Section 2.16),
<dd> (Section 2.18), <dt> (Section 2.21), <li> (Section 2.29), <dd> (Section 2.18), <dt> (Section 2.21), <li> (Section 2.29), <name>
<preamble> (Section 3.6), <refcontent> (Section 2.39), <strong> (Section 2.32), <preamble> (Section 3.11), <refcontent>
(Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52), <t> (Section 2.39), <strong> (Section 2.48), <sub> (Section 2.49), <sup>
(Section 2.53), <td> (Section 2.56), <th> (Section 2.58), and <tt> (Section 2.50), <t> (Section 2.51), <td> (Section 2.54), <th>
(Section 2.62). (Section 2.56), <tt> (Section 2.61), and <xref> (Section 2.66).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.10)
o <bcp14> elements (Section 2.9) o <br> elements (Section 2.13)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <relref> elements (Section 3.13)
o <relref> elements (Section 2.44) o <strong> elements (Section 2.48)
o <sub> elements (Section 2.49)
o <strong> elements (Section 2.50) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.61)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.23. <email> 2.23. <email>
Provides an email address. Provides an email address.
The value is expected to be the addr-spec defined in Section 2 of The value is expected to be the addr-spec defined in Section 2 of
[RFC6068]. [RFC6068].
This element appears as a child element of <address> (Section 2.2). This element appears as a child element of <address> (Section 2.2).
skipping to change at page 30, line 20 skipping to change at page 33, line 10
If the <eref> element has non-empty text content, formatters should If the <eref> element has non-empty text content, formatters should
use the content as the displayed text that is linked. Otherwise, the use the content as the displayed text that is linked. Otherwise, the
formatter should use the value of the "target" attribute as the formatter should use the value of the "target" attribute as the
displayed text. Formatters will link the displayed text to the value displayed text. Formatters will link the displayed text to the value
of the "target" attribute in a manner appropriate for the output of the "target" attribute in a manner appropriate for the output
format. format.
For example, with an input of: For example, with an input of:
This is described at This is described at
<eref target="http://www.example.com/reports/r12.html"/>. <eref target="http://www.example.com/reports/r12.html"/>.
An HTML formatter might generate: An HTML formatter might generate:
This is described at This is described at
<a href="http://www.example.com/reports/r12.html"> <a href="http://www.example.com/reports/r12.html">
http://www.example.com/reports/r12.html</a>. http://www.example.com/reports/r12.html</a>.
With an input of: With an input of:
This is described This is described
<eref target="http://www.example.com/reports/r12.html"> <eref target="http://www.example.com/reports/r12.html">
in this interesting report</eref>. in this interesting report</eref>.
An HTML formatter might generate: An HTML formatter might generate:
This is described This is described
<a href="http://www.example.com/reports/r12.html"> <a href="http://www.example.com/reports/r12.html">
in this interesting report</a>. in this interesting report</a>.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <c> (Section 3.1), <cref> (Section 2.3), <blockquote> (Section 2.11), <c> (Section 3.1), <cref>
(Section 2.16), <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.16), <dd> (Section 2.18), <dt> (Section 2.21), <em>
(Section 2.22), <li> (Section 2.29), <name> (Section 2.32), (Section 2.22), <li> (Section 2.29), <name> (Section 2.32),
<postamble> (Section 3.5), <preamble> (Section 3.6), <strong> <postamble> (Section 3.10), <preamble> (Section 3.11), <strong>
(Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52), <t> (Section 2.48), <sub> (Section 2.49), <sup> (Section 2.50), <t>
(Section 2.53), <td> (Section 2.56), <th> (Section 2.58), <tt> (Section 2.51), <td> (Section 2.54), <th> (Section 2.56), <tt>
(Section 2.62), and <ttcol> (Section 3.9). (Section 2.61), and <ttcol> (Section 3.18).
Content model: only text content. Content model: only text content.
2.24.1. "target" Attribute (Mandatory) 2.24.1. "brackets" Attribute
Determines whether the formatter should automatically enclose the URI
in angle brackets ("angle") or not (default of "none").
Allowed values:
o "none" (default)
o "angle"
2.24.2. "target" Attribute (Mandatory)
URI of the link target [RFC3986]. This must begin with a scheme name URI of the link target [RFC3986]. This must begin with a scheme name
(such as "https://") and thus not be relative to the URL of the (such as "https://") and thus not be relative to the URL of the
current document. current document.
2.25. <figure> 2.25. <figure>
Contains a figure with a caption with the figure number. If the Contains a figure with a caption with the figure number. If the
element contains a <name> element, the caption will also show that element contains a <name> element, the caption will also show that
name. name.
This element appears as a child element of <aside> (Section 2.6), This element appears as a child element of <aside> (Section 2.7),
<blockquote> (Section 2.10), <dd> (Section 2.18), <li> <blockquote> (Section 2.11), <dd> (Section 2.18), <li>
(Section 2.29), <section> (Section 2.46), <td> (Section 2.56), and (Section 2.29), <section> (Section 2.44), <td> (Section 2.54), and
<th> (Section 2.58). <th> (Section 2.56).
Content model: Content model:
In this order: In this order:
1. One optional <name> element (Section 2.32) 1. One optional <name> element (Section 2.32)
2. Optional <iref> elements (Section 2.27) 2. Optional <iref> elements (Section 2.27)
3. One optional <preamble> element (Section 3.11)
3. One optional <preamble> element (Section 3.6)
4. In any order, but at least one of: 4. In any order, but at least one of:
* <artwork> elements (Section 2.5) * <artset> elements (Section 2.5)
* <artwork> elements (Section 2.6)
* <sourcecode> elements (Section 2.48) * <sourcecode> elements (Section 2.46)
5. One optional <postamble> element (Section 3.5) 5. One optional <postamble> element (Section 3.10)
2.25.1. "align" Attribute 2.25.1. "align" Attribute
Deprecated. Deprecated.
Note: does not affect title or <artwork> alignment. Note: does not affect title or <artwork> alignment.
Allowed values: Allowed values:
o "left" (default) o "left" (default)
skipping to change at page 32, line 5 skipping to change at page 34, line 47
2.25.1. "align" Attribute 2.25.1. "align" Attribute
Deprecated. Deprecated.
Note: does not affect title or <artwork> alignment. Note: does not affect title or <artwork> alignment.
Allowed values: Allowed values:
o "left" (default) o "left" (default)
o "center" o "center"
o "right" o "right"
2.25.2. "alt" Attribute 2.25.2. "alt" Attribute
Deprecated. If the goal is to provide a single URI for a reference, Deprecated - use "alt" attribute on <artwork> element instead
use the "target" attribute in <reference> instead. (Section 2.6.2).
2.25.3. "anchor" Attribute 2.25.3. "anchor" Attribute
Document-wide unique identifier for this figure. Document-wide unique identifier for this figure.
2.25.4. "height" Attribute 2.25.4. "height" Attribute
Deprecated. Deprecated - use "height" attribute on <artwork> element instead
(Section 2.6.4).
2.25.5. "src" Attribute 2.25.5. "src" Attribute
Deprecated. Deprecated - use "src" attribute on <artwork> element instead
(Section 2.6.6).
2.25.6. "suppress-title" Attribute 2.25.6. "suppress-title" Attribute
Deprecated. Deprecated.
Allowed values: Allowed values:
o "true" o "true"
o "false" (default) o "false" (default)
2.25.7. "title" Attribute 2.25.7. "title" Attribute
Deprecated. Use <name> instead. Deprecated. Use <name> instead.
2.25.8. "width" Attribute 2.25.8. "width" Attribute
Deprecated. Deprecated - use "width" attribute on <artwork> element instead
(Section 2.6.8).
2.26. <front> 2.26. <front>
Represents the "front matter": metadata (such as author information), Represents the "front matter": metadata (such as author information),
the Abstract, and additional notes. the Abstract, and additional notes.
A <front> element may have more than one <seriesInfo> element. A
<seriesInfo> element determines the document number (for RFCs) or
name (for Internet-Drafts). Another <seriesInfo> element determines
the "maturity level" (defined in [RFC2026]), using values of "std"
for "Standards Track", "bcp" for "BCP", "info" for "Informational",
"exp" for "Experimental", and "historic" for "Historic". The "name"
attributes of those multiple <seriesInfo> elements interact as
described in Section 2.47.
This element appears as a child element of <reference> (Section 2.40) This element appears as a child element of <reference> (Section 2.40)
and <rfc> (Section 2.45). and <rfc> (Section 2.43).
Content model: Content model:
In this order: In this order:
1. One <title> element (Section 2.60) 1. One <title> element (Section 2.58)
2. Optional <seriesInfo> elements (Section 2.45)
2. Optional <seriesInfo> elements (Section 2.47) 3. One or more <author> elements (Section 2.8)
3. One or more <author> elements (Section 2.7)
4. One optional <date> element (Section 2.17) 4. One optional <date> element (Section 2.17)
5. Optional <area> elements (Section 2.4) 5. Optional <area> elements (Section 2.4)
6. Optional <workgroup> elements (Section 2.65) 6. Optional <workgroup> elements (Section 2.65)
7. Optional <keyword> elements (Section 2.28) 7. Optional <keyword> elements (Section 2.28)
8. One optional <abstract> element (Section 2.1) 8. One optional <abstract> element (Section 2.1)
9. Optional <note> elements (Section 2.33) 9. Optional <note> elements (Section 2.33)
10. One optional <boilerplate> element (Section 2.12)
10. One optional <boilerplate> element (Section 2.11) 11. One optional <toc> element (Section 2.59)
2.27. <iref> 2.27. <iref>
Provides terms for the document's index. Provides terms for the document's index.
Index entries can be either regular entries (when just the "item" Index entries can be either regular entries (when just the "item"
attribute is given) or nested entries (by specifying "subitem" as attribute is given) or nested entries (by specifying "subitem" as
well), grouped under a regular entry. well), grouped under a regular entry.
Index entries generally refer to the exact place where the <iref> Index entries generally refer to the exact place where the <iref>
element occurred. An exception is the occurrence as a child element element occurred. An exception is the occurrence as a child element
of <section>, in which case the whole section is considered to be of <section>, in which case the whole section is considered to be
relevant for that index entry. In some formats, index entries of relevant for that index entry. In some formats, index entries of
this type might be displayed as ranges. this type might be displayed as ranges.
When the prep tool is creating index content, it collects the items When the prep tool is creating index content, it preserves the case
in a case-sensitive fashion for both the item and subitem level. of each item and subitem. The index is sorted in conventional
alphabetical order disregarding case.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <aside> (Section 2.6), <blockquote> (Section 2.10), (Section 2.3), <aside> (Section 2.7), <blockquote> (Section 2.11),
<c> (Section 3.1), <dd> (Section 2.18), <dt> (Section 2.21), <em> <c> (Section 3.1), <dd> (Section 2.18), <dt> (Section 2.21), <em>
(Section 2.22), <figure> (Section 2.25), <li> (Section 2.29), (Section 2.22), <figure> (Section 2.25), <li> (Section 2.29), <name>
<postamble> (Section 3.5), <preamble> (Section 3.6), <section> (Section 2.32), <postamble> (Section 3.10), <preamble>
(Section 2.46), <strong> (Section 2.50), <sub> (Section 2.51), <sup> (Section 3.11), <section> (Section 2.44), <strong> (Section 2.48),
(Section 2.52), <t> (Section 2.53), <table> (Section 2.54), <td> <sub> (Section 2.49), <sup> (Section 2.50), <t> (Section 2.51),
(Section 2.56), <th> (Section 2.58), <tt> (Section 2.62), and <ttcol> <table> (Section 2.52), <td> (Section 2.54), <th> (Section 2.56),
(Section 3.9). <tt> (Section 2.61), and <ttcol> (Section 3.18).
Content model: this element does not have any contents. Content model: this element does not have any contents.
2.27.1. "item" Attribute (Mandatory) 2.27.1. "item" Attribute (Mandatory)
The item to include. The item to include.
2.27.2. "primary" Attribute 2.27.2. "primary" Attribute
Setting this to "true" declares the occurrence as "primary", which Setting this to "true" declares the occurrence as "primary", which
skipping to change at page 35, line 18 skipping to change at page 37, line 47
This element appears as a child element of <ol> (Section 2.34) and This element appears as a child element of <ol> (Section 2.34) and
<ul> (Section 2.63). <ul> (Section 2.63).
Content model: Content model:
Either: Either:
In any order, but at least one of: In any order, but at least one of:
* <artwork> elements (Section 2.5) * <artset> elements (Section 2.5)
* <artwork> elements (Section 2.6)
* <aside> elements (Section 2.7)
* <blockquote> elements (Section 2.11)
* <dl> elements (Section 2.20) * <dl> elements (Section 2.20)
* <figure> elements (Section 2.25) * <figure> elements (Section 2.25)
* <ol> elements (Section 2.34) * <ol> elements (Section 2.34)
* <sourcecode> elements (Section 2.46)
* <sourcecode> elements (Section 2.48) * <t> elements (Section 2.51)
* <table> elements (Section 2.52)
* <t> elements (Section 2.53)
* <ul> elements (Section 2.63) * <ul> elements (Section 2.63)
Or: Or:
In any order, but at least one of: In any order, but at least one of:
* Text * Text
* <bcp14> elements (Section 2.10)
* <bcp14> elements (Section 2.9) * <br> elements (Section 2.13)
* <cref> elements (Section 2.16) * <cref> elements (Section 2.16)
* <em> elements (Section 2.22) * <em> elements (Section 2.22)
* <eref> elements (Section 2.24) * <eref> elements (Section 2.24)
* <iref> elements (Section 2.27) * <iref> elements (Section 2.27)
* <relref> elements (Section 3.13)
* <relref> elements (Section 2.44) * <strong> elements (Section 2.48)
* <strong> elements (Section 2.50) * <sub> elements (Section 2.49)
* <sup> elements (Section 2.50)
* <sub> elements (Section 2.51) * <tt> elements (Section 2.61)
* <u> elements (Section 2.62)
* <sup> elements (Section 2.52)
* <tt> elements (Section 2.62)
* <xref> elements (Section 2.66) * <xref> elements (Section 2.66)
2.29.1. "anchor" Attribute 2.29.1. "anchor" Attribute
Document-wide unique identifier for this list item. Document-wide unique identifier for this list item.
2.30. <link> 2.30. <link>
A link to an external document that is related to the RFC. A link to an external document that is related to the RFC.
skipping to change at page 36, line 33 skipping to change at page 39, line 9
be pointed to in a <link> element: be pointed to in a <link> element:
o The current International Standard Serial Number (ISSN) for the o The current International Standard Serial Number (ISSN) for the
RFC Series. The value for the "rel" attribute is "item". The RFC Series. The value for the "rel" attribute is "item". The
link should use the form "urn:issn:". link should use the form "urn:issn:".
o The Digital Object Identifier (DOI) for this document. The value o The Digital Object Identifier (DOI) for this document. The value
for the "rel" attribute is "describedBy". The link should use the for the "rel" attribute is "describedBy". The link should use the
form specified in [RFC7669]; this is expected to change in the form specified in [RFC7669]; this is expected to change in the
future. future.
o The Internet-Draft that was submitted to the RFC Editor to become o The Internet-Draft that was submitted to the RFC Editor to become
the published RFC. The value for the "rel" attribute is the published RFC. The value for the "rel" attribute is
"convertedFrom". The link should be to an IETF-controlled web "convertedFrom". The link should be to an IETF-controlled web
site that retains copies of Internet-Drafts. site that retains copies of Internet-Drafts.
o A representation of the document offered by the document author. o A representation of the document offered by the document author.
The value for the "rel" attribute is "alternate". The link can be The value for the "rel" attribute is "alternate". The link can be
to a personally run web site. to a personally run web site.
In RFC production mode, the prep tool needs to check the values for In RFC production mode, the prep tool needs to check the values for
<link> before an RFC is published. In draft production mode, the <link> before an RFC is published. In draft production mode, the
prep tool might remove some <link> elements during the draft prep tool might remove some <link> elements during the draft
submission process. submission process.
This element appears as a child element of <rfc> (Section 2.45). This element appears as a child element of <rfc> (Section 2.43).
Content model: this element does not have any contents. Content model: this element does not have any contents.
2.30.1. "href" Attribute (Mandatory) 2.30.1. "href" Attribute (Mandatory)
The URI of the external document. The URI of the external document.
2.30.2. "rel" Attribute 2.30.2. "rel" Attribute
The relationship of the external document to this one. The The relationship of the external document to this one. The
relationships are taken from the "Link Relations" registry maintained relationships are taken from the "Link Relations" registry maintained
by IANA [LINKRELATIONS]. by IANA [LINKRELATIONS].
2.31. <middle> 2.31. <middle>
Represents the main content of the document. Represents the main content of the document.
This element appears as a child element of <rfc> (Section 2.45). This element appears as a child element of <rfc> (Section 2.43).
Content model: Content model:
One or more <section> elements (Section 2.46) One or more <section> elements (Section 2.44)
2.32. <name> 2.32. <name>
The name of the section, note, figure, or texttable. This name can The name of the section, note, figure, or texttable. This name can
indicate markup of flowing text (for example, including references or indicate markup of flowing text (for example, including references or
making some characters use a fixed-width font). making some characters use a fixed-width font).
This element appears as a child element of <figure> (Section 2.25), This element appears as a child element of <figure> (Section 2.25),
<note> (Section 2.33), <references> (Section 2.42), <section> <note> (Section 2.33), <references> (Section 2.42), <section>
(Section 2.46), <table> (Section 2.54), and <texttable> (Section 2.44), <table> (Section 2.52), and <texttable>
(Section 3.8). (Section 3.17).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.10)
o <br> elements (Section 2.13)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27)
o <relref> elements (Section 2.44) o <relref> elements (Section 3.13)
o <strong> elements (Section 2.48)
o <tt> elements (Section 2.62) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.50)
o <tt> elements (Section 2.61)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.33. <note> 2.33. <note>
Creates an unnumbered, titled block of text that appears after the Creates an unnumbered, titled block of text that appears after the
Abstract. Abstract.
It is usually used for additional information to reviewers (Working It is usually used for additional information to reviewers (Working
Group information, mailing list, ...) or for additional publication Group information, mailing list, ...) or for additional publication
information such as "IESG Notes". information such as "IESG Notes".
skipping to change at page 38, line 21 skipping to change at page 40, line 44
Group information, mailing list, ...) or for additional publication Group information, mailing list, ...) or for additional publication
information such as "IESG Notes". information such as "IESG Notes".
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26).
Content model: Content model:
In this order: In this order:
1. One optional <name> element (Section 2.32) 1. One optional <name> element (Section 2.32)
2. In any order, but at least one of: 2. In any order, but at least one of:
* <dl> elements (Section 2.20) * <dl> elements (Section 2.20)
* <ol> elements (Section 2.34) * <ol> elements (Section 2.34)
* <t> elements (Section 2.51)
* <t> elements (Section 2.53)
* <ul> elements (Section 2.63) * <ul> elements (Section 2.63)
2.33.1. "removeInRFC" Attribute 2.33.1. "removeInRFC" Attribute
If set to "true", this note is marked in the prep tool with text If set to "true", this note is marked in the prep tool with text
indicating that it should be removed before the document is published indicating that it should be removed before the document is published
as an RFC. That text will be "This note is to be removed before as an RFC. That text will be "This note is to be removed before
publishing as an RFC." publishing as an RFC."
Allowed values: Allowed values:
skipping to change at page 38, line 42 skipping to change at page 41, line 15
2.33.1. "removeInRFC" Attribute 2.33.1. "removeInRFC" Attribute
If set to "true", this note is marked in the prep tool with text If set to "true", this note is marked in the prep tool with text
indicating that it should be removed before the document is published indicating that it should be removed before the document is published
as an RFC. That text will be "This note is to be removed before as an RFC. That text will be "This note is to be removed before
publishing as an RFC." publishing as an RFC."
Allowed values: Allowed values:
o "true" o "true"
o "false" (default) o "false" (default)
2.33.2. "title" Attribute 2.33.2. "title" Attribute
Deprecated. Use <name> instead. Deprecated. Use <name> instead.
2.34. <ol> 2.34. <ol>
An ordered list. The labels on the items will be either a number or An ordered list. The labels on the items will be either a number or
a letter, depending on the value of the style attribute. a letter, depending on the value of the type attribute.
This element appears as a child element of <abstract> (Section 2.1), This element appears as a child element of <abstract> (Section 2.1),
<aside> (Section 2.6), <blockquote> (Section 2.10), <dd> <aside> (Section 2.7), <blockquote> (Section 2.11), <dd>
(Section 2.18), <li> (Section 2.29), <note> (Section 2.33), <section> (Section 2.18), <li> (Section 2.29), <note> (Section 2.33), <section>
(Section 2.46), <td> (Section 2.56), and <th> (Section 2.58). (Section 2.44), <td> (Section 2.54), and <th> (Section 2.56).
Content model: Content model:
One or more <li> elements (Section 2.29) One or more <li> elements (Section 2.29)
2.34.1. "anchor" Attribute 2.34.1. "anchor" Attribute
Document-wide unique identifier for the list. Document-wide unique identifier for the list.
2.34.2. "group" Attribute 2.34.2. "group" Attribute
When the prep tool sees an <ol> element with a "group" attribute that When the prep tool sees an <ol> element with a "group" attribute that
has already been seen, it continues the numbering of the list from has already been seen, it continues the numbering of the list from
where the previous list with the same group name left off. If an where the previous list with the same group name left off. If an
<ol> element has both a "group" attribute and a "start" attribute, <ol> element has both a "group" attribute and a "start" attribute,
the group's numbering is reset to the given start value. the group's numbering is reset to the given start value.
2.34.3. "spacing" Attribute 2.34.3. "indent" Attribute
The indentation of the list elements relative to the start of the
list item number. With indent='adaptive', the widest list item
number determines the indentation. A numeric value is interpreted as
characters when rendering plain-text documents, and en-space units
otherwise. Only non-negative integer indentation is allowed.
Allowed values:
o text
o "adaptive" (default)
Allowed values:
o "adaptive" (default)
2.34.4. "spacing" Attribute
Defines whether or not there is a blank line between entries. Defines whether or not there is a blank line between entries.
spacing="normal" indicates a single blank line, while spacing="normal" indicates a single blank line, while
spacing="compact" indicates no space between. spacing="compact" indicates no space between.
Allowed values: Allowed values:
o "normal" (default) o "normal" (default)
o "compact" o "compact"
2.34.4. "start" Attribute 2.34.5. "start" Attribute
The ordinal value at which to start the list. This defaults to "1" The ordinal value at which to start the list. This defaults to "1"
and must be an integer of 0 or greater. and must be an integer of 0 or greater.
2.34.5. "type" Attribute 2.34.6. "type" Attribute
The type of the labels on list items. If the length of the type The type of the labels on list items. If the length of the type
value is 1, the meaning is the same as it is for HTML: value is 1, the meaning is the same as it is for HTML:
a Lowercase letters (a, b, c, ...) a Lowercase letters (a, b, c, ...)
A Uppercase letters (A, B, C, ...) A Uppercase letters (A, B, C, ...)
1 Decimal numbers (1, 2, 3, ...) 1 Decimal numbers (1, 2, 3, ...)
skipping to change at page 41, line 10 skipping to change at page 43, line 42
2.35. <organization> 2.35. <organization>
Specifies the affiliation [RFC7322] of an author. Specifies the affiliation [RFC7322] of an author.
This information appears both in the "Author's Address" section and This information appears both in the "Author's Address" section and
on the front page (see [RFC7322] for more information). If the value on the front page (see [RFC7322] for more information). If the value
is long, an abbreviated variant can be specified in the "abbrev" is long, an abbreviated variant can be specified in the "abbrev"
attribute. attribute.
This element appears as a child element of <author> (Section 2.7). This element appears as a child element of <author> (Section 2.8) and
<contact> (Section 2.14).
Content model: only text content. Content model: only text content.
2.35.1. "abbrev" Attribute 2.35.1. "abbrev" Attribute
Abbreviated variant. Abbreviated variant.
2.35.2. "ascii" Attribute 2.35.2. "ascii" Attribute
The ASCII equivalent of the organization's name. The ASCII equivalent of the organization's name.
2.35.3. "asciiAbbrev" Attribute
To support abbreviated organization names in both ASCII and non-ASCII
contexts.
2.35.4. "showOnFrontPage" Attribute
To support turning off listing organization with author name.
Allowed values:
o "true" (default)
o "false"
2.36. <phone> 2.36. <phone>
Represents a phone number. Represents a phone number.
The value is expected to be the scheme-specific part of a "tel" URI The value is expected to be the scheme-specific part of a "tel" URI
(and so does not include the prefix "tel:"), using the "global- (and so does not include the prefix "tel:"), using the "global-
number-digits" syntax. See Section 3 of [RFC3966] for details. number-digits" syntax. See Section 3 of [RFC3966] for details.
This element appears as a child element of <address> (Section 2.2). This element appears as a child element of <address> (Section 2.2).
Content model: only text content. Content model: only text content.
2.37. <postal> 2.37. <postal>
Contains optional child elements providing postal information. These Contains optional child elements providing postal information. A
elements will be displayed in an order that is specific to postal address can contain only an ordered set of <postalLine>
formatters. A postal address can contain only a set of <street>, elements optionally followed by <country>, or only a set of <street>,
<city>, <region>, <code>, and <country> elements, or only an ordered <city>, <region>, <code>, and <country> elements, but not both.
set of <postalLine> elements, but not both.
The sub-elements other than <postalLine> and <country> have been
deprecated and will likely be removed in a future version.
This element appears as a child element of <address> (Section 2.2). This element appears as a child element of <address> (Section 2.2).
Content model: Content model:
Either: Either:
In any order: In any order:
* <city> elements (Section 2.13) * <city> elements (Section 3.2)
* <code> elements (Section 2.14)
* <cityarea> elements (Section 3.3)
* <code> elements (Section 3.4)
* <country> elements (Section 2.15) * <country> elements (Section 2.15)
* <region> elements (Section 2.43) * <extaddr> elements (Section 3.5)
* <street> elements (Section 2.49) * <pobox> elements (Section 3.9)
* <region> elements (Section 3.12)
* <sortingcode> elements (Section 3.14)
* <street> elements (Section 3.16)
Or: Or:
One or more <postalLine> elements (Section 2.38) One or more <postalLine> elements (Section 2.38)
One optional <country> element (Section 2.15)
2.38. <postalLine> 2.38. <postalLine>
Represents one line of a postal address. When more than one Represents one line of a postal address. When more than one
<postalLine> is given, the prep tool emits them in the order given. <postalLine> is given, the prep tool emits them in the order given.
This element appears as a child element of <postal> (Section 2.37). This element appears as a child element of <postal> (Section 2.37).
Content model: only text content. Content model: only text content.
2.38.1. "ascii" Attribute 2.38.1. "ascii" Attribute
skipping to change at page 42, line 48 skipping to change at page 46, line 16
<front> <front>
<title>On Being A Fool</title> <title>On Being A Fool</title>
<author initials="K." surname="Phunny" fullname="Knot Phunny"/> <author initials="K." surname="Phunny" fullname="Knot Phunny"/>
<date year="2000" month="April"/> <date year="2000" month="April"/>
</front> </front>
<refcontent>Self-published pamphlet</refcontent> <refcontent>Self-published pamphlet</refcontent>
</reference> </reference>
would render as: would render as:
[April1] Phunny, K., "On Being A Fool", Self-published [April1] Phunny, K., "On Being A Fool", Self-published
pamphlet, April 2000. pamphlet, April 2000.
This element appears as a child element of <reference> This element appears as a child element of <reference>
(Section 2.40). (Section 2.40).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <strong> elements (Section 2.50) o <strong> elements (Section 2.48)
o <sub> elements (Section 2.51) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.52) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.62) o <tt> elements (Section 2.61)
2.40. <reference> 2.40. <reference>
Represents a bibliographic reference. Represents a bibliographic reference.
This element appears as a child element of <referencegroup> This element appears as a child element of <referencegroup>
(Section 2.41) and <references> (Section 2.42). (Section 2.41) and <references> (Section 2.42).
Content model: Content model:
In this order: In this order:
1. One <front> element (Section 2.26) 1. One optional <stream> element (Section 2.47)
2. One <front> element (Section 2.26)
2. In any order: 3. In any order:
* <annotation> elements (Section 2.3) * <annotation> elements (Section 2.3)
* <format> elements (Section 3.3) * <format> elements (Section 3.7)
* <refcontent> elements (Section 2.39) * <refcontent> elements (Section 2.39)
* <seriesInfo> elements (Section 2.47; deprecated in this * <seriesInfo> elements (Section 2.45)
context)
2.40.1. "anchor" Attribute (Mandatory) 2.40.1. "anchor" Attribute (Mandatory)
Document-wide unique identifier for this reference. Usually, this Document-wide unique identifier for this reference. Usually, this
will be used both to "label" the reference in the "References" will be used both to "label" the reference in the "References"
section and as an identifier in links to this reference entry. section and as an identifier in links to this reference entry.
2.40.2. "quoteTitle" Attribute 2.40.2. "quote-title" Attribute
Deprecated variant of the "quoteTitle" attribute. Prep tools turn
this attribute into "quoteTitle".
Allowed values:
o "true"
o "false"
2.40.3. "quoteTitle" Attribute
Specifies whether or not the title in the reference should be quoted. Specifies whether or not the title in the reference should be quoted.
This can be used to prevent quoting, such as on errata. This can be used to prevent quoting, such as on errata.
Allowed values: Allowed values:
o "true" (default) o "true" (default)
o "false" o "false"
2.40.3. "target" Attribute 2.40.4. "target" Attribute
Holds the URI for the reference. Holds the URI for the reference.
2.41. <referencegroup> 2.41. <referencegroup>
Represents a list of bibliographic references that will be Represents a list of bibliographic references that will be
represented as a single reference. This is most often used to represented as a single reference. This is most often used to
reference STDs and BCPs, where a single reference (such as "BCP 9") reference STDs and BCPs, where a single reference (such as "BCP 9")
may encompass more than one RFC. may encompass more than one RFC.
skipping to change at page 44, line 47 skipping to change at page 48, line 30
One or more <reference> elements (Section 2.40) One or more <reference> elements (Section 2.40)
2.41.1. "anchor" Attribute (Mandatory) 2.41.1. "anchor" Attribute (Mandatory)
Document-wide unique identifier for this reference group. Usually, Document-wide unique identifier for this reference group. Usually,
this will be used both to "label" the reference group in the this will be used both to "label" the reference group in the
"References" section and as an identifier in links to this reference "References" section and as an identifier in links to this reference
entry. entry.
2.41.2. "target" Attribute
Holds an URI for the reference group, analogous to the "target"
attribute of <reference>. Typically used for a reference to a STD
which consists of multiple RFCs with their own URLs, but also has its
own unique URL.
2.42. <references> 2.42. <references>
Contains a set of bibliographic references. Contains a set of bibliographic references.
In the early days of the RFC Series, there was only one "References" In the early days of the RFC Series, there was only one "References"
section per RFC. This convention was later changed to group section per RFC. This convention was later changed to group
references into two sets, "Normative" and "Informative", as described references into two sets, "Normative" and "Informative", as described
in [RFC7322]. This vocabulary supports the split with the <name> in [RFC7322]. This vocabulary supports the split with the <name>
child element. In general, the title should be either "Normative child element. In general, the title should be either "Normative
References" or "Informative References". References" or "Informative References".
This element appears as a child element of <back> (Section 2.8). This element appears as a child element of <back> (Section 2.9) and
<references> (Section 2.42).
Content model: Content model:
In this order: In this order:
1. One optional <name> element (Section 2.32) 1. One optional <name> element (Section 2.32)
2. In any order: 2. Either:
* <reference> elements (Section 2.40) One or more <references> elements (Section 2.42)
* <referencegroup> elements (Section 2.41) Or:
In any order:
+ <reference> elements (Section 2.40)
+ <referencegroup> elements (Section 2.41)
2.42.1. "anchor" Attribute 2.42.1. "anchor" Attribute
An optional user-supplied identifier for this set of references. An optional user-supplied identifier for this set of references.
2.42.2. "title" Attribute 2.42.2. "title" Attribute
Deprecated. Use <name> instead. Deprecated. Use <name> instead.
2.43. <region> 2.43. <rfc>
Provides the region name in a postal address.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
2.43.1. "ascii" Attribute
The ASCII equivalent of the region name.
2.44. <relref>
Represents a link to a specific part of a document that appears in a
<reference> element. Formatters that have links (such as HTML and
PDF) render <relref> elements as external hyperlinks to the specified
part of the reference, creating the link target by combining the base
URI from the <reference> element with the "relative" attribute from
this element. The "target" attribute is required, and it must be the
anchor of a <reference> element.
The "section" attribute is required, and the "relative" attribute is
optional. If the reference is not an RFC or Internet-Draft that is
in the v3 format, the element needs to have a "relative" attribute;
in this case, the value of the "section" attribute is ignored.
An example of the <relref> element with text content might be:
See
<relref section="2.3" target="RFC9999" displayFormat="bare">
the protocol overview</relref>
for more information.
An HTML formatter might generate:
See
<a href="http://www.rfc-editor.org/rfc/rfc9999.html#s-2.3">
the protocol overview</a>
for more information.
Note that the URL in the above example might be different when the
RFC Editor deploys the v3 format.
This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16),
<dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
(Section 2.29), <name> (Section 2.32), <preamble> (Section 3.6),
<strong> (Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52),
<t> (Section 2.53), <td> (Section 2.56), <th> (Section 2.58), and
<tt> (Section 2.62).
Content model: only text content.
2.44.1. "displayFormat" Attribute
This attribute is used to signal formatters what the desired format
of the relative reference should be. Formatters for document types
that have linking capability should wrap each part of the displayed
text in hyperlinks. If there is content in the <relref> element,
formatters will ignore the value of this attribute.
"of"
A formatter should display the relative reference as the word
"Section" followed by a space, the contents of the "section"
attribute followed by a space, the word "of", another space, and
the value from the "target" attribute enclosed in square brackets.
For example, with an input of:
See
<relref section="2.3" target="RFC9999" displayFormat="of"/>
for an overview.
An HTML formatter might generate:
See
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
Section 2.3</a> of
[<a href="#RFC9999">RFC9999</a>]
for an overview.
Note that "displayFormat='of'" is the default for <relref>, so it
does not need to be given in a <relref> element if that format is
desired.
"comma"
A formatter should display the relative reference as the value
from the "target" attribute enclosed in square brackets, a comma,
a space, the word "Section" followed by a space, and the "section"
attribute.
For example, with an input of:
See
<relref section="2.3" target="RFC9999" displayFormat="comma"/>,
for an overview.
An HTML formatter might generate:
See
[<a href="#RFC9999">RFC9999</a>],
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
Section 2.3</a>, for an overview.
"parens"
A formatter should display the relative reference as the value
from the "target" attribute enclosed in square brackets, a space,
a left parenthesis, the word "Section" followed by a space, the
"section" attribute, and a right parenthesis.
For example, with an input of: This is the root element of the xml2rfc vocabulary.
See Processors distinguish between RFC mode ("number" attribute being
<relref section="2.3" target="RFC9999" displayFormat="parens"/> present) and Internet-Draft mode ("docName" present and "number"
for an overview. absent): when both are present, "number" takes precedence. Setting
neither "number" nor "docName" can be useful for producing other
types of documents but is out of scope for this specification.
An HTML formatter might generate: Content model:
See In this order:
[<a href="#RFC9999">RFC9999</a>]
(<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
Section 2.3</a>)
for an overview.
"bare" 1. Optional <link> elements (Section 2.30)
A formatter should display the relative reference as the contents 2. One <front> element (Section 2.26)
of the "section" attribute and nothing else. This is useful when
there are multiple relative references to a single base reference.
For example: 3. One <middle> element (Section 2.31)
See Sections 4. One optional <back> element (Section 2.9)
<relref section="2.3" target="RFC9999" displayFormat="bare"/>
and
<relref section="2.4" target="RFC9999" displayFormat="of"/>
for an overview.
An HTML formatter might generate: 2.43.1. "category" Attribute
See Sections Document category (see Appendix A.1).
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
2.3</a>
and
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.4">
Section 2.4</a> of
[<a href="#RFC9999">RFC9999</a>]
for an overview.
Allowed values: Allowed values:
o "of" (default) o "std"
o "comma"
o "parens"
o "bare"
2.44.2. "relative" Attribute
Specifies a relative reference from the URI in the target reference.
This value must include whatever leading character is needed to
create the relative reference; typically, this is "#" for HTML
documents.
2.44.3. "section" Attribute (Mandatory)
Specifies a section of the target reference. If the reference is not
an RFC or Internet-Draft in the v3 format, it is an error.
2.44.4. "target" Attribute (Mandatory)
The anchor of the reference for this element. If this value is not
an anchor to a <reference> or <referencegroup> element, it is an
error. If the reference at the target has no URI, it is an error.
2.45. <rfc>
This is the root element of the xml2rfc vocabulary.
Content model:
In this order:
1. Optional <link> elements (Section 2.30)
2. One <front> element (Section 2.26)
3. One <middle> element (Section 2.31) o "bcp"
4. One optional <back> element (Section 2.8) o "exp"
2.45.1. "category" Attribute o "info"
Deprecated; instead, use the "name" attribute in <seriesInfo>. o "historic"
2.45.2. "consensus" Attribute 2.43.2. "consensus" Attribute
Affects the generated boilerplate. Note that the values of "no" and Affects the generated boilerplate. Note that the values of "no" and
"yes" are deprecated and are replaced by "false" (the default) and "yes" are deprecated and are replaced by "false" (the default) and
"true". "true".
See [RFC7841] for more information. See [RFC7841] and Appendix A.4 for more information.
Allowed values: Allowed values:
o "no" o "no"
o "yes" o "yes"
o "false" (default) o "false" (default)
o "true" o "true"
2.45.3. "docName" Attribute 2.43.3. "docName" Attribute
Deprecated; instead, use the "value" attribute in <seriesInfo>. For Internet-Drafts, this specifies the draft name (which appears
below the title).
2.45.4. "indexInclude" Attribute If both the "docName" and "number" attributes are given, the latter
takes precedence (and the draft name indicates the Internet-Draft
from which the document was produced).
Note that the file extension is not part of the draft, so in general
it should end with the current draft number ("-", plus two digits).
Furthermore, it is good practice to disambiguate current editor
copies from submitted drafts (for instance, by replacing the draft
number with the string "latest").
See Section 7 of [IDGUIDE] for further information.
2.43.4. "indexInclude" Attribute
Specifies whether or not a formatter is requested to include an index Specifies whether or not a formatter is requested to include an index
in generated files. If the source file has no <iref> elements, an in generated files. If the source file has no <iref> elements, an
index is never generated. This option is useful for generating index is never generated. This option is useful for generating
documents where the source document has <iref> elements but the documents where the source document has <iref> elements but the
author no longer wants an index. author no longer wants an index.
Allowed values: Allowed values:
o "true" (default) o "true" (default)
o "false" o "false"
2.45.5. "ipr" Attribute 2.43.5. "ipr" Attribute
Represents the Intellectual Property status of the document. See Represents the Intellectual Property status of the document. See
Appendix A.1 for details. Appendix A.2 for details.
2.45.6. "iprExtract" Attribute 2.43.6. "iprExtract" Attribute
Identifies a single section within the document for which extraction Identifies a single section within the document for which extraction
"as is" is explicitly allowed (only relevant for historic values of "as is" is explicitly allowed (only relevant for historic values of
the "ipr" attribute). the "ipr" attribute).
2.45.7. "number" Attribute 2.43.7. "number" Attribute
Deprecated; instead, use the "value" attribute in <seriesInfo>. The number of the RFC to be produced.
2.45.8. "obsoletes" Attribute 2.43.8. "obsoletes" Attribute
A comma-separated list of RFC numbers or Internet-Draft names. A comma-separated list of RFC numbers or Internet-Draft names.
The prep tool will parse the attribute value so that incorrect The prep tool will parse the attribute value so that incorrect
references can be detected. references can be detected.
2.45.9. "prepTime" Attribute 2.43.9. "prepTime" Attribute
The date that the XML was processed by a prep tool. This is included The date that the XML was processed by a prep tool. This is included
in the XML file just before it is saved to disk. The value is in the XML file just before it is saved to disk. The value is
formatted using the "date-time" format defined in Section 5.6 of formatted using the "date-time" format defined in Section 5.6 of
[RFC3339]. The "time-offset" should be "Z". [RFC3339]. The "time-offset" should be "Z".
2.45.10. "seriesNo" Attribute 2.43.10. "seriesNo" Attribute
Deprecated; instead, use the "value" attribute in <seriesInfo>. Number within a document series.
2.45.11. "sortRefs" Attribute The document series is defined by the "category" attribute;
"seriesNo" is only applicable to the values "info" ("FYI" series),
"std" ("STD" series), and "bcp" ("BCP" series).
2.43.11. "sortRefs" Attribute
Specifies whether or not the prep tool will sort the references in Specifies whether or not the prep tool will sort the references in
each reference section. each reference section.
Allowed values: Allowed values:
o "true" o "true"
o "false" (default) o "false" (default)
2.45.12. "submissionType" Attribute 2.43.12. "submissionType" Attribute
The document stream, as described in [RFC7841]. (The RFC Series The document stream, as described in [RFC7841]. (The RFC Series
Editor may change the list of allowed values in the future.) Editor may change the list of allowed values in the future.)
Allowed values: Allowed values:
o "IETF" (default) o "IETF" (default)
o "IAB" o "IAB"
o "IRTF" o "IRTF"
o "independent" o "independent"
2.45.13. "symRefs" Attribute o "editorial"
2.43.13. "symRefs" Attribute
Specifies whether or not a formatter is requested to use symbolic Specifies whether or not a formatter is requested to use symbolic
references (such as "[RFC2119]"). If the value for this is "false", references (such as "[RFC2119]"). If the value for this is "false",
the references come out as numbers (such as "[3]"). the references come out as numbers (such as "[3]").
Allowed values: Allowed values:
o "true" (default) o "true" (default)
o "false" o "false"
2.45.14. "tocDepth" Attribute 2.43.14. "tocDepth" Attribute
Specifies the number of levels of headings that a formatter is Specifies the number of levels of headings that a formatter is
requested to include in the table of contents; the default is "3". requested to include in the table of contents; the default is "3".
2.45.15. "tocInclude" Attribute 2.43.15. "tocInclude" Attribute
Specifies whether or not a formatter is requested to include a table Specifies whether or not a formatter is requested to include a table
of contents in generated files. of contents in generated files.
Allowed values: Allowed values:
o "true" (default) o "true" (default)
o "false" o "false"
2.45.16. "updates" Attribute 2.43.16. "updates" Attribute
A comma-separated list of RFC numbers or Internet-Draft names. A comma-separated list of RFC numbers or Internet-Draft names.
The prep tool will parse the attribute value so that incorrect The prep tool will parse the attribute value so that incorrect
references can be detected. references can be detected.
2.45.17. "version" Attribute 2.43.17. "version" Attribute
Specifies the version of xml2rfc syntax used in this document. The Specifies the version of xml2rfc syntax used in this document. The
only expected value (for now) is "3". only expected value (for now) is "3".
2.46. <section> 2.44. <section>
Represents a section (when inside a <middle> element) or an appendix Represents a section (when inside a <middle> element) or an appendix
(when inside a <back> element). (when inside a <back> element).
Subsections are created by nesting <section> elements inside Subsections are created by nesting <section> elements inside
<section> elements. Sections are allowed to be empty. <section> elements. Sections are allowed to be empty.
This element appears as a child element of <back> (Section 2.8), This element appears as a child element of <back> (Section 2.9),
<boilerplate> (Section 2.11), <middle> (Section 2.31), and <section> <boilerplate> (Section 2.12), <middle> (Section 2.31), <section>
(Section 2.46). (Section 2.44), and <toc> (Section 2.59).
Content model: Content model:
In this order: In this order:
1. One optional <name> element (Section 2.32) 1. One optional <name> element (Section 2.32)
2. In any order: 2. In any order:
* <artwork> elements (Section 2.5) * <artset> elements (Section 2.5)
* <aside> elements (Section 2.6) * <artwork> elements (Section 2.6)
* <blockquote> elements (Section 2.10) * <aside> elements (Section 2.7)
* <author> elements (Section 2.8)
* <blockquote> elements (Section 2.11)
* <contact> elements (Section 2.14)
* <dl> elements (Section 2.20) * <dl> elements (Section 2.20)
* <figure> elements (Section 2.25) * <figure> elements (Section 2.25)
* <iref> elements (Section 2.27) * <iref> elements (Section 2.27)
* <ol> elements (Section 2.34) * <ol> elements (Section 2.34)
* <sourcecode> elements (Section 2.48) * <sourcecode> elements (Section 2.46)
* <t> elements (Section 2.53) * <t> elements (Section 2.51)
* <table> elements (Section 2.54) * <table> elements (Section 2.52)
* <texttable> elements (Section 3.8) * <texttable> elements (Section 3.17)
* <ul> elements (Section 2.63) * <ul> elements (Section 2.63)
3. Optional <section> elements (Section 2.46) 3. Optional <section> elements (Section 2.44)
2.46.1. "anchor" Attribute 2.44.1. "anchor" Attribute
Document-wide unique identifier for this section. Document-wide unique identifier for this section.
2.46.2. "numbered" Attribute 2.44.2. "numbered" Attribute
If set to "false", the formatter is requested to not display a If set to "false", the formatter is requested to not display a
section number. The prep tool will verify that such a section is not section number. The prep tool will verify that such a section is not
followed by a numbered section in this part of the document and will followed by a numbered section in this part of the document and will
verify that the section is a top-level section. verify that the section is a top-level section. Descendant sections
of unnumbered sections are unnumbered by definition.
Allowed values: Allowed values:
o "true" (default) o "true" (default)
o "false" o "false"
2.46.3. "removeInRFC" Attribute 2.44.3. "removeInRFC" Attribute
If set to "true", this note is marked in the prep tool with text If set to "true", this note is marked in the prep tool with text
indicating that it should be removed before the document is published indicating that it should be removed before the document is published
as an RFC. That text will be "This note is to be removed before as an RFC. That text will be "This note is to be removed before
publishing as an RFC." publishing as an RFC."
Allowed values: Allowed values:
o "true" o "true"
o "false" (default) o "false" (default)
2.46.4. "title" Attribute 2.44.4. "title" Attribute
Deprecated. Use <name> instead. Deprecated. Use <name> instead.
2.46.5. "toc" Attribute 2.44.5. "toc" Attribute
Indicates to a formatter whether or not the section is to be included Indicates to a formatter whether or not the section is to be included
in a table of contents, if such a table of contents is produced. in a table of contents, if such a table of contents is produced.
This only takes effect if the level of the section would have This only takes effect if the level of the section would have
appeared in the table of contents based on the "tocDepth" attribute appeared in the table of contents based on the "tocDepth" attribute
of the <rfc> element, and of course only if the table of contents is of the <rfc> element, and of course only if the table of contents is
being created based on the "tocInclude" attribute of the <rfc> being created based on the "tocInclude" attribute of the <rfc>
element. If this is set to "exclude", any section below this one element. If this is set to "exclude", any section below this one
will be excluded as well. The "default" value indicates inclusion of will be excluded as well. The "default" value indicates inclusion of
the section if it would be included by the tocDepth attribute of the the section if it would be included by the tocDepth attribute of the
skipping to change at page 54, line 39 skipping to change at page 56, line 4
of the <rfc> element, and of course only if the table of contents is of the <rfc> element, and of course only if the table of contents is
being created based on the "tocInclude" attribute of the <rfc> being created based on the "tocInclude" attribute of the <rfc>
element. If this is set to "exclude", any section below this one element. If this is set to "exclude", any section below this one
will be excluded as well. The "default" value indicates inclusion of will be excluded as well. The "default" value indicates inclusion of
the section if it would be included by the tocDepth attribute of the the section if it would be included by the tocDepth attribute of the
<rfc> element. <rfc> element.
Allowed values: Allowed values:
o "include" o "include"
o "exclude" o "exclude"
o "default" (default) o "default" (default)
2.47. <seriesInfo> 2.45. <seriesInfo>
Specifies the document series in which this document appears, and Specifies the document series in which this document appears, and
also specifies an identifier within that series. also specifies an identifier within that series.
A processing tool determines whether it is working on an RFC or an
Internet-Draft by inspecting the "name" attribute of a <seriesInfo>
element inside the <front> element inside the <rfc> element, looking
for "RFC" or "Internet-Draft". (Specifying neither value in any of
the <seriesInfo> elements can be useful for producing other types of
documents but is out of scope for this specification.)
It is invalid to have multiple <seriesInfo> elements inside the same
<front> element containing the same "name" value. Some combinations
of <seriesInfo> "name" attribute values make no sense, such as having
both <seriesInfo name="rfc"/> and <seriesInfo name="Internet-Draft"/>
in the same <front> element.
This element appears as a child element of <front> (Section 2.26) and This element appears as a child element of <front> (Section 2.26) and
<reference> (Section 2.40; deprecated in this context). <reference> (Section 2.40).
Content model: this element does not have any contents. Content model: this element does not have any contents.
2.47.1. "asciiName" Attribute 2.45.1. "asciiName" Attribute
The ASCII equivalent of the name field. The ASCII equivalent of the name field.
2.47.2. "asciiValue" Attribute 2.45.2. "asciiValue" Attribute
The ASCII equivalent of the value field. The ASCII equivalent of the value field.
2.47.3. "name" Attribute (Mandatory) 2.45.3. "name" Attribute (Mandatory)
The name of the series. The currently known values are "RFC", Some series names might trigger specific processing (such as for
"Internet-Draft", and "DOI". The RFC Series Editor may change this autogenerating links, inserting descriptions such as "work in
list in the future. progress", or additional functionality like reference diagnostics).
Examples for IETF-related series names are "BCP", "FYI", "Internet-
Draft", "RFC", and "STD".
Some of the values for "name" interact as follows: Some of the values for "name" interact as follows:
o If a <front> element contains a <seriesInfo> element with a name
of "Internet-Draft", it can also have at most one additional
<seriesInfo> element with a "status" attribute whose value is of
"standard", "full-standard", "bcp", "fyi", "informational",
"experimental", or "historic" to indicate the intended status of
this Internet-Draft, if it were to be later published as an RFC.
If such an additional <seriesInfo> element has one of those
statuses, the name needs to be "".
o If a <front> element contains a <seriesInfo> element with a name
of "RFC", it can also have at most one additional <seriesInfo>
element with a "status" attribute whose value is of "full-
standard", "bcp", or "fyi" to indicate the current status of this
RFC. If such an additional <seriesInfo> element has one of those
statuses, the "value" attribute for that name needs to be the
number within that series. That <front> element might also
contain an additional <seriesInfo> element with the status of
"info", "exp", or "historic" and a name of "" to indicate the
status of the RFC.
o A <front> element that has a <seriesInfo> element that has the o A <front> element that has a <seriesInfo> element that has the
name "Internet-Draft" cannot also have a <seriesInfo> element that name "Internet-Draft" cannot also have a <seriesInfo> element that
has the name "RFC". has the name "RFC".
o The <seriesInfo> element can contain the DOI for the referenced o The <seriesInfo> element can contain the DOI for the referenced
document. This cannot be used when the <seriesInfo> element is an document. This cannot be used when the <seriesInfo> element is an
eventual child element of an <rfc> element -- only as an eventual eventual child element of an <rfc> element -- only as an eventual
child of a <reference> element. The "value" attribute should use child of a <reference> element. The "value" attribute should use
the form specified in [RFC7669]. the form specified in [RFC7669].
2.47.4. "status" Attribute 2.45.4. "status" Attribute
The status of this document. The currently known values are The status of this document. The currently known values are
"standard", "informational", "experimental", "bcp", "fyi", and "full- "standard", "informational", "experimental", "bcp", "fyi", and "full-
standard". The RFC Series Editor may change this list in the future. standard". The RFC Series Editor may change this list in the future.
2.47.5. "stream" Attribute 2.45.5. "stream" Attribute
The stream (as described in [RFC7841]) that originated the document. The stream (as described in [RFC7841]) that originated the document.
(The RFC Series Editor may change this list in the future.) (The RFC Series Editor may change this list in the future.)
Allowed values: Allowed values:
o "IETF" (default) o "IETF"
o "IAB" o "IAB"
o "IRTF" o "IRTF"
o "independent" o "independent"
2.47.6. "value" Attribute (Mandatory) 2.45.6. "value" Attribute (Mandatory)
The identifier within the series specified by the "name" attribute. The identifier within the series specified by the "name" attribute.
For BCPs, FYIs, RFCs, and STDs, this is the number within the series. For BCPs, FYIs, RFCs, and STDs, this is the number within the series.
For Internet-Drafts, it is the full draft name (ending with the two- For Internet-Drafts, it is the full draft name (ending with the two-
digit version number). For DOIs, the value is given, such as digit version number). For DOIs, the value is given, such as
"10.17487/rfc1149", as described in [RFC7669]. "10.17487/rfc1149", as described in [RFC7669].
The name in the value should be the document name without any file The name in the value should be the document name without any file
extension. For Internet-Drafts, the value for this attribute should extension. For Internet-Drafts, the value for this attribute should
be "draft-ietf-somewg-someprotocol-07", not be "draft-ietf-somewg-someprotocol-07", not "draft-ietf-somewg-
"draft-ietf-somewg-someprotocol-07.txt". someprotocol-07.txt".
2.48. <sourcecode> 2.46. <sourcecode>
This element allows the inclusion of source code into the document. This element allows the inclusion of source code into the document.
When rendered, source code is always shown in a monospace font. When When rendered, source code is always shown in a monospace font. When
<sourcecode> is a child of <figure> or <section>, it provides full <sourcecode> is a child of <figure> or <section>, it provides full
control of horizontal whitespace and line breaks. When formatted, it control of horizontal whitespace and line breaks. When formatted, it
is indented relative to the left margin of the enclosing element. It is indented relative to the left margin of the enclosing element. It
is thus useful for source code and formal languages (such as ABNF is thus useful for source code and formal languages (such as ABNF
[RFC5234] or the RNC notation used in this document). (When [RFC5234] or the RNC notation used in this document). (When
<sourcecode> is a child of other elements, it flows with the text <sourcecode> is a child of other elements, it flows with the text
skipping to change at page 57, line 30 skipping to change at page 58, line 13
and so on, use the <artwork> element instead. and so on, use the <artwork> element instead.
Output formatters that do pagination should attempt to keep source Output formatters that do pagination should attempt to keep source
code on a single page. This is to prevent source code that is split code on a single page. This is to prevent source code that is split
across pages from looking like two separate pieces of code. across pages from looking like two separate pieces of code.
See Section 5 for a description of how to deal with issues of using See Section 5 for a description of how to deal with issues of using
"&" and "<" characters in source code. "&" and "<" characters in source code.
This element appears as a child element of <blockquote> This element appears as a child element of <blockquote>
(Section 2.10), <dd> (Section 2.18), <figure> (Section 2.25), <li> (Section 2.11), <dd> (Section 2.18), <figure> (Section 2.25), <li>
(Section 2.29), <section> (Section 2.46), <td> (Section 2.56), and (Section 2.29), <section> (Section 2.44), <td> (Section 2.54), and
<th> (Section 2.58). <th> (Section 2.56).
Content model: only text content. Content model: only text content.
2.48.1. "anchor" Attribute 2.46.1. "anchor" Attribute
Document-wide unique identifier for this source code. Document-wide unique identifier for this source code.
2.48.2. "name" Attribute 2.46.2. "markers" Attribute
Specifies whether or not the soure code should be displayed between
"<CODE BEGINS>"/"<CODE ENDS>" markers, as described in
<https://www.ietf.org/about/groups/iesg/statements/copyright-
2009-09-08/>. Note that adding markers is not needed for the
languages listed under "Code Components" on
<https://trustee.ietf.org/trust-legal-provisions.html>.
Additionally, if the "name" attribute is present, if will be
displayed after "<CODE BEGINS>", as described in Section 3.2 of
[RFC8407].
Allowed values:
o "true"
o "false" (default)
2.46.3. "name" Attribute
A filename suitable for the contents (such as for extraction to a A filename suitable for the contents (such as for extraction to a
local file). This attribute can be helpful for other kinds of tools local file). This attribute can be helpful for other kinds of tools
(such as automated syntax checkers, which work by extracting the (such as automated syntax checkers, which work by extracting the
source code). Note that the "name" attribute does not need to be source code). Note that the "name" attribute does not need to be
unique for <artwork> elements in a document. If multiple unique for <artwork> elements in a document. If multiple
<sourcecode> elements have the same "name" attribute, a formatter <sourcecode> elements have the same "name" attribute, a formatter
might assume that the elements are all fragments of a single file, might assume that the elements are all fragments of a single file,
and such a formatter can collect those fragments for later and such a formatter can collect those fragments for later
processing. processing.
2.48.3. "src" Attribute 2.46.4. "src" Attribute
The URI reference of a source file [RFC3986]. The URI reference of a source file [RFC3986].
It is an error to have both a "src" attribute and content in the It is an error to have both a "src" attribute and content in the
<sourcecode> element. <sourcecode> element.
2.48.4. "type" Attribute 2.46.5. "type" Attribute
Specifies the type of the source code. The value of this attribute Specifies the type of the source code. The value of this attribute
is free text with certain values designated as preferred. is free text with certain values designated as preferred.
The preferred values for <sourcecode> types are: The preferred values for <sourcecode> types are:
o abnf o abnf
o asn.1 o asn.1
skipping to change at page 59, line 6 skipping to change at page 60, line 6
o python o python
o rnc o rnc
o xml o xml
o yang o yang
The RFC Series Editor will maintain a complete list of the preferred The RFC Series Editor will maintain a complete list of the preferred
values on the RFC Editor web site, and that list is expected to be values on the RFC Editor web site, and that list is expected to be
updated over time. Thus, a consumer of v3 XML should not cause a updated over time. Thus, a consumer of v3 XML should be prepared for
failure when it encounters an unexpected type or no type is an unexpected type or no type at all.
specified.
2.49. <street> 2.47. <stream>
Provides a street address. The document stream, one of IETF, IAB, IRTF, independent, or
editorial.
This element appears as a child element of <postal> (Section 2.37). This element appears as a child element of <reference>
(Section 2.40).
Content model: only text content. This element appears as a child element of <reference>
(Section 2.40).
2.49.1. "ascii" Attribute Content model:
The ASCII equivalent of the street address. Text
2.50. <strong> 2.48. <strong>
Indicates text that is semantically strong. Text enclosed within Indicates text that is semantically strong. Text enclosed within
this element will be displayed as bold after processing. This this element will be displayed as bold after processing. This
element can be combined with other character formatting elements, and element can be combined with other character formatting elements, and
the formatting will be additive. the formatting will be additive.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16), (Section 2.3), <blockquote> (Section 2.11), <cref> (Section 2.16),
<dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li> <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
(Section 2.29), <preamble> (Section 3.6), <refcontent> (Section 2.29), <name> (Section 2.32), <preamble> (Section 3.11),
(Section 2.39), <sub> (Section 2.51), <sup> (Section 2.52), <t> <refcontent> (Section 2.39), <sub> (Section 2.49), <sup>
(Section 2.53), <td> (Section 2.56), <th> (Section 2.58), and <tt> (Section 2.50), <t> (Section 2.51), <td> (Section 2.54), <th>
(Section 2.62). (Section 2.56), <tt> (Section 2.61), and <xref> (Section 2.66).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <br> elements (Section 2.13)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <relref> elements (Section 2.44) o <relref> elements (Section 3.13)
o <sub> elements (Section 2.51) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.52) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.62) o <tt> elements (Section 2.61)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.51. <sub> 2.49. <sub>
Causes the text to be displayed as subscript, approximately half a Causes the text to be displayed as subscript, approximately half a
letter-height lower than normal text. This element can be combined letter-height lower than normal text. This element can be combined
with other character formatting elements, and the formatting will be with other character formatting elements, and the formatting will be
additive. additive.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16), (Section 2.3), <blockquote> (Section 2.11), <cref> (Section 2.16),
<dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li> <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
(Section 2.29), <preamble> (Section 3.6), <refcontent> (Section 2.29), <name> (Section 2.32), <preamble> (Section 3.11),
(Section 2.39), <strong> (Section 2.50), <t> (Section 2.53), <td> <refcontent> (Section 2.39), <strong> (Section 2.48), <sub>
(Section 2.56), <th> (Section 2.58), and <tt> (Section 2.62). (Section 2.49), <sup> (Section 2.50), <t> (Section 2.51), <td>
(Section 2.54), <th> (Section 2.56), <tt> (Section 2.61), and <xref>
(Section 2.66).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <relref> elements (Section 2.44) o <relref> elements (Section 3.13)
o <strong> elements (Section 2.48)
o <strong> elements (Section 2.50) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.50)
o <tt> elements (Section 2.61)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.52. <sup> 2.50. <sup>
Causes the text to be displayed as superscript, approximately half a Causes the text to be displayed as superscript, approximately half a
letter-height higher than normal text. This element can be combined letter-height higher than normal text. This element can be combined
with other character formatting elements, and the formatting will be with other character formatting elements, and the formatting will be
additive. additive.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16), (Section 2.3), <blockquote> (Section 2.11), <cref> (Section 2.16),
<dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li> <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
(Section 2.29), <preamble> (Section 3.6), <refcontent> (Section 2.29), <name> (Section 2.32), <preamble> (Section 3.11),
(Section 2.39), <strong> (Section 2.50), <t> (Section 2.53), <td> <refcontent> (Section 2.39), <strong> (Section 2.48), <sub>
(Section 2.56), <th> (Section 2.58), and <tt> (Section 2.62). (Section 2.49), <sup> (Section 2.50), <t> (Section 2.51), <td>
(Section 2.54), <th> (Section 2.56), <tt> (Section 2.61), and <xref>
(Section 2.66).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <relref> elements (Section 2.44) o <relref> elements (Section 3.13)
o <strong> elements (Section 2.50) o <strong> elements (Section 2.48)
o <tt> elements (Section 2.62) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.50)
o <tt> elements (Section 2.61)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.53. <t> 2.51. <t>
Contains a paragraph of text. Contains a paragraph of text.
This element appears as a child element of <abstract> (Section 2.1), This element appears as a child element of <abstract> (Section 2.1),
<aside> (Section 2.6), <blockquote> (Section 2.10), <dd> <aside> (Section 2.7), <blockquote> (Section 2.11), <dd>
(Section 2.18), <li> (Section 2.29), <list> (Section 3.4), <note> (Section 2.18), <li> (Section 2.29), <list> (Section 3.8), <note>
(Section 2.33), <section> (Section 2.46), <td> (Section 2.56), and (Section 2.33), <section> (Section 2.44), <td> (Section 2.54), and
<th> (Section 2.58). <th> (Section 2.56).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <br> elements (Section 2.13)
o <contact> elements (Section 2.14)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <list> elements (Section 3.4) o <relref> elements (Section 3.13)
o <relref> elements (Section 2.44)
o <spanx> elements (Section 3.7) o <spanx> elements (Section 3.15)
o <strong> elements (Section 2.50) o <strong> elements (Section 2.48)
o <sub> elements (Section 2.51) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.52) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.62) o <tt> elements (Section 2.61)
o <u> elements (Section 2.62)
o <vspace> elements (Section 3.10) o <vspace> elements (Section 3.19)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.53.1. "anchor" Attribute 2.51.1. "anchor" Attribute
Document-wide unique identifier for this paragraph. Document-wide unique identifier for this paragraph.
2.53.2. "hangText" Attribute 2.51.2. "hangText" Attribute
Deprecated. Instead, use <dd> inside of a definition list (<dl>). Deprecated. Instead, use <dd> inside of a definition list (<dl>).
2.53.3. "keepWithNext" Attribute 2.51.3. "indent" Attribute
The indentation of the text element. A numeric value is interpreted
as characters when rendering plain-text documents, and en-space units
otherwise. Only non-negative integer indentation is allowed.
2.51.4. "keepWithNext" Attribute
Acts as a hint to the output formatters that do pagination to do a Acts as a hint to the output formatters that do pagination to do a
best-effort attempt to keep the paragraph with the next element, best-effort attempt to keep the paragraph with the next element,
whatever that happens to be. For example, the HTML output @media whatever that happens to be. For example, the HTML output @media
print CSS ("CSS" refers to Cascading Style Sheets) might translate print CSS ("CSS" refers to Cascading Style Sheets) might translate
this to page-break-after: avoid. For PDF, the paginator could this to page-break-after: avoid. For PDF, the paginator could
attempt to keep the paragraph with the next element. Note: this attempt to keep the paragraph with the next element. Note: this
attribute is strictly a hint and not always actionable. attribute is strictly a hint and not always actionable.
Allowed values: Allowed values:
o "false" (default) o "false" (default)
o "true" o "true"
2.53.4. "keepWithPrevious" Attribute 2.51.5. "keepWithPrevious" Attribute
Acts as a hint to the output formatters that do pagination to do a Acts as a hint to the output formatters that do pagination to do a
best-effort attempt to keep the paragraph with the previous element, best-effort attempt to keep the paragraph with the previous element,
whatever that happens to be. For example, the HTML output @media whatever that happens to be. For example, the HTML output @media
print CSS might translate this to page-break-before: avoid. For PDF, print CSS might translate this to page-break-before: avoid. For PDF,
the paginator could attempt to keep the paragraph with the previous the paginator could attempt to keep the paragraph with the previous
element. Note: this attribute is strictly a hint and not always element. Note: this attribute is strictly a hint and not always
actionable. actionable.
Allowed values: Allowed values:
o "false" (default) o "false" (default)
o "true" o "true"
2.54. <table> 2.52. <table>
Contains a table with a caption with the table number. If the Contains a table with a caption with the table number. If the
element contains a <name> element, the caption will also show that element contains a <name> element, the caption will also show that
name. name.
Inside the <table> element is, optionally, a <thead> element to Inside the <table> element is, optionally, a <thead> element to
contain the rows that will be the table's heading and, optionally, a contain the rows that will be the table's heading and, optionally, a
<tfoot> element to contain the rows of the table's footer. If the <tfoot> element to contain the rows of the table's footer. If the
XML is converted to a representation that has page breaks (such as XML is converted to a representation that has page breaks (such as
PDFs or printed HTML), the header and footer are meant to appear on PDFs or printed HTML), the header and footer are meant to appear on
each page. each page.
This element appears as a child element of <aside> (Section 2.6) and This element appears as a child element of <aside> (Section 2.7),
<section> (Section 2.46). <dd> (Section 2.18), <li> (Section 2.29), and <section>
(Section 2.44).
Content model: Content model:
In this order: In this order:
1. One optional <name> element (Section 2.32) 1. One optional <name> element (Section 2.32)
2. Optional <iref> elements (Section 2.27) 2. Optional <iref> elements (Section 2.27)
3. One optional <thead> element (Section 2.59) 3. One optional <thead> element (Section 2.57)
4. One or more <tbody> elements (Section 2.55) 4. One or more <tbody> elements (Section 2.53)
5. One optional <tfoot> element (Section 2.57) 5. One optional <tfoot> element (Section 2.55)
2.54.1. "anchor" Attribute 2.52.1. "align" Attribute
Controls whether the table appears left justified, centered
(default), or right justified. The caption will be centered under
the table, and the combined table and caption will be aligned
according to the "align" attribute.
Allowed values:
o "left"
o "center" (default)
o "right"
2.52.2. "anchor" Attribute
Document-wide unique identifier for this table. Document-wide unique identifier for this table.
2.55. <tbody> 2.53. <tbody>
A container for a set of body rows for a table. A container for a set of body rows for a table.
This element appears as a child element of <table> (Section 2.54). This element appears as a child element of <table> (Section 2.52).
Content model: Content model:
One or more <tr> elements (Section 2.61) One or more <tr> elements (Section 2.60)
2.55.1. "anchor" Attribute 2.53.1. "anchor" Attribute
Document-wide unique identifier for the tbody. Document-wide unique identifier for the tbody.
2.56. <td> 2.54. <td>
A cell in a table row. A cell in a table row.
This element appears as a child element of <tr> (Section 2.61). This element appears as a child element of <tr> (Section 2.60).
Content model: Content model:
Either: Either:
In any order, but at least one of: In any order, but at least one of:
* <artwork> elements (Section 2.5) * <artset> elements (Section 2.5)
* <artwork> elements (Section 2.6)
* <dl> elements (Section 2.20) * <dl> elements (Section 2.20)
* <figure> elements (Section 2.25) * <figure> elements (Section 2.25)
* <ol> elements (Section 2.34)
* <sourcecode> elements (Section 2.48) * <ol> elements (Section 2.34)
* <t> elements (Section 2.53) * <sourcecode> elements (Section 2.46)
* <t> elements (Section 2.51)
* <ul> elements (Section 2.63) * <ul> elements (Section 2.63)
Or: Or:
In any order: In any order:
* Text * Text
* <bcp14> elements (Section 2.9) * <bcp14> elements (Section 2.10)
* <br> elements (Section 2.12) * <br> elements (Section 2.13)
* <cref> elements (Section 2.16) * <cref> elements (Section 2.16)
* <em> elements (Section 2.22) * <em> elements (Section 2.22)
* <eref> elements (Section 2.24) * <eref> elements (Section 2.24)
* <iref> elements (Section 2.27) * <iref> elements (Section 2.27)
* <relref> elements (Section 2.44) * <relref> elements (Section 3.13)
* <strong> elements (Section 2.50) * <strong> elements (Section 2.48)
* <sub> elements (Section 2.51) * <sub> elements (Section 2.49)
* <sup> elements (Section 2.52) * <sup> elements (Section 2.50)
* <tt> elements (Section 2.62) * <tt> elements (Section 2.61)
* <u> elements (Section 2.62)
* <xref> elements (Section 2.66) * <xref> elements (Section 2.66)
2.56.1. "align" Attribute 2.54.1. "align" Attribute
Controls whether the content of the cell appears left justified Controls whether the content of the cell appears left justified
(default), centered, or right justified. Note that "center" or (default), centered, or right justified. Note that "center" or
"right" will probably only work well in cells with plain text; any "right" will probably only work well in cells with plain text; any
other elements might make the contents render badly. other elements might make the contents render badly.
Allowed values: Allowed values:
o "left" (default) o "left" (default)
o "center" o "center"
o "right" o "right"
2.56.2. "anchor" Attribute 2.54.2. "anchor" Attribute
Document-wide unique identifier for the cell. Document-wide unique identifier for the cell.
2.56.3. "colspan" Attribute 2.54.3. "colspan" Attribute
The number of columns that the cell is to span. For example, setting The number of columns that the cell is to span. For example, setting
"colspan='3'" indicates that the cell occupies the same horizontal "colspan='3'" indicates that the cell occupies the same horizontal
space as three cells of a row without any "colspan" attributes. space as three cells of a row without any "colspan" attributes.
2.56.4. "rowspan" Attribute 2.54.4. "rowspan" Attribute
The number of rows that the cell is to span. For example, setting The number of rows that the cell is to span. For example, setting
"rowspan='3'" indicates that the cell occupies the same vertical "rowspan='3'" indicates that the cell occupies the same vertical
space as three rows. space as three rows.
2.57. <tfoot> 2.55. <tfoot>
A container for a set of footer rows for a table. A container for a set of footer rows for a table.
This element appears as a child element of <table> (Section 2.54). This element appears as a child element of <table> (Section 2.52).
Content model: Content model:
One or more <tr> elements (Section 2.61) One or more <tr> elements (Section 2.60)
2.57.1. "anchor" Attribute 2.55.1. "anchor" Attribute
Document-wide unique identifier for the tfoot. Document-wide unique identifier for the tfoot.
2.58. <th> 2.56. <th>
A cell in a table row. When rendered, this will normally come out in A cell in a table row. When rendered, this will normally come out in
boldface; other than that, there is no difference between this and boldface; other than that, there is no difference between this and
the <td> element. the <td> element.
This element appears as a child element of <tr> (Section 2.61). This element appears as a child element of <tr> (Section 2.60).
Content model: Content model:
Either: Either:
In any order, but at least one of: In any order, but at least one of:
* <artwork> elements (Section 2.5) * <artset> elements (Section 2.5)
* <artwork> elements (Section 2.6)
* <dl> elements (Section 2.20) * <dl> elements (Section 2.20)
* <figure> elements (Section 2.25) * <figure> elements (Section 2.25)
* <ol> elements (Section 2.34) * <ol> elements (Section 2.34)
* <sourcecode> elements (Section 2.48) * <sourcecode> elements (Section 2.46)
* <t> elements (Section 2.53) * <t> elements (Section 2.51)
* <ul> elements (Section 2.63) * <ul> elements (Section 2.63)
Or: Or:
In any order: In any order:
* Text * Text
* <bcp14> elements (Section 2.9) * <bcp14> elements (Section 2.10)
* <br> elements (Section 2.12) * <br> elements (Section 2.13)
* <cref> elements (Section 2.16) * <cref> elements (Section 2.16)
* <em> elements (Section 2.22) * <em> elements (Section 2.22)
* <eref> elements (Section 2.24) * <eref> elements (Section 2.24)
* <iref> elements (Section 2.27) * <iref> elements (Section 2.27)
* <relref> elements (Section 2.44) * <relref> elements (Section 3.13)
* <strong> elements (Section 2.50) * <strong> elements (Section 2.48)
* <sub> elements (Section 2.51) * <sub> elements (Section 2.49)
* <sup> elements (Section 2.50)
* <sup> elements (Section 2.52) * <tt> elements (Section 2.61)
* <tt> elements (Section 2.62)
* <u> elements (Section 2.62)
* <xref> elements (Section 2.66) * <xref> elements (Section 2.66)
2.58.1. "align" Attribute 2.56.1. "align" Attribute
Controls whether the content of the cell appears left justified Controls whether the content of the cell appears left justified
(default), centered, or right justified. Note that "center" or (default), centered, or right justified. Note that "center" or
"right" will probably only work well in cells with plain text; any "right" will probably only work well in cells with plain text; any
other elements might make the contents render badly. other elements might make the contents render badly.
Allowed values: Allowed values:
o "left" (default) o "left" (default)
o "center" o "center"
o "right" o "right"
2.58.2. "anchor" Attribute 2.56.2. "anchor" Attribute
Document-wide unique identifier for the row. Document-wide unique identifier for the row.
2.58.3. "colspan" Attribute 2.56.3. "colspan" Attribute
The number of columns that the cell is to span. For example, setting The number of columns that the cell is to span. For example, setting
"colspan='3'" indicates that the cell occupies the same horizontal "colspan='3'" indicates that the cell occupies the same horizontal
space as three cells of a row without any "colspan" attributes. space as three cells of a row without any "colspan" attributes.
2.58.4. "rowspan" Attribute 2.56.4. "rowspan" Attribute
The number of rows that the cell is to span. For example, setting The number of rows that the cell is to span. For example, setting
"rowspan='3'" indicates that the cell occupies the same vertical "rowspan='3'" indicates that the cell occupies the same vertical
space as three rows. space as three rows.
2.59. <thead> 2.57. <thead>
A container for a set of header rows for a table. A container for a set of header rows for a table.
This element appears as a child element of <table> (Section 2.54). This element appears as a child element of <table> (Section 2.52).
Content model: Content model:
One or more <tr> elements (Section 2.61) One or more <tr> elements (Section 2.60)
2.59.1. "anchor" Attribute 2.57.1. "anchor" Attribute
Document-wide unique identifier for the thead. Document-wide unique identifier for the thead.
2.60. <title> 2.58. <title>
Represents the document title. Represents the document title.
When this element appears in the <front> element of the current When this element appears in the <front> element of the current
document, the title might also appear in page headers or footers. If document, the title might also appear in page headers or footers. If
it is long (~40 characters), the "abbrev" attribute can be used to it is long (~40 characters), the "abbrev" attribute can be used to
specify an abbreviated variant. specify an abbreviated variant.
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26).
Content model: only text content. Content model:
2.60.1. "abbrev" Attribute In any order:
o Text
o <br> elements (Section 2.13)
2.58.1. "abbrev" Attribute
Specifies an abbreviated variant of the document title. Specifies an abbreviated variant of the document title.
2.60.2. "ascii" Attribute 2.58.2. "ascii" Attribute
The ASCII equivalent of the title. The ASCII equivalent of the title.
2.61. <tr> 2.59. <toc>
This element contains the Table of Contents. It is created
automatically by the preptool based on the "tocInclude" and
"tocDepth" attributes of the <rfc> element and the section headers.
In prepared drafts, it has no effect on document rendering and
contains no useful information. In prepared RFCs, it is used as the
source for the table of contents.
This element appears as a child element of <front> (Section 2.26).
Content model:
Optional <section> elements (Section 2.44)
2.60. <tr>
A row of a table. A row of a table.
This element appears as a child element of <tbody> (Section 2.55), This element appears as a child element of <tbody> (Section 2.53),
<tfoot> (Section 2.57), and <thead> (Section 2.59). <tfoot> (Section 2.55), and <thead> (Section 2.57).
Content model: Content model:
In any order, but at least one of: In any order, but at least one of:
o <td> elements (Section 2.56) o <td> elements (Section 2.54)
o <th> elements (Section 2.58) o <th> elements (Section 2.56)
2.61.1. "anchor" Attribute 2.60.1. "anchor" Attribute
Document-wide unique identifier for the row. Document-wide unique identifier for the row.
2.62. <tt> 2.61. <tt>
Causes the text to be displayed in a constant-width font. This Causes the text to be displayed in a constant-width font. This
element can be combined with other character formatting elements, and element can be combined with other character formatting elements, and
the formatting will be additive. the formatting will be additive.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16), (Section 2.3), <blockquote> (Section 2.11), <cref> (Section 2.16),
<dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li> <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
(Section 2.29), <name> (Section 2.32), <preamble> (Section 3.6), (Section 2.29), <name> (Section 2.32), <preamble> (Section 3.11),
<refcontent> (Section 2.39), <strong> (Section 2.50), <sub> <refcontent> (Section 2.39), <strong> (Section 2.48), <sub>
(Section 2.51), <sup> (Section 2.52), <t> (Section 2.53), <td> (Section 2.49), <sup> (Section 2.50), <t> (Section 2.51), <td>
(Section 2.56), and <th> (Section 2.58). (Section 2.54), <th> (Section 2.56), and <xref> (Section 2.66).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <br> elements (Section 2.13)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <relref> elements (Section 2.44) o <relref> elements (Section 3.13)
o <strong> elements (Section 2.50) o <strong> elements (Section 2.48)
o <sub> elements (Section 2.51) o <sub> elements (Section 2.49)
o <sup> elements (Section 2.52) o <sup> elements (Section 2.50)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
2.62. <u>
In order to insert Unicode characters in contexts that don't
explicitly allow Unicide, the Unicode string is enclosed within an
<u> element. The element will be expanded inline based on the value
of a "format" attribute. This provides a generalised means of
generating the 6 methods of Unicode renderings listed in [RFC7997],
Section 3.4, and also several others found in for instance the RFC
Format Tools example rendering of RFC 7700.
This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.11), <dd> (Section 2.18), <li>
(Section 2.29), <preamble> (Section 3.11), <t> (Section 2.51), <td>
(Section 2.54), and <th> (Section 2.56).
Content model: only text content.
2.62.1. "anchor" Attribute
Document-wide unique identifier for this <u> element.
2.62.2. "ascii" Attribute
The ASCII equivalent of the content, to be used if the "ascii"
keyword is used in the "format" specification.
2.62.3. "format" Attribute
Default value: "lit-name-num"
The "format" attribute accepts either a simplified format
specification, or a full format string with placeholders for the
various possible Unicode expansions.
The simplified format consists of dash-separated keywords, where each
keyword represents a possible expansion of the Unicode character or
string; use for example "<u "lit-num-name">foo</u>" to expand the
text to its literal value, code point values, and code point names.
A combination of up to 3 of the following keywords may be used,
separated by dashes: "num", "lit", "name", "ascii", "char". The
keywords are expanded as follows and combined, with the second and
third enclosed in parentheses if present:
ascii
The value of the 'ascii' attribute on the <u> element
char
The literal element text, without quotes
lit
The literal element text, enclosed in quotes
name
The Unicode name(s) of the element text
num
The numeric value(s) of the element text, in U+1234 notation
In order to ensure that no specification mistakes can result for
rendering methods that cannot render all Unicode code points, "num"
MUST always be part of the specified format.
In order to provide for cases where the simplified format above is
insufficient, without relinquishing the requirement that the number
of a code point always must be rendered, the "format" attribute can
also accept a full format string. This format uses placeholders
which consist of any of the key words above enclosed in curly braces;
outside of this, any ascii text is permissible. For example,
will be rendered as
As for the simplified format, "num" MUST always be part of the
specified format in order to ensure that no specification mistakes
can result for rendering methods that cannot render all Unicode code
points,
2.63. <ul> 2.63. <ul>
An unordered list. The labels on the items will be symbols picked by An unordered list. The labels on the items will be symbols picked by
the formatter. the formatter.
This element appears as a child element of <abstract> (Section 2.1), This element appears as a child element of <abstract> (Section 2.1),
<aside> (Section 2.6), <blockquote> (Section 2.10), <dd> <aside> (Section 2.7), <blockquote> (Section 2.11), <dd>
(Section 2.18), <li> (Section 2.29), <note> (Section 2.33), <section> (Section 2.18), <li> (Section 2.29), <note> (Section 2.33), <section>
(Section 2.46), <td> (Section 2.56), and <th> (Section 2.58). (Section 2.44), <td> (Section 2.54), and <th> (Section 2.56).
Content model: Content model:
One or more <li> elements (Section 2.29) One or more <li> elements (Section 2.29)
2.63.1. "anchor" Attribute 2.63.1. "anchor" Attribute
Document-wide unique identifier for the list. Document-wide unique identifier for the list.
2.63.2. "empty" Attribute 2.63.2. "bare" Attribute
Can only be used with empty="true" (see below). This attribute
controls whether the blank bullet has an horizontal extension or not.
With bare="false", the empty list bullet will still occupy the same
space as for empty="false". With empty="true", there will be no
bullet at all, i.e., the list items will have no indentation.
Allowed values:
o "true"
o "false" (default)
2.63.3. "empty" Attribute
Defines whether or not the label is empty. empty="true" indicates Defines whether or not the label is empty. empty="true" indicates
that no label will be shown. that no label will be shown.
Allowed values: Allowed values:
o "false" (default) o "false" (default)
o "true" o "true"
2.63.3. "spacing" Attribute 2.63.4. "indent" Attribute
The indentation of the list elements relative to the start of the
bullet or bullet text. A numeric value is interpreted as characters
when rendering plain-text documents, and en-space units otherwise.
Only non-negative integer indentation is allowed.
2.63.5. "spacing" Attribute
Defines whether or not there is a blank line between entries. Defines whether or not there is a blank line between entries.
spacing="normal" indicates a single blank line, while spacing="normal" indicates a single blank line, while
spacing="compact" indicates no space between. spacing="compact" indicates no space between.
Allowed values: Allowed values:
o "normal" (default) o "normal" (default)
o "compact" o "compact"
skipping to change at page 72, line 7 skipping to change at page 76, line 33
This element is used to specify the Working Group (IETF) or Research This element is used to specify the Working Group (IETF) or Research
Group (IRTF) from which the document originates, if any. The Group (IRTF) from which the document originates, if any. The
recommended format is the official name of the Working Group (with recommended format is the official name of the Working Group (with
some capitalization). some capitalization).
In Internet-Drafts, this is used in the upper left corner of the In Internet-Drafts, this is used in the upper left corner of the
boilerplate, replacing the "Network Working Group" string. boilerplate, replacing the "Network Working Group" string.
Formatting software can append the words "Working Group" or "Research Formatting software can append the words "Working Group" or "Research
Group", depending on the "submissionType" property of the <rfc> Group", depending on the "submissionType" property of the <rfc>
element (Section 2.45.12). element (Section 2.43.12).
This element appears as a child element of <front> (Section 2.26). This element appears as a child element of <front> (Section 2.26).
Content model: only text content. Content model: only text content.
2.66. <xref> 2.66. <xref>
A reference to an anchor in this document. Formatters that have A reference to an anchor in this document. Formatters that have
links (such as HTML and PDF) are likely to render <xref> elements as links (such as HTML and PDF) are likely to render <xref> elements as
internal hyperlinks. This element is useful for referring to internal hyperlinks. This element is useful for referring to
references in the "References" section, to specific sections of this references in the "References" section, to specific sections of this
document, to specific figures, and so on. The "target" attribute is document, to specific figures, and so on. The "target" attribute is
required. required.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.10), <c> (Section 3.1), <cref> (Section 2.3), <blockquote> (Section 2.11), <c> (Section 3.1), <cref>
(Section 2.16), <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.16), <dd> (Section 2.18), <dt> (Section 2.21), <em>
(Section 2.22), <li> (Section 2.29), <name> (Section 2.32), (Section 2.22), <li> (Section 2.29), <name> (Section 2.32),
<postamble> (Section 3.5), <preamble> (Section 3.6), <strong> <postamble> (Section 3.10), <preamble> (Section 3.11), <strong>
(Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52), <t> (Section 2.48), <sub> (Section 2.49), <sup> (Section 2.50), <t>
(Section 2.53), <td> (Section 2.56), <th> (Section 2.58), <tt> (Section 2.51), <td> (Section 2.54), <th> (Section 2.56), <tt>
(Section 2.62), and <ttcol> (Section 3.9). (Section 2.61), and <ttcol> (Section 3.18).
Content model: only text content. Content model:
In any order:
o Text
o <em> elements (Section 2.22)
o <strong> elements (Section 2.48)
o <sub> elements (Section 2.49)
o <sup> elements (Section 2.50)
o <tt> elements (Section 2.61)
2.66.1. "format" Attribute 2.66.1. "format" Attribute
This attribute signals to formatters what the desired format of the This attribute signals to formatters what the desired format of the
reference should be. Formatters for document types that have linking reference should be. Formatters for document types that have linking
capability should wrap the displayed text in hyperlinks. capability should wrap the displayed text in hyperlinks.
"counter" "counter"
The "derivedContent" attribute will contain just a counter. This The "derivedContent" attribute will contain just a counter. This
is used for targets that are <section>, <figure>, <table>, or is used for targets that are <section>, <figure>, <table>, or
items in an ordered list. Using "format='counter'" where the items in an ordered list. Using "format='counter'" where the
target is any other type of element is an error. target is any other type of element is an error.
For example, with an input of: For example, with an input of:
<section anchor="overview">Protocol Overview</section> <section anchor="overview">Protocol Overview</section>
. . . . . .
See Section <xref target="overview" format="counter"/> See Section <xref target="overview" format="counter"/>
for an overview. for an overview.
An HTML formatter might generate: An HTML formatter might generate:
See Section <a href="#overview">1.7</a> for an overview. See Section <a href="#overview">1.7</a> for an overview.
"default" "default"
If the element has no content, the "derivedContent" attribute will If the element has no content, the "derivedContent" attribute will
contain a text fragment that describes the referenced part contain a text fragment that describes the referenced part
completely, such as "XML" for a target that is a <reference>, or completely, such as "XML" for a target that is a <reference>, or
"Section 2" or "Table 4" for a target to a non-reference. (If the "Section 2" or "Table 4" for a target to a non-reference. (If the
element has content, the "derivedContent" attribute is filled with element has content, the "derivedContent" attribute is filled with
the content.) the content.)
For example, with an input of: For example, with an input of:
<section anchor="overview">Protocol Overview</section> <section anchor="overview">Protocol Overview</section>
. . . . . .
See <xref target="overview"/> for an overview. See <xref target="overview"/> for an overview.
An HTML formatter might generate: An HTML formatter might generate:
See <a href="#overview">Section 1.7</a> for an overview. See <a href="#overview">Section 1.7</a> for an overview.
"none" "none"
Deprecated. There will be no autogenerated text at all (this format only makes
sense if the <xref> element has text content).
"title" For example, with an input of:
<section anchor="overview">Protocol Overview</section>
. . .
See <xref target="overview" format="none">section above</xref>
for an overview.
An HTML formatter might generate:
See <a href="#overview">section above</a> for an overview.
"title"
If the target is a <reference> element, the "derivedContent" If the target is a <reference> element, the "derivedContent"
attribute will contain the name of the reference, extracted from attribute will contain the name of the reference, extracted from
the <title> child of the <front> child of the reference. Or, if the <title> child of the <front> child of the reference. Or, if
the target element has a <name> child element, the the target element has a <name> child element, the
"derivedContent" attribute will contain the text content of that "derivedContent" attribute will contain the text content of that
<name> element concatenated with the text content of each <name> element concatenated with the text content of each
descendant node of <name> (that is, stripping out all of the XML descendant node of <name> (that is, stripping out all of the XML
markup, leaving only the text). Or, if the target element does markup, leaving only the text). Or, if the target element does
not contain a <name> child element, the "derivedContent" attribute not contain a <name> child element, the "derivedContent" attribute
will contain the name of the "anchor" attribute of that element will contain the name of the "anchor" attribute of that element
skipping to change at page 74, line 4 skipping to change at page 79, line 17
markup, leaving only the text). Or, if the target element does markup, leaving only the text). Or, if the target element does
not contain a <name> child element, the "derivedContent" attribute not contain a <name> child element, the "derivedContent" attribute
will contain the name of the "anchor" attribute of that element will contain the name of the "anchor" attribute of that element
with no other adornment. with no other adornment.
Allowed values: Allowed values:
o "default" (default) o "default" (default)
o "title" o "title"
o "counter" o "counter"
o "none" o "none"
2.66.2. "pageno" Attribute 2.66.2. "pageno" Attribute
Deprecated. Deprecated.
Allowed values: Allowed values:
o "true" o "true"
o "false" (default) o "false" (default)
2.66.3. "target" Attribute (Mandatory) 2.66.3. "relative" Attribute
Specifies a relative reference from the URI in the target reference.
This value must include whatever leading character is needed to
create the relative reference; typically "#" for HTML documents.
2.66.4. "section" Attribute
Specifies a section of the target reference. If the reference is not
an RFC or Internet-Draft in the v3 format, and no "relative"
attribute has been provided, it is an error.
2.66.5. "sectionFormat" Attribute
This attribute tells formatters the desired format of the external
reference. Formatters for document types that have linking
capability should wrap each part of the displayed text in hyperlinks.
If there is content in the <xref> element, that content will be used
when rendering the internal link part of the <xref> rendering, but
will not affect the external link.
"of"
The <xref> element will be displayed as an external link followed
by an internal link, separated by the word 'of'. The external
link will have as its display text the word "Section" followed by
a space and the contents of the "section" attribute. This will be
followed by a space, the word "of", another space, and an internal
link to the relevant <reference> entry, formatted based on the
"format" attribute.
"comma"
The <xref> element will be displayed as an internal link followed
by an external link, separated by a comma. The external link will
have as its display text the word "Section" followed by a space
and the contents of the "section" attribute. The internal link
will point to the relevant <reference> entry, and will be rendered
according to the "format" attribute.
"parens"
The <xref> element will be displayed as an internal link followed
by an external link within parentheses. The external link will
have as its display text the word "Section" followed by a space
and the contents of the "section" attribute. The internal link
will point to the relevant <reference> entry, and will be rendered
according to the "format" attribute.
"bare"
The <xref> element will be displayed as an external link, possibly
followed by the same link within parentheses. The first external
link will have as its display text only contents of the "section"
attribute; the second link will be present within parentheses only
if the <xref> element has any text content, and will then have the
text content as its display text.
This value for the "sectionFormat" attribute is useful when it is
desired to express for instance "Sections 3.2 and 3.3 of
[RFC7997]".
Allowed values:
o "of" (default)
o "comma"
o "parens"
o "bare"
2.66.6. "target" Attribute (Mandatory)
Identifies the document component being referenced. The value needs Identifies the document component being referenced. The value needs
to match the value of the "anchor" attribute of an element in the to match the value of the "anchor" attribute of an element in the
document; otherwise, it is an error. document; otherwise, it is an error.
3. Elements from v2 That Have Been Deprecated 3. Elements from v2 and original v3 That Have Been Deprecated
This section lists the elements from v2 that have been deprecated. This section lists the elements from v2 and the original version of
Note that some elements in v3 have attributes from v2 that are v3 that have been deprecated. Note that some elements in v3 have
deprecated; those are not listed here. attributes from v2 that are deprecated; those are not listed here.
3.1. <c> 3.1. <c>
Deprecated. Instead, use <tr>, <td>, and <th>. Deprecated. Instead, use <tr>, <td>, and <th>.
This element appears as a child element of <texttable> (Section 3.8). This element appears as a child element of <texttable>
(Section 3.17).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <spanx> elements (Section 3.7)
o <strong> elements (Section 2.50) o <spanx> elements (Section 3.15)
o <sub> elements (Section 2.51) o <xref> elements (Section 2.66)
o <sup> elements (Section 2.52) 3.2. <city>
o <tt> elements (Section 2.62) Deprecated, use <postalLine> instead.
o <xref> elements (Section 2.66) This element appears as a child element of <postal> (Section 2.37).
3.2. <facsimile> Content model: only text content.
3.2.1. "ascii" Attribute
The ASCII equivalent of the city name.
3.3. <cityarea>
Deprecated, use <postalLine> instead.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
3.3.1. "ascii" Attribute
The ASCII equivalent of the city area name.
3.4. <code>
Deprecated, use <postalLine> instead.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
3.4.1. "ascii" Attribute
The ASCII equivalent of the postal code.
3.5. <extaddr>
Deprecated, use <postalLine> instead.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
3.5.1. "ascii" Attribute
ASCII equivalent for extaddr.
3.6. <facsimile>
Deprecated. The <email> element is a much more useful way to get in Deprecated. The <email> element is a much more useful way to get in
touch with authors. touch with authors.
This element appears as a child element of <address> (Section 2.2). This element appears as a child element of <address> (Section 2.2).
Content model: only text content. Content model: only text content.
3.3. <format> 3.7. <format>
Deprecated. If the goal is to provide a single URI for a reference, Deprecated. If the goal is to provide a single URI for a reference,
use the "target" attribute in <reference> instead. use the "target" attribute in <reference> instead.
This element appears as a child element of <reference> This element appears as a child element of <reference>
(Section 2.40). (Section 2.40).
Content model: this element does not have any contents. Content model: this element does not have any contents.
3.3.1. "octets" Attribute 3.7.1. "octets" Attribute
Deprecated. Deprecated.
3.3.2. "target" Attribute 3.7.2. "target" Attribute
Deprecated. Deprecated.
3.3.3. "type" Attribute (Mandatory) 3.7.3. "type" Attribute (Mandatory)
Deprecated. Deprecated.
3.4. <list> 3.8. <list>
Deprecated. Instead, use <dl> for list/@style "hanging"; <ul> for Deprecated. Instead, use <dl> for list/@style "hanging"; <ul> for
list/@style "empty" or "symbols"; and <ol> for list/@style "letters", list/@style "empty" or "symbols"; and <ol> for list/@style "letters",
"numbers", "counter", or "format". "numbers", "counter", or "format".
This element appears as a child element of <t> (Section 2.53).
Content model: Content model:
One or more <t> elements (Section 2.53) One or more <t> elements (Section 2.51)
3.4.1. "counter" Attribute 3.8.1. "counter" Attribute
Deprecated. The functionality of this attribute has been replaced Deprecated. The functionality of this attribute has been replaced
with <ol>/@start. with <ol>/@start.
3.4.2. "hangIndent" Attribute 3.8.2. "hangIndent" Attribute
Deprecated. Use <dl> instead. Deprecated. Use <dl> instead.
3.4.3. "style" Attribute 3.8.3. "style" Attribute
Deprecated. Deprecated.
3.5. <postamble> 3.9. <pobox>
Deprecated, use <postalLine> instead.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
3.9.1. "ascii" Attribute
ASCII equivalent for pobox.
3.10. <postamble>
Deprecated. Instead, use a regular paragraph after the figure or Deprecated. Instead, use a regular paragraph after the figure or
table. table.
This element appears as a child element of <figure> (Section 2.25) This element appears as a child element of <figure> (Section 2.25)
and <texttable> (Section 3.8). and <texttable> (Section 3.17).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <spanx> elements (Section 3.7) o <spanx> elements (Section 3.15)
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) o <xref> elements (Section 2.66)
3.6. <preamble> 3.11. <preamble>
Deprecated. Instead, use a regular paragraph before the figure or Deprecated. Instead, use a regular paragraph before the figure or
table. table.
This element appears as a child element of <figure> (Section 2.25) This element appears as a child element of <figure> (Section 2.25)
and <texttable> (Section 3.8). and <texttable> (Section 3.17).
Content model: Content model:
In any order: In any order:
o Text o Text
o <bcp14> elements (Section 2.9) o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <em> elements (Section 2.22) o <em> elements (Section 2.22)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <spanx> elements (Section 3.7) o <relref> elements (Section 3.13)
o <strong> elements (Section 2.50) o <spanx> elements (Section 3.15)
o <sub> elements (Section 2.51) o <strong> elements (Section 2.48)
o <sup> elements (Section 2.52) o <sub> elements (Section 2.49)
o <tt> elements (Section 2.62) o <sup> elements (Section 2.50)
o <tt> elements (Section 2.61)
o <u> elements (Section 2.62)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
3.7. <spanx> 3.12. <region>
Deprecated, use <postalLine> instead.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
3.12.1. "ascii" Attribute
The ASCII equivalent of the region name.
3.13. <relref>
Deprecated, use <xref> instead.
Represents a link to a specific part of a document that appears in a
<reference> element. Formatters that have links (such as HTML and
PDF) render <relref> elements as external hyperlinks to the specified
part of the reference, creating the link target by combining the base
URI from the <reference> element with the "relative" attribute from
this element. The "target" attribute is required, and it must be the
anchor of a <reference> element.
The "section" attribute is required, and the "relative" attribute is
optional. If the reference is not an RFC or Internet-Draft that is
in the v3 format, the element needs to have a "relative" attribute;
in this case, the value of the "section" attribute is ignored.
An example of the <relref> element with text content might be:
See
<relref section="2.3" target="RFC9999" displayFormat="bare">
the protocol overview</relref>
for more information.
An HTML formatter might generate:
See
<a href="http://www.rfc-editor.org/rfc/rfc9999.html#s-2.3">
the protocol overview</a>
for more information.
Note that the URL in the above example might be different when the
RFC Editor deploys the v3 format.
This element appears as a child element of <annotation>
(Section 2.3), <blockquote> (Section 2.11), <cref> (Section 2.16),
<dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
(Section 2.29), <name> (Section 2.32), <preamble> (Section 3.11),
<strong> (Section 2.48), <sub> (Section 2.49), <sup> (Section 2.50),
<t> (Section 2.51), <td> (Section 2.54), <th> (Section 2.56), and
<tt> (Section 2.61).
Content model: only text content.
3.13.1. "displayFormat" Attribute
This attribute is used to signal formatters what the desired format
of the relative reference should be. Formatters for document types
that have linking capability should wrap each part of the displayed
text in hyperlinks. If there is content in the <relref> element,
formatters will ignore the value of this attribute.
"of"
A formatter should display the relative reference as the word
"Section" followed by a space, the contents of the "section"
attribute followed by a space, the word "of", another space, and
the value from the "target" attribute enclosed in square brackets.
For example, with an input of:
See
<relref section="2.3" target="RFC9999" displayFormat="of"/>
for an overview.
An HTML formatter might generate:
See
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
Section 2.3</a> of
[<a href="#RFC9999">RFC9999</a>]
for an overview.
Note that "displayFormat='of'" is the default for <relref>, so it
does not need to be given in a <relref> element if that format is
desired.
"comma"
A formatter should display the relative reference as the value
from the "target" attribute enclosed in square brackets, a comma,
a space, the word "Section" followed by a space, and the "section"
attribute.
For example, with an input of:
See
<relref section="2.3" target="RFC9999" displayFormat="comma"/>,
for an overview.
An HTML formatter might generate:
See
[<a href="#RFC9999">RFC9999</a>],
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
Section 2.3</a>, for an overview.
"parens"
A formatter should display the relative reference as the value
from the "target" attribute enclosed in square brackets, a space,
a left parenthesis, the word "Section" followed by a space, the
"section" attribute, and a right parenthesis.
For example, with an input of:
See
<relref section="2.3" target="RFC9999" displayFormat="parens"/>
for an overview.
An HTML formatter might generate:
See
[<a href="#RFC9999">RFC9999</a>]
(<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
Section 2.3</a>)
for an overview.
"bare"
A formatter should display the relative reference as the contents
of the "section" attribute and nothing else. This is useful when
there are multiple relative references to a single base reference.
For example:
See Sections
<relref section="2.3" target="RFC9999" displayFormat="bare"/>
and
<relref section="2.4" target="RFC9999" displayFormat="of"/>
for an overview.
An HTML formatter might generate:
See Sections
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
2.3</a>
and
<a href="http://www.rfc-editor.org/info/rfc9999#s-2.4">
Section 2.4</a> of
[<a href="#RFC9999">RFC9999</a>]
for an overview.
Allowed values:
o "of" (default)
o "comma"
o "parens"
o "bare"
3.13.2. "relative" Attribute
Specifies a relative reference from the URI in the target reference.
This value must include whatever leading character is needed to
create the relative reference; typically, this is "#" for HTML
documents.
3.13.3. "section" Attribute (Mandatory)
Specifies a section of the target reference. If the reference is not
an RFC or Internet-Draft in the v3 format, it is an error.
3.13.4. "target" Attribute (Mandatory)
The anchor of the reference for this element. If this value is not
an anchor to a <reference> or <referencegroup> element, it is an
error. If the reference at the target has no URI, it is an error.
3.14. <sortingcode>
Deprecated, use <postalLine> instead.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
3.14.1. "ascii" Attribute
ASCII equivalent for sortingcode.
3.15. <spanx>
Deprecated. Deprecated.
This element appears as a child element of <annotation> This element appears as a child element of <annotation>
(Section 2.3), <c> (Section 3.1), <postamble> (Section 3.5), (Section 2.3), <c> (Section 3.1), <postamble> (Section 3.10),
<preamble> (Section 3.6), and <t> (Section 2.53). <preamble> (Section 3.11), and <t> (Section 2.51).
Content model: only text content. Content model: only text content.
3.7.1. "style" Attribute 3.15.1. "style" Attribute
Deprecated. Instead of <spanx style="emph">, use <em>; instead of Deprecated. Instead of <spanx style="emph">, use <em>; instead of
<spanx style="strong">, use <strong>; instead of <spanx <spanx style="strong">, use <strong>; instead of <spanx
style="verb">, use <tt>. style="verb">, use <tt>.
3.7.2. "xml:space" Attribute 3.15.2. "xml:space" Attribute
Deprecated. Deprecated.
Allowed values: Allowed values:
o "default" o "default"
o "preserve" (default) o "preserve" (default)
3.8. <texttable> 3.16. <street>
Deprecated, use <postalLine> instead.
This element appears as a child element of <postal> (Section 2.37).
Content model: only text content.
3.16.1. "ascii" Attribute
The ASCII equivalent of the street address.
3.17. <texttable>
Deprecated. Use <table> instead. Deprecated. Use <table> instead.
This element appears as a child element of <aside> (Section 2.6) and This element appears as a child element of <section> (Section 2.44).
<section> (Section 2.46).
Content model: Content model:
In this order: In this order:
1. One optional <name> element (Section 2.32) 1. One optional <name> element (Section 2.32)
2. One optional <preamble> element (Section 3.6) 2. One optional <preamble> element (Section 3.11)
3. One or more <ttcol> elements (Section 3.9) 3. One or more <ttcol> elements (Section 3.18)
4. Optional <c> elements (Section 3.1) 4. Optional <c> elements (Section 3.1)
5. One optional <postamble> element (Section 3.5) 5. One optional <postamble> element (Section 3.10)
3.8.1. "align" Attribute 3.17.1. "align" Attribute
Deprecated. Deprecated.
Allowed values: Allowed values:
o "left" o "left"
o "center" (default) o "center" (default)
o "right" o "right"
3.8.2. "anchor" Attribute 3.17.2. "anchor" Attribute
Deprecated. Deprecated.
3.8.3. "style" Attribute 3.17.3. "style" Attribute
Deprecated. Deprecated.
3.8.4. "suppress-title" Attribute Allowed values:
o "all"
o "none"
o "headers"
o "full" (default)
3.17.4. "suppress-title" Attribute
Deprecated. Deprecated.
Allowed values: Allowed values:
o "true" o "true"
o "false" (default) o "false" (default)
3.8.5. "title" Attribute 3.17.5. "title" Attribute
Deprecated. Deprecated.
3.9. <ttcol> 3.18. <ttcol>
Deprecated. Instead, use <tr>, <td>, and <th>. Deprecated. Instead, use <tr>, <td>, and <th>.
This element appears as a child element of <texttable> (Section 3.8). This element appears as a child element of <texttable>
(Section 3.17).
Content model: Content model:
In any order: In any order:
o Text
o <cref> elements (Section 2.16) o <cref> elements (Section 2.16)
o <eref> elements (Section 2.24) o <eref> elements (Section 2.24)
o <iref> elements (Section 2.27) o <iref> elements (Section 2.27)
o <xref> elements (Section 2.66) o <xref> elements (Section 2.66)
3.9.1. "align" Attribute o Text
3.18.1. "align" Attribute
Deprecated. Deprecated.
Allowed values: Allowed values:
o "left" (default) o "left" (default)
o "center" o "center"
o "right" o "right"
3.9.2. "width" Attribute 3.18.2. "width" Attribute
Deprecated. Deprecated.
3.10. <vspace> 3.19. <vspace>
Deprecated. In earlier versions of this format, <vspace> was often Deprecated. In earlier versions of this format, <vspace> was often
used to get an extra blank line in a list element; in the v3 used to get an extra blank line in a list element; in the v3
vocabulary, that can be done instead by using multiple <t> elements vocabulary, that can be done instead by using multiple <t> elements
inside the <li> element. Other uses have no direct replacement. inside the <li> element. Other uses have no direct replacement.
This element appears as a child element of <t> (Section 2.53). This element appears as a child element of <t> (Section 2.51).
Content model: this element does not have any contents. Content model: this element does not have any contents.
3.10.1. "blankLines" Attribute 3.19.1. "blankLines" Attribute
Deprecated. Deprecated.
4. SVG 4. SVG
The discussion of the use of SVG can be found in [RFC7996]. This The discussion of the use of SVG can be found in [RFC7996]. This
element is part of the namespace "http://www.w3.org/2000/svg". element is part of the namespace "http://www.w3.org/2000/svg".
5. Use of CDATA Structures and Escaping 5. Use of CDATA Structures and Escaping
skipping to change at page 81, line 38 skipping to change at page 94, line 23
6. Internationalization Considerations 6. Internationalization Considerations
This format is based on [XML] and thus does not have any issues This format is based on [XML] and thus does not have any issues
representing arbitrary Unicode [UNICODE] characters in text content. representing arbitrary Unicode [UNICODE] characters in text content.
The RFC Series Editor may restrict some of the characters that can be The RFC Series Editor may restrict some of the characters that can be
used in a particular RFC; the rules for such restrictions are covered used in a particular RFC; the rules for such restrictions are covered
in [RFC7997]. in [RFC7997].
7. Security Considerations 7. Security Considerations
The "name" attribute of the <artwork> element (Section 2.5.5) can be The "name" attribute of the <artwork> element (Section 2.6.5) can be
used to derive a filename for saving to a local file system. used to derive a filename for saving to a local file system.
Trusting this kind of information without pre-processing is a known Trusting this kind of information without pre-processing is a known
security risk; see Section 4.3 of [RFC6266] for more information. security risk; see Section 4.3 of [RFC6266] for more information.
The "src" attribute of the <artwork> element can be used to read The "src" attribute of the <artwork> element can be used to read
files from the local system. Processing tools must be careful to not files from the local system. Processing tools must be careful to not
accept dangerous values for the filename, particularly those that accept dangerous values for the filename, particularly those that
contain absolute references outside the current directory. contain absolute references outside the current directory.
The "type" attribute of the <artwork> and <sourcecode> elements is The "type" attribute of the <artwork> and <sourcecode> elements is
skipping to change at page 84, line 14 skipping to change at page 96, line 47
is also different than "previous" in that this relation is used for is also different than "previous" in that this relation is used for
converted resources, not those that are part of a sequence of converted resources, not those that are part of a sequence of
resources. resources.
Application Data: None Application Data: None
9. References 9. References
9.1. Normative References 9.1. Normative References
[BCP14] Bradner, S., "Key words for use in RFCs to Indicate [BCP14] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997, Requirement Levels", BCP 14, RFC 2119, March 1997,
<http://www.rfc-editor.org/info/bcp14>. <http://www.rfc-editor.org/info/bcp14>.
[XML] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, [RFC7991] Hoffman, P., "The "xml2rfc" Version 3 Vocabulary",
E., and F. Yergeau, "Extensible Markup Language RFC 7991, DOI 10.17487/RFC7991, December 2016,
(XML) 1.0 (Fifth Edition)", W3C Recommendation REC- <https://www.rfc-editor.org/info/rfc7991>.
xml-20081126, November 2008,
<https://www.w3.org/TR/2008/REC-xml-20081126/>.
Latest version available at [XML] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and
<http://www.w3.org/TR/xml>. F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
Edition)", W3C Recommendation REC-xml-20081126, November
2008, <https://www.w3.org/TR/2008/REC-xml-20081126/>.
Latest version available at <http://www.w3.org/TR/xml>.
9.2. Informative References 9.2. Informative References
[IDGUIDE] Housley, R., "Guidelines to Authors of Internet- [IDGUIDE] Housley, R., "Guidelines to Authors of Internet-Drafts",
Drafts", December 2010, December 2010,
<https://www.ietf.org/id-info/guidelines.html>. <https://www.ietf.org/id-info/guidelines.html>.
[LINKRELATIONS] IANA, "Link Relations", <https://www.iana.org/ [LINKRELATIONS]
assignments/link-relations/link-relations.xhtml>. IANA, "Link Relations", <https://www.iana.org/assignments/
link-relations/link-relations.xhtml>.
[RFC2026] Bradner, S., "The Internet Standards Process -- [RFC2026] Bradner, S., "The Internet Standards Process -- Revision
Revision 3", BCP 9, RFC 2026, DOI 10.17487/RFC2026, 3", BCP 9, RFC 2026, DOI 10.17487/RFC2026, October 1996,
October 1996, <https://www.rfc-editor.org/info/rfc2026>.
<https://www.rfc-editor.org/info/rfc2026>.
[RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397, [RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397,
DOI 10.17487/RFC2397, August 1998, DOI 10.17487/RFC2397, August 1998,
<https://www.rfc-editor.org/info/rfc2397>. <https://www.rfc-editor.org/info/rfc2397>.
[RFC2629] Rose, M., "Writing I-Ds and RFCs using XML", [RFC2629] Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629,
RFC 2629, DOI 10.17487/RFC2629, June 1999, DOI 10.17487/RFC2629, June 1999,
<https://www.rfc-editor.org/info/rfc2629>. <https://www.rfc-editor.org/info/rfc2629>.
[RFC3339] Klyne, G. and C. Newman, "Date and Time on the [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet:
Internet: Timestamps", RFC 3339, DOI 10.17487/ Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002,
RFC3339, July 2002, <https://www.rfc-editor.org/info/rfc3339>.
<https://www.rfc-editor.org/info/rfc3339>.
[RFC3470] Hollenbeck, S., Rose, M., and L. Masinter, [RFC3470] Hollenbeck, S., Rose, M., and L. Masinter, "Guidelines for
"Guidelines for the Use of Extensible Markup the Use of Extensible Markup Language (XML) within IETF
Language (XML) within IETF Protocols", BCP 70, Protocols", BCP 70, RFC 3470, DOI 10.17487/RFC3470,
RFC 3470, DOI 10.17487/RFC3470, January 2003, January 2003, <https://www.rfc-editor.org/info/rfc3470>.
<https://www.rfc-editor.org/info/rfc3470>.
[RFC3667] Bradner, S., "IETF Rights in Contributions", [RFC3667] Bradner, S., "IETF Rights in Contributions", RFC 3667,
RFC 3667, DOI 10.17487/RFC3667, February 2004, DOI 10.17487/RFC3667, February 2004,
<https://www.rfc-editor.org/info/rfc3667>. <https://www.rfc-editor.org/info/rfc3667>.
[RFC3966] Schulzrinne, H., "The tel URI for Telephone [RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers",
Numbers", RFC 3966, DOI 10.17487/RFC3966, RFC 3966, DOI 10.17487/RFC3966, December 2004,
December 2004, <https://www.rfc-editor.org/info/rfc3966>.
<https://www.rfc-editor.org/info/rfc3966>.
[RFC3978] Bradner, S., Ed., "IETF Rights in Contributions", [RFC3978] Bradner, S., Ed., "IETF Rights in Contributions",
RFC 3978, DOI 10.17487/RFC3978, March 2005, RFC 3978, DOI 10.17487/RFC3978, March 2005,
<https://www.rfc-editor.org/info/rfc3978>. <https://www.rfc-editor.org/info/rfc3978>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
"Uniform Resource Identifier (URI): Generic Syntax", Resource Identifier (URI): Generic Syntax", STD 66,
STD 66, RFC 3986, DOI 10.17487/RFC3986, RFC 3986, DOI 10.17487/RFC3986, January 2005,
January 2005, <https://www.rfc-editor.org/info/rfc3986>.
<https://www.rfc-editor.org/info/rfc3986>.
[RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Syntax Specifications: ABNF", STD 68, RFC 5234, Specifications: ABNF", STD 68, RFC 5234,
DOI 10.17487/RFC5234, January 2008, DOI 10.17487/RFC5234, January 2008,
<https://www.rfc-editor.org/info/rfc5234>. <https://www.rfc-editor.org/info/rfc5234>.
[RFC5378] Bradner, S., Ed. and J. Contreras, Ed., "Rights [RFC5378] Bradner, S., Ed. and J. Contreras, Ed., "Rights
Contributors Provide to the IETF Trust", BCP 78, Contributors Provide to the IETF Trust", BCP 78, RFC 5378,
RFC 5378, DOI 10.17487/RFC5378, November 2008, DOI 10.17487/RFC5378, November 2008,
<https://www.rfc-editor.org/info/rfc5378>. <https://www.rfc-editor.org/info/rfc5378>.
[RFC6068] Duerst, M., Masinter, L., and J. Zawinski, "The [RFC6068] Duerst, M., Masinter, L., and J. Zawinski, "The 'mailto'
'mailto' URI Scheme", RFC 6068, DOI 10.17487/ URI Scheme", RFC 6068, DOI 10.17487/RFC6068, October 2010,
RFC6068, October 2010, <https://www.rfc-editor.org/info/rfc6068>.
<https://www.rfc-editor.org/info/rfc6068>.
[RFC6266] Reschke, J., "Use of the Content-Disposition Header [RFC6266] Reschke, J., "Use of the Content-Disposition Header Field
Field in the Hypertext Transfer Protocol (HTTP)", in the Hypertext Transfer Protocol (HTTP)", RFC 6266,
RFC 6266, DOI 10.17487/RFC6266, June 2011, DOI 10.17487/RFC6266, June 2011,
<https://www.rfc-editor.org/info/rfc6266>. <https://www.rfc-editor.org/info/rfc6266>.
[RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type
Specifications and Registration Procedures", BCP 13, Specifications and Registration Procedures", BCP 13,
RFC 6838, DOI 10.17487/RFC6838, January 2013, RFC 6838, DOI 10.17487/RFC6838, January 2013,
<https://www.rfc-editor.org/info/rfc6838>. <https://www.rfc-editor.org/info/rfc6838>.
[RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format [RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format
Requirements and Future Development", RFC 6949, Requirements and Future Development", RFC 6949,
DOI 10.17487/RFC6949, May 2013, DOI 10.17487/RFC6949, May 2013,
<https://www.rfc-editor.org/info/rfc6949>. <https://www.rfc-editor.org/info/rfc6949>.
[RFC7303] Thompson, H. and C. Lilley, "XML Media Types", [RFC7303] Thompson, H. and C. Lilley, "XML Media Types", RFC 7303,
RFC 7303, DOI 10.17487/RFC7303, July 2014, DOI 10.17487/RFC7303, July 2014,
<https://www.rfc-editor.org/info/rfc7303>. <https://www.rfc-editor.org/info/rfc7303>.
[RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", [RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322,
RFC 7322, DOI 10.17487/RFC7322, September 2014, DOI 10.17487/RFC7322, September 2014,
<https://www.rfc-editor.org/info/rfc7322>. <https://www.rfc-editor.org/info/rfc7322>.
[RFC7669] Levine, J., "Assigning Digital Object Identifiers to [RFC7669] Levine, J., "Assigning Digital Object Identifiers to
RFCs", RFC 7669, DOI 10.17487/RFC7669, October 2015, RFCs", RFC 7669, DOI 10.17487/RFC7669, October 2015,
<https://www.rfc-editor.org/info/rfc7669>. <https://www.rfc-editor.org/info/rfc7669>.
[RFC7749] Reschke, J., "The "xml2rfc" Version 2 Vocabulary", [RFC7749] Reschke, J., "The "xml2rfc" Version 2 Vocabulary",
RFC 7749, DOI 10.17487/RFC7749, February 2016, RFC 7749, DOI 10.17487/RFC7749, February 2016,
<https://www.rfc-editor.org/info/rfc7749>. <https://www.rfc-editor.org/info/rfc7749>.
[RFC7841] Halpern, J., Ed., Daigle, L., Ed., and O. Kolkman, [RFC7841] Halpern, J., Ed., Daigle, L., Ed., and O. Kolkman, Ed.,
Ed., "RFC Streams, Headers, and Boilerplates", "RFC Streams, Headers, and Boilerplates", RFC 7841,
RFC 7841, DOI 10.17487/RFC7841, May 2016, DOI 10.17487/RFC7841, May 2016,
<https://www.rfc-editor.org/info/rfc7841>. <https://www.rfc-editor.org/info/rfc7841>.
[RFC7996] Brownlee, N., "SVG Drawings for RFCs: SVG 1.2 RFC", [RFC7996] Brownlee, N., "SVG Drawings for RFCs: SVG 1.2 RFC",
RFC 7996, DOI 10.17487/RFC7996, December 2016, RFC 7996, DOI 10.17487/RFC7996, December 2016,
<https://www.rfc-editor.org/info/rfc7996>. <https://www.rfc-editor.org/info/rfc7996>.
[RFC7997] Flanagan, H., Ed., "The Use of Non-ASCII Characters [RFC7997] Flanagan, H., Ed., "The Use of Non-ASCII Characters in
in RFCs", RFC 7997, DOI 10.17487/RFC7997, RFCs", RFC 7997, DOI 10.17487/RFC7997, December 2016,
December 2016, <https://www.rfc-editor.org/info/rfc7997>.
<https://www.rfc-editor.org/info/rfc7997>.
[RFC7998] Hoffman, P. and J. Hildebrand, ""xml2rfc" Version 3 [RFC7998] Hoffman, P. and J. Hildebrand, ""xml2rfc" Version 3
Preparation Tool Description", RFC 7998, Preparation Tool Description", RFC 7998,
DOI 10.17487/RFC7998, December 2016, DOI 10.17487/RFC7998, December 2016,
<https://www.rfc-editor.org/info/rfc7998>. <https://www.rfc-editor.org/info/rfc7998>.
[RNC] Clark, J., "RELAX NG Compact Syntax", The [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of
Organization for the Advancement of Structured Documents Containing YANG Data Models", BCP 216, RFC 8407,
Information Standards (OASIS) , November 2002, <http DOI 10.17487/RFC8407, October 2018,
s://www.oasis-open.org/committees/relax-ng/ <https://www.rfc-editor.org/info/rfc8407>.
compact-20021121.html>.
[RNG] ISO/IEC, "Information Technology - Document Schema [RNC] Clark, J., "RELAX NG Compact Syntax", The Organization for
Definition Languages (DSDL) - Part 2: Regular- the Advancement of Structured Information Standards
Grammar-Based Validation - RELAX NG (Second (OASIS) , November 2002, <https://www.oasis-
Edition)", ISO/IEC 19757-2:2008(E), December 2008. open.org/committees/relax-ng/compact-20021121.html>.
A useful source of RNG-related information is [RNG] ISO/IEC, "Information Technology - Document Schema
<http://relaxng.org/>. Definition Languages (DSDL) - Part 2: Regular-Grammar-
Based Validation - RELAX NG (Second Edition)", ISO/
IEC 19757-2:2008(E), December 2008.
[TLP1.0] IETF Trust, "Legal Provisions Relating to IETF A useful source of RNG-related information is
Documents", November 2008, <http://trustee.ietf.org/ <http://relaxng.org/>.
license-info/IETF-TLP-1.htm>.
[TLP2.0] IETF Trust, "Legal Provisions Relating to IETF [TLP1.0] IETF Trust, "Legal Provisions Relating to IETF Documents",
Documents", February 2009, <http://trustee.ietf.org/ November 2008,
license-info/IETF-TLP-2.htm>. <http://trustee.ietf.org/license-info/IETF-TLP-1.htm>.
[TLP3.0] IETF Trust, "Legal Provisions Relating to IETF [TLP2.0] IETF Trust, "Legal Provisions Relating to IETF Documents",
Documents", September 2009, <http:// February 2009,
trustee.ietf.org/license-info/IETF-TLP-3.htm>. <http://trustee.ietf.org/license-info/IETF-TLP-2.htm>.
[TLP4.0] IETF Trust, "Legal Provisions Relating to IETF [TLP3.0] IETF Trust, "Legal Provisions Relating to IETF Documents",
Documents", December 2009, <http://trustee.ietf.org/ September 2009,
license-info/IETF-TLP-4.htm>. <http://trustee.ietf.org/license-info/IETF-TLP-3.htm>.
[TLP5.0] IETF Trust, "Legal Provisions Relating to IETF [TLP4.0] IETF Trust, "Legal Provisions Relating to IETF Documents",
Documents", March 2015, <http://trustee.ietf.org/ December 2009,
license-info/IETF-TLP-5.htm>. <http://trustee.ietf.org/license-info/IETF-TLP-4.htm>.
[UAX24] The Unicode Consortium, "UAX #24: Unicode Script [TLP5.0] IETF Trust, "Legal Provisions Relating to IETF Documents",
Property", <http://www.unicode.org/reports/tr24/>. March 2015,
<http://trustee.ietf.org/license-info/IETF-TLP-5.htm>.
[UNICODE] The Unicode Consortium, "The Unicode Standard", [UAX24] The Unicode Consortium, "UAX #24: Unicode Script
<http://www.unicode.org/versions/latest/>. Property", <http://www.unicode.org/reports/tr24/>.
[USASCII] American National Standards Institute, "Coded [UNICODE] The Unicode Consortium, "The Unicode Standard",
Character Set -- 7-bit American Standard Code for <http://www.unicode.org/versions/latest/>.
Information Interchange", ANSI X3.4, 1986.
[XInclude] Marsh, J., Orchard, D., and D. Veillard, "XML [USASCII] American National Standards Institute, "Coded Character
Inclusions (XInclude) Version 1.0 (Second Edition)", Set -- 7-bit American Standard Code for Information
W3C Recommendation REC-xinclude-20061115, Interchange", ANSI X3.4, 1986.
November 2006, <https://www.w3.org/TR/xinclude/
REC-xinclude-20061115/>.
Latest version available at [XInclude]
<http://www.w3.org/TR/xinclude/>. Marsh, J., Orchard, D., and D. Veillard, "XML Inclusions
(XInclude) Version 1.0 (Second Edition)", W3C
Recommendation REC-xinclude-20061115, November 2006,
<https://www.w3.org/TR/xinclude/REC-xinclude-20061115/>.
[XPOINTER] Grosso, P., Maler, E., Marsh, J., and N. Walsh, Latest version available at <http://www.w3.org/TR/
"XPointer Framework", W3C Recommendation REC-xptr- xinclude/>.
framework-20030325, March 2003, <http://www.w3.org/
TR/2003/REC-xptr-framework-20030325/>.
Latest version available at [XPOINTER]
<http://www.w3.org/TR/xptr-framework/>. Grosso, P., Maler, E., Marsh, J., and N. Walsh, "XPointer
Framework", W3C Recommendation REC-xptr-framework-
20030325, March 2003,
<http://www.w3.org/TR/2003/REC-xptr-framework-20030325/>.
Latest version available at <http://www.w3.org/TR/xptr-
framework/>.
9.3. Editorial References
[IMPNOTES]
Levkowetz, H., "Implementation notes for RFC7991, "The
'xml2rfc' Version 3 Vocabulary"", draft-levkowetz-xml2rfc-
v3-implementation-notes-10 (work in progress), October
2019.
9.4. URIs
[1] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/34
[2] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/50
[3] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/35
[4] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/51
[5] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/37
[6] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/56
[7] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/38
[8] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/62
[9] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/39
[10] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/63
[11] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/9
[12] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/40
[13] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/68
[14] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/32
[15] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/40
[16] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/69
[17] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/47
[18] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/70
[19] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/76
[20] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/89
[21] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/47
[22] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/69
[23] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/92
[24] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/93
[25] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/95
[26] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/96
[27] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/97
[28] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/108
[29] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/108
[30] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/pull/108
[31] https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/
issues/111
Appendix A. Front-Page ("Boilerplate") Generation Appendix A. Front-Page ("Boilerplate") Generation
The values listed here will be defined by the RFC Series Editor. The values listed here will be defined by the RFC Series Editor.
Those listed here are believed to be the current values in use. Those listed here are believed to be the current values in use.
A.1. The "ipr" Attribute A.1. The "category" Attribute
For RFCs, the "category" attribute (Section 2.43.1) determines the
"maturity level" (see Section 4 of [RFC2026]). The allowed values
are "std" for "Standards Track", "bcp" for "BCP", "info" for
"Informational", "exp" for "Experimental", and "historic" for
"Historic".
For Internet-Drafts, the "category" attribute is not needed; when
supplied, it will appear as "Intended Status". Supplying this
information can be useful to reviewers.
A.2. The "ipr" Attribute
This attribute value can take a long list of values, each of which This attribute value can take a long list of values, each of which
describes an IPR policy for the document (Section 2.45.5). The describes an IPR policy for the document (Section 2.43.5). The
values are not the result of a grand design, but they remain simply values are not the result of a grand design, but they remain simply
for historic reasons. Of these values, only a few are currently in for historic reasons. Of these values, only a few are currently in
use; all others are supported by various tools for backwards use; all others are supported by various tools for backwards
compatibility with old source files. compatibility with old source files.
Note: Some variations of the boilerplate are selected based on the Note: Some variations of the boilerplate are selected based on the
document's date; therefore, it is important to specify the "year", document's date; therefore, it is important to specify the "year",
"month", and "day" attributes of the <date> element when archiving "month", and "day" attributes of the <date> element when archiving
the XML source of an Internet-Draft on the day of submission. the XML source of an Internet-Draft on the day of submission.
_Disclaimer: THIS ONLY PROVIDES IMPLEMENTATION INFORMATION. IF YOU _Disclaimer: THIS ONLY PROVIDES IMPLEMENTATION INFORMATION. IF YOU
NEED LEGAL ADVICE, PLEASE CONTACT A LAWYER._ For further information, NEED LEGAL ADVICE, PLEASE CONTACT A LAWYER._ For further information,
refer to <http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf>. refer to <http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf>.
For the current "Copyright Notice" text, the submissionType attribute For the current "Copyright Notice" text, the submissionType attribute
of the <rfc> element (Section 2.45.12) determines whether a statement of the <rfc> element (Section 2.43.12) determines whether a statement
about "Code Components" is inserted (which is the case for the value about "Code Components" is inserted (which is the case for the value
"IETF", which is the default). Other values, such as "independent", "IETF", which is the default). Other values, such as "independent",
suppress this part of the text. suppress this part of the text.
A.1.1. Current Values: "*trust200902" A.2.1. Current Values: "*trust200902"
The name for these values refers to version 2.0 of the IETF Trust's The name for these values refers to version 2.0 of the IETF Trust's
"Legal Provisions Relating to IETF Documents", sometimes simply "Legal Provisions Relating to IETF Documents", sometimes simply
called the "TLP", which went into effect on February 15, 2009 called the "TLP", which went into effect on February 15, 2009
[TLP2.0]. Updates to the document were published on September 12, [TLP2.0]. Updates to the document were published on September 12,
2009 [TLP3.0] and on December 28, 2009 [TLP4.0], modifying the 2009 [TLP3.0] and on December 28, 2009 [TLP4.0], modifying the
license for code components (see license for code components (see <http://trustee.ietf.org/license-
<http://trustee.ietf.org/license-info/> for further information). info/> for further information). The actual text is located in
The actual text is located in Section 6 ("Text to Be Included in IETF Section 6 ("Text to Be Included in IETF Documents") of these
Documents") of these documents. documents.
The prep tool automatically produces the "correct" text, depending on The prep tool automatically produces the "correct" text, depending on
the document's date information (see above): the document's date information (see above):
+----------+--------------------------------+ +----------+--------------------------------+
| TLP | starting with publication date | | TLP | starting with publication date |
+----------+--------------------------------+ +----------+--------------------------------+
| [TLP3.0] | 2009-11-01 | | [TLP3.0] | 2009-11-01 |
| [TLP4.0] | 2010-04-01 | | [TLP4.0] | 2010-04-01 |
+----------+--------------------------------+ +----------+--------------------------------+
The TLP was again updated in March 2015 [TLP5.0], but the changes The TLP was again updated in March 2015 [TLP5.0], but the changes
made in that version do not affect the boilerplate text. made in that version do not affect the boilerplate text.
A.1.1.1. trust200902 A.2.1.1. trust200902
This value should be used unless one of the more specific This value should be used unless one of the more specific
"*trust200902" values is a better fit. It produces the text in "*trust200902" values is a better fit. It produces the text in
Sections 6.a and 6.b of the TLP. Sections 6.a and 6.b of the TLP.
A.1.1.2. noModificationTrust200902 A.2.1.2. noModificationTrust200902
This produces the additional text from Section 6.c.i of the TLP: This produces the additional text from Section 6.c.i of the TLP:
This document may not be modified, and derivative works of it may This document may not be modified, and derivative works of it may
not be created, except to format it for publication as an RFC or not be created, except to format it for publication as an RFC or
to translate it into languages other than English. to translate it into languages other than English.
Note: this clause is incompatible with RFCs that are published on Note: this clause is incompatible with RFCs that are published on
the Standards Track. the Standards Track.
A.1.1.3. noDerivativesTrust200902 A.2.1.3. noDerivativesTrust200902
This produces the additional text from Section 6.c.ii of the TLP: This produces the additional text from Section 6.c.ii of the TLP:
This document may not be modified, and derivative works of it may This document may not be modified, and derivative works of it may
not be created, and it may not be published except as an Internet- not be created, and it may not be published except as an Internet-
Draft. Draft.
Note: this clause is incompatible with RFCs. Note: this clause is incompatible with RFCs.
A.1.1.4. pre5378Trust200902 A.2.1.4. pre5378Trust200902
This produces the additional text from Section 6.c.iii of the TLP, This produces the additional text from Section 6.c.iii of the TLP,
frequently called the "pre-5378 escape clause" referring to changes frequently called the "pre-5378 escape clause" referring to changes
introduced in [RFC5378]: introduced in [RFC5378]:
This document may contain material from IETF Documents or IETF This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this 10, 2008. The person(s) controlling the copyright in some of this
material may not have granted the IETF Trust the right to allow material may not have granted the IETF Trust the right to allow
modifications of such material outside the IETF Standards Process. modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) Without obtaining an adequate license from the person(s)
controlling the copyright in such materials, this document may not controlling the copyright in such materials, this document may not
be modified outside the IETF Standards Process, and derivative be modified outside the IETF Standards Process, and derivative
works of it may not be created outside the IETF Standards Process, works of it may not be created outside the IETF Standards Process,
except to format it for publication as an RFC or to translate it except to format it for publication as an RFC or to translate it
into languages other than English. into languages other than English.
See Section 4 of See Section 4 of <http://trustee.ietf.org/docs/IETF-Copyright-
<http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf> for further FAQ.pdf> for further information about when to use this value.
information about when to use this value.
Note: this text appears under "Copyright Notice", unless the Note: this text appears under "Copyright Notice", unless the
document was published before November 2009, in which case it document was published before November 2009, in which case it
appears under "Status of This Memo". appears under "Status of This Memo".
A.1.2. Historic Values A.2.2. Historic Values
A.1.2.1. Historic Values: "*trust200811" A.2.2.1. Historic Values: "*trust200811"
The attribute values "trust200811", "noModificationTrust200811", and The attribute values "trust200811", "noModificationTrust200811", and
"noDerivativesTrust200811" are similar to their "trust200902" "noDerivativesTrust200811" are similar to their "trust200902"
counterparts, except that they use text specified in [TLP1.0]. counterparts, except that they use text specified in [TLP1.0].
A.1.2.2. Historic Values: "*3978" A.2.2.2. Historic Values: "*3978"
The attribute values "full3978", "noModification3978", and The attribute values "full3978", "noModification3978", and
"noDerivatives3978" are similar to their counterparts above, except "noDerivatives3978" are similar to their counterparts above, except
that they use text specified in [RFC3978]. that they use text specified in [RFC3978].
A.1.2.3. Historic Values: "*3667" A.2.2.3. Historic Values: "*3667"
The attribute values "full3667", "noModification3667", and The attribute values "full3667", "noModification3667", and
"noDerivatives3667" are similar to their counterparts above, except "noDerivatives3667" are similar to their counterparts above, except
that they use text specified in [RFC3667]. that they use text specified in [RFC3667].
A.1.2.4. Historic Values: "*2026" A.2.2.4. Historic Values: "*2026"
The attribute values "full2026" and "noDerivativeWorks2026" are The attribute values "full2026" and "noDerivativeWorks2026" are
similar to their counterparts above, except that they use text similar to their counterparts above, except that they use text
specified in Section 10 of [RFC2026]. specified in Section 10 of [RFC2026].
The special value "none" was also used back then; it denied the IETF The special value "none" was also used back then; it denied the IETF
any rights beyond publication as an Internet-Draft. any rights beyond publication as an Internet-Draft.
A.2. The "submissionType" Attribute A.3. The "submissionType" Attribute
The RFC Editor publishes documents from different "document streams", The RFC Editor publishes documents from different "document streams",
of which the "IETF stream" is the most prominent. Other streams are of which the "IETF stream" is the most prominent. Other streams are
the "Independent Submissions stream" (used for things such as the "Independent Submissions stream" (used for things such as
discussion of Internet-related technologies that are not part of the discussion of Internet-related technologies that are not part of the
IETF agenda), the "IAB stream" (Internet Architecture Board), and the IETF agenda), the "IAB stream" (Internet Architecture Board), and the
"IRTF stream" (Internet Research Task Force). "IRTF stream" (Internet Research Task Force).
The values for the attribute are "IETF" (the default value), The values for the attribute are "IETF" (the default value),
"independent", "IAB", and "IRTF". "independent", "IAB", and "IRTF".
skipping to change at page 91, line 38 skipping to change at page 106, line 47
Group" or the value of the <workgroup> element). Group" or the value of the <workgroup> element).
o For RFCs, it affects the whole "Status of This Memo" section (see o For RFCs, it affects the whole "Status of This Memo" section (see
Section 3.2 of [RFC7841]). Section 3.2 of [RFC7841]).
o For all RFCs and Internet-Drafts, it determines whether the o For all RFCs and Internet-Drafts, it determines whether the
"Copyright Notice" section mentions the Copyright on Code "Copyright Notice" section mentions the Copyright on Code
Components (see Section 6 of the TLP ("Text to Be Included in IETF Components (see Section 6 of the TLP ("Text to Be Included in IETF
Documents")). Documents")).
A.3. The "consensus" Attribute A.4. The "consensus" Attribute
For some of the publication streams (see Appendix A.2), the "Status For some of the publication streams (see Appendix A.3), the "Status
of This Memo" section depends on whether there was a consensus to of This Memo" section depends on whether there was a consensus to
publish (again, see Section 3.4 of [RFC7841]). publish (again, see Section 3.4 of [RFC7841]).
The consensus attribute can be used to supply this information. The The consensus attribute can be used to supply this information. The
acceptable values are "true" (the default) and "false"; "yes" and acceptable values are "true" (the default) and "false"; "yes" and
"no" from v2 are deprecated. "no" from v2 are deprecated.
The effect of this value for the various streams is: The effect of this value for the various streams is:
o "independent": none. o "independent": none.
skipping to change at page 92, line 35 skipping to change at page 107, line 43
and changes many attribute values, and creates a file that is a and changes many attribute values, and creates a file that is a
"prepared document". The prepared document is a valid v3 "prepared document". The prepared document is a valid v3
document. The prep tool is described in [RFC7998]. document. The prep tool is described in [RFC7998].
The prep tool is expected to have many modes: The prep tool is expected to have many modes:
* RFC mode -- The mode used by the RFC Editor to process the * RFC mode -- The mode used by the RFC Editor to process the
input from one of the RFC streams and to process XML produced input from one of the RFC streams and to process XML produced
during the RFC editing process. The restrictions on the during the RFC editing process. The restrictions on the
canonical XML for RFCs, as well as how the non-canonical canonical XML for RFCs, as well as how the non-canonical
formats will look, are described at <https:// formats will look, are described at <https://www.rfc-
www.rfc-editor.org/rse/wiki/ editor.org/rse/wiki/doku.php?id=design:format-and-content-
doku.php?id=design:format-and-content-rfcs>. rfcs>.
* Draft mode -- The mode used by the Internet-Draft submission * Draft mode -- The mode used by the Internet-Draft submission
tool. The restrictions for the XML from this mode will be tool. The restrictions for the XML from this mode will be
described later. described later.
* Diagnostic mode -- A mode that can be used by document authors * Diagnostic mode -- A mode that can be used by document authors
to look for errors or warnings before they submit their to look for errors or warnings before they submit their
documents for publication. documents for publication.
* Consolidation mode -- Produces output where no external * Consolidation mode -- Produces output where no external
skipping to change at page 93, line 39 skipping to change at page 109, line 4
B.1. Including External Text with XInclude B.1. Including External Text with XInclude
All tools for the v3 format are expected to support XInclude All tools for the v3 format are expected to support XInclude
[XInclude]. XInclude specifies a processing model and syntax for [XInclude]. XInclude specifies a processing model and syntax for
general-purpose inclusion of information that is either on the general-purpose inclusion of information that is either on the
Internet or local to the user's computer. Internet or local to the user's computer.
In the v3 syntax, XInclude is expressed as the <xi:include> element. In the v3 syntax, XInclude is expressed as the <xi:include> element.
To use this element, you need to include the "xi" namespace in the To use this element, you need to include the "xi" namespace in the
<rfc> element; that is, you need to specify <rfc> element; that is, you need to specify
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
as one of the attributes in the <rfc> element. as one of the attributes in the <rfc> element.
The most common way to use <xi:include> is to pull in references that The most common way to use <xi:include> is to pull in references that
are already formed as XML. Currently, this can be done from are already formed as XML. Currently, this can be done from
xml2rfc.tools.ietf.org, but later this is expected to be from the RFC xml2rfc.tools.ietf.org, but later this is expected to be from the RFC
Editor. For example, if a document has three normative references, Editor. For example, if a document has three normative references,
all RFCs, the document might contain: all RFCs, the document might contain:
<references> <references>
<xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/ <xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.2119.xml"/> bibxml/reference.RFC.2119.xml"/>
<xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/ <xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.4869.xml"/> bibxml/reference.RFC.4869.xml"/>
<xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/ <xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.7169.xml"/> bibxml/reference.RFC.7169.xml"/>
</references> </references>
(the line breaks in the example above have been added for readability
and need to be removed in practice)
<xi:include> can be used anywhere an XML element could be used (but <xi:include> can be used anywhere an XML element could be used (but
not where free text is used). For example, if three Internet-Drafts not where free text is used). For example, if three Internet-Drafts
are all including a particular paragraph or section verbatim, that are all including a particular paragraph or section verbatim, that
text can be kept either in a file or somewhere on the web and can be text can be kept either in a file or somewhere on the web and can be
included with <xi:include>. An example of pulling something from the included with <xi:include>. An example of pulling something from the
local disk would be: local disk would be:
<x:include href="file://home/chris/ietf/drafts/commontext.xml"/> <xi:include href="file://home/chris/ietf/drafts/commontext.xml"/>
In general, XInclude should be used instead of ENTITY references and In general, XInclude should be used instead of ENTITY references and
XML Processing Instructions (PIs) that allow external inclusions. XML Processing Instructions (PIs) that allow external inclusions.
B.2. Anchors and IDs B.2. Anchors and IDs
People writing and reading Internet-Drafts and RFCs often want to People writing and reading Internet-Drafts and RFCs often want to
make reference to specific locations in those documents. In the case make reference to specific locations in those documents. In the case
of RFC authors, it is common to want to reference another part of of RFC authors, it is common to want to reference another part of
their document, such as "see Section 3.2 of this document." Readers, their document, such as "see Section 3.2 of this document." Readers,
skipping to change at page 95, line 23 skipping to change at page 110, line 34
sections can only have those anchor values. sections can only have those anchor values.
The following rules prevent this overlap: The following rules prevent this overlap:
o "pn" for regular sections always has the format "s-nnn", where o "pn" for regular sections always has the format "s-nnn", where
"nnn" is the section number, or the appendix identifier (which "nnn" is the section number, or the appendix identifier (which
starts with a letter). For example, this would be "s-2.1.3" for starts with a letter). For example, this would be "s-2.1.3" for
Section 2.1.3 and "s-a" for Appendix A. For the <abstract> Section 2.1.3 and "s-a" for Appendix A. For the <abstract>
element, it is always "s-abstract". For the <note> element, it is element, it is always "s-abstract". For the <note> element, it is
always "s-note-nnn", where "nnn" is a sequential value. For always "s-note-nnn", where "nnn" is a sequential value. For
sections in the <boilerplate> element, it is always sections in the <boilerplate> element, it is always "s-
"s-boilerplate-nnn", where "nnn" is a sequential value. boilerplate-nnn", where "nnn" is a sequential value.
o "pn" for <references> elements has the format "s-nnn". It is o "pn" for <references> elements has the format "s-nnn". It is
important to note that "nnn" is a number, not letters, even though important to note that "nnn" is a number, not letters, even though
the <references> appear in the back. It is the number that is one the <references> appear in the back. It is the number that is one
higher than the highest top-level section number in <middle>. If higher than the highest top-level section number in <middle>. If
there are two or more <references>, "nnn" will include a dot as if there are two or more <references>, "nnn" will include a dot as if
the <references> are a subsection of a section that is numbered the <references> are a subsection of a section that is numbered
one higher than the highest top-level section number in <middle>. one higher than the highest top-level section number in <middle>.
o "pn" for <figure> elements always has the format "f-nnn", where o "pn" for <figure> elements always has the format "f-nnn", where
skipping to change at page 95, line 49 skipping to change at page 111, line 11
"ttt" is the slugified item (plus a hyphen and the slugified "ttt" is the slugified item (plus a hyphen and the slugified
subitem if there is a subitem), and "nnn" is the instance of that subitem if there is a subitem), and "nnn" is the instance of that
item/subitem pair. For example, this would be "i-foo-1" for item/subitem pair. For example, this would be "i-foo-1" for
"<iref item='foo'>" and "i-foo-bar-1" for "<iref item='foo' "<iref item='foo'>" and "i-foo-bar-1" for "<iref item='foo'
subitem='bar'>". subitem='bar'>".
o "pn" for <table> elements always has the format "t-nnn", where o "pn" for <table> elements always has the format "t-nnn", where
"nnn" is the table number. For example, this would be "t-5" for "nnn" is the table number. For example, this would be "t-5" for
Table 5. Table 5.
o "pn" for all elements not listed above always has the format o "pn" for all elements not listed above always has the format "p-
"p-nnn-mmm", where "nnn" is the section number and "mmm" is the nnn-mmm", where "nnn" is the section number and "mmm" is the
relative position in the section. For example, this would be relative position in the section. For example, this would be
"p-2.1.3-7" for the seventh part number in Section 2.1.3. "p-2.1.3-7" for the seventh part number in Section 2.1.3.
o "slugifiedName" always has the format "n-ttt", where "ttt" is the o "slugifiedName" always has the format "n-ttt", where "ttt" is the
text of the name after slugification. For example, this would be text of the name after slugification. For example, this would be
"n-protocol-overview" for the name "Protocol Overview". The "n-protocol-overview" for the name "Protocol Overview". The
actual conversions done in slugification will be specified at a actual conversions done in slugification will be specified at a
later time. later time.
o Anchors must never overlap with any of the above. The easiest way o Anchors must never overlap with any of the above. The easiest way
skipping to change at page 96, line 29 skipping to change at page 111, line 40
Many elements in the v3 vocabulary have new attributes whose role is Many elements in the v3 vocabulary have new attributes whose role is
to hold values generated by the prep tool. These attributes can to hold values generated by the prep tool. These attributes can
exist in documents that are input to the prep tool; however, any of exist in documents that are input to the prep tool; however, any of
these attributes might be added, removed, or changed by the prep these attributes might be added, removed, or changed by the prep
tool. Thus, it is explicitly unsafe for a document author to include tool. Thus, it is explicitly unsafe for a document author to include
these attributes and expect that their values will survive processing these attributes and expect that their values will survive processing
by the prep tool. by the prep tool.
The attributes that are controlled by the prep tool are: The attributes that are controlled by the prep tool are:
o The "pn" attribute in any element -- The number for this item o The "pn" attribute -- The number for this item within the section.
within the section. The numbering is shared with other elements The numbering is shared with other elements of a section. The
of a section. The "pn" attribute is added to many block-level "pn" attribute is added to these elements: <abstract>, <artset>,
elements inside sections. <artwork>, <aside>, <blockquote>, <dd>, <dl>, <dt>, <figure>,
<iref>, <li>, <list>, <note>, <ol>, <references>, <section>,
o <artwork> originalSrc -- This attribute is filled with the <sourcecode>, <t>, <table>, <u>, and <ul> .
original value of the "src" attribute if that attribute is removed
by the prep tool.
o <figure> originalSrc -- This attribute is filled with the original o originalSrc -- This attribute is filled with the original value of
value of the "src" attribute if that attribute is removed by the the "src" attribute if that attribute is removed by the prep tool
prep tool. in <artwork>, <figure>, and <sourcecode>.
o <name> "slugifiedName" attribute -- This attribute is filled with o <name> "slugifiedName" attribute -- This attribute is filled with
a "slugified" version of the text in the element. This attribute a "slugified" version of the text in the element. This attribute
can be used in the output formats for elements that have both can be used in the output formats for elements that have both
names and numbers. names and numbers.
o <relref> "derivedLink" attribute -- This attribute is filled with o "derivedLink" attribute -- This attribute is filled with the link
the link that is derived from combining the URI from the reference that is derived from combining the URI from the reference and the
and the relative part that is either a copy of the "relative" relative part that is either a copy of the "relative" attribute or
attribute or a section number derived from the "section" a section number derived from the "section" attribute. This
attribute. attribute is added to <relref> and <xref>.
o <rfc> "expiresDate" attribute -- This attribute is filled with the o <rfc> "expiresDate" attribute -- This attribute is filled with the
date that an Internet-Draft expires. The date is in the format date that an Internet-Draft expires. The date is in the format
yyyy-mm-dd. yyyy-mm-dd.
o <rfc> "mode" attribute -- This attribute is filled with a string o <rfc> "mode" attribute -- This attribute is filled with a string
that indicates what mode the prep tool was in when it processed that indicates what mode the prep tool was in when it processed
the XML, such as whether it was processing a file to become an the XML, such as whether it was processing a file to become an
Internet-Draft or an RFC. Internet-Draft or an RFC.
o <rfc> "scripts" attribute -- This attribute is filled with a list o "scripts" attribute -- This attribute in the <rfc> element is
of scripts needed to render this document. The list is comma- filled with a list of scripts needed to render this document. The
separated, with no spaces allowed. The order is unimportant. The list is comma-separated, with no spaces allowed. The order is
names come from [UAX24]. For example, if the document has Chinese unimportant. The names come from [UAX24]. For example, if the
characters in it, the value might be "Common,Latin,Han". document has Chinese characters in it, the value might be