draft-iab-html-rfc-01.txt   draft-iab-html-rfc-02.txt 
Network Working Group J. Hildebrand, Ed. Network Working Group J. Hildebrand, Ed.
Internet-Draft Cisco Systems, Inc. Internet-Draft Cisco Systems, Inc.
Intended status: Informational P. Hoffman Intended status: Informational P. Hoffman
Expires: July 15, 2016 ICANN Expires: August 5, 2016 ICANN
January 12, 2016 February 2, 2016
HyperText Markup Language Request For Comments Format HyperText Markup Language Request For Comments Format
draft-iab-html-rfc-01 draft-iab-html-rfc-02
Abstract Abstract
In order to meet the evolving needs of the Internet community, the 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 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 canonical XML format that will in turn be rendered into several
publication formats. This document defines the HTML format that will publication formats. This document defines the HTML format that will
be rendered for an RFC or Internet-Draft. be rendered for an RFC or Internet-Draft.
Status of This Memo Status of This Memo
skipping to change at page 1, line 35 skipping to change at page 1, line 35
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 15, 2016. This Internet-Draft will expire on August 5, 2016.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 25 skipping to change at page 2, line 25
5.1. IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.1. IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.2. Pilcrows . . . . . . . . . . . . . . . . . . . . . . . . 8 5.2. Pilcrows . . . . . . . . . . . . . . . . . . . . . . . . 8
5.3. ASCII Equivalents . . . . . . . . . . . . . . . . . . . . 9 5.3. ASCII Equivalents . . . . . . . . . . . . . . . . . . . . 9
5.4. Syntactic Elements . . . . . . . . . . . . . . . . . . . 9 5.4. Syntactic Elements . . . . . . . . . . . . . . . . . . . 9
6. Front Matter . . . . . . . . . . . . . . . . . . . . . . . . 9 6. Front Matter . . . . . . . . . . . . . . . . . . . . . . . . 9
6.1. DOCTYPE . . . . . . . . . . . . . . . . . . . . . . . . . 9 6.1. DOCTYPE . . . . . . . . . . . . . . . . . . . . . . . . . 9
6.2. Root Element . . . . . . . . . . . . . . . . . . . . . . 10 6.2. Root Element . . . . . . . . . . . . . . . . . . . . . . 10
6.3. Head Element . . . . . . . . . . . . . . . . . . . . . . 10 6.3. Head Element . . . . . . . . . . . . . . . . . . . . . . 10
6.3.1. Charset Declaration . . . . . . . . . . . . . . . . . 10 6.3.1. Charset Declaration . . . . . . . . . . . . . . . . . 10
6.3.2. Document Title . . . . . . . . . . . . . . . . . . . 10 6.3.2. Document Title . . . . . . . . . . . . . . . . . . . 10
6.3.3. Document metadata . . . . . . . . . . . . . . . . . . 10 6.3.3. Document Metadata . . . . . . . . . . . . . . . . . . 10
6.3.4. Style . . . . . . . . . . . . . . . . . . . . . . . . 11 6.3.4. Link to XML source . . . . . . . . . . . . . . . . . 11
6.3.5. Links . . . . . . . . . . . . . . . . . . . . . . . . 11 6.3.5. Link to License . . . . . . . . . . . . . . . . . . . 11
6.4. Document Information . . . . . . . . . . . . . . . . . . 11 6.3.6. Style . . . . . . . . . . . . . . . . . . . . . . . . 11
6.3.7. Links . . . . . . . . . . . . . . . . . . . . . . . . 12
6.4. Document Information . . . . . . . . . . . . . . . . . . 12
6.5. Table of Contents . . . . . . . . . . . . . . . . . . . . 12 6.5. Table of Contents . . . . . . . . . . . . . . . . . . . . 12
7. Main Body . . . . . . . . . . . . . . . . . . . . . . . . . . 13 7. Main Body . . . . . . . . . . . . . . . . . . . . . . . . . . 13
8. Back Matter . . . . . . . . . . . . . . . . . . . . . . . . . 13 8. Back Matter . . . . . . . . . . . . . . . . . . . . . . . . . 13
8.1. Index . . . . . . . . . . . . . . . . . . . . . . . . . . 13 8.1. Index . . . . . . . . . . . . . . . . . . . . . . . . . . 13
8.1.1. Index Contents . . . . . . . . . . . . . . . . . . . 13 8.1.1. Index Contents . . . . . . . . . . . . . . . . . . . 13
8.1.2. Index Letters . . . . . . . . . . . . . . . . . . . . 13 8.1.2. Index Letters . . . . . . . . . . . . . . . . . . . . 14
8.1.3. Index Items . . . . . . . . . . . . . . . . . . . . . 14 8.1.3. Index Items . . . . . . . . . . . . . . . . . . . . . 14
8.1.4. Index Sub-items . . . . . . . . . . . . . . . . . . . 14 8.1.4. Index Sub-items . . . . . . . . . . . . . . . . . . . 15
8.2. Authors' Addresses . . . . . . . . . . . . . . . . . . . 15 8.2. Authors' Addresses . . . . . . . . . . . . . . . . . . . 15
8.3. Document Information . . . . . . . . . . . . . . . . . . 16 8.3. Document Information . . . . . . . . . . . . . . . . . . 16
8.4. XML Source . . . . . . . . . . . . . . . . . . . . . . . 17
9. Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 17 9. Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 17
9.1. <abstract> . . . . . . . . . . . . . . . . . . . . . . . 17 9.1. <abstract> . . . . . . . . . . . . . . . . . . . . . . . 17
9.2. <address> . . . . . . . . . . . . . . . . . . . . . . . . 18 9.2. <address> . . . . . . . . . . . . . . . . . . . . . . . . 17
9.3. <annotation> . . . . . . . . . . . . . . . . . . . . . . 18 9.3. <annotation> . . . . . . . . . . . . . . . . . . . . . . 17
9.4. <area> . . . . . . . . . . . . . . . . . . . . . . . . . 18 9.4. <area> . . . . . . . . . . . . . . . . . . . . . . . . . 18
9.5. <artwork> . . . . . . . . . . . . . . . . . . . . . . . . 18 9.5. <artwork> . . . . . . . . . . . . . . . . . . . . . . . . 18
9.5.1. Text Artwork . . . . . . . . . . . . . . . . . . . . 18 9.5.1. Text Artwork . . . . . . . . . . . . . . . . . . . . 18
9.5.2. SVG Artwork . . . . . . . . . . . . . . . . . . . . . 19 9.5.2. SVG Artwork . . . . . . . . . . . . . . . . . . . . . 19
9.5.3. Other Artwork . . . . . . . . . . . . . . . . . . . . 19 9.5.3. Other Artwork . . . . . . . . . . . . . . . . . . . . 19
9.6. <aside> . . . . . . . . . . . . . . . . . . . . . . . . . 20 9.6. <aside> . . . . . . . . . . . . . . . . . . . . . . . . . 20
9.7. <author> . . . . . . . . . . . . . . . . . . . . . . . . 20 9.7. <author> . . . . . . . . . . . . . . . . . . . . . . . . 20
9.7.1. Authors of this document . . . . . . . . . . . . . . 20 9.7.1. Authors of this document . . . . . . . . . . . . . . 20
9.7.2. Authors of references . . . . . . . . . . . . . . . . 21 9.7.2. Authors of references . . . . . . . . . . . . . . . . 21
9.8. <back> . . . . . . . . . . . . . . . . . . . . . . . . . 21 9.8. <back> . . . . . . . . . . . . . . . . . . . . . . . . . 21
skipping to change at page 5, line 44 skipping to change at page 5, line 44
o The HTML must display adequately in at least one text-based o The HTML must display adequately in at least one text-based
browser. Some consumers of the RFC series can only access the browser. Some consumers of the RFC series can only access the
series on text-based terminals. series on text-based terminals.
o The HTML document will be self-contained, without requiring o The HTML document will be self-contained, without requiring
external files for images, CSS, JavaScript, or the like. This external files for images, CSS, JavaScript, or the like. This
will allow the HTML file to be moved over various non-HTTP will allow the HTML file to be moved over various non-HTTP
transports (such as e-mail, FTP, and rsync) without breakage. transports (such as e-mail, FTP, and rsync) without breakage.
o Any use of JavaScript in the HTML document must not be required o JavaScript will be supported on a limited basis. It will not be
for comprehensive reading of the document, because some consumers permitted to overwrite or change any text present in the rendered
of the RFC series routinely disable JavaScript for security html. It may, on a limited basis, add additional text that
purposes. provides post-publication metadata or pointers if warranted. All
such text will be clearly marked as additional.
o The HTML document will allow easy local override of the default o The HTML document will allow easy local override of the default
CSS formatting. This will allow users who have a different visual CSS formatting. This will allow users who have a different visual
style that they prefer to make RFCs display with that style style that they prefer to make RFCs display with that style
without having to alter the contents of the HTML document. This without having to alter the contents of the HTML document. This
might also be valuable for allowing people with specific might also be valuable for allowing people with specific
accessibility needs to use a customized CSS. accessibility needs to use a customized CSS.
o HTML tags in documents will rarely have attributes whose only o HTML tags in documents will rarely have attributes whose only
purpose is to affect the rendered styling, and those will only be purpose is to affect the rendered styling, and those will only be
skipping to change at page 10, line 38 skipping to change at page 10, line 38
HTML <head> element contains a <meta> element, with charset attribute HTML <head> element contains a <meta> element, with charset attribute
with value "utf-8": with value "utf-8":
<meta charset="utf-8"> <meta charset="utf-8">
6.3.2. Document Title 6.3.2. Document Title
The contents of the <title> element from the XML source will be The contents of the <title> element from the XML source will be
placed inside an HTML <title> element in the header. placed inside an HTML <title> element in the header.
6.3.3. Document metadata 6.3.3. Document Metadata
The following <meta> elements will be included: The following <meta> elements will be included:
o author - comma-separated "fullname"s and "asciiFullname"s of all o author - comma-separated "fullname"s and "asciiFullname"s of all
of the <author>s from the <front> of the XML source of the <author>s from the <front> of the XML source
o description - the <abstract> from the XML source o description - the <abstract> from the XML source
o generator - the name and version number of the software used to o generator - the name and version number of the software used to
create the HTML create the HTML
skipping to change at page 11, line 12 skipping to change at page 11, line 12
For example: For example:
<meta name="author" content="Joe Hildebrand,Heather Flanagan"> <meta name="author" content="Joe Hildebrand,Heather Flanagan">
<meta name="description" content="This document defines..."> <meta name="description" content="This document defines...">
<meta name="generator" content="xmljade v0.2.4"> <meta name="generator" content="xmljade v0.2.4">
<meta name="keywords" content="html,css,rfc"> <meta name="keywords" content="html,css,rfc">
Note: the HTML <meta> tag does not contain a closing slash. Note: the HTML <meta> tag does not contain a closing slash.
6.3.4. Style 6.3.4. Link to XML source
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">
6.3.5. Link to License
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/">
6.3.6. Style
The <head> element contains an embedded CSS style sheet in a <style> The <head> element contains an embedded CSS style sheet in a <style>
element. The styles in the style sheet are to be set consistently element. The styles in the style sheet are to be set consistently
between documents by the RFC Editor, according to the best practices between documents by the RFC Editor, according to the best practices
of the day. of the day.
To ensure consistent formatting, individual style attributes should To ensure consistent formatting, individual style attributes should
not be used in the main portion of the document. not be used in the main portion of the document.
Different readers of a specification will desire different formatting Different readers of a specification will desire different formatting
skipping to change at page 11, line 35 skipping to change at page 12, line 5
directory as the HTML file, named "rfc-local.css". Any formatting in directory as the HTML file, named "rfc-local.css". Any formatting in
the linked style sheet will override the formatting in the included the linked style sheet will override the formatting in the included
style sheet. For example: style sheet. For example:
<style> <style>
body {} body {}
... ...
</style> </style>
<link rel="stylesheet" type="text/css" href="rfc-local.css"> <link rel="stylesheet" type="text/css" href="rfc-local.css">
6.3.5. Links 6.3.7. Links
Each <link> element from the XML source is copied into the HTML Each <link> element from the XML source is copied into the HTML
header. Note: the HTML <link> element does not include a closing header. Note: the HTML <link> element does not include a closing
slash. slash.
6.4. Document Information 6.4. Document Information
Information about the document as a whole will appear as the first Information about the document as a whole will appear as the first
child of the HTML <body> element, embedded in an HTML <dl> element child of the HTML <body> element, embedded in an HTML <dl> element
with id="identifiers". The defined terms in the definition list are with id="identifiers". The defined terms in the definition list are
skipping to change at page 17, line 16 skipping to change at page 17, line 22
<span class="finalized"> <span class="finalized">
Finalized: <time Finalized: <time
datetime="2015-04-29T18:59:08Z">2015-04-29T18:59:08Z</time> datetime="2015-04-29T18:59:08Z">2015-04-29T18:59:08Z</time>
</span> </span>
<span class="rendered"> <span class="rendered">
Rendered: <time Rendered: <time
datetime="2015-04-29T18:59:10Z">2015-04-29T18:59:10Z</time> datetime="2015-04-29T18:59:10Z">2015-04-29T18:59:10Z</time>
</span> </span>
</div> </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.
Since the sequence "--" is invalid in an HTML comment, any instances
of "--" in the input XML will be modified to use the escaped form of
the HYPHEN-MINUS characters: "&#x2d;&#x2d;". 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 before parsing.
<!-- XML SOURCE START (note: each instance of
two '-' (U+002D: HYPHEN-MINUS) characters
changed to "&#x2d;&#x2d;") -->
<!--
<?xml version="1.0" encoding="utf-8"?>
<rfc>
<!&#x2d;&#x2d; A comment &#x2d;&#x2d;>
9. Elements 9. Elements
This section describes how each of the XML elements from This section describes how each of the XML elements from
[I-D.iab-xml2rfc] is rendered to HTML. Many of the descriptions have [I-D.iab-xml2rfc] is rendered to HTML. Many of the descriptions have
examples to clarify how elements will be rendered. examples to clarify how elements will be rendered.
9.1. <abstract> 9.1. <abstract>
The abstract is rendered similarly to a <section> with The abstract is rendered similarly to a <section> with
anchor="abstract" and <name>Abstract</name>, but without a section anchor="abstract" and <name>Abstract</name>, but without a section
skipping to change at page 36, line 45 skipping to change at page 36, line 45
[RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying
Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646,
September 2009, <http://www.rfc-editor.org/info/rfc5646>. September 2009, <http://www.rfc-editor.org/info/rfc5646>.
[I-D.iab-rfc-css] [I-D.iab-rfc-css]
Flanagan, H., "CSS Requirements for RFCs", draft-iab-rfc- Flanagan, H., "CSS Requirements for RFCs", draft-iab-rfc-
css-00 (work in progress), January 2016. css-00 (work in progress), January 2016.
[I-D.iab-xml2rfc] [I-D.iab-xml2rfc]
Hoffman, P., "The 'XML2RFC' version 3 Vocabulary", draft- Hoffman, P., "The "xml2rfc" version 3 Vocabulary", draft-
iab-xml2rfc-00 (work in progress), December 2015. iab-xml2rfc-02 (work in progress), January 2016.
[W3C.REC-html5-20141028] [W3C.REC-html5-20141028]
Hickson, I., Berjon, R., Faulkner, S., Leithead, T., Hickson, I., Berjon, R., Faulkner, S., Leithead, T.,
Navara, E., O&#039;Connor, E., and S. Pfeiffer, "HTML5", Navara, E., O&#039;Connor, E., and S. Pfeiffer, "HTML5",
World Wide Web Consortium Recommendation REC- World Wide Web Consortium Recommendation REC-
html5-20141028, October 2014, html5-20141028, October 2014,
<http://www.w3.org/TR/2014/REC-html5-20141028>. <http://www.w3.org/TR/2014/REC-html5-20141028>.
[W3C.REC-CSS2-20110607] [W3C.REC-CSS2-20110607]
Bos, B., Celik, T., Hickson, I., and H. Lie, "Cascading Bos, B., Celik, T., Hickson, I., and H. Lie, "Cascading
skipping to change at page 37, line 40 skipping to change at page 37, line 40
DOI 10.17487/RFC7322, September 2014, DOI 10.17487/RFC7322, September 2014,
<http://www.rfc-editor.org/info/rfc7322>. <http://www.rfc-editor.org/info/rfc7322>.
[I-D.iab-rfcv3-preptool] [I-D.iab-rfcv3-preptool]
Hoffman, P. and J. Hildebrand, "RFC v3 Prep Tool Hoffman, P. and J. Hildebrand, "RFC v3 Prep Tool
Description", draft-iab-rfcv3-preptool-00 (work in Description", draft-iab-rfcv3-preptool-00 (work in
progress), January 2016. progress), January 2016.
[I-D.iab-rfc-framework] [I-D.iab-rfc-framework]
Flanagan, H., "RFC Format Framework", draft-iab-rfc- Flanagan, H., "RFC Format Framework", draft-iab-rfc-
framework-00 (work in progress), January 2016. framework-01 (work in progress), January 2016.
Authors' Addresses Authors' Addresses
Joe Hildebrand (editor) Joe Hildebrand (editor)
Cisco Systems, Inc. Cisco Systems, Inc.
Email: jhildebr@cisco.com Email: jhildebr@cisco.com
Paul Hoffman Paul Hoffman
ICANN ICANN
 End of changes. 15 change blocks. 
44 lines changed or deleted 42 lines changed or added

This html diff was produced by rfcdiff 1.42. The latest version is available from http://tools.ietf.org/tools/rfcdiff/