IETF Logo Mail Archive

[rfc-i] Authoring I-D/RFCs in AsciiDoc

Ronald Tse <tse@ribose.com> Mon, 27 November 2017 11:11 UTC

Return-Path: <rfc-interest-bounces@rfc-editor.org>
X-Original-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Delivered-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id CA2DE120725 for <ietfarch-rfc-interest-archive@ietfa.amsl.com>; Mon, 27 Nov 2017 03:11:25 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.089
X-Spam-Level:
X-Spam-Status: No, score=-4.089 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, HEADER_FROM_DIFFERENT_DOMAINS=0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001, T_DKIM_INVALID=0.01] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=fail (1024-bit key) reason="fail (message has been altered)" header.d=ribose.onmicrosoft.com
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 GsesmNbSNSd3 for <ietfarch-rfc-interest-archive@ietfa.amsl.com>; Mon, 27 Nov 2017 03:11:23 -0800 (PST)
Received: from rfc-editor.org (rfc-editor.org [4.31.198.49]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 6E00F1286B1 for <rfc-interest-archive-eekabaiReiB1@ietf.org>; Mon, 27 Nov 2017 03:11:23 -0800 (PST)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id C5B4DB81128; Mon, 27 Nov 2017 03:11:13 -0800 (PST)
X-Original-To: rfc-interest@rfc-editor.org
Delivered-To: rfc-interest@rfc-editor.org
Received: from localhost (localhost [127.0.0.1]) by rfc-editor.org (Postfix) with ESMTP id 67A6BB80DD9 for <rfc-interest@rfc-editor.org>; Sat, 25 Nov 2017 08:26:22 -0800 (PST)
X-Virus-Scanned: amavisd-new at rfc-editor.org
Authentication-Results: rfcpa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=ribose.onmicrosoft.com
Received: from rfc-editor.org ([127.0.0.1]) by localhost (rfcpa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id XWoIVp5kgePh for <rfc-interest@rfc-editor.org>; Sat, 25 Nov 2017 08:26:20 -0800 (PST)
Received: from APC01-HK2-obe.outbound.protection.outlook.com (mail-hk2apc01on0047.outbound.protection.outlook.com [104.47.124.47]) by rfc-editor.org (Postfix) with ESMTPS id AC5CFB80DD7 for <rfc-interest@rfc-editor.org>; Sat, 25 Nov 2017 08:26:19 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ribose.onmicrosoft.com; s=selector1-ribose-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=EjVZpcKrNZ1pU9pTT2gz1C+zvjoliwQn/vNi06fHoOk=; b=u81BIZGHobgURXUUrEVCEBr3tIbjFiX/9MFsDh8YSXGHkXPfdYkDHm/KERw9F1uVbbuC9RqehKz4jFQ8xLZwAoDEzC8Abdtokx8ftjV7We3GSeEaX0mPXrc2zzkkUTJ7f09fwGi7MKpTlIhKXUqS96PU0Yw9FHsERnd/W6PyPIs=
Received: from PS1PR01MB1050.apcprd01.prod.exchangelabs.com (10.165.210.30) by PS1PR01MB1051.apcprd01.prod.exchangelabs.com (10.165.211.141) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.260.4; Sat, 25 Nov 2017 16:26:22 +0000
Received: from PS1PR01MB1050.apcprd01.prod.exchangelabs.com ([fe80::7990:d65:5722:9b79]) by PS1PR01MB1050.apcprd01.prod.exchangelabs.com ([fe80::7990:d65:5722:9b79%13]) with mapi id 15.20.0260.005; Sat, 25 Nov 2017 16:26:22 +0000
From: Ronald Tse <tse@ribose.com>
To: "rfc-interest@rfc-editor.org" <rfc-interest@rfc-editor.org>
Thread-Topic: Authoring I-D/RFCs in AsciiDoc
Thread-Index: AQHTZgohs+UaXBMR+U6+SW9iuOoWww==
Date: Sat, 25 Nov 2017 16:26:22 +0000
Message-ID: <F53654DF-594E-4717-A320-74CC8F6A07FC@ribose.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
authentication-results: spf=none (sender IP is ) smtp.mailfrom=tse@ribose.com;
x-originating-ip: [220.246.174.191]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1; PS1PR01MB1051; 6:Qy61CVCCupqRsaqncjMvehWMBlGgqKJ7xqnVY3ej76s+dguRedCPDVKdx4iEzpxbJnOXHrN6t0+dp5eHJdJkskUoDM7Y+kIoR7BQ0OxqNqVAy7Hn+TSujs+gYwzAaK46xKI/ys4quYkr2Nq2CiOOmneGV3uTywo93HwGeFzi5z69wYjE8QqZqMFtGuM9QbKOKVIMWv2VRc0/7LO/cT03ZZR0HwzrHRnk8WdrRZryHCp0ZuzOPZ542jFEomABrnvKcWvfBzzl6fH1i81Sb4+f2P1I4V4UU0ap7shnWWqBThDEK99HBMaAmDAaoAgG81knnVDJBPFlrx8IvVta1BSexOBY4/2ykvo3sGpSF+WzWOM=; 5:PTa8cRFof8mExasvQusMym7OSx/NT1zx9e1a76MiyHZXel5OoE2o1kLqOtHgvQKMGdwouEpSLXTmgQo4SWBEmfERZFHgSypKHbQEqV9Ipg2nAv69CNfvmAALsTop5YwmVXYo21lC2y6Cgku6VjmgTBCWVtoYwv5IiUwwqrNtrJg=; 24:QuoZsBwTOiMbNx2fVPn8N+hagLqTR1lXAT7Cb//PjAMLYXk8aPQIuarylIOAG8N8DMSy3IXZ4sbquPU9A/si3HbU1BvIx0jMgxU83gH+wQ0=; 7:eoNlbFwyrRHGK4GO00R45AE1KzvIVf2+fLdsrZL8wSqtWbP8GwiI6YAV2uBcFVqTLHaRBTeAuGWhSW3aN18Z3l7bk5nF+xdGOHqPTYXec4VddZjfhBTdWoqDCD5SWllNcFjkmPsTCD2kECUdcrEx+b/QtFV8Nxu5SCjQ3nPh6D96eNxmQXI/QHKoaEX5b552Rr/ZGO/3eWO6dGlqyNfsVWIDg2TNY04dav2iTdBfNNFHm0upGx+cGx/7NCPHDH7o
x-ms-exchange-antispam-srfa-diagnostics: SSOS;
x-ms-office365-filtering-correlation-id: dd08753b-3482-4b11-baad-08d534214428
x-microsoft-antispam: UriScan:; BCL:0; PCL:0; RULEID:(4534020)(4602075)(4603075)(4627115)(201702281549075)(5600026)(4604075)(2017052603199); SRVR:PS1PR01MB1051;
x-ms-traffictypediagnostic: PS1PR01MB1051:
x-microsoft-antispam-prvs: <PS1PR01MB10510EF7C15B0465291E0843D7270@PS1PR01MB1051.apcprd01.prod.exchangelabs.com>
x-exchange-antispam-report-test: UriScan:(166708455590820);
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(6040450)(2401047)(5005006)(8121501046)(3002001)(3231022)(93006095)(93001095)(10201501046)(6041248)(20161123560025)(20161123562025)(2016111802025)(20161123558100)(20161123555025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123564025)(6072148)(6043046)(201708071742011); SRVR:PS1PR01MB1051; BCL:0; PCL:0; RULEID:(100000803101)(100110400095); SRVR:PS1PR01MB1051;
x-forefront-prvs: 0502983C0E
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(346002)(376002)(366004)(39830400002)(504964003)(199003)(189002)(288314003)(106356001)(2900100001)(54356999)(102836003)(3846002)(5660300001)(6116002)(14454004)(81156014)(8676002)(81166006)(478600001)(86362001)(53936002)(68736007)(2351001)(966005)(66066001)(99286004)(7736002)(101416001)(82746002)(2906002)(25786009)(50986999)(105586002)(3660700001)(3280700002)(189998001)(97736004)(6916009)(83716003)(8936002)(36756003)(5640700003)(236005)(606006)(33656002)(5250100002)(6486002)(6306002)(6512007)(6436002)(316002)(54896002)(6506006)(2501003); DIR:OUT; SFP:1101; SCL:1; SRVR:PS1PR01MB1051; H:PS1PR01MB1050.apcprd01.prod.exchangelabs.com; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; LANG:en;
received-spf: None (protection.outlook.com: ribose.com does not designate permitted sender hosts)
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
MIME-Version: 1.0
X-OriginatorOrg: ribose.com
X-MS-Exchange-CrossTenant-Network-Message-Id: dd08753b-3482-4b11-baad-08d534214428
X-MS-Exchange-CrossTenant-originalarrivaltime: 25 Nov 2017 16:26:22.2846 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: d98a04ff-ef98-489b-b33c-13c23a2e091a
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PS1PR01MB1051
X-Mailman-Approved-At: Mon, 27 Nov 2017 03:11:12 -0800
Subject: [rfc-i] Authoring I-D/RFCs in AsciiDoc
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://www.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <http://www.rfc-editor.org/pipermail/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://www.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
Content-Type: multipart/mixed; boundary="===============4578559360805133022=="
Errors-To: rfc-interest-bounces@rfc-editor.org
Sender: rfc-interest <rfc-interest-bounces@rfc-editor.org>

Warm greetings to everyone on the rfc-interest list!

We’ve recently made a tool that allows writing Internet-Drafts using AsciiDoc called “asciidoctor-rfc” [1], as an alternative to Kramdown / MMark or manual RFC XML. AsciiDoc is a widely-adopted textual format. Similar to Markdown, it is simple to write and easy to understand, but its major benefit is for being a structured format that directly converts into DocBook XML.

The tool, “asciidoctor-rfc” supports generating both v3 and v2 RFC XML through the “AsciiRFC” syntax [2].

We have attempted to expose as many v3 (and v2) features as possible through native AsciiDoc syntax. I do know the v3 xml2rfc tool is under development (originally scheduled for Oct?), and we are excited to try it out using RFC XML files generated with asciidoctor-rfc.

Here are some examples created through this asciidoctor-rfc:
* A large number of v2/v3 examples, including the IETF templates, at [3]
* draft-oscca-cfrg-sm3-02 (source: [4], text: [5])
* draft-ribose-cfrg-sm4-03 (source: [6], text: [7])

We are very interested in your (and RFC Editors!) feedback. Please let us know how this could work better for you — we look forward hearing from all interested parties. Thank you in advance!

Links:

[1] https://github.com/riboseinc/asciidoctor-rfc
[2] https://tools.ietf.org/html/draft-ribose-asciirfc-01
[3] https://github.com/riboseinc/asciidoctor-rfc/tree/master/spec/examples
[4] https://github.com/riboseinc/rfc-crypto-sm3
[5] https://tools.ietf.org/html/draft-oscca-cfrg-sm3-02
[6] https://github.com/riboseinc/rfc-crypto-sm3
[7] https://tools.ietf.org/html/draft-ribose-cfrg-sm4-03

Kind regards,
Ronald

_____________________________________

Ronald Tse
Ribose Inc.


_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest

v2.23.0 | Report a Bug | By Email