| title | description | published | date | tags | editor | dateCreated |
|---|---|---|---|---|---|---|
RFCXML vocabulary reference |
true |
2024-11-19 21:39:13 UTC |
markdown |
2021-11-02 22:58:38 UTC |
The current version of the RFCXML vocabulary is v3 and this page is currently the authoritative documentation for v3, superseding RFC 7991 as multiple changes have been made since the publication of RFC 7991.
All documents written in RFCXML begin with the root element <rfc> and follow the schema rules for the contents of each element. The available elements are listed below along with their attributes and a snippet of the RNC schema that defines that element.
NOTE: The schema snippets below include reference to elements and attributes that have been deprecated and should not be used. Details of this deprecated syntax can be found in Upgrading from v2. {.is-info}
Contains the Abstract of the document. See RFC7322 for more information on restrictions for the Abstract.
Used in: <front> Allowed content: (<dl>, <ol>, <t>, <ul>)+
Document-wide unique identifier for this element.
abstract =
element abstract {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
(dl | ol | t | ul)+
}
Provides address information for the author.
Used in: <author>, <contact> Allowed content: <postal>?, <phone>?, <email>*, <uri>?
address =
element address {
attribute xml:base { text }?,
attribute xml:lang { text }?,
postal?,
phone?,
facsimile?,
email*,
uri?
}
Provides additional prose augmenting a bibliographic reference. This text is intended to be shown after the rest of the generated reference text.
Used in: <reference> Allowed content: ( text | <bcp14> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <u> | <xref> )*
annotation =
element annotation {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(text
| bcp14
| cref
| em
| eref
| iref
| relref
| spanx
| strong
| sub
| sup
| tt
| u
| xref)*
}
Provides information about the IETF area to which this document relates (currently not used when generating documents).
The value ought to be either the full name or the abbreviation of one of the listed IETF areas.
Used in: <front> Allowed content: text
area =
element area {
attribute xml:base { text }?,
attribute xml:lang { text }?,
text
}
This element allows for the support of multiple artwork formats, in order to provide suitable artwork for different output formats. See diagrams for more details on diagrams and SVG.
When multiple <artwork> instances are provided within one <artset> element, the renderer will try to pick the <artwork> instance which is most appropriate for its current output format from the given alternatives.
If more than one <artwork> element with the same type is found within an <artset> element, the renderer could select the first one, or possibly choose between the alternative instances based on the output format and some quality of the alternatives that make one more suitable than the others for that particular format, such as size, aspect ratio, etc.
Used in: <aside>, <blockquote>, <dd>, <figure>, <li>, <section>, <td>, <th> Allowed content: <artwork>+
Document-wide unique identifier for this element.
artset =
element artset {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
artwork+
}
This element allows the inclusion of artwork in the document. <artwork> provides full control of horizontal whitespace and line breaks; thus, it is used for a variety of things, such as diagrams ("line art") and protocol unit diagrams. See diagrams for more details on diagrams and SVG.
Tab characters (U+0009) inside of this element are prohibited.
Alternatively, the src attribute allows referencing an external graphics file, such as a vector drawing in SVG or a bitmap graphic file, using a URI. In this case, the textual content acts as a fallback for output representations that do not support graphics; thus, it ought to contain either (1) a "line art" variant of the graphics or (2) prose that describes the included image in sufficient detail.
In order to include alternative artwork expressions for different output formats, you should provide multiple <artwork> elements enclosed within an <artset>. The text renderer will prefer instances with type of "ascii-art", while the HTML and PDF renderers will prefer instances with type of "svg".
The <artwork> element should not be used for source code and formal languages, the <sourcecode> element should be used instead.
There are at least five ways to include SVG in artwork in Internet- Drafts:
- Inline, by including all of the SVG in the content of the element, such as:
<artwork type="svg"><svg xmlns="http://www.w3.org/2000/ svg...">- Inline, but using XInclude, such as:
<artwork type="svg"><xi:include href=...>- As a data: URI, such as:
<artwork type="svg" src="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww...">- As a URI to an external entity, such as:
<artwork type="svg" src="http://www.example.com/...">- As a local file, such as:
<artwork type="svg" src="diagram12.svg">The above methods for inclusion of SVG art can also be used for including text artwork, but using a data: URI is probably confusing for text artwork.
Formatters that do pagination should attempt to keep artwork on a single page. This is to prevent artwork that is split across pages from looking like two separate pieces of artwork.
Used in: <artset>, <aside>, <blockquote>, <dd>, <figure>, <li>, <section>, <td>, <th> Allowed content: ( <text>* | <svg> )
Controls whether the artwork appears left justified, centered, or right justified.
Possible values: "left", "center", "right" Default value: "left"
Alternative text description of the artwork (which is more than just a summary or caption). When the art comes from the src attribute and the format of that artwork supports alternate text, the alternative text comes from the text of the artwork itself, not from this attribute. The contents of this attribute are important to readers who are visually impaired, as well as those reading on devices that cannot show the artwork well, or at all.
Document-wide unique identifier for this element.
TBD
A filename suitable for the contents (such as for extraction to a local file). This attribute can be helpful for other kinds of tools (such as automated syntax checkers, which work by extracting the artwork). Note that the name attribute does not need to be unique for <artwork> elements in a document. If multiple <artwork> elements have the same name attribute, a processing tool might assume that the elements are all fragments of a single file, and the tool can collect those fragments for later processing.
The URI reference of a graphics file (RFC3986), or the name of a file on the local disk. This can be a "data" URI RFC2397 that contains the contents of the graphics file. Note that the inclusion of art with the src attribute depends on the capabilities of the processing tool reading the XML document. Tools need to be able to handle the file: URI, and they should be able to handle http: and https: URIs as well. The prep tool will be able to handle reading the src attribute.
If no URI scheme is given in the attribute, the attribute is considered to be a local filename relative to the current directory. Processing tools must be careful to not accept dangerous values for the filename, particularly those that contain absolute references outside the current directory. Document creators should think hard before using relative URIs due to possible later problems if files move around on the disk. Also, documents should most likely use explicit URI schemes wherever possible.
In some cases, the prep tool may remove the src attribute after processing its value. See RFC7998 for a description of this.
Specifies the format of the artwork. The value of this attribute is free text with certain values designated as preferred.
The preferred values for type are: "ascii-art", "binary-art", "svg". See Diagrams for more information on these types and how they are rendered into different output formats.
Values that don't describe the format, such as "call-flow" or "hex-dump" were mentioned in RFC7991, but are not supported; they are instead candidates for use with another future attribute to describe the artwork content.
TBD
artwork =
element artwork {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
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 }?,
attribute originalSrc { text }?,
(text* | svg)
}
This element is a container for content that is semantically less important or tangential to the content that surrounds it.
Used in: <dd>, <section> Allowed content: ( <artset> | <artwork> | <blockquote> | <dl> | <figure> | <iref> | <ol> | <t> | <table> | <ul> )*
Document-wide unique identifier for this element.
aside =
element aside {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
(artset
| artwork
| blockquote
| dl
| figure
| iref
| ol
| t
| table
| ul)*
}
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 solely an organization by adding the <organization> child element and not specifying any of the name attributes.
Furthermore, the role attribute can be used to mark an author as "editor". This is reflected both on the front page and in the "Author's Address" section, as well as in bibliographic references.
Used in: <front>, <section> Allowed content: <organization>?, <address>?
Document-wide unique identifier for this element.
The Latin script equivalent of the author's full name.
The Latin script equivalent of the author's initials, to be used in conjunction with the separately specified asciiSurname.
The Latin script equivalent of the author's surname, to be used in conjunction with the separately specified asciiInitials.
The full name (used in the automatically generated "Author's Address" section). Although this attribute is optional, if one or more of the asciiFullname, asciiInitials, or asciiSurname attributes does not have values, the fullname attribute is required.
An abbreviated variant of the given name(s), to be used in conjunction with the separately specified surname. It usually appears on the front page, in footers, and in references.
Some processors will post-process the value, for instance when it only contains a single letter (in which case they might add a trailing dot). Relying on this kind of post-processing can lead to results varying across formatters and thus ought to be avoided.
Specifies the role the author had in creating the document.
The author's surname, to be used in conjunction with the separately specified initials. It usually appears on the front page, in footers, and in references.
author =
element author {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute initials { text }?,
attribute asciiInitials { text }?,
attribute surname { text }?,
attribute asciiSurname { text }?,
attribute fullname { text }?,
attribute role { "editor" }?,
attribute asciiFullname { text }?,
organization?,
address?
}
Contains the Back part of the document: the references and appendices. In <back>, <section> elements indicate appendices.
Used in: <rfc> Allowed content: <displayreference>*, <references>*, <section>*
back =
element back {
attribute xml:base { text }?,
attribute xml:lang { text }?,
displayreference*,
references*,
section*
}
Marks text that are phrases defined in BCP14 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 but it makes the usage much clearer.
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 is not correct to say <bcp14>The packet MUST be dropped.</bcp14>.
Used in: <annotation>, <blockquote>, <dd>, <dt>, <em>, <li>, <name>, <refcontent>, <strong>, <sub>, <sup>, <t>, <td>, <th>, <tt>. Allowed content: text
bcp14 =
element bcp14 {
attribute xml:base { text }?,
attribute xml:lang { text }?,
text
}
Specifies that a block of text is a quotation.
Used in: <aside>, <li>, <section> Allowed content: ( ( <artset> | <artwork> | <dl> | <figure> | <ol> | <sourcecode> | <t> | <ul> )+ | ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <u> | <xref> )+ )
Document-wide unique identifier for this element.
The source of the citation. This must be a URI. If the quotedFrom attribute is given, this URI will be used by processing tools as the link for the text of that attribute.
Name of person or document the text in this element is quoted from. A formatter should render this as visible text at the end of the quotation.
blockquote =
element blockquote {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
attribute cite { text }?,
attribute quotedFrom { text }?,
((artset | artwork | dl | figure | ol | sourcecode | t | ul)+
| (text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| u
| xref)+)
}
Holds the boilerplate text for the document. This element is filled in by the prep tool.
This element contains <section> elements. Every <section> element inside this element must have the numbered attribute set to "false".
Used in: <front> Allowed content: <section>+
boilerplate =
element boilerplate {
attribute xml:base { text }?,
attribute xml:lang { text }?,
section+
}
Inserts a forced break. Use sparingly. In most situations, it's better to insert U+200B, ZERO WIDTH SPACE, in order to encourage line breaking at a point where it would otherwise not occur.
Used in: <blockquote>, <cref>, <dd>, <dt>, <em>, <li>, <name>, <strong>, <t>, <td>, <th>, <title>, <tt> Allowed content: empty
br =
element br {
attribute xml:base { text }?,
attribute xml:lang { text }?,
empty
}
Gives the city name in a postal address.
Used in: <postal> Allowed content: text
The ASCII equivalent of the <city> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
city =
element city {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Where postal addresses use city subdivisions, these are mapped to the <cityarea> element. Korean addresses would use this for a city district, for instance. Countries known to use this element are Ascension Island, China, Iran, South Korea, and Thailand.
Used in: <postal> Allowed content: text
The ASCII equivalent of the <cityarea> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
cityarea =
element cityarea {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Gives the postal region code.
Used in: <postal>. Allowed content: text
The ASCII equivalent of the <code> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
code =
element code {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Provides information about contributors. This element can be used inline within a <t>, and will be rendered with name only, similarly to how <author> is rendered in a <reference>, or it can be used as a direct child of <section>, where it will be rendered the same way as an author address block within the Authors' Addresses section.
Note that a <contact> can also be just an organization by adding the <organization> child element and not providing any of the attributes that specify an individual's name.
Used in: <section>, <t> Allowed content: <organization>?, <address>?
Document-wide unique identifier for this element.
The Latin script equivalent of the contact's full name.
The Latin script equivalent of the contact's initials, to be used in conjunction with the separately specified asciiSurname.
The Latin script equivalent of the contact's surname, to be used in conjunction with the separately specified asciiInitials.
The full name. Although this attribute is optional, if one or more of the asciiFullname, asciiInitials, or asciiSurname attributes does not have values, the fullname attribute is required.
An abbreviated variant of the given name(s), to be used in conjunction with the separately specified surname.
The contact's surname, to be used in conjunction with the separately specified initials.
contact =
element contact {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute initials { text }?,
attribute asciiInitials { text }?,
attribute surname { text }?,
attribute asciiSurname { text }?,
attribute fullname { text }?,
attribute asciiFullname { text }?,
organization?,
address?
}
Specifies the country name in a postal address. All common and official country names should be recognized; in addition two- and three-letter country codes according to ISO 3166 are recognized.
xml2rfc has a help option which will list all names and country codes it recognizes as valid country names: xml2rfc --country-help .
Used in: <postal>. Allowed content: text
The ASCII equivalent of the <country> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
country =
element country {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Represents a comment.
Comments can be used in a document while it is work in progress. They might appear either inline and visually highlighted, at the end of the document, or not at all, depending on the formatting tool.
Used in: <annotation>, <blockquote>, <dd>, <dt>, <em>, <li>, <name>, <strong>, <sub>, <sup>, <t>, <td>, <th>, <tt> Allowed content: ( text | <br> | <em> | <eref> | <strong> | <sub> | <sup> | <tt> | <xref> )*
Document-wide unique identifier for this element.
Suggests whether or not the comment should be displayed by formatting tools. This might be set to "false" if you want to keep a comment in a document after the contents of the comment have already been dealt with.
Possible values: "true", "false" Default value: "true"
Holds the source of a comment, such as the name or the initials of the person who made the comment.
cref =
element cref {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute source { text }?,
[ a:defaultValue = "true" ]
attribute display { "true" | "false" }?,
(text
| br
| em
| eref
| relref
| strong
| sub
| sup
| tt
| xref)*
}
Provides information about the publication date. This element is used for two cases: the boilerplate of the document being produced, and inside bibliographic references that use the <front> element.
Bibliographic references:
- In order to be able to specify fuzzy dates, such as "2002-2003", "Second quarter 2010", etc., the date element is now permitted to have text content in addition to the year, month, and day attributes. If there is only text content, it will be rendered as is. If there is both text content and date components, both will be rendered, with the expanded date components in parentheses.
Boilerplate for Internet-Drafts and RFCs:
- This element defines the date of publication for the current document (Internet-Draft or RFC). When producing Internet-Drafts, the prep tool uses this date to compute the expiration date (see the Guidelines for I-D Authors for details). When one or more of year, month, or day attributes are left out, the prep tool will attempt to use the current system date if the attributes that are present are consistent with that date.
In dates in <rfc> elements, the month must be a number or a month in English. The prep tool will silently change text month names to numbers. Similarly, the year must be a four-digit number.
When the prep tool is used to create Internet-Drafts, it will warn if the draft has a <date> element in the boilerplate for itself that is more than 3 days away from today. To avoid this problem, authors might simply not include a <date> element in the boilerplate.
Used in: <front> Allowed content: text
The day of publication.
The month of publication.
The year of publication.
date =
element date {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute day { text }?,
attribute month { text }?,
attribute year { text }?,
text
}
The definition part of an entry in a definition list.
Used in: <dl>. Allowed content: ( ( <artset> | <artwork> | <aside> | <dl> | <figure> | <ol> | <sourcecode> | <t> | <table> | <ul> )+ | ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <u> | <xref> )+ )
Document-wide unique identifier for this element.
dd =
element dd {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
(( artset
| artwork
| aside
| dl
| figure
| ol
| sourcecode
| t
| table
| ul)+
| (text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| u
| xref)+)
}
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 mnemonic anchor names for automatically included references. The mapping in this element only applies to <xref> elements whose format is "default". 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 target="RFC6949" to="RFC-dev"/>If a reference section is sorted, this element changes the sort order.
Used in: <back>.
Required.
The name of an anchor in a <reference> or <referencegroup> element.
Required.
The 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, or A-Z. The other characters in the string must be 0-9, a-z, A-Z, "-", ".", or "_".
displayreference =
element displayreference {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute target { xsd:IDREF },
attribute to { text }
}
A definition list. Each entry has a pair of elements: a term (<dt>) and a definition (<dd>). (This is slightly different and simpler than the model used in HTML, which allows for multiple terms for a single definition.)
Used in: <abstract>, <aside>, <blockquote>, <dd>, <li>, <note>, <section>, <td>, <th>. Allowed content: ( <dt>, <dd> )+
Document-wide unique identifier for this element.
Indicates the indentation to be used for the rendering of the second and following lines of the item (the first line starts with the term, and is not indented). The indentation amount is interpreted as characters when rendering plain-text documents, and en-space units when rendering in formats that have richer typographic support such as HTML or PDF. One en-space is assumed to be the length of 0.5 em-space in CSS units.
Default value: "3"
The newline attribute defines whether or not the term appears on the same line as the definition. Setting newline to "false" indicates that the term is to the left of the definition, while setting newline to "true" indicates that the term will be on a separate line.
Possible values: "true", "false" Default value: "false"
Defines whether or not there is a blank line between entries. Setting spacing to "normal" indicates a single blank line, while setting spacing to "compact" indicates no blank line between entries.
Possible values: "normal", "compact" Default value: "normal"
dl =
element dl {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
[ a:defaultValue = "normal" ]
attribute spacing { "normal" | "compact" }?,
[ a:defaultValue = "false" ]
attribute newline { "true" | "false" }?,
[ a:defaultValue = "3" ]
attribute indent { text }?,
attribute pn { xsd:ID }?,
(dt, dd)+
}
The term being defined in a definition list.
Used in: <dl>. Allowed content: ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <xref> )*
Document-wide unique identifier for this element.
dt =
element dt {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
(text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| xref)*
}
Indicates text that is semantically emphasized. In HTML and PDF rendering, text enclosed within this element will be displayed as italic after processing; in text rendering it will be preceded and followed by an underline character. This element can be combined with other character formatting elements, and the formatting will be additive.
Used in: <annotation>, <blockquote>, <cref>, <dd>, <dt>, <li>, <name>, <refcontent>, <strong>, <sub>, <sup>, <t>, <td>, <th>, <tt>,<xref>. Allowed content: ( text | bcp14 | br | cref | eref | iref | strong | sub | sup | tt | xref )*
em =
element em {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(text
| bcp14
| br
| cref
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| xref)*
}
Provides an email address.
The value is expected to be the addr-spec defined in Section 2 of RFC6068.
Multiple email addresses are permitted.
Used in: <address>.
Allowed content: text
The ASCII equivalent of the author's email address. This is only used if the email address has any internationalized components.
email =
element email {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Represents an external link as specified in the target attribute. This is useful for embedding URIs in the body of a document.
If the <eref> element has non-empty text content, the content is used as the displayed text that is linked. Otherwise, the value of the target attribute is used as the displayed text.
Used in: <annotation>, <blockquote>, <cref>, <dd>, <dt>, <em>, <li>, <name>, <strong>, <sub>, <sup>, <t>, <td>, <th>, <tt>, . Allowed content: text
Determines the type of brackets that an <eref> will be rendered with. "angle" will render with angle brackets, and "none" will render with no brackets in HTML and PDF, and with parentheses by the text renderer.
Possible values: "none", "angle" Default value: "none"
This attribute must be specified and must be the URI of the link target (RFC3986). This must begin with a scheme name (such as "https://") and thus not be relative to the URL of the current document.
eref =
element eref {
attribute xml:base { text }?,
attribute xml:lang { text }?,
[ a:defaultValue = "none" ]
attribute brackets { "none" | "angle" }?,
attribute target { text },
text
}
Extra address information. This element can be used for address parts more specific than a street, for instance apartment numbers, suite numbers, building parts, etc.
Used in: <postal>.
Allowed content: text
The ASCII equivalent of the <extaddr> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
extaddr =
element extaddr {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Contains a figure with a caption with the figure number. If the element contains a <name> element, the caption will also show that name.
Used in: <aside>, <blockquote>, <dd>, <li>, <section>, <td>, and <th>.
Allowed content: <name>?, <iref>*, ( <artset> | <artwork> | <sourcecode> )+
Possible values: "left", "center", "right" Default value: "left"
TBD
Document-wide unique identifier for this element.
TBD
TBD
Possible values: "true", "false" Default value: "false"
Deprecated. Use the <name> element instead.
TBD
figure =
element figure {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
[ a:defaultValue = "" ] attribute title { text }?,
[ a:defaultValue = "false" ]
attribute suppress-title { "true" | "false" }?,
attribute src { text }?,
attribute originalSrc { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
[ a:defaultValue = "" ] attribute alt { text }?,
[ a:defaultValue = "" ] attribute width { text }?,
[ a:defaultValue = "" ] attribute height { text }?,
name?,
iref*,
preamble?,
(artset | artwork | sourcecode)+,
postamble?
}
Represents the Front part of the document including the Author Information, the Abstract, and additional notes.
A <front> element may have more than one <seriesInfo> element. Each should contain a name attribute with the series name and a value attribute with the series number; other uses of <front><seriesInfo> described in RFC7991 are deprecated.
Used in: <reference> and <rfc>. Allowed content: <title>, <seriesInfo>*, <author>+, <date>?, <area>*, <workgroup>*, <keyword>*, <abstract>?, <note>*, <boilerplate>?, <toc>?
front =
element front {
attribute xml:base { text }?,
attribute xml:lang { text }?,
title,
seriesInfo*,
author+,
date?,
area*,
workgroup*,
keyword*,
abstract?,
note*,
boilerplate?,
toc?
}
Provides terms for the document's index.
Index entries can be either 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 occurred. An exception is the occurrence 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 ranges.
When the prep tool is creating index content, it collects the items in a case-sensitive fashion for both the item and subitem level.
Used in: <annotation>, <aside>, <blockquote>, <dd>, <dt>, <em>, <figure>, <li>, <name>, <section>, <strong>, <sub>, <sup>, <t>, <table>, <td>, <th>, <tt>, . Allowed content: empty
This attribute must be specified and must be the item to include.
Setting this to "true" declares the occurrence as primary, which might cause it to be highlighted in the index. There is no restriction on the number of occurrences that can be primary.
Possible values: "true", "false" Default value: "false"
The subitem to include.
iref =
element iref {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute item { text },
[ a:defaultValue = "" ] attribute subitem { text }?,
[ a:defaultValue = "false" ]
attribute primary { "true" | "false" }?,
attribute pn { xsd:ID }?,
empty
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. They are not reflected in the HTML, PDF, or text rendering of the document.
Used in: <front>. Allowed content: text
keyword =
element keyword {
attribute xml:base { text }?,
attribute xml:lang { text }?,
text
}
A list item, used in <ol> and <ul>.
Used in: <ol> and <ul>. Allowed content: ( ( <artset> | <artwork> | <blockquote> | <dl> | <figure> | <ol> | <sourcecode> | <t> | <table> | <ul> )+ | ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <u> | <xref> )+ )
Document-wide unique identifier for this element.
li =
element li {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute derivedCounter { text }?,
attribute pn { xsd:ID }?,
(( artset
| artwork
| blockquote
| dl
| figure
| ol
| sourcecode
| t
| table
| ul)+
| (text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| u
| xref)+)
}
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:
- The current International Standard Serial Number (ISSN) for the RFC Series. The value for the rel attribute is "item". The link should use the form "urn:issn:".
- The Digital Object Identifier (DOI) for this document. The value for the rel attribute is "describedBy". The link should use the form specified in RFC7669; this is expected to change in the future.
- The Internet-Draft that was submitted to the RFC Editor to become the published RFC. The value for the rel attribute is "prev". (RFC7998 specified "convertedFrom", but that value is not one of the recognised values for the identicaly named rel attribute of the identically named link element in HTML. The "prev" value has the desired semantics.) The link should be to an IETF-controlled web site that retains copies of Internet-Drafts.
- 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.
In RFC production mode, the prep tool needs to check the values for <link> before an RFC is published. In draft production mode, the prep tool might remove some <link> elements during the draft submission process.
Used in: <rfc>.
The URI of the external document.
The relationship of the external document to this one. The relationships are taken from the IANA-maintained Link relations registry.
link =
element link {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute href { text },
attribute rel { text }?
}
Represents the main content of the document.
Used in: <rfc>. Allowed content: <section>+
middle =
element middle {
attribute xml:base { text }?,
attribute xml:lang { text }?,
section+
}
The name of the containing (parent) element, for instance the section name. This name can include inline markup (for example, including references or making some characters use a fixed-width font).
Used in: <figure>, <note>, <references>, <section>, <table>, . Allowed content: ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <xref> )*
name =
element name {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute slugifiedName { xsd:ID }?,
(text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| xref)*
}
Creates an unnumbered, titled block of text 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".
Used in: <front>. Allowed content: <name>?, ( <dl> | <ol> | <t> | <ul> )+
If removeInRFC is set to "true", this note is marked in the prep tool with text indicating that it should be removed before the document is published as an RFC. That text will be "This note is to be removed before publishing as an RFC."
Possible values: "true", "false" Default value: "false"
Deprecated. Use the <name> element instead.
note =
element note {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute title { text }?,
attribute pn { xsd:ID }?,
[ a:defaultValue = "false" ]
attribute removeInRFC { "true" | "false" }?,
name?,
(dl | ol | t | ul)+
}
An ordered list. The labels on the items will be either a number or a letter, depending on the value of the style attribute.
Used in: <abstract>, <aside>, <blockquote>, <dd>, <li>, <note>, <section>, <td>, and <th>. Allowed content: <li>+
Document-wide unique identifier for this element.
When the prep tool sees an <ol> element with a group attribute that has already been seen, it continues the numbering of the list from where the previous list with the same group name left off. If an <ol> element has both a group attribute and a start attribute, the group's numbering is reset to the given start value.
The indentation of the list elements relative to the start of the list item number. With indent set to "adaptive", the width of the widest list item number will determine the indentation. With a numeric value, that value will be used to determine the amount of indentation. The indentation amount is interpreted as characters when rendering plain-text documents, and en-space units when rendering in formats that have richer typographic support such as HTML or PDF. One en-space is assumed to be the length of 0.5 em-space in CSS units. Only non-negative integer amounts of indentation are supported.
Possible values: text, "adaptive" Default value: "adaptive"
Defines whether or not there is a blank line between entries. Setting spacing to "normal" indicates a single blank line, while setting spacing to "compact" indicates no blank line between entries.
Possible values: "normal", "compact" Default value: "normal"
The ordinal value at which to start the list. This defaults to "1" and must be an integer of value 0 or greater.
Default value: "1"
Required.
The type of the labels on list items. If the length of the type value is 1, the meaning is the same as it is for HTML:
- "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, ...)
Default value: "1"
For types "a" and "A", after the 26th entry, the numbering starts at "aa"/"AA", then "ab"/"AB", and so on.
If the length of the type value is greater than 1, the value must 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 a 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, ...)
- "%p" - The list counter of a list item in a parent list (see more below)
- "%%" - Represents a percent sign
Other formats are reserved for future use. Only one percent encoding other than "%%" and "%p" is allowed in a type value.
It is an error for the type attribute to be empty. For bulleted lists, use the <ul> element. For lists that have neither bullets nor numbers, use the <ul> element with empty set to "true".
'%p' may be used in nested ordered lists, where it represents the item number of the parent list item. This lets you say for instance:
<ol>
<li>List item one</li>
<li>
<t>Nested list:</t>
<ol type='%p%d'>
<li>Sublist item 2.1</li>
<li>Sublist item 2.2</li>
</ol>
</li>
</ol>which is rendered as:
1. List item one
2. Nested list
2.1 Sublist item 2.1
2.2 Sublist item 2.2
Without the '%p' format specifier, you would have to explicitly insert the counter number of the parent item, which could easily result in mismatched numbering if parent list intems were inserted or removed during document editing.
ol =
element ol {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
[ a:defaultValue = "1" ] attribute type { text }?,
[ a:defaultValue = "1" ] attribute start { text }?,
attribute group { text }?,
[ a:defaultValue = "normal" ]
attribute spacing { "normal" | "compact" }?,
[ a:defaultValue = "adaptive" ]
attribute indent { text | "adaptive" }?,
attribute pn { xsd:ID }?,
li+
}
Specifies the affiliation (RFC7322) of an author.
This information appears both in 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.
Used in: <author>, <contact> Allowed content: text
Abbreviated variant of the organization name.
The ASCII equivalent of the <organization> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
The ASCII equivalent of the abbreviated variant of the organization's name.
Turns off listing of organization with author name on the first document page.
Possible values: "true", "false" Default value: "true"
organization =
element organization {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute abbrev { text }?,
attribute ascii { text }?,
attribute asciiAbbrev { text }?,
[ a:defaultValue = "true" ]
attribute showOnFrontPage { "true" | "false" }?,
text
}
Represents a phone number.
The value is expected to be the scheme-specific part of a "tel" URI (and so does not include the prefix "tel:"), using the "global-number-digits" syntax. See Section 3 of RFC3966 for details.
Used in: <address>. Allowed content: text
phone =
element phone {
attribute xml:base { text }?,
attribute xml:lang { text }?,
text
}
Represents a post office box number.
Used in: <postal>. Allowed content: text
The ASCII equivalent of the <pobox> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
pobox =
element pobox {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Contains optional child elements providing postal information. These elements will be displayed in an order that is specific to formatters. 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.
Used in: <address>. Allowed content: ( ( <city> | <cityarea> | <code> | <country> | <extaddr> | <pobox> | <region> | <sortingcode> | <street> )* | <postalLine>+ )
postal =
element postal {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(( city | cityarea | code | country | extaddr | pobox | region
| sortingcode | street)*
| postalLine+)
}
Represents one line of a postal address. When more than one <postalLine> is provided, they are rendered in the order given.
Used in: <postal>. Allowed content: text
The ASCII equivalent of the <postalLine> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
postalLine =
element postalLine {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Text that should appear between the title and the date of a <reference>. <refcontent> should be used in preference to incorrectly using <seriesInfo> where the publication is not part of a recognised series.
Used in: <reference>. Allowed content: ( text | <bcp14> | <em> | <strong> | <sub> | <sup> | <tt> )*
The following <reference> uses <refcontent>:
<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>and renders as:
[April1] Phunny, K., "On Being A Fool", Self-published pamphlet, April 2000.
refcontent =
element refcontent {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(text | bcp14 | em | strong | sub | sup | tt)*
}
Represents a bibliographic reference. <reference> should only be used for references where a BibXML file does not exist.
See References in RFCXML for more information.
Used in: <referencegroup> and <references>. Allowed content: <stream>?, <front>, ( <annotation> | <refcontent> | <seriesInfo> )*
Document-wide unique identifier for this element. This will be used both to label the reference in the References section and as an identifier in links to this reference entry; but this can be changed as explained in <displayreference>. When used in links, this identifier cannot start with a number.
Specifies whether or not the title in the reference should be quoted. This can be used to prevent quoting, such as on errata.
Possible values: "true", "false"
Holds the URI for the reference.
reference =
element reference {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID },
attribute derivedAnchor { text }?,
attribute target { text }?,
[ a:defaultValue = "true" ]
attribute quoteTitle { "true" | "false" }?,
attribute quote-title { "true" | "false" }?,
stream?,
front,
(annotation | format | refcontent | seriesInfo)*
}
Represents a list of bibliographic references that will be represented as a single reference. This is most often used to reference STDs and BCPs, where a single reference (such as "BCP 9") may encompass more than one RFC.
See References in RFCXML for more information.
Used in: <references>. Allowed content: <reference>+
Document-wide unique identifier for this element. 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; but see <displayreference> for how to change this.
Holds an URI for the reference group, analogous to the target attribute of <reference>. Useful for a STD which consists of multiple RFCs with their own URLs, but also has its own unique URL.
referencegroup =
element referencegroup {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID },
attribute derivedAnchor { text }?,
attribute target { text }?,
reference+
}
Contains a set of bibliographic references. In general, the <name> child element should be either "Normative References" or "Informative References".
See References in RFCXML for more information.
Used in: <back> and <references>. Allowed content: <name>?, ( <references>+ | ( <reference> | <referencegroup> )* )
An optional user-supplied identifier for this set of references.
Deprecated. Use the <name> element instead.
references =
element references {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute pn { xsd:ID }?,
attribute anchor { xsd:ID }?,
attribute title { text }?,
name?,
(references+ | (reference | referencegroup)*)
}
Provides the region name in a postal address.
Used in: <postal>. Allowed content: text
The ASCII equivalent of the <region> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
region =
element region {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
This is the root element of RFCXML.
Allowed content: <link>*, <front>, <middle>, <back>?
Document category
For RFCs, the category attribute determines the maturity level (see Section 4 of RFC2026). The allowed values are "std" for "Standards Track", "bcp" for "BCP", "info" for "Informational", "exp" for "Experimental", and "historic" for "Historic".
For Internet-Drafts, the category attribute is not needed; when supplied, it will appear as "Intended Status". Supplying this information can be useful to reviewers.
Possible values: "std", "bcp", "exp", "info", "historic"
Affects the generated boilerplate. Note that the values of "no" and "yes" are deprecated and are replaced by "false" and "true".
See RFC7841 for more information.
Possible values: "false" | "true" Default value: "false"
Indicates the draft name (including revision number) for a draft, or the draft from which an RFC derived, for an RFC. Used to insert the <link rel="prev" href="..."> element that points to the precursor of the RFC, in accordance with the intentions of Section 5.6.3 of RFC7998.
Specifies whether or not a formatter is requested to include an index in generated files. If the source file has no <iref> elements, an index is never generated. This option is useful for generating documents where the source document has <iref> elements but the author no longer wants an index.
Possible values: "true", "false" Default value: "true"
Represents the Intellectual Property status of the document.
The possible values are specified in Appendix A.1 of RFC 7991 and explained in Copyright Notice.
If the attribute is set to the empty string, it is assumed that this is not a regular IETF/IRTF/IAB/ISE document, and the document header content is reduced. This is considered a feature by a few other standards organisations that use IETF tools to format their standards documents.
Identifies a single section within the document for which extraction "as is" is explicitly allowed (only relevant for historic values of ipr).
Used to determine whether to produce an RFC or an Internet-Draft.
A comma-separated list of RFC numbers or Internet-Draft names.
The prep tool will parse the attribute value so that incorrect references can be detected.
The date that the XML was processed by a prep tool. This is included in the XML file just before it is saved to disk. The value is formatted using the "date-time" format defined in Section 5.6 of RFC3339. The "time-offset" should be "Z".
Deprecated; instead, use the value attribute in <seriesInfo>.
Specifies whether or not the prep tool will sort the references in each reference section.
Possible values: "true", "false" Default value: "false"
The document stream, as described in RFC7841. "editorial" is for the new stream added by RFC9280 that is used for submissions to the RFC Series Working Group (RSWG).
Possible values: "IETF", "IAB", "IRTF", "independent", "editorial" Default value: "IETF"
Specifies whether or not a formatter is requested to use symbolic references (such as "RFC2119"). If the value for this is "false", the references come out as numbers (such as [3]).
Possible values: "true", "false" Default value: "true"
Specifies the number of levels of headings that a formatter is requested to include in the table of contents.
Default value: "3"
Specifies whether or not a formatter is requested to include a table of contents in generated files.
Possible values: "true", "false" Default value: "true"
A comma-separated list of RFC numbers or Internet-Draft names.
The prep tool will parse the attribute value so that incorrect references can be detected.
Specifies the version of RFCXML syntax used in this document. The only expected value is "3".
rfc =
element rfc {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute number { text }?,
[ a:defaultValue = "" ] attribute obsoletes { text }?,
[ a:defaultValue = "" ] attribute updates { text }?,
attribute category {
"std" | "bcp" | "exp" | "info" | "historic"
}?,
attribute mode { text }?,
[ a:defaultValue = "false" ]
attribute consensus { "no" | "yes" | "false" | "true" }?,
attribute seriesNo { text }?,
attribute ipr { text }?,
attribute iprExtract { xsd:IDREF }?,
[ a:defaultValue = "IETF" ]
attribute submissionType {
"IETF" | "IAB" | "IRTF" | "independent"
}?,
attribute docName { text }?,
[ a:defaultValue = "false" ]
attribute sortRefs { "true" | "false" }?,
[ a:defaultValue = "true" ]
attribute symRefs { "true" | "false" }?,
[ a:defaultValue = "true" ]
attribute tocInclude { "true" | "false" }?,
[ a:defaultValue = "3" ] attribute tocDepth { text }?,
attribute prepTime { text }?,
[ a:defaultValue = "true" ]
attribute indexInclude { "true" | "false" }?,
attribute version { text }?,
[ a:defaultValue = "Common,Latin" ] attribute scripts { text }?,
attribute expiresDate { text }?,
link*,
front,
middle,
back?
}
Represents a section (when inside a <middle> element) or an appendix (when inside a <back> element).
Subsections are created by nesting <section> elements inside <section> elements. Sections are allowed to be empty.
Used in: <back>, <boilerplate>, <middle>, <section>, and <toc>. Allowed content: <name>?, ( <artset> | <artwork> | <aside> | <author> | <blockquote> | <contact> | <dl> | <figure> | <iref> | <ol> | <sourcecode> | <t> | <table> | <ul> )*, section*
Document-wide unique identifier for this <section> element.
If set to "false", the formatter is requested to not display a section number. The prep tool will verify that such a section is not followed by a numbered section in this part of the document. Descendant sections of unnumbered sections are unnumbered by definition. Both top-level <section>s and other <section>s may have numbered set to "false".
Possible values: "true", "false" Default value: "true"
If set to "true", this section is marked in the prep tool with text indicating that it should be removed before the document is published as an RFC. That text will be "This section is to be removed before publishing as an RFC."
Possible values: "true", "false" Default value: "false"
Deprecated. Use the <name> element instead.
Indicates to a formatter whether or not the section is to be included in a table of contents, if such a table of contents is produced. 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 inclusion of the section if it would be included by the tocDepth attribute of the <rfc> element.
Possible values: "include", "exclude", "default" Default value: "default"
section =
element section {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
attribute title { text }?,
[ a:defaultValue = "true" ]
attribute numbered { "true" | "false" }?,
[ a:defaultValue = "default" ]
attribute toc { "include" | "exclude" | "default" }?,
[ a:defaultValue = "false" ]
attribute removeInRFC { "true" | "false" }?,
name?,
(artset
| artwork
| aside
| author
| blockquote
| contact
| dl
| figure
| iref
| ol
| sourcecode
| t
| table
| texttable
| ul)*,
section*
}
Specifies the document series in which this document appears, and also specifies an identifier within that series.
A processing tool determines whether it is working on an RFC or an Internet-Draft by inspecting the name attribute of a <seriesInfo> element inside the <front> element inside the <rfc> element, looking for "RFC" or "Internet-Draft". (Specifying neither value in any of the <seriesInfo> elements can be useful for producing other types of documents but is out of scope for this specification.)
It is invalid to have multiple <seriesInfo> elements inside the same <front> element containing the same name value. Some combinations of <seriesInfo> name attribute values make no sense, such as having both <seriesInfo name="rfc"/> and <seriesInfo name="Internet-Draft"/> in the same <front> element.
Used in: <front> and <reference>. Allowed content: empty
The ASCII equivalent of the name attribute.
The ASCII equivalent of the value attribute.
Required.
The name of the series. Some values in use by the IETF community are "RFC", "Internet-Draft", and "DOI", but other names such as "ISO", "W3C" for exist for other standardisation organisations.
TBD
Deprecated. Use the <stream> element instead.
Possible values: "IETF", "IAB", "IRTF", "independent"
Required.
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).
- For DOIs, the value is given, such as "10.17487/rfc1149", as described in RFC7669.
The name in the value should be the document name without any file extension.
seriesInfo =
element seriesInfo {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute name { text },
attribute value { text },
attribute asciiName { text }?,
attribute asciiValue { text }?,
attribute status { text }?,
attribute stream { "IETF" | "IAB" | "IRTF" | "independent" }?,
empty
}
A sorting code is related to postal codes in that it is used in addresses to allow sorting, for example to route mail to a certain postal centre or to distinguish streets with the same name in two different areas of the same settlement.
Used in: <postal>. Allowed content: text
The ASCII equivalent of the <sortingcode> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
sortingcode =
element sortingcode {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
This element allows the inclusion of source code into the document.
When rendered, source code is always shown in a monospace font. When <sourcecode> is a child of <figure> or <section>, it provides full control of horizontal whitespace and line breaks. When formatted, it is indented relative to the left margin of the enclosing element. It is thus useful for source code and formal languages, such as ABNF (RFC5234) or the RNC notation used in this document. (When <sourcecode> is a child of other elements, it flows with the text that surrounds it.) Tab characters (U+0009) inside of this element are prohibited.
The use of <![CDATA[ ... ]]> wrappers is recommended to avoid unxpected processing or issues with angle brackets.
For artwork such as character-based art, diagrams of message layouts, and so on, use the <artwork> element instead.
Output formatters that do pagination will attempt to keep source code on a single page. This is to prevent source code that is split across pages from looking like two separate pieces of code.
Used in: <blockquote>, <dd>, <figure>, <li>, <section>, <td>, and <th>. Allowed content: text
Document-wide unique identifier for this element.
Indicates whether <CODE BEGINS> and <CODE ENDS> markers, as introduced by RFC6087, should be generated when rendering the <sourcecode> element. The alternative is to include these explicitly inside the element, but that would necessitate extra code to strip these, when extracting code from the XML source.
Possible values: "true", "false" Default value: "false"
A filename suitable for the contents (such as for extraction to a local file). This attribute can be helpful for other kinds of tools (such as automated syntax checkers, which work by extracting the source code). Note that the name attribute does not need to be unique for <artwork> elements in a document. If multiple <sourcecode> elements have the same name attribute, a formatter might assume that the elements are all fragments of a single file, and such a formatter can collect those fragments for later processing.
The URI reference of a source file (RFC3986).
It is an error to have both a src attribute and content in the <sourcecode> element.
Specifies the type of the source code. The value of this attribute is free text with certain values designated as preferred.
Most of the preferred values for <sourcecode> types are language names, in a wide sense, such as "abnf", "asn.1", "bash", "c++", etc.
A list of the preferred values is maintained on the RFC Editor web site at https://www.rfc-editor.org/materials/sourcecode-types.txt, and that list is updated over time. Thus, a consumer of RFCXML should not cause a failure when it encounters an unexpected type or no type is specified.
The following is a basic example of a c program as set by the type attribute, using a CDATA block because the source code contains angle brackets, and a name attribute that suggests a file name for the extracted code:
<sourcecode name="helloworld.c" type="c" markers="true">
<![CDATA[
#include <stdio.h>
int main() {
printf("Hello World");
return 0;
}
]]>
</sourcecode>Another example can be found at https://www.rfc-editor.org/rfc/rfc8689.html#section-2-2.8.1 where the <sourcecode> element is within an <li> and therefore indented to start at the same level of ident.
sourcecode =
element sourcecode {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
[ a:defaultValue = "" ] attribute name { text }?,
[ a:defaultValue = "" ] attribute type { text }?,
[ a:defaultValue = "false" ]
attribute markers { "true" | "false" }?,
attribute src { text }?,
attribute originalSrc { text }?,
text
}
Indicates which stream an RFC belongs to.
Used in: <reference>. Allowed content: ( "IETF" | "IAB" | "IRTF" | "independent" )?
stream =
element stream {
( "IETF" | "IAB" | "IRTF" | "independent" )?
}
Provides a street address.
Used in: <postal>. Allowed content: text
The ASCII equivalent of the <street> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
street =
element street {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute ascii { text }?,
text
}
Indicates text that is semantically strong. In HTML and PDF rendering, text enclosed within this element will be displayed as bold after processing; in text rendering it will be preceeded and followed by an asterisk. This element can be combined with other character formatting elements, and the formatting will be additive.
Used in: <annotation>, <blockquote>, <cref>, <dd>, <dt>, <em>, <li>, <name>, <refcontent>, <sub>, <sup>, <t>, <td>, <th>, <tt>, and <xref>. Allowed content: ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <sub> | <sup> | <tt> | <xref> )*
strong =
element strong {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| sub
| sup
| tt
| xref)*
}
Causes the text to be displayed as subscript, approximately half a letter-height lower than normal text, in HTML and PDF rendering. This element can be combined with other character formatting elements, and the formatting will be additive.
Used in: <annotation>, <blockquote>, <cref>, <dd>, <dt>, <em>, <li>, <name>, <refcontent>, <strong>, <sub>, <sup>, <t>, <td>, <th>, <tt>, and <xref>. Allowed content: ( text | <bcp14> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <xref> )*
sub =
element sub {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(text
| bcp14
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| xref)*
}
Causes the text to be displayed as superscript, approximately half a letter-height higher than normal text, in HTML and PDF rendering. This element can be combined with other character formatting elements, and the formatting will be additive.
Used in: <annotation>, <blockquote>, <cref>, <dd>, <dt>, <em>, <li>, <name>, <refcontent>, [<strong>](rfcxml-elements<strong>, <sub>, <sup>, <t>, <td>, <th>, <tt>, and <xref>. Allowed content: ( text | <bcp14> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <xref> )*
sup =
element sup {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(text
| bcp14
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| xref)*
}
Contains a paragraph of text.
Used in: <abstract>, <aside>, <blockquote>, <dd>, <li>, <note>, <section>, <td>, and <th>. Allowed content: ( text | <bcp14> | <br> | <contact> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <u> | <xref> )*
Document-wide unique identifier for this paragraph.
Deprecated. Instead, use <dd> inside of a definition list (<dl>).
Indicates any extra amount of indentation to be used when rendering the paragraph of text. The indentation amount is interpreted as characters when rendering plain-text documents, and en-space units when rendering in formats that have richer typographic support such as HTML or PDF. One en-space is assumed to be the length of 0.5 em-space in CSS units. Only non-negative integer amounts of indentation are supported.
Default value: "0"
Acts as a hint to the output formatters that do pagination to do a best-effort attempt to keep the paragraph with the next element, whatever that happens to be. For example, for HTML output @media print CSS might translate this to page-break-after: avoid. For PDF, the paginator could attempt to keep the paragraph with the next element. Note: this attribute is strictly a hint and not always actionable.
Possible values: "true", "false" Default value: "false"
Acts as a hint to the output formatters that do pagination to do a best-effort attempt to keep the paragraph with the previous element, whatever that happens to be. For example, for HTML output @media print CSS might translate this to page-break-before: avoid. For PDF, the paginator could attempt to keep the paragraph with the previous element. Note: this attribute is strictly a hint and not always actionable.
Possible values: "true", "false" Default value: "false"
t =
element t {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
attribute hangText { text }?,
[ a:defaultValue = "0" ]
attribute indent { text }?,
[ a:defaultValue = "false" ]
attribute keepWithNext { "true" | "false" }?,
[ a:defaultValue = "false" ]
attribute keepWithPrevious { "true" | "false" }?,
(text
| bcp14
| br
| contact
| cref
| em
| eref
| iref
| \list
| relref
| spanx
| strong
| sub
| sup
| tt
| u
| vspace
| xref)*
}
Contains a table with a caption with the table number. If the element contains a <name> element, the caption will also show that name.
Inside the <table> element there is, optionally, 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.
Used in: <aside>, <dd>, <li>, and <section>. Allowed content: <name>?, <iref>*, <thead>?, <tbody>+, <tfoot>?
Controls whether the table appears left justified, centered, or right justified. The caption will be centered under the table, and the combined table and caption will be aligned according to the align attribute.
Possible values: "left", "center", "right" Default value: "center"
Document-wide unique identifier for this element.
table =
element table {
attribute xml:base { text }?,
attribute xml:lang { text }?,
[ a:defaultValue = "center" ]
attribute align { "left" | "center" | "right" }?,
attribute anchor { xsd:ID }?,
attribute pn { xsd:ID }?,
name?,
iref*,
thead?,
tbody+,
tfoot?
}
A container for a set of body rows for a table.
Used in: <table>. Allowed content: <tr>+
Document-wide unique identifier for this element.
tbody =
element tbody {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
tr+
}
A cell in a table row.
Used in: <tr>. Allowed content: ( ( <artset> | <artwork> | <dl> | <figure> | <ol> | <sourcecode> | <t> | <ul> )+ | ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <u> | <xref> )* )
Controls whether the content of the cell appears left justified, centered, or right justified. Note that "center" or "right" will probably only work well in cells with plain text; any other elements might make the contents render badly.
Possible values: "left", "center", "right" Default value: "left"
Document-wide unique identifier for this element.
The number of columns that the cell is to span. For example, setting colspan to "3" indicates that the cell occupies the same horizontal space as three cells of a row without the colspan attributes.
Default value: "1"
The number of rows that the cell is to span. For example, setting rowspan to "3" indicates that the cell occupies the same vertical space as three rows.
Default value: "1"
Fully featured table elements using rowspan or colspan)
td =
element td {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
[ a:defaultValue = "1" ] attribute colspan { text }?,
[ a:defaultValue = "1" ] attribute rowspan { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
((artset | artwork | dl | figure | ol | sourcecode | t | ul)+
| (text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| u
| xref)*)
}
A container for a set of footer rows for a table.
Used in: <table>. Allowed content: <tr>+
Document-wide unique identifier for this element.
tfoot =
element tfoot {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
tr+
}
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.
Used in: <tr>. Allowed content: ( ( <artset> | <artwork> | <dl> | <figure> | <ol> | <sourcecode> | <t> | <ul> )+ | ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <tt> | <u> | <xref> )* )
Controls whether the content of the cell appears left justified, centered, or right justified. Note that "center" or "right" will probably only work well in cells with plain text; any other elements might make the contents render badly.
Possible values: "left", "center", "right" Default value: "left"
Document-wide unique identifier for this element.
The number of columns that the cell is to span. For example, setting colspan to "3" indicates that the cell occupies the same horizontal space as three cells of a row without the colspan attributes.
Default value: "1"
The number of rows that the cell is to span. For example, setting rowspan to "3" indicates that the cell occupies the same vertical space as three rows.
Default value: "1"
th =
element th {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
[ a:defaultValue = "1" ] attribute colspan { text }?,
[ a:defaultValue = "1" ] attribute rowspan { text }?,
[ a:defaultValue = "left" ]
attribute align { "left" | "center" | "right" }?,
((artset | artwork | dl | figure | ol | sourcecode | t | ul)+
| (text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| tt
| u
| xref)*)
}
A container for a set of header rows for a table.
Used in: <table>. Allowed content: <tr>+
Document-wide unique identifier for this element.
thead =
element thead {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
tr+
}
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 can be used to specify an abbreviated variant.
Used in: <front>. Allowed content: ( text | <br> )*
Specifies an abbreviated variant of the document title.
The ASCII equivalent of the <title> content. This element may have non-ASCII Latin script content without specifying an ASCII equivalent, but for other non-ASCII content an ASCII equivalent is required.
title =
element title {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute abbrev { text }?,
attribute ascii { text }?,
(text | br)*
}
This element contains the Table of Content. The content of the <toc> element is generated by the preptool based on the tocInclude and tocDepth attributes of the <rfc> element. As a document author, you should not use <toc> directly.
Used in: <front>. Allowed content: <section>*
toc =
element toc {
attribute xml:base { text }?,
attribute xml:lang { text }?,
section*
}
A row of a table.
Used in: <tbody>, <tfoot>, and <thead>. Allowed content: ( <td> | <th> )+
Document-wide unique identifier for this element.
tr =
element tr {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
(td | th)+
}
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.
Used in: <annotation>, <blockquote>, <cref>, <dd>, <dt>, <em>, <li>, <name>, <refcontent>, <strong>, <sub>, <sup>, <t>, <td>, <th>, and <xref>. Allowed content: ( text | <bcp14> | <br> | <cref> | <em> | <eref> | <iref> | <strong> | <sub> | <sup> | <xref> )*
tt =
element tt {
attribute xml:base { text }?,
attribute xml:lang { text }?,
(text
| bcp14
| br
| cref
| em
| eref
| iref
| relref
| strong
| sub
| sup
| xref)*
}
The elements <author>, <organisation>, <street>, <city>, <region>, <code>, <country>, <postalLine>, <email>, <seriesInfo>, and <title> may contain non-ASCII characters for the purpose of rendering author names, addresses, and reference titles correctly. They also have an additional ascii attribute for the purpose of proper rendering in ascii-only media.
The <u> element is required to enclose Unicode strings that are needed for correct protocol operation. For more details, see non-ASCII characters in RFCXML.
Used in: <annotation>, <blockquote>, <dd>, <li>, <t>, <td>, and <th>. Allowed content: text
Document-wide unique identifier for this element.
The ASCII equivalent of the content, to be used if the "ascii" keyword is used in the format specification.
The format attribute accepts either a simplified format specification, or a full format string with placeholders for the various possible Unicode expansions.
For more details see non-ASCII characters in RFCXML.
Default value: "lit-name-num"
Non-ASCII characters in an author's name:
- in the Latin blocks: RFC 8655, RFC 8753, RFC 8831.
- outside the Latin blocks: RFC 8694, RFC 9005, RFC 9093, RFC 9094 Non-ASCII characters in a contact's name:
- in the Latin blocks: RFC 8725
- outside the Latin blocks: RFC 9000, RFC 9001, RFC 9002
u =
element u {
attribute anchor { xsd:ID }?,
attribute ascii { text }?,
[ a:defaultValue = "lit-name-num" ]
attribute format { text }?,
attribute pn { xsd:ID }?,
text
}
An unordered list. The labels on the items will be symbols picked by the formatter.
Used in: <abstract>, <aside>, <blockquote>, <dd>, <li>, <note>, <section>, <td>, and <th>.
Allowed content: <li>+
Document-wide unique identifier for this element.
Can only be used with empty set to "true" (see below). Determines if the blank bullet has an horizontal extension or not. With bare set to "false", the empty list bullet will still occupy the same space as for empty set to "false". With empty set to "true", there will be no bullet at all, i.e., the list items will have no indentation.
Possible values: "true", "false" Default value: "false"
Defines whether or not the list item bullets are empty. Setting empty to "true" indicates that a blank (empty) bullet will be shown.
Possible values: "true" "false" Default value: "false"
The indentation of the list elements relative to the start of the bullet or bullet text.
Default value: "3"
Defines whether or not there is a blank line between entries. Setting spacing to "normal" indicates a single blank line, while setting spacing to "compact" indicates no blank line between entries.
Possible values: "normal", "compact" Default value: "normal"
Example: an unordered list with bare as "true" and empty as "true":
List:
One
Two
Example: an unordered list with bare as "false" and empty as "false":
List:
* One
* Two
Example: an unordered list with bare as "false" and empty as "true":
List:
One
Two
ul =
element ul {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute anchor { xsd:ID }?,
[ a:defaultValue = "normal" ]
attribute spacing { "normal" | "compact" }?,
([ a:defaultValue = "false" ]
attribute empty { "true" | "false" },
[ a:defaultValue = "false" ]
attribute bare { "true" | "false" }?)?,
[ a:defaultValue = "3" ]
attribute indent { text }?,
attribute pn { xsd:ID }?,
li+
}
Contains a web address associated with the author.
The contents should be a valid URI; this most likely will be an "http:" or "https:" URI.
Used in: <address> Allowed content: text
uri =
element uri {
attribute xml:base { text }?,
attribute xml:lang { text }?,
text
}
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 attribute of the <rfc> element.
Used in: <front>. Allowed content: text
workgroup =
element workgroup {
attribute xml:base { text }?,
attribute xml:lang { text }?,
text
}
A reference to an anchor in this document. Formatters that have links (such as HTML and PDF) are likely to render <xref> elements as internal hyperlinks. This element is useful for referring to references in the References section, to specific sections of the document, to specific figures, and so on.
If the section attribute is present, this represents a link to a specific part of a document that appears in a <reference> element. Formatters that have links (such as HTML and PDF) render <xref> elements with section attributes as external hyperlinks to the specified part of the reference, creating the link target by combining the base URI from the <reference> element with the relative attribute from this element. The target attribute is required, and it must be the anchor of a <reference> element.
If the reference is not an RFC or Internet-Draft that is in the v3 format, the element needs to have a relative attribute; in this case, the value of the section attribute is used to render the text of the external link.
If the section attribute is present, the rendering will, for most cominations of the format and sectionFormat, have two links; one external link to the specific part of the referenced document, and one internal link to the <reference> entry.
The format attribute affect the internal link rendering only, and the sectionFormat attribute affects the rendering of the external link and its textual relationship to the internal link only.
See References in RFCXML for more information.
Used in: <annotation>, <blockquote>, <cref>, <dd>, <dt>, <em>, <li>, <name>, <strong>, <sub>, <sup>, <t>, <td>, <th>, <tt>. Allowed content: ( text | <em> | <strong> | <sub> | <sup> | <tt> )*
Possible values: "default", "title", "counter", "none" Default value: "default"
This attribute signals to formatters what the desired format of the internal link to the relevant <reference> should be.
-
"default" - If the element has no content, the derivedContent attribute will contain a text fragment that describes the referenced part completely, such as "XML" for a target that is a <reference>, or "Section 2" or "Table 4" for a target to a non-reference.
-
"title" - If the target is a <reference> element, the derivedContent attribute will contain the name of the reference, extracted from the <title> child of the <front> child of the reference. Or, if the target element has a <name> child element, the derivedContent attribute will contain the text content of that <name> element concatenated with the text content of each descendant node of <name> (that is, stripping out all of the XML markup, leaving only the text). Or, if the target element does not contain a <name> child element, the derivedContent attribute will contain the name of the anchor attribute of that element with no other adornment.
-
"counter" - The derivedContent attribute will contain just a counter. This is used for targets that are <section>, <figure>, <table>, or items in an ordered list. Setting format to "counter" where the target is any other type of element is an error.
-
"none" - There will be no autogenerated text for the xref. When this value is used, it expected that the <xref> element will have explicit text content.
Specifies a relative reference from the URI in the target reference. This value must include whatever leading character is needed to create the relative reference; typically, this is "#" for HTML documents.
Specifies a section of the target reference. If the reference is not an RFC or Internet-Draft in the v3 format, and no relative attribute has been provided, it is an error.
Possible values: "of", "comma", "parens", "bare" Default value: "of"
This attribute is used to signal formatters what the desired format of the external reference should be. Formatters for document types that have linking capability should wrap each part of the displayed text in hyperlinks. If there is content in the <xref> element, that content will be used when rendering the internal link part of the <xref> rendering, but will not affect the external link.
-
"of" - The <xref> element will be displayed as an external link followed by an internal link, separated by the word 'of'. The external link will have as its display text the word "Section" followed by a space and the contents of the section attribute. This will be followed by a space, the word "of", another space, and an internal link to the relevant <reference> entry, formatted based on the format attribute.
-
"comma" - The <xref> element will be displayed as an internal link followed by an external link, separated by a comma. The external link will have as its display text the word "Section" followed by a space and the contents of the section attribute. The internal link will point to the relevant <reference> entry, and will be rendered according to the format attribute.
-
"parens" - The <xref> element will be displayed as an internal link followed by an external link within parentheses. The external link will have as its display text the word "Section" followed by a space and the contents of the section attribute. The internal link will point to the relevant <reference> entry, and will be rendered according to the format attribute.
-
"bare" - The <xref> element will be displayed as an external link, possibly followed by the same link within parentheses. The first external link will have as its display text only contents of the section attribute; the second link will be present within parentheses only if the <xref> element has any text content, and will then have the text content as its display text.
This value for the sectionFormat attribute is useful when it is desired to express for instance
Sections 3.2 and 3.3 of [RFC7997]
Required.
Identifies the document component being referenced. The value needs to match the value of the anchor attribute of an element in the document; otherwise, it is an error.
xref =
element xref {
attribute xml:base { text }?,
attribute xml:lang { text }?,
attribute target { xsd:IDREF },
[ a:defaultValue = "false" ]
attribute pageno { "true" | "false" }?,
[ a:defaultValue = "default" ]
attribute format { "default" | "title" | "counter" | "none" }?,
attribute derivedContent { text }?,
[ a:defaultValue = "of" ]
attribute sectionFormat { "of" | "comma" | "parens" | "bare" }?,
attribute section { text }?,
attribute relative { text }?,
attribute derivedLink { text }?,
(text | em | strong | sub | sup | tt)*
}