Network Working Group P. Hoffman
Internet-Draft VPN Consortium
Obsoletes: 2629 (if approved) October 27, 2014
Intended status: Informational
Expires: April 30, 2015
The 'XML2RFC' version 3 Vocabulary
draft-hoffman-xml2rfc-12
Abstract
This document defines the "XML2RFC" version 3 vocabulary; an XML-
based language used for writing RFCs and Internet-Drafts. It is
heavily derived from the version 2 vocabulary that is also under
discussion. This document obsoletes the v2 grammar described in RFC
2629 and its expected followup, draft-reschke-xml2rfc.
Editorial Note (To be removed by RFC Editor)
Discussion of this draft takes place on the rfc-interest mailing list
(rfc-interest@rfc-editor.org), which has its home page at
<https://www.rfc-editor.org/mailman/listinfo/rfc-interest>.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on April 30, 2015.
Copyright Notice
Copyright (c) 2014 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
Hoffman Expires April 30, 2015 [Page 1]
Internet-Draft XML2RFCv3 October 2014
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1. Design Criteria for the Changes in v3 . . . . . . . . . . 5
1.2. Differences from v2 to v3 . . . . . . . . . . . . . . . . 6
1.2.1. New Elements in v3 . . . . . . . . . . . . . . . . . 6
1.2.2. New Attributes for Existing Elements . . . . . . . . 7
1.2.3. Elements and Attributes Deprecated from v2 . . . . . 7
1.2.4. Additional Changes from v2 . . . . . . . . . . . . . 8
1.3. Syntax Notation . . . . . . . . . . . . . . . . . . . . . 9
2. Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.1. <abstract> . . . . . . . . . . . . . . . . . . . . . . . 10
2.2. <address> . . . . . . . . . . . . . . . . . . . . . . . . 10
2.3. <annotation> . . . . . . . . . . . . . . . . . . . . . . 11
2.4. <area> . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5. <artwork> . . . . . . . . . . . . . . . . . . . . . . . . 12
2.6. <aside> . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.7. <author> . . . . . . . . . . . . . . . . . . . . . . . . 16
2.8. <b> . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.9. <back> . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.10. <bcp14> . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.11. <blockquote> . . . . . . . . . . . . . . . . . . . . . . 19
2.12. <boilerplate> . . . . . . . . . . . . . . . . . . . . . . 20
2.13. <city> . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.14. <code> . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.15. <country> . . . . . . . . . . . . . . . . . . . . . . . . 21
2.16. <cref> . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.17. <date> . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.18. <dd> . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.19. <displayreference> . . . . . . . . . . . . . . . . . . . 24
2.20. <dl> . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.21. <dt> . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.22. <em> . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.23. <email> . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.24. <eref> . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.25. <figure> . . . . . . . . . . . . . . . . . . . . . . . . 28
2.26. <front> . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.27. <i> . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.28. <iref> . . . . . . . . . . . . . . . . . . . . . . . . . 31
2.29. <keyword> . . . . . . . . . . . . . . . . . . . . . . . . 32
Hoffman Expires April 30, 2015 [Page 2]
Internet-Draft XML2RFCv3 October 2014
2.30. <li> . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.31. <link> . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.32. <middle> . . . . . . . . . . . . . . . . . . . . . . . . 35
2.33. <name> . . . . . . . . . . . . . . . . . . . . . . . . . 35
2.34. <note> . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.35. <ol> . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.36. <organization> . . . . . . . . . . . . . . . . . . . . . 38
2.37. <phone> . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.38. <postal> . . . . . . . . . . . . . . . . . . . . . . . . 39
2.39. <postalLine> . . . . . . . . . . . . . . . . . . . . . . 40
2.40. <refcontent> . . . . . . . . . . . . . . . . . . . . . . 40
2.41. <reference> . . . . . . . . . . . . . . . . . . . . . . . 41
2.42. <referencegroup> . . . . . . . . . . . . . . . . . . . . 42
2.43. <references> . . . . . . . . . . . . . . . . . . . . . . 42
2.44. <region> . . . . . . . . . . . . . . . . . . . . . . . . 43
2.45. <rfc> . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.46. <section> . . . . . . . . . . . . . . . . . . . . . . . . 47
2.47. <seriesInfo> . . . . . . . . . . . . . . . . . . . . . . 49
2.48. <sourcecode> . . . . . . . . . . . . . . . . . . . . . . 50
2.49. <street> . . . . . . . . . . . . . . . . . . . . . . . . 52
2.50. <strong> . . . . . . . . . . . . . . . . . . . . . . . . 53
2.51. <sub> . . . . . . . . . . . . . . . . . . . . . . . . . . 54
2.52. <sup> . . . . . . . . . . . . . . . . . . . . . . . . . . 54
2.53. <t> . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
2.54. <table> . . . . . . . . . . . . . . . . . . . . . . . . . 57
2.55. <tbody> . . . . . . . . . . . . . . . . . . . . . . . . . 57
2.56. <td> . . . . . . . . . . . . . . . . . . . . . . . . . . 58
2.57. <tfoot> . . . . . . . . . . . . . . . . . . . . . . . . . 59
2.58. <th> . . . . . . . . . . . . . . . . . . . . . . . . . . 59
2.59. <thead> . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.60. <title> . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.61. <tr> . . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.62. <tt> . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2.63. <ul> . . . . . . . . . . . . . . . . . . . . . . . . . . 63
2.64. <uri> . . . . . . . . . . . . . . . . . . . . . . . . . . 64
2.65. <workgroup> . . . . . . . . . . . . . . . . . . . . . . . 64
2.66. <xref> . . . . . . . . . . . . . . . . . . . . . . . . . 64
3. Elements from v2 That Have Been Deprecated . . . . . . . . . 67
3.1. <c> . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
3.2. <facsimile> . . . . . . . . . . . . . . . . . . . . . . . 68
3.3. <format> . . . . . . . . . . . . . . . . . . . . . . . . 68
3.4. <list> . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.5. <postamble> . . . . . . . . . . . . . . . . . . . . . . . 69
3.6. <preamble> . . . . . . . . . . . . . . . . . . . . . . . 70
3.7. <spanx> . . . . . . . . . . . . . . . . . . . . . . . . . 71
3.8. <texttable> . . . . . . . . . . . . . . . . . . . . . . . 72
3.9. <ttcol> . . . . . . . . . . . . . . . . . . . . . . . . . 73
3.10. <vspace> . . . . . . . . . . . . . . . . . . . . . . . . 74
Hoffman Expires April 30, 2015 [Page 3]
Internet-Draft XML2RFCv3 October 2014
4. Internationalization Considerations . . . . . . . . . . . . . 74
5. Security Considerations . . . . . . . . . . . . . . . . . . . 74
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 74
6.1. Internet Media Type Registration . . . . . . . . . . . . 75
6.2. Link Relation Registration . . . . . . . . . . . . . . . 76
7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 76
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 77
8.1. Normative References . . . . . . . . . . . . . . . . . . 77
8.2. Informative References . . . . . . . . . . . . . . . . . 77
Appendix A. Front Page Generation . . . . . . . . . . . . . . . 79
A.1. The /rfc/@category Attribute . . . . . . . . . . . . . . 79
A.2. The /rfc/@ipr Attribute . . . . . . . . . . . . . . . . . 79
A.2.1. Current Values: '*trust200902' . . . . . . . . . . . 80
A.2.2. Historic Values . . . . . . . . . . . . . . . . . . . 81
Appendix B. The v3 Format and Processors . . . . . . . . . . . . 82
B.1. Including External Text . . . . . . . . . . . . . . . . . 83
B.2. Anchors and IDs . . . . . . . . . . . . . . . . . . . . . 84
B.2.1. Overlapping Values . . . . . . . . . . . . . . . . . 85
Appendix C. Relax NG Schema . . . . . . . . . . . . . . . . . . 86
Appendix D. Schema Differences from v2 . . . . . . . . . . . . . 101
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Hoffman Expires April 30, 2015 [Page 4]
Internet-Draft XML2RFCv3 October 2014
1. Introduction
This document describes version 3 ("v3") of the "XML2RFC" vocabulary;
an XML-based language ('Extensible Markup Language', [XML]) used for
writing RFCs ([RFC7322]) and Internet-Drafts ([IDGUIDE]).
This document obsoletes the version ("v2") vocabulary [XML2RFCv2],
which contains the extended language definition. That document in
turn obsoletes the original version ("v1") [RFC2629]. This document
directly copies the material from [XML2RFCv2] where possible; as that
document makes its way toward RFC publication, this document will
incorporate as many of the changes as possible.
The v3 format will be used as part of the new RFC series described in
[RFC6949]. The new format will be handled by one or more new
processors for checking the XML and converting it to other
representations. Features of the expected processors are described
in Appendix B.
Note that the vocabulary contains certain constructs that might not
be used when generating of the final text; however, they can provide
useful data for other uses (such as index generation, populating a
keyword database, or syntax checks).
In this document, the term "format" is used when describing types of
documents, primarily XML and HTML. The term "representation" is used
when talking about a specific instatiation of a format, such as an
XML document or an HTML document that was created by an XML document.
The following two sections are a hopefully-complete list of all the
technical changes between [XML2RFCv2] and this document, as well as
the design criteria for those changes.
1.1. Design Criteria for the Changes in v3
The design criteria of the changes from v2 to v3 are:
o The intention is that starting and editing a v3 document will be
easier than for a v2 document.
o There will be good v2-to-v3 conversion tools for when an author
wants to change versions.
o There are no current plans to make v3 XML the required submission
representation for drafts or RFCs. That might happen eventually,
but it is likely to be years away.
There is a desire to keep as much of the v2 grammar as makes sense
Hoffman Expires April 30, 2015 [Page 5]
Internet-Draft XML2RFCv3 October 2014
within the above design criteria and not to make gratuitous changes
to the v2 grammar. Another way to say this is "we would rather
encourage backward compatibility but not be constrained by it".
Still, the goal of starting and editing a v3 document being easier
than for a v2 document is more important than backwards compatibility
with v2, given the latter two design criteria.
v3 is upwards compatible with v2, meaning that a v2 document is meant
to be a valid v3 document as well. However, some features of v2 are
deprecated in v3 in favor of new elements. Deprecated features are
listed in Section 1.2.3, and are described in [XML2RFCv2].
1.2. Differences from v2 to v3
The format changes in v3 are listed in the following subsections.
1.2.1. New Elements in v3
o Add <dl>, <ul>, and <ol> as new ways to make lists. This is a
significant change from v2 in that the child under these elements
is <li>, not <t>. <li> has a model of either containing one or
more <t> elements, or containing the flowing text normally found
in <t>. These lists are children of <section>s instead of <t>.
o Add <strong>, <b>, <em>, <i>, <tt>, <sub>, and <sup> for character
formatting.
o Add <aside> for incidental text that will be indented when
displayed.
o Add <sourcecode> to differentiate from <artwork>.
o Add <table>, <thead>, <tbody>, <tfoot>, <tr>, <td>, and <th> to
give table functionality like that in HTML.
o Add <blockquote> to indicate a quotation as in a paragraph-like
format.
o Add <name> to sections, notes, figures, and texttables to allow
character formatting (fixed-width font) in their titles, and to
allow references.
o Add <postalLine>, free text that represents one line of the
address.
o Add <displayreference> to allow display of more mneumonic anchor
names for automatically-included references.
Hoffman Expires April 30, 2015 [Page 6]
Internet-Draft XML2RFCv3 October 2014
o Add <refcontent> to allow better control of text in a reference.
o Add <referencegroup> to allow referemcing multi-RFC documents such
as STDs and BCPs.
o Add <link> to point to a resource related to the RFC.
1.2.2. New Attributes for Existing Elements
o Add "sortRefs", "symRefs", "tocDepth", and "tocInclude" attributes
to <rfc> to cover processor instructions (PIs) that were in v2
that are still needed in the grammar.
o Add "ascii" attributes to <author>, <email>, <organization>,
<street>, <city>, <region> and <code>. This allows an author to
specify their information in their native scripts as the primary
entry and still allow the ASCII-equivalent values to appear in the
processed documents.
o Add "xml:lang" attribute to <artwork>, <postal>, and <author>.
This is sometimes useful for renderers which display different
fonts for ideographic characters used in China and Japan.
o Add the "section", "relative", and "sectionFormat" attributes to
<xref>.
o Add the "numbered" and "removeInRFC" attributes to <section>.
o Add the "removeInRFC" attribute to <note>.
o Add "boilerplateText", "figureNumber", "tableNumber", and
"sectionNumber" attributes to <rfc>, <figure>, <table>, and
<section>, respectively.
o Add "partNumber" to <artwork>, <aside>, <blockquote>, <dt>, <li>,
<sourcecode>, and <t> to hold automatically generated numbers for
items in a section that don't have their own numbering (namely
figures and tables).
1.2.3. Elements and Attributes Deprecated from v2
Deprecated elements and attributes are legacy vocabulary from v2 that
are supported for input to v3 processors. They are likely to be
removed from those processors in the future. Instead of being listed
in Section 2, they are listed in in Section 3. See Appendix B for
more information on processors and how they will handle deprecated
features.
Hoffman Expires April 30, 2015 [Page 7]
Internet-Draft XML2RFCv3 October 2014
o Deprecate <list> in favor of <dl>, <ul>, and <ol>.
o Deprecate <spanx>; replace it with <strong>, <b>, <em>, <i>, and
<tt>.
o Deprecate <vspace> because the major use for it, creating pseudo-
paragraph-breaks in lists, is now handled properly.
o Deprecate <texttable>, <ttcol>, and <c>; replace them with the new
table elements (<table> and the elements that can be contained
within it).
o Deprecate <facsimile> because it is rarely used and is not
actually useful; <email> is a much more useful way to get in touch
with authors.
o Deprecate <format> because it is not useful and has caused
surprise for authors in the past. If the goal is to provide a
single URI (Uniform Resource Identifier) for a reference, use the
"target" attribute on <reference> instead.
o Deprecate <preamble> and <postamble> in favor of simply using <t>.
This also deprecates the "align" attribute in <figure>.
o Deprecate the "title" attribute in <section>, <note>, <figure>,
and <texttable> in favor of the new <name>.
o Deprecate the "alt", and "src" attributes in <figure> because they
overlap with the attributes in <artwork>.
o Deprecate the "xml:space" attribute in <artwork> because there was
only one useful value. Deprecate "height" and "width" attribute
in both <artwork> and <figure> because they are not needed for the
new output formats.
o Deprecate the "pageno" attribute in <xref> because it was unused
in v2. Deprecate the "none" and "title" values for the "format"
attribute in <xref> because the former makes no sense semantically
and the latter because it has unpredictable output.
1.2.4. Additional Changes from v2
o Allow non-ASCII characters in the format; the characters that are
actually allowed will be determined by the RFC Editor.
o Allow <artwork> and <sourcecode> to be used on their own in
<section> (no longer confine them to a figure).
Hoffman Expires April 30, 2015 [Page 8]
Internet-Draft XML2RFCv3 October 2014
o Give more specifics of handling the "type" attribute in <artwork>.
o In <address>, allow the sub-elements to be in any order.
o Allow <strong>, <b>, <em>, <i>, <tt>, <eref>, and <xref> in
<cref>.
o Allow the sub-elements inside a <reference> to be in any order.
o Turned off the auto-generation of anchors in <cref> because there
is no use case for them that cannot be achieved in other ways.
o Allow more than one <artwork>, or more than one <sourcecode>, in
<figure>.
o In <front>, make <date> optional.
o In <postal>, allow the sub-elements to be in any order. Also
allow the inclusion of the new <postalLine> instead of the older
elements.
o In <references>, now require <name> to give the section name.
o In <section>, restricted the names of the anchors that can be used
on some types of sections.
o <t> now only contains non-block elements, so it no longer contains
<figure> elements.
o Do not generate the grammar from a DTD, but instead get it
directly from the Relax Next Generation (RNG) grammar [RNG].
1.3. Syntax Notation
The XML vocabulary here is defined in prose, based on the Relax NG
schema ([RNC]) contained in Appendix C (specified in Relax NG Compact
Notation, "RNC").
Note that the schema can be used for automated validity checks, but
certain constraints are only described in prose (example: the
conditionally required presence of the "abbrev" attribute).
2. Elements
The sections below describe all elements and their attributes.
Note that attributes not labeled "mandatory" are optional.
Hoffman Expires April 30, 2015 [Page 9]
Internet-Draft XML2RFCv3 October 2014
Many elements have an optional "anchor" attribute. In all cases, the
value of the "anchor" attribute needs to be a valid XML "Name"
(Section 2.3 of [XML]). In short, it is a text string with no spaces
or colons; hyphens, periods, and underscores are allowed; some
characters cannot be in the first position (such as digits, hypen, or
period). Anchors are described in more detail in Appendix B.2.
Except inside <artwork> and <sourcecode>, horizontal whitespace and
linebreaks are collapsed into a single whitespace, and leading and
trailing whitespace are trimmed off.
2.1. <abstract>
Contains the abstract of the document. See [RFC7322] for more
information on restrictions for the abstract.
This element appears as a child element of: <front> (Section 2.26).
Content model:
One or more <t> elements (Section 2.53)
2.1.1. 'sectionNumber' attribute
The name for the abstract. See Appendix B.2.1 for a description of
this.
2.2. <address>
Provides address information for the author.
This element appears as a child element of: <author> (Section 2.7).
Content model:
In any order:
o <email> elements (Section 2.23)
o <facsimile> elements (Section 3.2)
o <phone> elements (Section 2.37)
o <postal> elements (Section 2.38)
o <uri> elements (Section 2.64)
Hoffman Expires April 30, 2015 [Page 10]
Internet-Draft XML2RFCv3 October 2014
2.3. <annotation>
Provides additional prose augmenting a bibliographical reference.
This element appears as a child element of: <reference>
(Section 2.41).
Content model:
In any order:
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <spanx> elements (Section 3.7)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.3.1. 'ascii' attribute
The ASCII equivalent of the annotation.
2.4. <area>
Provides information about the IETF area to which this document
relates (currently not used when generating documents).
Hoffman Expires April 30, 2015 [Page 11]
Internet-Draft XML2RFCv3 October 2014
The value ought to be either the full name or the abbreviation of one
of the IETF areas as listed on <http://www.ietf.org/iesg/area.html>.
The list at the time that this document is being published is:
"Applications", "app", "General", "gen", "Internet", "int",
"Operations and Management", "ops", "Real-time Applications and
Infrastructure", "rai", "Routing", "rtg", "Security", "sec",
"Transport", "tsv".
This element appears as a child element of: <front> (Section 2.26).
Content model: only text content.
2.5. <artwork>
This element allows the inclusion of "artwork" into the document.
<artwork> provides full control of horizontal whitespace and line
breaks, and thus is used for a variety of things, such as:
o diagrams ("line art"),
o complex tables, or
o protocol unit diagrams.
Alternatively, the "src" attribute allows referencing an external
graphics file, such as a bitmap or a vector drawing, using a URI. In
this case, the textual content acts as fallback for output
representations that do not support graphics, and thus ought to
contain either a "line art" variant of the graphics, or otherwise
prose that describes the included image in sufficient detail.
If the artwork includes either "&" or "<" characters, or the string
"]]>" those characters need to be encoded using escaping or CDATA
block(s); see <sourcecode> for a fuller description of these
solutions.
In [XML2RFCv2], the <artwork> element was also used for source code
and formal languages; in v3, this is now done with <sourcecode>.
There are at least four ways to include SVG in artwork in Internet
Drafts:
o Inline, by including all of the SVG in the content of the element
(such as "<artwork type="svg"><svg xmlns...">")
o Inline, but using XInclude (see Appendix B.1 (such as "<artwork
type="svg"><xi:include href=...")
Hoffman Expires April 30, 2015 [Page 12]
Internet-Draft XML2RFCv3 October 2014
o As a data: URI (such as "<artwork type="svg" src="data:image/
svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3...">")
o As a URI to an external entity (such as "<artwork type="svg"
src="http://www.example.com/...">")
This element appears as a child element of: <aside> (Section 2.6),
<blockquote> (Section 2.11), <dd> (Section 2.18), <figure>
(Section 2.25), <li> (Section 2.30), <section> (Section 2.46), <td>
(Section 2.56), and <th> (Section 2.58).
Content model:
Text
2.5.1. 'align' attribute
Controls whether the artwork appears left justified (default),
centered, or right justified.
Allowed values:
o "left" (default)
o "center"
o "right"
2.5.2. 'alt' attribute
Alternative text description of the artwork (not just the caption).
This is only used with artwork that is text-based; when the art comes
from the "src" attribute, the alternative text comes from the text of
the artwork itself.
2.5.3. 'anchor' attribute
Document-wide unique identifier for this artwork.
2.5.4. 'height' attribute
Deprecated.
2.5.5. 'name' attribute
A filename suitable for the contents (such as for extraction to a
local file).
Hoffman Expires April 30, 2015 [Page 13]
Internet-Draft XML2RFCv3 October 2014
This attribute generally isn't used for document generation, but it
can be helpful for other kinds of tools (such as automated syntax
checkers which work by extracting the artwork).
2.5.6. 'partNumber' attribute
The number for this artwork within the section. The numbering is
shared with other elements of a section. This is described in more
detail in Appendix B.2.
2.5.7. 'src' attribute
The URI reference of a graphics file ([RFC3986]).
Note that this can be a "data" URI ([RFC2397]).
2.5.8. 'type' attribute
Specifies the type of the artwork. The value of this attribute is
free text with certain values designated as preferred. A private
processor (as described in Appendix B) might add type-specific
formatting to artwork with the preferred values. If a processor
encounters a value for "type" that is not one of the preferred
values, it can issue a warning but should still use the artwork as if
it had no "type" attribute.
The preferred values for <artwork> types are:
o ascii-art
o call-flow
o hex-dump
o svg
The RFC Editor will maintain a complete list of the preferred values
on its web site, and that list is expected to be updated over time.
Thus, a consumer of v3 XML should not cause a failure when it
encounters an unexpected type.
2.5.9. 'width' attribute
Deprecated.
Hoffman Expires April 30, 2015 [Page 14]
Internet-Draft XML2RFCv3 October 2014
2.5.10. 'xml:lang' attribute
Allows specification of the language used. This is sometimes useful
for renderers which display different fonts for ideographic
characters used in China and Japan.
2.5.11. 'xml:space' attribute
Deprecated.
2.6. <aside>
This element is a container for content that is semantically less
important or tangential to the content that surrounds it. The
elements inside this container are indented from both margins when
displayed.
This element appears as a child element of: <section> (Section 2.46).
Content model:
In any order:
o <artwork> elements (Section 2.5)
o <figure> elements (Section 2.25)
o <iref> elements (Section 2.28)
o <sourcecode> elements (Section 2.48)
o <t> elements (Section 2.53)
o <texttable> elements (Section 3.8)
2.6.1. 'anchor' attribute
Document-wide unique identifier for this aside.
2.6.2. 'partNumber' attribute
The number for this aside within the section. The numbering is
shared with other elements of a section. This is described in more
detail in Appendix B.2.
Hoffman Expires April 30, 2015 [Page 15]
Internet-Draft XML2RFCv3 October 2014
2.7. <author>
Provides information about a document's author. This is used both
for the document itself (at the beginning of the document) and for
referenced documents.
The <author> elements contained within the document's <front> element
are used to fill the boilerplate, and also to generate the "Author's
Address" section (see [RFC7322]).
Note that an "author" can also be just an organization (by not
specifying any of the name attributes, but adding the <organization>
child element).
Furthermore, the "role" attribute can be used to mark an author as
"editor". This is reflected both on the front page and in
bibliographical references. Note that this specification does not
define a precise meaning for the term "editor".
See Section "Authors vs. Contributors" of [RFCPOLICY] for more
information.
This element appears as a child element of: <front> (Section 2.26).
Content model:
In this order:
1. One optional <organization> element (Section 2.36)
2. One optional <address> element (Section 2.2)
2.7.1. 'ascii' attribute
The ASCII equivalent of the author's full name.
2.7.2. 'fullname' attribute
The full name (used in the automatically generated "Author's Address"
section).
2.7.3. 'initials' attribute
Author initials (used on the front page and in references).
The value contains one or more initials, each followed by a period.
Initials should be provided as a whitespace separated list of pairs
of a letter and a dot.
Hoffman Expires April 30, 2015 [Page 16]
Internet-Draft XML2RFCv3 October 2014
2.7.4. 'role' attribute
Specifies the role the author had in creating the document.
Allowed values:
o "editor"
2.7.5. 'surname' attribute
The author's surname (used on the front page and in references).
2.7.6. 'xml:lang' attribute
Allows specification of the language used. This is sometimes useful
for renderers which display different fonts for CJK characters.
2.8. <b>
Causes the text to be displayed in bold. It is almost always a
better idea to use the <strong> element instead. This element can be
combined with other character formatting elements, and the formatting
will be additive.
This element appears as a child element of: <annotation>
(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.22), <i> (Section 2.27), <li> (Section 2.30), <postamble>
(Section 3.5), <preamble> (Section 3.6), <refcontent> (Section 2.40),
<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:
In any order:
o Text
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
Hoffman Expires April 30, 2015 [Page 17]
Internet-Draft XML2RFCv3 October 2014
o <iref> elements (Section 2.28)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.9. <back>
Contains the "back" part of the document: the references and
appendices. In <back>, <section> elements indicate appendices.
This element appears as a child element of: <rfc> (Section 2.45).
Content model:
In this order:
1. Optional <displayreference> elements (Section 2.19)
2. Optional <references> elements (Section 2.43)
3. Optional <section> elements (Section 2.46)
2.10. <bcp14>
Marks text that are phrases defined in BCP 14 such as "MUST", "SHOULD
NOT", and so on. When shown in some of the output representations,
the text in this element might be highlighted. The use of this
element is optional.
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
to say "The packet <bcp14>MUST</bcp14> be dropped.", but it not
correct to say "<bcp14>The packet MUST be dropped.</bcp14>".
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <blockquote> (Section 2.11), <c>
(Section 3.1), <dd> (Section 2.18), <dt> (Section 2.21), <em>
(Section 2.22), <i> (Section 2.27), <li> (Section 2.30), <postamble>
(Section 3.5), <preamble> (Section 3.6), <refcontent> (Section 2.40),
<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).
Hoffman Expires April 30, 2015 [Page 18]
Internet-Draft XML2RFCv3 October 2014
Content model: only text content.
2.11. <blockquote>
Specifies a block of text is a quotation. The "cite" attribute is
required, and must be a URI.
This element appears as a child element of: <section> (Section 2.46).
Content model:
In any order:
o Text
o <artwork> elements (Section 2.5)
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <em> elements (Section 2.22)
o <figure> elements (Section 2.25)
o <i> elements (Section 2.27)
o <sourcecode> elements (Section 2.48)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <t> elements (Section 2.53)
o <tt> elements (Section 2.62)
2.11.1. 'anchor' attribute
Document-wide unique identifier for this quotation.
2.11.2. 'cite' attribute
The source of the citation. This must be a URI. If the quotedFrom
attribute is given, this URI will be used by processors as the link
for the text of that attribute.
Hoffman Expires April 30, 2015 [Page 19]
Internet-Draft XML2RFCv3 October 2014
2.11.3. 'partNumber' attribute
The number for this blockquote within the section. The numbering is
shared with other elements of a section. This is described in more
detail in Appendix B.2.
2.11.4. 'quotedFrom' attribute
Name of person or document the text in this element is quoted from.
This will be rendered by the processor as visible text at the end of
the quotation.
2.12. <boilerplate>
Holds the boilerplate text for the document. This section is filled
in by the RFC Processor.
This element appears as a child element of: <front> (Section 2.26).
Content model:
One or more <section> elements (Section 2.46)
2.13. <city>
Gives the city name in a postal address.
This element appears as a child element of: <postal> (Section 2.38).
Content model: only text content.
2.13.1. 'ascii' attribute
The ASCII equivalent of the city name.
2.14. <code>
Gives the postal region code.
This element appears as a child element of: <postal> (Section 2.38).
Content model: only text content.
2.14.1. 'ascii' attribute
The ASCII equivalent of the postal code.
Hoffman Expires April 30, 2015 [Page 20]
Internet-Draft XML2RFCv3 October 2014
2.15. <country>
Gives the country in a postal address.
This element appears as a child element of: <postal> (Section 2.38).
Content model: only text content.
2.16. <cref>
Represents a comment.
Comments can be used in a document while it is work-in-progress.
They usually appear either inline and visually highlighted, at the
end of the document (depending on file representation and settings of
the processor), or not at all (when generating an RFC).
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <c> (Section 3.1), <dd>
(Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <i>
(Section 2.27), <li> (Section 2.30), <name> (Section 2.33),
<postamble> (Section 3.5), <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), <tt>
(Section 2.62), and <ttcol> (Section 3.9).
Content model:
In any order:
o Text
o <b> elements (Section 2.8)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
Hoffman Expires April 30, 2015 [Page 21]
Internet-Draft XML2RFCv3 October 2014
o <xref> elements (Section 2.66)
2.16.1. 'anchor' attribute
Document-wide unique identifier for this comment.
2.16.2. 'source' attribute
Holds the "source" of a comment, such as the name or the initials of
the person who made the comment.
2.17. <date>
Provides information about the publication date.
Note that this element is used both for the boilerplate of the
document being produced, and also inside bibliographic references
that use the <front> element.
In the boilerplate case, it defines the date of publication for the
current document (Internet Draft or RFC). When producing Internet-
Drafts, the Draft Processor uses this date to compute the expiration
date (see [IDGUIDE]). When one or more of "year", "month", or "day"
are left out, the processor will attempt to use the current system
date if the attributes that are present are consistent with that
date.
Also in the first case, that month names, if given, need to match the
full English month name: "January", "February", "March", "April",
"May, "June", "July", "August", "September", "October", "November",
or "December".
In the case of bibliographic references, the date information can
have prose text for the month or year. For example, vague dates
(year="ca. 2000"), date ranges (year="2012-2013"), non-specific
months (month="Second quarter") and so on, are allowed.
This element appears as a child element of: <front> (Section 2.26).
Content model: this element does not have any contents.
2.17.1. 'day' attribute
Day of publication; this is a number.
Hoffman Expires April 30, 2015 [Page 22]
Internet-Draft XML2RFCv3 October 2014
2.17.2. 'month' attribute
Month of publication; this is the English name of the month.
2.17.3. 'year' attribute
Year of publication.
2.18. <dd>
The definition part of an entry in a definition list.
This element appears as a child element of: <dl> (Section 2.20).
Content model:
Either:
One or more <t> elements (Section 2.53)
Or:
In any order, but at least one of:
* Text
* <artwork> elements (Section 2.5)
* <b> elements (Section 2.8)
* <bcp14> elements (Section 2.10)
* <cref> elements (Section 2.16)
* <dl> elements (Section 2.20)
* <em> elements (Section 2.22)
* <eref> elements (Section 2.24)
* <figure> elements (Section 2.25)
* <i> elements (Section 2.27)
* <iref> elements (Section 2.28)
* <ol> elements (Section 2.35)
Hoffman Expires April 30, 2015 [Page 23]
Internet-Draft XML2RFCv3 October 2014
* <sourcecode> elements (Section 2.48)
* <strong> elements (Section 2.50)
* <sub> elements (Section 2.51)
* <sup> elements (Section 2.52)
* <tt> elements (Section 2.62)
* <ul> elements (Section 2.63)
* <xref> elements (Section 2.66)
2.19. <displayreference>
This element gives a mapping between the anchor of a reference and a
name that will be displayed instead. This allows authors to display
more mneumonic anchor names for automatically-included references.
For example, if the reference uses the anchor "RFC6949", the
following would cause that anchor in the body of displayed documents
to be "RFC-dev":
<displayreference from="RFC6449" to="RFC-dev"/>
This element appears as a child element of: <back> (Section 2.9).
Content model: this element does not have any contents.
2.19.1. 'from' attribute (mandatory)
This attribute must be the name of an anchor in a <reference>
element.
2.19.2. 'to' attribute (mandatory)
This attribute is a name that will be displayed as the anchor instead
of the anchor that is given in the <reference> element. The string
given must start with one of the following characters: 0-9, a-z, A-Z.
The other characters in the string must be 0-9, a-z, A-Z, "-", ".",
and "_".
2.20. <dl>
A definition list. Each entry has a pair of elements: a term (<dt>)
and a definition (<dd>).
This element appears as a child element of: <dd> (Section 2.18), <li>
Hoffman Expires April 30, 2015 [Page 24]
Internet-Draft XML2RFCv3 October 2014
(Section 2.30), <section> (Section 2.46), <td> (Section 2.56), and
<th> (Section 2.58).
Content model:
One or more sequences of:
1. One <dt> element
2. One <dd> element
2.20.1. 'hanging' attribute
The hanging attribute defines whether or not the term appears on the
same line as the definition. hanging="false" indicates that the term
is to the left of the definition, while hanging="true" indicates that
the term will be on a separate line.
Allowed values:
o "false" (default)
o "true"
2.20.2. 'spacing' attribute
Defines whether or not there is a blank line between entries.
spacing="normal" indicates a single blank line, while
spacing="compact" indicates no space between.
Allowed values:
o "normal" (default)
o "compact"
2.21. <dt>
The term being defined in a definition list.
This element appears as a child element of: <dl> (Section 2.20).
Content model:
In any order:
o Text
Hoffman Expires April 30, 2015 [Page 25]
Internet-Draft XML2RFCv3 October 2014
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.21.1. 'partNumber' attribute
The number for this term within the section. The numbering is shared
with other elements of a section. This is described in more detail
in Appendix B.2.
2.22. <em>
Indicates text that is semantically empahsized. This element will be
displayed as italic after processing. This element has the same
effects as <i>.
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <blockquote> (Section 2.11), <c>
(Section 3.1), <cref> (Section 2.16), <dd> (Section 2.18), <dt>
(Section 2.21), <li> (Section 2.30), <postamble> (Section 3.5),
<preamble> (Section 3.6), <refcontent> (Section 2.40), <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:
In any order:
Hoffman Expires April 30, 2015 [Page 26]
Internet-Draft XML2RFCv3 October 2014
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <eref> elements (Section 2.24)
o <iref> elements (Section 2.28)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.23. <email>
Provides an email address.
The value is expected to be the scheme-specific part of a "mailto"
URI (so does not include the prefix "mailto:"). See Section 2 of
[RFC6068] for details.
This element appears as a child element of: <address> (Section 2.2).
Content model: only text content.
2.23.1. 'ascii' attribute
The ASCII equivalent of the author's email address. This is only
used if the email address has one or two internationalized
components.
2.24. <eref>
Represents an "external" link (as specified in the "target"
attribute). This can be used for creating linked references, such as
in HTML output.
If the element has text content, that content will be used.
Otherwise, the value of the target attribute will be inserted in
Hoffman Expires April 30, 2015 [Page 27]
Internet-Draft XML2RFCv3 October 2014
angle brackets ([RFC3986], Appendix C).
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <c> (Section 3.1), <cref>
(Section 2.16), <dd> (Section 2.18), <dt> (Section 2.21), <em>
(Section 2.22), <i> (Section 2.27), <li> (Section 2.30), <name>
(Section 2.33), <postamble> (Section 3.5), <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), <tt>
(Section 2.62), and <ttcol> (Section 3.9).
Content model: only text content.
2.24.1. 'target' attribute (mandatory)
URI of the link target (see Section 3 of [RFC3986]).
2.25. <figure>
Contains a figure with a caption with the figure number. If the
element contains a <name> element, the caption will also show that
name.
This element appears as a child element of: <aside> (Section 2.6),
<blockquote> (Section 2.11), <dd> (Section 2.18), <li>
(Section 2.30), <section> (Section 2.46), <td> (Section 2.56), and
<th> (Section 2.58).
Content model:
In this order:
1. One optional <name> element (Section 2.33)
2. Optional <iref> elements (Section 2.28)
3. One optional <preamble> element (Section 3.6)
4. In any order, but at least one of:
* <artwork> elements (Section 2.5)
* <sourcecode> elements (Section 2.48)
5. One optional <postamble> element (Section 3.5)
Hoffman Expires April 30, 2015 [Page 28]
Internet-Draft XML2RFCv3 October 2014
2.25.1. 'align' attribute
Deprecated.
Note: does not affect title or <artwork> alignment.
Allowed values:
o "left" (default)
o "center"
o "right"
2.25.2. 'alt' attribute
Deprecated. If the goal is to provide a single URI for a reference,
use the "target" attribute on <reference> instead.
2.25.3. 'anchor' attribute
Document-wide unique identifier for this figure.
2.25.4. 'figureNumber' attribute
The number for this figure. This attribute and its value are
automatically generated by the RFC Processor. If the value already
exists when the RFC Processor is run, it is replaced.
2.25.5. 'height' attribute
Deprecated.
2.25.6. 'src' attribute
Deprecated.
2.25.7. 'suppress-title' attribute
Deprecated. Figures always now get captions.
Allowed values:
o "true"
o "false" (default)
Hoffman Expires April 30, 2015 [Page 29]
Internet-Draft XML2RFCv3 October 2014
2.25.8. 'title' attribute
Deprecated. Use <name> instead.
2.25.9. 'width' attribute
Deprecated.
2.26. <front>
Represent the "front matter": metadata (such as author information),
abstract, and additional notes.
This element appears as a child element of: <reference>
(Section 2.41), and <rfc> (Section 2.45).
Content model:
In this order:
1. One <title> element (Section 2.60)
2. One or more <author> elements (Section 2.7)
3. One optional <date> element (Section 2.17)
4. Optional <area> elements (Section 2.4)
5. Optional <workgroup> elements (Section 2.65)
6. Optional <keyword> elements (Section 2.29)
7. One optional <abstract> element (Section 2.1)
8. Optional <note> elements (Section 2.34)
9. One optional <boilerplate> element (Section 2.12)
2.27. <i>
Causes the text to be displayed in italic. It is almost always a
better idea to use the <em> element instead.
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <blockquote> (Section 2.11), <c>
(Section 3.1), <cref> (Section 2.16), <dd> (Section 2.18), <dt>
(Section 2.21), <li> (Section 2.30), <postamble> (Section 3.5),
<preamble> (Section 3.6), <refcontent> (Section 2.40), <strong>
Hoffman Expires April 30, 2015 [Page 30]
Internet-Draft XML2RFCv3 October 2014
(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:
In any order:
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <eref> elements (Section 2.24)
o <iref> elements (Section 2.28)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.28. <iref>
Provides terms for the document's index.
Index entries can be either be regular entries (when just the "item"
attribute is given) or nested entries (by specifying "subitem" as
well), grouped under a regular entry.
Index entries generally refer to the exact place where the <iref>
element occured. An exception is the occurence as a child element of
<section>, in which case the whole section is considered to be
relevant for that index entry. In some formats, index entries of
this type might be displayed as range.
This element appears as a child element of: <annotation>
(Section 2.3), <aside> (Section 2.6), <b> (Section 2.8), <c>
(Section 3.1), <dd> (Section 2.18), <dt> (Section 2.21), <em>
(Section 2.22), <figure> (Section 2.25), <i> (Section 2.27), <li>
Hoffman Expires April 30, 2015 [Page 31]
Internet-Draft XML2RFCv3 October 2014
(Section 2.30), <name> (Section 2.33), <postamble> (Section 3.5),
<preamble> (Section 3.6), <section> (Section 2.46), <strong>
(Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52), <t>
(Section 2.53), <table> (Section 2.54), <td> (Section 2.56), <th>
(Section 2.58), <tt> (Section 2.62), and <ttcol> (Section 3.9).
Content model: this element does not have any contents.
2.28.1. 'item' attribute (mandatory)
The item to include.
2.28.2. 'primary' attribute
Setting this to "true" declares the occurrence as "primary", which
might cause it to be highlighted in the index.
Allowed values:
o "true"
o "false" (default)
2.28.3. 'subitem' attribute
The subitem to include.
2.29. <keyword>
Specifies a keyword applicable to the document.
Note that each element should only contain a single keyword; for
multiple keywords, the element can simply be repeated.
Keywords are used both in the RFC Index and in the metadata of
generated document representations.
This element appears as a child element of: <front> (Section 2.26).
Content model: only text content.
2.30. <li>
A list element, used in <ol> and <ul>.
This element appears as a child element of: <ol> (Section 2.35), and
<ul> (Section 2.63).
Hoffman Expires April 30, 2015 [Page 32]
Internet-Draft XML2RFCv3 October 2014
Content model:
Either:
One or more <t> elements (Section 2.53)
Or:
In any order, but at least one of:
* Text
* <artwork> elements (Section 2.5)
* <b> elements (Section 2.8)
* <bcp14> elements (Section 2.10)
* <cref> elements (Section 2.16)
* <dl> elements (Section 2.20)
* <em> elements (Section 2.22)
* <eref> elements (Section 2.24)
* <figure> elements (Section 2.25)
* <i> elements (Section 2.27)
* <iref> elements (Section 2.28)
* <ol> elements (Section 2.35)
* <sourcecode> elements (Section 2.48)
* <strong> elements (Section 2.50)
* <sub> elements (Section 2.51)
* <sup> elements (Section 2.52)
* <tt> elements (Section 2.62)
* <ul> elements (Section 2.63)
* <xref> elements (Section 2.66)
Hoffman Expires April 30, 2015 [Page 33]
Internet-Draft XML2RFCv3 October 2014
2.30.1. 'anchor' attribute
Document-wide unique identifier for this list item.
2.30.2. 'partNumber' attribute
The number for this list item within the section. The numbering is
shared with other elements of a section. This is described in more
detail in Appendix B.2.
2.31. <link>
A link to an external document that is related to the RFC.
The following are the supported types of external documents that can
be pointed to in a <link> element:
o The current ISSN for the RFC Series. The value for the "rel"
attribute is "isPartOf". The link should use the form
"urn:issn:".
o The DOI for this document. The value for the "rel" attribute is
"describedBy". The link should use the form "doi:".
o The Internet Draft that was submitted to the RFC Editor to become
the published RFC. The value for the "rel" attribute is
"convertedFrom". The link should be to an IETF-controlled web
site that retains copies of Internet Drafts.
o A representation of the document offered by the document author.
The value for the "rel" attribute is "alternate". The link can be
to a personally-run web site.
The RFC Processor needs to check the values for <link> before an RFC
is published. The Draft Processor might remove some <link> elements
during the draft submission process.
This element appears as a child element of: <rfc> (Section 2.45).
Content model: this element does not have any contents.
2.31.1. 'href' attribute (mandatory)
The URI of the external document.
Hoffman Expires April 30, 2015 [Page 34]
Internet-Draft XML2RFCv3 October 2014
2.31.2. 'rel' attribute
The relationship of the external document to this one. The
relationships are taken from Link Relations registry maintained by
IANA [LINKRELATIONS].
2.32. <middle>
Represents the main content of the document.
This element appears as a child element of: <rfc> (Section 2.45).
Content model:
One or more <section> elements (Section 2.46)
2.33. <name>
The name of the section, note, figure, or texttable. This name can
have flow markup such as to make some characters use a fixed-width
font, or to include references.
This element appears as a child element of: <figure> (Section 2.25),
<note> (Section 2.34), <references> (Section 2.43), <section>
(Section 2.46), <table> (Section 2.54), and <texttable>
(Section 3.8).
Content model:
In any order:
o Text
o <cref> elements (Section 2.16)
o <eref> elements (Section 2.24)
o <iref> elements (Section 2.28)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.33.1. 'slugifiedName' attribute
This attribute is filled in by a processor with a "slugified" version
of the text in the element. This attribute can be used in the output
formats for elements that have both names and numbers.
Hoffman Expires April 30, 2015 [Page 35]
Internet-Draft XML2RFCv3 October 2014
2.34. <note>
Creates an unnumbered section that appears after the abstract.
It is usually used for additional information to reviewers (working
group information, mailing list, ...), or for additional publication
information such as "IESG Notes".
This element appears as a child element of: <front> (Section 2.26).
Content model:
In this order:
1. One <name> element (Section 2.33)
2. One or more <t> elements (Section 2.53)
2.34.1. 'removeInRFC' attribute
If set to "yes", this note is marked in the processor with text
indicating that it should be removed before the document is published
as an RFC.
Allowed values:
o "yes"
o "no" (default)
2.34.2. 'sectionNumber' attribute
The name for this note. See Appendix B.2.1 for a description of
this.
2.34.3. 'title' attribute
Deprecated. Use <name> instead.
2.35. <ol>
An ordered list. The labels on the items will be either a number or
a letter, depending on the value of the style attribute.
This element appears as a child element of: <dd> (Section 2.18), <li>
(Section 2.30), <section> (Section 2.46), <t> (Section 2.53), <td>
(Section 2.56), and <th> (Section 2.58).
Hoffman Expires April 30, 2015 [Page 36]
Internet-Draft XML2RFCv3 October 2014
Content model:
One or more <li> elements (Section 2.30)
2.35.1. 'group' attribute
When a processor sees an <ol> element with a "group" attribute that
has already been seen, the processor continues the numbering of the
list from where the previous list with the same group name left off.
If an <ol> element has both a "group" and "start" attribute, the
group's numbering is reset to the given start value.
2.35.2. 'spacing' attribute
Defines whether or not there is a blank line between entries.
spacing="normal" indicates a single blank line, while
spacing="compact" indicates no space between.
Allowed values:
o "normal" (default)
o "compact"
2.35.3. 'start' attribute
The ordinal value to start the list at. This defaults to "1", and
must be an integer of 0 or greater.
2.35.4. 'style' attribute
The style of the labels on list items. If the length of the style
value is 1, the meaning is the same as it is for HTML:
a Lowercase letters (a, b, c, ...)
A Uppercase letters (A, B, C, ...)
1 Decimal numbers (1, 2, 3, ...)
i Lowercase Roman numerals (i, ii, iii, ...)
I Uppercase Roman numerals (I, II, III, ...)
For style "a" and "A", after the 26th entry, the numbering starts at
"aa"/"AA", then "ab"/"AB", and so on.
If the length of the style value is greater than 1, the value must
Hoffman Expires April 30, 2015 [Page 37]
Internet-Draft XML2RFCv3 October 2014
contain a percent-encoded indicator and other text. The value is a
free-form text that allows counter values to be inserted using a
"percent-letter" format. For instance, "[REQ%d]" generates labels of
the form "[REQ1]", where "%d" inserts the item number as decimal
number.
The following formats are supported:
%c Lowercase letters (a, b, c, ...)
%C Uppercase letters (A, B, C, ...)
%d Decimal numbers (1, 2, 3, ...)
%i Lowercase Roman numerals (i, ii, iii, ...)
%I Uppercase Roman numerals (I, II, III, ...)
%% Represents a percent sign
Other formats are reserved for future use.
It is an error for the style string to be empty, and processors will
reject documents with an element that has such a style. If the
intention is to have a list that is indented without bullets or
numbers, use <ul> with the 'empty="true"' attribute instead.
2.36. <organization>
Specifies the affiliation of an author.
This information appears in both the "Author's Address" section and
on the front page (see [RFC7322] for more information). If the value
is long, an abbreviated variant can be specified in the "abbrev"
attribute.
This element appears as a child element of: <author> (Section 2.7).
Content model: only text content.
2.36.1. 'abbrev' attribute
Abbreviated variant.
2.36.2. 'ascii' attribute
The ASCII equivalent of the organization's name.
Hoffman Expires April 30, 2015 [Page 38]
Internet-Draft XML2RFCv3 October 2014
2.37. <phone>
Represents a phone number.
The value is expected to be the scheme-specific part of a "tel" URI
(so does not include the prefix "tel:"), using the "global numbers"
syntax. See Section 3 of [RFC3966] for details.
This element appears as a child element of: <address> (Section 2.2).
Content model: only text content.
2.38. <postal>
Contains optional child elements providing postal information. These
elements will be displayed in an order that is processor-specific. A
postal address can contain only a set of <street>, <city>, <region>,
<code>, and <country> elements, or only an ordered set of
<postalLine> elements, but not both.
This element appears as a child element of: <address> (Section 2.2).
Content model:
Either:
In any order:
* <city> elements (Section 2.13)
* <code> elements (Section 2.14)
* <country> elements (Section 2.15)
* <region> elements (Section 2.44)
* <street> elements (Section 2.49)
Or:
One or more <postalLine> elements (Section 2.39)
2.38.1. 'xml:lang' attribute
Allows specification of the language used. This is sometimes useful
for renderers which display different fonts for CJK characters.
Hoffman Expires April 30, 2015 [Page 39]
Internet-Draft XML2RFCv3 October 2014
2.39. <postalLine>
Represents one line of a postal address. When more than one
<postalLine> is given, the processor emits them in the order given.
This element appears as a child element of: <postal> (Section 2.38).
Content model: only text content.
2.39.1. 'ascii' attribute
The ASCII equivalent of the text in the address line.
2.40. <refcontent>
Text that should appear between the title and the date of a
reference. The purpose of this element is to prevent the need to
abuse <seriesInfo> to get such text in a reference.
For example:
<reference anchor="April1">
<front>
<title>On Being A Fool</title>
<author initials="K." surname="Phunny" fullname="Knot Phunny"/>
<date year="2000" month="April"/>
</front>
<refcontent>Self-published pamphlet</refcontent>
</reference>
would render as:
[April1] Phunny, K., "On Being A Fool", Self-published
pamphlet, April 2000.
This element appears as a child element of: <reference>
(Section 2.41).
Content model:
In any order:
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
Hoffman Expires April 30, 2015 [Page 40]
Internet-Draft XML2RFCv3 October 2014
o <em> elements (Section 2.22)
o <i> elements (Section 2.27)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
2.40.1. 'ascii' attribute
The ASCII equivalent of the added text.
2.41. <reference>
Represents a bibliographical reference.
This element appears as a child element of: <referencegroup>
(Section 2.42), and <references> (Section 2.43).
Content model:
In this order:
1. One <front> element (Section 2.26)
2. In any order:
* <annotation> elements (Section 2.3)
* <format> elements (Section 3.3)
* <refcontent> elements (Section 2.40)
* <seriesInfo> elements (Section 2.47)
2.41.1. 'anchor' attribute (mandatory)
Document-wide unique identifier for this reference. Usually, this
will be used both to "label" the reference in the references section,
and as an identifier in links to this reference entry.
Hoffman Expires April 30, 2015 [Page 41]
Internet-Draft XML2RFCv3 October 2014
2.41.2. 'target' attribute
Holds the URI for the reference.
Note that depending on the <seriesInfo> element, a URI might not be
needed, nor desirable, as it can be automatically generated (for
instance, for RFCs).
2.42. <referencegroup>
Represents a list of bibliographic references that will be
represented as a single reference. This is most often used for
references in the STD and BCP series, where a single reference (such
as "BCP 9") encompasses more than one RFC.
Content model:
One or more <reference> elements (Section 2.41)
2.42.1. 'anchor' attribute (mandatory)
Document-wide unique identifier for this reference group. Usually,
this will be used both to "label" the reference group in the
references section, and as an identifier in links to this reference
entry.
2.43. <references>
Contains a set of bibliographical references.
In the early days of the RFC series, there was only one "References"
section per RFC. This convention was later changed to group
references into two sets, "Normative" and "Informative" as described
in [RFC7322]). This vocabulary supports the split with the <name>
child element. In general, the title should be either "Normative
References" or "Informative References".
By default, the order of references is significant. Processors,
however, can be instructed to sort them based on their anchor names.
This element appears as a child element of: <back> (Section 2.9).
Content model:
In this order:
1. One <name> element (Section 2.33)
Hoffman Expires April 30, 2015 [Page 42]
Internet-Draft XML2RFCv3 October 2014
2. One or more <reference> elements (Section 2.41)
2.44. <region>
Provides the region name in a postal address.
This element appears as a child element of: <postal> (Section 2.38).
Content model: only text content.
2.44.1. 'ascii' attribute
The ASCII equivalent of the region name.
2.45. <rfc>
This is the root element of the xml2rfc vocabulary.
Processors distinguish between RFC mode ("number" attribute being
present) and Internet-Draft mode ("docName" attribute being present):
it is invalid to specify both. Setting neither "number" nor
"docName" can be useful for producing other types of document but is
out-of-scope for this specification.
Content model:
In this order:
1. One optional <link> element (Section 2.31)
2. One <front> element (Section 2.26)
3. One <middle> element (Section 2.32)
4. One optional <back> element (Section 2.9)
2.45.1. 'category' attribute
Document category (see Appendix A.1).
Allowed values:
o "std"
o "bcp"
o "info"
Hoffman Expires April 30, 2015 [Page 43]
Internet-Draft XML2RFCv3 October 2014
o "exp"
o "historic"
2.45.2. 'consensus' attribute
Affects the generated boilerplate.
See [RFC5741] for more information.
Allowed values:
o "no"
o "yes"
2.45.3. 'docName' attribute
Specifies the name or the Internet Draft or private document. A
private document is one whose representation is not meant to be an
Internet Draft or RFC. If the value for this attribute starts with
the string "draft-", a processor treats the input as an Internet
Draft; if the value starts with any other string, a processor treats
this as a private document. The name in the value should be the
document name without any file extension. That is, the value for
this attribute should be "draft-ietf-somewg-someprotocol-07", not
"draft-ietf-somewg-someprotocol-07.txt".
A processor should give an error if both the "docName" and "number"
attributes are given in the <rfc> element.
2.45.4. 'ipr' attribute
Represents the Intellectual Property status of the document. See
Appendix A.2 for details.
Allowed values:
o "full2026"
o "noDerivativeWorks2026"
o "none"
o "full3667"
o "noModification3667"
Hoffman Expires April 30, 2015 [Page 44]
Internet-Draft XML2RFCv3 October 2014
o "noDerivatives3667"
o "full3978"
o "noModification3978"
o "noDerivatives3978"
o "trust200811"
o "noModificationTrust200811"
o "noDerivativesTrust200811"
o "trust200902"
o "noModificationTrust200902"
o "noDerivativesTrust200902"
o "pre5378Trust200902"
2.45.5. 'iprExtract' attribute
Identifies a single section within the document for which extraction
"as-is" is explicitly allowed (only relevant for historic values of
the "ipr" attribute).
2.45.6. 'number' attribute
The number of the RFC to be produced by a processor.
A processor should give an error if both the "docName" and "number"
attributes are given in the <rfc> element.
2.45.7. 'obsoletes' attribute
A comma-separated list of RFC numbers or Internet-Draft names.
Processors ought to parse the attribute value, so that incorrect
references can be detected and, depending on output representation,
hyperlinks can be generated. Also, the value ought to be reformatted
to insert whitespace after each comma if not already present.
2.45.8. 'seriesNo' attribute
When producing a document within document series (such as "STD"): the
number within that series.
Hoffman Expires April 30, 2015 [Page 45]
Internet-Draft XML2RFCv3 October 2014
2.45.9. 'sortRefs' attribute
Specifies whether or not a processor will sort the references in each
reference section.
Allowed values:
o "yes"
o "no" (default)
2.45.10. 'submissionType' attribute
The document stream.
See Section 2 of [RFC5741] for details.
Allowed values:
o "IETF" (default)
o "IAB"
o "IRTF"
o "independent"
2.45.11. 'symRefs' attribute
Specifies whether or not a processor will use symbolic references
(such as "[RFC2119]"). If the value for this is "no", the references
come out as numbers (such as "[3]").
Allowed values:
o "yes" (default)
o "no"
2.45.12. 'tocDepth' attribute
Specifies number of levels of heading for a processor to include in
the table of contents; the default is "3".
2.45.13. 'tocInclude' attribute
Specifies whether or not a processor will include a table of contents
in generated files.
Hoffman Expires April 30, 2015 [Page 46]
Internet-Draft XML2RFCv3 October 2014
Allowed values:
o "yes" (default)
o "no"
2.45.14. 'updates' attribute
A comma-separated list of RFC numbers or Internet-Draft names.
Processors ought to parse the attribute value, so that incorrect
references can be detected and, depending on output representation,
hyperlinks can be generated. Also, the value ought to be reformatted
to insert whitespace after each comma if not already present.
2.45.15. 'xml:lang' attribute
The natural language used in the document (defaults to "en").
See Section 2.12 of [XML] for more information.
2.46. <section>
Represents a section (when inside a <middle> element) or an appendix
(when inside a <back> element).
Sub-sections are created by nesting <section> elements inside
<section> elements. Sections are allowed to be empty.
This element appears as a child element of: <back> (Section 2.9),
<boilerplate> (Section 2.12), <middle> (Section 2.32), and <section>
(Section 2.46).
Content model:
In this order:
1. One <name> element (Section 2.33)
2. In any order:
* <artwork> elements (Section 2.5)
* <aside> elements (Section 2.6)
* <blockquote> elements (Section 2.11)
Hoffman Expires April 30, 2015 [Page 47]
Internet-Draft XML2RFCv3 October 2014
* <dl> elements (Section 2.20)
* <figure> elements (Section 2.25)
* <iref> elements (Section 2.28)
* <ol> elements (Section 2.35)
* <sourcecode> elements (Section 2.48)
* <t> elements (Section 2.53)
* <table> elements (Section 2.54)
* <texttable> elements (Section 3.8)
* <ul> elements (Section 2.63)
3. Optional <section> elements (Section 2.46)
2.46.1. 'anchor' attribute
Document-wide unique identifier for this section.
2.46.2. 'numbered' attribute
If set to "no", this section does not get a section number.
Processors will verify that such a section is not followed by a
numbered section in a part, and will verify that the section is a
top-level section.
Allowed values:
o "yes" (default)
o "no"
2.46.3. 'removeInRFC' attribute
If set to "yes", this section is marked in the processor with text
indicating that it should be removed before the document is published
as an RFC.
Allowed values:
o "yes"
Hoffman Expires April 30, 2015 [Page 48]
Internet-Draft XML2RFCv3 October 2014
o "no" (default)
2.46.4. 'sectionNumber' attribute
The number for this section, if one is generated by the processor.
This attribute and its value are automatically generated by the RFC
Processor, and are ignored by other processors. If the value already
exists when the RFC Processor is run, it is replaced.
2.46.5. 'title' attribute
Deprecated. Use <name> instead.
2.46.6. 'toc' attribute
Indicates to a processor whether or not the section is to be included
in the table of contents. This only takes effect if the level of the
section would have 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 being created based on the "tocInclude"
attribute of the <rfc> element. If this is set to "exclude", any
section below this one will be excluded as well. The "default" value
indicates to include the section if it would be included by the
tocDepth attribute of the <rfc> element.
Allowed values:
o "include"
o "exclude"
o "default" (default)
2.47. <seriesInfo>
Specifies the document series in which this document appears, and
also specifies an identifier within that series.
This element appears as a child element of: <reference>
(Section 2.41).
Content model: this element does not have any contents.
2.47.1. 'asciiname' attribute
The ASCII equivalent of the name field.
Hoffman Expires April 30, 2015 [Page 49]
Internet-Draft XML2RFCv3 October 2014
2.47.2. 'asciivalue' attribute
The ASCII equivalent of the value field.
2.47.3. 'name' attribute (mandatory)
The name of the series.
The following names trigger specific processing (such as for auto-
generating links, and adding descriptions such as "work in
progress"): "BCP", "FYI", "Internet-Draft", "RFC", and "STD".
2.47.4. 'value' attribute (mandatory)
The identifier within the series specified by the "name" attribute.
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-
digit version number).
2.48. <sourcecode>
This element allows the inclusion of sourcecode into the document.
<sourcecode> provides full control of horizontal whitespace and line
breaks. It is thus useful for source code and formal languages (such
as ABNF or the RNC notation used in this document).
For artwork such as character-based art, diagrams of message layouts,
and so on, use the <artwork> element instead.
A common problem authors have with <sourcecode> is that the XML
processor returns errors if the text in the artwork contains either
the "&" or "<" character, or the string "]]>". To avoid these
problems, the "&" and "<" characters may be escaped using the strings
"&" and "<", respectively; the "]]>" string can be represented
as "]]>". Alternatively, they may be surrounded in a CDATA
structure: "<![CDATA[]]>". For example:
Hoffman Expires April 30, 2015 [Page 50]
Internet-Draft XML2RFCv3 October 2014
Desired output:
allowed-chars = "." | "," | "&" | "<" | ">" | "|"
Using escaping:
<sourcecode>
allowed-chars = "." | "," | "&" | "<" | ">" | "|"
</sourcecode>
Using CDATA:
<sourcecode>
<![CDATA[ allowed-chars = "." | "," | "&" | "<" | ">" | "|"]]>
</sourcecode>
Using CDATA is not a panacea, but it does help prevent having to use
escapes in places where using using escapes can cause other problems,
such as difficulty of inclusion from other documents.
This element appears as a child element of: <aside> (Section 2.6),
<blockquote> (Section 2.11), <dd> (Section 2.18), <figure>
(Section 2.25), <li> (Section 2.30), <section> (Section 2.46), <td>
(Section 2.56), and <th> (Section 2.58).
Content model: only text content.
2.48.1. 'anchor' attribute
Document-wide unique identifier for this sourcecode.
2.48.2. 'name' attribute
A filename suitable for the contents (such as for extraction to a
local file). This attribute generally isn't used for document
generation, but it can be helpful for other kinds of tools (such as
automated syntax checkers which work by extracting the source code).
2.48.3. 'partNumber' attribute
The number for this sourceode within the section. The numbering is
shared with other elements of a section. This is described in more
detail in Appendix B.2.
2.48.4. 'type' attribute
Specifies the type of the sourcecode. The value of this attribute is
free text with certain values designated as preferred. A private
processor (as described in Appendix B) might add type-specific
formatting to sourcecode with the preferred values. If a processor
encounters a value for "type" that is not one of the preferred
Hoffman Expires April 30, 2015 [Page 51]
Internet-Draft XML2RFCv3 October 2014
values, it can issue a warning but should still use the artwork as if
it had no "type" attribute.
The preferred values for <sourcecode> types are:
o abnf
o asn.1
o bash
o c++
o c
o cbor
o dtd
o java
o javascript
o json
o mib
o perl
o pseudocode
o python
o rnc
o xml
The RFC Editor will maintain a complete list of the preferred values
on its web site, and that list is expected to be updated over time.
Thus, a consumer of v3 XML should not cause a failure when it
encounters an unexpected type.
2.49. <street>
Provides a street address.
This element appears as a child element of: <postal> (Section 2.38).
Hoffman Expires April 30, 2015 [Page 52]
Internet-Draft XML2RFCv3 October 2014
Content model: only text content.
2.49.1. 'ascii' attribute
The ASCII equivalent of the street address.
2.50. <strong>
Indicates text that is semantically strong. This element will be
displayed as bold after processing. This element has the same
effects as <b>. This element can be combined with other character
formatting elements, and the formatting will be additive.
This element appears as a child element of: <annotation>
(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.22), <i> (Section 2.27), <li> (Section 2.30), <postamble>
(Section 3.5), <preamble> (Section 3.6), <refcontent> (Section 2.40),
<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:
In any order:
o Text
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
Hoffman Expires April 30, 2015 [Page 53]
Internet-Draft XML2RFCv3 October 2014
2.51. <sub>
Causes the text to be displayed as subscript, approximately half a
letter-height lower than normal text. This element can be combined
with other character formatting elements, and the formatting will be
additive.
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <blockquote> (Section 2.11), <c>
(Section 3.1), <cref> (Section 2.16), <dd> (Section 2.18), <dt>
(Section 2.21), <em> (Section 2.22), <i> (Section 2.27), <li>
(Section 2.30), <postamble> (Section 3.5), <preamble> (Section 3.6),
<refcontent> (Section 2.40), <strong> (Section 2.50), <t>
(Section 2.53), <td> (Section 2.56), <th> (Section 2.58), and <tt>
(Section 2.62).
Content model:
In any order:
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <strong> elements (Section 2.50)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.52. <sup>
Causes the text to be displayed as superscript, approximately half a
letter-height higher than normal text. This element can be combined
with other character formatting elements, and the formatting will be
additive.
Hoffman Expires April 30, 2015 [Page 54]
Internet-Draft XML2RFCv3 October 2014
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <blockquote> (Section 2.11), <c>
(Section 3.1), <cref> (Section 2.16), <dd> (Section 2.18), <dt>
(Section 2.21), <em> (Section 2.22), <i> (Section 2.27), <li>
(Section 2.30), <postamble> (Section 3.5), <preamble> (Section 3.6),
<refcontent> (Section 2.40), <strong> (Section 2.50), <t>
(Section 2.53), <td> (Section 2.56), <th> (Section 2.58), and <tt>
(Section 2.62).
Content model:
In any order:
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <strong> elements (Section 2.50)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
2.53. <t>
Contains a paragraph of text.
This element appears as a child element of: <abstract> (Section 2.1),
<aside> (Section 2.6), <blockquote> (Section 2.11), <dd>
(Section 2.18), <li> (Section 2.30), <list> (Section 3.4), <note>
(Section 2.34), <section> (Section 2.46), <td> (Section 2.56), and
<th> (Section 2.58).
Content model:
In any order:
Hoffman Expires April 30, 2015 [Page 55]
Internet-Draft XML2RFCv3 October 2014
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <list> elements (Section 3.4)
o <ol> elements (Section 2.35)
o <spanx> elements (Section 3.7)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <vspace> elements (Section 3.10)
o <xref> elements (Section 2.66)
2.53.1. 'anchor' attribute
Document-wide unique identifier for this paragraph.
2.53.2. 'hangText' attribute
Deprecated. Instead use <dd> inside of a definition list (<dl>).
2.53.3. 'partNumber' attribute
The number for this paragraph within the section. The numbering is
shared with other elements of a section. This is described in more
detail in Appendix B.2.
Hoffman Expires April 30, 2015 [Page 56]
Internet-Draft XML2RFCv3 October 2014
2.54. <table>
Contains a table with a caption with the table number. If the
element contains a <name> element, the caption will also show that
name.
Insde the <table> element is optionlly a <thead> element to 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 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 each
page.
This element appears as a child element of: <section> (Section 2.46).
Content model:
In this order:
1. One optional <name> element (Section 2.33)
2. Optional <iref> elements (Section 2.28)
3. One optional <thead> element (Section 2.59)
4. One or more <tbody> elements (Section 2.55)
5. One optional <tfoot> element (Section 2.57)
2.54.1. 'anchor' attribute
Document-wide unique identifier for this table.
2.54.2. 'tableNumber' attribute
The number for this table. This attribute and its value are
automatically generated by the RFC Processor. If the value already
exists when the RFC Processor is run, it is replaced.
2.55. <tbody>
A container for a set of body rows for a table.
This element appears as a child element of: <table> (Section 2.54).
Content model:
One or more <tr> elements (Section 2.61)
Hoffman Expires April 30, 2015 [Page 57]
Internet-Draft XML2RFCv3 October 2014
2.56. <td>
A cell in a table row.
This element appears as a child element of: <tr> (Section 2.61).
Content model:
Either:
One or more <t> elements (Section 2.53)
Or:
In any order, but at least one of:
* Text
* <artwork> elements (Section 2.5)
* <b> elements (Section 2.8)
* <bcp14> elements (Section 2.10)
* <cref> elements (Section 2.16)
* <dl> elements (Section 2.20)
* <em> elements (Section 2.22)
* <eref> elements (Section 2.24)
* <figure> elements (Section 2.25)
* <i> elements (Section 2.27)
* <iref> elements (Section 2.28)
* <ol> elements (Section 2.35)
* <sourcecode> elements (Section 2.48)
* <strong> elements (Section 2.50)
* <sub> elements (Section 2.51)
* <sup> elements (Section 2.52)
Hoffman Expires April 30, 2015 [Page 58]
Internet-Draft XML2RFCv3 October 2014
* <tt> elements (Section 2.62)
* <ul> elements (Section 2.63)
* <xref> elements (Section 2.66)
2.56.1. 'border' attribute
The width of the border for this cell. The default is 0, meaning no
border.
2.56.2. 'colspan' attribute
The number of columns that the cell to span. For example, setting
"colspan='3'" indicates that the cell occupies the same horizontal
space as three cells in the row above or below this one.
2.56.3. 'rowspan' attribute
The number of rows that the cell to span. For example, setting
"rowspan='3'" indicates that the cell occupies the same vertical
space as three rows.
2.57. <tfoot>
A container for a set of footer rows for a table.
This element appears as a child element of: <table> (Section 2.54).
Content model:
One or more <tr> elements (Section 2.61)
2.58. <th>
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
the td> element.
This element appears as a child element of: <tr> (Section 2.61).
Content model:
Either:
One or more <t> elements (Section 2.53)
Or:
Hoffman Expires April 30, 2015 [Page 59]
Internet-Draft XML2RFCv3 October 2014
In any order, but at least one of:
* Text
* <artwork> elements (Section 2.5)
* <b> elements (Section 2.8)
* <bcp14> elements (Section 2.10)
* <cref> elements (Section 2.16)
* <dl> elements (Section 2.20)
* <em> elements (Section 2.22)
* <eref> elements (Section 2.24)
* <figure> elements (Section 2.25)
* <i> elements (Section 2.27)
* <iref> elements (Section 2.28)
* <ol> elements (Section 2.35)
* <sourcecode> elements (Section 2.48)
* <strong> elements (Section 2.50)
* <sub> elements (Section 2.51)
* <sup> elements (Section 2.52)
* <tt> elements (Section 2.62)
* <ul> elements (Section 2.63)
* <xref> elements (Section 2.66)
2.58.1. 'border' attribute
The width of the border for this cell. The default is 0, meaning no
border.
Hoffman Expires April 30, 2015 [Page 60]
Internet-Draft XML2RFCv3 October 2014
2.58.2. 'colspan' attribute
The number of columns that the cell to span. For example, setting
"colspan='3'" indicates that the cell occupies the same horizontal
space as three cells in the row above or below this one.
2.58.3. 'rowspan' attribute
The number of rows that the cell to span. For example, setting
"rowspan='3'" indicates that the cell occupies the same vertical
space as three rows.
2.59. <thead>
A container for a set of header rows for a table.
This element appears as a child element of: <table> (Section 2.54).
Content model:
One or more <tr> elements (Section 2.61)
2.60. <title>
Represents the document title.
When this element appears in the <front> element of the current
document, the title might also appear in page headers or footers. If
it is long (~40 characters), the "abbrev" attribute is used to
specify an abbreviated variant.
This element appears as a child element of: <front> (Section 2.26).
Content model: only text content.
2.60.1. 'abbrev' attribute
Specifies an abbreviated variant of the document title.
2.60.2. 'ascii' attribute
The ASCII equivalent of the title.
2.61. <tr>
A row of a table.
This element appears as a child element of: <tbody> (Section 2.55),
Hoffman Expires April 30, 2015 [Page 61]
Internet-Draft XML2RFCv3 October 2014
<tfoot> (Section 2.57), and <thead> (Section 2.59).
Content model:
One or more sequences of:
1. One <td> element
2. One <th> element
2.61.1. 'border' attribute
The width of the border for this row. The default is 0, meaning no
border. If the cells in this row also have "border" attributes,
those values override this value for those cells.
2.62. <tt>
Causes the text to be displayed in a constant-width font. This
element can be combined with other character formatting elements, and
the formatting will be additive.
This element appears as a child element of: <annotation>
(Section 2.3), <b> (Section 2.8), <blockquote> (Section 2.11), <c>
(Section 3.1), <cref> (Section 2.16), <dd> (Section 2.18), <dt>
(Section 2.21), <em> (Section 2.22), <i> (Section 2.27), <li>
(Section 2.30), <name> (Section 2.33), <postamble> (Section 3.5),
<preamble> (Section 3.6), <refcontent> (Section 2.40), <strong>
(Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52), <t>
(Section 2.53), <td> (Section 2.56), and <th> (Section 2.58).
Content model:
In any order:
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
Hoffman Expires April 30, 2015 [Page 62]
Internet-Draft XML2RFCv3 October 2014
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <xref> elements (Section 2.66)
2.63. <ul>
An unordered list. The labels on the items will be symbols picked by
the processor.
This element appears as a child element of: <dd> (Section 2.18), <li>
(Section 2.30), <section> (Section 2.46), <td> (Section 2.56), and
<th> (Section 2.58).
Content model:
One or more <li> elements (Section 2.30)
2.63.1. 'empty' attribute
Defines whether or not the label is empty. empty="true" indicates
that no label be shown.
Allowed values:
o "false" (default)
o "true"
2.63.2. 'spacing' attribute
Defines whether or not there is a blank line between entries.
spacing="normal" indicates a single blank line, while
spacing="compact" indicates no space between.
Allowed values:
o "normal" (default)
o "compact"
Hoffman Expires April 30, 2015 [Page 63]
Internet-Draft XML2RFCv3 October 2014
2.64. <uri>
Contains a web address associated with the author.
The contents should be a valid URI (see Section 3 of [RFC3986]).
This element appears as a child element of: <address> (Section 2.2).
Content model: only text content.
2.65. <workgroup>
This element is used to specify the Working Group (IETF) or Research
Group (IRTF) from which the document originates, if any. The
recommended format is the official name of the Working Group (with
some capitalization).
In Internet-Drafts, this is used in the upper left corner of the
boilerplate, replacing the "Network Working Group" string.
Formatting software can append the words "Working Group" or "Research
Group", depending on the "submissionType" property on the <rfc>
element (Section 2.45.10).
This element appears as a child element of: <front> (Section 2.26).
Content model: only text content.
2.66. <xref>
Inserts a reference to a different part of a document.
The generated text depends on whether the <xref> is empty (in which
case the processor will try to generate a meaningful text fragment),
and the nature of the referenced document part.
If the element is empty, a converter must invent text to show for the
reference. If the element is filled in and the format being
converted to supports links, the text from the element is surrounded
by a link to the reference.
Any element that allows the "anchor" attribute can be referenced;
however, there are restrictions with respect to the text content
being generated. For instance, a <t> can be a reference target,
however, because paragraphs are not (visibly) numbered, the author
will have to make sure that the prose is sufficient for a reader to
understand what is being referred to.
This element appears as a child element of: <annotation>
Hoffman Expires April 30, 2015 [Page 64]
Internet-Draft XML2RFCv3 October 2014
(Section 2.3), <b> (Section 2.8), <c> (Section 3.1), <cref>
(Section 2.16), <dd> (Section 2.18), <dt> (Section 2.21), <em>
(Section 2.22), <i> (Section 2.27), <li> (Section 2.30), <name>
(Section 2.33), <postamble> (Section 3.5), <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), <tt>
(Section 2.62), and <ttcol> (Section 3.9).
Content model: only text content.
2.66.1. 'format' attribute
This attribute is used to control the format of the generated
reference text.
"counter"
Inserts just a counter; this is used for the number of a section,
figure, or table. For example:
<section anchor="overview">Protocol Overview</section>
. . .
See Section <xref target="overview" format="counter"/>
for an overview.
might generate
See Section 1.7 for an overview.
"default"
Inserts a text fragment that describes the referenced part
completely, such as "Section 2" or "Table 4" for internal links,
or "[XML]" for links to references. For example:
<section anchor="overview">Protocol Overview</section>
. . .
See <xref target="overview"/> for an overview.
might generate
See Section 1.7 for an overview.
"none"
There will be no auto-generated text. This is useful for creating
a link that will appear in the processed text.
Hoffman Expires April 30, 2015 [Page 65]
Internet-Draft XML2RFCv3 October 2014
"title"
Inserts a title for the referenced element (usually obtained from
the referenced element's "title" attribute; some processors also
use the <title> child element or a <reference> target).
Allowed values:
o "counter"
o "title"
o "none"
o "default" (default)
2.66.2. 'pageno' attribute
Deprecated.
Allowed values:
o "true"
o "false" (default)
2.66.3. 'relative' attribute
Specifies a relative reference from the main target. Rendering
relative references is based on the format for the converted
document.
2.66.4. 'section' attribute
Specifies a section for the generated reference. For example,
See <xref section="2.3" target="RFC6949"/> for more information.
would generate
See Section 2.3 of [RFC6949] for more information.
2.66.5. 'sectionFormat' attribute
The format that the section reference will be displayed in. The
acceptable values are:
Hoffman Expires April 30, 2015 [Page 66]
Internet-Draft XML2RFCv3 October 2014
o "of" (default)
o "comma"
o "parens"
For example:
See <xref target="RFC6949" section="2.3" sectionFormat="of"/>
for more information.
See <xref target="RFC6949" section="2.4" sectionFormat="comma"/>
for more information.
See <xref target="RFC6949" section="2.5" sectionFormat="parens"/>
for more information.
would generate
See Section 2.3 of [RFC6949] for more information.
See [RFC6949], Section 2.4 for more information.
See [RFC6949] (Section 2.5) for more information.
2.66.6. 'target' attribute (mandatory)
Identifies the document component being referenced.
The value needs to match the value of the "anchor" attribute of
another element in the document.
3. Elements from v2 That Have Been Deprecated
This section lists the elements from v2 that have been deprecated.
Note that some elements in v3 have attributes from v2 that are
deprecated; those are not listed here.
3.1. <c>
Deprecated. Instead, use <tr>, <td>, and <th>.
This element appears as a child element of: <texttable>
(Section 3.8).
Content model:
In any order:
o Text
Hoffman Expires April 30, 2015 [Page 67]
Internet-Draft XML2RFCv3 October 2014
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <spanx> elements (Section 3.7)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
3.2. <facsimile>
Deprecated. The <email> element is a much more useful way to get in
touch with authors.
This element appears as a child element of: <address> (Section 2.2).
Content model: only text content.
3.3. <format>
Deprecated. If the goal is to provide a single URI for a reference,
use the "target" attribute on <reference> instead.
This element appears as a child element of: <reference>
(Section 2.41).
Content model: this element does not have any contents.
Hoffman Expires April 30, 2015 [Page 68]
Internet-Draft XML2RFCv3 October 2014
3.3.1. 'octets' attribute
Deprecated.
3.3.2. 'target' attribute
Deprecated.
3.3.3. 'type' attribute (mandatory)
Deprecated.
3.4. <list>
Deprecated. Instead, use <dl> for list/@style "hanging"; <ul> for
list/@style "empty" or "symbols"; and <ol> for list/@style "letters",
"numbers", "counter", or "format".
This element appears as a child element of: <t> (Section 2.53).
Content model:
One or more <t> elements (Section 2.53)
3.4.1. 'counter' attribute
Deprecated. The functionality of this attribute has been replaced
with <ol>/@start.
3.4.2. 'hangIndent' attribute
Deprecated. Use <dl> instead.
3.4.3. 'style' attribute
Deprecated.
3.5. <postamble>
Deprecated. Instead, use a regular paragraph after the figure or
table.
This element appears as a child element of: <figure> (Section 2.25),
and <texttable> (Section 3.8).
Content model:
In any order:
Hoffman Expires April 30, 2015 [Page 69]
Internet-Draft XML2RFCv3 October 2014
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <spanx> elements (Section 3.7)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
3.6. <preamble>
Deprecated. Instead, use a regular paragraph before the figure or
table.
This element appears as a child element of: <figure> (Section 2.25),
and <texttable> (Section 3.8).
Content model:
In any order:
o Text
o <b> elements (Section 2.8)
o <bcp14> elements (Section 2.10)
o <cref> elements (Section 2.16)
Hoffman Expires April 30, 2015 [Page 70]
Internet-Draft XML2RFCv3 October 2014
o <em> elements (Section 2.22)
o <eref> elements (Section 2.24)
o <i> elements (Section 2.27)
o <iref> elements (Section 2.28)
o <spanx> elements (Section 3.7)
o <strong> elements (Section 2.50)
o <sub> elements (Section 2.51)
o <sup> elements (Section 2.52)
o <tt> elements (Section 2.62)
o <xref> elements (Section 2.66)
3.7. <spanx>
Deprecated.
This element appears as a child element of: <annotation>
(Section 2.3), <c> (Section 3.1), <postamble> (Section 3.5),
<preamble> (Section 3.6), and <t> (Section 2.53).
Content model: only text content.
3.7.1. 'style' attribute
Deprecated. Instead of <spanx style="emph">, use <b> instead of
<spanx style="strong">, use <i>; instead of <spanx style="verg">, use
<tt>.
3.7.2. 'xml:space' attribute
Deprecated.
Allowed values:
o "default"
o "preserve" (default)
Hoffman Expires April 30, 2015 [Page 71]
Internet-Draft XML2RFCv3 October 2014
3.8. <texttable>
Deprecated. Use <table> instead.
This element appears as a child element of: <aside> (Section 2.6),
and <section> (Section 2.46).
Content model:
In this order:
1. One optional <name> element (Section 2.33)
2. One optional <preamble> element (Section 3.6)
3. One or more <ttcol> elements (Section 3.9)
4. Optional <c> elements (Section 3.1)
5. One optional <postamble> element (Section 3.5)
3.8.1. 'align' attribute
Deprecated
Allowed values:
o "left"
o "center" (default)
o "right"
3.8.2. 'anchor' attribute
Deprecated
3.8.3. 'style' attribute
Deprecated.
3.8.4. 'suppress-title' attribute
Deprecated.
Allowed values:
Hoffman Expires April 30, 2015 [Page 72]
Internet-Draft XML2RFCv3 October 2014
o "true"
o "false" (default)
3.8.5. 'title' attribute
Deprecated.
3.9. <ttcol>
Deprecated. Instead, use <tr>, <td>, and <th>.
This element appears as a child element of: <texttable>
(Section 3.8).
Content model:
In any order:
o <cref> elements (Section 2.16)
o <eref> elements (Section 2.24)
o <iref> elements (Section 2.28)
o <xref> elements (Section 2.66)
o Text
3.9.1. 'align' attribute
Deprecated.
Allowed values:
o "left" (default)
o "center"
o "right"
3.9.2. 'width' attribute
Deprecated.
Hoffman Expires April 30, 2015 [Page 73]
Internet-Draft XML2RFCv3 October 2014
3.10. <vspace>
Deprecated. In earlier versions of this format, <vspace> was often
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
inside the <li> element. Other uses have no direct replacement.
This element appears as a child element of: <t> (Section 2.53).
Content model: this element does not have any contents.
3.10.1. 'blankLines' attribute
Deprecated.
4. Internationalization Considerations
This format is based on [XML], thus does not have any issues
representing arbitrary Unicode [UNICODE] characters in text content.
The RFC Editor may restrict some of the characters that can be used
in a particular RFC; the rules for such restrictions are covered in
[NONASCII].
5. Security Considerations
The "name" attribute on the <artwork> element (Section 2.5.5) can be
used to derive a filename for saving to a local file system.
Trusting this kind of information without pre-processing is a known
security risk; see Section 4.3 of [RFC6266] for more information.
The "type" attribute of the <artwork> and <sourcecode> elements is
meant to encourage processors to automatically extract known types of
content from an RFC or Internet Draft. While extraction is probably
safe, those processors might also think that they could further
process the extracted content such as by rendering artwork or
executing code. Doing so without first sanity-checking the extracted
content is clearly a terrible idea from a security perspective. More
generally, a processor that is reading RFCs or Internet Drafts needs
to be suspicious of any content that it intends to post-process.
All security considerations related to XML processing are relevant as
well (see Section 7 of [RFC3470]).
6. IANA Considerations
Hoffman Expires April 30, 2015 [Page 74]
Internet-Draft XML2RFCv3 October 2014
6.1. Internet Media Type Registration
IANA maintains the registry of Internet media types [BCP13] at
<http://www.iana.org/assignments/media-types>.
This document updates the specification for the Internet media type
"application/rfc+xml" from the one in [XML2RFCv2]. The following is
to be registered with IANA.
Type name: application
Subtype name: rfc+xml
Required parameters: There are no required parameters.
Optional parameters: "charset": This parameter has identical
semantics as the charset parameter of the "application/xml" media
type specified in Section 9.1 of [RFC7303].
Encoding considerations: Identical to those of "application/xml" as
described in Section 9.1 of [RFC7303].
Security considerations: As defined in Section 5. In addition, as
this media type uses the "+xml" convention, it inherits the
security considerations described in Section 10 of [RFC7303].
Interoperability considerations: N/A
Published specification: This specification.
Applications that use this media type: Applications that transform
xml2rfc to output representations such as plain text or HTML, plus
additional analysis tools.
Fragment identifier considerations: The "anchor" attribute is used
for assigning document-wide unique identifiers that can be used as
shorthand pointers, as described in Section 2.8 of [XPOINTER].
Additional information:
Deprecated alias names for this type: None.
Magic number(s): As specified for "application/xml" in Section
9.1 of [RFC7303].
Hoffman Expires April 30, 2015 [Page 75]
Internet-Draft XML2RFCv3 October 2014
File extension(s): .xml or .rfcxml when disambiguation from other
XML files is needed
Macintosh file type code(s): TEXT
Person & email address to contact for further information: See
Authors Section.
Intended usage: COMMON
Restrictions on usage: N/A
Author: See Authors Section.
Change controller: RFC Series Editor (rse@rfc-editor.org)
6.2. Link Relation Registration
The following is a proposed addition to [LINKRELATIONS].
Relation Name: convertedFrom
Description: The document linked to was later converted to the
document that contains this link relation. For example, an RFC can
have a link to the Internet Draft that became the RFC; in that case,
the link relation would be "convertedFrom".
Reference: This document.
Notes: This relation is different than "predecessor-version" in that
"predecessor-version" is for items in a version control system. It
is also different that "previous" in that this relation is used for
converted resources, not those that are part of a sequence of
resources.
Application Data: none
7. Acknowledgments
Thanks to everybody who reviewed this document and provided feedback
and/or specification text. Thanks especially go to Julian Reschke
for editing [XML2RFCv2] and those who provided feedback on that
document.
We also thank Marshall T. Rose for both the original design and the
reference implementation of the "xml2rfc" processor.
8. References
Hoffman Expires April 30, 2015 [Page 76]
Internet-Draft XML2RFCv3 October 2014
8.1. Normative References
[XML] Maler, E., Yergeau, F., Paoli, J., Sperberg-McQueen,
M., and T. Bray, "Extensible Markup Language (XML)
1.0 (Fifth Edition)", W3C Recommendation REC-xml-
20081126, November 2008,
<http://www.w3.org/TR/2008/REC-xml-20081126/>.
Latest version available at
<http://www.w3.org/TR/xml>.
[XML2RFCv2] Reschke, J., "The 'XML2RFC' version 2 Vocabulary",
draft-reschke-xml2rfc (work in progress), 2014.
8.2. Informative References
[BCP13] Freed, N., Klensin, J., and T. Hansen, "Media Type
Specifications and Registration Procedures", BCP 13,
RFC 6838, January 2013.
[IDGUIDE] Housley, R., "Guidelines to Authors of Internet-
Drafts",
<http://www.ietf.org/id-info/guidelines.html>.
[LINKRELATIONS] IANA, "Link Relations", <http://www.iana.org/
assignments/link-relations/link-relations.xhtml>.
[NONASCII] Flanagan, H., "The Use of Non-ASCII Characters in
RFCs", draft-flanagan-nonascii (work in progress),
2014.
[RFC2026] Bradner, S., "The Internet Standards Process --
Revision 3", BCP 9, RFC 2026, October 1996.
[RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397,
August 1998.
[RFC2629] Rose, M., "Writing I-Ds and RFCs using XML",
RFC 2629, June 1999.
[RFC3470] Hollenbeck, S., Rose, M., and L. Masinter,
"Guidelines for the Use of Extensible Markup
Language (XML) within IETF Protocols", BCP 70,
RFC 3470, January 2003.
[RFC3966] Schulzrinne, H., "The tel URI for Telephone
Numbers", RFC 3966, December 2004.
Hoffman Expires April 30, 2015 [Page 77]
Internet-Draft XML2RFCv3 October 2014
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter,
"Uniform Resource Identifier (URI): Generic Syntax",
STD 66, RFC 3986, January 2005.
[RFC5741] Daigle, L. and O. Kolkman, "RFC Streams, Headers,
and Boilerplates", RFC 5741, December 2009.
[RFC6068] Duerst, M., Masinter, L., and J. Zawinski, "The
'mailto' URI Scheme", RFC 6068, October 2010.
[RFC6266] Reschke, J., "Use of the Content-Disposition Header
Field in the Hypertext Transfer Protocol (HTTP)",
RFC 6266, June 2011.
[RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format
Requirements and Future Development", RFC 6949,
May 2013.
[RFC7303] Thompson, H. and C. Lilley, "XML Media Types",
RFC 7303, July 2014.
[RFC7322] Heather, H. and S. Ginoza, "RFC Style Guide",
RFC 7322, September 2014.
[RFCPOLICY] RFC Editor, "RFC Editorial Guidelines and
Procedures",
<http://www.rfc-editor.org/policy.html>.
[RNC] Clark, J., "RELAX NG Compact Syntax", OASIS ,
November 2002, <http://www.oasis-open.org/
committees/relax-ng/compact-20021121.html>.
[RNG] ISO/IEC, "Information Technology - Document Schema
Definition Languages (DSDL) - Part 2: Regular-
Grammar-Based Validation - RELAX NG. Second
Edition.", ISO/IEC 19757-2:2008(E), December 2008.
A useful source of RNG-related information is
<http://relaxng.org/>.
[TLP2.0] IETF Trust, "Legal Provisions Relating to IETF
Documents", February 2009, <http://trustee.ietf.org/
license-info/IETF-TLP-2.htm>.
[TLP3.0] IETF Trust, "Legal Provisions Relating to IETF
Documents", September 2009, <http://
trustee.ietf.org/license-info/IETF-TLP-3.htm>.
Hoffman Expires April 30, 2015 [Page 78]
Internet-Draft XML2RFCv3 October 2014
[TLP4.0] IETF Trust, "Legal Provisions Relating to IETF
Documents", December 2009, <http://trustee.ietf.org/
license-info/IETF-TLP-4.htm>.
[UNICODE] The Unicode Consortium, "The Unicode Standard,
Version 6.3.0", September 2013,
<http://www.unicode.org/versions/Unicode6.3.0/>.
[XInclude] Marsh, J., Orchard, D., and D. Veillard, "XML
Inclusions (XInclude) Version 1.0 (Second Edition)",
W3C Recommendation REC-xinclude-20061115,
November 2006, <http://www.w3.org/TR/xinclude/>.
Latest version available at
<http://www.w3.org/TR/xinclude/>.
[XPOINTER] 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/>.
Appendix A. Front Page Generation
A.1. The /rfc/@category Attribute
For RFCs, the category 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, but will
appear on the front page as "Intended Status". Supplying this
information can be useful to reviewers.
A.2. The /rfc/@ipr Attribute
This attribute value can take a long list of values, each of which
describes an IPR policy for the document. This attribute's values
are not the result of a grand plan, but remain simply for historic
reasons. Of these values, only a few are currently in use; all
others are supported by the various tools for backwards compatibility
with old source files.
Hoffman Expires April 30, 2015 [Page 79]
Internet-Draft XML2RFCv3 October 2014
Note: some variations of the boilerplate are selected based on the
document's date; therefore it is important to specify the "year",
"month" and "day" attributes of the <date> element when archiving
the XML source of an Internet-Draft on the day of submission.
Disclaimer: THIS ONLY PROVIDES IMPLEMENTATION INFORMATION. IF YOU
NEED LEGAL ADVICE, PLEASE CONTACT A LAWYER. For further information,
refer to <http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf>.
For the current "Status Of This Memo" text, the submissionType
attribute determines whether a statement about "Code Components" is
inserted (which is the case for the value "IETF", which is the
default). Other values, such as "independent", suppress this part of
the text.
A.2.1. Current Values: '*trust200902'
The name for these values refers to the "IETF TRUST Legal Provisions
Relating to IETF Documents", sometimes simply called the "TLP, that
went into effect on February 15, 2009 ([TLP2.0]). Updates to this
document were published on September 12, 2009 ([TLP3.0]) and on
December 28, 2009 ([TLP4.0]), modifying the license for code
components (see <http://trustee.ietf.org/license-info/> for further
information). The actual text is located in Section 6 ("Text To Be
Included in IETF Documents") of these documents.
The tools will automatically produce the "correct" text depending on
the document's date information (see above):
+----------+--------------------------------+
| TLP | starting with publication date |
+----------+--------------------------------+
| [TLP3.0] | 2009-11-01 |
| [TLP4.0] | 2010-04-01 |
+----------+--------------------------------+
A.2.1.1. trust200902
This should be the default, unless one of the more specific
'*trust200902' values is a better fit. It produces the text in
Sections 6.a and 6.b of the TLP.
A.2.1.2. noModificationTrust200902
This produces additional text from Section 6.c.i of the TLP:
Hoffman Expires April 30, 2015 [Page 80]
Internet-Draft XML2RFCv3 October 2014
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
to translate it into languages other than English.
Note: this clause is incompatible with RFCs that are published on
the Standards Track.
A.2.1.3. noDerivativesTrust200902
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
not be created, and it may not be published except as an Internet-
Draft.
Note: this clause is incompatible with RFCs.
A.2.1.4. pre5378Trust200902
This produces the additional text from Section 6.c.iii of the TLP,
frequently called the "pre-5378 escape clause":
This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this
material may not have granted the IETF Trust the right to allow
modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s)
controlling the copyright in such materials, this document may not
be modified outside the IETF Standards Process, and derivative
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
into languages other than English.
See Section 4 of
<http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf> for further
information about when to use this value.
Note: this text appears under "Copyright Notice", unless the
document was published before November 2009, in which case it
appears under "Status Of This Memo".
A.2.2. Historic Values
A.2.2.1. Historic Values: '*trust200811'
The attribute values "trust200811", "noModificationTrust200811" and
"noDerivativesTrust200811" are similar to their "trust200902"
Hoffman Expires April 30, 2015 [Page 81]
Internet-Draft XML2RFCv3 October 2014
counterparts, except that they use text specified in <http://
trustee.ietf.org/license-info/archive/
IETF-Trust-License-Policy_11-10-08.pdf>.
A.2.2.2. Historic Values: '*3978'
The attribute values "full3978", "noModification3978" and
"noDerivatives3978" are similar to their counterparts above, except
that they use text specified in RFC 3978 (March 2005).
A.2.2.3. Historic Values: '*3667'
The attribute values "full3667", "noModification3667" and
"noDerivatives3667" are similar to their counterparts above, except
that they use text specified in RFC 3667 (February 2004).
A.2.2.4. Historic Values: '*2026'
The attribute values "full2026" and "noDerivativeWorks2026" are
similar to their counterparts above, except that they use text
specified in RFC 2026 (October 1996).
The special value "none" was also used back then, and denied the IETF
any rights beyond publication as Internet-Draft.
Appendix B. The v3 Format and Processors
This section describes topics that are specific to processors. Note
that there is some discussion of processors in the main body of the
document as well. For example, some elements have descriptions of
how a processor might create output from the element.
A processor has multiple roles. The processor checks whether or not
the input is valid XML; it also checks whether or not the input XML
matches this format. It may have one or more outputs, depending on
the way that it is invoked. It might convert the XML to different
XML, or to a different representation such as HTML or plain text, or
do no conversion at all. It also might give diagnostic warnings
about how to improve the input.
In v2, the grammar was specified as a DTD. In v3, the grammar is
specified only as Relax Next Generation (RNG). This means that
processors need to work from the RNG, not from a DTD. Some of the
features of the v3 grammar cannot be specified as a DTD.
This section differentiates between three types of processors:
Hoffman Expires April 30, 2015 [Page 82]
Internet-Draft XML2RFCv3 October 2014
o RFC Processor -- The processor used by the RFC Editor to process
the input from one of the RFC streams, and to process XML produced
during the RFC editing process.
o Draft Processor -- The processor used by the Internet Draft
submission tool. This processor will be defined in a different
document.
o Private Processors -- There may be processors that are meant to
run on the computers of authors. These processors may be used to
produce interim versions of the non-canonical representations so
that authors can see how their XML might later be rendered; to
create documents in representations different than those supported
by the RFC Editor; to possibly create documents that are not meant
to be Internet Drafts or RFCs; and to convert XML that has
external information into XML that has that external information
included.
It is expected that a single piece of software will be used for both
the RFC Processor and the Draft Processor, with different application
settings to differentiate between them. It is also expected that the
same software could be used as a Private Processor; others might
create Private Processors independently, or using parts of, the
software used by the RFC Editor.
The RFC Processor and Draft Processor must have clear error
reporting, giving more context than just a line number. For example,
the error messages will differentiate between errors in XML and those
from the v3 format.
It is expected that both the RFC Processor and the Draft Processor
will have options to produce different types of output. For example,
they might have a "convert XML to XML" option that expands the XML
entities in the output.
The restrictions on the canonical XML for RFCs, as well as how the
non-canonical formats will look, are described at <https://
www.rfc-editor.org/rse/wiki/
doku.php?id=design:format-and-content-rfcs>.
B.1. Including External Text
All XML processors for v3 are expected to support XInclude
[XInclude]. XInclude specifies a processing model and syntax for
general purpose inclusion of information that is either on the
Internet or local to the user's computer.
In the v3 syntax, XInclude is expressed as the <xi:include> element.
Hoffman Expires April 30, 2015 [Page 83]
Internet-Draft XML2RFCv3 October 2014
To use this element, you need to include the "xi" namespace in the
<rfc> element; that is, you need to specify
xmlns:xi="http://www.w3.org/2001/XInclude"
as one of the attributes in the <rfc> element.
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
xml2rfc.tools.ietf.org, but later is expected to be from the RFC
Editor. For example, if a document has three normative references,
all RFCs, the document might contain:
<references>
<xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.2119.xml"/>
<xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.4869.xml"/>
<xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.7169.xml"/>
</references>
<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
are all including a particular paragraph or section verbatim, that
text can be kept either in a file or somewhere on the web, and be
included with <xi:include>. An example of pulling something from the
local disk would be:
<x:include href="file://home/chris/ietf/drafts/commontext.xml"/>
In general, XInclude should be used instead of ENTITY references and
XML Processor Instructions (PIs) that allow external inclusions.
B.2. Anchors and IDs
People writing and reading Internet Drafts and RFCs often want to
make reference to specific locations in those documents. In the case
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,
on the other hand, want to reference part of documents that they
didn't write, such as "see Section 3.2 of RFC 6949". The XML
vocabulary in this document attempts to support both sets of people.
Authors can leave anchors in a document that can later be used for
references with the "anchor" attribute. Anchors can be included in
the following elements: <artwork>, <aside>, <blockquote>, <cref>,
<figure>, <li>, <reference>, <referencegroup>, <section>,
Hoffman Expires April 30, 2015 [Page 84]
Internet-Draft XML2RFCv3 October 2014
<sourcecode>, <t>, and <table>. The author can then refer to that
anchor in the "target" attribute of the <xref> element.
Readers can refer to any element that has an "anchor" attribute by
that attribute. Note, however, that most of the time, elements won't
have anchors. In the common case, the reader wants to refer to an
element that does not have an "anchor" attribute, but that element
has "partNumber" attribute.
Processors add the "partNumber" attribute to many elements during
processing. This attribute and its value are automatically generated
by the processor if the attribute is not there; if the attribute is
already there, the processor may replace the value.
B.2.1. Overlapping Values
In the HTML representation of this XML vocabulary, both anchors and
partNumber attributes will be used in the "id" attributes of
elements. Thus, there can be no overlap between the names entered in
"anchor" attributes, the values in the "figureNumber", "tableNumber",
and "sectionNumber" attributes, in "slugifiedName" attributes, and
those that are generated for the "partNumber" attributes. Also,
there are some values for the "anchor" values that are reserved for
sections, and those sections can only have those anchor values.
The following rules prevent this overlap:
o "figureNumber" always has the format "f-nnn", where "nnn" is the
figure number. For example, this would be "f-5" for Figure 5.
o "tableNumber" always has the format "t-nnn", where "nnn" is the
figure number. For example, this would be "t-5" for Table 5.
o "sectionNumber" for regular sections always has the format
"s-nnn", where "nnn" is the section or appendix number. For
example, this would be "s-2.1.3" for 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 always "s-note-nnn",
where "nnn" is a sequential value.
o "partNumber" always has the format "p-nnn-mmm", where "nnn" is the
section number and "mmm" is the 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.
o "slugifiedName" always has the format "n-ttt", where "ttt" is the
text of the name after slugification. For example, this would be
"n-protocol-overview" for the name "Protocol Overview". The
Hoffman Expires April 30, 2015 [Page 85]
Internet-Draft XML2RFCv3 October 2014
actual conversions done in slugification will be specified at a
later time.
o Anchors must never overlap with any of the above. The easiest way
to assure that is to not pick an anchor name that starts with a
single letter followed by a hyphen. If an anchor does overlap
with one of the types of names above, the processor will reject
the document.
o In the values for "figureNumber", "tableNumber", sectionNumber",
and "partNumber", there is never a trailing period.
Appendix C. Relax NG Schema
The following is the RelaxNG schema for the v3 format.
namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0"
rfc =
element rfc {
attribute number { text }?,
[ a:defaultValue = "" ] attribute obsoletes { text }?,
[ a:defaultValue = "" ] attribute updates { text }?,
attribute category { "std" | "bcp" | "info" | "exp" | "historic"
}?,
attribute consensus { "no" | "yes" }?,
attribute seriesNo { text }?,
attribute ipr {
"full2026"
| "noDerivativeWorks2026"
| "none"
| "full3667"
| "noModification3667"
| "noDerivatives3667"
| "full3978"
| "noModification3978"
| "noDerivatives3978"
| "trust200811"
| "noModificationTrust200811"
| "noDerivativesTrust200811"
| "trust200902"
| "noModificationTrust200902"
| "noDerivativesTrust200902"
| "pre5378Trust200902"
}?,
attribute iprExtract { xsd:IDREF }?,
[ a:defaultValue = "IETF" ]
Hoffman Expires April 30, 2015 [Page 86]
Internet-Draft XML2RFCv3 October 2014
attribute submissionType {
"IETF" | "IAB" | "IRTF" | "independent"
}?,
attribute docName { text }?,
[ a:defaultValue = "en" ] attribute xml:lang { text }?,
[ a:defaultValue = "no" ] attribute sortRefs { "yes" | "no" }?,
[ a:defaultValue = "yes" ] attribute symRefs { "yes" | "no" }?,
[ a:defaultValue = "yes" ] attribute tocInclude { "yes" | "no"
}?,
[ a:defaultValue = "3" ] attribute tocDepth { text }?,
link?,
front,
middle,
back?
}
link =
element link {
attribute href { text },
attribute rel { text }?
}
front =
element front {
title,
author+,
date?,
area*,
workgroup*,
keyword*,
abstract?,
note*,
boilerplate?
}
title =
element title {
attribute abbrev { text }?,
attribute ascii { text }?,
text
}
author =
element author {
attribute initials { text }?,
attribute surname { text }?,
attribute fullname { text }?,
attribute role { "editor" }?,
[ a:defaultValue = "en" ] attribute xml:lang { text }?,
attribute ascii { text }?,
organization?,
address?
Hoffman Expires April 30, 2015 [Page 87]
Internet-Draft XML2RFCv3 October 2014
}
organization =
element organization {
attribute abbrev { text }?,
attribute ascii { text }?,
text
}
address =
element address { (email | facsimile | phone | postal | uri)* }
postal =
element postal {
[ a:defaultValue = "en" ] attribute xml:lang { text }?,
((city | code | country | region | street)* | postalLine+)
}
street =
element street {
attribute ascii { text }?,
text
}
city =
element city {
attribute ascii { text }?,
text
}
region =
element region {
attribute ascii { text }?,
text
}
code =
element code {
attribute ascii { text }?,
text
}
country = element country { text }
postalLine =
element postalLine {
attribute ascii { text }?,
text
}
phone = element phone { text }
facsimile = element facsimile { text }
email =
element email {
attribute ascii { text }?,
text
}
uri = element uri { text }
Hoffman Expires April 30, 2015 [Page 88]
Internet-Draft XML2RFCv3 October 2014
date =
element date {
attribute day { text }?,
attribute month { text }?,
attribute year { text }?,
empty
}
area = element area { text }
workgroup = element workgroup { text }
keyword = element keyword { text }
abstract =
element abstract {
attribute sectionNumber { text }?,
t+
}
note =
element note {
attribute title { text }?,
name,
attribute sectionNumber { text }?,
[ a:defaultValue = "no" ] attribute removeInRFC { "yes" | "no"
}?,
t+
}
boilerplate = element boilerplate { section+ }
middle = element middle { section+ }
section =
element section {
attribute anchor { xsd:ID }?,
attribute title { text }?,
[ a:defaultValue = "yes" ] attribute numbered { "yes" | "no" }?,
[ a:defaultValue = "default" ]
attribute toc { "include" | "exclude" | "default" }?,
[ a:defaultValue = "no" ] attribute removeInRFC { "yes" | "no"
}?,
attribute sectionNumber { text }?,
name,
(artwork
| aside
| blockquote
| dl
| figure
| iref
| ol
| sourcecode
| t
| table
| texttable
Hoffman Expires April 30, 2015 [Page 89]
Internet-Draft XML2RFCv3 October 2014
| ul)*,
section*
}
name =
element name {
attribute slugifiedName { text }?,
(text | cref | eref | iref | tt | xref)*
}
t =
element t {
attribute anchor { xsd:ID }?,
attribute hangText { text }?,
attribute partNumber { text }?,
(text
| b
| bcp14
| cref
| em
| eref
| i
| iref
| \list
| ol
| spanx
| strong
| sub
| sup
| tt
| vspace
| xref)*
}
aside =
element aside {
attribute anchor { xsd:ID }?,
attribute partNumber { text }?,
(artwork | figure | iref | sourcecode | t | texttable)*
}
blockquote =
element blockquote {
attribute anchor { xsd:ID }?,
attribute partNumber { text }?,
attribute cite { text }?,
attribute quotedFrom { text }?,
(text
| artwork
| b
| bcp14
| em
Hoffman Expires April 30, 2015 [Page 90]
Internet-Draft XML2RFCv3 October 2014
| figure
| i
| sourcecode
| strong
| sub
| sup
| t
| tt)*
}
\list =
element list {
[ a:defaultValue = "empty" ] attribute style { text }?,
attribute hangIndent { text }?,
attribute counter { text }?,
t+
}
ol =
element ol {
[ a:defaultValue = "1" ] attribute style { text }?,
[ a:defaultValue = "1" ] attribute start { text }?,
attribute group { text }?,
[ a:defaultValue = "normal" ]
attribute spacing { "normal" | "compact" }?,
li+
}
ul =
element ul {
[ a:defaultValue = "normal" ]
attribute spacing { "normal" | "compact" }?,
[ a:defaultValue = "false" ] attribute empty { "false" | "true"
}?,
li+
}
li =
element li {
attribute anchor { xsd:ID }?,
attribute partNumber { text }?,
(t+
| (text
| artwork
| b
| bcp14
| cref
| dl
| em
| eref
| figure
| i
Hoffman Expires April 30, 2015 [Page 91]
Internet-Draft XML2RFCv3 October 2014
| iref
| ol
| sourcecode
| strong
| sub
| sup
| tt
| ul
| xref)+)
}
dl =
element dl {
[ a:defaultValue = "normal" ]
attribute spacing { "normal" | "compact" }?,
[ a:defaultValue = "false" ]
attribute hanging { "false" | "true" }?,
(dt, dd)+
}
dt =
element dt {
attribute partNumber { text }?,
(text
| b
| bcp14
| cref
| em
| eref
| i
| iref
| strong
| sub
| sup
| tt
| xref)*
}
dd =
element dd {
t+
| (text
| artwork
| b
| bcp14
| cref
| dl
| em
| eref
| figure
| i
Hoffman Expires April 30, 2015 [Page 92]
Internet-Draft XML2RFCv3 October 2014
| iref
| ol
| sourcecode
| strong
| sub
| sup
| tt
| ul
| xref)+
}
xref =
element xref {
attribute target { xsd:IDREF },
[ a:defaultValue = "false" ] attribute pageno { "true" | "false"
}?,
[ a:defaultValue = "default" ]
attribute format { "counter" | "title" | "none" | "default" }?,
(attribute section { text },
attribute relative { text }?,
attribute sectionFormat { text }?)?,
text
}
eref =
element eref {
attribute target { text },
text
}
iref =
element iref {
attribute item { text },
[ a:defaultValue = "" ] attribute subitem { text }?,
[ a:defaultValue = "false" ]
attribute primary { "true" | "false" }?,
empty
}
cref =
element cref {
attribute anchor { xsd:ID }?,
attribute source { text }?,
(text | b | em | eref | i | strong | sub | sup | tt | xref)*
}
tt =
element tt {
(text
| b
| bcp14
| cref
| em
Hoffman Expires April 30, 2015 [Page 93]
Internet-Draft XML2RFCv3 October 2014
| eref
| i
| iref
| strong
| sub
| sup
| xref)*
}
b =
element b {
(text
| bcp14
| cref
| em
| eref
| i
| iref
| sub
| sup
| tt
| xref)*
}
strong =
element strong {
(text
| bcp14
| cref
| em
| eref
| i
| iref
| sub
| sup
| tt
| xref)*
}
i =
element i {
(text
| b
| bcp14
| cref
| eref
| iref
| strong
| sub
| sup
| tt
Hoffman Expires April 30, 2015 [Page 94]
Internet-Draft XML2RFCv3 October 2014
| xref)*
}
em =
element em {
(text
| b
| bcp14
| cref
| eref
| iref
| strong
| sub
| sup
| tt
| xref)*
}
sub =
element sub {
(text
| b
| bcp14
| cref
| em
| eref
| i
| iref
| strong
| tt
| xref)*
}
sup =
element sup {
(text
| b
| bcp14
| cref
| em
| eref
| i
| iref
| strong
| tt
| xref)*
}
spanx =
element spanx {
[ a:defaultValue = "preserve" ]
attribute xml:space { "default" | "preserve" }?,
Hoffman Expires April 30, 2015 [Page 95]
Internet-Draft XML2RFCv3 October 2014
[ a:defaultValue = "emph" ] attribute style { text }?,
text
}
vspace =
element vspace {
[ a:defaultValue = "0" ] attribute blankLines { text }?,
empty
}
figure =
element figure {
attribute anchor { xsd:ID }?,
[ a:defaultValue = "" ] attribute title { text }?,
[ a:defaultValue = "false" ]
attribute suppress-title { "true" | "false" }?,
attribute src { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "" ] attribute alt { text }?,
[ a:defaultValue = "" ] attribute width { text }?,
[ a:defaultValue = "" ] attribute height { text }?,
attribute figureNumber { text }?,
name?,
iref*,
preamble?,
(artwork | sourcecode)+,
postamble?
}
table =
element table {
attribute anchor { xsd:ID }?,
attribute tableNumber { text }?,
name?,
iref*,
thead?,
tbody+,
tfoot?
}
preamble =
element preamble {
(text
| b
| bcp14
| cref
| em
| eref
| i
| iref
| spanx
Hoffman Expires April 30, 2015 [Page 96]
Internet-Draft XML2RFCv3 October 2014
| strong
| sub
| sup
| tt
| xref)*
}
artwork =
element artwork {
attribute xml:space { text }?,
[ a:defaultValue = "" ] attribute name { text }?,
[ a:defaultValue = "" ] attribute type { text }?,
attribute src { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "" ] attribute alt { text }?,
[ a:defaultValue = "" ] attribute width { text }?,
[ a:defaultValue = "" ] attribute height { text }?,
[ a:defaultValue = "en" ] attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute partNumber { text }?,
text*
}
sourcecode =
element sourcecode {
[ a:defaultValue = "" ] attribute name { text }?,
[ a:defaultValue = "" ] attribute type { text }?,
attribute anchor { xsd:ID }?,
attribute partNumber { text }?,
text
}
thead = element thead { tr+ }
tbody = element tbody { tr+ }
tfoot = element tfoot { tr+ }
tr =
element tr {
[ a:defaultValue = "0" ] attribute border { text }?,
(td, th)+
}
td =
element td {
[ a:defaultValue = "0" ] attribute border { text }?,
[ a:defaultValue = "0" ] attribute colspan { text }?,
[ a:defaultValue = "0" ] attribute rowspan { text }?,
(t+
| (text
| artwork
| b
| bcp14
Hoffman Expires April 30, 2015 [Page 97]
Internet-Draft XML2RFCv3 October 2014
| cref
| dl
| em
| eref
| figure
| i
| iref
| ol
| sourcecode
| strong
| sub
| sup
| tt
| ul
| xref)+)
}
th =
element th {
[ a:defaultValue = "0" ] attribute border { text }?,
[ a:defaultValue = "0" ] attribute colspan { text }?,
[ a:defaultValue = "0" ] attribute rowspan { text }?,
(t+
| (text
| artwork
| b
| bcp14
| cref
| dl
| em
| eref
| figure
| i
| iref
| ol
| sourcecode
| strong
| sub
| sup
| tt
| ul
| xref)+)
}
postamble =
element postamble {
(text
| b
| bcp14
| cref
Hoffman Expires April 30, 2015 [Page 98]
Internet-Draft XML2RFCv3 October 2014
| em
| eref
| i
| iref
| spanx
| strong
| sub
| sup
| tt
| xref)*
}
texttable =
element texttable {
attribute anchor { xsd:ID }?,
[ a:defaultValue = "" ] attribute title { text }?,
[ a:defaultValue = "false" ]
attribute suppress-title { "true" | "false" }?,
[ a:defaultValue = "center" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "full" ]
attribute style { "all" | "none" | "headers" | "full" }?,
name?,
preamble?,
ttcol+,
c*,
postamble?
}
ttcol =
element ttcol {
attribute width { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
(cref | eref | iref | xref | text)*
}
c =
element c {
(text
| b
| bcp14
| cref
| em
| eref
| i
| iref
| spanx
| strong
| sub
| sup
Hoffman Expires April 30, 2015 [Page 99]
Internet-Draft XML2RFCv3 October 2014
| tt
| xref)*
}
bcp14 = element bcp14 { text }
back = element back { displayreference*, references*, section* }
displayreference =
element displayreference {
attribute from { text },
attribute to { text }
}
references = element references { name, reference+ }
reference =
element reference {
attribute anchor { xsd:ID },
attribute target { text }?,
front,
(annotation | format | refcontent | seriesInfo)*
}
referencegroup =
element referencegroup {
attribute anchor { xsd:ID },
reference+
}
seriesInfo =
element seriesInfo {
attribute name { text },
attribute value { text },
attribute asciiname { text }?,
attribute asciivalue { text }?,
empty
}
format =
element format {
attribute target { text }?,
attribute type { text },
attribute octets { text }?,
empty
}
annotation =
element annotation {
attribute ascii { text }?,
(text
| b
| bcp14
| cref
| em
| eref
| i
Hoffman Expires April 30, 2015 [Page 100]
Internet-Draft XML2RFCv3 October 2014
| iref
| spanx
| strong
| sub
| sup
| tt
| xref)*
}
refcontent =
element refcontent {
attribute ascii { text }?,
(text | b | bcp14 | em | i | strong | sub | sup | tt)*
}
start = rfc
Appendix D. Schema Differences from v2
The following is a non-normative comparison of the v3 format to the
v2 format. A "-" indicates lines removed from the v2 schema, and a
"+" indicates lines added to the v3 schema.
namespace a =
"http://relaxng.org/ns/compatibility/annotations/1.0"
rfc =
element rfc {
attribute number { text }?,
[ a:defaultValue = "" ] attribute obsoletes { text }?,
[ a:defaultValue = "" ] attribute updates { text }?,
attribute category { "std" | "bcp" | "info" | "exp" |
"historic" }?,
attribute consensus { "no" | "yes" }?,
attribute seriesNo { text }?,
attribute ipr {
"full2026"
| "noDerivativeWorks2026"
| "none"
| "full3667"
| "noModification3667"
| "noDerivatives3667"
| "full3978"
| "noModification3978"
| "noDerivatives3978"
| "trust200811"
| "noModificationTrust200811"
| "noDerivativesTrust200811"
Hoffman Expires April 30, 2015 [Page 101]
Internet-Draft XML2RFCv3 October 2014
| "trust200902"
| "noModificationTrust200902"
| "noDerivativesTrust200902"
| "pre5378Trust200902"
}?,
attribute iprExtract { xsd:IDREF }?,
[ a:defaultValue = "IETF" ]
attribute submissionType {
"IETF" | "IAB" | "IRTF" | "independent"
}?,
attribute docName { text }?,
[ a:defaultValue = "en" ] attribute xml:lang { text }?,
+ [ a:defaultValue = "no" ] attribute sortRefs { "yes" | "no"
+ }?,
+ [ a:defaultValue = "yes" ] attribute symRefs { "yes" | "no"
+ }?,
+ [ a:defaultValue = "yes" ] attribute tocInclude { "yes" |
+ "no" }?,
+ [ a:defaultValue = "3" ] attribute tocDepth { text }?,
+ link?,
front,
middle,
back?
}
+ link =
+ element link {
+ attribute href { text },
+ attribute rel { text }?
+ }
front =
element front {
- title, author+, date, area*, workgroup*, keyword*, abstract?,
- note*
+ title,
+ author+,
+ date?,
+ area*,
+ workgroup*,
+ keyword*,
+ abstract?,
+ note*,
+ boilerplate?
}
title =
element title {
attribute abbrev { text }?,
+ attribute ascii { text }?,
text
Hoffman Expires April 30, 2015 [Page 102]
Internet-Draft XML2RFCv3 October 2014
}
author =
element author {
attribute initials { text }?,
attribute surname { text }?,
attribute fullname { text }?,
attribute role { "editor" }?,
+ [ a:defaultValue = "en" ] attribute xml:lang { text }?,
+ attribute ascii { text }?,
organization?,
address?
}
organization =
element organization {
attribute abbrev { text }?,
+ attribute ascii { text }?,
+ text
+ }
+ address =
+ element address { (email | facsimile | phone | postal | uri)* }
+ postal =
+ element postal {
+ [ a:defaultValue = "en" ] attribute xml:lang { text }?,
+ ((city | code | country | region | street)* | postalLine+)
+ }
+ street =
+ element street {
+ attribute ascii { text }?,
+ text
+ }
+ city =
+ element city {
+ attribute ascii { text }?,
+ text
+ }
+ region =
+ element region {
+ attribute ascii { text }?,
+ text
+ }
+ code =
+ element code {
+ attribute ascii { text }?,
text
}
- address = element address { postal?, phone?, facsimile?, email?,
- uri? }
- postal = element postal { street+, (city | region | code |
Hoffman Expires April 30, 2015 [Page 103]
Internet-Draft XML2RFCv3 October 2014
- country)* }
- street = element street { text }
- city = element city { text }
- region = element region { text }
- code = element code { text }
country = element country { text }
+ postalLine =
+ element postalLine {
+ attribute ascii { text }?,
+ text
+ }
phone = element phone { text }
facsimile = element facsimile { text }
- email = element email { text }
+ email =
+ element email {
+ attribute ascii { text }?,
+ text
+ }
uri = element uri { text }
date =
element date {
attribute day { text }?,
attribute month { text }?,
attribute year { text }?,
empty
}
area = element area { text }
workgroup = element workgroup { text }
keyword = element keyword { text }
- abstract = element abstract { t+ }
+ abstract =
+ element abstract {
+ attribute sectionNumber { text }?,
+ t+
+ }
note =
element note {
- attribute title { text },
+ attribute title { text }?,
+ name,
+ attribute sectionNumber { text }?,
+ [ a:defaultValue = "no" ] attribute removeInRFC { "yes" |
+ "no" }?,
t+
}
+ boilerplate = element boilerplate { section+ }
middle = element middle { section+ }
Hoffman Expires April 30, 2015 [Page 104]
Internet-Draft XML2RFCv3 October 2014
section =
element section {
attribute anchor { xsd:ID }?,
- attribute title { text },
+ attribute title { text }?,
+ [ a:defaultValue = "yes" ] attribute numbered { "yes" | "no"
+ }?,
[ a:defaultValue = "default" ]
attribute toc { "include" | "exclude" | "default" }?,
- (t | figure | texttable | iref)*,
+ [ a:defaultValue = "no" ] attribute removeInRFC { "yes" |
+ "no" }?,
+ attribute sectionNumber { text }?,
+ name,
+ (artwork
+ | aside
+ | blockquote
+ | dl
+ | figure
+ | iref
+ | ol
+ | sourcecode
+ | t
+ | table
+ | texttable
+ | ul)*,
section*
}
+ name =
+ element name {
+ attribute slugifiedName { text }?,
+ (text | cref | eref | iref | tt | xref)*
+ }
t =
element t {
attribute anchor { xsd:ID }?,
attribute hangText { text }?,
+ attribute partNumber { text }?,
(text
- | \list
- | figure
- | xref
+ | b
+ | bcp14
+ | cref
+ | em
| eref
+ | i
Hoffman Expires April 30, 2015 [Page 105]
Internet-Draft XML2RFCv3 October 2014
| iref
- | cref
+ | \list
+ | ol
| spanx
- | vspace)*
+ | strong
+ | sub
+ | sup
+ | tt
+ | vspace
+ | xref)*
+ }
+ aside =
+ element aside {
+ attribute anchor { xsd:ID }?,
+ attribute partNumber { text }?,
+ (artwork | figure | iref | sourcecode | t | texttable)*
+ }
+ blockquote =
+ element blockquote {
+ attribute anchor { xsd:ID }?,
+ attribute partNumber { text }?,
+ attribute cite { text }?,
+ attribute quotedFrom { text }?,
+ (text
+ | artwork
+ | b
+ | bcp14
+ | em
+ | figure
+ | i
+ | sourcecode
+ | strong
+ | sub
+ | sup
+ | t
+ | tt)*
}
\list =
element list {
- attribute style { text }?,
+ [ a:defaultValue = "empty" ] attribute style { text }?,
attribute hangIndent { text }?,
attribute counter { text }?,
t+
}
+ ol =
Hoffman Expires April 30, 2015 [Page 106]
Internet-Draft XML2RFCv3 October 2014
+ element ol {
+ [ a:defaultValue = "1" ] attribute style { text }?,
+ [ a:defaultValue = "1" ] attribute start { text }?,
+ attribute group { text }?,
+ [ a:defaultValue = "normal" ]
+ attribute spacing { "normal" | "compact" }?,
+ li+
+ }
+ ul =
+ element ul {
+ [ a:defaultValue = "normal" ]
+ attribute spacing { "normal" | "compact" }?,
+ [ a:defaultValue = "false" ] attribute empty { "false" |
+ "true" }?,
+ li+
+ }
+ li =
+ element li {
+ attribute anchor { xsd:ID }?,
+ attribute partNumber { text }?,
+ (t+
+ | (text
+ | artwork
+ | b
+ | bcp14
+ | cref
+ | dl
+ | em
+ | eref
+ | figure
+ | i
+ | iref
+ | ol
+ | sourcecode
+ | strong
+ | sub
+ | sup
+ | tt
+ | ul
+ | xref)+)
+ }
+ dl =
+ element dl {
+ [ a:defaultValue = "normal" ]
+ attribute spacing { "normal" | "compact" }?,
+ [ a:defaultValue = "false" ]
+ attribute hanging { "false" | "true" }?,
+ (dt, dd)+
Hoffman Expires April 30, 2015 [Page 107]
Internet-Draft XML2RFCv3 October 2014
+ }
+ dt =
+ element dt {
+ attribute partNumber { text }?,
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | strong
+ | sub
+ | sup
+ | tt
+ | xref)*
+ }
+ dd =
+ element dd {
+ t+
+ | (text
+ | artwork
+ | b
+ | bcp14
+ | cref
+ | dl
+ | em
+ | eref
+ | figure
+ | i
+ | iref
+ | ol
+ | sourcecode
+ | strong
+ | sub
+ | sup
+ | tt
+ | ul
+ | xref)+
+ }
xref =
element xref {
attribute target { xsd:IDREF },
[ a:defaultValue = "false" ] attribute pageno { "true" |
"false" }?,
[ a:defaultValue = "default" ]
attribute format { "counter" | "title" | "none" | "default"
Hoffman Expires April 30, 2015 [Page 108]
Internet-Draft XML2RFCv3 October 2014
}?,
+ (attribute section { text },
+ attribute relative { text }?,
+ attribute sectionFormat { text }?)?,
text
}
eref =
element eref {
attribute target { text },
text
}
iref =
element iref {
attribute item { text },
[ a:defaultValue = "" ] attribute subitem { text }?,
[ a:defaultValue = "false" ]
attribute primary { "true" | "false" }?,
empty
}
cref =
element cref {
attribute anchor { xsd:ID }?,
attribute source { text }?,
- text
+ (text | b | em | eref | i | strong | sub | sup | tt | xref)*
+ }
+ tt =
+ element tt {
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | strong
+ | sub
+ | sup
+ | xref)*
+ }
+ b =
+ element b {
+ (text
+ | bcp14
+ | cref
+ | em
+ | eref
Hoffman Expires April 30, 2015 [Page 109]
Internet-Draft XML2RFCv3 October 2014
+ | i
+ | iref
+ | sub
+ | sup
+ | tt
+ | xref)*
+ }
+ strong =
+ element strong {
+ (text
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | sub
+ | sup
+ | tt
+ | xref)*
+ }
+ i =
+ element i {
+ (text
+ | b
+ | bcp14
+ | cref
+ | eref
+ | iref
+ | strong
+ | sub
+ | sup
+ | tt
+ | xref)*
+ }
+ em =
+ element em {
+ (text
+ | b
+ | bcp14
+ | cref
+ | eref
+ | iref
+ | strong
+ | sub
+ | sup
+ | tt
+ | xref)*
Hoffman Expires April 30, 2015 [Page 110]
Internet-Draft XML2RFCv3 October 2014
+ }
+ sub =
+ element sub {
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | strong
+ | tt
+ | xref)*
+ }
+ sup =
+ element sup {
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | strong
+ | tt
+ | xref)*
}
spanx =
element spanx {
[ a:defaultValue = "preserve" ]
attribute xml:space { "default" | "preserve" }?,
[ a:defaultValue = "emph" ] attribute style { text }?,
text
}
vspace =
element vspace {
[ a:defaultValue = "0" ] attribute blankLines { text }?,
empty
}
figure =
element figure {
attribute anchor { xsd:ID }?,
[ a:defaultValue = "" ] attribute title { text }?,
[ a:defaultValue = "false" ]
attribute suppress-title { "true" | "false" }?,
attribute src { text }?,
Hoffman Expires April 30, 2015 [Page 111]
Internet-Draft XML2RFCv3 October 2014
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "" ] attribute alt { text }?,
[ a:defaultValue = "" ] attribute width { text }?,
[ a:defaultValue = "" ] attribute height { text }?,
+ attribute figureNumber { text }?,
+ name?,
iref*,
preamble?,
- artwork,
+ (artwork | sourcecode)+,
postamble?
}
+ table =
+ element table {
+ attribute anchor { xsd:ID }?,
+ attribute tableNumber { text }?,
+ name?,
+ iref*,
+ thead?,
+ tbody+,
+ tfoot?
+ }
preamble =
- element preamble { (text | xref | eref | iref | cref | spanx)* }
+ element preamble {
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | spanx
+ | strong
+ | sub
+ | sup
+ | tt
+ | xref)*
+ }
artwork =
element artwork {
- [ a:defaultValue = "preserve" ]
- attribute xml:space { "default" | "preserve" }?,
+ attribute xml:space { text }?,
[ a:defaultValue = "" ] attribute name { text }?,
[ a:defaultValue = "" ] attribute type { text }?,
Hoffman Expires April 30, 2015 [Page 112]
Internet-Draft XML2RFCv3 October 2014
attribute src { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "" ] attribute alt { text }?,
[ a:defaultValue = "" ] attribute width { text }?,
[ a:defaultValue = "" ] attribute height { text }?,
+ [ a:defaultValue = "en" ] attribute xml:lang { text }?,
+ attribute anchor { xsd:ID }?,
+ attribute partNumber { text }?,
text*
}
+ sourcecode =
+ element sourcecode {
+ [ a:defaultValue = "" ] attribute name { text }?,
+ [ a:defaultValue = "" ] attribute type { text }?,
+ attribute anchor { xsd:ID }?,
+ attribute partNumber { text }?,
+ text
+ }
+ thead = element thead { tr+ }
+ tbody = element tbody { tr+ }
+ tfoot = element tfoot { tr+ }
+ tr =
+ element tr {
+ [ a:defaultValue = "0" ] attribute border { text }?,
+ (td, th)+
+ }
+ td =
+ element td {
+ [ a:defaultValue = "0" ] attribute border { text }?,
+ [ a:defaultValue = "0" ] attribute colspan { text }?,
+ [ a:defaultValue = "0" ] attribute rowspan { text }?,
+ (t+
+ | (text
+ | artwork
+ | b
+ | bcp14
+ | cref
+ | dl
+ | em
+ | eref
+ | figure
+ | i
+ | iref
+ | ol
+ | sourcecode
+ | strong
+ | sub
Hoffman Expires April 30, 2015 [Page 113]
Internet-Draft XML2RFCv3 October 2014
+ | sup
+ | tt
+ | ul
+ | xref)+)
+ }
+ th =
+ element th {
+ [ a:defaultValue = "0" ] attribute border { text }?,
+ [ a:defaultValue = "0" ] attribute colspan { text }?,
+ [ a:defaultValue = "0" ] attribute rowspan { text }?,
+ (t+
+ | (text
+ | artwork
+ | b
+ | bcp14
+ | cref
+ | dl
+ | em
+ | eref
+ | figure
+ | i
+ | iref
+ | ol
+ | sourcecode
+ | strong
+ | sub
+ | sup
+ | tt
+ | ul
+ | xref)+)
+ }
postamble =
- element postamble { (text | xref | eref | iref | cref | spanx)*
+ element postamble {
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | spanx
+ | strong
+ | sub
+ | sup
+ | tt
+ | xref)*
Hoffman Expires April 30, 2015 [Page 114]
Internet-Draft XML2RFCv3 October 2014
}
texttable =
element texttable {
attribute anchor { xsd:ID }?,
[ a:defaultValue = "" ] attribute title { text }?,
[ a:defaultValue = "false" ]
attribute suppress-title { "true" | "false" }?,
[ a:defaultValue = "center" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "full" ]
attribute style { "all" | "none" | "headers" | "full" }?,
+ name?,
preamble?,
ttcol+,
c*,
postamble?
}
ttcol =
element ttcol {
attribute width { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
- text
+ (cref | eref | iref | xref | text)*
}
- c = element c { (text | xref | eref | iref | cref | spanx)* }
- back = element back { references*, section* }
- references =
- element references {
- [ a:defaultValue = "References" ] attribute title { text }?,
- reference+
+ c =
+ element c {
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
+ | eref
+ | i
+ | iref
+ | spanx
+ | strong
+ | sub
+ | sup
+ | tt
+ | xref)*
}
Hoffman Expires April 30, 2015 [Page 115]
Internet-Draft XML2RFCv3 October 2014
+ bcp14 = element bcp14 { text }
+ back = element back { displayreference*, references*, section* }
+ displayreference =
+ element displayreference {
+ attribute from { text },
+ attribute to { text }
+ }
+ references = element references { name, reference+ }
reference =
element reference {
attribute anchor { xsd:ID },
attribute target { text }?,
front,
- seriesInfo*,
- format*,
- annotation*
+ (annotation | format | refcontent | seriesInfo)*
+ }
+ referencegroup =
+ element referencegroup {
+ attribute anchor { xsd:ID },
+ reference+
}
seriesInfo =
element seriesInfo {
attribute name { text },
attribute value { text },
+ attribute asciiname { text }?,
+ attribute asciivalue { text }?,
empty
}
format =
element format {
attribute target { text }?,
attribute type { text },
attribute octets { text }?,
empty
}
annotation =
- element annotation { (text | xref | eref | iref | cref |
- spanx)* }
+ element annotation {
+ attribute ascii { text }?,
+ (text
+ | b
+ | bcp14
+ | cref
+ | em
Hoffman Expires April 30, 2015 [Page 116]
Internet-Draft XML2RFCv3 October 2014
+ | eref
+ | i
+ | iref
+ | spanx
+ | strong
+ | sub
+ | sup
+ | tt
+ | xref)*
+ }
+ refcontent =
+ element refcontent {
+ attribute ascii { text }?,
+ (text | b | bcp14 | em | i | strong | sub | sup | tt)*
+ }
start = rfc
Index
A
abbrev attribute
in organization element 38
in title element 61
abstract element 10
inside front 30
sectionNumber attribute 10
address element 10
inside author 16
align attribute
in artwork element 13
in figure element 29
in texttable element 72
in ttcol element 73
alt attribute
in artwork element 13
in figure element 29
anchor attribute
in artwork element 13
in aside element 15
in blockquote element 19
in cref element 22
in figure element 29
in li element 34
in reference element 41
in referencegroup element 42
in section element 48
in sourcecode element 51
Hoffman Expires April 30, 2015 [Page 117]
Internet-Draft XML2RFCv3 October 2014
in t element 56
in table element 57
in texttable element 72
annotation element 11
ascii attribute 11
inside reference 41
application/rfc+xml Media Type 75
area element 11
inside front 30
artwork element 12
align attribute 13
alt attribute 13
anchor attribute 13
height attribute 13
inside aside 15
inside blockquote 19
inside dd 23
inside figure 28
inside li 33
inside section 47
inside td 58
inside th 60
name attribute 13
partNumber attribute 14
src attribute 14
type attribute 14
width attribute 14
xml:lang attribute 15
xml:space attribute 15
ascii attribute
in annotation element 11
in author element 16
in city element 20
in code element 20
in email element 27
in organization element 38
in postalLine element 40
in refcontent element 41
in region element 43
in street element 53
in title element 61
asciiname attribute
in seriesInfo element 49
asciivalue attribute
in seriesInfo element 50
aside element 15
anchor attribute 15
inside section 47
Hoffman Expires April 30, 2015 [Page 118]
Internet-Draft XML2RFCv3 October 2014
partNumber attribute 15
Attributes
abbrev 38, 61
align 13, 29, 72-73
alt 13, 29
anchor 13, 15, 19, 22, 29, 34, 41-42, 48, 51, 56-57, 72
ascii 11, 16, 20, 27, 38, 40-41, 43, 53, 61
asciiname 49
asciivalue 50
blankLines 74
border 59-60, 62
category 43
cite 19
colspan 59, 61
consensus 44
counter 69
day 22
docName 44
empty 63
figureNumber 29
format 65
from 24
fullname 16
group 37
hangIndent 69
hanging 25
hangText 56
height 13, 29
href 34
initials 16
ipr 44
iprExtract 45
item 32
month 23
name 13, 50-51
number 45
numbered 48
obsoletes 45
octets 69
pageno 66
partNumber 14-15, 20, 26, 34, 51, 56
primary 32
quotedFrom 20
rel 35
relative 66
removeInRFC 36, 48
role 17
rowspan 59, 61
Hoffman Expires April 30, 2015 [Page 119]
Internet-Draft XML2RFCv3 October 2014
section 66
sectionFormat 66
sectionNumber 10, 36, 49
seriesNo 45
slugifiedName 35
sortRefs 46
source 22
spacing 25, 37, 63
src 14, 29
start 37
style 37, 69, 71-72
subitem 32
submissionType 46
suppress-title 29, 72
surname 17
symRefs 46
tableNumber 57
target 28, 42, 67, 69
title 30, 36, 49, 73
to 24
toc 49
tocDepth 46
tocInclude 46
type 14, 51, 69
updates 47
value 50
width 14, 30, 73
xml:lang 15, 17, 39, 47
xml:space 15, 71
year 23
author element 16
ascii attribute 16
fullname attribute 16
initials attribute 16
inside front 30
role attribute 17
surname attribute 17
xml:lang attribute 17
B
b element 17
inside annotation 11
inside blockquote 19
inside c 68
inside cref 21
inside dd 23
inside dt 26
inside em 27
Hoffman Expires April 30, 2015 [Page 120]
Internet-Draft XML2RFCv3 October 2014
inside i 31
inside li 33
inside postamble 70
inside preamble 70
inside refcontent 40
inside sub 54
inside sup 55
inside t 56
inside td 58
inside th 60
inside tt 62
back element 18
inside rfc 43
bcp14 element 18
inside annotation 11
inside b 17
inside blockquote 19
inside c 68
inside dd 23
inside dt 26
inside em 27
inside i 31
inside li 33
inside postamble 70
inside preamble 70
inside refcontent 40
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside td 58
inside th 60
inside tt 62
blankLines attribute
in vspace element 74
blockquote element 19
anchor attribute 19
cite attribute 19
inside section 47
partNumber attribute 20
quotedFrom attribute 20
boilerplate element 20
inside front 30
border attribute
in td element 59
in th element 60
in tr element 62
Hoffman Expires April 30, 2015 [Page 121]
Internet-Draft XML2RFCv3 October 2014
C
c element 67
inside texttable 72
category attribute
in rfc element 43
cite attribute
in blockquote element 19
city element 20
ascii attribute 20
inside postal 39
code element 20
ascii attribute 20
inside postal 39
colspan attribute
in td element 59
in th element 61
consensus attribute
in rfc element 44
counter attribute
in list element 69
country element 21
inside postal 39
cref element 21
anchor attribute 22
inside annotation 11
inside b 17
inside c 68
inside dd 23
inside dt 26
inside em 27
inside i 31
inside li 33
inside name 35
inside postamble 70
inside preamble 70
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside td 58
inside th 60
inside tt 62
inside ttcol 73
source attribute 22
D
date element 22
day attribute 22
Hoffman Expires April 30, 2015 [Page 122]
Internet-Draft XML2RFCv3 October 2014
inside front 30
month attribute 23
year attribute 23
day attribute
in date element 22
dd element 23
inside dl 25
displayreference element 24
from attribute 24
inside back 18
to attribute 24
dl element 24
hanging attribute 25
inside dd 23
inside li 33
inside section 48
inside td 58
inside th 60
spacing attribute 25
docName attribute
in rfc element 44
dt element 25
inside dl 25
partNumber attribute 26
E
Elements
abstract 10, 30
address 10, 16
annotation 11, 41
area 11, 30
artwork 12, 15, 19, 23, 28, 33, 47, 58, 60
aside 15, 47
author 16, 30
b 11, 17, 19, 21, 23, 26-27, 31, 33, 40, 54-56, 58, 60, 62,
68, 70
back 18, 43
bcp14 11, 17-19, 23, 26-27, 31, 33, 40, 53-56, 58, 60, 62, 68,
70
blockquote 19, 47
boilerplate 20, 30
c 67, 72
city 20, 39
code 20, 39
country 21, 39
cref 11, 17, 21, 23, 26-27, 31, 33, 35, 53-56, 58, 60, 62, 68,
70, 73
date 22, 30
Hoffman Expires April 30, 2015 [Page 123]
Internet-Draft XML2RFCv3 October 2014
dd 23, 25
displayreference 18, 24
dl 23-24, 33, 48, 58, 60
dt 25
em 11, 17, 19, 21, 23, 26, 33, 41, 53-56, 58, 60, 62, 68,
70-71
email 10, 27
eref 11, 17, 21, 23, 26-27, 31, 33, 35, 53-56, 58, 60, 62, 68,
70-71, 73
facsimile 10, 68
figure 15, 19, 23, 28, 33, 48, 58, 60
format 41, 68
front 30, 41, 43
i 11, 17, 19, 21, 23, 26, 30, 33, 41, 53-56, 58, 60, 63, 68,
70-71
iref 11, 15, 18, 23, 26-28, 31, 33, 35, 48, 53-58, 60, 63, 68,
70-71, 73
keyword 30, 32
li 32, 37, 63
link 34, 43
list 56, 69
middle 35, 43
name 28, 35-36, 42, 47, 57, 72
note 30, 36
ol 23, 33, 36, 48, 56, 58, 60
organization 16, 38
phone 10, 39
postal 10, 39
postalLine 39-40
postamble 28, 69, 72
preamble 28, 70, 72
refcontent 40-41
reference 41-43
referencegroup 42
references 18, 42
region 39, 43
rfc 43
section 18, 20, 35, 47-48
seriesInfo 41, 49
sourcecode 15, 19, 24, 28, 33, 48, 50, 58, 60
spanx 11, 56, 68, 70-71
street 39, 52
strong 11, 19, 21, 24, 26-27, 31, 33, 41, 53-56, 58, 60, 63,
68, 70-71
sub 11, 18-19, 21, 24, 26-27, 31, 33, 41, 53-54, 56, 58, 60,
63, 68, 70-71
sup 11, 18-19, 21, 24, 26-27, 31, 33, 41, 53-54, 56, 58, 60,
63, 68, 70-71
Hoffman Expires April 30, 2015 [Page 124]
Internet-Draft XML2RFCv3 October 2014
t 10, 15, 19, 23, 33, 36, 48, 55, 58-59, 69
table 48, 57
tbody 57
td 58, 62
texttable 15, 48, 72
tfoot 57, 59
th 59, 62
thead 57, 61
title 30, 61
tr 57, 59, 61
tt 11, 18-19, 21, 24, 26-27, 31, 33, 35, 41, 53-56, 59-60, 62,
68, 70-71
ttcol 72-73
ul 24, 33, 48, 59-60, 63
uri 10, 64
vspace 56, 74
workgroup 30, 64
xref 11, 18, 22, 24, 26-27, 31, 33, 35, 53-56, 59-60, 63-64,
68, 70-71, 73
em element 26
inside annotation 11
inside b 17
inside blockquote 19
inside c 68
inside cref 21
inside dd 23
inside dt 26
inside li 33
inside postamble 70
inside preamble 71
inside refcontent 41
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside td 58
inside th 60
inside tt 62
email element 27
ascii attribute 27
inside address 10
empty attribute
in ul element 63
eref element 27
inside annotation 11
inside b 17
inside c 68
inside cref 21
Hoffman Expires April 30, 2015 [Page 125]
Internet-Draft XML2RFCv3 October 2014
inside dd 23
inside dt 26
inside em 27
inside i 31
inside li 33
inside name 35
inside postamble 70
inside preamble 71
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside td 58
inside th 60
inside tt 62
inside ttcol 73
target attribute 28
F
facsimile element 68
inside address 10
figure element 28
align attribute 29
alt attribute 29
anchor attribute 29
figureNumber attribute 29
height attribute 29
inside aside 15
inside blockquote 19
inside dd 23
inside li 33
inside section 48
inside td 58
inside th 60
src attribute 29
suppress-title attribute 29
title attribute 30
width attribute 30
figureNumber attribute
in figure element 29
format attribute
in xref element 65
format element 68
inside reference 41
octets attribute 69
target attribute 69
type attribute 69
from attribute
Hoffman Expires April 30, 2015 [Page 126]
Internet-Draft XML2RFCv3 October 2014
in displayreference element 24
front element 30
inside reference 41
inside rfc 43
fullname attribute
in author element 16
G
group attribute
in ol element 37
H
hangIndent attribute
in list element 69
hanging attribute
in dl element 25
hangText attribute
in t element 56
height attribute
in artwork element 13
in figure element 29
href attribute
in link element 34
I
i element 30
inside annotation 11
inside b 17
inside blockquote 19
inside c 68
inside cref 21
inside dd 23
inside dt 26
inside li 33
inside postamble 70
inside preamble 71
inside refcontent 41
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside td 58
inside th 60
inside tt 63
initials attribute
in author element 16
ipr attribute
'*2026' 82
Hoffman Expires April 30, 2015 [Page 127]
Internet-Draft XML2RFCv3 October 2014
'*3667' 82
'*3978' 82
'*trust200811' 81
'*trust200902' 80
'noDerivativesTrust200902' 81
'noModificationTrust200902' 80
'pre5378Trust200902' 81
'trust200902' 80
in rfc element 44
iprExtract attribute
in rfc element 45
iref element 31
inside annotation 11
inside aside 15
inside b 18
inside c 68
inside dd 23
inside dt 26
inside em 27
inside figure 28
inside i 31
inside li 33
inside name 35
inside postamble 70
inside preamble 71
inside section 48
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside table 57
inside td 58
inside th 60
inside tt 63
inside ttcol 73
item attribute 32
primary attribute 32
subitem attribute 32
item attribute
in iref element 32
K
keyword element 32
inside front 30
L
li element 32
anchor attribute 34
Hoffman Expires April 30, 2015 [Page 128]
Internet-Draft XML2RFCv3 October 2014
inside ol 37
inside ul 63
partNumber attribute 34
link element 34
href attribute 34
inside rfc 43
rel attribute 35
list element 69
counter attribute 69
hangIndent attribute 69
inside t 56
style attribute 69
M
Media Type
application/rfc+xml 75
middle element 35
inside rfc 43
month attribute
in date element 23
N
name attribute
in artwork element 13
in seriesInfo element 50
in sourcecode element 51
name element 35
inside figure 28
inside note 36
inside references 42
inside section 47
inside table 57
inside texttable 72
slugifiedName attribute 35
note element 36
inside front 30
removeInRFC attribute 36
sectionNumber attribute 36
title attribute 36
number attribute
in rfc element 45
numbered attribute
in section element 48
O
obsoletes attribute
in rfc element 45
octets attribute
Hoffman Expires April 30, 2015 [Page 129]
Internet-Draft XML2RFCv3 October 2014
in format element 69
ol element 36
group attribute 37
inside dd 23
inside li 33
inside section 48
inside t 56
inside td 58
inside th 60
spacing attribute 37
start attribute 37
style attribute 37
organization element 38
abbrev attribute 38
ascii attribute 38
inside author 16
P
pageno attribute
in xref element 66
partNumber attribute
in artwork element 14
in aside element 15
in blockquote element 20
in dt element 26
in li element 34
in sourcecode element 51
in t element 56
phone element 39
inside address 10
postal element 39
inside address 10
xml:lang attribute 39
postalLine element 40
ascii attribute 40
inside postal 39
postamble element 69
inside figure 28
inside texttable 72
preamble element 70
inside figure 28
inside texttable 72
primary attribute
in iref element 32
Q
quotedFrom attribute
in blockquote element 20
Hoffman Expires April 30, 2015 [Page 130]
Internet-Draft XML2RFCv3 October 2014
R
refcontent element 40
ascii attribute 41
inside reference 41
reference element 41
anchor attribute 41
inside referencegroup 42
inside references 43
target attribute 42
referencegroup element 42
anchor attribute 42
references element 42
inside back 18
region element 43
ascii attribute 43
inside postal 39
rel attribute
in link element 35
relative attribute
in xref element 66
removeInRFC attribute
in note element 36
in section element 48
rfc element 43
category attribute 43
consensus attribute 44
docName attribute 44
ipr attribute 44
iprExtract attribute 45
number attribute 45
obsoletes attribute 45
seriesNo attribute 45
sortRefs attribute 46
submissionType attribute 46
symRefs attribute 46
tocDepth attribute 46
tocInclude attribute 46
updates attribute 47
xml:lang attribute 47
role attribute
in author element 17
rowspan attribute
in td element 59
in th element 61
S
section attribute
in xref element 66
Hoffman Expires April 30, 2015 [Page 131]
Internet-Draft XML2RFCv3 October 2014
section element 47
anchor attribute 48
inside back 18
inside boilerplate 20
inside middle 35
inside section 48
numbered attribute 48
removeInRFC attribute 48
sectionNumber attribute 49
title attribute 49
toc attribute 49
sectionFormat attribute
in xref element 66
sectionNumber attribute
in abstract element 10
in note element 36
in section element 49
seriesInfo element 49
asciiname attribute 49
asciivalue attribute 50
inside reference 41
name attribute 50
value attribute 50
seriesNo attribute
in rfc element 45
slugifiedName attribute
in name element 35
sortRefs attribute
in rfc element 46
source attribute
in cref element 22
sourcecode element 50
anchor attribute 51
inside aside 15
inside blockquote 19
inside dd 24
inside figure 28
inside li 33
inside section 48
inside td 58
inside th 60
name attribute 51
partNumber attribute 51
type attribute 51
spacing attribute
in dl element 25
in ol element 37
in ul element 63
Hoffman Expires April 30, 2015 [Page 132]
Internet-Draft XML2RFCv3 October 2014
spanx element 71
inside annotation 11
inside c 68
inside postamble 70
inside preamble 71
inside t 56
style attribute 71
xml:space attribute 71
src attribute
in artwork element 14
in figure element 29
start attribute
in ol element 37
street element 52
ascii attribute 53
inside postal 39
strong element 53
inside annotation 11
inside blockquote 19
inside c 68
inside cref 21
inside dd 24
inside dt 26
inside em 27
inside i 31
inside li 33
inside postamble 70
inside preamble 71
inside refcontent 41
inside sub 54
inside sup 55
inside t 56
inside td 58
inside th 60
inside tt 63
style attribute
in list element 69
in ol element 37
in spanx element 71
in texttable element 72
sub element 54
inside annotation 11
inside b 18
inside blockquote 19
inside c 68
inside cref 21
inside dd 24
inside dt 26
Hoffman Expires April 30, 2015 [Page 133]
Internet-Draft XML2RFCv3 October 2014
inside em 27
inside i 31
inside li 33
inside postamble 70
inside preamble 71
inside refcontent 41
inside strong 53
inside t 56
inside td 58
inside th 60
inside tt 63
subitem attribute
in iref element 32
submissionType attribute
in rfc element 46
sup element 54
inside annotation 11
inside b 18
inside blockquote 19
inside c 68
inside cref 21
inside dd 24
inside dt 26
inside em 27
inside i 31
inside li 33
inside postamble 70
inside preamble 71
inside refcontent 41
inside strong 53
inside t 56
inside td 58
inside th 60
inside tt 63
suppress-title attribute
in figure element 29
in texttable element 72
surname attribute
in author element 17
symRefs attribute
in rfc element 46
T
t element 55
anchor attribute 56
hangText attribute 56
inside abstract 10
inside aside 15
Hoffman Expires April 30, 2015 [Page 134]
Internet-Draft XML2RFCv3 October 2014
inside blockquote 19
inside dd 23
inside li 33
inside list 69
inside note 36
inside section 48
inside td 58
inside th 59
partNumber attribute 56
table element 57
anchor attribute 57
inside section 48
tableNumber attribute 57
tableNumber attribute
in table element 57
target attribute
in eref element 28
in format element 69
in reference element 42
in xref element 67
tbody element 57
inside table 57
td element 58
border attribute 59
colspan attribute 59
inside tr 62
rowspan attribute 59
texttable element 72
align attribute 72
anchor attribute 72
inside aside 15
inside section 48
style attribute 72
suppress-title attribute 72
title attribute 73
tfoot element 59
inside table 57
th element 59
border attribute 60
colspan attribute 61
inside tr 62
rowspan attribute 61
thead element 61
inside table 57
title attribute
in figure element 30
in note element 36
in section element 49
Hoffman Expires April 30, 2015 [Page 135]
Internet-Draft XML2RFCv3 October 2014
in texttable element 73
title element 61
abbrev attribute 61
ascii attribute 61
inside front 30
to attribute
in displayreference element 24
toc attribute
in section element 49
tocDepth attribute
in rfc element 46
tocInclude attribute
in rfc element 46
tr element 61
border attribute 62
inside tbody 57
inside tfoot 59
inside thead 61
tt element 62
inside annotation 11
inside b 18
inside blockquote 19
inside c 68
inside cref 21
inside dd 24
inside dt 26
inside em 27
inside i 31
inside li 33
inside name 35
inside postamble 70
inside preamble 71
inside refcontent 41
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside td 59
inside th 60
ttcol element 73
align attribute 73
inside texttable 72
width attribute 73
type attribute
in artwork element 14
in format element 69
in sourcecode element 51
Hoffman Expires April 30, 2015 [Page 136]
Internet-Draft XML2RFCv3 October 2014
U
ul element 63
empty attribute 63
inside dd 24
inside li 33
inside section 48
inside td 59
inside th 60
spacing attribute 63
updates attribute
in rfc element 47
uri element 64
inside address 10
V
value attribute
in seriesInfo element 50
vspace element 74
blankLines attribute 74
inside t 56
W
width attribute
in artwork element 14
in figure element 30
in ttcol element 73
workgroup element 64
inside front 30
X
xml:lang attribute
in artwork element 15
in author element 17
in postal element 39
in rfc element 47
xml:space attribute
in artwork element 15
in spanx element 71
xref element 64
format attribute 65
inside annotation 11
inside b 18
inside c 68
inside cref 22
inside dd 24
inside dt 26
inside em 27
inside i 31
Hoffman Expires April 30, 2015 [Page 137]
Internet-Draft XML2RFCv3 October 2014
inside li 33
inside name 35
inside postamble 70
inside preamble 71
inside strong 53
inside sub 54
inside sup 55
inside t 56
inside td 59
inside th 60
inside tt 63
inside ttcol 73
pageno attribute 66
relative attribute 66
section attribute 66
sectionFormat attribute 66
target attribute 67
xref formats
counter 65
default 65
none 65
title 66
Y
year attribute
in date element 23
Author's Address
Paul Hoffman
VPN Consortium
EMail: paul.hoffman@vpnc.org
Hoffman Expires April 30, 2015 [Page 138]