IETF Logo Mail Archive

[Tools-discuss] New tool: Using Emacs Org Mode for writing RFCs

Russ Housley <housley@vigilsec.com> Mon, 04 March 2019 23:36 UTC

Return-Path: <housley@vigilsec.com>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 1D8571311FC for <tools-discuss@ietfa.amsl.com>; Mon, 4 Mar 2019 15:36:40 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.898
X-Spam-Level:
X-Spam-Status: No, score=-1.898 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, URIBL_BLOCKED=0.001] 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 BltXm-nPzaYg for <tools-discuss@ietfa.amsl.com>; Mon, 4 Mar 2019 15:36:37 -0800 (PST)
Received: from mail.smeinc.net (mail.smeinc.net [209.135.209.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id DB00F13120A for <tools-discuss@ietf.org>; Mon, 4 Mar 2019 15:36:36 -0800 (PST)
Received: from localhost (localhost [127.0.0.1]) by mail.smeinc.net (Postfix) with ESMTP id D775F3004AA for <tools-discuss@ietf.org>; Mon, 4 Mar 2019 18:18:18 -0500 (EST)
X-Virus-Scanned: amavisd-new at mail.smeinc.net
Received: from mail.smeinc.net ([127.0.0.1]) by localhost (mail.smeinc.net [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id J9nA_fWzRPlw for <tools-discuss@ietf.org>; Mon, 4 Mar 2019 18:18:17 -0500 (EST)
Received: from a860b60074bd.fios-router.home (unknown [138.88.156.37]) by mail.smeinc.net (Postfix) with ESMTPSA id 0319D300250 for <tools-discuss@ietf.org>; Mon, 4 Mar 2019 18:18:16 -0500 (EST)
From: Russ Housley <housley@vigilsec.com>
Content-Type: multipart/signed; boundary="Apple-Mail=_55E8D243-C4E9-4FD4-9445-3289422823B6"; protocol="application/pgp-signature"; micalg="pgp-sha1"
Mime-Version: 1.0 (Mac OS X Mail 12.2 \(3445.102.3\))
Message-Id: <CE377055-CF55-4087-AAC7-C8B4DCD5972A@vigilsec.com>
References: <sa65zsy1b47.fsf@chopps.org>
To: Tools Discussion <tools-discuss@ietf.org>
Date: Mon, 04 Mar 2019 18:36:32 -0500
X-Mailer: Apple Mail (2.3445.102.3)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/jjj_bEoxCxAR-nCLQesEfLTBxvQ>
Subject: [Tools-discuss] New tool: Using Emacs Org Mode for writing RFCs
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 04 Mar 2019 23:36:40 -0000

FYI

> From: Christian Hopps <chopps@chopps.org>
> Subject: New tool: Using Emacs Org Mode for writing RFCs
> Date: March 4, 2019 at 6:19:20 PM EST
> To: "ietf\@ietf.org" <ietf@ietf.org>
> 
> 
> 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.

v2.23.0 | Report a Bug | By Email