hcard-profile

From Microformats Wiki
Revision as of 10:08, 1 February 2007 by AndyMabbett (talk | contribs) (→‎Related Pages: profile-examples-in-wild)
Jump to navigation Jump to search

hCard Profile

The following is an XMDP profile for the hCard specification.

It's also available as http://www.w3.org/2006/03/hcard. See profile-uris for more details.

http://www.w3.org/2006/vcard/ns has roughly the same information with a different editorial style.

Usage

Profiles are referenced in (X)HTML files in the <HEAD> tag, e.g.:

<head profile='http://www.w3.org/2006/03/hcard'>

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 as a 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

Related Pages

The hCard specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. These thoughts, issues, and questions are kept in separate pages.