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

Paul Kyzivat <pkyzivat@alum.mit.edu> Tue, 27 October 2020 15:22 UTC

Return-Path: <pkyzivat@alum.mit.edu>
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 342123A0E14 for <wgchairs@ietfa.amsl.com>; Tue, 27 Oct 2020 08:22:51 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.248
X-Spam-Level:
X-Spam-Status: No, score=-2.248 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, NICE_REPLY_A=-0.247, RCVD_IN_MSPIKE_H2=-0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=alum.mit.edu
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 tyhfOqzB4t3Y for <wgchairs@ietfa.amsl.com>; Tue, 27 Oct 2020 08:22:49 -0700 (PDT)
Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2064.outbound.protection.outlook.com [40.107.223.64]) (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 39B0F3A0E1A for <wgchairs@ietf.org>; Tue, 27 Oct 2020 08:22:48 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=KPn9tNyqpNXiDPVAwy64UFAQUw5X7WF6QNeRqFJwc5KkdqAQxvCHpZitT/HLwdBstTw8TJNET+N31ws/JY5YiC4BF7u/IrgoWYaxncOaK7nUzAKpcyTq95vTL2hFk+nqzXcnyeyALH8TOO67p9uIhwpb541T3ewnNJ0+SBNG7yHszYIpvwd4GS6HvZggCrIzFiMBeayZ5lcUyMrbqFQ8uelJdh2Wbd2Oya+Ps2+QE8C04hfuapL3bGx417kMw5bO8ZfrDSH2YACrHATfQKYi+lPDMPWGoMi5hv8NtXOU6f+nXLyhtOhG6xiKsoHaHAJD5wMNZ4ErD1sJd+5N28q55Q==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Ul8x+0qRzqRJgpAZs7MEYt5LZXFZEecPzSPeq9UComw=; b=kTWAziomRUBN2eMTviqovt+nxNGeP5+ENaMRomumsSArFGiW7wElydgRS+YmEgWDOgzTqL3VJjpeShVFSZPHNBWHybwGhqNQiZ2U4ijtcjBJWtFQ+Xe4liCcGHpXUDoaSXL+/D0mLXa+p6/KupR+iFpdP7O4dK4cfHY1UFoWitlqgH8fUrv81IoHJhed6l2poTemrUB9qWMvZeKTlEHaesWarBs5C3cfj/kNpNdOUIelLtMH4juaSEHgSpVAOQHntPIvtz7F3oyienWlJCej0wvjBM2fRNOZ3hUDdGA3kn//qG1NNKYyrLMleNLsUPIMayCJzRIYpLwO6qFEfpWtDQ==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 18.7.68.33) smtp.rcpttodomain=ietf.org smtp.mailfrom=alum.mit.edu; dmarc=bestguesspass action=none header.from=alum.mit.edu; dkim=none (message not signed); arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alum.mit.edu; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Ul8x+0qRzqRJgpAZs7MEYt5LZXFZEecPzSPeq9UComw=; b=BNMqYDlvW+qK2w+KOWlsrEXxuNbyDQSO+4ioPEbcce74sDFbNRyUE2W7/a9th1JJBzjw/2VS0K9IjPyJDgjQoSULIqirTS76QRuqO2yCER7eVk/ImEhAU+vLi23wMTXw4ASKNQdHZdiftnf7rNt2IQ2gRR/w9FTL8EetQts9FGk=
Received: from MN2PR16CA0028.namprd16.prod.outlook.com (2603:10b6:208:134::41) by BL0PR12MB4851.namprd12.prod.outlook.com (2603:10b6:208:1c1::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3477.28; Tue, 27 Oct 2020 15:22:47 +0000
Received: from BL2NAM02FT027.eop-nam02.prod.protection.outlook.com (2603:10b6:208:134:cafe::77) by MN2PR16CA0028.outlook.office365.com (2603:10b6:208:134::41) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3499.19 via Frontend Transport; Tue, 27 Oct 2020 15:22:47 +0000
X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 18.7.68.33) smtp.mailfrom=alum.mit.edu; ietf.org; dkim=none (message not signed) header.d=none;ietf.org; dmarc=bestguesspass action=none header.from=alum.mit.edu;
Received-SPF: Pass (protection.outlook.com: domain of alum.mit.edu designates 18.7.68.33 as permitted sender) receiver=protection.outlook.com; client-ip=18.7.68.33; helo=outgoing-alum.mit.edu;
Received: from outgoing-alum.mit.edu (18.7.68.33) by BL2NAM02FT027.mail.protection.outlook.com (10.152.77.160) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3499.20 via Frontend Transport; Tue, 27 Oct 2020 15:22:47 +0000
Received: from PaulKyzivatsMBP.localdomain (c-24-62-227-142.hsd1.ma.comcast.net [24.62.227.142]) (authenticated bits=0) (User authenticated as pkyzivat@ALUM.MIT.EDU) by outgoing-alum.mit.edu (8.14.7/8.12.4) with ESMTP id 09RFMkZl031292 (version=TLSv1/SSLv3 cipher=AES128-GCM-SHA256 bits=128 verify=NOT) for <wgchairs@ietf.org>; Tue, 27 Oct 2020 11:22:46 -0400
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> <baa56cf3-bf4b-fbb7-321c-80d3af92373f@ntlworld.com>
From: Paul Kyzivat <pkyzivat@alum.mit.edu>
Message-ID: <9ab56d82-854a-9b33-a3e9-acd537bc1e70@alum.mit.edu>
Date: Tue, 27 Oct 2020 11:22:46 -0400
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:78.0) Gecko/20100101 Thunderbird/78.4.0
MIME-Version: 1.0
In-Reply-To: <baa56cf3-bf4b-fbb7-321c-80d3af92373f@ntlworld.com>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: 8bit
X-EOPAttributedMessage: 0
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-Correlation-Id: d8963c87-7cec-42a1-8366-08d87a8c291b
X-MS-TrafficTypeDiagnostic: BL0PR12MB4851:
X-Microsoft-Antispam-PRVS: <BL0PR12MB4851EFE9993B7330CBE8498AF9160@BL0PR12MB4851.namprd12.prod.outlook.com>
X-MS-Oob-TLC-OOBClassifiers: OLM:8273;
X-MS-Exchange-SenderADCheck: 1
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: thpLSuKCw/pu5wRiK2GNvHPSY57DFKfN3pNhUZ/p1l3DWQZmjUR/15u/zUS2Jv0xdJ1xypdATI7sKG3vekcSWF1dttWG3+sJTDnzJ8gZfaftepm4aPj2GS/kQHjnMlInMbbE8DT5vGVC/8iH4jFbYQlTQi7xTbc6aEdt6KfmYIeO1rTw/JgJyPHY78+Zi5JiauI9Z8oghplR+nmhw8JZlfzAAUAEa0iXHRfFQrR5KjEdD8alHZk1w0h/Rayr+YmDJ38szk8CR6HOA3Uw4WD3WygXMEV4mlu5FCVbeS4InrQ2adaraMgY58LLGkJuPpv3n7RSYmZTXml1GNTS6DW6P3dP//aJgUryi6lV+JRImGewuxMUef6yw/Yi+cz8lE8oUADxbKShullZI80qL6cuOv4On3YunYL5glpWP3s+VKM=
X-Forefront-Antispam-Report: CIP:18.7.68.33; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:outgoing-alum.mit.edu; PTR:outgoing-alum.mit.edu; CAT:NONE; SFS:(136003)(396003)(346002)(39860400002)(376002)(46966005)(336012)(6916009)(7596003)(31686004)(316002)(70586007)(478600001)(8936002)(2906002)(86362001)(70206006)(786003)(36906005)(47076004)(82740400003)(356005)(5660300002)(186003)(2616005)(8676002)(26005)(53546011)(83380400001)(956004)(82310400003)(31696002)(75432002)(43740500002); DIR:OUT; SFP:1101;
X-OriginatorOrg: alum.mit.edu
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 Oct 2020 15:22:47.5764 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: d8963c87-7cec-42a1-8366-08d87a8c291b
X-MS-Exchange-CrossTenant-Id: 3326b102-c043-408b-a990-b89e477d582f
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3326b102-c043-408b-a990-b89e477d582f; Ip=[18.7.68.33]; Helo=[outgoing-alum.mit.edu]
X-MS-Exchange-CrossTenant-AuthSource: BL2NAM02FT027.eop-nam02.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL0PR12MB4851
Archived-At: <https://mailarchive.ietf.org/arch/msg/wgchairs/NqO9lpv-behRAW3fXcffEXUwz20>
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 15:22:51 -0000

On 10/27/20 7:33 AM, Keith Drage wrote:
> 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.

+1

Sections that contain subsections are commonly long. And not only can 
x.y.z contain text prior to x.y.z.1, it can also contain text after 
subsections that is not part of a subsection.

Perhaps the solution is paragraph numbers. But I don't know how you 
would include them in the txt format.

	Thanks,
	Paul

> 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
>>
>