Re: [Rfc-markdown] 1.5.26: Initials

Martin Thomson <mt@lowentropy.net> Thu, 10 February 2022 02:45 UTC

Return-Path: <mt@lowentropy.net>
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 7906C3A12DD for <rfc-markdown@ietfa.amsl.com>; Wed, 9 Feb 2022 18:45:36 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -7.1
X-Spam-Level:
X-Spam-Status: No, score=-7.1 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=lowentropy.net header.b=YbZELtof; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=GjxchFOg
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 xhrOG1yCY09U for <rfc-markdown@ietfa.amsl.com>; Wed, 9 Feb 2022 18:45:31 -0800 (PST)
Received: from wout3-smtp.messagingengine.com (wout3-smtp.messagingengine.com [64.147.123.19]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 106043A12DF for <rfc-markdown@ietf.org>; Wed, 9 Feb 2022 18:45:30 -0800 (PST)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailout.west.internal (Postfix) with ESMTP id 57E273200FA9 for <rfc-markdown@ietf.org>; Wed, 9 Feb 2022 21:45:30 -0500 (EST)
Received: from imap41 ([10.202.2.91]) by compute2.internal (MEProxy); Wed, 09 Feb 2022 21:45:30 -0500
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lowentropy.net; h=cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to; s=fm1; bh=sE2OViklozBMA2 w5Nc6LPKj0ggTIbujsnG51Kvt0ryE=; b=YbZELtof/7PMEurb0FTUXbEDqV8x9O qM8z/tRnvca0mjW5zhkWMKjU1EEdJtjPPfnbRxvvmrKgUN2V314HuFcpz+AIChcO v70Ubu8VOVkEuyjnMEU63lNEpePPXDsdN5cuy01PT0rRJoAjnPh+VlEQkAxLiXBM zVGjeD+P03ihp4ahZkLx9ScYQx17u79IbALpu8+/N5FWvekHLjfyBJvUGFXdFnS7 tBtau9oHHhrWSS0w36gkWUPKs8SFluYk9q3WluMGT7VbQvGoaNCt5JBRi/ho/gPP EwPxrLc8e5dEJ6QAmGqj5Hjr4ZSqboqjxW6gLMtXV0HtdFZY/ZvE9roA==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:date:from:from:in-reply-to:in-reply-to:message-id :mime-version:references:reply-to:sender:subject:subject:to:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm2; bh=sE2OViklozBMA2w5Nc6LPKj0ggTIbujsnG51Kvt0ryE=; b=GjxchFOg 9WUflDVPjOdw+B9PxpYcxAjEj6XwAPWzrSbCKm7uNKV7L/NVjxTW7VW4NXm0Xq3j 9F1luDJpklWgr0eQGw1TL0IGeoh/kpvXmnYzZWh8nZfSvagwktxcKRw6+wDI8TDl SB9o9T63bwi2digkXkwl/iDrBqMAZvz4FhjPoEmQFIv3N/wn8OAH+g8FDV//MCAj 8gAEcXu9vwOGjDt+ln4Z4uIXWsiLa4jN8tELFO8uGtttSS0OojcNlTMYx/Rs5QxC raRDjDlPh2J1wnT8skXwI8hTQjsA8brRLYppQcv3WMVSaJ5rh1iwyxAHj+sWiYss baJjxhxH1RM6Xg==
X-ME-Sender: <xms:SXwEYoEwVfTsbmOTTmqwOF6zfyfjC81L0czlQ4qHX1L2VHTc4EmJxw> <xme:SXwEYhWpu27UEcRARPfjfiNuFj4AdTyDPeErOItOvwi-sEY79bKJxBzr-ERONjgHH ymV9R5H5iullGrUySo>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvvddriedtgdegkecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhepofgfggfkjghffffhvffutgfgsehtqh ertderreejnecuhfhrohhmpedfofgrrhhtihhnucfvhhhomhhsohhnfdcuoehmtheslhho figvnhhtrhhophihrdhnvghtqeenucggtffrrghtthgvrhhnpeeuieeugeettdegveegge ffgeeuiedufffhjeeuvdelvdeuuedtvdffjeeltdetudenucffohhmrghinheprhhftgdq vgguihhtohhrrdhorhhgpdhivghtfhdrohhrghenucevlhhushhtvghrufhiiigvpedtne curfgrrhgrmhepmhgrihhlfhhrohhmpehmtheslhhofigvnhhtrhhophihrdhnvght
X-ME-Proxy: <xmx:SXwEYiI0jMwAIzTFLrQd0uyWLDtSz1zu4u9NCn_Zspyjbla3OEaTlQ> <xmx:SXwEYqEqxN6JOJyMKobCZ1b1vU0qqwSVR4kqVLPVX-rWk1jWHvKhMw> <xmx:SXwEYuWQgj7lmcWFxfgm5NP06v48Ve_i4KRhaJkJ0TZiACOMc_NKOg> <xmx:SXwEYmjKEBaXmgAqe55v3aqT48FyaqBvA-qOOuNzB3_mCTTHghwLFw>
Received: by mailuser.nyi.internal (Postfix, from userid 501) id ACDDE3C0F8A; Wed, 9 Feb 2022 21:45:29 -0500 (EST)
X-Mailer: MessagingEngine.com Webmail Interface
User-Agent: Cyrus-JMAP/3.5.0-alpha0-4748-g31a5b5f50e-fm-cal2020-20220204.001-g31a5b5f5
Mime-Version: 1.0
Message-Id: <c2598a10-34a7-4296-a52e-44b43016426f@beta.fastmail.com>
In-Reply-To: <9A0C6DD1-818D-490B-AB72-C0007B532128@tzi.org>
References: <9A0C6DD1-818D-490B-AB72-C0007B532128@tzi.org>
Date: Thu, 10 Feb 2022 13:45:10 +1100
From: Martin Thomson <mt@lowentropy.net>
To: rfc-markdown@ietf.org
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/_FMjXQWYNMHcBKvGyEcxDIxnp9k>
Subject: Re: [Rfc-markdown] 1.5.26: Initials
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, 10 Feb 2022 02:45:37 -0000

Thanks for doing this Carsten.  I would like to suggest that the solution here might be less necessary if we didn't have publication formats that insisted on using initials.

What this change means is that now that I have stopped adding "ins", it will be added for me.  I'd rather it not exist at all.

On Thu, Feb 10, 2022, at 12:30, Carsten Bormann wrote:
> I have just pushed kramdown-rfc version 1.5.26 (see discussion about 
> Ruby versions).
>
> This release mainly focuses on author information (both for the 
> document itself and in references), and in particular provides access 
> to the asciiXXX attributes that RFCXMLv3 provides to be able to render 
> Latin (not necessarily ASCII) variants of non-Latin names used in 
> author info, contributor info, and in references.  This support is 
> unfortunately hobbled by a few xml2rfc bugs; I’ll announce the feature 
> more properly when we have progress on these.
>
> The change that was long overdue and was forced due to the above 
> changes is better support for generating initials.
>
> As discussed in various fora, we really should get rid of the habit of 
> shortening names into initials.  But it is what we have in RFCXML, the 
> references database, as well as in the most recent style guide RFC 
> 7322, so we need to work with them.
>
> Today, many people provide both the initials and the fullname in a 
> construct like:
>
> authors:
>   - ins: C. Bormann
>     name: Carsten Bormann
>
> kramdown-rfc2629 now takes care to generate the “ins” from the “name”, 
> so it is no longer necessary to put in the ins:
>
> authors:
>   - name: Carsten Bormann
>
> The heuristics can handle hyphenated names:
>
>   - name: Jean-Pierre Paul
>
> The heuristics need help with complex last names:
> Just separate the first names from the last name with a pipe:
>
>   - name: Jean-Pierre | Paul de Vera
>
> (Note that “Paul de Vera” is the last name; this is needed often for 
> Spanish last names, but also for “van der Stok” and “von Schneider” etc.
> The pipe of course doesn’t make it through to the fullname attribute.)
>
> As far as I can see, the heuristics now work very well.  
>
> However, there is one snag:
>
>   - name: Richard L. Barnes
>
> Leads to a full set of initials on the front page:
>
>                            R. L. Barnes
>
> (And “Richard L. Barnes” in the authors’ addresses section, as it should.)
>
> This initialization is as it should be, but not the current practice 
> (*).
> So in this case, if you really want/need to emulate current practice, 
> you have to play the “ins” game or explicitly give the “initials” 
> attribute to override the heuristic for the frontpage.
>
>   - ins: R. Barnes
>     name: Richard L. Barnes
>
>   - name: Richard L. Barnes
>     initials: R.
>
> Grüße, Carsten
>
> (*)
> RFC 7322 says:
>
> 4.1.1:
>    The author's name (initial followed by family name) appears on the
>    first line of the heading.  Some variation, such as additional
>    initials or capitalization of family name, is acceptable.  Once the
>    author has selected how their name should appear, they should use
>    that display consistently in all of their documents.
>
> 4.8.6.2:
>       [RFCXXXX] Last name, First initial., Ed. (if applicable),
>                 "RFC Title", Sub-series number (if applicable),
>                 RFC number, Date of publication,
>                 <http://www.rfc-editor.org/info/rfc#>.
>
> There are enough cases that look somewhat different, so I was not able 
> to really derive a rule here:
>
> RFC 7693:
>    Markku-Juhani O. Saarinen (editor)
>    Jean-Philippe Aumasson
> ➔
> 7693 The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC).
>      M-J. Saarinen, Ed., J-P. Aumasson. November 2015. (Format: TXT,
>      HTML) (Status: INFORMATIONAL) (DOI: 10.17487/RFC7693) 
>
> RFC 8585:
>    Jordi Palet Martinez     [a Spanish name]
>    Hans M.-H. Liu           [Chinese name with “English” given name added?]
> ➔
> 8585 Requirements for IPv6 Customer Edge Routers to Support
>      IPv4-as-a-Service. J. Palet Martinez, H. M.-H. Liu, M. Kawashima.
>      May 2019. (Format: TXT, HTML) (Status: INFORMATIONAL) (DOI:
>      10.17487/RFC8585) 
>
>
> _______________________________________________
> Rfc-markdown mailing list
> Rfc-markdown@ietf.org
> https://www.ietf.org/mailman/listinfo/rfc-markdown