IETF Logo Mail Archive

Re: [xml2rfc] XInclude should be used instead of PI include

Carsten Bormann <cabo@tzi.org> Mon, 26 June 2023 21:02 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: xml2rfc@ietfa.amsl.com
Delivered-To: xml2rfc@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D83D3C1516E9 for <xml2rfc@ietfa.amsl.com>; Mon, 26 Jun 2023 14:02:14 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.899
X-Spam-Level:
X-Spam-Status: No, score=-6.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_HI=-5, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id aWzHUNfbrxxv for <xml2rfc@ietfa.amsl.com>; Mon, 26 Jun 2023 14:02:12 -0700 (PDT)
Received: from smtp.zfn.uni-bremen.de (smtp.zfn.uni-bremen.de [IPv6:2001:638:708:32::21]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id EB20BC151556 for <xml2rfc@ietf.org>; Mon, 26 Jun 2023 14:02:11 -0700 (PDT)
Received: from smtpclient.apple (p548dc15c.dip0.t-ipconnect.de [84.141.193.92]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4QqgJb5m7JzDCbH; Mon, 26 Jun 2023 23:02:07 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3731.600.7\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <m21qhyueoj.wl-randy@psg.com>
Date: Mon, 26 Jun 2023 23:01:57 +0200
Cc: XML2RFC Interest Group <xml2rfc@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <2612E60E-6B70-44DE-A87A-5ADB7F21F923@tzi.org>
References: <m25y7auglb.wl-randy@psg.com> <B71CAF97-2924-47FF-B28C-61E9C1B93CB1@tzi.org> <m21qhyueoj.wl-randy@psg.com>
To: Randy Bush <randy@psg.com>
X-Mailer: Apple Mail (2.3731.600.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/gITGOrgl-5RQpu2yGlBXoudQQw0>
Subject: Re: [xml2rfc] XInclude should be used instead of PI include
X-BeenThere: xml2rfc@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: XML2RFC discussion list <xml2rfc.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc/>
List-Post: <mailto:xml2rfc@ietf.org>
List-Help: <mailto:xml2rfc-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 26 Jun 2023 21:02:14 -0000

On 26. Jun 2023, at 22:55, Randy Bush <randy@psg.com> wrote:
> 
> i have a local rsunk repo and am doing
> 
>    <references title="Normative References">
>      <?rfc include="reference.RFC.2119.xml"?>
>      <?rfc include="reference.RFC.2622.xml"?>
>      <?rfc include="reference.RFC.2725.xml"?>
> 
> what should i be doing if i want to go to xml heaven?

As the warning says, the canonical way is now to use XInclude.
XInclude makes you hard-code the full URL to those reference items.
This is great if you always want to use the information stored remotely (and if the URLs are stable, which they haven’t been for the last half decade).

I don’t know much about XInclude as kramdown-rfc does all the reference handling for you (and can share a cache with xml2rfc, which you can prefill), so I don’t have to remember the details.

I’m sure others will speak up…

Grüße, Carsten

v2.23.0 | Report a Bug | By Email