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

Jim Schaad <ietf@augustcellars.com> Wed, 03 October 2018 03:02 UTC

Return-Path: <ietf@augustcellars.com>
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 A0B521311C0 for <xml2rfc-dev@ietfa.amsl.com>; Tue, 2 Oct 2018 20:02:44 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001, 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 PgoWWYttFQY1 for <xml2rfc-dev@ietfa.amsl.com>; Tue, 2 Oct 2018 20:02:42 -0700 (PDT)
Received: from mail2.augustcellars.com (augustcellars.com [50.45.239.150]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 80DDD1311B9 for <xml2rfc-dev@ietf.org>; Tue, 2 Oct 2018 20:02:41 -0700 (PDT)
Received: from Jude (192.168.0.11) by mail2.augustcellars.com (192.168.0.56) with Microsoft SMTP Server (TLS) id 15.0.1347.2; Tue, 2 Oct 2018 19:57:36 -0700
From: Jim Schaad <ietf@augustcellars.com>
To: 'Henrik Levkowetz' <henrik@levkowetz.com>, 'XML Developer List' <xml2rfc-dev@ietf.org>
References: <d97ebfcf-ee4f-02ef-39c7-ac439ba1e421@levkowetz.com>
In-Reply-To: <d97ebfcf-ee4f-02ef-39c7-ac439ba1e421@levkowetz.com>
Date: Tue, 02 Oct 2018 20:02:08 -0700
Message-ID: <02bc01d45ac5$7ae71a10$70b54e30$@augustcellars.com>
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
X-Mailer: Microsoft Outlook 16.0
Thread-Index: AQF+OZOBk6n1fKnGGQl4pCsbx09atqW5FyQw
Content-Language: en-us
X-Originating-IP: [192.168.0.11]
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/6BAUqv6aWoWfWexhCM33L9kjLe8>
Subject: Re: [xml2rfc-dev] RFC 7991 issue #21: 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: Wed, 03 Oct 2018 03:02:45 -0000


> -----Original Message-----
> From: xml2rfc-dev <xml2rfc-dev-bounces@ietf.org> On Behalf Of Henrik
> Levkowetz
> Sent: Monday, October 1, 2018 4:28 AM
> To: XML Developer List <xml2rfc-dev@ietf.org>
> Subject: [xml2rfc-dev] RFC 7991 issue #21: Schema Issue, RFC 7991, In Section
> 2.5.5, "name" Attribute
> 
> This captures an issue noted during implementation, also described in
> https://tools.ietf.org/html/draft-levkowetz-xml2rfc-v3-implementation#section-
> 3.1.1
> 
> Specification: https://tools.ietf.org/html/rfc7991#section-2.5.5
> 
> ---
> 
>       "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 have no problems with keeping this as "name" rather than "file".  There is not a great deal of difference to me.

I am worried about the rendering of the "name" parameter if present.  Is this going to be conditional on the presence of the <CODE BEGINS> rendering or is it done regardless.  I would like to be able to associate file names that are not rendered to the public as I generally chose those names that make sense if you read them.  Such as "Appendix.3.2.cddl"

Jim

> ---
> 
> Regards,
> 	Henrik
> 
> --
> This issue is tracked at:
>    https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/36
> 
> Discussion should take place on this list.