Re: [rfc-i] Poll: RFCs with page numbers (pretty please) ?

Keith Drage <drageke@ntlworld.com> Tue, 27 October 2020 11:34 UTC

Return-Path: <drageke@ntlworld.com>
X-Original-To: wgchairs@ietfa.amsl.com
Delivered-To: wgchairs@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 2B6983A005C for <wgchairs@ietfa.amsl.com>; Tue, 27 Oct 2020 04:34:01 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.347
X-Spam-Level:
X-Spam-Status: No, score=-2.347 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.247, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=ntlworld.com
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 2Rfwz4h8MzNX for <wgchairs@ietfa.amsl.com>; Tue, 27 Oct 2020 04:33:59 -0700 (PDT)
Received: from know-smtprelay-omc-2.server.virginmedia.net (know-smtprelay-omc-2.server.virginmedia.net [80.0.253.66]) (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 BA66D3A0045 for <wgchairs@ietf.org>; Tue, 27 Oct 2020 04:33:58 -0700 (PDT)
Received: from [192.168.0.17] ([81.97.229.170]) by cmsmtp with ESMTPA id XNEdkcwtqxz85XNEik3yMy; Tue, 27 Oct 2020 11:33:57 +0000
X-Originating-IP: [81.97.229.170]
X-Authenticated-User: drageke@ntlworld.com
X-Spam: 0
X-Authority: v=2.3 cv=H7n1PdQi c=1 sm=1 tr=0 a=uMkRna9mZ6QJhuoPpEZIww==:117 a=uMkRna9mZ6QJhuoPpEZIww==:17 a=IkcTkHD0fZMA:10 a=t8Wa6oZcAAAA:8 a=u_4VB4cHgBhrEsMQh_IA:9 a=OHuT7h3Smwoanf51:21 a=eblpB_eCafzvrleZ:21 a=QEXdDO2ut3YA:10 a=WUep13IHXZawN-cPAiCJ:22
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ntlworld.com; s=meg.feb2017; t=1603798437; bh=X3PXFbAjN1z+8kDa19MNdruuI7uCmPd+5wBEjcVvHCk=; h=Subject:To:References:From:Date:In-Reply-To; b=1Vg1cekXDrai4t/+mMKuolYa9daSNo4wqZTbeT/2Be9zRtfpb7umLcKEQaOI6qb+x pkEKCtbw+GHxm45huIrtv4mx29yYwWV/dFWvpQ7lQcIIvYgIJ+mfUZtacJx68+iku7 U9f9VDFqwVzM2+4HiPpfmtym9WnAovSsoAQE+Jx1GsjG8qpZxU9CyaJOMrf4TmNA7b oOzP8TKYNzpTE6eDwgm14njJvi3vJyqaMgOlK+pZbFe9UR5B5m6wLyJwRvCILqFHSl mMo+bxjJ6LTi9sUevRtxtIKkxuEA5v+Q0/4r0EIrJsLEHahaxa3xmYspR3Lbh1+/5N FuO0ACgrIjMhQ==
Subject: Re: [rfc-i] Poll: RFCs with page numbers (pretty please) ?
To: wgchairs@ietf.org
References: <20201026020433.GA19475@faui48f.informatik.uni-erlangen.de> <CADaq8je8gMwAkOndTNJ9ndwzOZb2HQMZrCUJ5wNUjw-6ax9QtA@mail.gmail.c om> <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> <03976f9f-7f49-7bf7-ce29-ee989232a44d@gmail.com> <7FA8EF59-5CDE-42B9-A487-520531EEA1F0@juniper.net> <65374aef-e018-7bc8-ce50-d5c0a3982bf7@gmail.com> <DE3C9D6AE8EF94D87936DAE7@PSB> <75918E93-96A2-4C9A-9D60-570E7A0E1B22@ribose.com> <C393B7270B2043C75B6CA7B8@PSB> <EB282B9A-8562-43B5-AC65-31FD2CF64C5D@ribose.com> <3F09EF2A87B102C8666C72D0@PSB>
From: Keith Drage <drageke@ntlworld.com>
Message-ID: <baa56cf3-bf4b-fbb7-321c-80d3af92373f@ntlworld.com>
Date: Tue, 27 Oct 2020 11:33:50 +0000
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.4.0
MIME-Version: 1.0
In-Reply-To: <3F09EF2A87B102C8666C72D0@PSB>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Transfer-Encoding: 8bit
Content-Language: en-GB
X-CMAE-Envelope: MS4wfFmkM1j2TkiV1dHj4WjQt1P4PPjgw7vTXQ/uROt9YVnKd2ymMqF4vHCIfEGN5YNTBVfnYHwUInee/zQeJ82QxlAu3wYPJjON7F9/TPg99kgPSOWe89H6 tcB5mn4oM48FVYpzDkr4FKisq3cqtlI+phNAwhYcuxx1y7ZqZfEG5q4q
Archived-At: <https://mailarchive.ietf.org/arch/msg/wgchairs/FSHFlZQ8qxzucTNUgJ3ugyQGH_4>
X-BeenThere: wgchairs@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Working Group Chairs <wgchairs.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/wgchairs/>
List-Post: <mailto:wgchairs@ietf.org>
List-Help: <mailto:wgchairs-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 27 Oct 2020 11:34:01 -0000

I do agree that referencing by section numbering is the appropriate method.

However, as you say, it gets difficult with overly long sections, and 
this is something on which no guidance or checking is currently given. 
Perhaps it should be?

Further there are difficulties with section references if you allow text 
between x.y.z and x.y.z.1. Does a reference to x.y.z mean the entirety 
of the text including x.y.z.1, or merely the text before x.y.z. Other 
organisations restrict such usage in order to make section references 
unambiguous.

I also note people are referring to the XML version as the definitive 
version, but surely the section numbers do not appear until the 
presentation version is created?

Keith

On 27/10/2020 01:53, John C Klensin wrote:
>
> --On Tuesday, October 27, 2020 01:30 +0000 Ronald Tse
> <tse@ribose.com> wrote:
>
>> Thanks John for the clarification. There is some confusion to
>> me whether the intention is just about the TXT output having
>> page numbers, or for the PDF to also have the same page
>> numbers, and whether to use page numbers inside cross
>> references. There was a also discussion about a ToC and page
>> numbers, but perhaps that was a diversion.
>>
>> If the discussion is only about the ASCII output having page
>> numbers, I have no objection because it is (nearly) purely
>> cosmetic (in publication and in usage of the text, being done
>> by xml2rfc).
>>
>> If having page numbers will require the PDF output to also
>> have page numbers, this inevitably leads to some shared spec
>> between the TXT and PDF outputs on the topic of pagination,
>> which is less ideal, but since I assume that is the work of
>> xml2rfc, it's not a concern to us as tool maintainers.
> Actually, I think you have it a bit backward.  The PDF has page
> numbers today.  More to the point, PDF is (almost) inherently a
> page image format so there is no way to escape pagination.  One
> could decide to not number those pages in the footers, or one
> could eliminate the headers and footers entirely, but the page
> boundaries are going to be there regardless.
>
> However, as long as a strict discipline is maintained that
> references (within an RFC, between RFCs, and whatever we can
> do/encourage about external references to RFCs use are to
> section numbers and not pages (and there Brian and I agree)
> _and_ as long as we don't allow sections to become so long that
> people seek other mechanisms, then whether the page numbers in a
> text format agree with those in the PDF format or not is largely
> irrelevant.  That issue is centuries old: if I reference a
> chapter by number in a book, that reference is typically stable
> for different printings and formats (and often but not always
> between editions).  But the page numbers often are not, so,
> unless the people doing the layout are _really_ careful, using
> the index from, e.g., a hardbound copy and trying to apply its
> numbers to a paperback that uses different size type and page
> layouts is, to use a technical term, just plain dumb.  And
> external references that use page numbers need to be very
> careful to specify exactly what form is being referred to.
>
>> Adding page numbers to cross references can make reading
>> confusing — since the cross references between the paginated
>> and flowed versions will render these references differently.
>> It's doable, but again this requirement ties the paginated
>> versions (TXT and PDF) together for consistency.
> And, again, this is why there has been a long-term prohibition
> in the RFC Series against using page numbers in cross references.
>
>> Of course, if the PDF output is simply an enhanced PDF-ized
>> TXT version, these aren't really issues.
> But two of several advantages of the contemporary (xml2rfc v3)
> PDF version is that it can contain and render pictures easily
> and that, if characters are used outside the ASCII repertoire,
> they are rendered correctly as well.
>
> best,
>      john
>