Tech-invite3GPPspaceIETFspace
959493929190898887868584838281807978777675747372717069686766656463626160595857565554535251504948474645444342414039383736353433323130292827262524232221201918171615141312111009080706050403020100
in Index   Prev   Next

RFC 7992

HTML Format for RFCs

Pages: 43
Informational
Part 1 of 2 – Pages 1 to 18
None   None   Next

Top   ToC   RFC7992 - Page 1
Internet Architecture Board (IAB)                     J. Hildebrand, Ed.
Request for Comments: 7992                                       Mozilla
Category: Informational                                       P. Hoffman
ISSN: 2070-1721                                                    ICANN
                                                           December 2016


                          HTML Format for RFCs

Abstract

In order to meet the evolving needs of the Internet community, the canonical format for RFCs is changing from a plain-text, ASCII-only format to an 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. Status of This Memo This document is not an Internet Standards Track specification; it is published for informational purposes. This document is a product of the Internet Architecture Board (IAB) and represents information that the IAB has deemed valuable to provide for permanent record. It represents the consensus of the Internet Architecture Board (IAB). Documents approved for publication by the IAB are not a candidate for any level of Internet Standard; see Section 2 of RFC 7841. Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc7992. Copyright Notice 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.
Top   ToC   RFC7992 - Page 2

Table of Contents

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Requirements for the HTML Format . . . . . . . . . . . . . . 5 2.1. Requirements for Accessibility . . . . . . . . . . . . . 6 3. HTML Version . . . . . . . . . . . . . . . . . . . . . . . . 7 4. HTML Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 7 5. Common Items . . . . . . . . . . . . . . . . . . . . . . . . 8 5.1. IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.2. Pilcrows . . . . . . . . . . . . . . . . . . . . . . . . 8 6. Front Matter . . . . . . . . . . . . . . . . . . . . . . . . 9 6.1. DOCTYPE . . . . . . . . . . . . . . . . . . . . . . . . . 9 6.2. Root Element . . . . . . . . . . . . . . . . . . . . . . 9 6.3. <head> Element . . . . . . . . . . . . . . . . . . . . . 9 6.3.1. Charset Declaration . . . . . . . . . . . . . . . . . 9 6.3.2. Document Title . . . . . . . . . . . . . . . . . . . 10 6.3.3. Document Metadata . . . . . . . . . . . . . . . . . . 10 6.3.4. Link to XML Source . . . . . . . . . . . . . . . . . 10 6.3.5. Link to License . . . . . . . . . . . . . . . . . . . 10 6.3.6. Style . . . . . . . . . . . . . . . . . . . . . . . . 11 6.3.7. Links . . . . . . . . . . . . . . . . . . . . . . . . 11 6.4. Page Headers and Footers . . . . . . . . . . . . . . . . 12 6.5. Document Information . . . . . . . . . . . . . . . . . . 13 6.6. Table of Contents . . . . . . . . . . . . . . . . . . . . 14 7. Main Body . . . . . . . . . . . . . . . . . . . . . . . . . . 14 8. Back Matter . . . . . . . . . . . . . . . . . . . . . . . . . 14 8.1. Index . . . . . . . . . . . . . . . . . . . . . . . . . . 14 8.1.1. Index Contents . . . . . . . . . . . . . . . . . . . 15 8.1.2. Index Letters . . . . . . . . . . . . . . . . . . . . 15 8.1.3. Index Items . . . . . . . . . . . . . . . . . . . . . 16 8.1.4. Index Subitems . . . . . . . . . . . . . . . . . . . 16 8.2. Authors' Addresses Section . . . . . . . . . . . . . . . 17 8.3. Document Information . . . . . . . . . . . . . . . . . . 18 9. Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 18 9.1. <abstract> . . . . . . . . . . . . . . . . . . . . . . . 18 9.2. <address> . . . . . . . . . . . . . . . . . . . . . . . . 19 9.3. <annotation> . . . . . . . . . . . . . . . . . . . . . . 19 9.4. <area> . . . . . . . . . . . . . . . . . . . . . . . . . 19 9.5. <artwork> . . . . . . . . . . . . . . . . . . . . . . . . 20 9.5.1. Text Artwork . . . . . . . . . . . . . . . . . . . . 20 9.5.2. SVG Artwork . . . . . . . . . . . . . . . . . . . . . 20 9.5.3. Other Artwork . . . . . . . . . . . . . . . . . . . . 21 9.6. <aside> . . . . . . . . . . . . . . . . . . . . . . . . . 21 9.7. <author> . . . . . . . . . . . . . . . . . . . . . . . . 21 9.7.1. Authors in Document Information . . . . . . . . . . . 22 9.7.2. Authors of This Document . . . . . . . . . . . . . . 22 9.7.3. Authors of References . . . . . . . . . . . . . . . . 24 9.8. <back> . . . . . . . . . . . . . . . . . . . . . . . . . 24
Top   ToC   RFC7992 - Page 3
     9.9.  <bcp14> . . . . . . . . . . . . . . . . . . . . . . . . .  25
     9.10. <blockquote>  . . . . . . . . . . . . . . . . . . . . . .  25
     9.11. <boilerplate> . . . . . . . . . . . . . . . . . . . . . .  26
     9.12. <br>  . . . . . . . . . . . . . . . . . . . . . . . . . .  26
     9.13. <city>  . . . . . . . . . . . . . . . . . . . . . . . . .  26
     9.14. <code>  . . . . . . . . . . . . . . . . . . . . . . . . .  26
     9.15. <country> . . . . . . . . . . . . . . . . . . . . . . . .  26
     9.16. <cref>  . . . . . . . . . . . . . . . . . . . . . . . . .  27
     9.17. <date>  . . . . . . . . . . . . . . . . . . . . . . . . .  27
     9.18. <dd>  . . . . . . . . . . . . . . . . . . . . . . . . . .  27
     9.19. <displayreference>  . . . . . . . . . . . . . . . . . . .  27
     9.20. <dl>  . . . . . . . . . . . . . . . . . . . . . . . . . .  27
     9.21. <dt>  . . . . . . . . . . . . . . . . . . . . . . . . . .  27
     9.22. <em>  . . . . . . . . . . . . . . . . . . . . . . . . . .  28
     9.23. <email> . . . . . . . . . . . . . . . . . . . . . . . . .  28
     9.24. <eref>  . . . . . . . . . . . . . . . . . . . . . . . . .  28
     9.25. <figure>  . . . . . . . . . . . . . . . . . . . . . . . .  28
     9.26. <front> . . . . . . . . . . . . . . . . . . . . . . . . .  28
     9.27. <iref>  . . . . . . . . . . . . . . . . . . . . . . . . .  29
     9.28. <keyword> . . . . . . . . . . . . . . . . . . . . . . . .  29
     9.29. <li>  . . . . . . . . . . . . . . . . . . . . . . . . . .  29
     9.30. <link>  . . . . . . . . . . . . . . . . . . . . . . . . .  29
     9.31. <middle>  . . . . . . . . . . . . . . . . . . . . . . . .  29
     9.32. <name>  . . . . . . . . . . . . . . . . . . . . . . . . .  29
     9.33. <note>  . . . . . . . . . . . . . . . . . . . . . . . . .  30
     9.34. <ol>  . . . . . . . . . . . . . . . . . . . . . . . . . .  30
       9.34.1.  Percent Styles . . . . . . . . . . . . . . . . . . .  30
       9.34.2.  Standard Styles  . . . . . . . . . . . . . . . . . .  30
     9.35. <organization>  . . . . . . . . . . . . . . . . . . . . .  31
     9.36. <phone> . . . . . . . . . . . . . . . . . . . . . . . . .  31
     9.37. <postal>  . . . . . . . . . . . . . . . . . . . . . . . .  31
     9.38. <postalLine>  . . . . . . . . . . . . . . . . . . . . . .  32
     9.39. <refcontent>  . . . . . . . . . . . . . . . . . . . . . .  32
     9.40. <reference> . . . . . . . . . . . . . . . . . . . . . . .  33
     9.41. <referencegroup>  . . . . . . . . . . . . . . . . . . . .  33
     9.42. <references>  . . . . . . . . . . . . . . . . . . . . . .  34
     9.43. <region>  . . . . . . . . . . . . . . . . . . . . . . . .  34
     9.44. <relref>  . . . . . . . . . . . . . . . . . . . . . . . .  35
       9.44.1.  displayFormat='of' . . . . . . . . . . . . . . . . .  35
       9.44.2.  displayFormat='comma'  . . . . . . . . . . . . . . .  35
       9.44.3.  displayFormat='parens' . . . . . . . . . . . . . . .  36
       9.44.4.  displayFormat='bare' . . . . . . . . . . . . . . . .  36
     9.45. <rfc> . . . . . . . . . . . . . . . . . . . . . . . . . .  37
     9.46. <section> . . . . . . . . . . . . . . . . . . . . . . . .  37
     9.47. <seriesInfo>  . . . . . . . . . . . . . . . . . . . . . .  37
     9.48. <sourcecode>  . . . . . . . . . . . . . . . . . . . . . .  38
     9.49. <street>  . . . . . . . . . . . . . . . . . . . . . . . .  38
     9.50. <strong>  . . . . . . . . . . . . . . . . . . . . . . . .  38
Top   ToC   RFC7992 - Page 4
     9.51. <sub> . . . . . . . . . . . . . . . . . . . . . . . . . .  38
     9.52. <sup> . . . . . . . . . . . . . . . . . . . . . . . . . .  38
     9.53. <t> . . . . . . . . . . . . . . . . . . . . . . . . . . .  38
     9.54. <table> . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.55. <tbody> . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.56. <td>  . . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.57. <tfoot> . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.58. <th>  . . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.59. <thead> . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.60. <title> . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.61. <tr>  . . . . . . . . . . . . . . . . . . . . . . . . . .  39
     9.62. <tt>  . . . . . . . . . . . . . . . . . . . . . . . . . .  40
     9.63. <ul>  . . . . . . . . . . . . . . . . . . . . . . . . . .  40
     9.64. <uri> . . . . . . . . . . . . . . . . . . . . . . . . . .  40
     9.65. <workgroup> . . . . . . . . . . . . . . . . . . . . . . .  40
     9.66. <xref>  . . . . . . . . . . . . . . . . . . . . . . . . .  40
     9.67. <svg xmlns='http://www.w3.org/2000/svg'>  . . . . . . . .  41
   10. Security Considerations . . . . . . . . . . . . . . . . . . .  41
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  41
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  41
     11.2.  Informative References . . . . . . . . . . . . . . . . .  42
   IAB Members at the Time of Approval . . . . . . . . . . . . . . .  43
   Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . .  43
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  43

1. Introduction

As described in [RFC7990], 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 [RFC7993]. The details (particularly any vocabularies) described in this document are expected to change based on experience gained in implementing the new publication toolsets. Revised documents will be published capturing those changes as the toolsets are completed. Other implementers must not expect those changes to remain backwards compatible with the details described in this document.
Top   ToC   RFC7992 - Page 5

2. Requirements for the HTML Format

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 [RFC7998]. o The HTML has to render correctly on a list of browser versions that the RFC Editor will keep up to date outside of this document. o The format will consist of a subset of HTML deemed to be widely implemented by common browsers at the time the specification is created, likely to continue to be widely implemented, and unlikely to cause security issues. This will maximize the chances that future HTML renderers (such as new web browsers) will continue to produce readable text from the HTML format without the format needing to be changed frequently. o These requirements are expected to change in the future to reflect the expectation that HTML rendering will be required for current versions of browsers and platforms, while ideally continuing to render correctly on recent versions of those browsers. o The HTML documents from the RFC Editor or Internet-Drafts directory may be re-rendered from the canonical XML format in the future to ensure the ongoing readability of the documents. The intent is that any re-rendering would be due to exceptional circumstances rather than for minor annoyances. o The HTML must display adequately in at least one text-based browser. Some consumers of the RFC Series can only access the documents on text-based terminals. o The HTML document will be self-contained, without requiring external files for images, CSS, JavaScript, or the like. This will allow the HTML file to be moved over various non-HTTP transports (such as email, FTP, and rsync) without breakage. o JavaScript will be supported on a limited basis. It will not be permitted to overwrite or change any text present in the rendered HTML. It may, on a limited basis, add additional text that 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 CSS formatting. This will allow users who have a different visual style that they prefer to make RFCs display with that style without having to alter the contents of the HTML document. This
Top   ToC   RFC7992 - Page 6
      might also be valuable for allowing people with specific
      accessibility needs to use a customized CSS.

   o  HTML tags in documents will rarely have attributes whose only
      purpose is to affect the rendered styling, and those will only be
      used if it would not be possible to specify that styling in a CSS.
      No such attributes are known at this time.

   o  Both user-defined and auto-generated anchors must be supported and
      linkable, with user-defined anchors appearing in an "id"
      attribute.  Auto-generated anchors will be generated for every
      heading, paragraph, and so on, not just those that do not have
      user-defined anchors.  User-defined anchors may, and auto-
      generated anchors will, appear next to paragraphs, figures,
      tables, blockquotes, and section titles.

   o  All sections, subsections, figures, and paragraphs should have
      stable numbered link anchors.  Additionally, anchors expressed in
      the source XML should be exposed as anchors in the HTML output as
      well.

   o  The HTML must make it easy to separate sections along with all of
      their subsections into separate files.  This will make creating
      EPUB documents easier in the future.

   o  The HTML produced for Internet-Drafts will differ from that
      produced by the RFC Editor due to differences in the output from
      the prep tool.

   o  The abstract must be marked up or tagged in a way that popular
      search engines will extract it as a summary.

2.1. Requirements for Accessibility

o Normative information must be easily accessible to the following consumers: * People with impaired vision, including those that use large fonts and those that use screen readers * People with difficulty distinguishing between colors * People who use devices with small screens, such as cell phones o Specific instances where goals for accessibility are important in the design choices of the format have been called out in the text.
Top   ToC   RFC7992 - Page 7
   o  Note: designing for these consumers does not preclude the use of
      features they cannot use, but it does require that key semantic
      data not be lost when read using the tools and settings that are
      required by a given constituency.

3. HTML Version

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.

4. HTML Syntax

The processor emitting HTML from the XML source will follow these rules: o The HTML output is encoded as UTF-8, as specified in [RFC3629]. o The document is valid HTML. o Double quotes (U+0022 QUOTATION MARK: ") are used to quote attribute values unless the HTML specification forbids quoting a particular attribute. o Each logical line is terminated solely with a \n (U+000A: LINE FEED), otherwise known as "Unix-style" line endings. o Code points below (U+0020: SPACE) or character entity references that generate them (e.g. &#9;), other than (U+000A: LINE FEED) may not be used. Note: this rule explicitly forbids \t (U+0009: CHARACTER TABULATION), \f (U+000C: FORM FEED), and \r (U+000D: CARRIAGE RETURN) from appearing in the HTML output. o Comments in the source XML, if any, will not be copied into the HTML. o The HTML output will be pretty-printed, using whatever consistent rules are deemed best by the developers of the HTML production tools. Note: none of these rules affect the rendered output of the HTML, but they are intended to increase the chance that text comparison tools (e.g., "diff") that operate on the HTML output are easier to write.
Top   ToC   RFC7992 - Page 8

5. Common Items

This section lists items that are common across multiple parts of the HTML document.

5.1. IDs

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.

5.2. Pilcrows

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 "&para;". 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">&para;</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">&para;</a></p> <!-- NO pilcrow here --> </blockquote>
Top   ToC   RFC7992 - Page 9

6. Front Matter

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.

6.1. DOCTYPE

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>

6.2. Root Element

The root element of the document is <html>. This element includes a "lang" attribute, whose value is a language tag, as discussed in [RFC5646], that describes 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; see Section 2.47.3 of [RFC7991]), allowing CSS to style RFCs and Internet-Drafts differently from one another (if needed): <html lang="en" class="RFC">

6.3. <head> Element

The root <html> will contain a <head> element that contains the following elements, as needed.

6.3.1. Charset Declaration

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, whose "charset" attribute value is "utf-8": <meta charset="utf-8">
Top   ToC   RFC7992 - Page 10

6.3.2. Document Title

The contents of the <title> element from the XML source will be placed inside an HTML <title> element in the header.

6.3.3. Document Metadata

The following <meta> elements will be included: o author - one each for the each of the "fullname"s and "asciiFullname"s of all of the <author>s from the <front> of the XML source o description - the <abstract> from the XML source o generator - the name and version number of the software used to create the HTML o keywords - comma-separated <keyword>s from the XML source 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.

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://trustee.ietf.org/trust-legal-provisions.html">
Top   ToC   RFC7992 - Page 11

6.3.6. Style

The <head> element contains an embedded CSS 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">

6.3.7. Links

Each <link> element from the XML source is copied into the HTML header. Note: the HTML <link> element does not include a closing slash.
Top   ToC   RFC7992 - Page 12

6.4. Page Headers and Footers

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 formatting of the page number 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>
Top   ToC   RFC7992 - Page 13

6.5. Document Information

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>) <span class="editor">Ed.</span> </div> <div class="author"> <span class="initial">H.</span> <span class="surname">Flanagan</span> (<span class="organization">RFC Editor</span>) </div> </dd> </dl>
Top   ToC   RFC7992 - Page 14

6.6. Table of Contents

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> ...

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 as dictated by the RFC Editor's Style Guide [RFC-STYLE] 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.
Top   ToC   RFC7992 - Page 15

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 letter is followed by a <ul> tag that contains an <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" attribute 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> ...
Top   ToC   RFC7992 - Page 16

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 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> is 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> ...

8.1.4. Index Subitems

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". The format for each subitem is similar to that used for 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> ...
Top   ToC   RFC7992 - Page 17

8.2. Authors' Addresses Section

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 Series Editor</div> </address> </section>
Top   ToC   RFC7992 - Page 18

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: <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>


(page 18 continued on part 2)

Next Section