Re: [Tools-discuss] Let's have better tools

Carsten Bormann <cabo@tzi.org> Mon, 28 June 2021 01:45 UTC

Return-Path: <cabo@tzi.org>
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 241CA3A24F9 for <tools-discuss@ietfa.amsl.com>; Sun, 27 Jun 2021 18:45:10 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, 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 rYtdCEM-Y5cd for <tools-discuss@ietfa.amsl.com>; Sun, 27 Jun 2021 18:45:05 -0700 (PDT)
Received: from gabriel-2.zfn.uni-bremen.de (gabriel-2.zfn.uni-bremen.de [134.102.50.19]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 557773A24FB for <tools-discuss@ietf.org>; Sun, 27 Jun 2021 18:45:05 -0700 (PDT)
Received: from smtpclient.apple (p548dcc89.dip0.t-ipconnect.de [84.141.204.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-2.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4GCr5W5S7Jz2xHX; Mon, 28 Jun 2021 03:45:03 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.100.0.2.22\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <sbb6er$oqm$1@gal.iecc.com>
Date: Mon, 28 Jun 2021 03:45:03 +0200
Cc: tools-discuss@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <5F7EBB82-56F7-4C4D-B90D-77DFC1E197B2@tzi.org>
References: <20210627013258.1D30F188447C@ary.qy> <98f8f742-e395-6c86-44ca-1a862b268390@gmx.de> <AADC35DD-F2F7-410D-9FDC-57A6DC367E72@tzi.org> <21692.1624828953@localhost> <sbb6er$oqm$1@gal.iecc.com>
To: John Levine <johnl@taugh.com>
X-Mailer: Apple Mail (2.3654.100.0.2.22)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/T3XgeIRvlO6i6FO8mKMzIniCci8>
Subject: Re: [Tools-discuss] Let's have better tools
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, 28 Jun 2021 01:45:10 -0000

On 28. Jun 2021, at 02:51, John Levine <johnl@taugh.com> wrote:
> 
>> https://codimd.ietf.org/mcr-kramdown-test
>> 
>> This is 90% of the way there.
> 
> That last 10% is a killer.

+1.

Note that CodiMD (which these days is called HedgeDoc, we are just running an older version) is already quite useful for editing rfc-markdown.
As is the markdown support in GitHub.

But to get those last 10 % of fidelity (“WYSIWYG”), we need xml2rfc in the loop.
For now, this means server-based approaches, as I alluded to.

As soon as references etc. are in cache, my laptop translates the source of RFC 8949 (approximately 80 pages (*)) to HTML in about 2.6 s (0.8 s kramdown-rfc + 1.8 s xml2rfc).
Adding a few 100 ms for browser processing, this means that the latency from an editor save to a redisplay could be ≈ 3 s.
Maybe not good enough for editing NFSv4.1, but for everything else, this should be quite usable.
(And I have a few ideas how to speed this up by a factor of three, but crawling comes before walking.)

Grüße, Carsten

(*) Yeah, I know.  We don’t get page numbers any more, except in the PDF, and that is slightly more dense, at 66 pages here.  Hence “approximately”.  But most people will have a feel for the size of their I-Ds in plaintext pages, so I’m using the 80 pages the I-D was.