| Network Working Group | J. Hildebrand, Ed. |
| Internet-Draft | Cisco Systems, Inc. |
| Intended status: Informational | P. Hoffman |
| Expires: January 1, 2017 | ICANN |
| June 30, 2016 |
HyperText Markup Language Request For Comments Format
draft-iab-html-rfc-03
In order to meet the evolving needs of the Internet community, the format for RFCs is changing from a plain-text, ASCII-only format to a canonical XML format that will in turn be rendered into several publication formats. This document defines the HTML format that will be rendered for an RFC or Internet-Draft.
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 January 1, 2017.
Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
As described in [I-D.iab-rfc-framework], the RFC Series is changing. One of those changes includes the RFC Editor publishing a non-canonical HTML version of RFCs.
This document describes the HTML format that will be used as one of the publication formats for the RFC Series. It defines a strict subset of HTML appropriate for RFC Series documents. The visual layout of the document will be defined through a cascading style sheet (CSS) [W3C.REC-CSS2-20110607]. The CSS will be included in the HTML file but will be described in [I-D.iab-rfc-css].
The details (particularly any vocabularies) described in this document are expected to change based on experience gained in implementing the RFC production center's toolset. Revised documents will be published capturing those changes as the toolset is completed. Other implementers must not expect those changes to remain backwards-compatible with the details described this document.
This section lists the design requirements used to create the HTML format described in this document. These requirements build on those found in [RFC6949]. Many of these requirements are naturally fulfilled by using the output of the preparation tool [I-D.iab-rfcv3-preptool].
The RFC Editor will periodically determine which version of the HTML specification will be referenced for tools generating the format defined in this document. The starting version will be that defined in [W3C.REC-html5-20141028], commonly known as "HTML5". Although the HTML specification mandates several of the syntax and structure rules described in this document, they are called out here for emphasis.
The processor emitting HTML from the XML source will follow these rules:
NOTE: none of these rules affect the rendered output of the HTML, but are intended to increase the chance that text comparison tools (e.g., "diff") that operate on the HTML output easier to write.
This section lists items that are common across multiple parts of the HTML document.
HTML elements that are generated from XML elements that include an "anchor" attribute will use the value of the "anchor" attribute as the value of the "id" attribute of the corresponding HTML element. The prep tool produces XML with "anchor" attributes in all elements that need them. Some HTML constructs (such as <section>) will use multiple instances of these identifiers.
Each paragraph, artwork, or sourcecode segment outside of a <figure> or <table> element will be appended with a space and a "pilcrow" (U+00B6: PILCROW SIGN), otherwise known as a "paragraph sign". For the purposes of clarity in ASCII renderings of this document, in this document pilcrows are rendered as "¶". The pilcrow will be linked to the "id" attribute on the XML entity to which it is associated using an <a> element of class "pilcrow". For example:
<p id="s-1.1-1"> Some paragraph text. <a class="pilcrow" href="#s-1.1-1">¶</a> </p>
The pilcrow will normally be invisible unless the element it is attached to is moused over. The pilcrow will be surrounded by a link that points to the element it is attached to.
Pilcrows are never included inside a <table> or <figure> element, since the figure number or table number serves as an adequate link target.
Elements that might otherwise contain a pilcrow do not get marked with a pilcrow if they contain one or more child elements that are marked with a pilcrow. For example:
<blockquote id="s-1.2-1">
<p id="s-1.2-2">Four score and seven years ago our fathers brought
forth on this continent, a new nation, conceived in Liberty, and
dedicated to the proposition that all men are created equal.
<a href="#s-1.2-2" class="pilcrow">¶</a></p>
<!-- NO pilcrow here -->
</blockquote>
The front matter of the HTML format contains processing information, metadata of various types, and styling information that applies to the document as a whole. This section describes HTML that is not necessarily a direct transform from the XML format. For more details on each of the tags that generate content in this section, see Section 9.
The DOCTYPE of the document is "html", which declares that the document is compliant with HTML5. The document will start with exactly this string:
<!DOCTYPE html>
The root element of the document is <html>. This element includes a lang attribute, whose value is a [RFC5646] language tag describing the natural language of the document. The language tag to be included is "en". The class of the <html> element will be copied verbatim from the XML <rfc> element's <front> element's <seriesInfo> element's "name" attributes (separated by spaces), allowing CSS to style RFCs and Internet-Drafts differently from one another (if needed):
<html lang="en" class="RFC">
The root <html> will contain a <head> element that contains the following elements, as needed.
In order to be correctly processed by browsers that load the HTML using a mechanism that does not provide a valid content-type or charset (such as from a local file system using a "file:" URL), the HTML <head> element contains a <meta> element, with charset attribute with value "utf-8":
<meta charset="utf-8">
The contents of the <title> element from the XML source will be placed inside an HTML <title> element in the header.
The following <meta> elements will be included:
For example:
<meta name="author" content="Joe Hildebrand"> <meta name="author" content="JOE HILDEBRAND"> <meta name="author" content="Heather Flanagan"> <meta name="description" content="This document defines..."> <meta name="generator" content="xmljade v0.2.4"> <meta name="keywords" content="html,css,rfc">
Note: the HTML <meta> tag does not contain a closing slash.
The <head> element contains a <link> tag, with "rel" attribute of "alternate", "type" attribute of "application/rfc+xml", and "href" attribute pointing to the prepared XML source that was used to generate this document.
<link rel="alternate" type="application/rfc+xml" href="source.xml">
The <head> element contains a <link> tag, with "rel" attribute of "license" and "href" attribute pointing to the an appropriate copyright license for the document.
<link rel="license" href="https://www.rfc-editor.org/copyright/">
The <head> element contains an embedded CSS style sheet in a <style> element. The styles in the style sheet are to be set consistently between documents by the RFC Editor, according to the best practices of the day.
To ensure consistent formatting, individual style attributes should not be used in the main portion of the document.
Different readers of a specification will desire different formatting when reading the HTML versions of RFCs. To facilitate this, the <head> element also includes a <link> to a style sheet in the same directory as the HTML file, named "rfc-local.css". Any formatting in the linked style sheet will override the formatting in the included style sheet. For example:
<style>
body {}
...
</style>
<link rel="stylesheet" type="text/css" href="rfc-local.css">
Each <link> element from the XML source is copied into the HTML header. Note: the HTML <link> element does not include a closing slash.
In order to simplify printing by HTML renderers that implement [W3C.WD-css3-page-20130314], a hidden HTML <table> tag of class "ears" is added at the beginning of the HTML <body> tag, containing HTML <thead> and <tfoot> tags, each of which contains an HTML <tr> tag, which contains three HTML <td> tags with class "left", "center", and "right", respectively.
The <thead> corresponds to the top of the page, the <tfoot> to the bottom. The string "[Page]" can be used as a placeholder for the page number. In practice, this must always be in the <tfoot>'s right <td>, and no control of the page number formatting is implied.
<table class="ears">
<thead>
<tr>
<td class="left">Internet-Draft</td>
<td class="center">HTML RFC</td>
<td class="right">March 2016</td>
</tr>
</thead>
<tfoot>
<tr>
<td class="left">Hildebrand</td>
<td class="center">Expires September 2, 2016</td>
<td class="right">[Page]</td>
</tr>
</tfoot>
</table>
Information about the document as a whole will appear as the first child of the HTML <body> element, embedded in an HTML <dl> element with id="identifiers". The defined terms in the definition list are "Workgroup:", "Series:", "Status:", "Published:", and "Author:" or "Authors:" (as appropriate). For example:
<dl id="identifiers">
<dt>Workgroup:</dt>
<dd class="workgroup">rfc-interest</dd>
<dt>Series:</dt>
<dd class="series">Internet-Draft</dd>
<dt>Status:</dt>
<dd class="status">Informational</dd>
<dt>Published:</dt>
<dd><time datetime="2014-10-25"
class="published">2014-10-25</time></dd>
<dt>Authors:</dt>
<dd class="authors">
<div class="author">
<span class="initial">J.</span>
<span class="surname">Hildebrand</span>
(<span class="organization">Cisco Systems, Inc.</span>), Ed.
</div>
<div class="author">
<span class="initial">H.</span>
<span class="surname">Flanagan</span>
(<span class="organization">RFC Editor</span>)
</div>
</dd>
</dl>
The table of contents will follow the boilerplate if the XML's <rfc> element's tocInclude attribute has the value "true". An HTML <h2> heading containing the text "Table of Contents" will be followed by a <nav> element that contains a <ul> element for each depth of the section hierarchy. Each section will be represented by a <li> element containing links by the section number (from the "pn" attribute) and by the name (from the "slugifiedName" attribute of the <name> child element). Each <nav>, <ul>, and <li> element will have the class "toc".
For example:
<h2 id="toc">Table of Contents</h2>
<nav class="toc">
<ul class="toc">
<li class="toc">
<a href="s-1">1</a>. <a href="n-introduction">Introduction</a>
</li>
<ul class="toc">
<li class="toc">
<a href="s-1.1">1.1</a>. <a href="n-sub-intro">Sub Intro</a>
</li>
...
The main body of the HTML document is processed according to the rules in Section 9.
The back matter of the HTML document includes an index (if generated), information about the authors, and further information about the document itself.
The index will be produced at the end of the document (before the author information) if and only if the XML document's <rfc> element has an indexInclude attribute with the value "true", and there is one or more <iref> elements in the document.
The index section will start with an <h2> heading containing the text "Index", followed by links to each of the lettered portions of the index. Links are not generated for letters that do not occur as the first letter of an index item.
For example:
<h2>Index</h2>
<div class="index">
<div class="indexIndex">
<a href="#rfc.index.C">C</a>
<a href="#rfc.index.P">P</a>
</div>
...
The index letter is followed by a <ul> tag that contains a <li> tag for each first letter represented in the index. This <li> tag has the class "indexChar", and contains an <a> tag with the id pointed to by the index letter, as well as an href to itself. The <li> tag also includes a <ul> tag that will contain the index items.
For example:
<ul>
<li class="indexChar">
<a href="#rfc.index.C" id="rfc.index.C">C</a>
<ul>
<!-- items go here -->
</ul>
</li>
...
Each index item can have multiple <iref> elements to point to, all with the same item attribute. Each index item is represented by an <li> tag of class "indexItem" containing a <span> of class "irefItem" for the item text and one of class "irefRefs" for the generated references (if there is at least one reference to the item not having a subitem). Each generated reference contains an <a> tag containing the section number where the <iref> was found, with an "href" attribute pointing to the "irefid" attribute of the <iref> element from the XML document. If the primary attribute of the <iref> element has the value "true", the <a> element in the HTML document will have the class "indexPrimary". Commas may be used to separate the generated references.
For example:
<li class="indexItem">
<span class="irefItem">Bullets</span>
<span class="irefRefs">
<a class="indexPrimary" href="#s-Bullets-1">2</a>,
<a href="#s-Bullets-2">2</a>
</span>
<!-- subitems go here -->
</li>
...
If an index item has at least one subitem, the <li> of that item will contain a <ul>, with one <li> for each subitem, of class "indexSubItem". Each subitem is formatted similarly to items, except the class of the first <span> tag is "irefSubItem".
For example:
<ul>
<li class="indexSubItem">
<span class="irefSubItem">Ordered</span>
<span class="irefRefs">
<a href="#s-Bullets-Ordered-1">2</a>
</span>
</li>
</ul>
...
At the end of the document, author information will be included inside an HTML <section> element whose id attribute is "author-addresses". The class names of the constituent HTML tags have been chosen to match the class names in [HCARD].
The information for each author will be separated by an HTML <hr> element with class "addr"
<section id="author-addresses">
<h2>
<a class="selfRef" href="#author-addresses">
Authors' Addresses
</a>
</h2>
<address class="vcard">
<div class="nameRole"><span class="fn">Joe Hildebrand</span>
(<span class="role">editor</span>)</div>
<div class="org">Cisco Systems, Inc.</div>
</address>
<hr class="addr">
<address class="vcard">
<div class="nameRole"><span class="fn">Heather Flanagan</span>
(<span class="role">editor</span>)</div>
<div class="org">RFC Editor</div>
</address>
</section>
A few bits of metadata about the document that are less important to most readers are included after the author information. These are gathered together into a <div> of class "docInfo".
The finalized time is copied from the <rfc> element's prepTime attribute. The rendered time is the time that this HTML was generated.
For example:
<div class="docInfo">
<span class="finalized">
Finalized: <time
datetime="2015-04-29T18:59:08Z">2015-04-29T18:59:08Z</time>
</span>
<span class="rendered">
Rendered: <time
datetime="2015-04-29T18:59:10Z">2015-04-29T18:59:10Z</time>
</span>
</div>
This section describes how each of the XML elements from [I-D.iab-xml2rfc] is rendered to HTML. Many of the descriptions have examples to clarify how elements will be rendered.
The abstract is rendered similarly to a <section> with anchor="abstract" and <name>Abstract</name>, but without a section number.
<section id="abstract">
<h2><a href="#abstract" class="selfRef">Abstract</a></h2>
<p id="s-abstract-1">This document defines...
<a href="#s-abstract-1" class="pilcrow">¶</a>
</p>
</section>
This element is used in Authors' Addresses. It is rendered as an HTML <address> tag of class "vcard". If none of the descendant XML elements has an "ascii" attribute, the <address> HTML tag includes the HTML rendering of each of the descendant XML elements. Otherwise, the <address> HTML tag includes an HTML <div> tag of class "ascii" (containing the HTML rendering of the ASCII variants of each of the descendant XML elements), an HTML <div> tag of class "alternative-contact", (containing the text "Alternate contact information:"), and an HTML <div> tag of class "non-ascii" (containing the HTML rendering of the non-ASCII variants of each of the descendant XML elements).
Note: The following example shows some ASCII equivalents that are the same as their nominal equivalents for clarity; normally the ASCII equivalents would not be included for these cases.
<address class="vcard">
<div class="ascii">
<div class="nameRole"><span class="fn">Joe Hildebrand</span>
(<span class="role">editor</span>)</div>
<div class="org">Cisco Systems, Inc.</div>
</div>
<div class="alternative-contact">
Alternate contact information:
</div>
<div class="non-ascii">
<div class="nameRole"><span class="fn">Joe Hildebrand</span>
(<span class="role">editor</span>)</div>
<div class="org">Cisco Systems, Inc.</div>
</div>
</address>
This element is rendered as the text ", " (a comma and a space) followed by a span of class "annotation" at the end of a <reference> element, the span containing appropriately-transformed elements from the children of the <annotation> tag.
, <span class="annotation">Some <em>thing</em>.</span>
Not currently rendered to HTML.
Artwork can either consist of inline text or SVG. If the artwork is not inside a <figure> element, a pilcrow [pilcrows] is included. Inside a <figure> element, the figure title serves the purpose of the pilcrow. If the "align" attribute has the value "right", the CSS class "alignRight" will be added. If the "align" attribute has the value "center", the CSS class "alignCenter" will be added.
Text artwork is rendered inside an HTML <pre> element, which is contained by a <div> element for consistency with SVG artwork. Note that CDATA blocks are not a part of HTML, so all <, >, and & must be escaped as <, >, and &, respectively.
The <div> element will have CSS classes of "artwork", "art-text", and "art-" prepended to the value of the <artwork> element's "type" attribute, if it exists.
<div class="artwork art-text art-ascii-art" id="s-1-2">
<pre>
______________
< hello, world >
--------------
\ ^__^
\ (oo)\_______
(__)\ )\/\
||----w |
|| ||
</pre>
<a class="pilcrow" href="#s-1-2">¶</a>
</div>
SVG artwork will be included inline. The SVG is wrapped in a <div> element with CSS classes "artwork" and "art-svg".
If the SVG artwork element is a child of <figure> and the artwork is specified as align='right', an empty HTML <span> element is added directly after the <svg> element, in order to get right alignment work correctly in HTML rendering engines that do not support the flex-box model.
Note: the alt attribute of <artwork> is not currently used for SVG; instead, the <title> and <desc> tags are used in the SVG.
<div class="artwork art-svg" id="s-2-17">
<svg width="100" height="100" xmlns="http://www.w3.org/2000/svg">
<desc>Alt text here</desc>
<circle
cx="50" cy="50" r="40"
stroke="green" stroke-width="4" fill="yellow" />
</svg>
<a href="#s-2-17" class="pilcrow">¶</a></pre>
</div>
Other artwork will have a src attribute uses the "data" URI scheme defined in [RFC2397]. Such artwork is rendered in an HTML <img> element. Note: the HTML <img> element does not have a closing slash.
Note: such images are not yet allowed by the RFC Series Editor, even though the format supports them. The RFC Series Editor may allow a limited set of "data:" mediatypes for artwork in the future.
<div class="artwork art-logo" id="s-2-58">
<img alt="IETF logo"
src="data:image/gif;charset=utf-8;base64,...">
<a class="pilcrow" href="#s-2-58">¶</a>
</div>
This element is rendered as an HTML <aside> element, with all child content appropriately transformed.
<aside id="s-2.1-2">
<p id="s-2.1-2.1">
A little more than kin, and less than kind.
<a class="pilcrow" href="#s-2.1-2.1">¶</a>
</p>
</aside>
The <author> element is used in several places in the output. Different rendering is used for each.
As seen in the Document Information at the beginning of the HTML, each document author is rendered as an HTML <div> tag of class "author".
Inside the <div class="author"> HTML tag, the author's initials and surname (or the fullname, if it exists and the others do not) will be rendered in an HTML <div> tag of class "author-name". If the <author> contains "asciiInitials" and "asciiSurname" attributes, or contains as "asciiFullname" attribute, the author's name is rendered twice, with the first being the non-ASCII version, wrapped in an HTML <span> tag of class "non-ascii", followed by the ASCII version wrapped in an HTML <span> tag of class "ascii", wrapped in parentheses. If the <author> has a "role" attribute of "editor", the <div class="author-name"> will also contain the text ", " (comma, space), followed by an HTML <span> tag of class "editor", which contains the text "Ed.".
If the <author> element contains an <organization> element, it is also rendered inside the <div class="author"> HTML tag.
<div class="author">
<div class="author-name">
H. Flanagan,
<span class="editor">Ed.</span></div>
<div class="org">Test Org</div>
</div>
<div class="author">
<div class="author-name">
<span class="non-ascii">Hildebrand</span>
(<span class="ascii">HILDEBRAND</span>)
</div>
<div class="org">
<span class="non-ascii">Test Org</span>
(<span class="ascii">TEST ORG</span>)
</div>
</div>
As seen in Authors' Addresses, at the end of the HTML, each document author is rendered into an HTML <address> element with the CSS class "vcard".
The HTML <address> element will contain an HTML <div> with CSS class "nameRole". That div will contain an HTML <span> element with CSS class "fn" containing the value of the "fullname" attribute of the <author> XML element, and an HTML <span> element with CSS class "role" containing the value of the "role" attribute of the <author> XML element (if there is a role). Parentheses will surround the <span class="role">, if it exists.
<address class="vcard">
<div class="nameRole">
<span class="fn">Joe Hildebrand</span>
(<span class="role">editor</span>)
</div>
...
After the name, the <organization> and <address> child elements of the author are rendered inside the HTML <address> tag.
When the <author> element or any of its descendant elements has any attribute that start with "ascii", all of the author information is displayed twice. The first version is wrapped in an HTML <div> tag with class "ascii"; this version prefers the ASCII version of information, such as "asciiFullname", but falls back on the non-ASCII version if the ASCII version doesn't exist. The second version is wrapped in an HTML <div> tag with class "non-ascii"; this version prefers the non-ASCII version of information, such as "fullname", but falls back on the ASCII version if the non-ASCII version does not exist. Between these two HTML <div>s, a third <div> is inserted, with class "alternative-contact", containing the text "Alternate contact information:".
<address class="vcard">
<div class="ascii">
<div class="nameRole">
<span class="fn">The ASCII name</span>
</div>
<div class="alternative-contact">
Alternate contact information:
</div>
<div class="non-ascii">
<div class="nameRole">
<span class="fn">The non-ASCII name</span>
(<span class="role">editor</span>)</div>
</div>
</address>
In the output generated from a reference element, author tags are rendered inside an HTML <span> element with CSS class "refAuthor". See [RFC7322], section 4.8.6.2 for which sections of the author name to use.
<span class="refAuthor">Flanagan, H.</span> and <span class="refAuthor">N. Brownlee</span>
If there is exactly one <references> child, renders that child similarly to a <section>. If there are more than one <references> child, renders as a <section> whose name is "References", containing a <section> for each <references>.
After any <references> sections, renders each <section> child as appendices.
<section id="n-references">
<h2 id="s-2">
<a class="selfRef" href="#s-2">2.</a>
<a class="selfRef" href="#n-references">References</a>
</h2>
<section id="n-normative">
<h3 id="s-2.1">
<a class="selfRef" href="#s-2.1">2.1.</a>
<a class="selfRef" href="#n-normative">Normative</a>
</h3>
<dl class="reference"></dl>
</section>
<section id="n-informational">
<h3 id="s-2.2">
<a class="selfRef" href="#s-2.2">2.2.</a>
<a class="selfRef" href="#n-informational">Informational</a>
</h3>
<dl class="reference"></dl>
</section>
</section>
<section id="n-unimportant">
<h2 id="s-A">
<a class="selfRef" href="#s-A">Appendix A.</a>
<a class="selfRef" href="#n-unimportant">Unimportant</a>
</h2>
</section>
This element marks up words like MUST and SHOULD with an HTML <span> element with the CSS class "bcp14".
You <span class="bcp14">MUST</span> be joking.
This element renders as the similar HTML <blockquote> element. If there is a "cite" attribute, it is copied to the HTML cite attribute. If there is a "quoteFrom" attribute, it is placed inside a <cite> element at the end of the quote, with an <a> element surrounding it (if there is a "cite" attribute), linking to the "cite" URL.
If the blockquote does not contain another element that gets a pilcrow [pilcrows], a pilcrow is added.
Note that the "—" at the beginning of the <cite> element should be a proper emdash, which is difficult to show in the current format of this format.
<blockquote id="s-1.2-1"
cite="http://...">
<p id="s-1.2-2">Four score and seven years ago our fathers
brought forth on this continent, a new nation, conceived
in Liberty, and dedicated to the proposition that all men
are created equal.
<a href="#s-1.2-2" class="pilcrow">¶</a>
</p>
<cite>— <a href="http://...">Abraham Lincoln</a></cite>
</blockquote>
The IPR boilerplate for the document appears directly after the Abstract. The children of the input <boilerplate> element are treated similarly to unnumbered sections.
<section id="status-of-this-memo">
<h2 id="s-boilerplate-1">
<a href="#status-of-this-memo" class="selfRef">
Status of this Memo</a>
</h2>
<p id="s-boilerplate-1-1">This Internet-Draft is submitted in full
conformance with the provisions of BCP 78 and BCP 79.
<a href="#s-boilerplate-1-1" class="pilcrow">¶</a>
</p>
...
This element is directly rendered as its HTML counterpart. Note: in HTML, <br> does not have a closing slash.
This element is rendered as a <span> element with CSS class "locality".
<span class="locality">Guilford</span>
This element is rendered as a <span> element with CSS class "postal-code".
<span class="postal-code">GU16 7HF<span>
This element is rendered as a <div> element with CSS class "country-name".
<div class="country-name">England</div>
This element is rendered as a <span> element with CSS class "cref". Any anchor is copied to the id attribute. If there is a source given, it is contained inside the cref span with another span of class "crefSource".
<span class="cref" id="crefAnchor">Just a brief comment about something that we need to remember later. <span class="crefSource">--life</span></span>
This element is rendered as the HTML <time> element. If the "year", "month", or "day" attribute is included on the XML element, an appropriate "datetime" element will be generated in HTML.
If this date is a child of the document's <front> element, it gets the CSS class "published".
If this date is inside a <reference> element, it gets the CSS class "refDate".
<time datetime="2014-10" class="published">October 2014</time>
This element is directly rendered as its HTML counterpart.
Does not affect the HTML output, but used in the generation of <reference>, <referencegroup>, <relref>, and <xref>.
This element is directly rendered as its HTML counterpart.
If the hanging attribute is "false", add the "dlParallel" class, else add the "dlHanging" class.
If the spacing attribute is "compact", add the "dlCompact" class.
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
As shown in Section 8.2 this element is rendered as an HTML <div> containing the string "Email:" and an HTML <a> element, with "href" attribute set to the equivalent "mailto:" URI, CSS class of "email", and the contents set to the email address. If this is the version of the address with ASCII, the "ascii" attribute is preferred to the element text.
<div> <span>Email:</span> <a class="email" href="mailto:joe@example.com">joe@example.com</a> </div>
This element is rendered as HTML <a> element, with the "href" attribute set to the value of the "target" attribute, and the CSS class of "eref".
<a href="https://..." class="eref">the text</a>
This element renders as the HTML <figure> element, containing the artwork or sourcecode indicated and an HTML <figcaption> element. The <figcaption> will contain an <a> element around the figure number. It will also contain another <a> element with CSS class "selfRef" around the figure name, if a name was given.
<figure id="f-1">
...
<figcaption>
<a href="#f-1">Figure 1.</a>
<a href="#n-it-figures" id="n-it-figures" class="selfRef">
It figures
</a>
</figcaption>
</figure>
See Document Information.
This element is rendered as an empty <> tag of class iref, with an id consisting of the <iref> element's irefid:
<span class="iref" id="s-Paragraphs-first-1"/>
Each of these elements renders its text into the <meta> keywords in the document's header, separated by commas.
<meta name="keywords" content="html,css,rfc">
This element is rendered as its HTML counterpart. However if there is no contained element that had a pilcrow [pilcrows] attached, a pilcrow is added.
<li id="s-2-7">Item <a href="#s-2-7" class="pilcrow">¶</a></li>
This element is rendered as its HTML counterpart, in the HTML header.
This element does not add any direct output to HTML.
This element is never rendered directly, but instead when considering its parent element, such as <figure>, <references>, <section>, or <table>.
This element is rendered similarly to a <section>, but without a section number, and with the CSS class of "note". If the "removeInRFC" attribute is set to "yes", the generated <div> will also include the CSS class "rfcEditorRemove".
<section id="s-note-1" class="note rfceditor-remove">
<h2>
<a href="#n-editorial-note" class="selfRef">Editorial Note</a>
</h2>
<p id="s-note-1-1">
Discussion of this draft takes place...
<a href="#s-note-1-1" class="pilcrow">¶</a>
</p>
</section>
The output created from an <ol> element depends upon the style attribute.
If the spacing attribute has the value "compact", a CSS class of "olCompact" will be added.
The group attribute is not copied; the input XML should have start values added by a prep tool for all grouped <ol> elements.
If the style attribute includes the character "%", the output is a <dl> tag with the class "olPercent". Each contained li is emitted as a <dt>/<dd> pair, with the generated label in the <dt> and the contents of the li in the <dd>.
<dl class="olPercent"> <dt>Requirement xviii:</dt> <dd>Wheels on a big rig</dd> </dl>
For all other styles, an <ol> tag is emitted, with any style attribute turned into the equivalent HTML type attribute.
<ol class="compact" type="I" start="18"> <li>Wheels on a big rig</li> </ol>
As shown in Section 8.2 this element is rendered as an HTML <div> tag with CSS class "org".
If the element contains the "ascii" attribute, the organization name is rendered twice, once with the non-ASCII version wrapped in an HTML <span> tag of class "non-ascii", then as the ASCII version wrapped in an HTML <span> tag of class "ascii" wrapped in parentheses.
<div class="org"> <span class="non-ascii">Test Org</span> (<span class="ascii">TEST ORG</span>) </div>
As shown in Section 8.2 this element is rendered as an HTML <div> containing the string "Phone:" (wrapped in a span), an HTML <a> tag with CSS class "tel" containing the phone number (and an href with a corresponding "tel:" URI) and an HTML <span> with CSS class "type" containing the string "VOICE".
<div> <span>Phone:</span> <a class="tel" href="tel:+1-720-555-1212">+1-720-555-1212</a> <span class="type">VOICE</span> </div>
This element renders as an HTML <div> with CSS class "adr", unless it contains one or more <postalLine> child elements; in which case it renders as an HTML <pre> with CSS class "label".
When there is no <postalLine> child, the following child elements are rendered into the HTML:
<div class="adr">
<div class="street-address">1 Main Street</div>
<div class="street-address">Suite 1</div>
<div>
<span class="city">Denver</span>,
<span class="region">CO</span>
<span class="postal-code">80212</span>
</div>
<div class="country-name">US</div>
</div>
This element renders as the text contained by the element, followed by a newline. However, the last <postalLine> in a given <postal> should not be followed by a newline. For example:
<postal> <postalLine>In care of:</postalLine> <postalLine>Computer Sciences Division</postalLine> </postal>
Would be rendered as:
<pre class="label">In care of: Computer Sciences Division</pre>
This element renders as an HTML <span> with CSS class "refcontent".
<span class="refContent">Self-published pamphlet</span>
If the parent of this element is not a <referencegroup>, this element will render as a <dt> <dd> pair, with the defined term being the reference "anchor" attribute surrounded by square brackets, and the definition including the correct set of bibliographic information as specified by [RFC7322]. The <dt> element will have an "id" attribute of the reference anchor.
<dl class="reference">
<dt id="RFC5646">[RFC5646]</dt>
<dd>
<span class="refAuthor">Phillips, A.</span>
<span>and</span>
<span class="refAuthor">M. Davis</span>
<span class="refTitle">"Tags for Identifying Languages"</span>,
...
</dd>
</dl>
If this element is the child of a <referencegroup>, this element renders as a <div> of class "refInstance", whose "id" attribute is the value of the source element's "anchor" attribute.
<div class="refInstance" id="RFC5730"> ... </div>
A <referencegroup> is translated into a <dt> <dd> pair, with the defined term being the referencegroup "anchor" attribute surrounded by square brackets, and the definition containing the translated output of all of the child <reference> elements.
<dt id="STD69">[STD69]</dt>
<dd>
<div class="refInstance" id="RFC5730">
<span class="refAuthor">Hollenbeck, S.</span>
...
</div>
<div class="refInstance" id="RFC5731">
<span class="refAuthor">Hollenbeck, S.</span>
...
</div>
...
</dd>
If there is at exactly one <references> element, a section is added to the document, continuing with the next section number after the last top-level <section> in <middle>. The <name> element of the <references> element is used as the section name.
<section id="n-my-references">
<h2 id="s-3">
<a href="#s-3" class="selfRef">3.</a>
<a href="#n-my-references class="selfRef">My References</a>
</h2>
...
</section>
If there is more than one <references> element, an HTML <section> element is created to contain a sub-section for each of the <references>. The section number will be the next section number after the last top-level <section> in <middle>. The name of this section will be "References", and it's "id" attribute will be "n-references".
<section id="n-references">
<h2 id="s-3">
<a href="#s-3" class="selfRef">3.</a>
<a href="#n-references" class="selfRef">References</a>
</h2>
<section id="n-informative-references">
<h3 id="s-3.1">
<a href="#s-3.1" class="selfRef">3.1.</a>
<a href="#n-informative-references" class="selfRef">
Informative References</a></h3>
<dl class="reference">...
</dl>
</section>
...
</section>
This element is rendered as a <span> tag with CSS class "region".
<span class="region">Colorado<span>
This element is rendered as an HTML <a> tag with CSS class "relref" and "href" attribute of the "derivedLink" attribute of the element. Different values of the "displayFormat" attribute cause the text inside that HTML <a> tag to change, as well as extra text to be generated. Some values of the "displayFormat" attribute also cause another HTML <a> tag to be rendered with CSS class "xref" and an "href" of "#" and the "target" attribute (modified by any applicable <displayreference> XML element) and text inside of the "target" attribute (modified by any applicable <displayreference> XML element). When used, this <a class='xref'> HTML tag is always surrounded by square brackets, like "[<a class='xref' href='#foo'>foo</a>]".
The output is an <a class='relref'> HTML tag, with contents of "Section " and the value of the "section" attribute. This is followed by the word "of" (surrounded by whitespace). This is followed by the <a class='xref'> HTML tag (surrounded by square brackets).
For example, with an input of:
See <relref section="2.3" target="RFC7878" displayFormat="of" derivedLink="http://www.rfc-editor.org/info/rfc7878#s-2.3"/> for an overview.
The HTML generated will be:
See <a class="relref" href="http://www.rfc-editor.org/info/rfc7878#s-2.3">Section 2.3</a> of [<a class="xref" href="#RFC7878">RFC7878</a>] for an overview.
The output is an <a class='xref'> HTML tag (wrapped by square brackets), followed by a comma (","), followed by whitespace, followed by an <a class='relref'> HTML tag, with contents of "Section " and the value of the "section" attribute.
For example, with an input of:
See <relref section="2.3" target="RFC7878" displayFormat="comma" derivedLink="http://www.rfc-editor.org/info/rfc7878#s-2.3"/>, for an overview.
The HTML generated will be:
See [<a class="xref" href="#RFC7878">RFC7878</a>], <a class="relref" href="http://www.rfc-editor.org/info/rfc7878#s-2.3">Section 2.3</a>, for an overview.
The output is an <a> element with "href" attribute whose value is the value of the "target" attribute prepended by "#", and whose content is the value of the "target" attribute; the entire element is wrapped in square brackets. This is followed by whitespace. This is followed by an <a> element whose "href" attribute is the value of the "derivedLink" attribute and whose content is the value of the "derivedRemoteContent" attribute; the entire element is wrapped in parentheses.
For example, if Section 2.3 of RFC 7878 has the title "Protocol Overview", for an input of:
See <relref section="2.3" target="RFC7878" displayFormat="parens" derivedLink="http://www.rfc-editor.org/info/rfc7878#s-2.3" derivedRemoteContent="Section 2.3"/> for an overview.
The HTML generated will be:
See [<a class="relref" href="#RFC7878">RFC7878</a>] (<a class="relref" href="http://www.rfc-editor.org/info/rfc7878#s-2.3">Section 2.3</a>) for an overview.
The output is an <a> element whose "href" attribute is the value of the "derivedLink" attribute and whose content is the value of the "derivedRemoteContent" attribute.
For this input:
See <relref section="2.3" target="RFC7878" displayFormat="bare" derivedLink="http://www.rfc-editor.org/info/rfc7878#s-2.3" derivedRemoteContent="Section 2.3"/> and ...
The HTML generated will be:
See <a class="relref" href="http://www.rfc-editor.org/info/rfc7878#s-2.3">Section 2.3</a> and ...
Various attributes of this element are represented in different parts of the HTML document.
This element is rendered as an HTML <section> element, containing an appropriate level HTML heading element (<h2>-<h6>). That heading element contains an <a> element around the part number (pn), if applicable (for instance, <abstract> does not get a section number). Another <a> element is included with the section's name.
<section id="intro">
<h2 id="s-1">
<a href="#s-1" class="selfRef">1.</a>
<a href="#intro" class="selfRef">Introduction</a>
</h2>
<p id="s-1-1">Paragraph <a href="#s-1-1" class="pilcrow">¶</a>
</p>
</section>
This element is rendered in an HTML <span> element with CSS name "seriesInfo".
<span class="seriesInfo">RFC 5646</span>
This element is rendered in an HTML <pre> with a CSS class of "sourcecode". Note that CDATA blocks do not work consistently in HTML, so all <, >, and & must be escaped as <, >, and &, respectively. If the input XML has a "type" attribute, another CSS class of "lang-" and the type is added.
If the sourcecode is not inside a <figure> element, a pilcrow [pilcrows] is included. Inside a <figure> element, the figure title serves the purpose of the pilcrow.
<pre class="sourcecode lang-c">
#include <stdio.h>
int main(void)
{
printf("hello, world\n");
return 0;
}
</pre>
This element renders as an HTML <div> with CSS class "street-address".
<div class="street-address">1899 Wynkoop St, Suite 600</div>
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
This element is rendered as an HTML <p> element. A pilcrow [pilcrows] is included.
<p id="s-1-1">A paragraph. <a href="#s-1-1" class="pilcrow">¶</a></p>
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
This element is directly rendered as its HTML counterpart.
The title of the document appears in an <title> element in the <head> element, as shown in Section 6.3.2.
The title also appears in an <h1> element, and follows directly after the Document Information. The <h1> element has an id attribute with value "title".
<h1 id="title">HyperText Markup Language Request For
Comments Format</h1>
Inside a reference, the title is rendered as an HTML <span> tag with CSS class "refTitle". The text is surrounded by quotes inside the <span>.
<span class="refTitle">"Tags for Identifying Languages"</span>
This element is directly rendered as its HTML counterpart.
This element is rendered as an HTML <code> element.
This element is directly rendered as its HTML counterpart. If the "spacing" attribute has the value "compact", a CSS class of "ulCompact" will be added. If the "empty" attribute has the value "true", a CSS class of "ulEmpty" will be added.
As shown in Section 8.2 this element is rendered as an HTML <div> containing the string "URI:" and an HTML <a> element, with "href" attribute set to the linked URI, CSS class of "url" [sic], and the contents set to the linked URI.
<div>URI:
<a href="http://www.example.com"
class="url">http://www.example.com</a>
</div>
This element does not add any direct output to HTML.
This element is rendered as an HTML <a> element containing an appropriate local link as the "href" attribute. The value of the "href" attribute is taken from the "target" attribute, prepended by "#". The <a> element generated will have class "xref". The contents of the <a> element are the value of the "derivedContent" attribute. If the "format" attribute has the value "default", and the "target" attribute points to a <reference> or <referencegroup> element, then the generated <a> element is surrounded by square brackets in the output.
<a class="xref" href="#target">Table 2</a>
or
[<a class="xref" href="#RFC1234">RFC1234</a>]
This element is rendered as part of the <artwork> element. The "xmlns='http://www.w3.org/2000/svg'" namespace declaration should be included, and the SVG should be serialized as well-formed XML, even for tags that would otherwise not need closing in HTML5.
This document contains no actions for IANA
Since RFCs are sometimes exchanged outside the normal Web sandboxing mechanism (such as using the "rsync" program to a mirror site) then loaded from a local file, more care must be taken with the HTML than is ordinary on the web.
Heather Flanangan was an early co-author of this document and helped its formation. The authors gratefully acknowledge the contributions of: Patrick Linskey, and the members of the RFC Format Design Team (Nevil Brownlee, Sandy Ginoza, Tony Hansen, Ted Lemon, Julian Reschke, Adam Roach, Alice Russo, Robert Sparks, Dave Thaler).
| [RFC2397] | Masinter, L., "The "data" URL scheme", RFC 2397, DOI 10.17487/RFC2397, August 1998. |
| [RFC3629] | Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 2003. |
| [RFC5646] | Phillips, A. and M. Davis, "Tags for Identifying Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, September 2009. |
| [RFC7322] | Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322, DOI 10.17487/RFC7322, September 2014. |
| [I-D.iab-rfc-css] | Flanagan, H., "CSS Requirements for RFCs", Internet-Draft draft-iab-rfc-css-00, January 2016. |
| [I-D.iab-xml2rfc] | Hoffman, P., "The "xml2rfc" version 3 Vocabulary", Internet-Draft draft-iab-xml2rfc-03, February 2016. |
| [W3C.REC-html5-20141028] | Hickson, I., Berjon, R., Faulkner, S., Leithead, T., Navara, E., O'Connor, E. and S. Pfeiffer, "HTML5", World Wide Web Consortium Recommendation REC-html5-20141028, October 2014. |
| [W3C.REC-CSS2-20110607] | Bos, B., Celik, T., Hickson, I. and H. Lie, "Cascading Style Sheets Level 2 Revision 1 (CSS 2.1) Specification", World Wide Web Consortium Recommendation REC-CSS2-20110607, June 2011. |
| [W3C.WD-css3-page-20130314] | Grant, M., Etemad, E., Lie, H. and S. Sapin, "CSS Paged Media Module Level 3", World Wide Web Consortium WD WD-css3-page-20130314, March 2013. |
| [HCARD] | Celik, T., "hCard 1.0", 2015. |
| [RFC6949] | Flanagan, H. and N. Brownlee, "RFC Series Format Requirements and Future Development", RFC 6949, DOI 10.17487/RFC6949, May 2013. |
| [I-D.iab-rfcv3-preptool] | Hoffman, P. and J. Hildebrand, "RFC v3 Prep Tool Description", Internet-Draft draft-iab-rfcv3-preptool-01, February 2016. |
| [I-D.iab-rfc-framework] | Flanagan, H., "RFC Format Framework", Internet-Draft draft-iab-rfc-framework-06, June 2016. |