Network Working Group R. Tse Internet-Draft N. Nicholas Intended status: Informational J. Lau Expires: June 15, 2018 P. Brasolin Ribose December 12, 2017 AsciiRFC: Authoring Internet-Drafts And RFCs Using AsciiDoc draft-ribose-asciirfc-04 Abstract This document describes the AsciiDoc syntax extension called AsciiRFC designed for authoring IETF Internet-Drafts and RFCs. AsciiDoc is a human readable document markup language which affords more granular control over markup than comparable schemes such as Markdown. The AsciiRFC syntax is designed to allow the author to entirely focus on text, providing the full power of the resulting RFC XML through the AsciiDoc language, while abstracting away the need to manually edit XML, including references. This document itself was written and generated into RFC XML v2 (RFC7749) and RFC XML v3 (RFC7991) directly through asciidoctor-rfc, an AsciiRFC generator. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on June 15, 2018. Tse, et al. Expires June 15, 2018 [Page 1] Internet-Draft AsciiRFC Specifications December 2017 Copyright Notice Copyright (c) 2017 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 (https://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. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Conventions Used in This Document . . . . . . . . . . . . . . 5 2.1. Definitions . . . . . . . . . . . . . . . . . . . . . . . 5 3. Document Structure And AsciiDoctor Syntax . . . . . . . . . . 5 3.1. AsciiRFC Mapping To Asciidoctor . . . . . . . . . . . . . 7 3.2. Simple Illustration . . . . . . . . . . . . . . . . . . . 8 4. Header And Document Attributes . . . . . . . . . . . . . . . 16 4.1. Title And Basic Attributes . . . . . . . . . . . . . . . 16 4.2. Detailed Author Information . . . . . . . . . . . . . . . 17 4.3. XML Processing Information . . . . . . . . . . . . . . . 20 4.4. AsciiRFC-specific Document Attributes . . . . . . . . . . 21 5. Preamble . . . . . . . . . . . . . . . . . . . . . . . . . . 23 6. Sections and Paragraphs . . . . . . . . . . . . . . . . . . . 25 7. Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 8. Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 8.1. Basic Lists . . . . . . . . . . . . . . . . . . . . . . . 29 8.2. List Continuation . . . . . . . . . . . . . . . . . . . . 30 9. Blockquotes . . . . . . . . . . . . . . . . . . . . . . . . . 32 10. Notes And Asides . . . . . . . . . . . . . . . . . . . . . . 33 11. Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 12. Inline Formatting . . . . . . . . . . . . . . . . . . . . . . 37 12.1. Italics, Boldface, Monospace, Subscripts, Superscripts . 37 12.2. Formatting BCP 14 Keywords . . . . . . . . . . . . . . . 37 12.3. Escaping AsciiRFC Syntax . . . . . . . . . . . . . . . . 38 13. Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 14. Cross-References . . . . . . . . . . . . . . . . . . . . . . 39 14.1. Basic Referencing . . . . . . . . . . . . . . . . . . . 39 14.2. Referencing With Attributes . . . . . . . . . . . . . . 40 15. Inclusions . . . . . . . . . . . . . . . . . . . . . . . . . 42 16. Encoding and Entities . . . . . . . . . . . . . . . . . . . . 43 17. Bibliography . . . . . . . . . . . . . . . . . . . . . . . . 44 17.1. Using Raw RFC XML . . . . . . . . . . . . . . . . . . . 44 17.2. Preprocessing Using asciidoctor- bibliography . . . . . . . . . . . . . . . . . . 46 Tse, et al. Expires June 15, 2018 [Page 2] Internet-Draft AsciiRFC Specifications December 2017 18. RFC XML features not supported in Asciidoctor . . . . . . . . 48 19. Authoring . . . . . . . . . . . . . . . . . . . . . . . . . . 48 19.1. Using the rfc-in-asciidoc- template . . . . . . . . . . . . . . . . . . . . 49 19.2. Installing AsciiRFC Backend Processors . . . . . . . . . 49 19.3. Iterating AsciiRFC Content . . . . . . . . . . . . . . . 49 20. Security Considerations . . . . . . . . . . . . . . . . . . . 50 21. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 50 22. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 50 22.1. Example 1: AsciiRFC . . . . . . . . . . . . . . . . . . 50 22.2. Example 1: RFC XML v3 . . . . . . . . . . . . . . . . . 52 22.3. Example 2: AsciiRFC . . . . . . . . . . . . . . . . . . 53 22.4. Example 2: RFC XML v3 . . . . . . . . . . . . . . . . . 59 23. References . . . . . . . . . . . . . . . . . . . . . . . . . 65 23.1. Normative References . . . . . . . . . . . . . . . . . . 65 23.2. Informative References . . . . . . . . . . . . . . . . . 65 Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 67 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 67 1. Introduction Internet-Drafts and RFCs intended for publication submission to the IETF can be written in a multitude of formats today, including: o XML: RFC XML v2 [RFC7749] and v3 [RFC7991] o nroff: through "NroffEdit" [NroffEdit] o Microsoft Word: through usage of [RFC5385] o Lyx: through [lyx2rfc] o Pandoc: [RFC7328], through [pandoc2rfc] or [draftr] o Kramdown: through [kramdown-rfc2629] o mmark: through [mmark] Interestingly, the last three are Markdown [RFC7763] variants. As specified in [RFC7990], the IETF intends for the canonical format of RFCs to transition from plain-text ASCII to RFC XML v3 [RFC7991]. While plain-text will continue to be accepted from authors by the IETF, at least in the short- to medium-term, XML will be preferred for submission, and any plain-text submissions will need to be converted to RFC XML v3. Tse, et al. Expires June 15, 2018 [Page 3] Internet-Draft AsciiRFC Specifications December 2017 While this need is already met for RFC XML v2 [RFC7749] by the tools specified above, the transition to RFC XML v3 [RFC7991] places added onus on authors to generate compliant XML. [AsciiDoc] is an alternative markup language to Markdown, with features that make it attractive as a markup language for RFC with XML output. This document describes the use of [Asciidoctor], a Ruby-based enhancement of the original AsciiDoc markup language, for RFC XML markup, with a Ruby gem written by the authors used to render Asciidoctor documents as RFC XML. The markup language used specifically for the purpose of generating RFC XML document is called "AsciiRFC". Section 1.2 of [RFC7764] famously states that "there is no such thing as "invalid" Markdown, there is no standard demanding adherence to the Markdown syntax, and there is no governing body that guides or impedes its development." While there are contexts where that lack of rigour is helpful, the authoring of RFCs does have a standard and a governing body, and there is such a thing as invalid RFC XML. A more rigorous counterpart to Markdown, which still preserves its basic approach to formatting, is useful in generating RFC XML that encompasses a fuller subset of the specification, and preempting malformed RFC XML output. Compared to Markdown [Asciidoctor-Manual], o AsciiDoc was designed from the beginning as a publishing language: it was initially intended as a plain-text alternative to the DocBook XML schema. For that reason, Asciidoctor natively supports the full range of formatting required by RFC XML (including notes, tables, bibliographies, source-code blocks, and definition lists), without resorting to embedded HTML or Markdown "flavours". o AsciiDoc in its Ruby-based Asciidoctor implementation is extensible, with a well-defined API. (Extensions have been harnessed to deal with bibliographic preprocessing for AsciiRFC.) o AsciiRFC allows granular control of rendering, including user- specified attributes of text blocks. o The Asciidoctor implementation allows document inclusion, for managing large-scale documentation projects. o AsciiRFC allows granular control of permutations of block nesting, such as source code within lists or definition lists within unordered lists. Tse, et al. Expires June 15, 2018 [Page 4] Internet-Draft AsciiRFC Specifications December 2017 o As a more formal counterpart to Markdown, AsciiDoc is well-suited to generating XML that needs to conform to a specified schema. As with Markdown, there is a wide range of tools that can render AsciiDoc; so AsciiRFC drafts of RFC documents can be previewed and accessed without depending on the RFC tools ecosystem. Our realisation of RFC XML in AsciiRFC has aimed to ensure that, as much as possible, the markup language can be can be processed by generic Asciidoctor tools. (The only exception to this as an add-on is the optional bibliography module, which allows bibliographies to be assembled on the fly based on citations in a document: see Section 17.2.) 2. Conventions Used in This Document The key words "*MUST*", "*MUST NOT*", "*REQUIRED*", "*SHALL*", "*SHALL NOT*", "*SHOULD*", "*SHOULD NOT*", "*RECOMMENDED*", "*MAY*", and "*OPTIONAL*" in this document are to be interpreted as described in [RFC2119]. 2.1. Definitions In this document, _AsciiDoc_ refers to the markup language generically. _Asciidoctor_ refers specifically to the Ruby-based implementation of the markup language, which has enhanced the original markup language. The RFC XML document converter contributed by the authors uses a subset of _Asciidoctor_, with some minor additions (a few document attributes specific to RFC XML, some macros specific to citation processing, and some templated use of _Asciidoctor_ crossreferences). This variant of _Asciidoctor_ markup is referred to as _AsciiRFC_. 3. Document Structure And AsciiDoctor Syntax The syntax of Asciidoctor is presented in the Asciidoctor user manual [Asciidoctor-Manual]. AsciiRFC is a subset of Asciidoctor syntax, with the addition of bibliographic macros (Section 17.2). Asciidoctor consists of: o A document header, containing a title, a list of authors, and document attributes in lines prefixed with ":". o An optional document preamble, separated from document header by a blank line. o A number of sections, set off by a section title (a line prefixed with two or more "=". Tse, et al. Expires June 15, 2018 [Page 5] Internet-Draft AsciiRFC Specifications December 2017 A section may contain: o Other sections, whose level of nesting is indicated by the number of "=" in their header. o Blocks of text. Blocks can have metadata (including a title, an anchor for cross-references, and attributes.) Blocks can be: o Paragraphs, which are terminated by blank lines. o Lists. List items are by default paragraphs, but can span over multiple paragraphs. o Delimited blocks (with a line delimiter on either side of them); these include tables, notes, sidebars, source code, block quotes, examples, and unprocessed content (e.g. raw XML). Delimited blocks contain by default one or more paragraphs. o List items can contain other blocks, including both nested lists and delimited blocks. o Some delimited blocks can contain other delimited blocks; for example, examples can contain source code as well as discussion in paragraphs. o Blocks of text consist of inline text, which themselves can contain markup. Inline markup includes: o Text formatting: bold, italic, superscript, subscript, monospace. o Custom markup macros. (AsciiRFC uses one: "bcp14".) o URLs, including display text. o Inline anchors. o Cross-references to anchors (IDs of blocks or spans of text), including display text. o Images, audio, and visual files. (AsciiRFC only supports images.) o Index terms. Tse, et al. Expires June 15, 2018 [Page 6] Internet-Draft AsciiRFC Specifications December 2017 o Equations (native support for [AsciiMathML] and [TeX-LaTeX], via the [MathJax] tool). (Not supported in AsciiRFC, since there is no RFC XML equivalent.) o Footnotes. (Not supported in AsciiRFC.) 3.1. AsciiRFC Mapping To Asciidoctor The Asciidoctor document structure aligns with the RFC XML v2 and v3 structure. In the following, v3 equivalences are given. Header "" attributes, most "front" elements. Preamble "front/abstract" and "front/note". Sections "middle/section" elements. Sections with bibliography style attributes "back/references" elements. Sections with appendix style attributes "back/section" elements. Paragraphs "t" elements. Lists "ul", "ol", "dl" elements. Delimited blocks "artwork", "aside", "blockquote", "figure", "note", "sourcecode", "table". Inline markup "bcp14", "br", "cref", "em", "eref", "iref", "relref", "strong", "sub", "sup", "tt", "xref". Full details of the mapping of AsciiRFC elements to RFC XML v2 and v3 elements, and of how to convert AsciiRFC documents to RFC XML, are given in the documentation of [asciidoctor-rfc]. Tse, et al. Expires June 15, 2018 [Page 7] Internet-Draft AsciiRFC Specifications December 2017 3.2. Simple Illustration This section gives an overview of how to create an RFC XML document in AsciiRFC, with some pitfalls to be aware of. Illustrations are in RFC XML v3, although the converter deals with both versions of RFC XML. A sample AsciiRFC document is provided in Figure 1, and its corresponding rendering in: o RFC XML v3 (Figure 2) o RFC XML v2 (Figure 3) = Four Yorkshiremen Sketch Tim Brooke-Taylor; John Cleese; Graham Chapman; Marty Feldman :doctype: internet-draft :abbrev: 4 Yorkshiremen :obsoletes: 10, 120 :updates: 2010, 2120 :status: informational :name: draft-four-yorkshiremen-00 :ipr: trust200902 :area: Internet :workgroup: Network Working Group :keyword: yorkshire, memory :revdate: 1990-04-01T00:00:00Z :organization: BBC :phone: (555) 555-5555 :uri: http://example.com :street: 10 Moulton Street :city: Cambridge :code: MA 02238 :email: tbt@example.com :email_2: jc@example.com :email_3: gc@example.com :email_4: mf@bcc.co.uk :smart-quotes: false :link: https://en.wikipedia.org/wiki/Four_Yorkshiremen_sketch [abstract] The sketch is a parody of nostalgic conversations about humble beginnings or difficult childhoods, featuring four men from Yorkshire who reminisce about their upbringing. As the conversation progresses they try to outdo one another, and their accounts of deprived childhoods become increasingly absurd. <> <> Tse, et al. Expires June 15, 2018 [Page 8] Internet-Draft AsciiRFC Specifications December 2017 NOTE: See also Wikipedia summary [#michaelpalin] == Claim: Michael Palin You were lucky. We lived for three months in a brown paper bag in a septic tank. We used to have to get up at six o'clock in the morning, clean the bag, eat a crust of stale bread, go to work down mill for fourteen hours a day week in-week out. When we got home, our Dad would thrash us to sleep with his belt! <> === Response: Graham Chapman Luxury. We used to have to get out of the lake at three o'clock in the morning, clean the lake, eat a handful of hot gravel, go to work at the mill every day for tuppence a month, come home, and Dad would beat us around the head and neck with a broken bottle, if we were *lucky*! === Response: Terry Gilliam Well we had it tough. We used to have to get up out of the shoebox at twelve o'clock at night, and *lick* the road clean with our tongues. We had half a handful of freezing cold gravel, worked twenty-four hours a day at the mill for fourpence every six years, and when we got home, our Dad would slice us in two with a bread knife. [#ericidle] === Response: Eric Idle Right. I had to get up in the morning at ten o'clock at night, half an hour before I went to bed, (_pause for laughter_), eat a lump of cold poison, work twenty-nine hours a day down mill, and pay mill owner for permission to come to work, and when we got home, our Dad would kill us, and dance about on our graves singing "Hallelujah." [bibliography] == Normative References ++++ Guidelines for Writing an IANA Considerations Section in RFCs Sacramento State UC Davis Tse, et al. Expires June 15, 2018 [Page 9] Internet-Draft AsciiRFC Specifications December 2017 ++++ [appendix] == Addendum But you try and tell the young people today that... and they won't believe ya. Figure 1: Sample Internet-Draft in AsciiRFC The first block of text, from "= Four Yorkshiremen Sketch" through to ":link: https://en.wikipedia.org/wiki/Four_Yorkshiremen_sketch", is the document header. It contains a title in the first line, an author attribution, and then a set of document attributes, conveying information about the document as well as information about its authors. This information ends up either as attributes of the root "rfc" tag, elements of the "front" tag, or processing instructions. The following blocks of text, up until the first section header ("== Claim: Michael Palin"), are the document preamble. They are treated by the document converter as containing the document abstract ("abstract"), followed by any notes ("note", identified above by the "NOTE:" heading). The first section header ("== Claim: Michael Palin") is preceded by an anchor for that section ("[#michaelpalin]"). There is a cross- reference to that anchor already in place in the abstract ("<>"). The document converter treats the first section of the document as the start of the "middle" section of the document. The first section header is followed by a paragraph, and other sections and paragraphs. The number of "=" signs are one higher than the initial section header, which indicates that they are subsections of that section. The paragraphs contains some inline formatting (italics: "_pause for laughter_"; boldface: "*lick*"). The first paragraph also contains a citation of a reference, which in this version of AsciiRFC is treated identically to a cross-reference ("<>"). (If the bibliography preprocessor were used, it would be encoded differently.) The second last section is tagged with the style attribute "[bibliography]", which identifies it as a references container; the document converter accordingly inserts this into the "back" element Tse, et al. Expires June 15, 2018 [Page 10] Internet-Draft AsciiRFC Specifications December 2017 of the document. The contents of the references section are in this instance raw XML, delimited as a passthrough block (with "++++"), which the converter does not alter. The final section is tagged with the style attribute "[appendix]", and is treated as such. The RFC XML v3 document generated from this AsciiRFC document is: Four Yorkshiremen Sketch BBC
10 Moulton Street Cambridge MA 02238 (555) 555-5555 tbt@example.com http://example.com
jc@example.com
gc@example.com
mf@bcc.co.uk
Internet Network Working Group yorkshire Tse, et al. Expires June 15, 2018 [Page 11] Internet-Draft AsciiRFC Specifications December 2017 memory The sketch is a parody of nostalgic conversations about humble beginnings or difficult childhoods, featuring four men from Yorkshire who reminisce about their upbringing. As the conversation progresses they try to outdo one another, and their accounts of deprived childhoods become increasingly absurd. See also Wikipedia summary
Claim: Michael Palin You were lucky. We lived for three months in a brown paper bag in a septic tank. We used to have to get up at six o'clock in the morning, clean the bag, eat a crust of stale bread, go to work down mill for fourteen hours a day week in-week out. When we got home, our Dad would thrash us to sleep with his belt!
Response: Graham Chapman Luxury. We used to have to get out of the lake at three o'clock in the morning, clean the lake, eat a handful of hot gravel, go to work at the mill every day for tuppence a month, come home, and Dad would beat us around the head and neck with a broken bottle, if we were lucky!
Response: Terry Gilliam Well we had it tough. We used to have to get up out of the shoebox at twelve o'clock at night, and lick the road clean with our tongues. We had half a handful of freezing cold gravel, worked twenty-four hours a day at the mill for fourpence every six years, and when we got home, our Dad would slice us in two with a bread knife.
Response: Eric Idle Right. I had to get up in the morning at ten o'clock at night, half an hour before I went to bed, (pause for laughter), eat a lump of cold poison, work twenty-nine hours a day down mill, and pay mill owner for permission to come to work, and when we got home, our Dad would kill us, and dance about on Tse, et al. Expires June 15, 2018 [Page 12] Internet-Draft AsciiRFC Specifications December 2017 our graves singing "Hallelujah."
Normative References Guidelines for Writing an IANA Considerations Section in RFCs<title> <author initials="T." surname="Krovetz"> <organization>Sacramento State<organization> </author> <author initials="P." surname="Rogaway"> <organization>UC Davis<organization> </author> <date month="May" year="2014" /> </front> <seriesInfo name="RFC" value="7253" /> </reference> </references> <section anchor="_addendum" numbered="false"> <name>Addendum<name> <t>But you try and tell the young people today that…​ and they won't believe ya'.<t> </section> </back> </rfc> Figure 2: Sample Internet-Draft In AsciiRFC, Output In RFC XML v3 Format Some default processing instructions have already been prefixed to the XML. Our AsciiRFC converter can also generate RFC XML v2 from the same source AsciiRFC, as shown in Figure 3. Output in RFC XML v2 is not extensively described in this document. <rfc ipr="trust200902" obsoletes="10, 120" updates="2010, 2120" category="info" submissionType="IETF" docName="draft-four-yorkshiremen-00"> <front> <title abbrev="4 Yorkshiremen">Four Yorkshiremen Sketch<title> <author fullname="Tim Brooke-Taylor" surname="Brooke-Taylor"> <organization>BBC</organization> Tse, et al. Expires June 15, 2018 [Page 13] Internet-Draft AsciiRFC Specifications December 2017 <address> <postal> <street>10 Moulton Street</street> <city>Cambridge</city> <code>MA 02238</code> </postal> <phone>(555) 555-5555</phone> <email>tbt@example.com</email> <uri>http://example.com</uri> </address> </author> <author fullname="John Cleese" surname="Cleese"> <address> <email>jc@example.com</email> </address> </author> <author fullname="Graham Chapman" surname="Chapman"> <address> <email>gc@example.com</email> </address> </author> <author fullname="Marty Feldman" surname="Feldman"> <address> <email>mf@bcc.co.uk</email> </address> </author> <date day="1" month="April" year="1990" /> <area>Internet</area> <workgroup>Network Working Group</workgroup> <keyword>yorkshire</keyword> <keyword>memory</keyword> <abstract> <t>The sketch is a parody of nostalgic conversations about humble beginnings or difficult childhoods, featuring four men from Yorkshire who reminisce about their upbringing. As the conversation progresses they try to outdo one another, and their accounts of deprived childhoods become increasingly absurd. <xref target="michaelpalin" /> <xref target="ericidle" /></t> </abstract> <note title="NOTE"> <t>See also Wikipedia summary</t> </note> </front> <middle> <section anchor="michaelpalin" title="Claim: Michael Palin"> <t>You were lucky. We lived for three months in a brown paper bag in a septic tank. We used to have to get up at six o'clock in Tse, et al. Expires June 15, 2018 [Page 14] Internet-Draft AsciiRFC Specifications December 2017 the morning, clean the bag, eat a crust of stale bread, go to work down mill for fourteen hours a day week in-week out. When we got home, our Dad would thrash us to sleep with his belt! <xref target="RFC7253" /></t> <section anchor="_response_graham_chapman" title="Response: Graham Chapman"> <t>Luxury. We used to have to get out of the lake at three o'clock in the morning, clean the lake, eat a handful of hot gravel, go to work at the mill every day for tuppence a month, come home, and Dad would beat us around the head and neck with a broken bottle, if we were <spanx style="strong">lucky</spanx>!</t> </section> <section anchor="_response_terry_gilliam" title="Response: Terry Gilliam"> <t>Well we had it tough. We used to have to get up out of the shoebox at twelve o'clock at night, and <spanx style="strong">lick<spanx> the road clean with our tongues. We had half a handful of freezing cold gravel, worked twenty-four hours a day at the mill for fourpence every six years, and when we got home, our Dad would slice us in two with a bread knife.</t> </section> <section anchor="ericidle" title="Response: Eric Idle"> <t>Right.</t> <t>I had to get up in the morning at ten o'clock at night, half an hour before I went to bed, (<spanx style="emph">pause for laughter</spanx>), eat a lump of cold poison, work twenty-nine hours a day down mill, and pay mill owner for permission to come to work, and when we got home, our Dad would kill us, and dance about on our graves singing "Hallelujah."</t> </section> </section> </middle> <back> <references title="Normative References"> <reference anchor="RFC7253" target="https://tools.ietf.org/html/rfc7253"> <front> <title>Guidelines for Writing an IANA Considerations Section in RFCs Sacramento State UC Davis Tse, et al. Expires June 15, 2018 [Page 15] Internet-Draft AsciiRFC Specifications December 2017
But you try and tell the young people today that…​ and they won't believe ya'.
Figure 3: Sample Internet-Draft In AsciiRFC, Output In RFC XML v2 Format 4. Header And Document Attributes The header gives the document title, followed by an optional author attribution, and a series of document attributes, with no carriage return breaks. 4.1. Title And Basic Attributes Document attributes are used to populate attributes of the root "rfc" element, "front" elements, and document-level processing instructions. o ":doctype:" determines whether the document will be considered "rfc" or "internet-draft", and interprets other attributes accordingly. o Certain attributes ("workgroup", "area", "keyword") are comma delimited, and result in repeated RFC XML elements. Figure 4 demonstrates how to set the document header in AsciiRFC, with its rendering in v3 shown in Figure 5. Tse, et al. Expires June 15, 2018 [Page 16] Internet-Draft AsciiRFC Specifications December 2017 = Four Yorkshiremen Sketch Tim Brooke-Taylor :doctype: internet-draft :abbrev: 4 Yorkshiremen :obsoletes: 10, 120 :updates: 2010, 2120 :status: informational :name: draft-four-yorkshiremen-00 :ipr: trust200902 :area: Internet :workgroup: Network Working Group :keyword: yorkshire, memory :revdate: 1990-04-01T00:00:00Z Figure 4: AsciiRFC Document Header Four Yorkshiremen Sketch
tbt@example.com
Internet Network Working Group yorkshire memory Figure 5: AsciiRFC Document Header Rendered As RFC XML v3 4.2. Detailed Author Information The document header can spell out further information about authors, including contact details. The AsciiRFC header is shown in Figure 6 with its rendering in RFC XML v3 shown in Figure 7. Tse, et al. Expires June 15, 2018 [Page 17] Internet-Draft AsciiRFC Specifications December 2017 = Four Yorkshiremen Sketch Tim Brooke-Taylor :doctype: internet-draft :abbrev: 4 Yorkshiremen :obsoletes: 10, 120 :updates: 2010, 2120 :status: informational :name: draft-four-yorkshiremen-00 :ipr: trust200902 :area: Internet :workgroup: Network Working Group :keyword: yorkshire, memory :revdate: 1990-04-01T00:00:00Z :organization: BBC :phone: (555) 555-5555 :uri: http://bbn.com :street: 10 Moulton Street :city: Cambridge :code: MA 02238 Figure 6: AsciiRFC Document Header With One Author Four Yorkshiremen Sketch BBC
10 Moulton Street Cambridge MA 02238 (555) 555-5555 tbt@example.com http://bbn.com
Internet Network Working Group yorkshire memory Figure 7: AsciiRFC Document Header With One Author (RFC XML v3) Tse, et al. Expires June 15, 2018 [Page 18] Internet-Draft AsciiRFC Specifications December 2017 Details of a second, third etc. author, including their organization and contact details, are provided by suffixing the relevant author attributes with "_2", "_3" etc., as shown in Figure 8 and its v3 rendering Figure 9. = Four Yorkshiremen Sketch Tim Brooke-Taylor ; John Cleese :doctype: internet-draft :status: informational :name: draft-four-yorkshiremen-00 :ipr: trust200902 :organization: BBC :phone: (555) 555-5555 :uri: http://example.com :street: 10 Moulton Street :city: Cambridge :code: MA 02238 :forename_initials: T. :lastname: Brooke-Taylor :street: 12 Moulton Street :city: London :country: United Kingdom :forename_initials_2: J. :lastname_2: Cleese :uri_2: https://twitter.com/johncleese Figure 8: AsciiRFC Document Header With Multiple Authors Tse, et al. Expires June 15, 2018 [Page 19] Internet-Draft AsciiRFC Specifications December 2017 Four Yorkshiremen Sketch BBC
12 Moulton Street London MA 02238 United Kingdom (555) 555-5555 tbt@example.com http://example.com
jc@example.com https://twitter.com/johncleese
Figure 9: AsciiRFC Document Header With Multiple Authors (RFC XML v3) The initial author attribution in AsciiRFC, e.g. "Tim Brooke-Taylor ; John Cleese " in the example above, expects a strict format of First Name, zero or more Middle Names, Last name, and cannot process honorifics like "Dr." or suffixes like "Jr.". Name attributes with any degree of complexity should be overriden by using the ":fullname:" and ":lastname:" attributes. The AsciiRFC ":forename_initials:" attribute replaces the built-in Asciidoctor ":initials:" attribute (which includes the surname initial), and is not automatically populated from the name attribution. 4.3. XML Processing Information A document header may also contain attribute headers which are treated as XML processing instructions. An AsciiRFC example is shown in Figure 10 with its rendering in Figure 11. Tse, et al. Expires June 15, 2018 [Page 20] Internet-Draft AsciiRFC Specifications December 2017 = Four Yorkshiremen Sketch Tim Brooke-Taylor :doctype: internet-draft :status: informational :name: draft-four-yorkshiremen-00 :ipr: trust200902 :revdate: 1990-04-01T00:00:00Z :rfcedstyle: yes :text-list-symbols: yes :rfc2629xslt: true Figure 10: AsciiRFC Document Header With XML Processing Information Four Yorkshiremen Sketch
tbt@example.com
Figure 11: AsciiRFC Document Header With XML Processing Information (RFC XML v3) 4.4. AsciiRFC-specific Document Attributes A few document attributes are specific to the operation of the RFC XML document converter: :no-rfc-bold-bcp14: false overrides the wrapping by default of boldface uppercase BCP14 [RFC2119] words (e.g. "*MUST NOT*") with the "bcp14" element. :smart-quotes: false overrides Asciidoctor's conversion of straight quotes and apostrophes to smart quotes and apostrophes. :inline-definition-lists: true overrides the RFC XML v2 "idnits" requirement that a blank line be inserted between a definition list term and its definition. Tse, et al. Expires June 15, 2018 [Page 21] Internet-Draft AsciiRFC Specifications December 2017 = Four Yorkshiremen Sketch Tim Brooke-Taylor :doctype: internet-draft :status: informational :name: draft-four-yorkshiremen-00 == Section 1 The specification *MUST NOT* use the word _doesn't_. Figure 12: AsciiRFC Document Header Without RFC-specific Attributes Four Yorkshiremen Sketch
tbt@example.com
Section 1 The specification MUST NOT use the word doesn’t.
Figure 13: AsciiRFC Document Header Without RFC-specific Attributes (RFC XML v3) = Four Yorkshiremen Sketch Tim Brooke-Taylor :doctype: internet-draft :status: informational :name: draft-four-yorkshiremen-00 :no-rfc-bold-bcp14: false :smart-quotes: false == Section 1 The specification *MUST NOT* use the word _doesn't_. Figure 14: AsciiRFC Document Header With Overridden RFC-specific Attributes Tse, et al. Expires June 15, 2018 [Page 22] Internet-Draft AsciiRFC Specifications December 2017 Four Yorkshiremen Sketch
tbt@example.com
Section 1 The specification MUST NOT use the word doesn't.
Figure 15: AsciiRFC Document Header With Overridden RFC-specific Attributes (RFC XML v3) 5. Preamble The preamble in AsciiRFC is the text between the end of the document header (which terminates with a blank line) and the first section of text. Any paragraphs of text in the preamble are treated as an abstract, and may optionally be tagged with the "abstract" style attribute. Any notes in the preamble are treated as a "note" element. An example of setting the preamble is given in Figure 16 with its rendering in Figure 17. Tse, et al. Expires June 15, 2018 [Page 23] Internet-Draft AsciiRFC Specifications December 2017 = Four Yorkshiremen Sketch Tim Brooke-Taylor :doctype: internet-draft :status: informational :name: draft-four-yorkshiremen-00 The "Four Yorkshiremen" sketch is a comedy sketch written by Tim Brooke-Taylor, John Cleese, Graham Chapman and Marty Feldman and originally performed on their TV series _At Last the 1948 Show_ in 1967. It later became associated with the comedy group Monty Python (which included Cleese and Chapman), who performed it in their live shows, including _Monty Python Live at the Hollywood Bowl_. The sketch is a parody of nostalgic conversations about humble beginnings or difficult childhoods, featuring four men from Yorkshire who reminisce about their upbringing. As the conversation progresses they try to outdo one another, and their accounts of deprived childhoods become increasingly absurd. NOTE: Barry Cryer is the wine waiter in the original performance and may have contributed to the writing. [NOTE] .Original Recording == The original performance of the sketch by the four creators is one of the surviving sketches from the programme and can be seen on the _At Last the 1948 Show_ DVD. == Figure 16: AsciiRFC With Preamble Tse, et al. Expires June 15, 2018 [Page 24] Internet-Draft AsciiRFC Specifications December 2017 Four Yorkshiremen Sketch
tbt@example.com
The "Four Yorkshiremen" sketch is a comedy sketch written by Tim Brooke-Taylor, John Cleese, Graham Chapman and Marty Feldman and originally performed on their TV series At Last the 1948 Show in 1967. It later became associated with the comedy group Monty Python (which included Cleese and Chapman), who performed it in their live shows, including Monty Python Live at the Hollywood Bowl. The sketch is a parody of nostalgic conversations about humble beginnings or difficult childhoods, featuring four men from Yorkshire who reminisce about their upbringing. As the conversation progresses they try to outdo one another, and their accounts of deprived childhoods become increasingly absurd. Barry Cryer is the wine waiter in the original performance and may have contributed to the writing. Original Recording The original performance of the sketch by the four creators is one of the surviving sketches from the programme and can be seen on the At Last the 1948 Show DVD. Figure 17: AsciiRFC With Preamble (RFC XML v3) 6. Sections and Paragraphs Section headers are given with a sequence of "=", the number of "=" giving the header level. Section numbering is toggled with the in- document attribute ":sectnums:" (on), ":sectnums!:" (off). The "toc" attribute can also be set on sections, indicating whether the section can be included in the document's table of contents. Tse, et al. Expires June 15, 2018 [Page 25] Internet-Draft AsciiRFC Specifications December 2017 Figure 18 shows how sections and paragraphs are used in AsciiRFC, and its rendered form shown in Figure 19. :sectnums: [toc=exclude] == Section 1 Para 1 === Subsection 1.1 Para 1a :sectnums!: [toc=default] === Subsection 1.2 Para 2 ==== Subsection 1.2.1 Para 3 Figure 18: AsciiRFC With Sections
Section 1 Para 1
Subsection 1.1 Para 1a
Subsection 1.2 Para 2
Subsection 1.2.1 Para 3
Figure 19: AsciiRFC With Sections (RFC XML v3) 7. Figures AsciiRFC examples (corresponding to RFC XML Figures), source code Listings, and Literals (preformatted text) are all delimited blocks. Listings and Literals can occur nested within Examples. An AsciiRFC example with a figure is given in Figure 20, and its rendering in Figure 21. Tse, et al. Expires June 15, 2018 [Page 26] Internet-Draft AsciiRFC Specifications December 2017 .Figure 1 ==== .figure1.txt .... Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork) This is some ASCII Art: _____ ___ ____ _ _ | ___|_ _/ ___| | ___| |_ | |_ | | | _| |/ _ \ __| | _| | | |_| | | __/ |_ |_| |___\____|_|\___|\__| .... [source,ruby] ---- def listing(node) result = [] if node.parent.context != :example result << "
" end end Figure 20: AsciiRFC With A Figure Tse, et al. Expires June 15, 2018 [Page 27] Internet-Draft AsciiRFC Specifications December 2017
Figure 1 Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork) This is some ASCII Art: _____ ___ ____ _ _ | ___|_ _/ ___| | ___| |_ | |_ | | | _| |/ _ \ __| | _| | | |_| | | __/ |_ |_| |___\____|_|\___|\__| def listing(node) result = [] if node.parent.context != :example result << "<figure>" end end
Figure 21: AsciiRFC With A Figure (RFC XML v3) If an AsciiRFC Listing or Literal occurs outside of an Example (Figure 22), the RFC XML converter will supply the surrounding Figure element (Figure 23). .... This is some ASCII Art: _____ ___ ____ _ _ | ___|_ _/ ___| | ___| |_ | |_ | | | _| |/ _ \ __| | _| | | |_| | | __/ |_ |_| |___\____|_|\___|\__| .... Figure 22: AsciiRFC With ASCII Art Without Figure Wrapping Tse, et al. Expires June 15, 2018 [Page 28] Internet-Draft AsciiRFC Specifications December 2017
This is some ASCII Art: _____ ___ ____ _ _ | ___|_ _/ ___| | ___| |_ | |_ | | | _| |/ _ \ __| | _| | | |_| | | __/ |_ |_| |___\____|_|\___|\__|
Figure 23: AsciiRFC With ASCII Art Without Figure Wrapping (RFC XML v3) 8. Lists 8.1. Basic Lists AsciiRFC supports ordered, unordered, and definition lists. Indentation of ordered and unordered lists is indicated by repeating the list item prefix ("*" and "." respectively). List attributes specify the type of symbol used for ordered lists. An example of AsciiRFC List is shown in Figure 24 with its rendered version in Figure 25. [loweralpha] . First . Second [upperalpha] .. Third .. Fourth . Fifth . Sixth Figure 24: AsciiRFC With Lists Tse, et al. Expires June 15, 2018 [Page 29] Internet-Draft AsciiRFC Specifications December 2017
  1. First
  2. Second
    1. Third
    2. Fourth
  3. Fifth
  4. Sixth
Figure 25: AsciiRFC With Lists (RFC XML v3) 8.2. List Continuation A list item by default spans a single paragraph. A following paragraph or other block element can be appended to the current list item by prefixing it with "+" in a separate line. See the "List Continuation" section in [Asciidoctor-Manual] for more information. An example of list containuation with text is shown in Figure 26 with its rendered version in Figure 27. Notes:: Note 1. + Note 2. + Note 3. Figure 26: AsciiRFC List With Text Continuation
Notes
Note 1. Note 2. Note 3.
Figure 27: AsciiRFC List With Text Continuation (RFC XML v3) Tse, et al. Expires June 15, 2018 [Page 30] Internet-Draft AsciiRFC Specifications December 2017 (Multiple paragraphs are not permitted within a list item in RFC XML v2. The RFC XML converter deals with this by converting paragraph breaks into line breaks within a list item.) List continuations can also be embed to populate a list item with a sequence of blocks as a unit (in an Asciidoctor open block). An example of list containuation with block is shown in Figure 28 with its rendered version in Figure 29. * List Entry 1 * List Entry 2 + -- Note 2. .... Literal .... Note 3. -- Figure 28: AsciiRFC List With Block Continuation
  • List Entry 1
  • List Entry 2 Note 2.
    Literal
    Note 3.
Figure 29: AsciiRFC List With Block Continuation (RFC XML v3) AsciiDoc, and thus AsciiRFC, considers paragraphs to be the basic level of blocks, and does not permit lists to be nested within them: text after a list is considered to be a new paragraph. Therefore, markup as shown in Figure 30 cannot be generated via AsciiRFC. Tse, et al. Expires June 15, 2018 [Page 31] Internet-Draft AsciiRFC Specifications December 2017 This is the start of a paragraph.
  • List Entry 1
  • List Entry 2 Note 2.
And this is the continuation of the paragraph. Figure 30: This RFC XML v3 Output Cannot Be Generated Using AsciiRFC 9. Blockquotes Asciidoctor supports blockquotes and quotations of verse; its block quotations permit arbitrary levels of quote nesting. RFC XML v3, and thus AsciiRFC, only supports one level of blockquotes. Unlike RFC XML v2, RFC XML v3 does not support line breaks outside of tables, so verse quotations are converted to prose in the v3 converter. An example of using AsciiRFC Blockquotes is given in Figure 31 with its rendered version in Figure 32. [quote,attribution="Monty Python",citetitle="http://example.com"] ____ Dennis: Come and see the violence inherent in the system. Help! Help! I'm being repressed! King Arthur: Bloody peasant! Dennis: Oh, what a giveaway! * Did you hear that? * Did you hear that, eh? * That's what I'm on about! ** Did you see him repressing me? ** You saw him, Didn't you? ____ Figure 31: AsciiRFC Blockquote Usage Tse, et al. Expires June 15, 2018 [Page 32] Internet-Draft AsciiRFC Specifications December 2017
Dennis: Come and see the violence inherent in the system. Help! Help! I’m being repressed! King Arthur: Bloody peasant! Dennis: Oh, what a giveaway!
  • Did you hear that?
  • Did you hear that, eh?
  • That’s what I’m on about!
    • Did you see him repressing me?
    • You saw him, Didn’t you?
Figure 32: AsciiRFC Blockquote Usage (RFC XML v3) 10. Notes And Asides Asciidoctor supports a range of "admonitions", including notes, warnings, and tips. They are indicated by a paragraph prefix (e.g. "WARNING:"), or as a block with an admonition style attribute. All admonitions are conflated in AsciiRFC, being converted to "note" elements in the document preamble, and "cref" documents in the main document. This means that all admonitions will therefore not appear in the textual output. A sample of this is shown in Figure 33 with its rendered output in Figure 34. == Section 1 [NOTE,source=GBS] .Note Title ==== Any admonition inside the body of the text is a comment. ==== Figure 33: An AsciiRFC Adminition Block Tse, et al. Expires June 15, 2018 [Page 33] Internet-Draft AsciiRFC Specifications December 2017
Section 1 Any admonition inside the body of the text is a comment.
Figure 34: An AsciiRFC Adminition Block (RFC XML v3) With RFC XML v2, note that no inline formatting is permitted for "cref" elements, and is therefore stripped for v2 by the converter. Because paragraphs in AsciiRFC cannot contain any other blocks, a comment at the end of a paragraph is treated as a new block. In the document converter, any such comments are moved inside the preceding RFC XML paragraph; if the comment is at the start of a section, as in the example above, it is wrapped inside a paragraph. The RFC XML v3 converter also supports "asides" (Asciidoctor sidebars). A sample is shown in Figure 35 with its rendered output in Figure 36. == Section 1 **** Sidebar Another sidebar * This is a list .... And this is ascii-art .... **** Figure 35: An AsciiRFC Sidebar Block Tse, et al. Expires June 15, 2018 [Page 34] Internet-Draft AsciiRFC Specifications December 2017
Section 1
Figure 36: An AsciiRFC Sidebar Block Rendered As An Aside (RFC XML v3) Comments given in the AsciiDoc syntax (notated with initial "//") are not intended to be shown in the rendered output, and will not appear in the output as XML comments. 11. Tables AsciiRFC tables, like RFC XML v3, support distinct table heads, bodies and feet; cells spanning multiple rows and columns; and horizontal alignment. The larger range of table formatting options available in RFC XML v2 is also supported. A sample of an AsciiRFC table is shown in Figure 37 with its rendered output in Figure 38. Neither version of RFC XML is as expressive in its table structure as Asciidoctor. RFC XML, for example, does not permit blocks within table cells. Tse, et al. Expires June 15, 2018 [Page 35] Internet-Draft AsciiRFC Specifications December 2017 .Table Title |=== |head | head h|header cell | body cell | | body cell 2+| colspan of 2 .2+|rowspan of 2 | cell |cell ^|centre aligned cell | cell <|left aligned cell | cell >|right aligned cell | cell |foot | foot |=== Figure 37: An AsciiRFC Table Table Title Tse, et al. Expires June 15, 2018 [Page 36] Internet-Draft AsciiRFC Specifications December 2017
head head
header cell body cell
body cell
colspan of 2
rowspan of 2 cell
cell
centre aligned cell cell
left aligned cell cell
right aligned cell cell
foot foot
Figure 38: An AsciiRFC Table (RFC XML v3) 12. Inline Formatting 12.1. Italics, Boldface, Monospace, Subscripts, Superscripts AsciiRFC supports italics, boldface, monospace, subscripts and superscripts, just like RFC XML v3. The inline formatting syntax given in Figure 39 produces the RFC XML v3 output given in Figure 40. _Text_ *Text* `Text` ^Superscript^ ~Subscript~ Figure 39: Inline Formatting In AsciiRFC Text Text Text Superscript Subscript Figure 40: Inline Formatting In AsciiRFC (RFC XML v3) 12.2. Formatting BCP 14 Keywords RFC XML v3 also supports tagging of BCP14 keywords [RFC2119]; this is done in AsciiRFC either by tagging them with a custom formatting span ("bcp14#must not#"), or by converting BCP14 boldface all-caps words (unless the ":no-rfc-bold-bcp14: false" document attribute is set). Tse, et al. Expires June 15, 2018 [Page 37] Internet-Draft AsciiRFC Specifications December 2017 Any spans of BCP14 text delimited by inline formatting delimiters needs to be contained within a single line of text; the Asciidoctor API breaks up formatting spans across line breaks. This usage is demonstrated in Figure 41 with the rendered output in Figure 42. This [bcp14]#must not# stand This *MUST NOT* stand Figure 41: BCP14 Keywords In AsciiRFC This MUST NOT stand This MUST NOT stand Figure 42: BCP14 Keywords In AsciiRFC (RFC XML v3) 12.3. Escaping AsciiRFC Syntax Formatting delimiters like "*" can be escaped with backslash ("\*"); double formatting delimiters, like "**" and "__", need to be escaped with double backslash ("\\**"). Escaping delimiters is not always reliable, and for double delimiters it is preferable to use HTML entities ("**"), or attribute references (references to the value of attributes set in the document header) as shown in Figure 43. :dblast: ** `{dblast}` Figure 43: Escaping AsciiRFC Syntax Using Attributes In extreme circumstances (such as quoting AsciiDoc syntax), you may need to resort to altering the substitutions behaviour within a given block of of AsciiDoc; see the "Applying Substitutions" section of [Asciidoctor-Manual]. 13. Links Common URL formats are recognised automatically as hyperlinks in AsciiRFC, inheriting this excellent feature from AsciiDoc, and are rendered as such. Tse, et al. Expires June 15, 2018 [Page 38] Internet-Draft AsciiRFC Specifications December 2017 Any hyperlinked text is appended after the hyperlink in square brackets. An example is given in Figure 44 with its rendered version in Figure 45. http://example.com/[linktext] Figure 44: An AsciiRFC Link linktext Figure 45: An AsciiRFC Link (RFC XML v3) To prevent hyperlinking of a URL, prefix it with a backslash, as shown in Figure 46 with its rendered version in <. \http://example.com/[linktext] Figure 46: A Literal AsciiRFC Link http://example.com/[linktext] Figure 47: A Literal AsciiRFC Link (RFC XML v3) 14. Cross-References 14.1. Basic Referencing Anchors for cross-references are notated as "[[...]]" or "[#...]", and can be inserted on their own line in front of most blocks. Asciidoctor supports anchors in a much wider range of contexts than is supported than RFC XML v3 (let alone v2); anchors that are not supported for that version of RFC XML are simply ignored by the converter. Note that anchors in RFC XML are constrained to the format "[A-Za- z_:][[A-Za-z0-9_:.-]*". Cross-references to anchors are notated as "<<...>>"; cross- references with custom text as "<>". An example of using cross-references in AsciiRFC is given in Figure 48 with its rendered output in Figure 49. Tse, et al. Expires June 15, 2018 [Page 39] Internet-Draft AsciiRFC Specifications December 2017 [[cross-reference]] == Section 1 == Section 2 See <>. == Section 3 See <> Figure 48: Setting And Referring To Cross-References In AsciiRFC
Section 1
Section 2 See .
Section 3 See text
Figure 49: Setting And Referring To Cross-References In AsciiRFC (RFC XML v3) 14.2. Referencing With Attributes While Asciidoctor natively does not support attributes on cross- references, AsciiRFC works around that by embedding formatting information as templated text within cross-references: o "format=x: text" populates the "xref@format" attribute o a section number followed by one of the words "of", "parens", "bare", "text" is treated as a "relref" reference to an external document. Tse, et al. Expires June 15, 2018 [Page 40] Internet-Draft AsciiRFC Specifications December 2017 An example of referencing with attributes is given in Figure 50 with its output in Figure 51. == Section 4 See <> == Section 5 See <> See <> <> <> <> Figure 50: Cross-References With Attributes In AsciiRFC Tse, et al. Expires June 15, 2018 [Page 41] Internet-Draft AsciiRFC Specifications December 2017
Section 4 See text
Section 5 See See text text
Figure 51: Cross-References With Attributes In AsciiRFC (RFC XML v3) 15. Inclusions AsciiRFC inherits the Asciidoctor "include" directive [Asciidoctor-Manual] to include external files in a master AsciiRFC document. This directive is capable of sophisticated document merging, including adjusting the heading levels of the included text, selecting text within specified tags or line numbers to be included, and adjusting the indentation of code snippets in merged text. Its basic syntax is given in Figure 52. Tse, et al. Expires June 15, 2018 [Page 42] Internet-Draft AsciiRFC Specifications December 2017 include::path[ leveloffset=_offset_, lines=_ranges_, tag(s)=_name(s)_, indent=_depth_ ] Figure 52: Inclusions In AsciiRFC If a file is included in an AsciiRFC document, ensure it ends with a blank line. An inclusion that results in its final block not being delimited with a blank line from what follows can lead to unpredictable results. 16. Encoding and Entities XML accepts the full range of characters in the world's languages through UTF-8 character encoding, and one of the motivations for the move from plain text to RFC XML has been to allow non-ASCII characters to be included in RFCs. However, current RFC XML v2 tools still do not support UTF-8, and alternative tooling support for UTF-8 also remains patchy. Out of an abundance of caution, the RFC XML converter uses US-ASCII for its character encoding, and renders any non-ASCII characters as HTML entities. AsciiRFC accepts HTML entities as input even though they are not part of the XML specification. HTML entities such as " " feature in examples of RFC XML provided by the IETF. In order to prevent dependence of the XML output from extraneous entity definitions, any such entities are rendered in the XML as decimal character entities. An example of how AsciiRFC renders non-ASCII UTF-8 characters are given in Figure 53 with the output in Figure 54. Это Русский Язык. — This is not George's.† Figure 53: UTF-8 Characters In AsciiRFC Tse, et al. Expires June 15, 2018 [Page 43] Internet-Draft AsciiRFC Specifications December 2017 Это Русский Язык. — This is not George's.† Figure 54: UTF-8 Characters In AsciiRFC Rendered As RFC XML v3 17. Bibliography The simple encoding of bibliography syntax provided by AsciiDoc (and Asciidoctor) is inadequate for the complexity of bibliographic markup required by RFC XML. RFC documents overwhelmingly cite other RFC documents, and canonical RFC XML bibliographic entries are available at [IETF-BibXML]; so it would be inefficient to encode those entries in AsciiRFC, only to have them converted back to RFC XML. The converter provides two means of incorporating bibliographies into RFC documents authored in AsciiRFC: o using raw RFC XML; and o assembling bibliographies in preprocessing. In either case, the RFC XML needs to be well-formed; missing closing tags can lead to erratic behaviour in the converter. 17.1. Using Raw RFC XML In the first method, bibliographic citations are handled like all other AsciiRFC cross-references. The bibliographic entries for normative and informative references are given in the AsciiRFC as passthrough blocks, which contain the raw RFC XML for all references; document conversion leaves the raw RFC XML in place. This approach requires authors to maintain the normative and informative bibliographies within the document, to update them as citations are added and removed, and to sort them manually. For example, the AsciiRFC in Figure 55 will generate the corresponding RFC XML in Figure 56. Tse, et al. Expires June 15, 2018 [Page 44] Internet-Draft AsciiRFC Specifications December 2017 Some datagram padding may be needed.<> [bibliography] == Normative References ++++ Guidelines for Writing an IANA Considerations Section in RFCs Sacramento State UC Davis ++++ Figure 55: AsciiRFC Inline Bibliography Some datagram padding may be needed Normative References Guidelines for Writing an IANA Considerations Section in RFCs Sacramento State UC Davis Figure 56: AsciiRFC Inline Bibliography Rendered As RFC XML v3 Tse, et al. Expires June 15, 2018 [Page 45] Internet-Draft AsciiRFC Specifications December 2017 17.2. Preprocessing Using asciidoctor- bibliography The alternative method is to use a preprocessing tool, [asciidoctor-bibliography], to import citations into the AsciiRFC document from an external file of references. The references file consists of RFC XML reference entries, and still needs to be managed manually; however the bibliographies are assembled from that file, sorted, and inserted into the normative and informative references in preprocessing. Citations in the document itself are given as macros to be interpreted by the preprocessor; this allows them to be split into normative and informative references. (The MMark tool likewise splits reference citations into normative and informative.) Integration with the "asciidoc-bibliography" gem proceeds as follows: 1. Create an RFC XML references file, consisting of a "" element with individual "" elements inserted, as would be done for the informative and normative references normally. The references file will contain all possible references to be used in the file; the bibliography gem will select which references have actually been cited in the document. A. Rather than hand crafting RFC XML references for RFC documents, you should download them from an authoritative source; e.g. "http://xml.resource.org/public/rfc/bibxml/ reference.RFC.2119.xml" B. Unlike the case for RFC XML documents created manually, the references file does not recognise XML entities and will not attempt to download them during processing. Any references to "http://xml.resource.org/public/rfc/bibxml/" will need to be downloaded and inserted into the references file. C. The RFC XML in the references file will need to be appropriate to the version of RFC XML used in the main document, as usual. Note that RFC XML v2 references are forward compatible with v3; v3 contains a couple of additional elements. 2. Add to the main document header attributes referencing the references file (":bibliography-database:"), and the bibliography style (":bibliography-style: rfc-v3"). Tse, et al. Expires June 15, 2018 [Page 46] Internet-Draft AsciiRFC Specifications December 2017 3. References to a normative reference are inserted with the macro "cite:norm[id]" instead of "<>", where "id" is the anchor of the reference. 4. References to an infomrative reference are inserted with the macro "cite:info[id]" instead of "<>", where "id" is the anchor of the reference. 5. Formatted crossreferences and "relref" crossreferences are entered by inserting the expected raw XML in the "text" attribute. Do not use the "{cite}" interpolation of the citation. For example: * "<>" = "cite:norm[id, text="words"]" * "<>" (processed as a formatted cross-reference) = "cite:norm[id, text="words"]" * "<>" (processed as relref) = "cite:norm[id, text=""]" * "<>" (processed as relref with a cross-document internal reference) = "cite:norm[id, text=""]" 6. Normative and Informative References are inserted in the document through a macro, which occurs where the RFC XML references would be inserted, as shown in Figure 57. Tse, et al. Expires June 15, 2018 [Page 47] Internet-Draft AsciiRFC Specifications December 2017 [bibliography] == Normative References ++++ bibliography::norm[] ++++ [bibliography] == Informative References ++++ bibliography::info[] ++++ Figure 57: Using asciidoctor-bibliography For Bibliography Preprocessing 18. RFC XML features not supported in Asciidoctor The following features of RFC XML v3 [RFC7991] and v2 [RFC7749] are not supported by the AsciiRFC converter, and would need to be adjusted manually after RFC XML is generated: +------------------------+--------------------+---------------------+ | RFC XML element | RFC XML v3 | RFC XML v2 | +------------------------+--------------------+---------------------+ | "front/boilerplate" | Not added by the | Not added by the | | | converter | converter | | "iref@primary" | N | N | | "reference" (and all | As Raw XML | As Raw XML | | children) | | | | "table/preamble" | Deprecated | N | | "table/postamble" | Deprecated | N | | "artwork@width" | Only on images | Only on images | | "artwork@height" | Only on images | Only on images | +------------------------+--------------------+---------------------+ 19. Authoring To author an AsciiRFC document, you should first familiarise yourself with the [Asciidoctor-Manual]. The [asciidoctor-rfc] Ruby gem source code distribution also has samples of individual RFC XML features in v2 and v3, and examples of self-standing AsciiRFC documents, along with their RFC XML renderings. (This includes round-tripped RFC XML documents.) Tse, et al. Expires June 15, 2018 [Page 48] Internet-Draft AsciiRFC Specifications December 2017 19.1. Using the rfc-in-asciidoc-template In addition, you can clone the sample "rfc-in-asciidoc-template" repository as a template, and populate it for your AsciiRFC document using the steps shown in Figure 58. $ git clone https://github.com/riboseinc/rfc-in-asciidoc-template Figure 58: Cloning The AsciiRFC Document Template 19.2. Installing AsciiRFC Backend Processors Converting your AsciiRFC to RFC XML is a simple as installing Asciidoctor (see "Installation" at [Asciidoctor]) and the "asciidoctor-rfc" gem in Ruby (through RubyGems), then running the asciidoctor executable on the document, specifying the asciidoctor- rfc gem as a library. The necessary steps are shown in Figure 59. $ gem install asciidoctor-rfc $ asciidoctor -b rfc3 -r 'asciidoctor-rfc' foo.adoc # RFC XML v3 output $ asciidoctor -b rfc2 -r 'asciidoctor-rfc' foo.adoc # RFC XML v2 output Figure 59: Installing The AsciiRFC Backend Processors 19.3. Iterating AsciiRFC Content As you author AsciiRFC content, you should iterate through running the Asciidoctor conversion frequently, to ensure that you are still generating valid XML through your markup. The converter makes an effort to ensure that its XML output is valid, and it issues warnings about likely issues; it also validates its own XML output against the RFC XML schema (of the corresponding version), and reports errors in the XML output in the format shown in Figure 60. V3 RELAXNG Validation: 12:0: ERROR: Invalid attribute sortRefs for element rfc Figure 60: Sample Validation Error Message From AsciiRFC Note that validation against the RELAXNG RFC XML schema includes confirming the referential integrity of all cross-references in the document. It may be necessary to intervene in the XML output generated by the converter, either because the block model of AsciiRFC does not conform with the intended RFC XML (e.g. lists embedded in Tse, et al. Expires June 15, 2018 [Page 49] Internet-Draft AsciiRFC Specifications December 2017 paragraphs), or because RFC XML features are required that are not supported within AsciiRFC. 20. Security Considerations o Ensure your AsciiRFC generator comes from a geniune and trustworthy source. This protects your own machine and also prevents injection of malicious content in your resulting document. o An AsciiRFC generator may cause errors in textual rendering or link generation that may lead to security issues. o Creating cross-references (and also bibliographic references) to external documents may pose risks since the specified external location may become controlled by a malicious party. 21. IANA Considerations This document does not require any action by IANA. 22. Examples 22.1. Example 1: AsciiRFC = The Holy Hand Grenade of Antioch Arthur Pendragon :doctype: internet-draft :name: draft-iab-holy-hand-grenade-antioch-00 :status: informational :ipr: trust200902 :toc-include: true :forename_initials: A. :organization: Camelot :revdate: 932-06-23 :area: General :workgroup: Internet Architecture Board :smart-quotes: false [abstract] The Killer Rabbit of Caerbannog is a fictional character in the Monty Python film _Monty Python and the Holy Grail_. The scene in _Holy Grail_ was written by Graham Chapman and John Cleese. The rabbit is the antagonist in a major set piece battle, and makes a similar appearance in _Spamalot_, a musical inspired by the movie. == Terminology In this document, the key words *MUST*, *MUST NOT*, *REQUIRED*, Tse, et al. Expires June 15, 2018 [Page 50] Internet-Draft AsciiRFC Specifications December 2017 *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *MAY*, and *OPTIONAL* are to be interpreted as described in BCP 14, <>. == In The Film The Cave of Caerbannog (_caer bannog_ being Welsh for "turreted castle", thus making its title a pun on the English dish "Welsh rabbit") is the home of the Legendary Black Beast of Arrrghhh (named for the last utterance of anyone who ever saw it). This is guarded by a monster which is initially unknown. King Arthur and his knights are led to the cave by Tim the Enchanter and find that they must face its guardian beast. === Holy Hand Grenade of Antioch The Holy Hand Grenade of Antioch is a visual satire of the Sovereign's Orb of the United Kingdom, and may refer to the mythical Holy Spear of Antioch. The Holy Hand Grenade is described as one of the "sacred relics" carried by Brother Maynard. Despite its ornate appearance and long-winded instructions, it functions much the same as any other hand grenade. [bibliography] == Normative References ++++ Key words for use in RFCs to Indicate Requirement Levels ++++ [appendix] == Cultural Impact The rabbit is now used as a metaphor for something ostensibly harmless which is, in fact, deadly. Such hidden but real risks may even arise from similarly cuddly animals. Tse, et al. Expires June 15, 2018 [Page 51] Internet-Draft AsciiRFC Specifications December 2017 22.2. Example 1: RFC XML v3 The Holy Hand Grenade of Antioch Camelot
arthur@camelot.gov.uk
General Internet Architecture Board The Killer Rabbit of Caerbannog is a fictional character in the Monty Python film Monty Python and the Holy Grail. The scene in Holy Grail was written by Graham Chapman and John Cleese. The rabbit is the antagonist in a major set piece battle, and makes a similar appearance in Spamalot, a musical inspired by the movie.
Terminology In this document, the key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, Tse, et al. Expires June 15, 2018 [Page 52] Internet-Draft AsciiRFC Specifications December 2017 RECOMMENDED, MAY, and OPTIONAL are to be interpreted as described in BCP 14, .
In The Film The Cave of Caerbannog (caer bannog being Welsh for "turreted castle", thus making its title a pun on the English dish "Welsh rabbit") is the home of the Legendary Black Beast of Arrrghhh (named for the last utterance of anyone who ever saw it). This is guarded by a monster which is initially unknown. King Arthur and his knights are led to the cave by Tim the Enchanter and find that they must face its guardian beast.
Holy Hand Grenade of Antioch The Holy Hand Grenade of Antioch is a visual satire of the Sovereign's Orb of the United Kingdom, and may refer to the mythical Holy Spear of Antioch. The Holy Hand Grenade is described as one of the "sacred relics" carried by Brother Maynard. Despite its ornate appearance and long-winded instructions, it functions much the same as any other hand grenade.
Normative References
Cultural Impact The rabbit is now used as a metaphor for something ostensibly harmless which is, in fact, deadly. Such hidden but real risks may even arise from similarly cuddly animals.
22.3. Example 2: AsciiRFC = The Holy Hand Grenade of Antioch :doctype: internet-draft :abbrev: Hand Grenade of Antioch Tse, et al. Expires June 15, 2018 [Page 53] Internet-Draft AsciiRFC Specifications December 2017 :submission-type: independent :name: draft-iab-holy-hand-grenade-antioch-01 :status: informational :consensus: false :ipr: trust200902 :toc-include: true :fullname: Arthur son of Uther Pendragon :forename_initials: A. :lastname: Pendragon :email: arthur@camelot.gov.uk :forename_initials: A. :organization: Camelot :uri: http://camelot.gov.uk :street: Palace\ Camel Lot 1 :city: Camelot :country: England :fullname_2: Patsy :lastname_2: Patsy :role_2: editor :email_2: patsy@camelot.gov.uk :organization_2: Camelot :postal-line_2: Camel Lot 9\ Camelot\ England :revdate: 932-06-23 :area: General, Operations and Management :workgroup: Internet Architecture Board :keyword: rabbits, grenades :smart-quotes: false :obsoletes: 10, 20 :updates: 2010 :sort-refs: true :comments: yes :notedraftinprogress: yes :link: https://en.wikipedia.org/wiki/Rabbit_of_Caerbannog convertedFrom, http://questionthekillerrabbit.tumblr.com preview [abstract] The Killer Rabbit of Caerbannog is a fictional character in the Monty Python film _Monty Python and the Holy Grail_. The scene in _Holy Grail_ was written by Graham Chapman and John Cleese. The rabbit is the antagonist in a major set piece battle, and makes a similar appearance in _Spamalot_, a musical inspired by the movie. See also <> [NOTE,remove-in-rfc=false] .Spamalot The iconic status of this scene was important in establishing the viability of the musical. Tse, et al. Expires June 15, 2018 [Page 54] Internet-Draft AsciiRFC Specifications December 2017 [toc=exclude] :sectnums!: == Terminology In this document, the key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *MAY*, and *OPTIONAL* are to be interpreted as described in BCP 14, <>. :sectnums: == In The Film The Cave of Caerbannog (_caer bannog_ being Welsh for "turreted castle", thus making its title a pun on the English dish "Welsh rabbit") is the home of the Legendary Black Beast of Arrrghhh (((Killer Rabbit of Caerbannog))) (named for the last utterance of anyone who ever saw it). This is guarded by a monster which is initially unknown. ((King Arthur)) and his knights are led to the cave by ((Tim the Enchanter)) and find that they must face its guardian beast. **** The rabbit scene was shot outside the Tomnadashan mine, a cave 4 miles (6.5 km) from the Perthshire village of Killin. For the 25th anniversary DVD, Michael Palin and Terry Jones returned to be interviewed in front of the cave but they could not remember the location. **** * Tim verbally paints a picture of a terrible monster with "nasty, big, pointy teeth!", so terrifying that Sir Robin soils his armour at the mere description. (((Sir Robin, soiling armour))) * When the guardian appears to be an innocuous white rabbit (<>: http://ascii.co.uk/art/rabbit[RABBIT - ASCII ART]), surrounded by the bones of the fallen, Arthur and his knights no longer take it seriously. ** Ignoring Tim's warnings ("a vicious streak a mile wide!"), King Arthur orders Bors to chop its head off. [upperalpha,group=Victims] ... Bors confidently approaches it, sword drawn, and is immediately decapitated by the rabbit biting clean through his neck, to the sound of a can opener. ** Despite their initial shock, Sir Robin soiling his armor again, and Tim's loud scoffing, the knights attack in force. [upperalpha,group=Victims] ... But the rabbit injures several Tse, et al. Expires June 15, 2018 [Page 55] Internet-Draft AsciiRFC Specifications December 2017 of the knights and kills Gawain and Ector with ease. The knights themselves have no hope of killing or injuring the rabbit. ** Arthur panics and shouts for the knights to retreat ("Run away!"). * Knowing they cannot risk attacking again, they try to find another way to defeat the beast. * The Holy Hand Grenade of Antioch is ultimately used to kill it and allow the quest to proceed. [NOTE,display=false,source=Lancelot] .Tip for the Bridge scene What is Lancelot's favourite colour? Will come in handy later. [[killer_bunny]] .Figure 1 ==== [alt=Killer Bunny] .... /\ /| |||| | \ | \ _ _ / @ @ / \ =>X<= /| | / \| /__| | \_____\ \__\ unknown .... ==== .Dramatis Personae [grid=all] |=== |Actor |Role |Graham Chapman >|King Arthur |John Cleese >|Tim the Enchanter .2+|Eric Idle >|Sir Robin >|Brother Maynard |Terry Gilliam >|Sir Bors |Michael Palin >|The Lector |=== === Holy Hand Grenade of Antioch Tse, et al. Expires June 15, 2018 [Page 56] Internet-Draft AsciiRFC Specifications December 2017 [[sovereign_orb]] .Figure 2 ==== .Sovereign's Orb [link=https://en.wikipedia.org/wiki/File:British_Sovereigns_Orb.jpg, align=right] image::https://en.wikipedia.org/wiki/File:British_Sovereigns_Orb.jpg [Orb,124,135] ==== The Holy Hand Grenade of Antioch is a visual satire of the Sovereign's Orb of the United Kingdom, Figure <>, and may refer to the mythical Holy Spear of Antioch. The Holy Hand Grenade is described as one of the "sacred relics" carried by Brother Maynard. Despite its ornate appearance and long-winded instructions, it functions much the same as any other hand grenade. At King Arthur's prompting, instructions for its use are read aloud from the fictitious _Book of Armaments_, Chapter 2, verses 9-21. NOTE: Verses parodying the King James Bible and the Athanasian Creed. [keep-with-previous=true] [quote,Book of Armaments 2:9-21, https://genius.com/Monty-python-holy-hand-grenade-of-antioch-lyrics] And Saint Attila raised the hand grenade up on high, saying, "O *LORD*, bless this Thy hand grenade that with it Thou [bcp14]#mayest# blow Thine enemies to tiny bits, in Thy mercy." And the *LORD* did grin and the people did feast upon the lambs and sloths and carp and anchovies and orangutans and breakfast cereals, and fruit bats and large chu... [At this point, the friar is urged by ((Brother Maynard)) to "skip a bit, brother"]... And the *LORD* spake, saying, "First [bcp14]#shalt# thou take out the Holy Pin, then [bcp14]#shalt# thou count to three, no more, no less. Three [bcp14]#shall# be the number thou [bcp14]#shalt# count, and the number of the counting [bcp14]#shall# be three. Four [bcp14]#shalt# thou not count, neither count thou two, excepting that thou then proceed to three. Five is right out. Once the number three, being the third number, be reached, then lobbest thou thy Holy Hand Grenade of Antioch towards thy foe, who being naughty in My sight, [bcp14]#shall# snuff it." === Code Example .Sample Python program [source,python,align=center] ---- ready = True Tse, et al. Expires June 15, 2018 [Page 57] Internet-Draft AsciiRFC Specifications December 2017 if ready: print("Hello World!") ---- [bibliography] == Normative References ++++ Key words for use in RFCs to Indicate Requirement Levels ++++ [bibliography] == Informative References ++++ DON'T SPEW A Set of Guidelines for Mass Unsolicited Mailings and Postings (spam*) ++++ Tse, et al. Expires June 15, 2018 [Page 58] Internet-Draft AsciiRFC Specifications December 2017 22.4. Example 2: RFC XML v3 The Holy Hand Grenade of Antioch Camelot
Palace Camel Lot 1 Camelot England arthur@camelot.gov.uk http://camelot.gov.uk
Camelot
Camel Lot 9 Camelot England Tse, et al. Expires June 15, 2018 [Page 59] Internet-Draft AsciiRFC Specifications December 2017 patsy@camelot.gov.uk
General Operations and Management Internet Architecture Board rabbits grenades The Killer Rabbit of Caerbannog is a fictional character in the Monty Python film Monty Python and the Holy Grail. The scene in Holy Grail was written by Graham Chapman and John Cleese. The rabbit is the antagonist in a major set piece battle, and makes a similar appearance in Spamalot, a musical inspired by the movie. See also What is Spam*? Spamalot The iconic status of this scene was important in establishing the viability of the musical.
Terminology In this document, the key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL are to be interpreted as described in BCP 14, .
In The Film The Cave of Caerbannog (caer bannog being Welsh for "turreted castle", thus making its title a pun on the English Tse, et al. Expires June 15, 2018 [Page 60] Internet-Draft AsciiRFC Specifications December 2017 dish "Welsh rabbit") is the home of the Legendary Black Beast of Arrrghhh (named for the last utterance of anyone who ever saw it). This is guarded by a monster which is initially unknown. King Arthur and his knights are led to the cave by Tim the Enchanter and find that they must face its guardian beast.
  • Tim verbally paints a picture of a terrible monster with "nasty, big, pointy teeth!", so terrifying that Sir Robin soils his armour at the mere description.
  • When the guardian appears to be an innocuous white rabbit (See depiction: RABBIT - ASCII ART), surrounded by the bones of the fallen, Arthur and his knights no longer take it seriously.
    • Ignoring Tim's warnings ("a vicious streak a mile wide!"), King Arthur orders Bors to chop its head off.
      1. Bors confidently approaches it, sword drawn, and is immediately decapitated by the rabbit biting clean through his neck, to the sound of a can opener.
    • Despite their initial shock, Sir Robin soiling his armor again, and Tim's loud scoffing, the knights attack in force.
      1. But the rabbit injures several of the knights and kills Gawain and Ector with ease. The knights themselves have no hope of killing or injuring the rabbit.
      • Tse, et al. Expires June 15, 2018 [Page 61] Internet-Draft AsciiRFC Specifications December 2017
    • Arthur panics and shouts for the knights to retreat ("Run away!").
  • Knowing they cannot risk attacking again, they try to find another way to defeat the beast.
  • The Holy Hand Grenade of Antioch is ultimately used to kill it and allow the quest to proceed.
What is Lancelot's favourite colour? Will come in handy later.
Figure 1 /\ /| |||| | \ | \ _ _ / @ @ / \ =>X<= /| | / \| /__| | \_____\ \__\ unknown
Dramatis Personae Tse, et al. Expires June 15, 2018 [Page 62] Internet-Draft AsciiRFC Specifications December 2017
Actor Role
Graham Chapman King Arthur
John Cleese Tim the Enchanter
Eric Idle Sir Robin
Brother Maynard
Terry Gilliam Sir Bors
Michael Palin The Lector
Holy Hand Grenade of Antioch
Figure 2
The Holy Hand Grenade of Antioch is a visual satire of the Sovereign's Orb of the United Kingdom, Figure , and may refer to the mythical Holy Spear of Antioch. The Holy Hand Grenade is described as one of the "sacred relics" carried by Brother Maynard. Despite its ornate appearance and long-winded instructions, it functions much the same as any other hand grenade. At King Arthur's prompting, instructions for its use are read aloud from the fictitious Book of Armaments, Chapter 2, verses 9-21. Verses parodying the King James Bible and the Athanasian Creed.
And Saint Attila raised the hand grenade up on high, saying, "O LORD, bless this Thy hand grenade that with it Thou MAYEST blow Thine enemies to tiny bits, in Thy mercy." And the LORD did grin and the people did feast upon the lambs and sloths and carp and anchovies and orangutans and breakfast cereals, and fruit Tse, et al. Expires June 15, 2018 [Page 63] Internet-Draft AsciiRFC Specifications December 2017 bats and large chu…​ [At this point, the friar is urged by Brother Maynard to "skip a bit, brother"]…​ And the LORD spake, saying, "First SHALT thou take out the Holy Pin, then SHALT thou count to three, no more, no less. Three SHALL be the number thou SHALT count, and the number of the counting SHALL be three. Four SHALT thou not count, neither count thou two, excepting that thou then proceed to three. Five is right out. Once the number three, being the third number, be reached, then lobbest thou thy Holy Hand Grenade of Antioch towards thy foe, who being naughty in My sight, SHALL snuff it."
Code Example
ready = True if ready: print("Hello World!")
Normative References Informative References Tse, et al. Expires June 15, 2018 [Page 64] Internet-Draft AsciiRFC Specifications December 2017 23. References 23.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC7991] Hoffman, P., "The "xml2rfc" Version 3 Vocabulary", RFC 7991, DOI 10.17487/RFC7991, December 2016, . 23.2. Informative References [AsciiDoc] Rackham, S., "AsciiDoc: Text based document generation", November 2013, . [Asciidoctor] Allen, D., Waldron, R., and S. White, "Asciidoctor: A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.", November 2017, . [asciidoctor-bibliography] Ribose Inc., "Citations and Bibliography the 'asciidoctor- way'", November 2017, . [Asciidoctor-Manual] Allen, D., Waldron, R., and S. White, "Asciidoctor: A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.", November 2017, . [asciidoctor-rfc] Ribose Inc., "asciidoctor-rfc lets you write Internet- Drafts and RFCs in AsciiDoc, the "asciidoctor-way".", November 2017, . [AsciiMathML] "AsciiMath is an easy-to-write markup language for mathematics.", November 2017, . [draftr] Barnes, R., "draftr: an HTML front-end to pandoc2rfc", Nov 2017, . Tse, et al. Expires June 15, 2018 [Page 65] Internet-Draft AsciiRFC Specifications December 2017 [IETF-BibXML] "IETF BibXML Library", November 2017, . [kramdown-rfc2629] Bormann, C., "kramdown-rfc2629: An RFC2629 (XML2RFC) backend for Thomas Leitner's kramdown markdown parser", Nov 2017, . [lyx2rfc] Williams, N., "LyX to I-D/RFC export by way of Lyx export to XHTML and XSLT conversion to xml2rfc schema", 2014, . [MathJax] "MathJax: A JavaScript display engine for mathematics that works in all browsers.", November 2017, . [mmark] Gieben, R., "Using mmark to create I-Ds and RFCs", June 2015, . [NroffEdit] Santesson, S., "WYSIWYG Internet-Draft Nroff Editor", May 2011, . [pandoc2rfc] Gieben, R., "pandoc2rfc: Use pandoc to create XML suitable for xml2rfc", 2012, . [RFC5385] Touch, J., "Version 2.0 Microsoft Word Template for Creating Internet Drafts and RFCs", RFC 5385, DOI 10.17487/RFC5385, February 2010, . [RFC7328] Gieben, R., "Writing I-Ds and RFCs Using Pandoc and a Bit of XML", RFC 7328, DOI 10.17487/RFC7328, August 2014, . [RFC7749] Reschke, J., "The "xml2rfc" Version 2 Vocabulary", RFC 7749, DOI 10.17487/RFC7749, February 2016, . [RFC7763] Leonard, S., "The text/markdown Media Type", RFC 7763, DOI 10.17487/RFC7763, March 2016, . Tse, et al. Expires June 15, 2018 [Page 66] Internet-Draft AsciiRFC Specifications December 2017 [RFC7764] Leonard, S., "Guidance on Markdown: Design Philosophies, Stability Strategies, and Select Registrations", RFC 7764, DOI 10.17487/RFC7764, March 2016, . [RFC7990] Flanagan, H., "RFC Format Framework", RFC 7990, DOI 10.17487/RFC7990, December 2016, . [TeX-LaTeX] "LaTeX is document preparation software that runs on top of Donald E. Knuth's TeX typesetting system.", November 2017, . Appendix A. Acknowledgements The authors would like to thank the following persons for their valuable advice and input. Authors' Addresses Ronald Henry Tse Ribose Suite 1111, 1 Pedder Street Central, Hong Kong Hong Kong Email: ronald.tse@ribose.com URI: https://www.ribose.com Nick Nicholas Ribose Australia Email: nick.nicholas@ribose.com URI: https://www.ribose.com Jeffrey Lau Ribose Suite 1111, 1 Pedder Street Central, Hong Kong Hong Kong Email: jeffrey.lau@ribose.com URI: https://www.ribose.com Tse, et al. Expires June 15, 2018 [Page 67] Internet-Draft AsciiRFC Specifications December 2017 Paolo Brasolin Ribose Italy Email: paolo.brasolin@ribose.com URI: https://www.ribose.com Tse, et al. Expires June 15, 2018 [Page 68]