[Rfc-markdown] 1.3.16..1.3.18: small improvements, math

Carsten Bormann <cabo@tzi.org> Wed, 09 December 2020 08:03 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost []) by ietfa.amsl.com (Postfix) with ESMTP id D9CBE3A0D13 for <rfc-markdown@ietfa.amsl.com>; Wed, 9 Dec 2020 00:03:48 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.92
X-Spam-Status: No, score=-1.92 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_MSPIKE_H4=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([]) by localhost (ietfa.amsl.com []) (amavisd-new, port 10024) with ESMTP id r_fysxOzT876 for <rfc-markdown@ietfa.amsl.com>; Wed, 9 Dec 2020 00:03:45 -0800 (PST)
Received: from gabriel-vm-2.zfn.uni-bremen.de (gabriel-vm-2.zfn.uni-bremen.de []) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C7DF33A0DCB for <rfc-markdown@ietf.org>; Wed, 9 Dec 2020 00:03:44 -0800 (PST)
Received: from [] (p548dca87.dip0.t-ipconnect.de []) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-vm-2.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4CrV1B3RXHzyZ6; Wed, 9 Dec 2020 09:03:42 +0100 (CET)
From: Carsten Bormann <cabo@tzi.org>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-Mao-Original-Outgoing-Id: 629193821.941566-3525e4aee61c553ca5dd9f559a5f55dd
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.\))
Date: Wed, 9 Dec 2020 09:03:41 +0100
Message-Id: <016C2140-EB25-4BBE-A673-6129F97DDFEE@tzi.org>
To: rfc-markdown@ietf.org
X-Mailer: Apple Mail (2.3608.
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/m8FzJ1FTx1lk3fm2F3x-r8ZPdK8>
Subject: [Rfc-markdown] 1.3.16..1.3.18: small improvements, math
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "rfc-markdown is a discussion list for people writing I-Ds and RFCs in Markdown and the authors of the tools used for that." <rfc-markdown.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-markdown/>
List-Post: <mailto:rfc-markdown@ietf.org>
List-Help: <mailto:rfc-markdown-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 09 Dec 2020 08:03:49 -0000

It seems I haven’t done my usual updates on recent kramdown-rfc releases.

So here they are, by commit:

* 2298e53 1.3.18: Generate v3 XML for dl/dt/dd

The v2 format for definition lists has the problem that you can’t have substructure in the definition term.  With the v3 format now used, constructs such as <sub>…</sub> can be had in the definition term.

Note that v3 enforces a strict (dt, dd)+ rhythm.  Kramdown-rfc fakes this, if needed, by adding empty dt or dd elements (dd can’t be empty, so it’s actually <dd><t/></dd>).

I expect to do quite a few similar little v3 sprints over the next few months; if you have something that you want done first, please holler (as in https://github.com/cabo/kramdown-rfc2629/issues/76).

* a6d14a3 Tag stderr messages from tools with the tool name

Various tools called from kramdown-rfc send things to stderr, and it is sometimes not easy to find out where a message comes from.  These messages should now be tagged in a way that reduces the guessing.

* 8b10657 Add -c (convert) option as a milder version of -p (prep)

For submission, my recommendation has been to do a kdrfc -p (run the prep tool).  If you know you don’t have external references (such as src= on an svg), you can now use the less heavy -c option to get a draft-foo.v2v3.xml that should survive submission as v3 and even would be useful to the RFC editor.

* 1a0615c Add basic support for inline math character keyboarding

So you can write $$\alpha \ll \beta \bar{x}$$ inside a paragraph.
So you can write α ≪ β x̅ inside a paragraph.

(This is experimental, but will move in the direction of supporting more Latex, not less.  Sub/sup support is next...)
Kudos to the unicodeit tool from where this functionality was stolen^W inspired.

* e9f28b4 1.3.17: Prototype equation support (address #84), subject to change.

~~~ math
α_{aimd} = 3 * \frac{1 - β_{cubic}}{1 + β_{cubic}} \\
β_{aimd} = β_{cubic} \\

now generates SVG from math with tex2svg (which you need to have installed and on the path), and fallback with asciitex (which is not great, but Lars Eggert is on it; and, again, you have to have it installed and on path).

Of course, this should replace block-level math processing ($$…$$) at some point, but at the moment it was easier to wedge this in as math “sourcecode”.

* 94c78e2 1.3.16: Fix apostrophes in hangText

A really old bug where I had used the wrong escaping function for hangText (as in definition lists), so you couldn’t (this!) have apostrophes in them.  (Since 1.3.18, this is no longer relevant for --v3.)

Grüße, Carsten