Re: [Rfc-markdown] [xml2rfc] initials handling, was: New xml2rfc release: v2.22.3

Heather Flanagan <rse@rfc-editor.org> Thu, 11 April 2019 15:06 UTC

Return-Path: <rse@rfc-editor.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 6DAC012038D; Thu, 11 Apr 2019 08:06:18 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.199
X-Spam-Level:
X-Spam-Status: No, score=-4.199 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_MED=-2.3, 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 Uk5RB021gF8V; Thu, 11 Apr 2019 08:06:15 -0700 (PDT)
Received: from mail.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 5D16E120006; Thu, 11 Apr 2019 08:06:15 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 8A08E1C2B53; Thu, 11 Apr 2019 08:06:07 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id eREjFUQfHriH; Thu, 11 Apr 2019 08:06:07 -0700 (PDT)
Received: from [10.119.8.87] (unknown [74.115.160.217]) by c8a.amsl.com (Postfix) with ESMTPSA id D7DA11C38DB; Thu, 11 Apr 2019 08:06:06 -0700 (PDT)
From: Heather Flanagan <rse@rfc-editor.org>
Message-Id: <3A0F4CD6-451F-44E2-9DA4-28235C638588@rfc-editor.org>
Content-Type: multipart/alternative; boundary="Apple-Mail=_70EA8E26-3E37-43FE-B9DB-177E25DC9DDC"
Mime-Version: 1.0 (Mac OS X Mail 12.4 \(3445.104.8\))
Date: Thu, 11 Apr 2019 08:06:12 -0700
In-Reply-To: <308E0D17-7B84-4782-B17D-EE06EE80E6BE@rfc-editor.org>
Cc: "rfc-markdown@ietf.org" <rfc-markdown@ietf.org>, "xml2rfc-dev@ietf.org" <xml2rfc-dev@ietf.org>, "xml2rfc@ietf.org" <xml2rfc@ietf.org>
To: Julian Reschke <julian.reschke@gmx.de>
References: <E1hDSIW-0008DY-Hl@durif.tools.ietf.org> <c8d8c9e9-88dd-8c49-c1d4-e0438c56a03c@gmx.de> <f41d8ba2-7078-0ffa-3e41-6f8bc1d0f766@levkowetz.com> <dfcbd237-bbff-867d-b704-cb874c4b2ed3@gmx.de> <b760846d-5183-ad8a-dd42-62a7800bdbf6@levkowetz.com> <561D7097-7155-4DDD-8C5D-FA65663B5105@att.com> <280b0cf8-a7d0-0334-42fe-a9cd6e7966d7@gmx.de> <1DC0E053-509F-4531-9EAF-1A287FFA4ECD@att.com> <8cedc522-614c-039c-e550-8f5494ab040f@gmx.de> <308E0D17-7B84-4782-B17D-EE06EE80E6BE@rfc-editor.org>
X-Mailer: Apple Mail (2.3445.104.8)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/vC9iIuVMz_mFaf6It--J0gxy92Q>
Subject: Re: [Rfc-markdown] [xml2rfc] initials handling, was: New xml2rfc release: v2.22.3
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, 11 Apr 2019 15:06:19 -0000


> On Apr 9, 2019, at 10:34 AM, Heather Flanagan <rse@rfc-editor.org> wrote:
> 
> 
> 
>> On Apr 9, 2019, at 09:01, Julian Reschke <julian.reschke@gmx.de> wrote:
>> 
>>> On 09.04.2019 17:37, HANSEN, TONY L wrote:
>>> On 4/9/19, 8:19 AM, "Julian Reschke" <julian.reschke@gmx.de> wrote:
>>> 
>>>    On 09.04.2019 14:11, HANSEN, TONY L wrote:
>>>> ...
>>>> How is the requirement to generate a single initial communicated within the XML? By looking at the RFC number? Or by a different attribute specified somewhere? While using the RFC number might seem simpler, I think it's better to be transparent and use an attribute.
>>>> ...
>>> 
>>>    Yes.
>>> 
>>>    But we really should ask the RFC Editor whether they are sure about
>>>    this. After all, it seems to be a violation of the style guide:
>>>    <https://tools.ietf.org/html/rfc7322#section-4.8.6.2>.
>>> 
>>> For re-rendering old RFCs that were originally written using a previous style guide? The interesting thing about style guides is that they do change over time.
>> 
>> Yes, but in that case the rendering depends on the RFC the reference
>> appears in, not on the referenced document.
>> 
>> FWIW, it would be great if revisions to the style guide also defined a
>> precise start date from which the rules apply.
>> 
>>> I know that we've had various means of doing these stylistic machinations through the years, such as code that says "if rfc number < some value, do this special stylistic processing" or "if public date is before some value, do this special stylistic processing ". The reason I asked my question was that I don't know how the current V3 code is making its decisions for these stylistic issues. My suggestion above is that instead of having code like that, it should instead be "if some <rfc> attribute is set, do this to the initials".
> 
> Hi all,
> 
> I’m discussing this with Sandy and Alice now; a response to the list may take a day or so as I’m traveling at the moment.
> 

And coming back to this:

A longstanding principle for referencing RFCs is to make the reference match what is on the front page of the RFC itself, over what information is in any other location. This is something we should be clearer about in the Style Guide, but it is a practice we’ve enforced for quite a long time. 

Changing the tool to match this longstanding practice is not ideal, but it is expedient given that the proper way to handle this is an extensive data cleanup of the citation library. I’ve asked the RPC to prioritize getting documents published and format implementation over this kind of data cleanup for now. 

-Heather Flanagan