Re: Poll: RFCs with page numbers (pretty please) ?

Benjamin Kaduk <kaduk@mit.edu> Tue, 27 October 2020 19:26 UTC

Return-Path: <kaduk@mit.edu>
X-Original-To: ietf@ietfa.amsl.com
Delivered-To: ietf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D4F9D3A1538 for <ietf@ietfa.amsl.com>; Tue, 27 Oct 2020 12:26:59 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.898
X-Spam-Level:
X-Spam-Status: No, score=-1.898 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
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 k5t0FGO5GkYw for <ietf@ietfa.amsl.com>; Tue, 27 Oct 2020 12:26:58 -0700 (PDT)
Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 52DED3A1532 for <ietf@ietf.org>; Tue, 27 Oct 2020 12:26:58 -0700 (PDT)
Received: from kduck.mit.edu ([24.16.140.251]) (authenticated bits=56) (User authenticated as kaduk@ATHENA.MIT.EDU) by outgoing.mit.edu (8.14.7/8.12.4) with ESMTP id 09RJQpTW025812 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 27 Oct 2020 15:26:55 -0400
Date: Tue, 27 Oct 2020 12:26:50 -0700
From: Benjamin Kaduk <kaduk@mit.edu>
To: Keith Moore <moore@network-heretics.com>
Cc: ietf@ietf.org
Subject: Re: Poll: RFCs with page numbers (pretty please) ?
Message-ID: <20201027192650.GR39170@kduck.mit.edu>
References: <CADaq8je8gMwAkOndTNJ9ndwzOZb2HQMZrCUJ5wNUjw-6ax9QtA@mail.gmail.com> <35EFE952-7786-4E24-B228-9BEE51D3C876@tzi.org> <20201026150241.GK48111@faui48f.informatik.uni-erlangen.de> <20201026162814.GP39170@kduck.mit.edu> <20201026164036.GO48111@faui48f.informatik.uni-erlangen.de> <1a56dc3b-56ef-3ffb-a12b-44d5e0d0f835@levkowetz.com> <20201026171931.GP48111@faui48f.informatik.uni-erlangen.de> <b733240-fc78-5a71-8920-ff84fbf64287@iecc.com> <20201026180105.GQ48111@faui48f.informatik.uni-erlangen.de> <a11ca0a2-94a0-921c-4c4d-0ffc951935b9@network-heretics.com>
MIME-Version: 1.0
Content-Type: text/plain; charset="iso-8859-1"
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <a11ca0a2-94a0-921c-4c4d-0ffc951935b9@network-heretics.com>
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf/Mb2HlB3H6JruBxE3CqtAgZUmbxE>
X-BeenThere: ietf@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF-Discussion <ietf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf>, <mailto:ietf-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ietf/>
List-Post: <mailto:ietf@ietf.org>
List-Help: <mailto:ietf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf>, <mailto:ietf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 27 Oct 2020 19:27:00 -0000

On Tue, Oct 27, 2020 at 01:43:42PM -0400, Keith Moore wrote:
> References to RFC text should be in terms of section numbers rather than 
> page numbers.   However, that the current RFC page formatting (for PDF 
> RFCs) isn't well designed for reading on paper, because page footers 
> don't include section numbers.   Without such footers, it's harder to 
> flip pages looking for the desired section.    So I would welcome 
> changes to the RFC footers of paginated RFCs to include section numbers.

That is an interesting idea!  I want to say that I would find it useful,
but I am actually having a hard time imaginging what it would feel like to
have them present -- I might need to see it in action to know how I would
react.

> Section numbers aren't sufficient, however, if one needs to reorder 
> pages from a printed RFC, because a section may span multiple pages.  So 
> there is still a need for page numbers in paginated RFCs.

The act of pagination induces numberings, and not recording those numbers
in-band seems risky, yes.

> Also, not all sections in recent RFCs are numbered, and this is a 
> problem if one wishes to reference an unnumbered section.   I suspect 
> the fix here is to explicitly number/label every section, even 
> Acknowledgments, appendices, etc.
> 
> One problem with having page numbers is that different paginated 
> renderings of the same RFC will likely result in different pagination.   
> But if there's only one paginated rendering of any RFC, as seems to be 
> the case for newer RFCs at least, this is not a problem.
> 
> The currently official "plain text" RFCs are not paginated, but the PDF 

I do want to check in what sense you use the term "official", here -- my
understanding is that the party line is that the XML source is the
authoritative version and that the rendered versions can be regenerated
arbitrarily if there is new tooling deemed to produce "better" output.
(IIRC this was even supposed to happen or did happen for the PDF output,
which due to an error was not actually using the PDF/A stuff that it was
supposed to.) So there can be an "official" plain text version in that it
is on the RFC Editor's website, but it is not authoritative or immutable.

Thanks,

Ben

> versions are paginated with page numbers.     This seems like a good 
> compromise (even if it breaks some old scripts), because Windows systems 
> have historically been too broken to properly print paginated plain text 
> with formfeeds anyway, and because one of the uses of plain text RFCs 
> has always been for automated free-text searching in which page breaks 
> are a nuisance.
> 
> I would like it if HTML versions of RFCs were paginated when printed 
> (with footers containing section numbers and page numbers, and with 
> those page breaks and numbers aligned with other paginated versions of 
> the same RFC.)    But I recognize that this would require significant 
> tooling effort, and could occasionally produce very unsatisfactory 
> results despite that effort.   It seems like the PDF version is 
> sufficient for printing purposes, though it is not as easily found from 
> the HTML version as it might be.   Adding a link to the PDF version at 
> the top of the HTML version would IMO be a good idea.
> 
> Keith
> 
>