hcard-profile: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(note a newer profile document in progress)
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= hCard Profile =
{{DISPLAYTITLE:hCard Profile}}


The following is an [http://gmpg.org/xmdp/ XMDP] profile for the [[hcard|hCard]] specification.
The following is an [http://gmpg.org/xmdp/ XMDP] profile for the [[hcard|hCard]] specification.


It's also available as [http://www.w3.org/2006/03/hcard http://www.w3.org/2006/03/hcard].
== URLs ==
See [[profile-uris]] for more details.
This profile is hosted as a separate XMDP file on microformats.org:
* http://microformats.org/profile/hcard
* shortURL: http://ufs.cc/x/hcard


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 <code>&lt;head&gt;</code> tag, e.g.:
<source lang=html4strict>
<head profile='http://microformats.org/profile/hcard'>
</source>


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


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


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


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


   <dt>given-name</dt>
   <dt id="given-name">given-name</dt>
     <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-name</dt>
   <dt id="additional-name">additional-name</dt>
     <dd>See "Additional Names" in section 3.1.2 of RFC 2426.</dd>
     <dd>See "Additional Names" in section 3.1.2 of RFC 2426.</dd>


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


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


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


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


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


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


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


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


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


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


   <dt>country-name</dt>
   <dt id="country-name">country-name</dt>
     <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>type</dt>
   <dt id="type">type</dt>
     <dd>See "type" in the various sections of RFC 2426.</dd>
     <dd>See "type" in the various sections of RFC 2426.</dd>


   <dt>value</dt>
   <dt id="label">label</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>
     <dd>See section 3.2.2 of RFC 2426.</dd>


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


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


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


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


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


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


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


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


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


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


   <dt>agent</dt>
   <dt id="agent">agent</dt>
     <dd>See section 3.5.4 of RFC 2426. If the value is a vCard, then  
     <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  
     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>
     has the class name of "agent" should use the class name of "vcard".</dd>


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


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


   <dt>organization-unit</dt>
   <dt id="organization-unit">organization-unit</dt>
     <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>category</dt>
   <dt id="category">category</dt>
     <dd>See section 3.6.1 of RFC 2426.</dd>
     <dd>See section 3.6.1 of RFC 2426.</dd>


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


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


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


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


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


   <dt>url</dt>
   <dt id="url">url</dt>
     <dd>See section 3.6.8 of RFC 2426. Typically used with an &lt;a&gt; tag.
     <dd>See section 3.6.8 of RFC 2426. Typically used with an &lt;a&gt; tag.
     </dd>
     </dd>


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


   <dt>key</dt>
   <dt id="key">key</dt>
     <dd>See section 3.7.2 of RFC 2426. Typically used with an &lt;abbr&gt; tag  
     <dd>See section 3.7.2 of RFC 2426. Typically used with an &lt;abbr&gt; tag  
     with the 'title' attribute for the key value, and a human readable key
     with the 'title' attribute for the key value, and a human readable key
     equivalent inside the element.</dd>
     equivalent inside the element.</dd>
      
      
  <dt id="value">value</dt>
    <dd>This class name is used to distinguish the <em>actual</em> value
    of a property from any other cruft that may be in
    the containing element representing the property.
    See the
    <a href="http://microformats.org/wiki/value-class-pattern">
      value-class-pattern</a> for details.</dd>
  <dt id="value-title">value-title</dt>
    <dd>This class name is used to distinguish the <em>actual</em> value
    of a property, specifically in the 'title' attribute of the element,
    from the element contents and the element representing
    the containing property.
    See the
    <a href="http://microformats.org/wiki/value-class-pattern#Parsing_value_from_a_title_attribute">
      value-class-pattern value-title description</a> for details.</dd>
   </dl>
   </dl>
  </dd>
  </dd>
</dl>
</dl>
</pre>
</source>


== Deprecated ==
== Deprecated ==
Line 196: Line 214:
* type values:  
* type values:  
** dom, intl, postal, parcel, home, work, pref, msg, voice, fax, cell, video, pager, bbs, modem, car, isdn, pcs, internet, x400
** dom, intl, postal, parcel, home, work, pref, msg, voice, fax, cell, video, pager, bbs, modem, car, isdn, pcs, internet, x400
== Other versions ==
Previous versions of this profile on other sites:
* [http://www.w3.org/2006/03/hcard W3C 2006 hCard metadata profile]
Other similar profiles:
* [http://www.w3.org/2006/vcard/ns W3C vCard namespace]
== Related Pages ==
*[[profile-uris]]
*[[profile-uri-examples-in-wild|Profile URI examples, in the wild]]
{{hcard-related-pages}}

Latest revision as of 16:26, 18 July 2020


The following is an XMDP profile for the hCard specification.

URLs

This profile is hosted as a separate XMDP file on microformats.org:

Usage

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

<head profile='http://microformats.org/profile/hcard'>

Profile

<dl class="profile">
 <dt>class</dt>
 <dd><p>
  <a 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 rel="contents start" 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 id="vcard">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 id="fn">fn</dt>
    <dd>See section 3.1.1 of RFC 2426.</dd>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   <dt id="agent">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 id="org">org</dt>
    <dd>See section 3.5.5 of RFC 2426.</dd>

   <dt id="organization-name">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 id="organization-unit">organization-unit</dt>
    <dd>See "Organization Unit" in section 3.5.5 of RFC 2426.</dd>    

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

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

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

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

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

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

   <dt id="url">url</dt>
    <dd>See section 3.6.8 of RFC 2426. Typically used with an &lt;a&gt; tag.
    </dd>

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

   <dt id="key">key</dt>
    <dd>See section 3.7.2 of RFC 2426. Typically used with an &lt;abbr&gt; tag 
     with the 'title' attribute for the key value, and a human readable key
     equivalent inside the element.</dd>
     
   <dt id="value">value</dt>
    <dd>This class name is used to distinguish the <em>actual</em> value
     of a property from any other cruft that may be in 
     the containing element representing the property.
     See the 
     <a href="http://microformats.org/wiki/value-class-pattern"> 
      value-class-pattern</a> for details.</dd>

   <dt id="value-title">value-title</dt>
    <dd>This class name is used to distinguish the <em>actual</em> value
     of a property, specifically in the 'title' attribute of the element,
     from the element contents and the element representing 
     the containing property.
     See the 
     <a href="http://microformats.org/wiki/value-class-pattern#Parsing_value_from_a_title_attribute"> 
      value-class-pattern value-title description</a> for details.</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

Other versions

Previous versions of this profile on other sites:

Other similar profiles:

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.