[rfc-i] Errata Reference Format

Julian Reschke julian.reschke at gmx.de
Sat Mar 11 05:55:16 PST 2017


<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





More information about the rfc-interest mailing list