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

Henrik Levkowetz <henrik@levkowetz.com> Wed, 09 October 2019 17:21 UTC

Return-Path: <henrik@levkowetz.com>
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 5224F120122 for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 10:21:17 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.096
X-Spam-Level:
X-Spam-Status: No, score=-1.096 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RDNS_NONE=0.793, SPF_HELO_NONE=0.001, T_SPF_PERMERROR=0.01] autolearn=no 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 pYAitKc5ACvC for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 10:21:15 -0700 (PDT)
Received: from zinfandel.tools.ietf.org (unknown [IPv6:2001:1890:126c::1:2a]) (using TLSv1.2 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id BA6BD1200B1 for <xml2rfc-dev@ietf.org>; Wed, 9 Oct 2019 10:21:15 -0700 (PDT)
Received: from h-202-242.a357.priv.bahnhof.se ([158.174.202.242]:60584 helo=tannat.localdomain) by zinfandel.tools.ietf.org with esmtpsa (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80) (envelope-from <henrik@levkowetz.com>) id 1iIFeD-0004T0-W9; Wed, 09 Oct 2019 10:21:14 -0700
To: Paul Hoffman <paul.hoffman@icann.org>, Heather Flanagan <rse@rfc-editor.org>
References: <bd47caef-fe97-f078-3c23-0744fa9154ce@gmx.de> <6CBA5233-FDBE-4E5B-BC8D-C9AC27D17B80@rfc-editor.org> <6e36282d-c6d2-6031-2002-e4bbc85b3fc0@gmx.de> <5cc54256-66e7-12b7-ccb6-76174860d553@icann.org>
Cc: XML Developer List <xml2rfc-dev@ietf.org>
From: Henrik Levkowetz <henrik@levkowetz.com>
Message-ID: <05fc49c1-62a9-0095-a118-acc323dbbad7@levkowetz.com>
Date: Wed, 09 Oct 2019 19:21:06 +0200
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:45.0) Gecko/20100101 Thunderbird/45.8.0
MIME-Version: 1.0
In-Reply-To: <5cc54256-66e7-12b7-ccb6-76174860d553@icann.org>
Content-Type: multipart/signed; micalg="pgp-sha256"; protocol="application/pgp-signature"; boundary="3XEavtHUME6Q5GJwfNBgOP7lds9Vi7POW"
X-SA-Exim-Connect-IP: 158.174.202.242
X-SA-Exim-Rcpt-To: xml2rfc-dev@ietf.org, rse@rfc-editor.org, paul.hoffman@icann.org
X-SA-Exim-Mail-From: henrik@levkowetz.com
X-SA-Exim-Version: 4.2.1 (built Mon, 26 Dec 2011 16:24:06 +0000)
X-SA-Exim-Scanned: Yes (on zinfandel.tools.ietf.org)
X-Clacks-Overhead: GNU Terry Pratchett
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/ahHW2nxXJ0gGSc_H1zBIC32Eb5Q>
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 17:21:17 -0000

Hi Paul,

On 2019-10-09 18:47, Paul Hoffman wrote:
> 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.

The XML currently generated for the ToC is used as-is to generate entries
with page numbers for paginated text, and without them for other formats.
No conflict.


	Henrik