Re: [Rfc-markdown] Author listing in XML and Markdown?

Carsten Bormann <cabo@tzi.org> Wed, 11 March 2020 23:21 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 6B8DF3A0A4F for <rfc-markdown@ietfa.amsl.com>; Wed, 11 Mar 2020 16:21:01 -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 xCZ9QQW7w_Ya for <rfc-markdown@ietfa.amsl.com>; Wed, 11 Mar 2020 16:20:57 -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 C0C323A0A11 for <rfc-markdown@ietf.org>; Wed, 11 Mar 2020 16:20:52 -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 48d7HP2nYqzyTl; Thu, 12 Mar 2020 00:20:49 +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: <04CD97D2-8AA3-4826-8A1E-9EC8D74B3947@amsl.com>
Date: Thu, 12 Mar 2020 00:20:48 +0100
Cc: Eric Gray <eric.gray@ericsson.com>, RFC Editor <rfc-editor@rfc-editor.org>, RFC Markdown <rfc-markdown@ietf.org>
X-Mao-Original-Outgoing-Id: 605661648.700125-af8aa4ec7828b2c386bed8d7aed86158
Content-Transfer-Encoding: quoted-printable
Message-Id: <48FE125D-32EC-4D52-A2AD-4AFE44A59409@tzi.org>
References: <BN8PR15MB2644C01E60453D9CE2F00BE297FC0@BN8PR15MB2644.namprd15.prod.outlook.com> <04CD97D2-8AA3-4826-8A1E-9EC8D74B3947@amsl.com>
To: Alice Russo <arusso@amsl.com>
X-Mailer: Apple Mail (2.3608.60.0.2.5)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/xebR1HnhcrNXkag9jLz1QG7-GWk>
Subject: Re: [Rfc-markdown] Author listing in XML and Markdown?
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, 11 Mar 2020 23:21:08 -0000

On 2020-03-11, at 23:16, Alice Russo <arusso@amsl.com> wrote:
> 
> Hi Eric,
> 
> [CC'ing Carsten because perhaps he can share some kramdown-rfc2629 magic.]

I might be able to cook up some such magic if needed.

> There is no role="contributor". There is the new <contact> element in the xml2rfc v3 vocabulary, which is essentially the same as <author>. (For the v3 vocabulary, the RelaxNG is here: https://svn.tools.ietf.org/svn/tools/xml2rfc/trunk/cli/xml2rfc/data/v3.rnc)
> 
> So, two methods come to mind:
> 1) Copy & paste the desired output (from a text file) into an <artwork> element in the contributors section.

… which looks quite ugly.

> 2) If using xml2rfc w/ the v3 vocabulary, you can simply change <author> to <contact> and put those elements directly into the contributors section.

So you have to put in that section manually, while the “authors’ addresses” section is put in by XML2RFC based on the front matter information.  Not something I would have designed…

But it is a small matter of programming to support this.  
Might do that later today (CET today).

So the idea would be that you have an additional YAML section for contributors, like this:

author:
 - name: Henk Birkholz
 - name: Max Pritikin
 - name: Robert Moskowitz
contributor:
 - name: Carsten Bormann

(I stripped out all the other metadata, I hope you get the idea.)
That makes it minimally painful to move people around between the two, which happens a lot because of the straightjacket that the five-author rule is.

Now how do we get this info into the Contributors Section (RFC 7322, 4.11).
As I said, this section is not automatically inserted by XML2RFC.
In the authoring XML, it is the last section (unnumbered) of the main body (i.e., before the back matter), so kramdown-rfc could simply insert it automatically there, just like xml2rfc then does with authors’ addresses.

The problem with that is that Contributors also can be more like a free text section, as in acknowledgements.  I’m not sure how those would mix in practice; I haven’t seen a Contributors section that had both contact info and free text.
(And no, I don’t know why this isn’t “contributors’ addresses".)

Of course, all this only works with v3 processing rules.

I’m CCing rfc-markdown and removing some text to make this less of a violation of etiquette, apologizing in advance if it still is.

Grüße, Carsten