HyperText Markup Language Request For Comments Format
draft-iab-html-rfc-00
The information below is for an old version of the document.
| Document | Type |
This is an older version of an Internet-Draft that was ultimately published as RFC 7992.
|
|
|---|---|---|---|
| Authors | Joe Hildebrand , Paul E. Hoffman | ||
| Last updated | 2016-01-08 | ||
| Replaces | draft-hildebrand-html-rfc | ||
| RFC stream | Internet Architecture Board (IAB) | ||
| Formats | |||
| Additional resources | |||
| Stream | IAB state | (None) | |
| Consensus boilerplate | Unknown | ||
| IAB shepherd | (None) |
draft-iab-html-rfc-00
quot;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>
...
Hildebrand & Hoffman Expires July 10, 2016 [Page 12]
Internet-Draft HTML RFC January 2016
7. Main Body
The main body of the HTML document is processed according to the
rules in Section 9.
8. Back Matter
The back matter of the HTML document includes an index (if
generated), information about the authors, and further information
about the document itself.
8.1. Index
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 a indexInclude attribute with the value "true", and there is one
or more <iref> elements in the document.
8.1.1. Index Contents
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>
...
8.1.2. Index Letters
The index index 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 index, as well as an href to itself. The <li> tag also
includes a <ul> tag that will contain the index items.
For example:
Hildebrand & Hoffman Expires July 10, 2016 [Page 13]
Internet-Draft HTML RFC January 2016
<ul>
<li class="indexChar">
<a href="#rfc.index.C" id="rfc.index.C">C</a>
<ul>
<!-- items go here -->
</ul>
</li>
...
8.1.3. Index Items
Each index item can have multiple <iref> elements to point to, all
with the same item attribute. Each index item is represented by a
<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, surrounded by a <span> tag with class
"comma".
For example:
<li class="indexItem">
<span class="irefItem">Bullets</span>
<span class="irefRefs">
<a class="indexPrimary" href="#s-Bullets-1">2</a>
<span class="comma">,</span>
<a href="#s-Bullets-2">2</a>
</span>
<!-- subitems go here -->
</li>
...
8.1.4. Index Sub-items
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:
Hildebrand & Hoffman Expires July 10, 2016 [Page 14]
Internet-Draft HTML RFC January 2016
<ul>
<li class="indexSubItem">
<span class="irefSubItem">Ordered</span>
<span class="irefRefs">
<a href="#s-Bullets-Ordered-1">2</a>
</span>
</li>
</ul>
...
8.2. Authors' Addresses
At the end of the document, author information will be included
inside an HTML <section> element. The class names have been chosen
to match the class names in [HCARD].
Note: The following example shows several ASCII equivalents that are
the same as their nominal equivalents for clarity; normally the ASCII
equivalents would not be included for these cases.
<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 class="ascii">Joe Hildebrand</span>
</span>
<span class="openParen">(</span>
<span class="role">editor</span>
<span class="closeParen">)</span>
</div>
<div class="org">
Cisco Systems, Inc. <span class="ascii">Cisco Systems,
Inc.</span>
</div>
<div class="adr">
<div class="street-address">1 Main Street</div>
<div class="street-address">Suite 1</div>
<div>
<span class="city">
Denver <span class="ascii">Denver</span>
</span>
<span class="comma">,</span>
<span class="region">CO</span>
Hildebrand & Hoffman Expires July 10, 2016 [Page 15]
Internet-Draft HTML RFC January 2016
<span class="postal-code">
80202 <span class="ascii">80202</span>
</span>
</div>
<div class="country-name">US</div>
</div>
<div>
<span>Phone:</span>
<span class="tel">+1-720-555-1212</span>
<span class="type">VOICE</span>
</div>
<div>
<span>Fax:</span>
<span class="tel">+1-303-555-1212</span>
<span class="type">fax</span>
</div>
<div>
<span>Email:</span>
<a class="email" href="mailto:jhildebr@example.com">
jhildebr@example.com
</a>
<span class="ascii">jhildebr@example.com</span>
</div>
<div>
<span>URI:</span>
<a class="url" href="http://www.example.com">
http://www.example.com
</a>
</div>
</address>
</section>
8.3. Document Information
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:
Hildebrand & Hoffman Expires July 10, 2016 [Page 16]
Internet-Draft HTML RFC January 2016
<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>
8.4. XML Source
At the very end of the document, the XML source that was used to
produce this document will be included within a comment. This
comment may be preceded by another comment that describes the source.
Any instances of "--" in the XML will be modified to use U+002D
characters: "--". Note that if the dashes in the original XML were
in a comment start- (<!--) or end-delimiter (-->), the XML will not
parse correctly without reversing this transformation.
<!-- XML SOURCE START (note: each instance of
two '-' (U+002D: HYPHEN-MINUS) characters
changed to "--") -->
<!--
<?xml version="1.0" encoding="utf-8"?>
<rfc>
<!-- A comment -->
9. Elements
This section describes how each of the XML elements from
[I-D.hoffman-xml2rfc] is rendered to HTML. Many of the descriptions
have examples to clarify how elements will be rendered.
9.1. <abstract>
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="p-abstract-1">This document defines...
<a href="#p-abstract-1" class="pilcrow">¶</a>
</p>
</section>
Hildebrand & Hoffman Expires July 10, 2016 [Page 17]
Internet-Draft HTML RFC January 2016
9.2. <address>
This element is used in Authors' Addresses (Section 8.2).
9.3. <annotation>
This element is rendered as 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. A
<span> of class "comma" is added before the annotation, containing
",".
<span class="comma">,</span>
<span class="annotation">
You <span class="bcp14">MUST</span> read this annotation.
</span>
9.4. <area>
Not currently rendered to HTML.
9.5. <artwork>
Artwork can either consist of inline text or SVG. If the artwork is
not inside a <figure> element, a pilcrow (Section 5.2) 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.
9.5.1. Text Artwork
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 do not work consistently in HTML, so all <, >, and
& must be escaped as <, >, and &, respectively.
The <div> element will have CSS classes of "artwork" and "art-"
prepended to the value of the <artwork> element's "type" attribute,
if it exists.
Hildebrand & Hoffman Expires July 10, 2016 [Page 18]
Internet-Draft HTML RFC January 2016
<figure id="f-1">
<div class="artwork art-ascii-art" id="p-2-52">
<pre>
______________
< hello, world >
--------------
\ ^__^
\ (oo)\_______
(__)\ )\/\
||----w |
|| ||
</pre>
</div>
<figcaption>
<a href="#f-1">Figure 1.</a>
<a class="selfRef" href="#n-it-figures" id="n-it-figures">
It figures
</a>
</figcaption>
</figure>
9.5.2. SVG Artwork
SVG artwork MUST be included inline. The SVG is wrapped in a <div>
element with CSS classes "artwork" and "art-svg".
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="p-2-17">
<svg width="100" height="100" xmlns="http://www.w3.org/2000/svg">
<circle
cx="50" cy="50" r="40"
stroke="green" stroke-width="4" fill="yellow" />
</svg>
<a href="#p-2-17" class="pilcrow">¶</a></pre>
</div>
9.5.3. Other Artwork
Other artwork will have a src attribute uses the "data" URI scheme
defined in [RFC2397]. Such artwork is rendered in an HTML image
element.
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.
Hildebrand & Hoffman Expires July 10, 2016 [Page 19]
Internet-Draft HTML RFC January 2016
<div class="artwork art-logo" id="p-2-58">
<img alt="IETF logo"
src="data:image/gif;charset=utf-8;base64,..."/>
<a class="pilcrow" href="#p-2-58">¶</a>
</div>
9.6. <aside>
This element is rendered as an HTML <aside> element, with all child
content appropriately transformed and a pilcrow (Section 5.2) added.
<aside id="p-1.2-6">A little more than kin, and less than kind.
<a href="#p-1.2-6" class="pilcrow">¶</a>
</aside>
9.7. <author>
9.7.1. Authors of this document
As seen in Authors' Addresses (Section 8.2), at the end of the
document, 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, each enclosed in a <span> with CSS
class "openParen" or "closeParen" as appropriate.
<address class="vcard">
<div class="nameRole">
<span class="fn">Joe Hildebrand</span>
<span class="openParen">(</span>
<span class="role">editor</span>
<span class="closeParen">)</span>
</div>
...
The <author> element from the <front> of the document is also
rendered into the Document Information (Section 6.4), the HTML meta
headers (Section 6.3.3), and in <references>. See each of those
sections for details.
Hildebrand & Hoffman Expires July 10, 2016 [Page 20]
Internet-Draft HTML RFC January 2016
9.7.2. Authors of references
In the output generated from a reference element, author tags are
rendered inside an HTML <span> element with CSS class "refAuthor".
9.8. <back>
This element does not add any direct output to HTML.
9.9. <bcp14>
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.
9.10. <blockquote>
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 get a pilcrow
(Section 5.2), a pilcrow is added.
Note that the "--" at the begining of the <cite> element should be a
proper emdash, which is difficult to show in the current format of
this format.
<blockquote id="p-1.2-1"
cite="http://...">
<p id="p-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="#p-1.2-2" class="pilcrow">¶</a>
</p>
<cite>-- <a href="http://...">Abraham Lincoln</a></cite>
</blockquote>
9.11. <boilerplate>
The IPR boilerplate for the document appears directly after the
Abstract. The children of the input <boilerplate> element are
treated similarly to sections.
Hildebrand & Hoffman Expires July 10, 2016 [Page 21]
Internet-Draft HTML RFC January 2016
<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="p-boilerplate-1-1">This Internet-Draft is submitted in full
conformance with the provisions of BCP 78 and BCP 79.
<a href="#p-boilerplate-1-1" class="pilcrow">¶</a>
</p>
...
9.12. <br>
This element is directly rendered as its HTML counterpart.
9.13. <city>
This element is rendered as a <span> element with CSS class
"locality".
<span class="locality">Guilford</span>
9.14. <code>
This element is rendered as a <span> element with CSS class "postal-
code".
<span class="postal-code">GU16 7HF<span>
9.15. <country>
This element is rendered as a <div> element with CSS class "country-
name".
<div class="country-name">England</div>
9.16. <cref>
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>
Hildebrand & Hoffman Expires July 10, 2016 [Page 22]
Internet-Draft HTML RFC January 2016
9.17. <date>
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>
9.18. <dd>
This element is directly rendered as its HTML counterpart.
9.19. <displayreference>
Does not effect the HTML output. The prep tool
([I-D.hoffman-rfcv3-preptool]) will have already used this element to
generate the <xref>'s "derivedContent" attribute.
9.20. <dl>
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.
9.21. <dt>
This element is directly rendered as its HTML counterpart.
9.22. <em>
This element is directly rendered as its HTML counterpart.
9.23. <email>
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.
Hildebrand & Hoffman Expires July 10, 2016 [Page 23]
Internet-Draft HTML RFC January 2016
If the email contains an ascii attribute, a span of class ascii is
also contained in the div.
<div>
<span>Email:</span>
<a href="mailto:joe@example.net" class="email">joe@example.net</a>
<span class="ascii">joe@example.net</span>
</div>
9.24. <eref>
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>
9.25. <figure>
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 with CSS class "selfRef"
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" class="selfRef">Figure 1.</a>
<a href="#n-it-figures" class="selfRef">It figures</a>
</figcaption>
</figure>
9.26. <front>
This element does not add any direct output to HTML.
9.27. <iref>
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"/>
Hildebrand & Hoffman Expires July 10, 2016 [Page 24]
Internet-Draft HTML RFC January 2016
9.28. <keyword>
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">
9.29. <li>
This element is rendered as its HTML counterpart, however if there is
no contained element that had a pilcrow (Section 5.2) attached, a
pilcrow is added.
<li id="p-2-7">Item <a href="#p-2-7" class="pilcrow">¶</a></li>
9.30. <link>
This element is rendered as its HTML counterpart, in the HTML header.
9.31. <middle>
This element does not add any direct output to HTML.
9.32. <name>
This element is never rendered directly, but instead when considering
its parent element, such as <section>.
9.33. <note>
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="p-note-1-1">
Discussion of this draft takes place...
<a href="#p-note-1-1" class="pilcrow">¶</a>
</p>
</section>
Hildebrand & Hoffman Expires July 10, 2016 [Page 25]
Internet-Draft HTML RFC January 2016
9.34. <ol>
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.
9.34.1. Percent styles
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>
9.34.2. Standard styles
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>
9.35. <organization>
As shown in Section 8.2 this element is rendered as an HTML <div> tag
with CSS class "org".
<div class="org">Cisco Systems, Inc.</div>
9.36. <phone>
As shown in Section 8.2 this element is rendered as an HTML <div>
containing the string "Phone:" (wrapped in a span), an HTML <span>
with CSS class "tel" containing the phone number and an HTML <span>
with CSS class "type" containing the string "VOICE".
Hildebrand & Hoffman Expires July 10, 2016 [Page 26]
Internet-Draft HTML RFC January 2016
<div>
<span>Phone:</span>
<span class="tel">+1-720-555-1212</span>
<span class="type">VOICE</span>
</div>
9.37. <postal>
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:
o Each <street> is rendered
o A <div> that includes:
* The rendering of all <city> elements
* A comma (wrapped in a span of class "comma")
* The rendering of all <region> elements
* Whitespace
* The rendering of all <code> elements
o The rendering of all <country> elements
<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="comma">,</span>
<span class="region">CO</span>
<span class="postal-code">80212</span>
</div>
<div class="country-name">US</div>
</div>
9.38. <postalLine>
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:
Hildebrand & Hoffman Expires July 10, 2016 [Page 27]
Internet-Draft HTML RFC January 2016
<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>
9.39. <refcontent>
This element renders as an HTML <span> with CSS class "refcontent".
<span class="refContent">Self-published pamphlet</span>
9.40. <reference>
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>
<span class="comma">,</span>
...
<span class="fullStop">.</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>
Hildebrand & Hoffman Expires July 10, 2016 [Page 28]
Internet-Draft HTML RFC January 2016
9.41. <referencegroup>
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>
9.42. <references>
If there is at least one <references> element, a "References" section
is added to the document, continuing with the next major section
number after the last <section>.
Each references element will be added to that "References" section as
if it were a section itself.
<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>
Hildebrand & Hoffman Expires July 10, 2016 [Page 29]
Internet-Draft HTML RFC January 2016
9.43. <region>
This element is rendered as a <span> element with CSS class "region".
<span class="region">Colorado<span>
9.44. <relref>
This element is rendered as one or more HTML <a> elements containing
appropriate external links as their "href" attributes as well as
(potentially) some connective text. All of the <a> elements
generated will have class "relref". The contents of the <a>
element(s) are determined by the values of the "derivedRemoteContent"
and "displayFormat" attributes.
9.44.1. displayFormat='of'
The output is an <a> element with "href" attribute whose value is the
value of the "derivedLink" attribute, and whose contents are the
value of the "derivedRemoteContent" attribute. This is followed by
the word "of" (surrounded by whitespace). This is followed by a
second <a> element, surrounded by square brackets, whose href
attribute is the value of the "target" attribute prepended with "#",
and whose content is the value of the "target" attribute.
For example, if Section 2.3 of RFC 7878 has the title "Protocol
Overview", with an input of:
See <relref section="2.3" target="RFC7878" displayFormat="of"
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="http://www.rfc-editor.org/info/rfc7878#s-2.3">Section
2.3</a> of [<a class="relref" href="#RFC7878">RFC7878</a>]
for an overview.
9.44.2. displayFormat='comma'
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 a comma (","), 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.
Hildebrand & Hoffman Expires July 10, 2016 [Page 30]
Internet-Draft HTML RFC January 2016
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="comma"
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.
9.44.3. displayFormat='parens'
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.
9.44.4. displayFormat='bare'
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:
Hildebrand & Hoffman Expires July 10, 2016 [Page 31]
Internet-Draft HTML RFC January 2016
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 ...
9.45. <rfc>
Various attributes of this element are represented in different parts
of the HTML document.
9.46. <section>
This element is rendered as an HTML <section> element, containing an
appropriate level HTML heading element (<h2>-<h6>). That heading
element contains a <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="p-1-1">Paragraph <a href="#p-1-1" class="pilcrow">¶</a>
</p>
</section>
9.47. <seriesInfo>
This element is rendered in an HTML <span> element with CSS name
"seriesInfo".
<span class="seriesInfo">RFC 5646</span>
9.48. <sourcecode>
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.
Hildebrand & Hoffman Expires July 10, 2016 [Page 32]
Internet-Draft HTML RFC January 2016
If the sourcecode is not inside a <figure> element, a pilcrow
(Section 5.2) 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>
9.49. <street>
This element renders as an HTML <div> with CSS class "street-
address".
<div class="street-address">1899 Wynkoop St, Suite 600</div>
9.50. <strong>
This element is directly rendered as its HTML counterpart.
9.51. <sub>
This element is directly rendered as its HTML counterpart.
9.52. <sup>
This element is directly rendered as its HTML counterpart.
9.53. <svg>
This element is rendered as part of the <artwork> element.
9.54. <t>
This element is rendered as an HTML <p> element. A pilcrow
(Section 5.2) is included.
<p id="p-1-1">A paragraph.
<a href="#p-1-1" class="pilcrow">¶</a></p>
Hildebrand & Hoffman Expires July 10, 2016 [Page 33]
Internet-Draft HTML RFC January 2016
9.55. <table>
This element is directly rendered as its HTML counterpart.
9.56. <tbody>
This element is directly rendered as its HTML counterpart.
9.57. <td>
This element is directly rendered as its HTML counterpart.
9.58. <tfoot>
This element is directly rendered as its HTML counterpart.
9.59. <th>
This element is directly rendered as its HTML counterpart.
9.60. <thead>
This element is directly rendered as its HTML counterpart.
9.61. <title>
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>
9.62. <tr>
This element is directly rendered as its HTML counterpart.
Hildebrand & Hoffman Expires July 10, 2016 [Page 34]
Internet-Draft HTML RFC January 2016
9.63. <tt>
This element is directly rendered as its HTML counterpart.
9.64. <ul>
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", as CSS class of "ulEmpty" will be added.
9.65. <uri>
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>
9.66. <workgroup>
This element does not add any direct output to HTML.
9.67. <xref>
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>]
Hildebrand & Hoffman Expires July 10, 2016 [Page 35]
Internet-Draft HTML RFC January 2016
10. IANA Considerations
This document contains no actions for IANA
11. Security Considerations
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.
12. Acknowledgments
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).
13. References
13.1. Normative References
[RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397,
DOI 10.17487/RFC2397, August 1998,
<http://www.rfc-editor.org/info/rfc2397>.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November
2003, <http://www.rfc-editor.org/info/rfc3629>.
[RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying
Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646,
September 2009, <http://www.rfc-editor.org/info/rfc5646>.
[I-D.hoffman-xml2rfc]
Hoffman, P., "The 'XML2RFC' version 3 Vocabulary", draft-
hoffman-xml2rfc-23 (work in progress), September 2015.
[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,
<http://www.w3.org/TR/2014/REC-html5-20141028>.
Hildebrand & Hoffman Expires July 10, 2016 [Page 36]
Internet-Draft HTML RFC January 2016
[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,
<http://www.w3.org/TR/2011/REC-CSS2-20110607>.
13.2. Informative References
[HCARD] Celik, T., "hCard 1.0", 2015,
<http://microformats.org/wiki/hcard>.
[RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format
Requirements and Future Development", RFC 6949,
DOI 10.17487/RFC6949, May 2013,
<http://www.rfc-editor.org/info/rfc6949>.
[RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322,
DOI 10.17487/RFC7322, September 2014,
<http://www.rfc-editor.org/info/rfc7322>.
[I-D.hoffman-rfcv3-preptool]
Hoffman, P. and J. Hildebrand, "RFC v3 Prep Tool
Description", draft-hoffman-rfcv3-preptool-06 (work in
progress), September 2015.
[I-D.iab-rfc-framework]
Flanagan, H., "RFC Format Framework", draft-iab-rfc-
framework-00 (work in progress), January 2016.
Authors' Addresses
Joe Hildebrand (editor)
Cisco Systems, Inc.
Email: jhildebr@cisco.com
Paul Hoffman
ICANN
Email: paul.hoffman@icann.org
Hildebrand & Hoffman Expires July 10, 2016 [Page 37]