[rfc-i] 1.3.37: Annotate contributors section (Re: contacts section?)

Carsten Bormann <cabo@tzi.org> Fri, 26 February 2021 15:07 UTC

Return-Path: <rfc-interest-bounces@rfc-editor.org>
X-Original-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Delivered-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 616773A09E0; Fri, 26 Feb 2021 07:07:54 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.648
X-Spam-Level:
X-Spam-Status: No, score=-2.648 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, MAILING_LIST_MULTI=-1, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=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 jx9FX6lTjVR8; Fri, 26 Feb 2021 07:07:52 -0800 (PST)
Received: from rfc-editor.org (rfc-editor.org [4.31.198.49]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9D59D3A09F5; Fri, 26 Feb 2021 07:07:52 -0800 (PST)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id 664BAF4074B; Fri, 26 Feb 2021 07:07:41 -0800 (PST)
X-Original-To: rfc-interest@rfc-editor.org
Delivered-To: rfc-interest@rfc-editor.org
Received: from localhost (localhost [127.0.0.1]) by rfc-editor.org (Postfix) with ESMTP id 1A1D2F4074B for <rfc-interest@rfc-editor.org>; Fri, 26 Feb 2021 07:07:41 -0800 (PST)
X-Virus-Scanned: amavisd-new at rfc-editor.org
Received: from rfc-editor.org ([127.0.0.1]) by localhost (rfcpa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 1Cm_kNM0vF2u for <rfc-interest@rfc-editor.org>; Fri, 26 Feb 2021 07:07:37 -0800 (PST)
Received: from gabriel-vm-2.zfn.uni-bremen.de (gabriel-vm-2.zfn.uni-bremen.de [134.102.50.17]) by rfc-editor.org (Postfix) with ESMTPS id CAE31F40749 for <rfc-interest@rfc-editor.org>; Fri, 26 Feb 2021 07:07:36 -0800 (PST)
Received: from [192.168.217.118] (p5089a828.dip0.t-ipconnect.de [80.137.168.40]) (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 4DnCh06142zyXV; Fri, 26 Feb 2021 16:07:44 +0100 (CET)
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <E294FFDC-9D2E-4AE6-B61B-440539AE232B@tzi.org>
Date: Fri, 26 Feb 2021 16:07:44 +0100
X-Mao-Original-Outgoing-Id: 636044864.204412-30aba237d7007c86673903fc08a59668
Message-Id: <5FB26904-1D13-4830-9755-65FDA94D3E13@tzi.org>
References: <20210226092712.GA7967@miek.nl> <0bcd3cac-6fa4-b7e1-63ae-e81380bb07cf@gmx.de> <20210226100116.GA8958@miek.nl> <93495dfb-d515-820e-d9ba-29cf711e5598@gmx.de> <E294FFDC-9D2E-4AE6-B61B-440539AE232B@tzi.org>
To: rfc-markdown@ietf.org
X-Mailer: Apple Mail (2.3608.120.23.2.4)
Subject: [rfc-i] 1.3.37: Annotate contributors section (Re: contacts section?)
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://www.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <http://www.rfc-editor.org/pipermail/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://www.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
Cc: RFC Interest Group <rfc-interest@rfc-editor.org>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: base64
Errors-To: rfc-interest-bounces@rfc-editor.org
Sender: "rfc-interest" <rfc-interest-bounces@rfc-editor.org>

1.3.37: contributors to be listed in the contributor section can now be annotated with text that will be added to that section after their contact information.

The text is entered in the “contribution” entry of the contact information for a contributor.
It is markdown and can contain paragraph breaks and other markup, as shown below (with some author information as context, which is not shown in the rendering).
Note that YAML has the “|” syntax that is strongly recommended for entering markdown text into YAML entries.

author:
  - name: Carsten Bormann
    org: Universität Bremen TZI
    email: cabo@tzi.org
contributor:
  - name: Peter Occil
    email: poccil14 at gmail dot com
    contribution: |
      Peter Occil registered tags 30, 264, 265, 268–270
      ({{advanced-arithmetic}}), 38, 257, 266 and 267
      ({{domain-specific}}), and contributed much of the text about
      these tags in this document.
  - name: Jane Doe
    org: To do
    contribution: |
      Further contributors will be listed here as text is added.

      Plase stay tuned.

➔ 

Contributors

   Peter Occil

   Email: poccil14 at gmail dot com

   Peter Occil registered tags 30, 264, 265, 268-270 (Section 6.1), 38,
   257, 266 and 267 (Section 7), and contributed much of the text about
   these tags in this document.

   Jane Doe
   To do

   Further contributors will be listed here as text is added.

   Plase stay tuned.

Note that the text rendition of the XML generated contains some spurious empty lines between contact and text; there is no obvious workaround until this is fixed in xml2rfc.  The HTML seems fine.

Grüße, Carsten


> On 2021-02-26, at 13:18, Carsten Bormann <cabo@tzi.org> wrote:
> 
> V3 has a contributors section.
> Kramdown-rfc can generate that from metadata that look exactly like author metadata (so it’s easy to shift back and forward).
> What we don’t have is a way to add annotations to that (no extra RFCXML support needed, as the kramdown-rfc result would then look a lot like the below).
> 
> Grüße, Carsten
> 
> 
>> On 26. Feb 2021, at 11:51, Julian Reschke <julian.reschke@gmx.de> wrote:
>> 
>> You can do something like:
>> 
>> <section name="Contacts">
>> <contact fullname="Sam Whatever" ...>
>> </contact>
>> <t>Sam wrote <xref. .../>.</t>
>> </section>
> 

_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest