Writing I-Ds and RFCs using Pandoc and a bit of XML
draft-gieben-pandoc2rfc-02

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2013-07-05
Stream ISE
Intended RFC status (None)
Formats plain text pdf html bibtex
IETF conflict review conflict-review-gieben-pandoc2rfc
Additional URLs
Stream ISE state Submission Received
Consensus Boilerplate Unknown
Document shepherd None
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to rfc-ise@rfc-editor.org
RFC Beautification Working Group                               R. Gieben
Internet-Draft                                                    Google
Intended status: Informational                             July 05, 2013
Expires: January 06, 2014

          Writing I-Ds and RFCs using Pandoc and a bit of XML
                       draft-gieben-pandoc2rfc-02

Abstract

   This document presents a technique for using a Markdown syntax
   variant, called Pandoc, and a (bit) of XML [RFC2629] as a source
   format for documents in the Internet-Drafts (I-Ds) and Request for
   Comments (RFC) series.

   The goal of this technique is to let an author of an I-D focus on the
   main body of text without being distracted too much by XML tags, it
   does however not alleviate the need to typeset some files in XML.

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 http://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 January 06, 2014.

Copyright Notice

   Copyright (c) 2013 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
   (http://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

Gieben                  Expires January 06, 2014                [Page 1]
Internet-Draft                 Pandoc2rfc                      July 2013

   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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Pandoc to RFC . . . . . . . . . . . . . . . . . . . . . . . .   2
     2.1.  Dependencies  . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Building an Internet-Draft  . . . . . . . . . . . . . . . . .   4
   4.  Supported Features  . . . . . . . . . . . . . . . . . . . . .   5
   5.  Unsupported Features and Limitations  . . . . . . . . . . . .   6
   6.  Pandoc Style  . . . . . . . . . . . . . . . . . . . . . . . .   7
     6.1.  Figures . . . . . . . . . . . . . . . . . . . . . . . . .   7
     6.2.  Tables  . . . . . . . . . . . . . . . . . . . . . . . . .   7
     6.3.  References  . . . . . . . . . . . . . . . . . . . . . . .   7
   7.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   7
   8.  Security Considerations . . . . . . . . . . . . . . . . . . .   8
   9.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   8
   10. Normative References  . . . . . . . . . . . . . . . . . . . .   8
   Appendix A.  Changelog  . . . . . . . . . . . . . . . . . . . . .   8
     A.1.  -00 . . . . . . . . . . . . . . . . . . . . . . . . . . .   8
     A.2.  -01 . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
     A.3.  -02 . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
   Appendix B.  Cheat Sheet  . . . . . . . . . . . . . . . . . . . .   9
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  10

1.  Introduction

   This document presents a technique for using a Markdown [Markdown]
   syntax variant, called Pandoci [Pandoc], and a bit of XML [RFC2629]
   as a source format for documents in the Internet-Drafts (I-Ds) and
   Request for Comments (RFC) series.

   The goal of this technique is to let an author of an I-D focus on the
   main body of text without being distracted too much by XML tags, it
   does however not alleviate the need to typeset some files in XML.

   Pandoc is an almost plain text format and therefor particularly well
   suited for editing RFC-like documents.  The syntax itself is a super
   set of the syntax championed by Markdown.

2.  Pandoc to RFC

   Pandoc's syntax is easy to learn and write and it can be translated
   to numerous output formats, including, but not limited to: HTML,
   EPUB, (plain) Markdown and DocBook XML.

Gieben                  Expires January 06, 2014                [Page 2]
Internet-Draft                 Pandoc2rfc                      July 2013

   Pandoc2rfc allows authors to write in Pandoc syntax which is then
   transformed to XML and given to xml2rfc.  The conversions are, in a
Show full document text