Difference between revisions of "hcard-profile"

From Microformats Wiki
hcard-profile
Jump to navigation Jump to search
m (I couldn't find the 'page history' to revert the changes, so i just added the code back in that i removed)
m (deprecated plural names.)
Line 38: Line 38:
 
     <dd>See "Given Name" in section 3.1.2 of RFC 2426.</dd>
 
     <dd>See "Given Name" in section 3.1.2 of RFC 2426.</dd>
  
   <dt>additional-names</dt>
+
   <dt>additional-name</dt>
     <dd>See "Additional Names" in section 3.1.2 of RFC 2426
+
     <dd>See "Additional Names" in section 3.1.2 of RFC 2426.</dd>
    Typically used with &lt;ul&gt; or &lt;ol&gt; elements, with an &lt;li&gt;
 
    for each additional name.</dd>
 
  
   <dt>honorific-prefixes</dt>
+
   <dt>honorific-prefix</dt>
     <dd>See "Honorific Prefixes" in section 3.1.2 of RFC 2426.
+
     <dd>See "Honorific Prefixes" in section 3.1.2 of RFC 2426.</dd>
    Typically used with &lt;ul&gt; or &lt;ol&gt; elements, with an &lt;li&gt;
 
    for each honorific prefix.</dd>
 
  
   <dt>honorific-suffixes</dt>
+
   <dt>honorific-suffix</dt>
     <dd>See "Honorific Suffixes" in section 3.1.2 of RFC 2426.
+
     <dd>See "Honorific Suffixes" in section 3.1.2 of RFC 2426.</dd>
    Typically used with &lt;ul&gt; or &lt;ol&gt; elements, with an &lt;li&gt;
 
    for each honorific suffix.</dd>
 
 
    
 
    
 
   <dt>nickname</dt>
 
   <dt>nickname</dt>
Line 90: Line 84:
 
     <dd>See "country name" in section 3.2.1 of RFC 2426.</dd>
 
     <dd>See "country name" in section 3.2.1 of RFC 2426.</dd>
  
   <dt>dom</dt>
+
   <dt>type</dt>
  <dt>intl</dt>
+
     <dd>See "type" in the various sections of RFC 2426.</dd>
  <dt>postal</dt>
 
  <dt>parcel</dt>
 
     <dd>Use on an element inside an element with a class name of "adr",
 
    or "label" to indicate the type of the adr or label per the definitions of
 
    these types in section 3.2.1 and 3.2.2 respectively of RFC 2426.</dd>
 
  
   <dt>home</dt>
+
   <dt>value</dt>
  <dt>work</dt>
+
     <dd>This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property.</dd>
     <dd>Use on an element inside an element with a class name of "adr",
 
    "label", or "tel" to indicate the type of the adr, label, or tel per
 
    the definitions of these types in sections 3.2.1, 3.2.2, and 3.3.1
 
    respectively of RFC 2426.</dd>
 
 
 
  <dt>pref</dt>
 
    <dd>Use on an element inside an element with a class name of "adr",
 
    "label", "tel", or "email" to indicate the "pref" type of the adr,
 
    label, tel, or email per the definitions of "pref" in sections 3.2.1,
 
    3.2.2, 3.3.1, 3.3.2 respectively of RFC 2426.</dd>
 
  
 
   <dt>label</dt>
 
   <dt>label</dt>
Line 116: Line 95:
 
   <dt>tel</dt>
 
   <dt>tel</dt>
 
     <dd>See section 3.3.1 of RFC 2426.</dd>
 
     <dd>See section 3.3.1 of RFC 2426.</dd>
 
  <dt>msg</dt>
 
  <dt>voice</dt>
 
  <dt>fax</dt>
 
  <dt>cell</dt>
 
  <dt>video</dt>
 
  <dt>pager</dt>
 
  <dt>bbs</dt>
 
  <dt>modem</dt>
 
  <dt>car</dt>
 
  <dt>isdn</dt>
 
  <dt>pcs</dt>
 
    <dd>Use on an element inside an element with a class name of "tel" to
 
    indicate the type of the tel per the definitions of these
 
    types in section 3.3.1 of RFC 2426.</dd>
 
  
 
   <dt>email</dt>
 
   <dt>email</dt>
 
     <dd>See section 3.3.2 of RFC 2426.</dd>
 
     <dd>See section 3.3.2 of RFC 2426.</dd>
 
  <dt>internet</dt>
 
  <dt>x400</dt>
 
    <dd>Use on an element inside an element with a class name of "email" to
 
    indicate the type of the email per the definitions of these
 
    types in section 3.3.2 of RFC 2426.</dd>
 
  
 
   <dt>mailer</dt>
 
   <dt>mailer</dt>
Line 184: Line 142:
 
     <dd>See "Organization Unit" in section 3.5.5 of RFC 2426.</dd>     
 
     <dd>See "Organization Unit" in section 3.5.5 of RFC 2426.</dd>     
  
   <dt>categories</dt>
+
   <dt>category</dt>
     <dd>See section 3.6.1 of RFC 2426. Typically used with an &lt;ul&gt; tag.
+
     <dd>See section 3.6.1 of RFC 2426.</dd>
    Thus individual categories should be marked up with &lt;li&gt; tags.</dd>
 
  
 
   <dt>note</dt>
 
   <dt>note</dt>
Line 222: Line 179:
 
</dl>
 
</dl>
 
</pre>
 
</pre>
 +
 +
== Deprecated ==
 +
 +
2005-09-16:
 +
 +
The following class names have been deprecated in favor of singular names and the use of the "type" sub-property rather than class names for all of its values.  hCard publishers MUST NOT use them aa class name.
 +
* plurals:
 +
** additional-names, honorific-prefixes, honorific-suffixes, categories
 +
* type values:
 +
** dom, intl, postal, parcel, home, work, pref, msg, voice, fax, cell, video, pager, bbs, modem, car, isdn, pcs, internet, x400

Revision as of 08:50, 18 September 2005

hCard Profile

The following is an XMDP profile for the hCard specification.

Profile

<dl class="profile">
 <dt>class</dt>
 <dd><p>
  <a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
   HTML4 definition of the 'class' attribute.</a>
  This meta data profile defines some 'class' attribute values (class names) 
  and their meanings as suggested by a 
  <a href="http://www.w3.org/TR/WD-htmllink-970328#profile">
   draft of "Hypertext Links in HTML"</a>.
  All values are defined according to the semantics defined in the 
  <a href="http://microformats.org/wiki/hcard">
   hCard specification</a> 
  and thus in 
  <a href="http://www.ietf.org/rfc/rfc2426.txt">RFC 2426</a>.</p>
  <dl>
   <dt>vcard</dt>
    <dd>A container for the rest of the class names defined in this XMDP profile.
     See section 1. of RFC 2426.
    </dd>

   <dt>fn</dt>
    <dd>See section 3.1.1 of RFC 2426.</dd>

   <dt>n</dt>
    <dd>See section 3.1.2 of RFC 2426. May be inferred per 
      Implied "N" Optimization.</dd>

   <dt>family-name</dt>
    <dd>See "Family Name" in section 3.1.2 of RFC 2426.</dd>

   <dt>given-name</dt>
    <dd>See "Given Name" in section 3.1.2 of RFC 2426.</dd>

   <dt>additional-name</dt>
    <dd>See "Additional Names" in section 3.1.2 of RFC 2426.</dd>

   <dt>honorific-prefix</dt>
    <dd>See "Honorific Prefixes" in section 3.1.2 of RFC 2426.</dd>

   <dt>honorific-suffix</dt>
    <dd>See "Honorific Suffixes" in section 3.1.2 of RFC 2426.</dd>
   
   <dt>nickname</dt>
    <dd>See section 3.1.3 of RFC 2426.</dd>

   <dt>photo</dt>
    <dd>See section 3.1.4 of RFC 2426. Typically used with an <img> tag.
     Use the 'src' attribute for URI values. Use the 'data:' URI scheme for
     binary values.</dd>

   <dt>bday</dt>
    <dd>See section 3.1.5 of RFC 2426. Typically used with an <abbr> tag 
     with the 'title' attribute for the date value, and a human readable date
     inside the element.</dd>
 
   <dt>adr</dt>
    <dd>See section 3.2.1 of RFC 2426.</dd>

   <dt>post-office-box</dt>
    <dd>See "post office box" in section 3.2.1 of RFC 2426.</dd>

   <dt>extended-address</dt>
    <dd>See "extended address" in section 3.2.1 of RFC 2426.</dd>

   <dt>street-address</dt>
    <dd>See "street address" in section 3.2.1 of RFC 2426.</dd>

   <dt>locality</dt>
    <dd>See "locality" in section 3.2.1 of RFC 2426.</dd>

   <dt>region</dt>
    <dd>See "region" in section 3.2.1 of RFC 2426.</dd>

   <dt>postal-code</dt>
    <dd>See "postal code" in section 3.2.1 of RFC 2426.</dd>

   <dt>country-name</dt>
    <dd>See "country name" in section 3.2.1 of RFC 2426.</dd>

   <dt>type</dt>
    <dd>See "type" in the various sections of RFC 2426.</dd>

   <dt>value</dt>
    <dd>This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property.</dd>

   <dt>label</dt>
    <dd>See section 3.2.2 of RFC 2426.</dd>

   <dt>tel</dt>
    <dd>See section 3.3.1 of RFC 2426.</dd>

   <dt>email</dt>
    <dd>See section 3.3.2 of RFC 2426.</dd>

   <dt>mailer</dt>
    <dd>See section 3.3.3 of RFC 2426.</dd>

   <dt>tz</dt>
    <dd>See section 3.4.1 of RFC 2426. Typically used with an <abbr> tag 
     with the 'title' attribute for the tz value, and a human readable time zone
     inside the element.</dd>

   <dt>geo</dt>
    <dd>See section 3.4.2 of RFC 2426.</dd>

   <dt>latitude</dt>
    <dd>See "latitude" in section 3.4.2 of RFC 2426.</dd>

   <dt>longitude</dt>
    <dd>See "longitude" in section 3.4.2 of RFC 2426.</dd>

   <dt>title</dt>
    <dd>See section 3.5.1 of RFC 2426.</dd>

   <dt>role</dt>
    <dd>See section 3.5.2 of RFC 2426.</dd>

   <dt>logo</dt>
    <dd>See section 3.5.3 of RFC 2426. Typically used with an <img> tag.
     Use the 'src' attribute for URI values. Use the 'data:' URI scheme for
     binary values.</dd>

   <dt>agent</dt>
    <dd>See section 3.5.4 of RFC 2426. If the value is a vCard, then 
    use a nest hCard.  For simplicity in that case, the same element that 
    has the class name of "agent" should use the class name of "vcard".</dd>

   <dt>org</dt>
    <dd>See section 3.5.5 of RFC 2426.</dd>

   <dt>organization-name</dt>
    <dd>See "Organization Name" in section 3.5.5 of RFC 2426. 
      May be inferred per Implied "organization-name" Optimization.</dd>

   <dt>organization-unit</dt>
    <dd>See "Organization Unit" in section 3.5.5 of RFC 2426.</dd>    

   <dt>category</dt>
    <dd>See section 3.6.1 of RFC 2426.</dd>

   <dt>note</dt>
    <dd>See section 3.6.2 of RFC 2426.</dd>

   <dt>rev</dt>
    <dd>See section 3.6.4 of RFC 2426. Typically used with an <abbr> tag 
     with the 'title' attribute for the date value, and a human readable date
     inside the element.</dd>

   <dt>sort-string</dt>
    <dd>See section 3.6.5 of RFC 2426.</dd>

   <dt>sound</dt>
    <dd>See section 3.6.6 of RFC 2426. Typically used with either an <a>
     or <object> tag. Use the 'data:' URI scheme for binary values.</dd>

   <dt>uid</dt>
    <dd>See section 3.6.7 of RFC 2426.</dd>

   <dt>url</dt>
    <dd>See section 3.6.8 of RFC 2426. Typically used with an <a> tag.
    </dd>

   <dt>class</dt>
    <dd>See section 3.7.1 of RFC 2426.</dd>

   <dt>key</dt>
    <dd>See section 3.7.2 of RFC 2426. Typically used with an <abbr> tag 
     with the 'title' attribute for the key value, and a human readable key
     equivalent inside the element.</dd>
     
  </dl>
 </dd>
</dl>

Deprecated

2005-09-16:

The following class names have been deprecated in favor of singular names and the use of the "type" sub-property rather than class names for all of its values. hCard publishers MUST NOT use them aa class name.

  • plurals:
    • additional-names, honorific-prefixes, honorific-suffixes, categories
  • type values:
    • dom, intl, postal, parcel, home, work, pref, msg, voice, fax, cell, video, pager, bbs, modem, car, isdn, pcs, internet, x400