Network Working Group J. Carberry Internet-Draft T. Grayson Intended status: Informational Brown University Expires: September 24, 2018 March 23, 2018 A Minimal Internet-Draft In AsciiRFC draft-asciirfc-minimal-00 Abstract This document provides a template on how to author (or migrate!) a new Internet-Draft / RFC in 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 September 24, 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 September 24, 2018 [Page 1] Internet-Draft AsciiRFC Example March 2018 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Terms and Definitions . . . . . . . . . . . . . . . . . . . . 2 3. Symbols And Abbreviations . . . . . . . . . . . . . . . . . . 2 3.1. Operators . . . . . . . . . . . . . . . . . . . . . . . . 2 4. Security Considerations . . . . . . . . . . . . . . . . . . . 2 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 3 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 3 6.1. Normative References . . . . . . . . . . . . . . . . . . 3 6.2. Informative References . . . . . . . . . . . . . . . . . 3 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 3 A.1. Example 1 . . . . . . . . . . . . . . . . . . . . . . . . 3 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 4 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 4 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 [RFC7991]. This is a template for authors to easily start with [I-D.ribose-asciirfc]. 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. 3. Symbols And Abbreviations 3.1. Operators AsciiRFC As defined in [I-D.ribose-asciirfc]. 4. Security Considerations o Please beware of implementation issues caused by Section 3.1. o Here's how you include references [I-D.ribose-cfrg-sm4], [RFC7253], [RNP]. Carberry & Grayson Expires September 24, 2018 [Page 2] Internet-Draft AsciiRFC Example March 2018 5. IANA Considerations This document does not require any action by IANA. 6. References 6.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, . 6.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. [I-D.ribose-cfrg-sm4] Tse, R. and W. Wong, "The SM4 Blockcipher Algorithm And Its Modes Of Operations", draft-ribose-cfrg-sm4-08 (work in progress), December 2017. [RFC7253] Krovetz, T. and P. Rogaway, "The OCB Authenticated- Encryption Algorithm", RFC 7253, DOI 10.17487/RFC7253, May 2014, . [RNP] Ribose Inc., "Botan: Crypto and TLS for C++11", October 2017, . Appendix A. Examples A.1. Example 1 Here's an example. Carberry & Grayson Expires September 24, 2018 [Page 3] Internet-Draft AsciiRFC Example March 2018 { "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 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 September 24, 2018 [Page 4]