Re: [rfc-i] RFC9115 errata html rendering

Alice Russo <arusso@amsl.com> Mon, 26 February 2024 20:22 UTC

Return-Path: <arusso@amsl.com>
X-Original-To: rfc-interest@ietfa.amsl.com
Delivered-To: rfc-interest@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D1CA3C151996 for <rfc-interest@ietfa.amsl.com>; Mon, 26 Feb 2024 12:22:53 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.906
X-Spam-Level:
X-Spam-Status: No, score=-1.906 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 9zqS6WgE3jX7 for <rfc-interest@ietfa.amsl.com>; Mon, 26 Feb 2024 12:22:50 -0800 (PST)
Received: from c8a.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1061FC151981 for <rfc-interest@rfc-editor.org>; Mon, 26 Feb 2024 12:22:50 -0800 (PST)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 04136424CD01 for <rfc-interest@rfc-editor.org>; Mon, 26 Feb 2024 12:22:50 -0800 (PST)
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 Yaxno9Evq-sI for <rfc-interest@rfc-editor.org>; Mon, 26 Feb 2024 12:22:49 -0800 (PST)
Received: from smtpclient.apple (c-76-146-133-47.hsd1.wa.comcast.net [76.146.133.47]) by c8a.amsl.com (Postfix) with ESMTPSA id D608C424B426 for <rfc-interest@rfc-editor.org>; Mon, 26 Feb 2024 12:22:49 -0800 (PST)
From: Alice Russo <arusso@amsl.com>
Content-Type: multipart/alternative; boundary="Apple-Mail=_AAFD743E-BF18-4874-BAB4-084BBA174BA6"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.120.41.1.1\))
Date: Mon, 26 Feb 2024 12:22:48 -0800
References: <13117.1708638712@obiwan.sandelman.ca> <47db462f-478b-4237-b045-e6b5579b7061@nostrum.com>
To: rfc-interest@rfc-editor.org
In-Reply-To: <47db462f-478b-4237-b045-e6b5579b7061@nostrum.com>
Message-Id: <39EF5AD5-0A7F-41F9-A30A-19CC2DBD6AD3@amsl.com>
X-Mailer: Apple Mail (2.3696.120.41.1.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-interest/FjX285OuPO4qsYZgtWMOsweuiyI>
Subject: Re: [rfc-i] RFC9115 errata html rendering
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://mailman.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://mailman.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
X-List-Received-Date: Mon, 26 Feb 2024 20:22:53 -0000

On Feb 22, 2024, at 2:30 PM, Robert Sparks <rjsparks@nostrum.com> wrote:
> 
> On 2/22/24 3:51 PM, Michael Richardson wrote:
>> I arrived to read RFC9115 after following the reference newly published 9535.
>> At https://www.rfc-editor.org/info/rfc9115 I see the option to read the HTML
>> with errata applied at:
>> https://www.rfc-editor.org/rfc/inline-errata/rfc9115.html
>> 
>> But, it's not really the HTML version.  There are no internal links, no
>> right-hand table of contents, etc.  It's a poorly HTML-ized txt output.
>> 
>> I'm wondering what's going on here.  I don't mind if the errata version is
>> the text version, but it seems to be advertised as the HTML version.
> 
> It is using features of html to render the applied and annotated diff to the text version - it is closer to htmlized than the 799* html.
> 
> The inline-errata tool is something that Adam Roach originally put together as a proof-of-concept. It's been useful to continue to use it in the limited scope that it can be used, but it is not attempting to make "patched' versions of all the output formats.

To add more info, Jim Schaad created rfc-errata <https://github.com/ietf-tools/rfc-errata> after Adam prototyped it.  rfc-errata is used by the RPC to generate the files listed as "HTML with inline errata" on the info page. For a given RFC, the file exists only if verified errata exist.
The current input is a text file. As far as potential updates -- 
- for lower than RFC 8650, it would be nice if the input were the HTML output of rfc2html.
- for RFC 8650 and beyond, it would be nice if the input were the HTML output of xml2rfc.

Alice Russo
RFC Production Center