Writing Internet-Drafts And RFCs In AsciiDoc (AsciiRFC)
draft-ribose-asciirfc-00

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2017-11-20
Stream (None)
Intended RFC status (None)
Formats plain text pdf html bibtex
IETF conflict review conflict-review-ribose-asciirfc
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                                             R. Tse
Internet-Draft                                               N. Nicholas
Intended status: Informational                                    J. Lau
Expires: May 24, 2018                                        P. Brasolin
                                                                  Ribose
                                                       November 20, 2017

        Writing Internet-Drafts And RFCs In AsciiDoc (AsciiRFC)
                        draft-ribose-asciirfc-00

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 XML RFC through
   the AsciiDoc language, while abstracting away the need to manually
   edit XML, including references.

   This document itself was written and generated into XML RFC v2
   (RFC7749) and XML RFC 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 May 24, 2018.

Tse, et al.               Expires May 24, 2018                  [Page 1]
Internet-Draft           AsciiRFC Specifications           November 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.  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.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Conventions Used in This Document . . . . . . . . . . . . . .   4
     2.1.  Definitions . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Document Structure And AsciiDoctor Syntax . . . . . . . . . .   4
   4.  Header And Document Attributes  . . . . . . . . . . . . . . .   6
   5.  Preamble  . . . . . . . . . . . . . . . . . . . . . . . . . .   9
   6.  Sections and Paragraphs . . . . . . . . . . . . . . . . . . .  11
   7.  Figures . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
   8.  Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . .  12
   9.  Blockquotes . . . . . . . . . . . . . . . . . . . . . . . . .  15
   10. Notes And Asides  . . . . . . . . . . . . . . . . . . . . . .  16
   11. Tables  . . . . . . . . . . . . . . . . . . . . . . . . . . .  17
   12. Inline Formatting . . . . . . . . . . . . . . . . . . . . . .  20
   13. Links . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
   14. Crossreferences . . . . . . . . . . . . . . . . . . . . . . .  21
   15. Inclusions  . . . . . . . . . . . . . . . . . . . . . . . . .  23
   16. Encoding and Entities . . . . . . . . . . . . . . . . . . . .  23
   17. Bibliography  . . . . . . . . . . . . . . . . . . . . . . . .  23
     17.1.  Using Raw RFC XML  . . . . . . . . . . . . . . . . . . .  24
     17.2.  Using preprocessing  . . . . . . . . . . . . . . . . . .  25
   18. RFC XML features not supported in Asciidoctor . . . . . . . .  27
   19. Authoring . . . . . . . . . . . . . . . . . . . . . . . . . .  27
   20. Security Considerations . . . . . . . . . . . . . . . . . . .  28
   21. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  28
   22. Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .  29
     22.1.  Example 1  . . . . . . . . . . . . . . . . . . . . . . .  29
   23. References  . . . . . . . . . . . . . . . . . . . . . . . . .  29
     23.1.  Normative References . . . . . . . . . . . . . . . . . .  29
     23.2.  Informative References . . . . . . . . . . . . . . . . .  29
     23.3.  URIs . . . . . . . . . . . . . . . . . . . . . . . . . .  30
Show full document text