IETF Logo Mail Archive

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

Heather Flanagan <rse@rfc-editor.org> Wed, 09 October 2019 15:47 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 BEC0F12006A for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 08:47:46 -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 hgCZJTmKKcra for <xml2rfc-dev@ietfa.amsl.com>; Wed, 9 Oct 2019 08:47:44 -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 41A0A12004E for <xml2rfc-dev@ietf.org>; Wed, 9 Oct 2019 08:47:43 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id EE483203461; Wed, 9 Oct 2019 08:46:17 -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 98r-pqOOiHHC; Wed, 9 Oct 2019 08:46:17 -0700 (PDT)
Received: from [10.47.51.224] (unknown [156.39.10.47]) by c8a.amsl.com (Postfix) with ESMTPSA id B602320345D; Wed, 9 Oct 2019 08:46:17 -0700 (PDT)
Content-Type: text/plain; charset="us-ascii"
Mime-Version: 1.0 (Mac OS X Mail 12.4 \(3445.104.11\))
From: Heather Flanagan <rse@rfc-editor.org>
In-Reply-To: <bd47caef-fe97-f078-3c23-0744fa9154ce@gmx.de>
Date: Wed, 09 Oct 2019 08:47:20 -0700
Cc: XML Developer List <xml2rfc-dev@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <6CBA5233-FDBE-4E5B-BC8D-C9AC27D17B80@rfc-editor.org>
References: <bd47caef-fe97-f078-3c23-0744fa9154ce@gmx.de>
To: Julian Reschke <julian.reschke@gmx.de>
X-Mailer: Apple Mail (2.3445.104.11)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/L1twZHXLAZfj-c9zrYMcoENCGqM>
Subject: Re: [xml2rfc-dev] xml2rfc: use of <boilerplate> in preotool 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 15:47:47 -0000


> On Oct 7, 2019, at 9:37 PM, Julian Reschke <julian.reschke@gmx.de> wrote:
> 
> So xml2rfc, when running the preptool step, apparently puts the TOC
> inside the <boilerplate> element.
> 
> This is problematic for a variety of reasons:
> 
> - it uses <boilerplate> for something it was designed for (which would
> require changes to RFC 7991 and RFC 7998)
> - it makes automatic checking of <boilerplate> harder
> - it requires the @pn attribute to become a full-blown link target
> 
> As far as I can tell, none of this is currently documented.
> 
> Now, as far as I can tell, the reason for this change is entirely an
> implementation detail now leaking into the grammar and the canonical
> XML. Namely, that xml2rfc internally used the prepped output to embed
> information for the rendering backends. This is of course absolutely ok,
> but it shouldn't affect the canonical format, nor the semantics of
> <boilerplate>.
> 
> Best regards, Julian
> 
> PS: raised as <https://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/440>


Hi -

Is there any reason not to create a separate <toc> element that would live in <front>?

-Heather

v2.23.0 | Report a Bug | By Email