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

Document Type Active Internet-Draft (individual)
Last updated 2017-12-18 (latest revision 2017-12-12)
Stream ISE
Intended RFC status Informational
Formats plain text xml pdf html bibtex
Stream ISE state Finding Reviewers
Consensus Boilerplate Unknown
Document shepherd No shepherd assigned
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: June 15, 2018                                       P. Brasolin
                                                                  Ribose
                                                       December 12, 2017

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

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 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 June 15, 2018.

Tse, et al.               Expires June 15, 2018                 [Page 1]
Internet-Draft           AsciiRFC Specifications           December 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.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Conventions Used in This Document . . . . . . . . . . . . . .   5
     2.1.  Definitions . . . . . . . . . . . . . . . . . . . . . . .   5
   3.  Document Structure And AsciiDoctor Syntax . . . . . . . . . .   5
     3.1.  AsciiRFC Mapping To Asciidoctor . . . . . . . . . . . . .   7
     3.2.  Simple Illustration . . . . . . . . . . . . . . . . . . .   8
   4.  Header And Document Attributes  . . . . . . . . . . . . . . .  16
     4.1.  Title And Basic Attributes  . . . . . . . . . . . . . . .  16
     4.2.  Detailed Author Information . . . . . . . . . . . . . . .  17
     4.3.  XML Processing Information  . . . . . . . . . . . . . . .  20
     4.4.  AsciiRFC-specific Document Attributes . . . . . . . . . .  21
   5.  Preamble  . . . . . . . . . . . . . . . . . . . . . . . . . .  23
   6.  Sections and Paragraphs . . . . . . . . . . . . . . . . . . .  25
   7.  Figures . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
   8.  Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . .  29
     8.1.  Basic Lists . . . . . . . . . . . . . . . . . . . . . . .  29
     8.2.  List Continuation . . . . . . . . . . . . . . . . . . . .  30
   9.  Blockquotes . . . . . . . . . . . . . . . . . . . . . . . . .  32
   10. Notes And Asides  . . . . . . . . . . . . . . . . . . . . . .  33
   11. Tables  . . . . . . . . . . . . . . . . . . . . . . . . . . .  35
   12. Inline Formatting . . . . . . . . . . . . . . . . . . . . . .  37
     12.1.  Italics, Boldface, Monospace, Subscripts, Superscripts .  37
     12.2.  Formatting BCP 14 Keywords . . . . . . . . . . . . . . .  37
     12.3.  Escaping AsciiRFC Syntax . . . . . . . . . . . . . . . .  38
   13. Links . . . . . . . . . . . . . . . . . . . . . . . . . . . .  38
   14. Cross-References  . . . . . . . . . . . . . . . . . . . . . .  39
     14.1.  Basic Referencing  . . . . . . . . . . . . . . . . . . .  39
     14.2.  Referencing With Attributes  . . . . . . . . . . . . . .  40
   15. Inclusions  . . . . . . . . . . . . . . . . . . . . . . . . .  42
   16. Encoding and Entities . . . . . . . . . . . . . . . . . . . .  43
   17. Bibliography  . . . . . . . . . . . . . . . . . . . . . . . .  44
     17.1.  Using Raw RFC XML  . . . . . . . . . . . . . . . . . . .  44
     17.2.  Preprocessing Using <spanx style="verb">asciidoctor-
Show full document text