[Rfc-markdown] 1.3.2: Kdrfc supports HTML; artset support (via goat for now)

Carsten Bormann <cabo@tzi.org> Thu, 12 March 2020 21:23 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 [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id DA0D33A00C1 for <rfc-markdown@ietfa.amsl.com>; Thu, 12 Mar 2020 14:23: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 H0WoR7mLDEfH for <rfc-markdown@ietfa.amsl.com>; Thu, 12 Mar 2020 14:23:08 -0700 (PDT)
Received: from gabriel-vm-2.zfn.uni-bremen.de (gabriel-vm-2.zfn.uni-bremen.de [134.102.50.17]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 55E853A00C0 for <rfc-markdown@ietf.org>; Thu, 12 Mar 2020 14:23:08 -0700 (PDT)
Received: from [172.16.42.113] (p548DCD70.dip0.t-ipconnect.de [84.141.205.112]) (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 48dhd66pB0zyrt; Thu, 12 Mar 2020 22:23:06 +0100 (CET)
Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 13.0 \(3608.60.0.2.5\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <B4EE04EE-E6F9-4FA6-A419-67B02D6EAD7D@tzi.org>
Date: Thu, 12 Mar 2020 22:23:06 +0100
X-Mao-Original-Outgoing-Id: 605740986.37183-a7b2e7e16bdd3b3204f562c023634d00
Content-Transfer-Encoding: quoted-printable
Message-Id: <530BDF95-2BE9-4D17-A292-509FAA474189@tzi.org>
References: <BN8PR15MB2644C01E60453D9CE2F00BE297FC0@BN8PR15MB2644.namprd15.prod.outlook.com> <04CD97D2-8AA3-4826-8A1E-9EC8D74B3947@amsl.com> <48FE125D-32EC-4D52-A2AD-4AFE44A59409@tzi.org> <B4EE04EE-E6F9-4FA6-A419-67B02D6EAD7D@tzi.org>
To: RFC Markdown <rfc-markdown@ietf.org>
X-Mailer: Apple Mail (2.3608.60.0.2.5)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/zqoYTJ8KiNV09IuvaRBfqHWpgnA>
Subject: [Rfc-markdown] 1.3.2: Kdrfc supports HTML; artset support (via goat for now)
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: Thu, 12 Mar 2020 21:23:11 -0000

On 2020-03-12, at 17:45, Carsten Bormann <cabo@tzi.org> wrote:
> 
> Done in 1.3.1.

And while I was hacking this, two more improvements in 1.3.2:

* kdrfc now has a -h/—-html flag that generates html alongside the txt (use --no-txt to suppress the latter).

So a typical thing you might do now is:

   kdrfc -3h foo.md
   open foo.html

I still need to hack the remote xml2rfc support, though, -rh gives an error at the moment.

* There is now experimental support for generating artsets.

Try

~~~~ goat
.---.
|o o|
| | |
| - |
|___|
~~~~

In markdown, this is a code block of type “goat”.
Special-casing this type, kdrfc then calls goat and svgcheck (which both must be in the path(*)) to generate SVG for use in the HTML, keeping the UTF-8 art (“ascii-art”) for use in the TXT.

Until I have learned how to properly shut up svgcheck (which seems to ignore its -q option), this will be a bit chatty.

If you want support for other ascii-art-to-SVG processors, please tell us.

I really want to do a version of mscgen (what UML calls sequence diagrams) next; if you have a favorite that can generate SVG that svgcheck groks and is reasonably easy to install, I’d like to know.

UML Flow charts?  Hand-drawn diagrams?  DOT/Graphviz?  Gantt diagrams?  Music?
Railroad charts?  You name it, you got it (as long as an SVG processor exists).

Grüße, Carsten

(*) The gem install will not try to find and install that for you.
Thomas has documented in his svg-test draft how to get these:

$ go get github.com/blampe/goat
$ pip install svgcheck

Of course you need go and python, which you might get via:

$ brew install go
(do read the hints output after install)
$ brew install python