Re: [xml2rfc] rfc2629-xhtml.ent warning

Jay Daley <exec-director@ietf.org> Fri, 19 May 2023 12:58 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 BEC7EC15107E for <xml2rfc@ietfa.amsl.com>; Fri, 19 May 2023 05:58:40 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.896
X-Spam-Level:
X-Spam-Status: No, score=-1.896 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=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 ugan01j9voRy for <xml2rfc@ietfa.amsl.com>; Fri, 19 May 2023 05:58:35 -0700 (PDT)
Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) (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 C70A4C14F75F for <xml2rfc@ietf.org>; Fri, 19 May 2023 05:58:35 -0700 (PDT)
Received: by mail-wr1-x42d.google.com with SMTP id ffacd0b85a97d-3075e802738so3093555f8f.1 for <xml2rfc@ietf.org>; Fri, 19 May 2023 05:58:35 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ietf-org.20221208.gappssmtp.com; s=20221208; t=1684501114; x=1687093114; h=to:references:message-id:content-transfer-encoding:cc:date :in-reply-to:from:subject:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=Tm/F1gLiMdNgnrt6Jihib+3b5RtGEzHAuc432X6eXgQ=; b=oiMlSJ2tJZvThGXZ7AZ2Hi/DIXytqLqykw+TbFnwOxqklYaWHq6CBmxgfWYeLlM+pQ sUNRGUAaICQ0F6RRe0HR3pph/fC0XfdNyIu+WY3SXIrbFn4NMd547r9cazyJDzFjfW5t 4owBtQeVNoEfqCqcs0ES7arD3tNWvEqsmR1MrxuQRR5SNzBcmFwJJKcUV3RgWF1dibzJ YWd1Uy4ocJ3Jtv7BSt4RzrJJKKgSJECxALfbfKHjGOjq3OX1wdXxuXKNHbUzqcMqD/zl Zap8Bi7Dhkve0ZcHfeTdL1XhCjCwuJQB2MelH6Rr4JRZCjBOYUfSiTIC8ttViw03Ni41 fgNA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684501114; x=1687093114; h=to:references:message-id:content-transfer-encoding:cc:date :in-reply-to:from:subject:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Tm/F1gLiMdNgnrt6Jihib+3b5RtGEzHAuc432X6eXgQ=; b=CYPQ7zWN/pTQjzwQFzTLF/AwAUx6b6InMoUObXgJuDzLdOT3N4JBQWBhecuM0qLS/9 DbVX7O1nR/U5ODeIbQSfWrQTUY5bDnUOkygmbnRNnHD8XfzTeTvBIDrETrQtHJN2qd9v QB1JjElenNA1kon5emeha5B5vgYtUiXH9Cx0SBavMR+unLdirKA+ZLIpZ3ihxQp8/2NK zU2AafZwnqEdp7Tt5J+vN6G7hvAbrhCUhn3g8OP4NAVU2Q/Qln/p1XfVBUcXqfokUMtn g2wU2zBpxBIqQw/PIIvrGTHyBdmXnxK0sy5pzN8FCgPK6uAmq5agVzVE7Jkaml54rtwR g+0Q==
X-Gm-Message-State: AC+VfDzRu5ciBYbqKNx0Nc4p2zwo3pYXsij1AJvsImSaW+PqDOPem1UP iH5Ya0ErimsRumoEj1Fb7UPXKCgUAvM1uS9j075b6fXt
X-Google-Smtp-Source: ACHHUZ7jbeYWyJ2VDzeXYmexf81mrQrL6x/cw1rcYcroq4T9beYcStHJqic2NuuHfykeFMM+BYnpgA==
X-Received: by 2002:adf:f306:0:b0:306:2d45:a8e0 with SMTP id i6-20020adff306000000b003062d45a8e0mr1806404wro.15.1684501113648; Fri, 19 May 2023 05:58:33 -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 t4-20020a1c7704000000b003f42bb3a5adsm2374247wmi.4.2023.05.19.05.58.32 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Fri, 19 May 2023 05:58:33 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3731.500.231\))
From: Jay Daley <exec-director@ietf.org>
In-Reply-To: <49c86fec-70ef-ab8d-f522-2669520b2dfb@gmx.de>
Date: Fri, 19 May 2023 13:58:07 +0100
Cc: xml2rfc@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <6E6E9A65-3761-4C68-98B9-1790B4BC57DC@ietf.org>
References: <b09e9607-966a-6250-db4b-5d541b1e690d@htt-consult.com> <EA51BFDA-0A1C-49DA-8301-FDF9BD805D2E@ietf.org> <9c8e932b-f6eb-5cf9-2dae-3018f0a217c0@gmx.de> <EA50DA32-4D0A-4FB9-B749-CAB07EF18B33@ietf.org> <49c86fec-70ef-ab8d-f522-2669520b2dfb@gmx.de>
To: Julian Reschke <julian.reschke@gmx.de>
X-Mailer: Apple Mail (2.3731.500.231)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/MqvpMToP43ArxolepAdiL84eZAc>
Subject: Re: [xml2rfc] rfc2629-xhtml.ent warning
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: Fri, 19 May 2023 12:58:40 -0000

For info for others, Julian and I continued this discussion on a GitHub issue and reached agreement:

	https://github.com/ietf-tools/xml2rfc/issues/992

Jay

> On 16 May 2023, at 15:31, Julian Reschke <julian.reschke@gmx.de> wrote:
> 
> On 16.05.2023 16:23, Jay Daley wrote:
>> 
>> 
>>> On 16 May 2023, at 14:37, Julian Reschke <julian.reschke@gmx.de> wrote:
>>> 
>>> On 16.05.2023 15:19, Jay Daley wrote:
>>>> 
>>>>> On 16 May 2023, at 14:12, Robert Moskowitz <rgm@htt-consult.com> wrote:
>>>>> 
>>>>> It has been a few weeks since my last run of xml2rfc, and that was
>>>>> on what I had installed on my old Fedora 35 notebook, now on my
>>>>> updated Fedora 38 system...
>>>>> 
>>>>> So this morning I got (4 times):
>>>>> 
>>>>> Warning:
>>>>> /home/rgm/data/htt/Projects/Critical/drafts/rfc2629-xhtml.ent is no
>>>>> longer needed as the special processing of non-ASCII characters has
>>>>> been superseded by direct support for non-ASCII characters in RFCXML.
>>>>> 
>>>>> 
>>>>> The only use of rfc2629 in my xml is:
>>>>> 
>>>>> <!DOCTYPE rfc SYSTEM "rfc2629-xhtml.ent">
>>>>> <?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
>>>>> 
>>>>> So obviously there has been a change that I did not catch.  No
>>>>> comments from the rfc editor on working with my drafts a couple
>>>>> months back for rfcs 9373 & 9374 that had these lines.
>>>>> 
>>>>> So what is the current for !DOCTYPE and xml-stylesheet?
>>>> 
>>>> A DOCTYPE is not recommended because the grammar is specified in
>>>> Compact RelaxNG not any other schema format.   The recommended method
>>>> to associate the schema with the XML is
>>>> 
>>>> <?xml-model href="rfc7991bis.rnc"?>
>>>> 
>>>> Note, this will require you to have rfc7991bis.rnc in your build path.
>>>> 
>>>> This is fully explained in the authors documentation here:
>>>> 
>>>> https://authors.ietf.org/en/templates-and-schemas
>>>> 
>>>> That same page also links to the "official" templates that can be
>>>> used as starting points.
>>>> 
>>>> Finally, the authors documentation also lists various XML editors and
>>>> how the interact with the schema
>>>> 
>>>> https://authors.ietf.org/en/drafting-in-xml
>>>> 
>>>> Jay
>>> 
>>> Jay,
>>> 
>>> I don't think this is helpful.
>>> 
>>> Robert's DOCTYPE declaration is used to define named character entities.
>>> RelaxNG doesn't help with these at all.
>> 
>> I was trying to address two things at once, but yes I can see that I
>> only confused things.
>> 
>> The page I pointed to explains this correctly
>> https://authors.ietf.org/en/templates-and-schemas#character-entities
>> <https://authors.ietf.org/en/templates-and-schemas#character-entities>
>> 
>>> 
>>> The warning message from xml2rfc is completely misleading, as it
>>> conflates entity declarations with validation.
>> 
>> No it’s correct, the full rfc2629-xhtml.ent file is no longer required
>> for exactly the reason explained in the warning.
> 
> The warning is misleading. It was never required.

So you would be happy if the warning was "not required" instead of "no longer required"?

> 
> This is an XML question, not an RFCXML question.
> 
> If you want named entities, you need to declare them. Either in an
> external resource, or in the internal subset. Or, instead, given an
> editor with proper Unicode support, you can type them directly (which,
> depending on the code point, may or may not be a good idea).
> 
> This is true for all versions of x2mlrfc (the tool) and RFCXML (the
> language). It has nothing to do with whether you use DTDs or RelaxNG for
> validation, or whether you validate at all.
> 
> And yes, RFCXML since version 3 supports *outputting* non-ASCII
> characters in HTML and TXT. But this has nothing to do with the way they
> are *inserted* into the XML file.

Yes, understood and that is all well explained in the documentation.  

The point about the warning though is to try and nudge people away from old working practices to new working practices that will improve their authoring experience.  

> 
> Best regards, Julian


-- 
Jay Daley
IETF Executive Director
exec-director@ietf.org