Re: [rfc-i] Errata Reference Format

"Heather Flanagan (RFC Series Editor)" <rse@rfc-editor.org> Thu, 04 May 2017 23:34 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 C788E12773A for <ietfarch-rfc-interest-archive@ietfa.amsl.com>; Thu, 4 May 2017 16:34:01 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.503
X-Spam-Level:
X-Spam-Status: No, score=-1.503 tagged_above=-999 required=5 tests=[BAYES_50=0.8, RCVD_IN_DNSWL_MED=-2.3, RP_MATCHES_RCVD=-0.001, SPF_HELO_PASS=-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 pLNdAXSmT8-l for <ietfarch-rfc-interest-archive@ietfa.amsl.com>; Thu, 4 May 2017 16:34:00 -0700 (PDT)
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 209B1126D46 for <rfc-interest-archive-eekabaiReiB1@ietf.org>; Thu, 4 May 2017 16:34:00 -0700 (PDT)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id 9925BB819EA; Thu, 4 May 2017 16:33:54 -0700 (PDT)
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 D1A6DB819E9 for <rfc-interest@rfc-editor.org>; Thu, 4 May 2017 16:33:52 -0700 (PDT)
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 zrcMZNs1r5xp for <rfc-interest@rfc-editor.org>; Thu, 4 May 2017 16:33:51 -0700 (PDT)
Received: from mail.amsl.com (c8a.amsl.com [4.31.198.40]) by rfc-editor.org (Postfix) with ESMTPS id 63053B819E8 for <rfc-interest@rfc-editor.org>; Thu, 4 May 2017 16:33:51 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 508451C68C0 for <rfc-interest@rfc-editor.org>; Thu, 4 May 2017 16:33:48 -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 hltEHVpKy1U4 for <rfc-interest@rfc-editor.org>; Thu, 4 May 2017 16:33:48 -0700 (PDT)
Received: from Heathers-MBP.jetpack (unknown [IPv6:2600:100f:b024:49d7:6829:dff0:b9b2:fe6c]) by c8a.amsl.com (Postfix) with ESMTPSA id DB5501C0015 for <rfc-interest@rfc-editor.org>; Thu, 4 May 2017 16:33:47 -0700 (PDT)
To: rfc-interest@rfc-editor.org
References: <148916689952.6827.6792653811413720687.idtracker@ietfa.amsl.com> <383fa41c-e289-8045-7c1f-fcdcd8cc8445@rfc-editor.org> <291ffdb4-36b0-691b-498e-9eaaa2f9a239@gmx.de>
From: "Heather Flanagan (RFC Series Editor)" <rse@rfc-editor.org>
Message-ID: <47e064ca-495e-9665-dfb2-8a6cc07a6b55@rfc-editor.org>
Date: Thu, 4 May 2017 16:33:58 -0700
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv:45.0) Gecko/20100101 Thunderbird/45.8.0
MIME-Version: 1.0
In-Reply-To: <291ffdb4-36b0-691b-498e-9eaaa2f9a239@gmx.de>
Subject: Re: [rfc-i] Errata Reference Format
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.22
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>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: rfc-interest-bounces@rfc-editor.org
Sender: "rfc-interest" <rfc-interest-bounces@rfc-editor.org>

On 3/11/17 5:55 AM, Julian Reschke wrote:
> <https://tools.ietf.org/html/draft-flanagan-7322bis-00#section-4.8.6.5>:
> 
>> 4.8.6.5.  Referencing Errata
>>
>>    The following format is required when a reference to an erratum
>>    report is necessary:
>>
>>    [ErrNumber]  RFC Errata, Erratum ID number, RFC number, <URI>.
>>
>>    [Err1912]  RFC Errata, Erratum ID 1912, RFC 2978, xxx.
> 
> In V3, we'd format that as:
> 
>> <reference anchor="Err1912" quoteTitle="false" target="xxx">
>>   <front>
>>     <title>Errata ID 1912</title>
>>     <author><organization>RFC Errata</organization></author>
>>   </front>
>>   <seriesInfo name="RFC" value="2978"/>
>> </reference>
> 
> Observations:
> 
> 1) That makes it look like this references actually RFC 2978, so the
> seriesInfo element is very misleading.
> 
> 2) No date is specified.
> 
> Proposal:
> 
> <reference anchor="Err1912" quoteTitle="false"
> target="https://www.rfc-editor.org/errata_search.php?eid=1912">
>   <front>
>     <title>RFC 2978 Erratum 1912</title>
>     <author><organization>RFC Errata</organization></author>
>   </front>
>   <seriesInfo name="RFC Errata" value="1912"/>
>   <date year="2009" month="October"/>
> </reference>
> 
> Giving:
> 
> [Err1912]  RFC Errata, RFC 2978 Erratum 1912, RFC Errata 1912, October
>            2009, <https://www.rfc-editor.or/errata_search.php?eid=1912>
> 
> a) This make seriesInfo actually meaningful.
> 
> b) The URI of course should be aligned with what the future format is;
> for instance <https://www.rfc-editor.org/errata/1912>.
> 
> c)
> <https://greenbytes.de/tech/webdav/rfc7991.html#element.reference.attribute.quoteTitle>
> allows us to have an unquoted title, but I'd like to question whether we
> *really* need a special case here.
> 
> Best regards, Julian
> 

Hello all,

The effort to make better, stable errata URLs is done. The format of the
URL is:

https://www.rfc-editor.org/errata/eid####

(e.g., https://www.rfc-editor.org/errata/eid4920)

Note that for the concatenated records (the "Full Records" in a search
on the RFC Editor website) those remain URL search strings.

I will be adjusting the Style Guide, and the RPC will manage the
references as needed for documents in our queue.

Please let me know if you have any questions!
Heather
_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest