Re: [xml2rfc-dev] V3 breakage in formatting internet draft references

Heather Flanagan <rse@rfc-editor.org> Tue, 01 October 2019 21:19 UTC

Return-Path: <rse@rfc-editor.org>
X-Original-To: xml2rfc-dev@ietfa.amsl.com
Delivered-To: xml2rfc-dev@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 314031200B8 for <xml2rfc-dev@ietfa.amsl.com>; Tue, 1 Oct 2019 14:19:43 -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_HELO_NONE=0.001, SPF_PASS=-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 e2vA5Yt53Wjg for <xml2rfc-dev@ietfa.amsl.com>; Tue, 1 Oct 2019 14:19:39 -0700 (PDT)
Received: from mail.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 4C003120089 for <xml2rfc-dev@ietf.org>; Tue, 1 Oct 2019 14:19:39 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id BEEDE200034; Tue, 1 Oct 2019 14:19:16 -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 QZ14DdjOWngT; Tue, 1 Oct 2019 14:19:16 -0700 (PDT)
Received: from [10.198.42.38] (c-71-231-216-10.hsd1.wa.comcast.net [71.231.216.10]) by c8a.amsl.com (Postfix) with ESMTPSA id 36C52200032; Tue, 1 Oct 2019 14:19:16 -0700 (PDT)
From: Heather Flanagan <rse@rfc-editor.org>
Message-Id: <DD4A3091-9E2B-417A-AF3A-8A44AFBBE60E@rfc-editor.org>
Content-Type: multipart/alternative; boundary="Apple-Mail=_2CEC5F18-6408-4B83-92F3-92DE196E7037"
Mime-Version: 1.0 (Mac OS X Mail 12.4 \(3445.104.11\))
Date: Tue, 01 Oct 2019 14:19:37 -0700
In-Reply-To: <b750c06e-caab-40e9-617d-57e0f79ff585@gmx.de>
Cc: XML Developer List <xml2rfc-dev@ietf.org>
To: Julian Reschke <julian.reschke@gmx.de>
References: <7e8bb742-1939-b48c-e7f7-03f3bec6bd63@gmx.de> <6F5868A8-56F3-4E26-B297-2CE0BD765397@rfc-editor.org> <b750c06e-caab-40e9-617d-57e0f79ff585@gmx.de>
X-Mailer: Apple Mail (2.3445.104.11)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/k3SLYVOR9d2qNuwZqneEuZj33ag>
Subject: Re: [xml2rfc-dev] V3 breakage in formatting internet draft references
X-BeenThere: xml2rfc-dev@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion about particulars of xml2rfc V3 design, development and code." <xml2rfc-dev.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc-dev/>
List-Post: <mailto:xml2rfc-dev@ietf.org>
List-Help: <mailto:xml2rfc-dev-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 01 Oct 2019 21:19:43 -0000


> On Oct 1, 2019, at 1:52 PM, Julian Reschke <julian.reschke@gmx.de> wrote:
> 
> On 01.10.2019 22:03, Heather Flanagan wrote:
>> 
>> 
>>> On Oct 1, 2019, at 8:01 AM, Julian Reschke <julian.reschke@gmx.de> wrote:
>>> 
>>> V3:
>>> 
>>>>   [Messaging]
>>>>              Fielding, R., Ed., Nottingham, M., Ed., and J. F. Reschke,
>>>>              Ed., "HTTP/1.1 Messaging", Internet-Draft, draft-ietf-
>>>>              httpbis-messaging-05, July 2019,
>>>>              <https://tools.ietf.org/html/draft-ietf-httpbis-messaging-
>>>>              99>.
>>> 
>>> V2:
>>> 
>>>>   [Messaging]
>>>>              Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke,
>>>>              Ed., "HTTP/1.1 Messaging", draft-ietf-httpbis-messaging-
>>>>              05 (work in progress), July 2019.
>>> 
>>> Observations:
>>> 
>>> 1) author initials not restricted to one anymore (I'm open to change,
>>> but it should be properly documented)
>> 
>> That’s been in the draft style guide for a while.
>> 
>> "<t>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.</t>"
> 
> That's about the front page, not for references.

Iirc, we’ve always tried to be consistent between what’s on the front page and what’s in the references. 

> 
> For the latter, the draft style guide says in
> <https://tools.ietf.org/html/draft-flanagan-7322bis-03#section-4.8.6.4 <https://tools.ietf.org/html/draft-flanagan-7322bis-03#section-4.8.6.4>>:
> 
>>   [SYMBOLIC-TAG]  Last name, First initial., Ed. (if applicable) and
>>   First initial.  Last name, Ed. (if applicable), "I-D Title", Internet
>>   Draft, draft-string-NN, Month Year.
> 
> Note: "first initial”.

“Second initial if provided” is a really ugly example, but I can add it if you think it’s critical.

> 
>> .. >> 3) "(work in progress)" is missing
>> 
>> Bug.
> 
> Ack.
> 
>>> 4) A URI on tools.ietf.org <http://tools.ietf.org/> is inserted that I'd prefer not to have here.
>> 
>> Why not? I think having a URI makes a lot of sense.
> 
> The style guide doesn't say so. The author didn't provide one. Why is
> the tool inserting something automatically? Also, why to tools.ietf.org <http://tools.ietf.org/>?
> Are you planning to put that into the style guide?

Well, there are always things the authors don’t provide that are automatically added. And since we’ve been talking about making sure that internal links to specific sections are included (which perforce MUST go to tools references) the thought was to be consistent and have the reference point to the same place that the internal section pointers are going to send people. I think it would be confusing to have one set of links go one place, and another set of links to somewhere entirely different.

-Heather