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

Robert Sparks <rjsparks@nostrum.com> Tue, 30 August 2022 13:58 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 3B995C1594A0 for <tools-discuss@ietfa.amsl.com>; Tue, 30 Aug 2022 06:58:07 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.088
X-Spam-Level:
X-Spam-Status: No, score=-2.088 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, 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 eWK7AQoE2mAO for <tools-discuss@ietfa.amsl.com>; Tue, 30 Aug 2022 06:58:03 -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 89777C1526F0 for <tools-discuss@ietf.org>; Tue, 30 Aug 2022 06:58:03 -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 27UDw15n074878 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO); Tue, 30 Aug 2022 08:58:01 -0500 (CDT) (envelope-from rjsparks@nostrum.com)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=nostrum.com; s=default; t=1661867882; bh=M9gq5o5k33aEOCBlhe3wD4xtB4ozeni1qiHeblCmIqk=; h=Date:Subject:To:References:From:In-Reply-To; b=sNgsDt9kk5XhSY7IM8LLa4i3BkIK5AMygYStDmlDN/hs2ZC9Gb8SLIUowIwp44ICr +8vsSoyuXZMAGTgVH4iznIcGB1UI9w9fGz79xPx/ER+ksZY8Fturiky5t6jDIQ7Wl7 Wbqqm048c+MmdZIqhDCC+n8gN10no4Z7HJRrwVDY=
X-Authentication-Warning: raven.nostrum.com: Host [47.186.48.51] claimed to be [192.168.1.102]
Message-ID: <3d3a0620-7e87-ac7f-39af-103be25d33de@nostrum.com>
Date: Tue, 30 Aug 2022 08:57:55 -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> <71b8057b-f21f-e567-1c8b-3a5d485b30c7@nostrum.com> <93c1d678-6037-e459-d32f-13a88dccb1ce@fastmail.com>
From: Robert Sparks <rjsparks@nostrum.com>
In-Reply-To: <93c1d678-6037-e459-d32f-13a88dccb1ce@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/29gcExZEOudl4hyE9aDzCRvpqcw>
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: Tue, 30 Aug 2022 13:58:07 -0000

On 8/30/22 8:54 AM, Jaime Jiménez wrote:
> Thank you all for the interesting discussion!
>
> I was unaware of the previous discussions and I did not participate in 
> them, sorry for that.
> @Robert, producing a whole new RFC on RSWG for this purpose sounds a 
> bit overkill for me.
> I think I probably won't be able to fix it but, where is the link to 
> the HTMLizer code? I could have a look.

https://github.com/ietf-tools/rfc2html

Though, again, I encourage you to look at what Lars is working on at 
https://github.com/ietf-tools/datatracker/pull/4082.

(We will likely be standing up another test instance soon for people to 
try this out without having to run it themselves).

>
> Ciao!
>
> Jaime
>
> On 22.8.2022 16.44, Robert Sparks wrote:
>>
>> 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!
>>>