[Rfc-markdown] 1.3.9: More SVG cleanups, version/help on command line

Carsten Bormann <cabo@tzi.org> Sun, 19 July 2020 14:12 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 B2AA33A07C7 for <rfc-markdown@ietfa.amsl.com>; Sun, 19 Jul 2020 07:12:23 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.92
X-Spam-Level:
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 ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id LE4fBDu_Dkz7 for <rfc-markdown@ietfa.amsl.com>; Sun, 19 Jul 2020 07:12:20 -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 B74813A07C5 for <rfc-markdown@ietf.org>; Sun, 19 Jul 2020 07:12:20 -0700 (PDT)
Received: from [192.168.217.119] (p5089ae91.dip0.t-ipconnect.de [80.137.174.145]) (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 4B8myT3JbgzyWb; Sun, 19 Jul 2020 16:12:17 +0200 (CEST)
From: Carsten Bormann <cabo@tzi.org>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
X-Mao-Original-Outgoing-Id: 616860736.877094-439c3f8c030248ed34d658997a0cc03b
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.1\))
Date: Sun, 19 Jul 2020 16:12:16 +0200
Message-Id: <FD81D913-7D0F-4BFB-85BC-EA1B38106E42@tzi.org>
To: rfc-markdown@ietf.org
X-Mailer: Apple Mail (2.3608.120.23.2.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/QxXbIvwbfcBH3rlG8bdwqNSmyMo>
Subject: [Rfc-markdown] 1.3.9: More SVG cleanups, version/help on command line
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: Sun, 19 Jul 2020 14:12:24 -0000

1.3.9 has version/help on the command line (--version, --help); thank you MCR.

Among a few little nit fixes, it also has a bit more polish in the SVG fixup.
SVG tool translations are now cached (in .refcache or where your KRAMDOWN_REFCACHEDIR points to; my favorite for the latter is ~/.cache/xml2rfc, so the cache is shared with XML2RFC), so, unless you change the source in the code block or update the kramdown-rfc version, no time will be wasted in rerunning the tools.

Extract from the README is below.

As usual, update with

	gem update kramdown-rfc2629

(a simple `gem update` will suffice, but also possibly update other gems you don’t need updated).  A `sudo` may be required depending on your setup.

Grüße, Carsten


(1.3.x)
Slowly improving support for SVG generating tools for XML2RFCv3 (i.e.,
with `-3` flag).
These tools must be installed and callable from the command line.

The basic idea is to mark an input code block with one of the following
labels (language types), yielding some plaintext form in the .TXT
output and a graphical form in the .HTML output.  The plaintext is the
input in some cases (e.g., ASCII art, `mscgen`), or some plaintext
output generated by the tool (e.g., `plantuml-utxt`).

Currently supported labels as of 1.3.9:

* goat, ditaa: ASCII (plaintext) art to figure conversion
* mscgen: Message Sequence Charts
* plantuml: widely used multi-purpose diagram generator
* plantuml-utxt: Like plantuml, except that a plantuml-generated
  plaintext form is used
* mermaid: Very experimental; the conversion to SVG is prone to
  generate black-on-black text in this version

Note that this feature does not play well with the CI (continuous
integration) support in Martin Thomson's [I-D Template][], as that may
not have the tools installed in its docker instance.