idnits 2.17.1 draft-asciirfc-minimal-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (December 12, 2018) is 1961 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Unused Reference: 'RFC5378' is defined on line 212, but no explicit reference was found in the text Summary: 0 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group J. Carberry 3 Internet-Draft T. Grayson 4 Intended status: Informational Brown University 5 Expires: June 15, 2019 December 12, 2018 7 A Minimal Internet-Draft In AsciiRFC 8 draft-asciirfc-minimal-03 10 Abstract 12 This document provides a template on how to author (or migrate!) a 13 new Internet-Draft / RFC in the AsciiRFC format. 15 NOTE 17 This template requires usage of the Metanorma toolchain and the 18 "metanorma-ietf" Ruby gem. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at https://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on June 15, 2019. 37 Copyright Notice 39 Copyright (c) 2018 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (https://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 55 2. Terms and Definitions . . . . . . . . . . . . . . . . . . . . 2 56 3. Symbols And Abbreviations . . . . . . . . . . . . . . . . . . 3 57 4. Main content . . . . . . . . . . . . . . . . . . . . . . . . 3 58 4.1. Getting started . . . . . . . . . . . . . . . . . . . . . 3 59 4.1.1. Metanorma toolchain . . . . . . . . . . . . . . . . . 3 60 4.1.2. XML RFC toolchain . . . . . . . . . . . . . . . . . . 3 61 4.2. Referencing external content . . . . . . . . . . . . . . 3 62 4.3. Code snippets . . . . . . . . . . . . . . . . . . . . . . 4 63 5. Security Considerations . . . . . . . . . . . . . . . . . . . 4 64 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 65 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 4 66 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 4 67 8.1. Normative References . . . . . . . . . . . . . . . . . . 4 68 8.2. Informative References . . . . . . . . . . . . . . . . . 5 69 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 5 70 A.1. Example 1 . . . . . . . . . . . . . . . . . . . . . . . . 5 71 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6 73 1. Introduction 75 AsciiRFC [I-D.ribose-asciirfc] is an extremely simple way to author 76 Internet-Drafts and RFCs without needing to manually craft RFC XML 77 conforming to [RFC7991]. 79 This is a template specifically made for authors to easily start with 80 creating an Internet-Draft conforming to [RFC7991] and submittable to 81 the IETF datatracker. 83 2. Terms and Definitions 85 The key words "*MUST*", "*MUST NOT*", "*REQUIRED*", "*SHALL*", 86 "*SHALL NOT*", "*SHOULD*", "*SHOULD NOT*", "*RECOMMENDED*", "*NOT 87 RECOMMENDED*", "*MAY*", and "*OPTIONAL*" in this document are to be 88 interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only 89 when, they appear in all capitals, as shown here. 91 This document also refers to the following terms and definitions: 93 AsciiRFC 94 an AsciiDoc-derived syntax used for authoring RFCs and Internet- 95 Drafts, as defined in [I-D.ribose-asciirfc]. 97 3. Symbols And Abbreviations 99 ADRFC 100 abbreviated form of _AsciiRFC_ 102 4. Main content 104 This is where you place the main content, and the following serves as 105 a placeholder for your text. 107 Subsections are used here for demonstration purposes. 109 4.1. Getting started 111 The Metanorma and RFC toolchains *MUST* be available locally to build 112 this document template. 114 4.1.1. Metanorma toolchain 116 You will need to have: 118 1. Ruby: for running Metanorma 120 a. "metanorma-cli" gem: for the Metanorma command-line interface 122 b. "metanorma-ietf" gem: for converting AsciiRFC into XML RFC (v2 or 123 v3) 125 4.1.2. XML RFC toolchain 127 You will need to have: 129 1. Python: for running "xml2rfc" 131 A. "xml2rfc": for converting RFC XML (v2 or v3) into TXT 133 B. "idnits": for submission preflight 135 4.2. Referencing external content 137 o This is a published RFC [RFC7253] 139 o This is an Internet-Draft [I-D.ribose-asciirfc] 141 o This is an external reference [RNP] 143 4.3. Code snippets 145 Code snippets should be wrapped with "" and "" blocks, as required by the IETF Trust Legal Provisions (TLP) 147 [IETF.TLP] (Section 4) specified in [RFC5378]. 149 5. Security Considerations 151 Any security considerations should be placed here. 153 As described in Section 4 (here's how you refer a local anchor), 154 local tools have to be installed before the document template can be 155 built. 157 Running of these local tools *MAY* produce unintended side effects 158 that impact security. For example 160 +-----------------+----------------------------+ 161 | Security issue | Discussed in | 162 +-----------------+----------------------------+ 163 | Confidentiality | Section 2.1.1 of [RFC3552] | 164 | Data Integrity | Section 2.1.2 of [RFC3552] | 165 | Non-Repudiation | Section 2.2 of [RFC3552] | 166 +-----------------+----------------------------+ 168 6. IANA Considerations 170 This document does not require any action by IANA. 172 But if it does, such as proposing changes to IANA registries, please 173 include them here. 175 7. Acknowledgements 177 The authors would like to thank their families. 179 8. References 181 8.1. Normative References 183 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 184 Requirement Levels", BCP 14, RFC 2119, 185 DOI 10.17487/RFC2119, March 1997, 186 . 188 [RFC7991] Hoffman, P., "The "xml2rfc" Version 3 Vocabulary", 189 RFC 7991, DOI 10.17487/RFC7991, December 2016, 190 . 192 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 193 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 194 May 2017, . 196 8.2. Informative References 198 [I-D.ribose-asciirfc] 199 Tse, R., Nicholas, N., and P. Brasolin, "AsciiRFC: 200 Authoring Internet-Drafts And RFCs Using AsciiDoc", draft- 201 ribose-asciirfc-08 (work in progress), April 2018. 203 [IETF.TLP] 204 IETF, "IETF Trust Legal Provisions (TLP)", April 2018, 205 . 207 [RFC3552] Rescorla, E. and B. Korver, "Guidelines for Writing RFC 208 Text on Security Considerations", BCP 72, RFC 3552, 209 DOI 10.17487/RFC3552, July 2003, 210 . 212 [RFC5378] Bradner, S., Ed. and J. Contreras, Ed., "Rights 213 Contributors Provide to the IETF Trust", BCP 78, RFC 5378, 214 DOI 10.17487/RFC5378, November 2008, 215 . 217 [RFC7253] Krovetz, T. and P. Rogaway, "The OCB Authenticated- 218 Encryption Algorithm", RFC 7253, DOI 10.17487/RFC7253, May 219 2014, . 221 [RNP] Ribose Inc., "RNP: A C library approach to OpenPGP", March 222 2018, . 224 Appendix A. Examples 226 A.1. Example 1 228 Here's an example of a properly wrapped code snippet in accordance 229 with rules specified in Section 4.3. 231 232 { 233 "code": { 234 "encoding": "ascii", 235 "type": "rfc", 236 "authors": [ "Josiah Carberry", "Truman Grayson" ] 237 } 238 } 239 241 Authors' Addresses 243 Josiah Stinkney Carberry 244 Brown University 245 Box K, 69 Brown Street 246 Providence 02912 247 United States of America 249 Phone: +1 401 863 1000 250 Email: josiah.carberry@ribose.com 251 URI: https://www.brown.edu 253 Truman Grayson 254 Brown University 255 Box G, 69 Brown Street 256 Providence 02912 257 United States of America 259 Phone: +1 401 863 1000 260 Email: truman.grayson@ribose.com 261 URI: https://www.brown.edu