IETF Logo Mail Archive

Re: [xml2rfc-dev] [Ext] xml2rfc: use of <boilerplate> in preptool step

Paul Hoffman <paul.hoffman@icann.org> Wed, 09 October 2019 16:47 UTC

Return-Path: <paul.hoffman@icann.org>
X-Original-To: xml2rfc-dev@ietfa.amsl.com
Delivered-To: xml2rfc-dev@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 8C04B12089C for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 09:47:56 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, 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 5Z04r6qriXV0 for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 09:47:55 -0700 (PDT)
Received: from ppa5.dc.icann.org (ppa5.dc.icann.org [192.0.46.78]) (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 C87BF120895 for <xml2rfc-dev@ietf.org>; Wed, 9 Oct 2019 09:47:54 -0700 (PDT)
Received: from PFE112-CA-1.pexch112.icann.org (out.west.pexch112.icann.org [64.78.40.7]) by ppa5.dc.icann.org (8.16.0.27/8.16.0.27) with ESMTPS id x99GlqdP022747 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Wed, 9 Oct 2019 16:47:53 GMT
Received: from PMBX112-W1-CA-1.pexch112.icann.org (64.78.40.21) by PMBX112-W1-CA-1.pexch112.icann.org (64.78.40.21) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Wed, 9 Oct 2019 09:47:51 -0700
Received: from PMBX112-W1-CA-1.pexch112.icann.org ([64.78.40.21]) by PMBX112-W1-CA-1.PEXCH112.ICANN.ORG ([64.78.40.21]) with mapi id 15.00.1497.000; Wed, 9 Oct 2019 09:47:51 -0700
From: Paul Hoffman <paul.hoffman@icann.org>
To: Heather Flanagan <rse@rfc-editor.org>
CC: XML Developer List <xml2rfc-dev@ietf.org>
Thread-Topic: [Ext] [xml2rfc-dev] xml2rfc: use of <boilerplate> in preptool step
Thread-Index: AQHVfrzAqJ5FPr2kWkyqMh6r14NI/6dS+oaA
Date: Wed, 09 Oct 2019 16:47:51 +0000
Message-ID: <5cc54256-66e7-12b7-ccb6-76174860d553@icann.org>
References: <bd47caef-fe97-f078-3c23-0744fa9154ce@gmx.de> <6CBA5233-FDBE-4E5B-BC8D-C9AC27D17B80@rfc-editor.org> <6e36282d-c6d2-6031-2002-e4bbc85b3fc0@gmx.de>
In-Reply-To: <6e36282d-c6d2-6031-2002-e4bbc85b3fc0@gmx.de>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:68.0) Gecko/20100101 Thunderbird/68.1.1
x-ms-exchange-messagesentrepresentingtype: 1
x-ms-exchange-transport-fromentityheader: Hosted
x-originating-ip: [192.0.32.234]
x-source-routing-agent: Processed
Content-Type: text/plain; charset="utf-8"
Content-ID: <AF1EA3859BC17842AFA83A5542E3FF42@pexch112.icann.org>
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2019-10-09_08:, , signatures=0
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/8PxhrNMkQuGMVJG9JoHSc0t7hJ0>
Subject: Re: [xml2rfc-dev] [Ext] xml2rfc: use of <boilerplate> in preptool step
X-BeenThere: xml2rfc-dev@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion about particulars of xml2rfc V3 design, development and code." <xml2rfc-dev.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc-dev/>
List-Post: <mailto:xml2rfc-dev@ietf.org>
List-Help: <mailto:xml2rfc-dev-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 09 Oct 2019 16:47:57 -0000

On 10/9/19 9:14 AM, Julian Reschke wrote:
> On 09.10.2019 17:47, Heather Flanagan wrote:
>> ...
>> Hi -
>>
>> Is there any reason not to create a separate <toc> element that would live in <front>?
>>
>> -Heather
>> ...
> 
> That would be better, as it wouldn't conflate things with <boilerplate>.
> 
> That said, I still don't get why the Table of Contents needs to be part
> of the canonical XML. I understand why it's desirable to be present in
> an intermediate representation before rendering, but that doesn't mean
> it needs to leak out into the canonical format.

+1 to Julian's comment. That's one reason why the design team chose not to put it in the XML at all. Another reason is that people writing XML might think that they can edit the elements of <toc> and have those edits remain through the publication cycle.

The design in the RFCs describing v3 has the tables only being created during HTML / text / PDF / whatever output. This means that the TOC for HTML doesn't have page numbers, but the TOC for text and PDF can have the appropriate page numbers.

--Paul Hoffman

v2.23.0 | Report a Bug | By Email