Re: [Rfc-markdown] Carsten: Re: [rfc-i] summary of Removing postal information from RFCs

Carsten Bormann <cabo@tzi.org> Mon, 19 July 2021 18:34 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 EBF2A3A39B7 for <rfc-markdown@ietfa.amsl.com>; Mon, 19 Jul 2021 11:34:25 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: 0.102
X-Spam-Level:
X-Spam-Status: No, score=0.102 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, PDS_OTHER_BAD_TLD=1.999, 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=no 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 WOXRERRcK4Wn for <rfc-markdown@ietfa.amsl.com>; Mon, 19 Jul 2021 11:34:21 -0700 (PDT)
Received: from gabriel-smtp.zfn.uni-bremen.de (mail.uni-bremen.de [134.102.50.15]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id ECC693A39B6 for <rfc-markdown@ietf.org>; Mon, 19 Jul 2021 11:34:20 -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-smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4GT9VL21sLz2xJr; Mon, 19 Jul 2021 20:34:18 +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: <20210719171839.GB24216@faui48e.informatik.uni-erlangen.de>
Date: Mon, 19 Jul 2021 20:34:17 +0200
Cc: rfc-markdown@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <DBCC4252-8A2D-473C-82CD-B1B2688586D3@tzi.org>
References: <20210712034838.B461E209AFFB@ary.qy> <6c781dab-7a40-7031-be1c-d77a182f4cf4@gmail.com> <DE0CD982-D4BE-44A6-9234-B53A756E9717@mnot.net> <bbb8302a-4041-35db-ce61-d2a18b8ebeee@taugh.com> <AB6E5013-C14E-4962-8907-17F241971F9D@tzi.org> <20210719171839.GB24216@faui48e.informatik.uni-erlangen.de>
To: Toerless Eckert <tte@cs.fau.de>
X-Mailer: Apple Mail (2.3654.100.0.2.22)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/VUkTJiW0zeql9EloL7nXXRdp3Dw>
Subject: Re: [Rfc-markdown] Carsten: Re: [rfc-i] summary of Removing postal information from RFCs
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: Mon, 19 Jul 2021 18:34:26 -0000

CCing RFC-markdown...

> On 19. Jul 2021, at 19:18, Toerless Eckert <tte@cs.fau.de> wrote:
> 
> So, what is the relationship kramdown-rfc2629 to this ?
> 
> - Can the kramdown create xmlv3 output ?

Yes, via the --v2v3 process in xml2rfc.

Without the --v3 (kdrfc -3) flag, kramdown-rfc2629 produces just that, RFC 2629 (or its evolution that we call v2, as per RFC 7749).
This can be used by the historic v2 code in xml2rfc, or it can be converted to v3 using xml2rfc —v2v3.
After the successful transition from v2 to some v3, I don’t think that is a very function any more, but I’ll wait before killing it.

With the --v3 (-3) flag, kramdown-rfc2629 produces XML that xml2rfc can process, and that --v2v3 can turn into the current version of v3.
This XML is no longer v2 compliant, as it uses the new features of v3.
Not all v3 features are directly accessible from markdown syntax, but practically all of them can be activated via inline attribute lists (IALs) or by including XML syntax in the markdown.
(The only one really missing from the direct markdown translation is the new table format with colspan/rowspan, and that is hard to get right in markdown — I’m working on it.
Until then just enter the tables that need this in v3 XML format inside the markdown.)

> - Does it support postalline ?

Since 1.5.2, yes.
(The memo: update early, update often.)

> - Is there a better way to figure out answers other han
>   - check readme on github (didn't find it)

I’d memoize this: http://rfc.space
(Yeah, I’ll get to httpsing this, one of these days.)

>   - ask carsten (here)

Here = rfc-markdown@ietf.org (which can also be searched).

>   - trial and error (tried to avoid this so far ..)

Yes: read the commit history and/or the source.
Important progress is announced on rfc-markdown@ietf.org, but since postalLine support is probably a minority program right now, I didn’t announce 1.5.2 there yet (too little time before today).

Re postalLine, the 1.5.2 commit says:

+  # The below anticipates the "postalLine" changes.
+  # If a postalLine is used (abbreviated "postal" in YAML),
+  # non-postalLine elements are appended as further postalLines.
+  # This prepares for how "country" is expected to be handled
+  # specially with the next schema update.
+  # So an address is now best keyboarded as:
+  #   postal:
+  #     - Foo Street
+  #     - 28359 Bar
+  #   country: Germany

So what happens here is to put the value of `country:` in as another postalLine until `<country>` becomes allowed together with `<postalLine>`s in one of the next v3 versions.
Then there will be another change in the tool (here my strategy to isolate kramdown-rfc from v3 changes via --v2v3 obviously doesn’t work).
If you follow the above recommendation, there will be no need to do another change to the YAML then.

Grüße, Carsten



> 
> Cheers
>    Toerless
> 
> On Wed, Jul 14, 2021 at 09:29:12AM +0200, Carsten Bormann wrote:
>> On 14. Jul 2021, at 03:57, John R Levine <johnl@taugh.com> wrote:
>>> 
>>> Or you can give a sequence of postallines with an optional country, in which we render the whole list in order.
>> 
>> Works for me.
>> 
>> (I’m sure nobody will mind if my postal people tell me that starting the address with the lines
>> 
>> GND: 987654321
>> ORCID: 0123-4711-0815
>> 
>> will get my mail faster to me.)
>> 
>> Grüße, Carsten
>> 
>> _______________________________________________
>> rfc-interest mailing list
>> rfc-interest@rfc-editor.org
>> https://www.rfc-editor.org/mailman/listinfo/rfc-interest
> 
> -- 
> ---
> tte@cs.fau.de