HTML Format for Rfcs
Total Page:16
File Type:pdf, Size:1020Kb
Internet Architecture Board (IAB) J. Hildebrand, Editor 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 78411. 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/rfc79922. 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-info3) 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. 1 https://www.rfc-editor.org/rfc/rfc7841.html#section-2 2 http://www.rfc-editor.org/info/rfc7992 3 http://trustee.ietf.org/license-info RFC 7992 HTML for RFCs December 2016 Table of Contents 1 Introduction...............................................................................................................................................................5 2 Requirements for the HTML Format....................................................................................................................6 2.1 Requirements for Accessibility............................................................................................................................. 6 3 HTML Version..........................................................................................................................................................8 4 HTML Syntax........................................................................................................................................................... 9 5 Common Items........................................................................................................................................................10 5.1 IDs........................................................................................................................................................................10 5.2 Pilcrows................................................................................................................................................................10 6 Front Matter............................................................................................................................................................11 6.1 DOCTYPE........................................................................................................................................................... 11 6.2 Root Element....................................................................................................................................................... 11 6.3 <head> Element...................................................................................................................................................11 6.3.1 Charset Declaration........................................................................................................................................ 11 6.3.2 Document Title............................................................................................................................................... 11 6.3.3 Document Metadata........................................................................................................................................11 6.3.4 Link to XML Source......................................................................................................................................12 6.3.5 Link to License...............................................................................................................................................12 6.3.6 Style................................................................................................................................................................ 12 6.3.7 Links................................................................................................................................................................12 6.4 Page Headers and Footers...................................................................................................................................12 6.5 Document Information.........................................................................................................................................13 6.6 Table of Contents................................................................................................................................................ 13 7 Main Body............................................................................................................................................................... 15 8 Back Matter.............................................................................................................................................................16 8.1 Index.....................................................................................................................................................................16 8.1.1 Index Contents................................................................................................................................................16 8.1.2 Index Letters................................................................................................................................................... 16 8.1.3 Index Items..................................................................................................................................................... 16 8.1.4 Index Subitems............................................................................................................................................... 17 8.2 Authors' Addresses Section.................................................................................................................................17 8.3 Document Information.........................................................................................................................................18 9 Elements...................................................................................................................................................................19 9.1 <abstract>.............................................................................................................................................................19 9.2 <address>............................................................................................................................................................. 19 9.3 <annotation>........................................................................................................................................................ 19 9.4 <area>...................................................................................................................................................................19 9.5 <artwork>.............................................................................................................................................................20 9.5.1 Text Artwork.................................................................................................................................................. 20 Hildebrand & Hoffman Informational [Page 2] RFC 7992 HTML for RFCs December 2016 9.5.2 SVG Artwork..................................................................................................................................................20 9.5.3 Other Artwork.................................................................................................................................................20 9.6 <aside>.................................................................................................................................................................21 9.7 <author>...............................................................................................................................................................21 9.7.1 Authors in Document Information................................................................................................................. 21 9.7.2 Authors of This Document.............................................................................................................................22 9.7.3 Authors of References....................................................................................................................................23 9.8 <back>..................................................................................................................................................................23