Network Working Group J. Carberry Internet-Draft T. Grayson Intended status: Informational Brown University Expires: October 14, 2018 April 12, 2018 A Minimal Internet-Draft In AsciiRFC draft-asciirfc-minimal-02 Abstract This document provides a template on how to author (or migrate!) a new Internet-Draft / RFC in the AsciiRFC format. This template requires usage of the "asciidoctor-rfc" Ruby gem. 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 October 14, 2018. Copyright Notice Copyright (c) 2018 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. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Carberry & Grayson Expires October 14, 2018 [Page 1] Internet-Draft AsciiRFC Example April 2018 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Terms and Definitions . . . . . . . . . . . . . . . . . . . . 2 3. Symbols And Abbreviations . . . . . . . . . . . . . . . . . . 3 4. Main content . . . . . . . . . . . . . . . . . . . . . . . . 3 4.1. Getting started . . . . . . . . . . . . . . . . . . . . . 3 4.1.1. AsciiRFC toolchain . . . . . . . . . . . . . . . . . 3 4.1.2. XML RFC toolchain . . . . . . . . . . . . . . . . . . 3 4.2. Referencing external content . . . . . . . . . . . . . . 3 4.3. Code snippets . . . . . . . . . . . . . . . . . . . . . . 4 5. Security Considerations . . . . . . . . . . . . . . . . . . . 4 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 4 7.1. Normative References . . . . . . . . . . . . . . . . . . 4 7.2. Informative References . . . . . . . . . . . . . . . . . 4 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 5 A.1. Example 1 . . . . . . . . . . . . . . . . . . . . . . . . 5 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 5 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 1. Introduction AsciiRFC [I-D.ribose-asciirfc] is an extremely simple way to author Internet-Drafts and RFCs without needing to manually craft RFC XML conforming to [RFC7991]. This is a template specifically made for authors to easily start with creating an Internet-Draft conforming to [RFC7991] and submittable to the IETF datatracker. 2. Terms and Definitions The key words "*MUST*", "*MUST NOT*", "*REQUIRED*", "*SHALL*", "*SHALL NOT*", "*SHOULD*", "*SHOULD NOT*", "*RECOMMENDED*", "*NOT RECOMMENDED*", "*MAY*", and "*OPTIONAL*" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. This document also refers to the following terms and definitions: AsciiRFC an AsciiDoc-derived syntax used for authoring RFCs and Internet- Drafts, as defined in [I-D.ribose-asciirfc]. Carberry & Grayson Expires October 14, 2018 [Page 2] Internet-Draft AsciiRFC Example April 2018 3. Symbols And Abbreviations ADRFC abbreviated form of AsciiRFC 4. Main content This is where you place the main content, and the following serves as a placeholder for your text. Subsections are used here for demonstration purposes. 4.1. Getting started The AsciiRFC and RFC toolchains *MUST* be available locally to build this document template. 4.1.1. AsciiRFC toolchain You will need to have: o Ruby: for running the AsciiRFC toolchain o "asciidoctor-rfc" gem: for converting AsciiRFC into XML RFC (v2 or v3) 4.1.2. XML RFC toolchain You will need to have: o Python: for running "xml2rfc" o "xml2rfc": for converting RFC XML (v2 or v3) into TXT o "idnits": for submission preflight 4.2. Referencing external content o This is a published RFC [RFC7253] o This is an Internet-Draft [I-D.ribose-asciirfc] o This is an external reference [RNP] Carberry & Grayson Expires October 14, 2018 [Page 3] Internet-Draft AsciiRFC Example April 2018 4.3. Code snippets Code snippets should be wrapped with "" and "" blocks, as required by the IETF Trust Legal Provisions (TLP) [IETF.TLP] specified in [RFC5378]. 5. Security Considerations Any security considerations should be placed here. As described in Section 4 (here's how you refer a local anchor), local tools have to be installed before the document template can be built. Running of these local tools *MAY* produce unintended side effects that impact security. 6. IANA Considerations This document does not require any action by IANA. But if it does, such as proposing changes to IANA registries, please include them here. 7. References 7.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, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . 7.2. Informative References [I-D.ribose-asciirfc] Tse, R., Nicholas, N., and P. Brasolin, "AsciiRFC: Authoring Internet-Drafts And RFCs Using AsciiDoc", draft- ribose-asciirfc-04 (work in progress), December 2017. Carberry & Grayson Expires October 14, 2018 [Page 4] Internet-Draft AsciiRFC Example April 2018 [IETF.TLP] IETF, "IETF Trust Legal Provisions (TLP)", April 2018, . [RFC5378] Bradner, S., Ed. and J. Contreras, Ed., "Rights Contributors Provide to the IETF Trust", BCP 78, RFC 5378, DOI 10.17487/RFC5378, November 2008, . [RFC7253] Krovetz, T. and P. Rogaway, "The OCB Authenticated- Encryption Algorithm", RFC 7253, DOI 10.17487/RFC7253, May 2014, . [RNP] Ribose Inc., "RNP: A C library approach to OpenPGP", March 2018, . Appendix A. Examples A.1. Example 1 Here's an example of a properly wrapped code snippet in accordance with rules specified in Section 4.3. { "code": { "encoding": "ascii", "type": "rfc", "authors": [ "Josiah Carberry", "Truman Grayson" ] } } Appendix B. Acknowledgements The authors would like to thank their families. Authors' Addresses Josiah Stinkney Carberry Brown University Box K, 69 Brown Street Providence 02912 United States of America Phone: +1 401 863 1000 Email: josiah.carberry@ribose.com URI: https://www.brown.edu Carberry & Grayson Expires October 14, 2018 [Page 5] Internet-Draft AsciiRFC Example April 2018 Truman Grayson Brown University Box G, 69 Brown Street Providence 02912 United States of America Phone: +1 401 863 1000 Email: truman.grayson@ribose.com URI: https://www.brown.edu Carberry & Grayson Expires October 14, 2018 [Page 6]