Re: [rfc-i] Errata Reference Format

Martin Thomson <martin.thomson@gmail.com> Mon, 25 September 2017 01:32 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 CD059133020 for <ietfarch-rfc-interest-archive@ietfa.amsl.com>; Sun, 24 Sep 2017 18:32:10 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -3.889
X-Spam-Level:
X-Spam-Status: No, score=-3.889 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_ADSP_CUSTOM_MED=0.001, DKIM_SIGNED=0.1, FREEMAIL_FORGED_FROMDOMAIN=0.199, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.001, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001, T_DKIM_INVALID=0.01] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=fail (2048-bit key) reason="fail (body has been altered)" header.d=gmail.com
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 eozgnvta-d8j for <ietfarch-rfc-interest-archive@ietfa.amsl.com>; Sun, 24 Sep 2017 18:32:09 -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 131A2132F7C for <rfc-interest-archive-eekabaiReiB1@ietf.org>; Sun, 24 Sep 2017 18:32:09 -0700 (PDT)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id 7E57CB813A6; Sun, 24 Sep 2017 18:31:44 -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 24DD3B813A6; Sun, 24 Sep 2017 18:31:43 -0700 (PDT)
X-Virus-Scanned: amavisd-new at rfc-editor.org
Authentication-Results: rfcpa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
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 99edfw0SzXR6; Sun, 24 Sep 2017 18:31:41 -0700 (PDT)
Received: from mail-oi0-x231.google.com (mail-oi0-x231.google.com [IPv6:2607:f8b0:4003:c06::231]) by rfc-editor.org (Postfix) with ESMTPS id EB289B813A5; Sun, 24 Sep 2017 18:31:40 -0700 (PDT)
Received: by mail-oi0-x231.google.com with SMTP id u130so4486819oib.11; Sun, 24 Sep 2017 18:32:05 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=esrdO64ND1b+MT0Y991qJqiSIyllwHSWiM3sVDwMfD0=; b=MhMk2F2z9OKQ2JntCNuFp4oaPuwcNADYCMB9lu3AMbzI3lV0uvdz+BtkRoODV7Dw3+ vcb3+3ekL4Jde32VGEmY9QTj53fkAFkPBbIkog1Ys00sdQJjPwqbjS0ijPQVHxTp8tcH 2/CuLolF/OGxHbqlSA4eoFjGmEVAUy+Ztlk2lAt5DqA6bZ+DZh6rlEcCobkAFid/kh8c U9EItk6Msp68W/u/QtOBhpRtOI84Rnz8tM7I0G8okDCJs0FFqZ7WNCLasKkqgYaNTbXD YaiMLqbeAxTPlzdIEZDAywo3Wd4RMQLnprRKrVzXGMaG+yLCYG2gzzLY4c7HIwQaq7Ra ms6A==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=esrdO64ND1b+MT0Y991qJqiSIyllwHSWiM3sVDwMfD0=; b=BDvLjnjh7TYBofTqEdyDurUz/f2ZlXpn4G6t8kMGoJGttuKRrBAPf9qXEy7I2ijr8f qSI3nCwoHbDixu3WU83su6VCMzK3T+lW892kt/mFZGyWCALb4Ifx1G0QqBJaUmujbHaB NNhk3zZn4EDglkjuVeKHPz6xOuzOK2gQ5c+KUQx1eYPrtkF52K1kMl24Yf6HottxRoLE S/KA8Hd4dX6GjBDelHluznqjsN2vTEl1Ae4/fy6g8V2aI4iTQzQbxvgdNxMfBKy/+s1O uVx9AmwX84hb6kXFw19GnvTPNKM/xBS1CozLnu026VWQ0w0cnBcTyqvws7tNHTMn1h+R W7OA==
X-Gm-Message-State: AHPjjUgfHs2/jkOcPYr3RvR4RyNktTX8KSYlTlxNauUT/DWYiZOshdYQ hMf+GKPqMEBd1oElmu725EIZbIqAZF3RNwln1nLnHsnq
X-Google-Smtp-Source: AOwi7QDdHvoM0SD0G2sJS3gHTp/tJNwG+x235rUy7gMX7jZ7hV8Dj8dKz3fn9Z7hazzkckQx95tFNWI2vgTCqqPguUM=
X-Received: by 10.202.178.133 with SMTP id b127mr7366450oif.319.1506303124174; Sun, 24 Sep 2017 18:32:04 -0700 (PDT)
MIME-Version: 1.0
Received: by 10.157.0.38 with HTTP; Sun, 24 Sep 2017 18:32:03 -0700 (PDT)
In-Reply-To: <47e064ca-495e-9665-dfb2-8a6cc07a6b55@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> <47e064ca-495e-9665-dfb2-8a6cc07a6b55@rfc-editor.org>
From: Martin Thomson <martin.thomson@gmail.com>
Date: Mon, 25 Sep 2017 11:32:03 +1000
Message-ID: <CABkgnnWk1mHk1omwKzD6KoVRJjoOoV6tAULkVnmbtLPz=QvJyQ@mail.gmail.com>
To: "Heather Flanagan (RFC Series Editor)" <rse@rfc-editor.org>
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>
Cc: RFC Interest <rfc-interest@rfc-editor.org>
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>

Hi Heather:

There is no way to go from a search:
  e.g., https://www.rfc-editor.org/errata_search.php?rfc=7919

To a specific erratum:
  e.g., https://www.rfc-editor.org/errata/eid4908

Could I request that the erratum ID be turned into a link?

The format I get is a little odd:

small: Found 1 record.
huge: Status: Reported (1)
large: RFC 7919, "Negotiated Finite Field Diffie-Hellman Ephemeral
Parameters for Transport Layer Security (TLS)", August 2016
small: Source of RFC: tls (sec)
small: Errata ID: 4908
medium: Status: Reported
medium: Type: Technical
small: Reported By: Martin Thomson
small: Date Reported: 2017-01-16

I don't know why "Status: Reported (1)" appears so prominently.  It
could be removed.  And the metadata is inconsistently formatted.  I'd
suggest:

small: Found 1 record.
large:Errata ID: 4908 <- link
medium: RFC 7919, "Negotiated Finite Field Diffie-Hellman Ephemeral
Parameters for Transport Layer Security (TLS)", August 2016
small: Source of RFC: tls (sec) <- keep the existing links
small: Status: Reported <- bold
small: Type: Technical <- bold
small: Reported By: Martin Thomson
small: Date Reported: 2017-01-16

At the same time, I'd request that you change the stylesheet to
include pre { overflow-x: auto;  } rather than pre { overflow: scroll;
overflow-y: hidden; }


On Fri, May 5, 2017 at 9:33 AM, Heather Flanagan (RFC Series Editor)
<rse@rfc-editor.org> wrote:
> 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
_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest