Re: [Rfc-markdown] 1.3.7: supporting ditaa, mscgen in -3 mode

Carsten Bormann <cabo@tzi.org> Sun, 31 May 2020 07:11 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 122513A12C9; Sun, 31 May 2020 00:11:55 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.897
X-Spam-Level:
X-Spam-Status: No, score=-1.897 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, 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 KSs9fkcByfk1; Sun, 31 May 2020 00:11:51 -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 9403B3A12CA; Sun, 31 May 2020 00:11:51 -0700 (PDT)
Received: from [192.168.217.116] (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 49ZTxx3b8HzyY2; Sun, 31 May 2020 09:11:49 +0200 (CEST)
Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.80.23.2.2\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <20200531060040.GA136848@miek.nl>
Date: Sun, 31 May 2020 09:11:49 +0200
Cc: rfc-markdown@ietf.org, fdt@ietf.org
X-Mao-Original-Outgoing-Id: 612601908.997391-88c45ff4e3fc18d6cb87215eab42eb79
Content-Transfer-Encoding: quoted-printable
Message-Id: <BDC6F700-9DF3-42E2-80C6-DB278A2ABB1A@tzi.org>
References: <E1jduEw-0007if-7I@durif.tools.ietf.org> <93E5295E-CE96-4121-B3F5-C04540D542FD@tzi.org> <D6806E5D-2B6E-4464-9126-44F3F5C808F7@tzi.org> <1a5cfced-2718-0a4a-41ef-b366543ec5a2@gmail.com> <3E78C586-228A-457E-BADD-D66117FFD1C0@tzi.org> <D00FAAF2-E308-462C-9E35-825DB8DC2710@tzi.org> <20200531060040.GA136848@miek.nl>
To: Miek Gieben <miek@miek.nl>
X-Mailer: Apple Mail (2.3608.80.23.2.2)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/fsCIIPuapPmJi3pu6i0ZQlCOr7k>
Subject: Re: [Rfc-markdown] 1.3.7: supporting ditaa, mscgen in -3 mode
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, 31 May 2020 07:11:55 -0000

(FDT list: Talking about diagram generation in RFC markdown; look at the thread in https://mailarchive.ietf.org/arch/msg/rfc-markdown/meUO_DWdsJJm36FwTVYcto00tRo/ )

Hi Miek,

> This allows you to create pipelines,

Yea, troff (nroff) has been using this approach successfully for almost half a century now.
I was trying to do a slightly more “batteries included” approach.
The disadvantage of both approaches is that any change in the document requires running all the filters again, and for SVG output these are often unwieldy Java clunkers; some form of smart caching (as is done for the bibxml retrieval) would probably help.

On to your filter example:

> example one that uses a python program called
> 'protocol': https://github.com/mmarkdown/filter/tree/master/plugins/protocol

It strikes me “protocol” is not a smart name for something that does only the box notation part of the work…  (Also, “protocol” is taken in pip, so I don’t even know how to install the thing.)


> ``` protocol
> Source:16,TTL:8,Reserved:40
> ```
> Figure: This is a protocol.

Nice!
I never got around to doing a box notation generator; mostly because box notation in reality can be a bit more complicated.

https://tools.ietf.org/html/rfc7252#section-3
https://tools.ietf.org/html/rfc7400#section-3.3
https://tools.ietf.org/html/rfc793#section-3.1

Maybe the author of that tool should talk to Stephen McQuistin…
https://tools.ietf.org/html/draft-mcquistin-augmented-ascii-diagrams-04

> ```
> 0                   1                   2                   3
> 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
> |             Source            |      TTL      |               |
> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+               +
> |                            Reserved                           |
> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
> ```
> Figure: This is a protocol.


On another note, I just found plantuml’s ascii_art mode; if sequence diagrams are good enough, this might solve the plaintext vs. svg issue one has with mscgen.  Next on the todo list now...

Grüße, Carsten