| Network Working Group | J. F. Reschke |
| Internet-Draft | greenbytes |
| Obsoletes: 2629 (if approved) | April 08, 2014 |
| Intended status: Standards Track | |
| Expires: October 10, 2014 |
The 'XML2RFC' version 2 Vocabulary
draft-reschke-xml2rfc-07
This document defines the 'XML2RFC' version 2 vocabulary; an XML-based language used for writing RFCs and Internet-Drafts.
Discussion of this draft takes place on the XML2RFC mailing list (xml2rfc@ietf.org), which has its home page at https://www.ietf.org/mailman/listinfo/xml2rfc.
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 October 10, 2014.
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 (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.
This document describes version 2 ('v2') of the 'XML2RFC' vocabulary; an XML-based language ('Extensible Markup Language', [XML]) used for writing RFCs ([RFCSTYLE]) and Internet-Drafts ([IDGUIDE]).
It obsoletes the original version ("v1") [RFC2629], which contained the original language definition, and which was subsequently extended ("v2"). Furthermore, it discusses potential extensions in a future revision ("v3").
Note that the vocabulary contains certain constructs that might not be used when generating the final text; however, they can provide useful data for other uses (such index generation, populating a keyword database, or syntax checks).
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).
The sections below describe all elements and their attributes.
Note that attributes not labeled "mandatory" are optional.
Contains the abstract of the document. The abstract ought to be self-contained and thus should not contain references or unexpanded abbreviations. See Section 4.3 of [RFCSTYLE] for more information.
This element appears as child element of: <front [element.front]> (Section 2.19).
One or more <t [element.t]> elements (Section 2.38)
Provides address information for the author.
This element appears as child element of: <author [element.author]> (Section 2.6).
In this order:
Provides additional prose augmenting a bibliographical reference.
For instance:
<annotation> Latest version available at <eref target='http://www.w3.org/TR/xml'/>. </annotation>
...will generate the text used in the reference for [XML].
This element appears as child element of: <reference [element.reference]> (Section 2.30).
In any order:
Provides information about the IETF area this document applies to (currently not used when generating documents).
The value ought to be either the fullname or the abbreviation of one of the IETF areas as listed on http://www.ietf.org/iesg/area.html: "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 child element of: <front [element.front]> (Section 2.19).
Content model: only text content.
This element allows the inclusion of "artwork" into the document.
<artwork> is the only element in the vocabulary that provides full control of horizontal whitespace and line breaks, and thus is used for a variety of things, such as:
Alternatively, the "src" attribute allows referencing an external graphics file, such as a bitmap or a vector drawing. In this case, the textual content acts as fallback for output formats 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. Note that RFCs occasionally are published with enhanced diagrams; a recent example is [RFC5598].
This element appears as child element of: <figure [element.figure]> (Section 2.17).
Text
Controls whether the artwork appears left (default), centered, or right.
Allowed values:
Alternative text description of the artwork (not just the caption).
The suggested height of the graphics included using the "src" attribute.
This attribute is format-dependent and ought to be avoided.
When generating HTML output, current implementations copy the attribute "as is". For other output formats it is usually ignored.
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).
The URI of a graphics file.
Note that this can be a "data" URI ([RFC2397]) as well, in which case the graphics file essentially is in-lined.
Specifies the type of the artwork.
The value either is a well-known keyword (such as "abnf"), or an Internet Media Type (see [RFC2046]).
How it is used depends on context and application. For instance, a formatter can attempt to syntax-highlight code in certain known languages.
The suggested width of the graphics included using the "src" attribute.
This attribute is format-dependent and ought to be avoided.
When generating HTML output, current implementations copy the attribute "as is". For other output formats it is usually ignored.
Determines whitespace handling.
"preserve" is both the default value and the only meaningful setting anyway (because that's what the <artwork> element is for).
See also Section 2.10 of [XML].
Allowed values:
Provides information about a document author.
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 Section 4.12 of [RFCSTYLE]).
Note that an "author" can also be just an organization (by not specifying any of the name attributes, but adding the <organization [element.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 child element of: <front [element.front]> (Section 2.19).
In this order:
The full name (used in the automatically generated "Author's Address" section).
Author initials (used on the front page and in references).
Initials should be provided as a whitespace separated list of pairs of a letter and a dot.
Specifies the role the author had in creating the document.
Allowed values:
The author's surname.
Contains the "back" part of the document: the references and appendices.
This element appears as child element of: <rfc [element.rfc]> (Section 2.33).
In this order:
Provides the content of a cell in a table.
This element appears as child element of: <texttable [element.texttable]> (Section 2.39).
In any order:
Gives the city name in a postal address.
This element appears as child element of: <postal [element.postal]> (Section 2.27).
Content model: only text content.
Gives the postal region code.
This element appears as child element of: <postal [element.postal]> (Section 2.27).
Content model: only text content.
Gives the country in a postal address.
This element appears as child element of: <postal [element.postal]> (Section 2.27).
Content model: only text content.
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 format and settings of the formatter), or not at all (when generating an RFC).
This element appears as child element of: <annotation [element.annotation]> (Section 2.3), <c [element.c]> (Section 2.8), <postamble [element.postamble]> (Section 2.28), <preamble [element.preamble]> (Section 2.29), and <t [element.t]> (Section 2.38).
Content model: only text content.
Document-wide unique identifier for this comment. The processor will auto-generate an identifier when none is given.
The value needs to be a valid XML "Name" (Section 2.3 of [XML]).
Holds the "source" of a comment, such as the name or the initials of the person who made the comment.
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.
In the first case, it defines the publication date, which, when producing Internet-Drafts, will be used for computing the expiration date (see Section 8 of [IDGUIDE]). When "year", "month" or "day" are left out, the processor will attempt to use the current system date if the attributes that are specified do match the system date.
Note that month names need to match the full (English) month name ("January", "February", "March", "April", "May, "June", "July", "August", "September", "October", "November", or "December") in order for expiration calculations to work (some implementations might support additional formats, though).
In the second case, the date information will be embedded as-is into the reference text. Therefore, also vague dates ("ca. 2000"), date ranges, and so on, are allowed.
This element appears as child element of: <front [element.front]> (Section 2.19).
Content model: this element does not have any contents.
Day of publication.
Month of publication.
Year of publication.
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 child element of: <address [element.address]> (Section 2.2).
Content model: only text content.
Represents an "external" link (as specified in the "target" attribute).
If the element has text content, that content will be used. Otherwise, the value of the target attribute will be inserted in angle brackets ([RFC3986], Appendix C).
This element appears as child element of: <annotation [element.annotation]> (Section 2.3), <c [element.c]> (Section 2.8), <postamble [element.postamble]> (Section 2.28), <preamble [element.preamble]> (Section 2.29), and <t [element.t]> (Section 2.38).
Content model: only text content.
URI of the link target (see Section 3 of [RFC3986]).
Represents the phone number of a fax machine.
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 child element of: <address [element.address]> (Section 2.2).
Content model: only text content.
This element is used to represent a figure, consisting of an optional preamble, the actual figure, an optional postamble, and an optional title.
This element appears as child element of: <section [element.section]> (Section 2.34), and <t [element.t]> (Section 2.38).
In this order:
Used to change the alignment of <preamble [element.preamble]> and <postamble [element.postamble]>.
Note: does not affect title or <artwork [element.artwork]> alignment.
Allowed values:
Duplicates functionality available on <artwork>; avoid it.
Document-wide unique identifier for this figure.
Furthermore, the presence of this attribute causes the figure to be numbered.
The value needs to be a valid XML "Name" (Section 2.3 of [XML]).
Duplicates functionality available on <artwork>; avoid it.
Duplicates functionality available on <artwork>; avoid it.
Figures that have an "anchor" attribute will automatically get an autogenerated title (such as "Figure 1"), even if the "title" attribute is absent. Setting this attribute to "true" will prevent this.
Allowed values:
The title for the figure; this usually appears on a line after the figure.
Duplicates functionality available on <artwork>; avoid it.
Provides a link to an additional format variant for a reference.
Note that these additional links are neither used in published RFCs, nor supported by all tools. If the goal is to provide a single URI for a reference, the "target" attribute on <reference [element.reference]> can be used instead.
This element appears as child element of: <reference [element.reference]> (Section 2.30).
Content model: this element does not have any contents.
Octet length of linked-to document.
URI of document.
The type of the linked-to document, such as "TXT", "HTML", or "PDF".
Represent the "front matter": metadata (such as author information), abstract, and additional notes.
This element appears as child element of: <reference [element.reference]> (Section 2.30), and <rfc [element.rfc]> (Section 2.33).
In this order:
Provides terms for the document's index.
Index entries can be either single items (when just the "item" attribute is given) or nested items (by specifying "subitem" as well).
For instance:
<iref item="Grammar" subitem="item"/>
will produce an index entry for "Grammar, item".
This element appears as child element of: <annotation [element.annotation]> (Section 2.3), <c [element.c]> (Section 2.8), <figure [element.figure]> (Section 2.17), <postamble [element.postamble]> (Section 2.28), <preamble [element.preamble]> (Section 2.29), <section [element.section]> (Section 2.34), and <t [element.t]> (Section 2.38).
Content model: this element does not have any contents.
The item to include.
Setting this to "true" declares the occurrence as "primary", which might cause it to be highlighted in the index.
Allowed values:
The subitem to include.
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 formats.
This element appears as child element of: <front [element.front]> (Section 2.19).
Content model: only text content.
Delineates a text list.
Each list item is represented by a <t [element.t]> element. The vocabulary currently does not directly support list items consisting of multiple paragraphs; if this is needed, <vspace [element.vspace]> (Section 2.43) can be used as workaround.
This element appears as child element of: <t [element.t]> (Section 2.38).
One or more <t [element.t]> elements (Section 2.38)
This attribute holds a token that serves as an identifier for a counter. The intended use is continuation of lists.
Note that this attribute functions only when the style attribute is using the "format..." syntax (Section 2.22.3); otherwise, it is ignored.
For list styles with potentially wide labels, this attribute can override the default indentation level, measured in characters.
Note that it only affects style with variable-width labels ("format..." and "hanging", see below), and it may not affect formats in which the list item text appears below the label.
This attribute is used to control the display of a list.
The value of this attribute is inherited by any nested lists that do not have this attribute set. It may be set to:
And, finally:
Represents the main content of the document.
This element appears as child element of: <rfc [element.rfc]> (Section 2.33).
One or more <section [element.section]> elements (Section 2.34)
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 child element of: <front [element.front]> (Section 2.19).
One or more <t [element.t]> elements (Section 2.38)
The title of the note.
Specifies the affiliation of an author.
This information appears in both the "Author's Address" section and on the front page ([RFCSTYLE], Section 4.1.1). If the value is long, an abbreviated variant can be specified in the "abbrev" attribute.
This element appears as child element of: <author [element.author]> (Section 2.6).
Content model: only text content.
Abbreviated variant.
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 child element of: <address [element.address]> (Section 2.2).
Content model: only text content.
Contains child elements providing postal information.
This element appears as child element of: <address [element.address]> (Section 2.2).
In this order:
Gives text that appears at the bottom of a figure or table.
This element appears as child element of: <figure [element.figure]> (Section 2.17), and <texttable [element.texttable]> (Section 2.39).
In any order:
Gives text that appears at the top of a figure or table.
This element appears as child element of: <figure [element.figure]> (Section 2.17), and <texttable [element.texttable]> (Section 2.39).
In any order:
Represents a bibliographical reference.
This element appears as child element of: <references [element.references]> (Section 2.31).
In this order:
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.
The value needs to be a valid XML "Name" (Section 2.3 of [XML]).
Holds the URI for the reference.
Note that depending on the <seriesInfo [element.seriesInfo]> element, a URI might not be needed, nor desirable, as it can be automatically generated (for instance, for RFCs).
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"; see Section 4.8.6 of [RFCSTYLE]). This vocabulary supports the split with the "title" attribute.
This element appears as child element of: <back [element.back]> (Section 2.7).
One or more <reference [element.reference]> elements (Section 2.30)
Provides the title for the References section (defaulting to "References").
In general, the title should be either "Normative References" or "Informative References".
Provides the region name in a postal address.
This element appears as child element of: <postal [element.postal]> (Section 2.27).
Content model: only text content.
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.
In this order:
Document category (see Appendix A.1).
Allowed values:
Affects the generated boilerplate.
See [RFC5741] for more information.
Allowed values:
For Internet-Drafts, this specifies the draft name (which appears below the title).
Note that the file extension is not part of the draft, so in general it should end with the current draft number ("-", plus two digits).
Furthermore, it is good practice to disambiguate current editor copies from submitted drafts (for instance, by replacing the draft number with the string "latest").
See Section 7 of [IDGUIDE] for further information.
Represents the Intellectual Property status of the document. See Appendix A.2 for details.
Allowed values:
Identifies a single section within the document (by its 'anchor' attribute) for which extraction "as-is" is explicitly allowed (this is only relevant for historic values of the "ipr" attribute).
The number of the RFC to be produced.
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 format, hyperlinks can be generated. Also, the value ought to be reformatted to insert whitespace after each comma if not already present.
When producing a document within document series (such as "STD"): the number within that series.
The document stream.
See Section 2 of [RFC5741] for details.
Allowed values:
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 format, hyperlinks can be generated. Also, the value ought to be reformatted to insert whitespace after each comma if not already present.
The natural language used in the document (defaults to "en").
See Section 2.12 of [XML] for more information.
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.
This element appears as child element of: <back [element.back]> (Section 2.7), <middle [element.middle]> (Section 2.23), and <section [element.section]> (Section 2.34).
In this order:
Document-wide unique identifier for this section.
The value needs to be a valid XML "Name" (Section 2.3 of [XML]).
The title of the section.
Determines whether the section is included in the Table Of Contents.
The processor usually has defaults for whether a Table Of Contents will be produced at all, and sections of which maximal depth will be included (frequently: 3). "include" and "exclude" allow overriding the processor's default behavior for the element they are specified on (they do not affect nested elements).
Allowed values:
Specifies the document series in which this document appears, and also specifies an identifier within that series.
This element appears as child element of: <reference [element.reference]> (Section 2.30).
Content model: this element does not have any contents.
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".
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).
Wraps a piece of text, indicating special formatting styles.
When generating plain text, processors usually emulate font changes using characters such as "*" and "_".
The following styles are defined:
This element appears as child element of: <annotation [element.annotation]> (Section 2.3), <c [element.c]> (Section 2.8), <postamble [element.postamble]> (Section 2.28), <preamble [element.preamble]> (Section 2.29), and <t [element.t]> (Section 2.38).
Content model: only text content.
The style to be used (defaults to "emph").
Determines whitespace handling.
According to the DTD, the default value is "preserve". Tests however show that it doesn't have any effect on processing; thus this attribute will be removed in future versions of the vocabulary.
See also Section 2.10 of [XML].
Allowed values:
Provides a street address.
This element appears as child element of: <postal [element.postal]> (Section 2.27).
Content model: only text content.
Contains a paragraph of text.
This element appears as child element of: <abstract [element.abstract]> (Section 2.1), <list [element.list]> (Section 2.22), <note [element.note]> (Section 2.24), and <section [element.section]> (Section 2.34).
In any order:
Document-wide unique identifier for this paragraph.
The value needs to be a valid XML "Name" (Section 2.3 of [XML]).
Holds the label ("hanging text") for items in lists using the "hanging" style (see Section 2.22.3).
Contains a table, consisting of an optional preamble, a header line, rows, an optional postamble, and an optional title.
The number of columns in the table is determined by the number of <ttcol [element.ttcol]> elements. The number of rows in the table is determined by the number of <c [element.c]> elements divided by the number of columns. There is no requirement that the number of <c [element.c]> elements be evenly divisible by the number of columns.
This element appears as child element of: <section [element.section]> (Section 2.34).
In this order:
Determines the horizontal alignment of the table.
Allowed values:
Document-wide unique identifier for this table.
Furthermore, the presence of this attribute causes the table to be numbered.
The value needs to be a valid XML "Name" (Section 2.3 of [XML]).
Selects which borders should be drawn, where
Allowed values:
Tables that have an "anchor" attribute will automatically get an autogenerated title (such as "Table 1"), even if the "title" attribute is absent. Setting this attribute to "true" will prevent this.
Allowed values:
The title for the table; this usually appears on a line below the table body.
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's long (~40 characters), the "abbrev" attribute is used to specified an abbreviated variant.
This element appears as child element of: <front [element.front]> (Section 2.19).
Content model: only text content.
Specifies an abbreviated variant of the document title.
Contains a column heading in a table.
This element appears as child element of: <texttable [element.texttable]> (Section 2.39).
Content model: only text content.
Determines the horizontal alignment within the table column.
Allowed values:
The desired column width (as integer 0..100 followed by "%").
Contains a web address associated with the author.
The contents should be a valid URI (see Section 3 of [RFC3986]).
This element appears as child element of: <address [element.address]> (Section 2.2).
Content model: only text content.
This element can be used to force the inclusion of a single line break or multiple blank lines.
Note that this is a purely presentational element and thus its use ought to be avoided.
This element appears as child element of: <t [element.t]> (Section 2.38).
Content model: this element does not have any contents.
Number of blank lines to be inserted, where "0" indicates a single line break (defaults to "0").
For paged output formats, no additional blank lines should be generated after a page break.
This element is used to specify the Working Group the document originates from, 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.rfc]> element (Section 2.33.9).
This element appears as child element of: <front [element.front]> (Section 2.19).
Content model: only text content.
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.
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 [element.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 child element of: <annotation [element.annotation]> (Section 2.3), <c [element.c]> (Section 2.8), <postamble [element.postamble]> (Section 2.28), <preamble [element.preamble]> (Section 2.29), and <t [element.t]> (Section 2.38).
Content model: only text content.
This attribute is used to control the format of the generated reference text.
Allowed values:
Unused.
It's unclear what the purpose of this attribute is; processors seem to ignore it and it never was documented.
Allowed values:
Identifies the document component being referenced.
The value needs to match the value of the "anchor" attribute of another element in the document.
Although the current RFC format does not allow non-ASCII Unicode characters ([UNICODE]), some of them can be used to enforce certain behaviors of formatters.
For instance:
non-breaking space (U+00A0)
non-breaking hyphen (U+2011)
word joiner (U+2060)
Note that in order to use these characters by name, they need to be declared either in the Document Type Definition (DTD, [XML], Section 2.9), or in the "internal subset" ([XML], Section 2.8), like that:
<?xml version="1.0"?> <!DOCTYPE rfc [ <!-- declare nbsp and friends --> <!ENTITY nbsp " "> <!ENTITY nbhy "‑"> <!ENTITY wj "⁠"> ]>
This version of the vocabulary does not support an inclusion mechanism on it's own — thus, a document always needs to be self-contained.
That being said, some processors do support file inclusion using processing instructions (Section 2.6 of [XML]).
Furthermore, XML itself allows inclusion of external content using the "internal subset" (Section 2.8 of [XML]). Unfortunately, this requires declaring the external data in the DTD upfront.
For instance:
<?xml version="1.0"?> <!DOCTYPE rfc [ <!-- allow later RFC2616 reference using "&rfc2616;" --> <!-- the data will be fetched from xml.resource.org --> <!ENTITY rfc2616 PUBLIC "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2616.xml"> ]>
...declares the entity "rfc2616", which then can be used in the "references" section:
<references>
&rfc2616;
</references>
Note that this mechanism only works for well-formed XML fragments; thus any plain text that would need to be escaped in XML can't be included as-is.
This format is based on [XML], thus does not have any issues representing arbitrary Unicode [UNICODE] characters in text content.
However, the current canonical RFC format is restricted to US-ASCII [USASCII] characters ([RFC2223], Section 3). Future versions are likely to relax this role, and it is expected that the vocabulary will be extended so that US-ACSII alternatives can be provided when that makes sense (for instance, in contact information).
The "name" attribute on the <artwork [element.artwork]> element (Section 2.5.4) 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.
Furthermore, all security considerations related to XML processing are relevant as well (see Section 7 of [RFC3470]).
IANA maintains the registry of Internet media types [BCP13] at http://www.iana.org/assignments/media-types.
This document serves as the specification for the Internet media type "application/rfc+xml". The following is to be registered with IANA.
Thanks to everybody who reviewed this document and provided feedback and/or specification text, in particular Brian Carpenter, Tony Hansen, Paul Hoffman, Henrik Levkowetz, Alice Russo, Tom Taylor, Jim Schaad, and Nico Williams.
We also thank Marshall T. Rose for both the original design and the reference implementation of the "xml2rfc" formatter.
| [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. Latest version available at |
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 - surprise - "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.
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.
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.
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 |
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.
This produces additional text from Section 6.c.i of the TLP:
This produces the additional text from Section 6.c.ii of the TLP:
This produces the additional text from Section 6.c.iii of the TLP, frequently called the "pre-5378 escape clause":
See Section 4 of http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf for further information about when to use this value.
The attribute values "trust200811", "noModificationTrust200811" and "noDerivativesTrust200811" are similar to their "trust200902" counterparts, except that they use text specified in http://trustee.ietf.org/license-info/archive/IETF-Trust-License-Policy_11-10-08.pdf.
The attribute values "full3978", "noModification3978" and "noDerivatives3978" are similar to their counterparts above, except that they use text specified in RFC 3978 (March 2005).
The attribute values "full3667", "noModification3667" and "noDerivatives3667" are similar to their counterparts above, except that they use text specified in RFC 3667 (February 2004).
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.
The <appendix> element has been removed; to generate an appendix, place a <section [element.section]> inside <back [element.back]>.
Many attributes have lost their "default" value; this is to avoid having document semantics differ based on whether a DTD was specified and evaluated. Processors will handle absent values the way the default value was specified before.
<artwork [element.artwork]>: Has a set of new attributes: "name", "type", "src", "align", "alt", "width", and "height". (Section 2.5)
<author [element.author]>: The <organization [element.organization]> element is now optional. The "role" attribute was added. (Section 2.6)
<country [element.country]>: The requirement to use ISO 3166 codes was removed. (Section 2.11)
<date [element.date]>: All attributes are now optional. (Section 2.13)
<figure [element.figure]>: Has a set of new attributes: "suppress-title", "src", "align", "alt", "width", and "height". (Section 2.17)
<iref [element.iref]>: Has a new "primary" attribute. (Section 2.20)
<list [element.list]>: The "style" attribute isn't restricted to a set of enumerated values anymore. The "hangIndent" and "counter" attributes have been added. (Section 2.22)
<rfc [element.rfc]>: The "ipr" attribute has gained additional values. The attributes "consensus", "iprExtract", "submissionType", and "xml:lang" have been added. (Section 2.33)
<reference [element.reference]>: <annotation [element.annotation]> allows adding prose to a reference. The "anchor" attribute has been made mandatory. (Section 2.30)
<references [element.references]>: Can now appear multiple times, and carry a "title" attribute (so that normative and informative references can be split). (Section 2.31)
<section [element.section]>: The new "toc" attribute controls whether it will appear in the Table Of Contents. <iref [element.iref]> can now appear as direct child element. (Section 2.34)
<t [element.t]>: The "anchor" attribute can now be used as well, however there are restrictions on how they can be referred to. (Section 2.38)
The following elements have been added: <annotation [element.annotation]> (Section 2.3), <c [element.c]> (Section 2.8), <cref [element.cref]> (Section 2.12), <format [element.format]> (Section 2.18), <spanx [element.spanx]> (Section 2.36), <texttable [element.texttable]> (Section 2.39).
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" ]
attribute submissionType {
"IETF" | "IAB" | "IRTF" | "independent"
}?,
attribute docName { text }?,
[ a:defaultValue = "en" ] attribute xml:lang { text }?,
front,
middle,
back?
}
front =
element front {
title, author+, date, area*, workgroup*, keyword*, abstract?,
note*
}
title =
element title {
attribute abbrev { text }?,
text
}
author =
element author {
attribute initials { text }?,
attribute surname { text }?,
attribute fullname { text }?,
attribute role { "editor" }?,
organization?,
address?
}
organization =
element organization {
attribute abbrev { text }?,
text
}
address = element address { postal?, phone?, facsimile?, email?,
uri? }
postal = element postal { street+, (city | region | code | country)*
}
street = element street { text }
city = element city { text }
region = element region { text }
code = element code { text }
country = element country { text }
phone = element phone { text }
facsimile = element facsimile { text }
email = element email { 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+ }
note =
element note {
attribute title { text },
t+
}
middle = element middle { section+ }
section =
element section {
attribute anchor { xsd:ID }?,
attribute title { text },
[ a:defaultValue = "default" ]
attribute toc { "include" | "exclude" | "default" }?,
(t | figure | texttable | iref)*,
section*
}
t =
element t {
attribute anchor { xsd:ID }?,
attribute hangText { text }?,
(text
| \list
| figure
| xref
| eref
| iref
| cref
| spanx
| vspace)*
}
\list =
element list {
attribute style { text }?,
attribute hangIndent { text }?,
attribute counter { text }?,
t+
}
xref =
element xref {
attribute target { xsd:IDREF },
[ a:defaultValue = "false" ] attribute pageno { "true" | "false"
}?,
[ a:defaultValue = "default" ]
attribute format { "counter" | "title" | "none" | "default" }?,
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
}
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 }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "" ] attribute alt { text }?,
[ a:defaultValue = "" ] attribute width { text }?,
[ a:defaultValue = "" ] attribute height { text }?,
iref*,
preamble?,
artwork,
postamble?
}
preamble =
element preamble { (text | xref | eref | iref | cref | spanx)* }
artwork =
element artwork {
[ a:defaultValue = "preserve" ]
attribute xml:space { "default" | "preserve" }?,
[ 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 }?,
text*
}
postamble =
element postamble { (text | xref | eref | iref | cref | spanx)* }
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" }?,
preamble?,
ttcol+,
c*,
postamble?
}
ttcol =
element ttcol {
attribute width { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
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+
}
reference =
element reference {
attribute anchor { xsd:ID },
attribute target { text }?,
front,
seriesInfo*,
format*,
annotation*
}
seriesInfo =
element seriesInfo {
attribute name { text },
attribute value { text },
empty
}
format =
element format {
attribute target { text }?,
attribute type { text },
attribute octets { text }?,
empty
}
annotation =
element annotation { (text | xref | eref | iref | cref | spanx)* }
start = rfc
(This schema was derived from version 1.3.6 of the xml2rfc DTD ('Document Type Definition', [XML], Section 2.8), available from http://svn.tools.ietf.org/svn/tools/xml2rfc/vocabulary/v2/03/xml2rfcv2.dtd).
Discussion of "v3" changes takes place on the rfc-interest mailing list (rfc-interest@rfc-editor.org), which has its home page at http://www.rfc-editor.org/mailman/listinfo/rfc-interest. See also https://www.rfc-editor.org/rse/wiki/doku.php?id=design:xml-tags for a related Wiki page.
If contact information is changed to allow non-ASCII characters: add a place for a ASCII fallback (probably just for the author names).
The content model for <postal [element.postal]> ought to be more strict to allow at most one of <city [element.city]>, <region [element.region]>, <code [element.code]>, and <country [element.country]>.
It should be possible to have multiple <email [element.email]> and <uri [element.uri]> elements (see also http://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/36).
<facsimile [element.facsimile]> looks outdated, while a container for IM (messaging) URIs is missing. Maybe this area needs to be aligned with vCard.
Section 4.11 of [RFCSTYLE] hints at a "Contributors" Section that could supply contact information similar to the one in the auto-generated "Authors' Address" Section. Consider how to capture contributor contact information (probably not using <author [element.author]> to avoid confusion). Furthermore, consider ways to augment the contact information section with prose.
Cleanup the set of overlapping attributes between <figure [element.figure]> and <artwork [element.artwork]>.
For artwork that consists of a sequence of items (such as messages in a protocol example), it would be good if a <figure> element could contain multiple <artwork> elements (to assist code to find good places for page breaks).
Extend <figure [element.figure]> to support different types of artwork (such as by specifying certain type attribute values, see http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#artwork.types), and also avoid having to markup code (such as ABNF) as "artwork".
It would be good if "code components" could be marked as such.
Finally, even in preformatted text use of markup could be useful to support (a) references, or (b) highlighting the important bits (http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#ext-rfc2629.artwork).
Extend <xref [element.xref]> so that subsection/anchors can be specified (see http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#ext-rfc2629.xref).
Remove the "pageno" attribute which seems to be both undocumented and non-functional.
Allow multiple paragraphs in list items; eliminating the need to use <vspace [element.vspace]> — this could be achieved by adding a list item container element ("<lt>", see http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#ext.element.lt and http://www.ietf.org/mail-archive/web/xml2rfc/current/msg02010.html).
Add support for a "dictionary" style; eliminating the need to combine "hanging" with <vspace> to force new lines (see thread around http://www.rfc-editor.org/pipermail/rfc-interest/2013-December/005876.html).
Allow overriding the "anchor" attribute of an included <reference> element.
Add a way to add prose to a reference that avoids abuse of <seriesInfo>.
Allow <reference [element.reference]>s that identify a document set such as a BCP.
Deprecate or remove the <format [element.format]> element; right now it's not used for the generation of the plain text document anyway.
The "anchor" attribute is optional because it is not needed when using numeric references (symrefs processing instruction), and the reference actually is not in use. This is an edge case that doesn't need special support in the vocabulary and thus should be removed.
When this vocabulary becomes the canonical RFC format, it will need to be able to capture all generated information, such as section/figure/table numbers, plus any auto-generated boilerplate (copyright statements etc.).
Extend the concept of language tagging to at least examples and contact information to address potential japanese/chinese font confusion.
Provide a way to indicate the intended level on the standards track.
Include feedback information in a way so that generated documents can provide usable feedback links (see http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#ext.element.feedback).
As discussed in Section 4, file inclusion currently uses out-of-the-box XML mechanisms or processor-specific directives.
We need to decide whether the vocabulary should have its own inclusion mechanism, or whether it would be better to use a generic solution such as [XINCLUDE] instead.
Make the <date [element.date]> element optional; all of its content is optional already.
<spanx [element.spanx]> has both a weird whitespace model ("preserve") and problematic styling. Consider to deprecate it in favor of elements such as <b>, <i>, and <tt>.
Indented paragraphs currently can be created by abusing the <list [element.list]>. It would be good to have a special element for this purpose.
Provide a special element for inserting block quotes (http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#ext.element.blockquote).
The content model for <cref [element.cref]> should be extended to allow more flow elements, such as <xref [element.xref]> and <eref [element.eref]>.
Section titles should really be elements, not attributes (this would allow them to contain markup).
Text tables are currently very constrained. For instance, it would be good if alignment of headers and table cells could be de-coupled (http://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/69).
Counters are currently restricted to lists, figures, and tables. Maybe there should be a generic mechanism that is not directly tied to other elements (http://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/68).