Re: [Tools-discuss] RFCs TOC render in plaintext

Robert Sparks <rjsparks@nostrum.com> Mon, 22 August 2022 13:45 UTC

Return-Path: <rjsparks@nostrum.com>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id CFD56C1522D4 for <tools-discuss@ietfa.amsl.com>; Mon, 22 Aug 2022 06:45:10 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.087
X-Spam-Level:
X-Spam-Status: No, score=-2.087 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, T_SCC_BODY_TEXT_LINE=-0.01, T_SPF_HELO_PERMERROR=0.01, T_SPF_PERMERROR=0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nostrum.com
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 vJyPsm5xgi7L for <tools-discuss@ietfa.amsl.com>; Mon, 22 Aug 2022 06:45:06 -0700 (PDT)
Received: from nostrum.com (raven-v6.nostrum.com [IPv6:2001:470:d:1130::1]) (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 C99A8C14CE47 for <tools-discuss@ietf.org>; Mon, 22 Aug 2022 06:45:06 -0700 (PDT)
Received: from [192.168.1.102] ([47.186.48.51]) (authenticated bits=0) by nostrum.com (8.17.1/8.17.1) with ESMTPSA id 27MDj3u5071753 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO); Mon, 22 Aug 2022 08:45:03 -0500 (CDT) (envelope-from rjsparks@nostrum.com)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=nostrum.com; s=default; t=1661175904; bh=MOGS5dt+wtZlzMFjiKE+DNMI0jWNVXCk8NGhq+vP+Xs=; h=Date:To:References:From:Subject:In-Reply-To; b=CZJbSF1shwrR8uNVABFwsctoXHadI0ZSlVAQ66Yc/q5NL8yH86Cc1E4YtDSpgr/9z h2HngqEmoczp44cqVc07+svkaiuOtoQYowyX9s34aGy2/0E2FstyuPalbDTaUVhBnt 0kmHyQFC3xExHQ19ooweeWItx4MDWeb3d3RN/AlM=
X-Authentication-Warning: raven.nostrum.com: Host [47.186.48.51] claimed to be [192.168.1.102]
Message-ID: <71b8057b-f21f-e567-1c8b-3a5d485b30c7@nostrum.com>
Date: Mon, 22 Aug 2022 08:44:58 -0500
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0) Gecko/20100101 Thunderbird/91.12.0
Content-Language: en-US
To: Jaime Jiménez <jaime@iki.fi>, tools-discuss@ietf.org
References: <2cdd411b-11cc-4d4e-d87c-938641820749@fastmail.com> <5F5EFDC0-D0FA-4639-B30A-7E97BF4A5042@tzi.org> <d649f8d7-b305-d5d0-6bf9-04f87faf403e@fastmail.com>
From: Robert Sparks <rjsparks@nostrum.com>
In-Reply-To: <d649f8d7-b305-d5d0-6bf9-04f87faf403e@fastmail.com>
Content-Type: text/plain; charset="UTF-8"; format="flowed"
Content-Transfer-Encoding: 8bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/IL2httCOMQTxuhMmP3zJsjhnqxk>
Subject: Re: [Tools-discuss] RFCs TOC render in plaintext
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 22 Aug 2022 13:45:10 -0000

On 8/22/22 8:07 AM, Jaime Jiménez wrote:
> Dear all,
>
> this topic has been discussed before, but I'd like to raise it once 
> again.
>
> The current default datatracker RFC template has a bug for many of our 
> RFCs.
> Draft versions of the same documents render the table of contents in 
> html but only plaintext in the RFC.
> The problem applies to ALL RFCs after RFC 8650 in CoRE WG. For example:
>
> RD RFC with plaintext TOC:https://datatracker.ietf.org/doc/html/rfc9176
> RD draft with HTML 
> TOC:https://datatracker.ietf.org/doc/html/draft-ietf-core-resource-directory-28
>
> I have been told that the plaintext format for RFCs has changed and 
> they are no longer paginated (why??)

That is the root of all that you are asking about and the why is in RFC7994.

The _why_ is that it was what was published as a set of RFCs that went 
through community wide last calls. The team that defined the output 
formats had a contingent that believed very strongly that the text 
should not be paginated, and that made it through as rough consensus at 
the time. (Fwiw, I was in the rough). Heather and the IAB called this 
change out _many_ times, on many lists before the docs were published, 
and in Plenary sessions, yet here we are with people who were present 
while it was happening (a very long time ago) still being surprised.

Drafts do not look this way because the IESG did not agree to change the 
requirements for the format of text Internet-Drafts at the time.

Your recourse now, should you really want to change the base definition 
of the text output format for RFCs is to try to get consensus to do so 
in the RSWG and publish a document that obsoletes RFC7994.

Lars is experimenting with a replacement for the htmlization of text 
with a rendering of the html that looks like the text htmlization. It 
would be worth looking to see if the ToC for that is any more useful to you.

RjS

> and therefore there are no page numbers in the TOC.
>
> I see this as a bug, as many users still prefer the "htmlized" version 
> over the new html RFC format and makes it pretty much unusable without 
> pagination.
> Could this please be fixed to how it was before the update?
>
>
> Ciao!
>