[netmod] New tool: Using Emacs Org Mode for writing RFCs

Christian Hopps <chopps@chopps.org> Tue, 05 March 2019 05:36 UTC

Return-Path: <chopps@chopps.org>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 657CD130F7B; Mon, 4 Mar 2019 21:36:19 -0800 (PST)
X-Quarantine-ID: <ErOpmkEDr3FR>
X-Virus-Scanned: amavisd-new at amsl.com
X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "Cc"
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ErOpmkEDr3FR; Mon, 4 Mar 2019 21:36:17 -0800 (PST)
Received: from smtp.chopps.org (smtp.chopps.org [54.88.81.56]) by ietfa.amsl.com (Postfix) with ESMTP id 7B855130F75; Mon, 4 Mar 2019 21:36:17 -0800 (PST)
Received: from tops.chopps.org (047-050-069-038.biz.spectrum.com [47.50.69.38]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by smtp.chopps.org (Postfix) with ESMTPS id AB33E604AD; Tue, 5 Mar 2019 00:36:16 -0500 (EST)
References: <sa65zsy1b47.fsf@chopps.org>
User-agent: mu4e 1.1.0; emacs 26.1
From: Christian Hopps <chopps@chopps.org>
To: "netmod\@ietf.org" <netmod@ietf.org>
Cc: XML2RFC Interest Group <xml2rfc@ietf.org>
Cc: chopps@chopps.org
Date: Tue, 05 Mar 2019 00:36:15 -0500
Message-ID: <sa64l8h288g.fsf@chopps.org>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature"
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/suJS7RJFw04Cw4OYdyQ1P6gk_Ic>
Subject: [netmod] New tool: Using Emacs Org Mode for writing RFCs
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 05 Mar 2019 05:36:19 -0000

 Check it out: https://github.com/choppsv1/org-rfc-export

If you are an Emacs user, especially one who is familiar with/uses Org Mode, I think you'll like this.

I've been working on an org mode exporter for writing RFCs. As it's now in MELPA (package: ox-rfc) I figured it was a good time to announce it's availability. Basically you write your RFC in Org Mode and export it to XML. The back-end supports exporting to XML (for manual xml2rfc), but also supports exporting to text, HTML, or PDF, including directly into a buffer for easy previewing.

Highlights:
- Powerful Org Mode
- Simple Citations/References.
- Lists (Numbered, Unnumbered)
- Definition Lists (term + definition)
- Tables
- Embedded Code (Literate Programming e.g., embed yang model, trees, examples)

In particular YANG embedding is pretty neat. There's no need for separate files and tree generation (and example validation) can be automated from the embedded text.

Check out the README and the examples (currently in the ert-tests directory).

Thanks,
Chris.