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

Eric Gray <eric.gray@ericsson.com> Thu, 12 March 2020 14:26 UTC

Return-Path: <eric.gray@ericsson.com>
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 160B63A0A20 for <rfc-markdown@ietfa.amsl.com>; Thu, 12 Mar 2020 07:26:08 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.101
X-Spam-Level:
X-Spam-Status: No, score=-2.101 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=ericsson.com
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 FK-4HhzvvNWu for <rfc-markdown@ietfa.amsl.com>; Thu, 12 Mar 2020 07:26:06 -0700 (PDT)
Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2062.outbound.protection.outlook.com [40.107.223.62]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id ADD9E3A0A1B for <rfc-markdown@ietf.org>; Thu, 12 Mar 2020 07:26:06 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=mqK+QqZg1daPDGhKJvOtVCpYI/4ZOtZiyGBjjIVALoruiVB/4/Qw2ySp5HGV5KVNyZOxSn/IFnz81tu9cOHCJKDbJQJqbu+SJ332iivmFz/socy9HY0PzYcVLoZT7BsK1QopkvK255uJgi33BRXewmT9EG9dKFUrfBFPHY7Edf/Zpv/RYqFE0rZqZCpzusyW8qeJp84Etdty0nipuVYnL6VUqWbj/pcEep4hQYANmWbhg1if7TljJx3pb+cMrRZb09TCssLW8KfP+d8QcDM+GfX6NRg/pe7jiJO5D/+4bf+IEssExWq7a3adku6ggRUYSOZfNJjyQrIItbvlN+uA2g==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=OOrBMvDGlEXbzXEn1F/5Rhy87V72Iz4FXEVtdF6CXF0=; b=RGgYsHvG/l6mGpnd0MRSJBHTTGr2XJv1FfPaXsiGjsxS3VwXcFF2NijzVMgbvvOf5Mu+4qajHv8OzjfHhdA2S75B6NADL60O8TM6XXZS54ib1sIia9V984mYBRCyst7M+1Y6OO1KO/5hfJBkLz7Ljuu6jNp5+dogdpqFahOghl65Hpr1u4HMjMmrwp8Z1BU3z/v29LoYY3wlqnRMUNKhAbPprVmnLSZfamKWTR2TT2VpJUXOpVpyj1w5cJsJrayHpi0xkV1nhATMkEgecvwTE1OpkDxqqxDpbIgHcggF2imzJwY2C35DvdERUNj2po0WDaT1GeDXQWalHLvU7aZ/Mg==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=ericsson.com; dmarc=pass action=none header.from=ericsson.com; dkim=pass header.d=ericsson.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=OOrBMvDGlEXbzXEn1F/5Rhy87V72Iz4FXEVtdF6CXF0=; b=t3SbYYWJekAh3fLD0fFfAM7jvsU9iXNKOL2zdZ/s2ynHMtJIy3aHPNfTToyncB9Nc4F7Ksngjk104TLho4J1N3RsfUmc+FKlbDRzjKgCYC/Cn/3f79ttMa+p2Wb5HakQSUOE5FkSUiMP5EvtYsJLIDtJDETaAV49KVbnKaDBN2g=
Received: from BN8PR15MB2644.namprd15.prod.outlook.com (2603:10b6:408:c8::27) by BN8PR15MB3140.namprd15.prod.outlook.com (2603:10b6:408:91::32) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2814.14; Thu, 12 Mar 2020 14:26:04 +0000
Received: from BN8PR15MB2644.namprd15.prod.outlook.com ([fe80::b083:9869:d21f:619e]) by BN8PR15MB2644.namprd15.prod.outlook.com ([fe80::b083:9869:d21f:619e%6]) with mapi id 15.20.2814.007; Thu, 12 Mar 2020 14:26:04 +0000
From: Eric Gray <eric.gray@ericsson.com>
To: Carsten Bormann <cabo@tzi.org>, Alice Russo <arusso@amsl.com>
CC: RFC Editor <rfc-editor@rfc-editor.org>, RFC Markdown <rfc-markdown@ietf.org>
Thread-Topic: Author listing in XML and Markdown?
Thread-Index: AdX377h1koq2az6USHOhhP5oWOPW7wAAwLVeAAI9ygAAH1h9MA==
Date: Thu, 12 Mar 2020 14:26:04 +0000
Message-ID: <BN8PR15MB2644A7D162B05A41AEB4D17697FD0@BN8PR15MB2644.namprd15.prod.outlook.com>
References: <BN8PR15MB2644C01E60453D9CE2F00BE297FC0@BN8PR15MB2644.namprd15.prod.outlook.com> <04CD97D2-8AA3-4826-8A1E-9EC8D74B3947@amsl.com> <48FE125D-32EC-4D52-A2AD-4AFE44A59409@tzi.org>
In-Reply-To: <48FE125D-32EC-4D52-A2AD-4AFE44A59409@tzi.org>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
authentication-results: spf=none (sender IP is ) smtp.mailfrom=eric.gray@ericsson.com;
x-originating-ip: [129.192.79.10]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 71da8e71-9dfd-47ae-739b-08d7c6914c14
x-ms-traffictypediagnostic: BN8PR15MB3140:
x-microsoft-antispam-prvs: <BN8PR15MB31409F9107AC7B12A93D1E5697FD0@BN8PR15MB3140.namprd15.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:9508;
x-forefront-prvs: 0340850FCD
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(376002)(136003)(39860400002)(346002)(396003)(366004)(199004)(316002)(71200400001)(110136005)(44832011)(2906002)(8936002)(966005)(52536014)(5660300002)(6506007)(81156014)(81166006)(7696005)(53546011)(54906003)(478600001)(86362001)(26005)(33656002)(8676002)(4326008)(55016002)(9686003)(66946007)(64756008)(186003)(66476007)(66446008)(66556008)(76116006); DIR:OUT; SFP:1101; SCL:1; SRVR:BN8PR15MB3140; H:BN8PR15MB2644.namprd15.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1;
received-spf: None (protection.outlook.com: ericsson.com does not designate permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: kExacAGvtM8eFNPdyVGreenit6SmUN2NSeqW+JBQoUvRytXFpMev8Rm4MmLGP9LWMGJl/yPsVFFsGuUzriqPy6JIBrf59moVy7yvAsfXBEIwCSxd8tNeG+vGYEqnu9v3iE/MQ5sLBJFuUa1PdXxx7EB13GzNSWdwkCZRpYsrlMmXJR9esbSNXVVst2BVnPSIBcM9MrF+vCmXF2MNkq1b45t3TdEI8V5CpUZgVAHC+T9/qMNgjrJDdYagZFSpQV5/vISG2nWhYNGzITjtYBRdsNz91TFJtjwFvggM59Iab7qfNckvsLbOvjakBYR/+rgaZpr6eU1NuufOgkQEozaTjz8ZjC1e3mxns4GjfpNbV1Yxf6w9fWKBoIFElPLpSVi3drIt10+4gCcCXJSLo0VIwF8tiC2baein5PPlXQXSNnc+MTEE+G7OscPT5E1rQRvCrB8hLs+3v9OJw8o1MAi2nfKip/9BAahMMVunOMOz6W213iEjuIl13yjFxKUra4pMnypV95gg9cjy+alaD7IZBg==
x-ms-exchange-antispam-messagedata: QB/rVEYSg3SWd8OScKl4mmAIgcJrbfvo7NWGP8nEUpAwMzWXOXBve3BaueRHRsQgDehJMB7SbQBKHPMpDQjPucRofE6IcpACylNi3Mx5TonVcTlKhCh5z8Fo72ahbOIJS6MB5PeOxCEPMO2XxvKAPw==
x-ms-exchange-transport-forked: True
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-OriginatorOrg: ericsson.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 71da8e71-9dfd-47ae-739b-08d7c6914c14
X-MS-Exchange-CrossTenant-originalarrivaltime: 12 Mar 2020 14:26:04.2792 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 92e84ceb-fbfd-47ab-be52-080c6b87953f
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: q2401ddFWtx6XWZPTLS4eATTz/aGvuUiw7HyrwbH3TckHeWafvgvKA9eIQbGigNiBwAc181KQtawZCwmU/nUlw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN8PR15MB3140
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/aWQvhBCoTdg7vsIwt-sRHmEqLro>
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: Thu, 12 Mar 2020 14:26:08 -0000

Carsten,

	That would be great.  I have a list of names in that way now, which I have left in because I only get a warning that "contributor ... is not included" (keeps me from having to document the list elsewhere).

	An alternative I had tried was trying to use the "role" attribute under "author" (which is what I had to do to list myself and another person as "Editors").

	Everything I tried (obviously, other than "editor") gave an error that the attribute value was not in the enumerated set.

	But I had not tried using "contact."  Okay, I get the same error using role: contact.  Sigh.

	Is there some place where I could look to see what "role" attribute values are in the enumerated set; are there other enumerated sets that might be useful?

--
Eric

-----Original Message-----
From: Carsten Bormann <cabo@tzi.org> 
Sent: Wednesday, March 11, 2020 7:21 PM
To: Alice Russo <arusso@amsl.com>
Cc: Eric Gray <eric.gray@ericsson.com>om>; RFC Editor <rfc-editor@rfc-editor.org>rg>; RFC Markdown <rfc-markdown@ietf.org>
Subject: Re: Author listing in XML and Markdown?

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