vcard-errata: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(created and noted the inconsistency/mistake about dropping CHARSET and noted changes to clearly keep it in.)
 
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= vCard errata =
{{DISPLAYTITLE: vCard errata }}


In the development of [[hcard|hCard]] and proxies like X2V, we have discovered various details of RFC 2426 vCard that appear to be mistakes.  Thus we are documenting them here as we find them, organized by RFC 2426 section number.
In the development of [[hcard|hCard]] and proxies like X2V, we have discovered various details of [[RFC2426]] vCard that appear to be mistakes.  Thus we are documenting them here as we find them, organized by [[RFC2426]] section number.
 
== Author(s) ==
* Tantek Çelik


; Editor: Tantek Çelik


== Errata ==
== Errata ==
Line 11: Line 9:
=== 2.2 Predefined Type Parameter Usage ===
=== 2.2 Predefined Type Parameter Usage ===


# 2005-11-24 by [http://tantek.com/log/ Tantek Çelik]
# 2005-11-24 by [http://tantek.com/ Tantek Çelik]


Just after this block:
Just after this block:
Line 32: Line 30:
</nowiki></pre>
</nowiki></pre>


=== 3.6.7 UID Type Definition ===
# 2007-09-08 by [http://tantek.com/ Tantek Çelik] based on [http://microformats.org/wiki?title=uid&diff=21212&oldid=21211 issue raised by Andy Mabbett 11:10, 7 Sep 2007].
[[RFC2426]] says [note inserted text for clarification].
<pre><nowiki>
  The [UID] type can include the type parameter "TYPE" to specify the format
  of the identifier. The TYPE parameter value should be an IANA
  registered identifier format. The value can also be a non-standard
  format.
</nowiki></pre>
Note that a search of the IANA website as of 11:10, 7 Sep 2007 finds no occurrences of "identifier format", therefore there is no way to comply with the "should" sentence in the above-quoted portion of section 3.6.7.  Since the statement is only a "should", thus content {{may}} ignore it, and there is no way to comply with the "should",  the simplest errata is to drop the impossible "should" statement, and remove the word "also" from the following sentence, as follows:
<pre><nowiki>
  The [UID] type can include the type parameter "TYPE" to specify the format
  of the identifier. The value can be a non-standard format.
</nowiki></pre>
# 2008-01-14 by [http://PetesGuide.com/ Peter Sheerin]
I too have failed to find any reference to "registered itentifier format", and believe that sentence was intended to indicate that any IANA (MIME type) type of identifier, whereas most of the types referenced in the RFC are confined to one branch (image for photo and logo, audio for sound, etc.). However, I can find no obvious IANA MIME type appropriate for a UID. There is an RFC for a UUID, however. RFC 4122 describes the procedure for generating a globally unique 128-bit UID, using time, MAC address, and a few other things. Perhaps vCard should reference this?


=== 5.  Differences From vCard v2.1 ===
=== 5.  Differences From vCard v2.1 ===


# 2005-11-24 by [http://tantek.com/log/ Tantek Çelik]
# 2005-11-24 by [http://tantek.com/ Tantek Çelik]  


RFC 2426 says:
[[RFC2426]] says:


<pre><nowiki>
<pre><nowiki>
Line 45: Line 66:
</nowiki></pre>
</nowiki></pre>


We believe this to have been a mistake, note in particular that section 1. of RFC 2426 explicitly states that the CHARSET parameter is one of the "Predefined MIME Directory parameters" that is "used".  We believe that statement in section 1. of RFC 2426 to be '''correct'''.
We believe this to have been a mistake, note in particular that section 1. of [[RFC2426]] explicitly states that the CHARSET parameter is one of the "Predefined MIME Directory parameters" that is "used".  We believe that statement in section 1. of [[RFC2426]] to be '''correct'''.


The most obvious proof of why this is needed is when a vCard .vcf file is stored on and retrieved from  a local file-system, you obviously cannot depend on the Content-Type MIME (or HTTP) header field, nor can you assume that the operating system will keep character set metadata about the file in some other location.
The most obvious proof of why this is needed is when a vCard .vcf file is stored on and retrieved from  a local file-system, you obviously cannot depend on the Content-Type MIME (or HTTP) header field, nor can you assume that the operating system will keep character set metadata about the file in some other location.
Line 53: Line 74:
# delete the above quoted bullet item from section 5.
# delete the above quoted bullet item from section 5.
# make the change to section 2.2 as noted above.
# make the change to section 2.2 as noted above.
== external resources ==
* [http://www.imc.org/imc-vcard/ vCard mailing list] - a place to raise these issues, and where similar issues can be found.
== See Also ==
* [[vcard-suggestions]]
* [[vcard-implementations]]
* [[vCard4]]
* [[hcard|hCard]]

Latest revision as of 16:34, 18 July 2020


In the development of hCard and proxies like X2V, we have discovered various details of RFC2426 vCard that appear to be mistakes. Thus we are documenting them here as we find them, organized by RFC2426 section number.

Editor
Tantek Çelik

Errata

2.2 Predefined Type Parameter Usage

  1. 2005-11-24 by Tantek Çelik

Just after this block:

   The vCard MIME Directory Profile uses the following predefined type
   parameters as defined by [MIME-DIR].

insert this:

        - CHARSET


just before this:

        - LANGUAGE


3.6.7 UID Type Definition

  1. 2007-09-08 by Tantek Çelik based on issue raised by Andy Mabbett 11:10, 7 Sep 2007.

RFC2426 says [note inserted text for clarification].

   The [UID] type can include the type parameter "TYPE" to specify the format
   of the identifier. The TYPE parameter value should be an IANA
   registered identifier format. The value can also be a non-standard
   format.

Note that a search of the IANA website as of 11:10, 7 Sep 2007 finds no occurrences of "identifier format", therefore there is no way to comply with the "should" sentence in the above-quoted portion of section 3.6.7. Since the statement is only a "should", thus content MAY ignore it, and there is no way to comply with the "should", the simplest errata is to drop the impossible "should" statement, and remove the word "also" from the following sentence, as follows:

   The [UID] type can include the type parameter "TYPE" to specify the format
   of the identifier. The value can be a non-standard format.
  1. 2008-01-14 by Peter Sheerin

I too have failed to find any reference to "registered itentifier format", and believe that sentence was intended to indicate that any IANA (MIME type) type of identifier, whereas most of the types referenced in the RFC are confined to one branch (image for photo and logo, audio for sound, etc.). However, I can find no obvious IANA MIME type appropriate for a UID. There is an RFC for a UUID, however. RFC 4122 describes the procedure for generating a globally unique 128-bit UID, using time, MAC address, and a few other things. Perhaps vCard should reference this?

5. Differences From vCard v2.1

  1. 2005-11-24 by Tantek Çelik

RFC2426 says:

        . The [VCARD] CHARSET type parameter has been eliminated.
          Character set can only be specified on the CHARSET parameter
          on the Content-Type MIME header field.

We believe this to have been a mistake, note in particular that section 1. of RFC2426 explicitly states that the CHARSET parameter is one of the "Predefined MIME Directory parameters" that is "used". We believe that statement in section 1. of RFC2426 to be correct.

The most obvious proof of why this is needed is when a vCard .vcf file is stored on and retrieved from a local file-system, you obviously cannot depend on the Content-Type MIME (or HTTP) header field, nor can you assume that the operating system will keep character set metadata about the file in some other location.

Thus it is critical that the CHARSET parameter be reused from MIME-DIR. This requires:

  1. delete the above quoted bullet item from section 5.
  2. make the change to section 2.2 as noted above.

external resources

  • vCard mailing list - a place to raise these issues, and where similar issues can be found.

See Also