Search

# hCard

hCard is a simple, open, distributed format for representing people, companies, organizations, and places, using a 1:1 representation of vCard (RFC2426) properties and values in semantic HTML or XHTML. hCard is one of several open microformat standards suitable for embedding in HTML, XHTML, Atom, RSS, and arbitrary XML.

Want to get started with writing an hCard? Use the hCard creator to write up some contact information and publish it, or follow the hCard authoring tips to add hCard markup to your current contact page.

## Specification

Editor
  Tantek Çelik (http://tantek.com/, and before at Technorati, Inc., and at Microsoft Corporation)

Authors
  Tantek Çelik (affiliations above)
  Brian Suda (http://suda.co.uk/)

Acknowledgments
  See acknowledgments.

copyright and patents statements apply.

## Introduction

The vCard standard (RFC2426), has been broadly interoperably implemented (e.g. Apple's "Address Book" application built into MacOSX).

In addition, many bloggers identify themselves by name and discuss their friends and family. With just a tad bit of structure, bloggers can discuss people in their blog(s) in such a way that spiders and other aggregators can retrieve this information, automatically convert them to vCards, and use them in any vCard application or service.

This specification introduces the hCard format, which uses a 1:1 representation of the properties and values of the aforementioned vCard standard, in semantic HTML. Bloggers can both embed hCards directly in their web pages, and style them with CSS to make them appear as desired. In addition, hCard enables applications to retrieve information directly from web pages without having to reference a separate file.

Use the hCard creator and copy the HTML code it generates to your blog or website to publish your contact info.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

## Format

### In General

The vCard standard (RFC2426) forms the basis of hCard.

The basic format of hCard is to use vCard object/property names in lower-case for class names, and to map the nesting of vCard objects directly into nested HTML elements.

### Root Class Name

The root class name for an hCard is "vcard". An element with a class name of "vcard" is itself called an hCard.

### Properties and Sub-properties

The properties of an hCard are represented by elements inside the hCard. Elements with class names of the listed properties represent the values of those properties. Some properties have sub-properties, and those are represented by elements inside the elements for properties.

### Property List

hCard properties (sub-properties in parentheses like this)

Required:

- fn
- n1 (family-name, given-name, additional-name, honorific-prefix, honorific-suffix)

Optional:

- nickname, sort-string
- url, email (type, value), tel2 (type, value)
- adr (post-office-box, extended-address, street-address, locality, region, postal-code, country-name, type, value), label
- geo (latitude, longitude), tz
- photo, logo, sound, bday
- title, role, org (organization-name, organization-unit)
- category, note
- class, key, mailer, uid, rev

### Property Notes

1. ^: The 'n' property is OPTIONAL if any implied 'n' optimization rules are in effect.
2. ^: tel - Authors MAY follow the E.123 standard for writing values of telephone numbers. Letter values (e.g. +1-555-FORMATS) MUST be converted to numbers. Use an `abbr` to display letters and provide a numerical value simultaneously, e.g. `<abbr title="+15553676287">+1-555-FORMATS</abbr>`.

### Singular vs. Plural Properties

Singular properties: 'fn', 'n', 'bday', 'tz', 'geo', 'sort-string', 'uid', 'class'. For properties which are singular, the first descendant element with that class SHOULD take effect, any others being ignored.

All other properties MAY be plural. Each class instance of such properties creates a new instance of that property.

### Human vs. Machine readable

The human visible text contents of an element for a property represents the value of that property, with a few exceptions:

If an `<abbr>` element is used for a property, then the '`title`' attribute (if present) of the `<abbr>` element is the value of the property, instead of the contents of the element, which instead provide a more human presentable version of the value.

If an `<a>` element is used for one or more properties, it MUST be treated as follows:

1. For the 'photo' property and any other property that takes a URL as its value, the `href="..."` attribute provides the property value.
2. For other properties, the element's content is the value of the property.

If an `<img>` element is used for one or more properties, it MUST be treated as follows:

1. For the 'photo' property and any other property that takes a URL as its value, the `src="..."` attribute provides the property value.
2. For other properties, the `<img>` element's '`alt`' attribute is the value of the property.

If an `<object>` element is used for one or more properties, it MUST be treated as follows:

1. For the 'photo' property and any other property that takes a URL as its value, the `data="..."` attribute provides the property value.
2. For other properties, the element's content is the value of the property.

### Value excerpting

Sometimes only part of an element which is the equivalent for a property is used for the value of the property. This typically occurs when a property has a subtype, like 'tel'. For this purpose, the special class name "`value`" is used to excerpt out the subset of the element that is the value of the property. E.g. here is an hCard fragment for marking up a home phone number:

vCard:

    TEL;TYPE=HOME:+1.415.555.1212

hCard:

    <span class="tel">
     <span class="type">home</span>:
     <span class="value">+1.415.555.1212</span>
    </span>

This hCard fragment could be displayed as:

home: +1.415.555.1212

### Property Exceptions

vCard has several properties which either do not make sense on, or are already implied within the context of a web page. This section explains what to (not) do with them.

1. vCard's NAME, PROFILE, SOURCE, PRODID, VERSION properties are defined in Sections 2.1.2, 2.1.3, 2.1.4, 3.6.3, 3.6.9 of RFC2426. Content publishers MUST NOT use these properties in their hCards, and as such, hCard consumers/parsers MUST IGNORE these properties if they are found within an hCard. Instead. hCard to vCard converters SHOULD use the title of the page where the hCard is found (e.g. the `<title>` element in HTML documents) to construct the NAME property, MAY output a PROFILE value of "`VCARD`" per RFC2426, SHOULD use the URL of the page where the hCard is found to construct the SOURCE property (e.g. perhaps as a parameter to a URL/service that converts hCards to vCards), for an output vCard stream (e.g. a .vcf file). Only services/applications that output actual vCards should write the PRODID property, with the product identifier for said service/application. Similarly, only such services/applications should write the VERSION property, with the value "3.0" (without quotes) per RFC2426 Section 3.6.9.

### Organization Contact Info

If the "FN" and "ORG" properties have the exact same value (typically because they are set on the same element, e.g. class="fn org"), then the hCard represents contact information for a company, organization or place and SHOULD be treated as such. In this case the author also MUST NOT set the "N" property, or set it (and any sub-properties) explicitly to the empty string "". Thus parsers SHOULD handle the missing "N" property, in this case by implying empty values for all the "N" sub-properties.

### Implied "n" Optimization

Although vCard requires that the "N" property be present, the authors of the vCard specification (RFC2426) themselves do not include "N" properties in their vCards near the end of the spec (p.38). This apparent contradiction can be resolved by simply allowing the "FN" property to imply "N" property values in typical cases provided in the spec. We do so explicitly in hCard.

If "FN" and "ORG" are not the same (see previous section), and the value of the "FN" property is exactly two words (separated by whitespace), and there is no explicit "N" property, then the "N" property is inferred from the "FN" property. For "FN"s with either one word see below, and for three or more, the author MUST explicitly markup the "N", except for the organization contact info case, see above for that.

1. The content of "FN" is broken into two "words" separated by whitespace.
2. The first word of the "FN" is interpreted as the "given-name" for the "N" property.
3. The second/last word of the "FN" is interpreted as the "family-name" for the "N" property.
4. Exception: If the first word ends in a "," comma OR if the second word is a single character (optionally followed by a period "."), then the first word (minus the comma at the end if any) is interpreted as the "family-name" and the second word is interpreted as the "given-name".

This allows simplification in the typical case of people stating:

- given-name (space) family-name
- family-name (comma) given-name
- family-name (comma) given-name-first-initial
- family-name (space) given-name-first-initial (optional period)

### Implied "nickname" Optimization

Due to the prevalence of the use of nicknames/handles/usernames in actual content published on the Web (e.g. authors of reviews), hCard also has an implied "nickname" optimization to handle this.

Similar to the implied "n" optimization, if "FN" and "ORG" are not the same, and the value of the "FN" property is exactly one word, and there is no explicit "N" property, then:

1. The content of the "FN" MUST be treated as a "nickname" property value.
2. Parsers SHOULD handle the missing "N" property by implying empty values for all the "N" sub-properties.

Though parsers MUST follow the implied nickname optimization, publishers SHOULD explicitly indicate the "nickname" even in this case, e.g.:

    <span class="vcard">
     <span class="fn nickname">daveman692</span>
    </span>

The hCard MAY have additional explicit "nickname" property values in addition to the implied nickname.

### Implied "organization-name" Optimization

The "ORG" property has two subproperties, organization-name and organization-unit. Very often authors only publish the organization-name. Thus if an "ORG" property has no "organization-name" inside it, then its entire contents MUST be treated as the "organization-name".

### Tags as Categories

Categories in hCard MAY be represented by tags with rel-tag. When a category property is a rel-tag, the tag (as defined by rel-tag) is used for that category.

### type subproperty values

The 'type' subproperty in particular takes different values depending on which property it is a subproperty of. These 'type' subproperty values are case-INSENSITIVE, meaning "Home" is the same as "home", as well as multivalued, e.g. a tel can be home and preferred:

vCard:

    TEL;TYPE=HOME,PREF:+1.415.555.1212

hCard:

    <span class="tel"><span class="type">Home</span> (<span class="type">pref</span>erred):
     <span class="value">+1.415.555.1212</span>
    </span>

This could be displayed as:

Home (preferred): +1.415.555.1212

#### type with unspecified value

When the type of a property is specified, and there is no explicit value specified, then everything in the property except for the type is considered the value of the property. E.g.

    <span class="tel"><span class="type">Home</span> +1.415.555.1212</span>

is equivalent to:

    <span class="tel"><span class="type">Home</span><span class="value"> +1.415.555.1212</span></span>

And thus the type is "home" and the value is "+1.415.555.1212".

#### adr tel email types

The following lists are informative. See RFC2426 sections 3.2.1 ADR, 3.3.1 TEL, and 3.3.2 EMAIL respectively for normative type values. They are repeated here for convenience. Default type subproperty value(s) is(are) first in each list and indicated in ALL CAPS. types may be multivalued.

- adr type: INTL, POSTAL, PARCEL, WORK, dom, home, pref
- tel type: VOICE, home, msg, work, pref, fax, cell, video, pager, bbs, modem, car, isdn, pcs
- email type: INTERNET, x400, pref, "other IANA registered address types"

### XMDP Profile

See hcard-profile for the XMDP profile of hCard which contains the above complete list of properties, with references to their RFC2426 definitions.

### Parsing Details

See hCard parsing.

## Examples

This section is informative.

### Sample vCard

Here is a sample vCard:

    BEGIN:VCARD
    VERSION:3.0
    N:Çelik;Tantek
    FN:Tantek Çelik
    URL:http://tantek.com/
    END:VCARD

and an equivalent in hCard with various elements optimized appropriately. See hCard Example 1 for the derivation.

    <div class="vcard">
     <a class="url fn" href="http://tantek.com/">Tantek Çelik</a>
    </div>

This hCard might be displayed as:

Tantek Çelik

Note: The version information is unnecessary in hCard markup directly since the version will be defined by the profile of hCard that is used/referred to in the 'profile' attribute of the <head> element.

### Live example

Here is Commercenet's contact details, as a live hCard which will be detected, on this page, by microformat parsing tools:

CommerceNet
http://www.commerce.net/
Work:
169 University Avenue

Palo Alto, CA 94301

USA
Work +1-650-289-4040
Fax +1-650-289-4041
Email info@commerce.net

The mark-up, emboldening omitted for clarity, with the following semantic improvements:

- `abbr` to expand abbreviations
- hyperlinking the org name with the url

    <div class="vcard">
      <a class="fn org url" href="http://www.commerce.net/">CommerceNet</a>
      <div class="adr">
        <span class="type">Work</span>:
        <div class="street-address">169 University Avenue</div>
        <span class="locality">Palo Alto</span>,
        <abbr class="region" title="California">CA</abbr>
        <span class="postal-code">94301</span>
        <div class="country-name">USA</div>
      </div>
      <div class="tel">
       <span class="type">Work</span> +1-650-289-4040
      </div>
      <div class="tel">
        <span class="type">Fax</span> +1-650-289-4041
      </div>
      <div>Email:
       <span class="email">info@commerce.net</span>
      </div>
    </div>

### More Examples

See hCard examples for more examples, including all examples from vCard RFC2426 converted into hCard.

## Buttons

You can use these buttons on pages with hCards. See buttons#hCard for any recent additions.

- (mirror: )
- CSS-powered button, as evidenced at microformat badges @ re-run

## Examples in the wild

This section is informative. The number of hCard examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a separate page.

See hCard Examples in the wild.

## Implementations

This section is informative. The number of hCard implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a separate page.

See hCard Implementations.

## Copyright

Per the public domain release on the authors' user pages (Tantek Çelik, Brian Suda) this specification is released into the public domain.

Public Domain Contribution Requirement. Since the author(s) released this work into the public domain, in order to maintain this work's public domain status, all contributors to this page agree to release their contributions to this page to the public domain as well. Contributors may indicate their agreement by adding the public domain release template to their user page per the Voluntary Public Domain Declarations instructions. Unreleased contributions may be reverted/removed.

## Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

## References

### Normative References

- XHTML 1.0 SE
- vCard RFC2426
- ITU recommendation E.123 format of telephone numbers (chargeable document)
- RFC 2119

### Informative References

- hCard history
  - FOO Camp 2004 Simple Semantic Formats presentation, 2004-09-10
  - hCard term introduced and defined on the Web, 2004-09-30
  - Contributed from http://developers.technorati.com/wiki/hCard 2005-06-20
- X.520 in Postscript (HTMLization courtesy of Google Cache) - vCard refers to ROLE as being "based on the X.520 Business Category explanatory attribute".
- HTML reformatted version of RFC2426
- CSS1
- XHTML 1.1
- Wikipedia summary of ITU-T Recommendation E.123 - for "TEL" values.
- Internet Mail Consortium Personal Data Interchange vCard and vCalendar
- ISO8601

#### Specifications That Use hCard

- adr
- geo
- hCalendar
- hReview

#### Similar Work

- Atom PaceBetterPersonElement
- JEP-0054: vcard-temp

## Inspiration and Acknowledgments

Thanks to: my good friend Vadim who introduced me to vCard many years ago, and if I'd only paid more attention then, perhaps I could have helped a lot of people avoid wasting a lot of time reinventing various standards wheels.

## Notes on derivation from vCard

This section is informative.

See: hcard-design-methodology.

### More Semantic Equivalents

For some properties there are HTML elements which better match and convey their semantics. The following properties SHOULD be encoded with the following HTML:

- `URL` in vCard becomes `<a class="url" href="...">...</a>` inside the element with `class="vcard"` in hCard.
- Similarly, `EMAIL` in vCard becomes `<a class="email" href="mailto:...">...</a>`
- `PHOTO` in vCard becomes `<img class="photo" src="..." alt="Photo of ..." />` or `<object class="photo" data="..." type="...">Photo of ...</object>`
- `UID` in vCard simply becomes another semantic applied to a specific URL (or EMAIL) for an hCard.

### Singular and Plural derivations

The lists of singular and plural properties have been derived by analyzing the semantics of the individual properties in vCard RFC2426 and determining logically that they MUST be singular per their semantics. See hcard-singular-properties for explanations.

#### Plural Properties Singularized

Since plural property names become their singular equivalents, even if the original plural property permitted only a single value with multiple components, those multiple components are represented each with their own singularly named property and the the property is effectively multivalued and subject to the above treatment of multivalued properties.

## Further Reading

- Digital Web Magazine: Microformats Primer by Garrett Dimon has a good intro to hCard
- Practical Microformats with hCard by Drew McLellan
- Local Search Engine Optimization using Microformats by Chris Silver Smith
- Andrew D. Hume has written a blog post on usable microformats which discusses hCard
- Jesse Skinner's introduction to hCard
- Shaun Shull's great post on How Microformats Affect SEO, including his hCard as an example.
- 24 Ways: Styling hCards with CSS A 24 Ways article - John Allsopp on styling hCard using CSS
- See also blogs discussing this page and the hCard tag
- RFC 4770 Extensions for Instant Messaging
- A real life use case of Microformat hCard in action by Bob Ngu
- Getting Semantic With Microformats, Part 3: hCard by Emily Lewis
- Microformats: The Fine Art of Markup: hCard by Andy Clarke

## Related Pages

- hCard
- hCard cheatsheet - hCard properties
- hCard creator (feedback) - create your own hCard.
- hCard authoring - learn how to add hCard markup to your existing contact info.
- hCard examples - example usage of various classes within hCard.
- hCard examples in the wild - an on-going list of websites which use hCards.
- hcard-supporting-user-profiles - sites with user profiles marked up with hCard - a very common example.
- hCard FAQ - if you have any questions about hCard, check here.
- hCard implementations - websites or tools which either generate or parse hCards.
- hcard-implied - a proposal to create a alternative method of marking up a simple hCard
- hCard parsing - normative details of how to parse hCards.
- hcard-user-interface - techniques and issues surrounding user-interfaces to author, publish, and display hCards.
- hCard profile - the XMDP profile for hCard
- hCard singular properties - an explanation of the list of singular properties in hCard.
- hCard tests - a wiki page with actual embedded hCards to try parsing.
- hCard advocacy - encourage others to use hCard
- hCard "to do" - jobs to do

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.

- hCard brainstorming - brainstorms and other explorations relating to hCard.
  - hcard-parsing-brainstorming - brainstorming specific to parsing of hCard
  - geo brainstorming
- hCard feedback - general feedback (as opposed to specific issues).
- hCard issues - specific issues with the specification.
- vCard errata - corrections to the vCard specification, which underlies hCard.
- vCard suggestions - suggested improvements to the vCard specification.

Retrieved from "http://microformats.org/wiki/hcard"

## Categories

- Specifications
- hCard

‘hCard’ was last modified: 2009-01-31T18:12:00P

## Views

- View source
- History