IETF Logo Mail Archive

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

Heather Flanagan <rse@rfc-editor.org> Wed, 09 October 2019 16:44 UTC

Return-Path: <rse@rfc-editor.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 F088412085B for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 09:44:47 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.2
X-Spam-Level:
X-Spam-Status: No, score=-4.2 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, 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 o8aKd4BRLlIl for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 09:44:46 -0700 (PDT)
Received: from mail.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id A9C3D1200A3 for <xml2rfc-dev@ietf.org>; Wed, 9 Oct 2019 09:44:46 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id D54E1203D16; Wed, 9 Oct 2019 09:43:20 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dqewoeugl9MN; Wed, 9 Oct 2019 09:43:20 -0700 (PDT)
Received: from [100.69.76.168] (unknown [172.58.19.215]) by c8a.amsl.com (Postfix) with ESMTPSA id 96EB2203D15; Wed, 9 Oct 2019 09:43:20 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
From: Heather Flanagan <rse@rfc-editor.org>
Mime-Version: 1.0 (1.0)
Date: Wed, 09 Oct 2019 09:44:32 -0700
Message-Id: <6D64EA29-B4A3-4DF7-A5F0-1B6D4B83886D@rfc-editor.org>
References: <6e36282d-c6d2-6031-2002-e4bbc85b3fc0@gmx.de>
Cc: XML Developer List <xml2rfc-dev@ietf.org>
In-Reply-To: <6e36282d-c6d2-6031-2002-e4bbc85b3fc0@gmx.de>
To: Julian Reschke <julian.reschke@gmx.de>
X-Mailer: iPhone Mail (17A860)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/my9BQf8dFcYa5HkzjnKXqS7dn60>
Subject: Re: [xml2rfc-dev] 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:44:48 -0000


> On Oct 9, 2019, at 9:13 AM, Julian Reschke <julian.reschke@gmx.de> 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>.

Ok. 

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

I feel fairly strongly that the final XML must be self-contained. While someone can derive the TOC based in section headers, deriving details is not as good as just have the thing available in one place. 

You don’t agree. I get that. But I am insisting on this one. 

Heather

> 
> Best regards, Julian
>

v2.23.0 | Report a Bug | By Email