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

Julian Reschke <julian.reschke@gmx.de> Wed, 09 October 2019 16:51 UTC

Return-Path: <julian.reschke@gmx.de>
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 436B0120881 for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 09:51:02 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.599
X-Spam-Level:
X-Spam-Status: No, score=-2.599 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=gmx.net
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 29EESxzWFE5n for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 09:50:58 -0700 (PDT)
Received: from mout.gmx.net (mout.gmx.net [212.227.17.21]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1178112087E for <xml2rfc-dev@ietf.org>; Wed, 9 Oct 2019 09:50:57 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1570639847; bh=rAdUeG89v8pZGCjVRuTuof32BUG1b0+JW5xaZTh4Q3w=; h=X-UI-Sender-Class:Subject:To:Cc:References:From:Date:In-Reply-To; b=ZBVLDz5vQxuGbNEc5UHy4JM8aDFavyPKRaHio+OrlXDzDs511uT7fBRN36xupquHC BDHSsSJW6hKMHCL7ixKGLFg8GLAR+NNMr46V85PH9Uc6pscYUiZVbwEWGgQmy8GD3F y2q1iAzmzOJ7afHso5ifpGWbtANXhgspn6FYg2aI=
X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c
Received: from [192.168.178.124] ([84.171.145.63]) by mail.gmx.com (mrgmx105 [212.227.17.168]) with ESMTPSA (Nemesis) id 1MhD6g-1heFSX33ly-00eHhd; Wed, 09 Oct 2019 18:50:47 +0200
To: Heather Flanagan <rse@rfc-editor.org>
Cc: XML Developer List <xml2rfc-dev@ietf.org>
References: <6e36282d-c6d2-6031-2002-e4bbc85b3fc0@gmx.de> <6D64EA29-B4A3-4DF7-A5F0-1B6D4B83886D@rfc-editor.org>
From: Julian Reschke <julian.reschke@gmx.de>
Message-ID: <410e71dc-72e3-93b7-09aa-240fccf537e6@gmx.de>
Date: Wed, 09 Oct 2019 18:50:45 +0200
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:60.0) Gecko/20100101 Thunderbird/60.9.0
MIME-Version: 1.0
In-Reply-To: <6D64EA29-B4A3-4DF7-A5F0-1B6D4B83886D@rfc-editor.org>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: quoted-printable
X-Provags-ID: V03:K1:w4+8wVm6z4QEHyAvlCqrWoBkQBN7td/QXNIHjBn5WnRF7loG78L 72VwP81ulU2Z8UJKS+WINSKLDlk6drHvcUk5j0OVnRvdQgBY52HCUs4yL4s7F3OzyOg7Nq7 qvgPkPe0kvpf+lkAbT+z3s2bQHIiGJ8RT6X1SnWrxULneJPt5axlBIoK+3KcEkHkmzWpqPb Y6sOAX7VMGpBFrQqqij2w==
X-UI-Out-Filterresults: notjunk:1;V03:K0:Lbmfiqf0CfA=:JXmFAlQfm1Zq26KDDKcTX0 rSzQgUf3qnqemJ0SGO20tiW32VKnqzWaSqKeRbbr8PS7PjNt53C+fJASRuaAyEk5rsxT2+X7k 0aFAhQH2XRi7iY+wkQ5eW7oDFGxdNovMeLrocd5VYFxrUrTQDtCNIP+k9bry1iZCc7mHwwxwm shC05JpGgku1eUM6TcBwhpEjPESf8A4jiGU3uvG1o4qy4mHhPTEahPITAqMdS8jVNrp4O2xFI V852rl2lLgzG2y3pbF5ExGo+GoSxnfx97XI1obidqB4NNGOO5PGpaMoRe6SL1oQtUfr9C4ddl w/zHCKjBFt39eQ9zgDWxYSAvE0EgmbXTOvzLRnON4Bv5KMMdpDoXHyS8R7FXXdaI2CLUBCPuT 8Fox2BhB/SATLyrHgUzpVmju/6dztX2d+dcw/QY0kQBYcCW+4WleeZ86wWsIOmnwsuDRWOaDz yv/nVoZ1yNf5i4aEOFYVvgDKdWec3S7NbwmZFEbuagSywWrIWZqy5vqXsH/yTXhEsTbUpgKp8 gLKQI7lCjXPjq6TXApol8mC64Y+KR1AFq8URmXcicY8DQBJ5sW6ppIFFSVdq+uH2inMEsu2vg Ds2xW9i1fmUXYjkV4lo0Ux+TyPWc9PNUs0LzD1VsrQE4rLqvGqvCBJ5swFvl0Tus1zptxEK0u zkdhzBoQijfW7HRn1sU7MZoCaBHFltNvg0/59dmpG6HqzL03htSXbYOy/6sDI46Xl1TgD7cb2 7fUVRibOuqfD0LF4YzZLrH9uF5khjfXdNbPvhrUvW0ukb83JFSSIxNuZKqxyCA2ZX3lft2huo ENNOicNMjy2DWmp2na/8xBLaiaLHOtuWhgZwASUIIjRd4vGRV2Rz6HsjVPqA6Z7OPFEK3yC3i 9963Nv4r2ZkYuNYxvnOYnZ1DL7PRaCbPm73+qxuybOK5GytfFENUDcxfJ1bNy8BPXjmiZzIdh JFZtXzJiBNIv85ghIpHxuMYfGIa+Bt7tIoLYPrPEli/NSBBAOh3/xL9ZXeZKBmZu4ndmFAvii wLSywrOI968YEro5SlsHYmmbNlGnihwZxy/2W6Q0zm4Ptd+m/i3KdFDpO7BVEUFIvqwTEIccH HzbP2GmPgBOaHLdbaoO3SQ1obH3b6PAgBZ80q752PTe7O+OdphP9KSWMUVq0hUGsA5SpOncD2 fx9bJv34b6ZWSXMouwu/i2Y3xrGM6i/UaEPqNmoLyIkYAVLnGeaQ7IckfpGTpztjd53GedVEH 8+qNZWZ8hDQ9lTbSjcuDAnPhgHx6Qx88f+IJ0jgLtR5o+NBWk4Dv5cWOJg3c=
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/G68MkfeCGgtXkMhxqMBVOAEYvwI>
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:51:02 -0000

On 09.10.2019 18:44, Heather Flanagan wrote:
> ...
>> 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.
> ...

I don't see the point (and it contradicts the specs). But well, it won't
hurt either, except that it causes potential confusion. Just make sure
it's fully specified (for instance, what to do when it's present in the
input source and does not match the to-be-generated ToC).

Also, as a reminder, there are other places where text is generated, and
which is not reflected in the canonical XML (for instance, anything
generated by processing <u>, or the code that reformats the contents of
<postal>).

Best regards, Julian