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

Henrik Levkowetz <henrik@levkowetz.com> Fri, 11 October 2019 09:16 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 48136120043 for <xml2rfc-dev@ietfa.amsl.com>; Fri, 11 Oct 2019 02:16:45 -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 xfzZIlAuUiN1 for <xml2rfc-dev@ietfa.amsl.com>; Fri, 11 Oct 2019 02:16:44 -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 5066212004D for <xml2rfc-dev@ietf.org>; Fri, 11 Oct 2019 02:16:44 -0700 (PDT)
Received: from h-202-242.a357.priv.bahnhof.se ([158.174.202.242]:63418 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 1iIr2R-0002gl-Di; Fri, 11 Oct 2019 02:16:43 -0700
To: Martin Thomson <mt@lowentropy.net>, xml2rfc-dev@ietf.org
References: <6e36282d-c6d2-6031-2002-e4bbc85b3fc0@gmx.de> <6D64EA29-B4A3-4DF7-A5F0-1B6D4B83886D@rfc-editor.org> <4c8e3e4a-b7d8-4c49-a8b4-97435946b91d@www.fastmail.com>
From: Henrik Levkowetz <henrik@levkowetz.com>
Message-ID: <3f8f9f45-3bd5-9424-5bf9-0ac54772cf21@levkowetz.com>
Date: Fri, 11 Oct 2019 11:16:17 +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: <4c8e3e4a-b7d8-4c49-a8b4-97435946b91d@www.fastmail.com>
Content-Type: multipart/signed; micalg="pgp-sha256"; protocol="application/pgp-signature"; boundary="lb1tEpxwP535aP1b676XSjkckG0QdAQqW"
X-SA-Exim-Connect-IP: 158.174.202.242
X-SA-Exim-Rcpt-To: xml2rfc-dev@ietf.org, mt@lowentropy.net
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/CSMU5wwTZ7jdocfyz-g48weyCZ4>
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: Fri, 11 Oct 2019 09:16:46 -0000

Martin:

On 2019-10-11 08:37, Martin Thomson wrote:
> On Thu, Oct 10, 2019, at 03:44, Heather Flanagan wrote:
>> 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. 
> 
> I'm struggling to understand this argument.  In what way does having
> a TOC in the XML make the document more self-contained?  It only
> seems to add redundancy, which only invites contradiction as far as I
> can see.  In my view, informed by long experience with DRY
> (https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), derivations
> are always far more robust.
> 
> Removing the redundancy, all you have is a signal about the desired
> *location* of the TOC, but I don't see any value in encoding that
> information.
> 
>> You don’t agree. I get that. But I am insisting on this one.
> 
> I get the appeal to authority bit (or assertion thereof really), but
> I don't think we should operate that way, and I hope that you don't
> expect us to accede to that either.

After a discussion about including the generated Table of Contents and
Index in the prepped XML output file last year, it was decided to keep
the ToC, but not include the Index.  Now Julian opposed having the ToC
as part of the <boilerplate> element, so it was moved to <toc> (which I
think is a good move).

Are you against moving the ToC to a separate element within <front>,
instead of making it a <section> within <boilerplate>, or are you aiming
to undo the decision from last year about including the ToC?


	Henrik