[rpat] Media types as soucecode for incomplete examples? - Fwd: AUTH48: RFC-to-be 9555 <draft-ietf-calext-jscontact-vcard-13> for your review

Sandy Ginoza <sginoza@amsl.com> Fri, 05 April 2024 18:48 UTC

Return-Path: <sginoza@amsl.com>
X-Original-To: rpat@ietfa.amsl.com
Delivered-To: rpat@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 1F760C151086 for <rpat@ietfa.amsl.com>; Fri, 5 Apr 2024 11:48:35 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.197
X-Spam-Level:
X-Spam-Status: No, score=-4.197 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_PASS=-0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
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 EPeH53Hl4xw8 for <rpat@ietfa.amsl.com>; Fri, 5 Apr 2024 11:48:31 -0700 (PDT)
Received: from c8a.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 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 4F2CAC14F61D for <rpat@rfc-editor.org>; Fri, 5 Apr 2024 11:48:31 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 35ACA424B432; Fri, 5 Apr 2024 11:48:31 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id TV7aAF1uE3xX; Fri, 5 Apr 2024 11:48:31 -0700 (PDT)
Received: from smtpclient.apple (172-113-155-155.res.spectrum.com [172.113.155.155]) by c8a.amsl.com (Postfix) with ESMTPSA id 0A615424B427; Fri, 5 Apr 2024 11:48:31 -0700 (PDT)
From: Sandy Ginoza <sginoza@amsl.com>
Content-Type: multipart/alternative; boundary="Apple-Mail=_97BA629E-7208-437A-8CFD-45E79DCFCDE9"
Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.120.0.1.13\))
Date: Fri, 05 Apr 2024 11:47:25 -0700
References: <84f1813c-8bf6-4206-a5b3-349fc6560ed1@app.fastmail.com>
Cc: Karen Moore <kmoore@amsl.com>
To: rpat <rpat@rfc-editor.org>
Message-Id: <FC5E05B9-DE2A-4709-8241-EC60A9E7CC39@amsl.com>
X-Mailer: Apple Mail (2.3654.120.0.1.13)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rpat/ilVSJe8hK3OMittLn3qtjF38Gec>
Subject: [rpat] Media types as soucecode for incomplete examples? - Fwd: AUTH48: RFC-to-be 9555 <draft-ietf-calext-jscontact-vcard-13> for your review
X-BeenThere: rpat@rfc-editor.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: RFC Production Advisory Team - Provides operational advice to the RFC Production Center <rpat.rfc-editor.org>
List-Unsubscribe: <https://mailman.rfc-editor.org/mailman/options/rpat>, <mailto:rpat-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rpat/>
List-Post: <mailto:rpat@rfc-editor.org>
List-Help: <mailto:rpat-request@rfc-editor.org?subject=help>
List-Subscribe: <https://mailman.rfc-editor.org/mailman/listinfo/rpat>, <mailto:rpat-request@rfc-editor.org?subject=subscribe>
X-List-Received-Date: Fri, 05 Apr 2024 18:48:35 -0000

Hi,

We recently started allowing media types to be listed as sourcecode types.  Do you have an opinion on whether the specific media type should be used for incomplete examples?  For RFC-to-be 9555, we are discussing whether it is more appropriate to use “text/vcard” vs “text/plain” for partial vCard text.  Here are some examples from the document: 

            <sourcecode type="text/vcard"><![CDATA[                                          
item1.TEL;VALUE=uri:tel:+1-555-555-5555                                                      
]]></sourcecode>

            <sourcecode type="text/vcard"><![CDATA[                                          
FN;LANGUAGE=EN:John Doe                                                                      
TITLE;ALTID=1;LANGUAGE=EN:Boss                                                               
TITLE;ALTID=1;LANGUAGE=fr:Patron                                                             
]]></sourcecode>

Please see the discussion below.  I think text/plain is a default, but it seemingly provides less information to the user than specifying text/vcard.  Am I understanding this correctly?

RFC-to-be is currently in AUTH48.  Your an view the files here: 
https://www.rfc-editor.org/authors/rfc9555.html
https://www.rfc-editor.org/authors/rfc9555.xml 

Thanks,
Sandy 



> Begin forwarded message:
> 
> From: Robert Stepanek <rsto=40fastmailteam.com@dmarc.ietf.org>
> Subject: Re: AUTH48: RFC-to-be 9555 <draft-ietf-calext-jscontact-vcard-13> for your review
> Date: April 5, 2024 at 2:10:09 AM PDT
> To: "Karen Moore" <kmoore@amsl.com>, "Orie Steele" <orie@transmute.industries>, "Murray S. Kucherawy" <superuser@gmail.com>, "Mario Loffredo" <mario.loffredo@iit.cnr.it>
> Cc: rfc-editor <rfc-editor@rfc-editor.org>, calext-ads@ietf.org, calext-chairs@ietf.org, "Daniel Migault" <mglt.ietf@gmail.com>, auth48archive <auth48archive@rfc-editor.org>
> 
> Hi Karen, Orie,
> 
> On Thu, Apr 4, 2024, at 11:29 PM, Karen Moore wrote:
>> > [OS] Thanks for making this change, in case "text/vcard" is rejected (for some tooling reason) "text/plain" would also work... in fact it may be more appropriate if the source code is not a fully valid vcard in text serialization... Is it valid?
>> 

[snip]

> The examples contain only partial vCard text, so strictly speaking "text/vcard" is not appropriate. If that is an issue, "text/plain" is equally fine.
> 
>> 
>> > NEW:
>> >    The PREF parameter (Section 5.3 of [RFC6350]) converts to the pref
>> >    property of the derived JSContact object.
>> 
>> 
>> Please consider if any updates are needed to this similar sentence that follows in Section 2.3.18:
>> 
>>   The PROP-ID parameter (Section 4.7 of [RFC9554]) converts to the Id-
>>    typed key of the JSContact object, to which the vCard property having
>>    this parameter converts.
> 
> I think Orie's suggestion for the PREF parameter is great, and I kindly ask you to apply it also to the PROP-ID definition.
> 
> Thanks,
> Robert