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

Jay Daley <exec-director@ietf.org> Tue, 27 June 2023 06:50 UTC

Return-Path: <jay@staff.ietf.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 733F4C1527A0 for <xml2rfc@ietfa.amsl.com>; Mon, 26 Jun 2023 23:50:12 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.897
X-Spam-Level:
X-Spam-Status: No, score=-6.897 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=ietf-org.20221208.gappssmtp.com
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 qNWYBxUz072b for <xml2rfc@ietfa.amsl.com>; Mon, 26 Jun 2023 23:50:11 -0700 (PDT)
Received: from mail-wm1-x32e.google.com (mail-wm1-x32e.google.com [IPv6:2a00:1450:4864:20::32e]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 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 CAFE9C1526F4 for <xml2rfc@ietf.org>; Mon, 26 Jun 2023 23:50:11 -0700 (PDT)
Received: by mail-wm1-x32e.google.com with SMTP id 5b1f17b1804b1-3fb10fd9ae9so14642235e9.2 for <xml2rfc@ietf.org>; Mon, 26 Jun 2023 23:50:11 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ietf-org.20221208.gappssmtp.com; s=20221208; t=1687848610; x=1690440610; h=to:in-reply-to:cc:references:message-id:date:subject:mime-version :from:content-transfer-encoding:from:to:cc:subject:date:message-id :reply-to; bh=u92wHx6zSQcG8R0pVvrWb5yC0dEBdsvED1oH+qIFyOc=; b=SDerJKJlwaiNdR3sBI2A7TV1N9tPB5UrgZl5wcqhGQPZ947m8kCMCZ1A/hJ/OhIQY+ bSWyU2Oq9NRyPdJec8PbqVjz2lb1ifjcObmmBzw0ALBIaGMqOzrTTdlbjEqUsiYAXBZs T0OOANuFL2CJ9AAchWrRgQiJCasc3cPvTFd5sKPbsuMKQIv+oqv3KQVYAOxx7wHxfPhp BfKUGlAJod4kKBwdTwk2x8/k8cdh5LduqvC1Lr1BLYPLYEOF7B9/ie2yo8lQSq8oRG4A EbuAoe0cHR/39makCuNNtmuzxgDMOypBOcdFUj8iUXGRHgbFjhGoZRb8l4s7+1K7qSxl KQbQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687848610; x=1690440610; h=to:in-reply-to:cc:references:message-id:date:subject:mime-version :from:content-transfer-encoding:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=u92wHx6zSQcG8R0pVvrWb5yC0dEBdsvED1oH+qIFyOc=; b=LpSfgjYftM+nD9xJRhxZf0T++J2jUpZtya4n/kOnyGHCKRnvn0s2bhGgDHRr+wpudH jjnLI4PV9jkf+VrgONk1MITBoxL80tLq0srQZqvG9XVrnc7LNcBSSW4+J4NeLB9i3hsr /jza41EX2DlknUemONL6BzMFEoL96dKueK48x48yv2g4vn7i/+B14i41bDsed5aNIOk3 bX8+0kKOMdJgTok2/j2Hewwdk02Y29LaPaIYgaeKYaYH5JEdZVqy+DmKvBxReTwISOQf bXZXtc7sbHA62bitGph0DAr6xahhuYcNLd5CPNM8CunZ5gmGVYy+Np8sZmDEBFdhhte0 uC2A==
X-Gm-Message-State: AC+VfDwzT4Z8PW9tDpy4eLap7d6RtsDb1tLqRSnM0zP6PIxFV9Uhp/UJ 5A8LxuWdvhCbJC7lWwBjO5Ry79SzqN3CWIT0IRXzlTlu
X-Google-Smtp-Source: ACHHUZ67O3MvqCEcsJje7OvyvNB2Qj2tsVv5EtLiLJt0F2k6HW4as1b3J1FMVLhpyDWI95iRxWeRbA==
X-Received: by 2002:a05:600c:22ce:b0:3fa:962e:e8f4 with SMTP id 14-20020a05600c22ce00b003fa962ee8f4mr3160177wmg.26.1687848609727; Mon, 26 Jun 2023 23:50:09 -0700 (PDT)
Received: from smtpclient.apple (host-92-27-125-209.static.as13285.net. [92.27.125.209]) by smtp.gmail.com with ESMTPSA id 13-20020a05600c240d00b003f7f2a1484csm9694500wmp.5.2023.06.26.23.50.08 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 26 Jun 2023 23:50:09 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
From: Jay Daley <exec-director@ietf.org>
Mime-Version: 1.0 (1.0)
Date: Tue, 27 Jun 2023 07:49:57 +0100
Message-Id: <126127DA-54EC-455E-BEC5-AF64E4981659@ietf.org>
References: <BEAEBC3E-CEAE-494B-9551-E5D178E86FC3@tzi.org>
Cc: Kesara Rathnayake <kesara@staff.ietf.org>, XML2RFC Interest Group <xml2rfc@ietf.org>
In-Reply-To: <BEAEBC3E-CEAE-494B-9551-E5D178E86FC3@tzi.org>
To: Carsten Bormann <cabo@tzi.org>
X-Mailer: iPhone Mail (20F75)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/aUBLeXxgX6sT2phhpslFgi62QdM>
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: Tue, 27 Jun 2023 06:50:12 -0000

As I understand it, the design intent of v3 was to replace all PIs with grammar constructs because that then enables independently developed code using standard XML tools. For example, XSLT based transformers. 

As PIs are not recognised in v3 I think it would be a mistake to add them back. 

On the documentation point - it’s hard to know how far to go in documenting things that are standard features of XML processors, such as checking the local directory/cache for includes, but it seems clear we should err on the side of adding as much as info as possible. 

-- 
Jay Daley 
IETF Executive Director

> On 27 Jun 2023, at 06:05, Carsten Bormann <cabo@tzi.org> wrote:
> 
> On 27. Jun 2023, at 06:54, Kesara Rathnayake <kesara@staff.ietf.org> wrote:
>> 
>> I'm under the impression that we need to move away from using PIs.
> 
> PIs are great for doing things that are instructions on the processing.
> (They are not so great for the actual content of the document.)
> Compare pragmas in programming languages.
> 
> There used to be a feature that could be invoked like this:
> 
> <?v3xml2rfc silence="XInclude should be used instead of PI include" ?>
> 
> I can’t get this to work though with 3.17.4.
> 
> Grüße, Carsten
> 
> _______________________________________________
> xml2rfc mailing list
> xml2rfc@ietf.org
> https://www.ietf.org/mailman/listinfo/xml2rfc