A Minimal Internet-Draft In AsciiRFC
draft-asciirfc-minimal-03

Document Type Active Internet-Draft (individual)
Last updated 2018-12-11
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                        J. Carberry
Internet-Draft                                                T. Grayson
Intended status: Informational                          Brown University
Expires: June 15, 2019                                 December 12, 2018

                  A Minimal Internet-Draft In AsciiRFC
                       draft-asciirfc-minimal-03

Abstract

   This document provides a template on how to author (or migrate!) a
   new Internet-Draft / RFC in the AsciiRFC format.

NOTE

   This template requires usage of the Metanorma toolchain and the
   "metanorma-ietf" 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 June 15, 2019.

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

Carberry & Grayson        Expires June 15, 2019                 [Page 1]
Internet-Draft              AsciiRFC Example               December 2018

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

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.  Metanorma 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.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   4
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   4
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .   4
     8.2.  Informative References  . . . . . . . . . . . . . . . . .   5
   Appendix A.  Examples . . . . . . . . . . . . . . . . . . . . . .   5
     A.1.  Example 1 . . . . . . . . . . . . . . . . . . . . . . . .   5
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   6

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 June 15, 2019                 [Page 2]
Internet-Draft              AsciiRFC Example               December 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 Metanorma and RFC toolchains *MUST* be available locally to build
   this document template.
Show full document text