AsciiRFC: Authoring Internet-Drafts And RFCs Using AsciiDoc
draft-ribose-asciirfc-08

Document Type Active Internet-Draft (individual)
Last updated 2018-07-10 (latest revision 2018-04-17)
Stream ISE
Intended RFC status Informational
Formats plain text xml pdf html bibtex
IETF conflict review conflict-review-ribose-asciirfc
Stream ISE state Sent to the RFC Editor
Consensus Boilerplate Unknown
Document shepherd Adrian Farrel
Shepherd write-up Show (last changed 2018-03-27)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to Adrian Farrel <rfc-ise@rfc-editor.org>, draft-ribose-asciirfc@ietf.org
IANA IANA review state Version Changed - Review Needed
IANA action state None
RFC Editor RFC Editor state AUTH
Network Working Group                                             R. Tse
Internet-Draft                                               N. Nicholas
Intended status: Informational                                    J. Lau
Expires: October 20, 2018                                    P. Brasolin
                                                                  Ribose
                                                          April 18, 2018

      AsciiRFC: Authoring Internet-Drafts And RFCs Using AsciiDoc
                        draft-ribose-asciirfc-08

Abstract

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

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

Tse, et al.             Expires October 20, 2018                [Page 1]
Internet-Draft           AsciiRFC Specifications              April 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.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Designed for authoring RFCs and Internet-Drafts . . . . .   3
     1.2.  Relationship between AsciiRFC, AsciiDoc and Asciidoctor .   4
     1.3.  Comparison with RFC XML tools based on Markdown variants    4
   2.  Conventions Used in This Document . . . . . . . . . . . . . .   6
     2.1.  Terms and Definitions . . . . . . . . . . . . . . . . . .   6
     2.2.  Wrapping Lines in Documentation Examples  . . . . . . . .   6
   3.  Document Structure and Syntax . . . . . . . . . . . . . . . .   7
     3.1.  Unsupported features compared with Asciidoctor syntax . .   8
     3.2.  Mapping To RFC XML syntax . . . . . . . . . . . . . . . .   8
     3.3.  Example Illustrations . . . . . . . . . . . . . . . . . .   9
     3.4.  Simple Illustration . . . . . . . . . . . . . . . . . . .  10
   4.  Header And Document Attributes  . . . . . . . . . . . . . . .  28
     4.1.  Title And Basic Attributes  . . . . . . . . . . . . . . .  28
     4.2.  Detailed Author Information . . . . . . . . . . . . . . .  30
     4.3.  XML Processing Information  . . . . . . . . . . . . . . .  34
     4.4.  AsciiRFC-specific Document Attributes . . . . . . . . . .  35
   5.  Preamble  . . . . . . . . . . . . . . . . . . . . . . . . . .  38
   6.  Sections and Paragraphs . . . . . . . . . . . . . . . . . . .  39
   7.  Figures . . . . . . . . . . . . . . . . . . . . . . . . . . .  41
   8.  Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
     8.1.  Basic Lists . . . . . . . . . . . . . . . . . . . . . . .  47
     8.2.  List Continuation . . . . . . . . . . . . . . . . . . . .  52
   9.  Blockquotes . . . . . . . . . . . . . . . . . . . . . . . . .  55
   10. Notes And Asides  . . . . . . . . . . . . . . . . . . . . . .  56
   11. Tables  . . . . . . . . . . . . . . . . . . . . . . . . . . .  59
   12. Inline Formatting . . . . . . . . . . . . . . . . . . . . . .  62
     12.1.  Italics, Boldface, Monospace, Subscripts, Superscripts .  62
     12.2.  Formatting BCP 14 Keywords . . . . . . . . . . . . . . .  63
     12.3.  Escaping AsciiRFC Syntax . . . . . . . . . . . . . . . .  64
   13. Links . . . . . . . . . . . . . . . . . . . . . . . . . . . .  64
   14. Cross-References  . . . . . . . . . . . . . . . . . . . . . .  66
     14.1.  Basic Referencing  . . . . . . . . . . . . . . . . . . .  66
Show full document text