[Tools-discuss] structured contributor section --- auto-reference to DT/Person?

Michael Richardson <mcr+ietf@sandelman.ca> Thu, 29 October 2020 16:51 UTC

Return-Path: <mcr+ietf@sandelman.ca>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 1FBB23A09D4 for <tools-discuss@ietfa.amsl.com>; Thu, 29 Oct 2020 09:51:48 -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 wEqDv8lMZwvF for <tools-discuss@ietfa.amsl.com>; Thu, 29 Oct 2020 09:51:45 -0700 (PDT)
Received: from tuna.sandelman.ca (tuna.sandelman.ca [209.87.249.19]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9DBEE3A0971 for <tools-discuss@ietf.org>; Thu, 29 Oct 2020 09:51:45 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by tuna.sandelman.ca (Postfix) with ESMTP id E386D389D3 for <tools-discuss@ietf.org>; Thu, 29 Oct 2020 12:58:30 -0400 (EDT)
Received: from tuna.sandelman.ca ([127.0.0.1]) by localhost (localhost [127.0.0.1]) (amavisd-new, port 10024) with LMTP id xS5VMAM-WkG3 for <tools-discuss@ietf.org>; Thu, 29 Oct 2020 12:58:30 -0400 (EDT)
Received: from sandelman.ca (obiwan.sandelman.ca [IPv6:2607:f0b0:f:2::247]) by tuna.sandelman.ca (Postfix) with ESMTP id 61FB9389CF for <tools-discuss@ietf.org>; Thu, 29 Oct 2020 12:58:30 -0400 (EDT)
Received: from localhost (localhost [IPv6:::1]) by sandelman.ca (Postfix) with ESMTP id 0706A59A for <tools-discuss@ietf.org>; Thu, 29 Oct 2020 12:51:44 -0400 (EDT)
From: Michael Richardson <mcr+ietf@sandelman.ca>
To: tools-discuss <tools-discuss@ietf.org>
X-Attribution: mcr
X-Mailer: MH-E 8.6+git; nmh 1.7+dev; GNU Emacs 26.1
X-Face: $\n1pF)h^`}$H>Hk{L"x@)JS7<%Az}5RyS@k9X%29-lHB$Ti.V>2bi.~ehC0; <'$9xN5Ub# z!G,p`nR&p7Fz@^UXIn156S8.~^@MJ*mMsD7=QFeq%AL4m<nPbLgmtKK-5dC@#:k
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-="; micalg="pgp-sha512"; protocol="application/pgp-signature"
Date: Thu, 29 Oct 2020 12:51:44 -0400
Message-ID: <17582.1603990304@localhost>
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/2S80GaFR-hN4oxSQz6ga_-WrXoo>
Subject: [Tools-discuss] structured contributor section --- auto-reference to DT/Person?
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 29 Oct 2020 16:51:48 -0000

Some year or so ago I asked if our XML format could accomodate a structured
form of the contributor.  There was various discussion (ratholing, alas) on
how different WGs would use it differently, and how to game the system, etc.

It turns out that we already have this feature.
In the kramdown, one can do:

contributor:
  - name: Bugs Bunny
    email: bugsbunny@loneytunes.example

which results in XML like:

    <section anchor="contributors" numbered="false" toc="include" removeInRFC="false">
      <name>Contributors</name>
      <contact initials="B." surname="Bunny" fullname="Bugs Bunny">
        <organization/>
        <address>
          <email>bugsbunny@loneytunes.example</email>
        </address>
      </contact>

It occurs to me that it might be nice if we could connect the contributors
directly to a DT /Person/XYZ page.   That would sure make any kind of
mechanical collection of the data really really really easy.
It's right now, easy: take the email address and find it in the DT list of
emails for the people.

But, on my side, the authoring side, I often three things wrong:
 1) I don't know how to get the right accents and/or non-english UTF-8 right.
 2) My notion of <organization> could be obsolete.
 3) What if I credit the wrong person because names are similiar?

On the contributor side, it would be nice if they knew that their name was
there, in part so that they could object!

So I'm thinking that it would be cool if we could do something like:

  <?ietf-dt include="bugsbunny@loneytunes.example" ?>
  [Not sure how I'd do this in kramdown. New "ietfdtemail:" tag or something]

to get the contributor and/or author information sucked in documents.

Would this be helpful, or am I just trying to be too cute?
This is just stuff to code, no changes to the XML scheme required, AFAIK.

--
Michael Richardson <mcr+IETF@sandelman.ca>   . o O ( IPv6 IøT consulting )
           Sandelman Software Works Inc, Ottawa and Worldwide