Re: [xml2rfc-dev] RFC 7991 issue #36: Schema Issue, RFC 7991, In Section 2.5.5, "name" Attribute

Julian Reschke <julian.reschke@gmx.de> Mon, 01 October 2018 14:10 UTC

Return-Path: <julian.reschke@gmx.de>
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 D1672130DFA for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 07:10:40 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.599
X-Spam-Level:
X-Spam-Status: No, score=-2.599 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, SPF_PASS=-0.001, 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 tHu26Dbu3yoD for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 07:10:38 -0700 (PDT)
Received: from mout.gmx.net (mout.gmx.net [212.227.17.20]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 2FBF4130DDC for <xml2rfc-dev@ietf.org>; Mon, 1 Oct 2018 07:10:38 -0700 (PDT)
Received: from [192.168.1.34] ([217.91.35.233]) by mail.gmx.com (mrgmx103 [212.227.17.168]) with ESMTPSA (Nemesis) id 0Lrw2c-1fjUuJ3GaE-013dEh; Mon, 01 Oct 2018 16:10:22 +0200
Received: from [192.168.1.34] ([217.91.35.233]) by mail.gmx.com (mrgmx103 [212.227.17.168]) with ESMTPSA (Nemesis) id 0Lrw2c-1fjUuJ3GaE-013dEh; Mon, 01 Oct 2018 16:10:22 +0200
To: Henrik Levkowetz <henrik@levkowetz.com>, XML Developer List <xml2rfc-dev@ietf.org>
References: <d97ebfcf-ee4f-02ef-39c7-ac439ba1e421@levkowetz.com> <e8d5e4d3-8cf0-80c7-f475-e86339b74d7b@levkowetz.com> <edd7e2d4-77a6-bdc0-1acd-066876e0a829@gmx.de> <66f634b8-1789-cb13-02cc-08dcbdeda373@levkowetz.com> <c20d9600-cbad-a305-34f4-1a6a7243df53@gmx.de> <3559f29f-38b5-4af3-f92d-d6c2a24a073f@levkowetz.com>
From: Julian Reschke <julian.reschke@gmx.de>
Message-ID: <377cbc50-6c2f-9a62-872d-f578116693ed@gmx.de>
Date: Mon, 01 Oct 2018 16:10:16 +0200
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:60.0) Gecko/20100101 Thunderbird/60.0
MIME-Version: 1.0
In-Reply-To: <3559f29f-38b5-4af3-f92d-d6c2a24a073f@levkowetz.com>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
X-Provags-ID: V03:K1:93gnBoNXfg2O01MG0XdtmFFGwXEcGROVAmOGzqBMjHo/+C1CDkO xK6hmOPiheHrD6BCiyAGg1V6OUnYYGINxhezuv8xzGaZPioVys4WRieHukDmbzYvYw5VAac vr962icriYURogY4q+QpN7bCx4j/hHPZgPwkBKZlmNeona89z4NslyLW3mDPLoih99qI5QS i3j7XMDTnrh+ex88oH6/Q==
X-UI-Out-Filterresults: notjunk:1;V01:K0:GzoB3WcCjbw=:wTpDzva3UiPHBpSAjH9V2d atPXT8c2VpnD4RS/N3yRjVLVVNdzdvcenKDcxmWN/Na2+3DD7WmL1S8zeDX5ajSmvK8zXYn1b oglfHVJMPRWKDE+Vi030KbHIn0riRtcQEM91i/dLwoEv+UTHWhzoDQFptSXgAWa3+oC0D2+Zj Qr3paw+G/Rlcy4mXraivDwPL5jBbGMLlivHzdB9r6JV+1CjuxzlsIsAOtU3B8Eb4npTWX7770 PitR1AV/ltgzdOhOeAr3X5Qz03Qcaz1wBknw4o+6MsuHRxtkdNG6hhMRFRTVfBgIbHI0FaGUX FVtiYow3/3PL6p+ISrhg2lfcB+DIugCX9Lav6WGG9HwE3/Emd64RMPFBM/3tJBgsax+3IkXWd 11k3btiS8HSJTjbgXuvD9uhm8tSttQstY1MSU7D28EFMSKpD9DGBdnOIMac4zPKjaD55dcO6d xlbTLxOWMMHQDB+9Nr3RczXeViJE/6pYqeOeVOXfXMNSzUyJkHUaBYOx2c3XH5Kl/V69ZtZY6 v3+B/1eaGjNvnJqGEQ2xpYZ4+Xg+EdzmHcB0OyY/prXhPd1n61pdfJISVThwJTqZThL2tQr/2 tPnae+b3uiwzt9qVR04fy5Mlo4Gwm+ZB1etKemiiRtFvFfFE9arnXJvLriUn4DYzCY2WV3JS+ JkY6ZA05oPBWkLsPiTQcxMt3hEsivrLTO2vrwVjWhKlnJEWxC3/eekvD5hkicoFa4LQ9XOged rZ9nclsEoy+mVsGZ2hbSEk0l3LYA6o7ebAOud9FBBatr1OJaZ59+zslQAjySGAGaf79XgvJCQ pyv19Jkv94h0td/sJbCBmfNQDyDYRSUbvO1uTy/OC8Qu7YFsGk=
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/jsPIo0KqLzMMiSKAUW1eu87yZLw>
Subject: Re: [xml2rfc-dev] RFC 7991 issue #36: Schema Issue, RFC 7991, In Section 2.5.5, "name" Attribute
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: Mon, 01 Oct 2018 14:10:41 -0000

On 10/1/2018 3:27 PM, Henrik Levkowetz wrote:
> Hi Julian,
> 
> On 2018-10-01 15:07, Julian Reschke wrote:
>> On 10/1/2018 2:45 PM, Henrik Levkowetz wrote:
>>> Hi Julian,
>>>
>>> On 2018-10-01 14:10, Julian Reschke wrote:
>>>> On 10/1/2018 1:36 PM, Henrik Levkowetz wrote:
>>>>> ...
>>>>>
>>>>>          "A filename suitable for the contents (such as for extraction to a
>>>>>          local file)."
>>>>>
>>>>>       Given the existing use of "name" on <seriesInfo>, this attribute name
>>>>>       has a semantic dissonance.
>>>>>
>>>>>       Recommendation:  Deprecate "name" for use on <artwork> and <sourcecode>,
>>>>>                        and instead use "file", which for <sourcecode> will be
>>>>>                        explicitly rendered, as established as best current
>>>>>                        practice for YANG modules (see for instance RFC 6087
>>>>>                        [RFC6087])
>>>>>
>>>>>       Implementation:  The current version of xml2rfc uses "name".
>>>>> ---
>>>>> ...
>>>>
>>>> I would avoid making changes that aren't strictly necessary, thus keep
>>>> the name as-is.
>>>
>>> I think now, before actual use of v3 starts in earnest is the only chance
>>> we have to make changes like this.  So if the change makes sense, let's
>>> do it, rather than live forever with something which is (even if only
>>> slightly) less appropriate.
>>
>> Well, @name has been around for over a decade, it's not a V3 thing. If
>> this was new, I'd be more likely to agree.
> 
> Umm?  For the specific purpose of specifying the name of a file for
> extraction of artwork or sourcecode?  This is the specific case I'm
> thinking of here.

Yes.

"A filename suitable for the contents (such as for extraction to a local 
file).

This attribute generally isn't used for document generation, but it can 
be helpful for other kinds of tools (such as automated syntax checkers, 
which work by extracting the source code)." -- 
<https://greenbytes.de/tech/webdav/rfc7749.html#element.artwork.attribute.name>

...and, previously...:

"Finally, the "artwork" element has two optional attributes: "name" and 
"type". The former is used to suggest a filename to use when storing the 
content of the "artwork" element, whilst the latter contains a 
suggestive data-typing for the content." --
<https://tools.ietf.org/html/rfc2629#section-2.3.1.3>