Re: [xml2rfc] Links to rfc7991bis.rnc may need some fixing

Carsten Bormann <cabo@tzi.org> Wed, 02 March 2022 07:16 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 9F3203A12C8 for <xml2rfc@ietfa.amsl.com>; Tue, 1 Mar 2022 23:16:40 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.909
X-Spam-Level:
X-Spam-Status: No, score=-1.909 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=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 8XfjGKntRofd for <xml2rfc@ietfa.amsl.com>; Tue, 1 Mar 2022 23:16:35 -0800 (PST)
Received: from gabriel-smtp.zfn.uni-bremen.de (gabriel-smtp.zfn.uni-bremen.de [134.102.50.15]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id A0E863A12CE for <xml2rfc@ietf.org>; Tue, 1 Mar 2022 23:16:27 -0800 (PST)
Received: from smtpclient.apple (p5089ad4f.dip0.t-ipconnect.de [80.137.173.79]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4K7lls3yyZzDCdJ; Wed, 2 Mar 2022 08:16:25 +0100 (CET)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 15.0 \(3693.60.0.1.1\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <7f5b1796-f986-c2e7-85d8-de1bfbab7b7f@it.aoyama.ac.jp>
Date: Wed, 02 Mar 2022 08:16:24 +0100
Cc: "xml2rfc@ietf.org" <xml2rfc@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <3BFE3BFC-41AE-430C-9A7A-81A82765C311@tzi.org>
References: <7f5b1796-f986-c2e7-85d8-de1bfbab7b7f@it.aoyama.ac.jp>
To: "\"Martin J. Dürst\"" <duerst@it.aoyama.ac.jp>
X-Mailer: Apple Mail (2.3693.60.0.1.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/oz5xo_MeQiqpUburdWHiJvPhhgY>
Subject: Re: [xml2rfc] Links to rfc7991bis.rnc may need some fixing
X-BeenThere: xml2rfc@ietf.org
X-Mailman-Version: 2.1.29
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: Wed, 02 Mar 2022 07:16:41 -0000

On 2. Mar 2022, at 07:24, Martin J. Dürst <duerst@it.aoyama.ac.jp> wrote:
> 
> Dear XML2RFC experts,
> 
> I just started recently with a new ID using xml2rfc, after a long hiatus. Things went fairly smooth, but one thing that caused problems was that there are links for rfc7991bis.rnc that actually go to
> https://github.com/ietf-authors/rfcxml-templates-and-schemas/blob/main/rfc7991bis.rnc. I naively tried to just download that with "save link as" from my browser, but that didn't give me the actual file, just a github page including the actual file. It took me quite a while to figure out what the resulting error messages meant, and what had happened.
> 
> I no longer remember where I originally found such a link, but I have found one on https://authors.ietf.org/en/templates-and-schemas, in the Schemas section.
> 
> Anyway, if you put a link on a filename, make it so that it works for direct downloading. Everything else is highly confusing. If you want to link to the relevant github page, please add a separate link making clear that this link doesn't link to the actual file. Many thanks in advance.

This is also very confusing for me.

The authoritative RFCXMLv3 grammar is at

https://github.com/ietf-tools/xml2rfc/blob/main/xml2rfc/data/v3.rnc
(https://raw.githubusercontent.com/ietf-tools/xml2rfc/main/xml2rfc/data/v3.rnc is the raw version of that.)

This appears to be a precursor to the one at rfcxml-templates-and-schemas, which has less indentation and more comment text.

I also find a version of the v3.rnc that includes grammar for xi:xinclude, which is needed for some tools if you use that feature.

The name rfc7991bis.rnc also seems to relate to various other activities.
There is an expired draft at:

https://datatracker.ietf.org/doc/html/draft-iab-rfc7991bis-03

… which points to the xml2rfc-dev mailing list as its locus of discussion.

While there is no repo information on that draft or its datatracker entry, there is a GitHub repo at

https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis

… which appears to have recent activity.

This includes a

https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/blob/master/xml2rfcv3.rng

… which is used in the accompanying Makefile to create an xml2rfcv3.rnc, as well as an annotated RNG from text from the I-D in that directory.

I don’t find documentation as to what the intentions with these various copies and versions is, and whether the naming of the files has any relation to those.

Grüße, Carsten