The hCard microformat

The hCard microformat describes an entry in a contact database, as a virtual business card.

Properties

The value of each property is a string unless anything else is specified. If a property is not marked as required, the value might be undefined. If a property is marked as plural, the value is either undefined or a non-empty array. Each element in the array is a string unless anything else is specified. The values of the email, n, org and tel properties are not fully documented.

Property Description
adr The contact's address. Plural. Each element is an adr microformat where none of the properties are required.
agent People who act as agents on behalf of the contact. Plural. Each element is either a string or an hCard microformat where none of the properties are required.
bday The contact's birthdate.
class A class for the contact.
category Category with which the contact is associated. If a category is also a tag microformat, its "tag" property is used. Plural.
email Zero or more email addresses for the contact. Each email address entry includes two subproperties, both of which are plural:
type
This can be one or more of internet, x400, or pref. The pref type indicates the preferred email address.
value
One or more email addresses associated with the specified type.
fn The contact's full name. Required.
geo The contact's physical location. The value is a geo microformat where none of the properties are required.
key The contact's public key, for exchanging encrypted data with the contact. Plural.
label Formatted text providing an address label for the contact. Plural.
logo Optional URI to a graphic image of a logo for the contact; this can be used for a company logo, for example. Plural.
mailer The type of email software used by the contact. Plural.
n The contact's name. This has the following subproperties:
honorific-prefix
Zero or more honorifics to prepend to the name. For example, ["Mr."], or ["Honorable", "Governor"].
given-name
The contact's given name.
additional-name
An additional name, such as the middle name.
family-name
The contact's family name.
honorific-suffix
Zero or more honorifics to append to the name.

The n property is normally required, but since Mozilla's implementation offers an implied n optimization, it is optional, and will be parsed from the fn property if not specifically provided.

nickname Nickname for the contact. Plural.
note HTML note with additional information about the contact. Plural. Each element is some kind of object.
org The organization with which the contact is associated. This includes the following subproperties:
organization-name
The name of the organization with which the contact is associated.
organization-unit
The name of the division or department within the organization with which the contact is associated.
photo URI providing a photograph of the contact. Plural.
rev The date and time at which the contact was last revised.
role Role which the contact fills within his or her organization. Plural.
sequence A revision number for the contact. Each time the contact is revised, this number should be incremented, if this property is used at all. (The value is a string)
sort-string If provided, this string is used instead of the fn or n property to determine the sort order for the card. This can be useful in cases where the locale of the contact's name has different sorting rules than other names in the user's contact database.
sound URI specifying a sound file associated with the contact. Plural.
title Job title for the contact. Plural.
tel The contact's telephone number. Plural. Each element has the following subproperties:
type
The type of phone number. Can be one or more of the following: msg, home, work, pref, voice, fax, cell, video, pager, bbs, car, isdn, pcs.
tel
The telephone number, specified using the tel datatype.
tz The contact's time zone.
uid A unique UID for this contact.
url URL associated with the contact. Plural.

 

See also

Document Tags and Contributors

Contributors to this page: Dikrib, Sheppy, Mgjbot, Kohei
Last updated by: Dikrib,