Difference between revisions of "h-card"

From Microformats Wiki
Jump to navigation Jump to search
(properties intro sentence, move backward compatiblity to its own section)
(all properties optional, validating, embedding)
Line 53: Line 53:
 
* '''<code>u-uid</code>''' - unique identifier
 
* '''<code>u-uid</code>''' - unique identifier
 
* '''<code>p-category</code>''' - category/tag
 
* '''<code>p-category</code>''' - category/tag
* '''<code>p-adr</code>''' - postal address, optionally a nested {{main|h-adr}}
+
* '''<code>p-adr</code>''' - postal address, optionally embed an [[h-adr]] {{main|h-adr}}
 
* '''<code>p-post-office-box</code>'''
 
* '''<code>p-post-office-box</code>'''
 
* '''<code>p-extended-address</code>'''
 
* '''<code>p-extended-address</code>'''
Line 62: Line 62:
 
* '''<code>p-country-name</code>''' - country name
 
* '''<code>p-country-name</code>''' - country name
 
* '''<code>p-label</code>'''
 
* '''<code>p-label</code>'''
* '''<code>p-geo</code>''' or '''<code>u-geo</code>''', optionally a nested {{main|h-geo}}
+
* '''<code>p-geo</code>''' or '''<code>u-geo</code>''', optionally embed an [[h-geo]] {{main|h-geo}}
 
* '''<code>p-latitude</code>''' - decimal latitude
 
* '''<code>p-latitude</code>''' - decimal latitude
 
* '''<code>p-longitude</code>''' - decimal longitude
 
* '''<code>p-longitude</code>''' - decimal longitude
Line 70: Line 70:
 
* '''<code>dt-bday</code>''' - birth date
 
* '''<code>dt-bday</code>''' - birth date
 
* '''<code>u-key</code>''' - cryptographic public key e.g. SSH or GPG
 
* '''<code>u-key</code>''' - cryptographic public key e.g. SSH or GPG
* '''<code>p-org</code>''' - affiliated organisation, optionally a nested h-card
+
* '''<code>p-org</code>''' - affiliated organization, optionally embed an [[h-card]]
 
* '''<code>p-job-title</code>''' - job title, previously 'title' in [[hCard]], disambiguated.
 
* '''<code>p-job-title</code>''' - job title, previously 'title' in [[hCard]], disambiguated.
 
* '''<code>p-role</code>''' - description of role  
 
* '''<code>p-role</code>''' - description of role  
Line 77: Line 77:
 
* '''<code>p-gender-identity</code>''' - gender identity, new in vCard4 (RFC6350)
 
* '''<code>p-gender-identity</code>''' - gender identity, new in vCard4 (RFC6350)
 
* '''<code>dt-anniversary</code>'''
 
* '''<code>dt-anniversary</code>'''
 +
 +
All properties are optional.
  
 
== Status ==
 
== Status ==
Line 120: Line 122:
 
* WebMaker by Mozilla has [[microformats-2]] h-card on event search (e.g. [https://webmaker.org/en-US/events/near/?lat=45.5234515&lng=-122.6762071 search near Portland Oregon]) and event pages (e.g. [https://webmaker.org/en-US/events/192f56eb9/ IndieWebCamp 2012]).[https://twitter.com/microformats/status/212207925643587585]
 
* WebMaker by Mozilla has [[microformats-2]] h-card on event search (e.g. [https://webmaker.org/en-US/events/near/?lat=45.5234515&lng=-122.6762071 search near Portland Oregon]) and event pages (e.g. [https://webmaker.org/en-US/events/192f56eb9/ IndieWebCamp 2012]).[https://twitter.com/microformats/status/212207925643587585]
 
* WebFWD by Mozilla has [[microformats-2]] h-card markup on [https://webfwd.org/about/experts/ experts] and [https://webfwd.org/about/team/ team] pages
 
* WebFWD by Mozilla has [[microformats-2]] h-card markup on [https://webfwd.org/about/experts/ experts] and [https://webfwd.org/about/team/ team] pages
* [http://indiewebcamp.com IndieWebCamp] has [[microformats-2]] h-event markup with nested h-cards for the organizers and the location.
+
* [http://indiewebcamp.com IndieWebCamp] has [[microformats-2]] h-event markup with embedded h-cards for the organizers and the location.
 
* [https://wiki.mozilla.org/Events Mozilla Events] page has [[microformats-2]] h-event markup with attendees marked up with h-card.
 
* [https://wiki.mozilla.org/Events Mozilla Events] page has [[microformats-2]] h-event markup with attendees marked up with h-card.
 +
 +
 +
== Validating ==
 +
{{main|validators}}
 +
Test and validate your [[h-adr]] markup with:
 +
* http://waterpigs.co.uk/php-mf2/ - enter your markup directly
 +
* http://pin13.net/ - enter a URL to a page to test where it says "Microformats Parser"
 +
  
 
== Backward Compatibility ==
 
== Backward Compatibility ==
Line 128: Line 138:
  
 
<source lang=html4strict>
 
<source lang=html4strict>
<span class="p-name fn n">Joe Bloggs</span>
+
<p class="h-card vcard">
 +
  <span class="p-name fn">Joe Bloggs</span>,
 +
  <span class="p-org org">Awesome Nonprofit</span>
 +
  ...
 +
</p>
 
</source>
 
</source>
 +
 +
The class '''<code>vcard</code>''' is a ''backward compatible root class name'' that indicates the presence of an [[hCard]].
 +
 +
'''fn''', '''org''', and all the other backward compatibility hCard property class names are listed below.
  
 
=== Parser Compatibility ===
 
=== Parser Compatibility ===

Revision as of 00:07, 19 June 2013

<entry-title>h-card</entry-title> Tantek Çelik (Editor)


h-card is a simple, open format for publishing people and organisations on the web. h-card is one of several open microformat draft standards suitable for embedding data in HTML/HTML5.

h-card is the microformats2 update to hCard 1.0.

Example

Here is a simple minimal person example:

<a class="h-card" href="http://example.com">Joe Bloggs</a>

And a slightly more complete example:

<p class="h-card">
  <img class="u-photo" href="http://example.org/photo.png" />
  <a class="p-name u-url" href="http://example.org">Joe Bloggs</a>
  <a class="u-email" href="mailto:joebloggs@example.com">joebloggs@example.com</a>
  <p class="p-adr h-adr">
    <span class="p-street-address">17 Austerstræti</span>
    <span class="p-locality">Reykjavík</span>
    <span class="p-country-name">Iceland</span>
  </p>
</p>

Get started

The class h-card is a root class name that indicates the presence of an h-card.

For minimal examples where at most p-name, u-url and u-photo are required (such as the first given above), only the root class name is needed — see implied properties.

For more complex examples, the root class name must be placed on an element which encloses all the desired properties, and then the properties themselves marked up using the classnames given below.

See microformats2 parsing specification to learn more about property classnames.

Properties

h-card properties, inside an element with class h-card:

  • p-name - The full/formatted name of the person or organisation
  • p-honorific-prefix - e.g. Mrs., Mr. or Dr.
  • p-given-name - given (often first) name
  • p-additional-name - other/middle name
  • p-family-name - family (often last) name
  • p-sort-string - string to sort by
  • p-honorific-suffix - e.g. Ph.D, Esq.
  • p-nickname - nickname/alias/handle
  • u-email - email address
  • u-logo
  • u-photo
  • u-url - home page
  • u-uid - unique identifier
  • p-category - category/tag
  • p-adr - postal address, optionally embed an h-adr
    Main article: h-adr
  • p-post-office-box
  • p-extended-address
  • p-street-address - street number + name
  • p-locality - city/town/village
  • p-region - state/county/province
  • p-postal-code - postal code, e.g. US ZIP
  • p-country-name - country name
  • p-label
  • p-geo or u-geo, optionally embed an h-geo
    Main article: h-geo
  • p-latitude - decimal latitude
  • p-longitude - decimal longitude
  • p-altitude - decimal altitude
  • p-tel - telephone number
  • p-note - additional notes
  • dt-bday - birth date
  • u-key - cryptographic public key e.g. SSH or GPG
  • p-org - affiliated organization, optionally embed an h-card
  • p-job-title - job title, previously 'title' in hCard 1.0, disambiguated.
  • p-role - description of role
  • u-impp per RFC 4770, new in vCard4 (RFC6350)
  • p-sex - biological sex, new in vCard4 (RFC6350)
  • p-gender-identity - gender identity, new in vCard4 (RFC6350)
  • dt-anniversary

All properties are optional.

Status

h-card is a microformats.org draft specification. Public discussion on h-card takes place on h-card-feedback, the #microformats #microformats chat channel on irc.freenode.net, and microformats-new mailing list.

h-card is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-cards up as classic hCards.

Property Details

(stub, to be expanded)

p-adr and its associated postal address properties can optionally use h-adr, for example:

<p class="p-adr h-adr">
  <span class="p-street-address">17 Austerstræti</span>
  <span class="p-locality">Reykjavík</span>
  <span class="p-country-name">Iceland</span>
</p>

Reserved properties (not used much, if at all, in practice):

  • p-organization-name
  • p-organization-unit
  • p-tz
  • dt-rev

Note: use of 'value' within 'tel' should be automatically handled by the support of the Value Class Pattern. And for now, the 'type' subproperty of 'tel' is dropped/ignored. If there is demonstrable documented need for additional tel types (e.g. fax), we can introduce new flat properties as needed (e.g. p-tel-fax).

Examples in the wild

Real world in the wild examples:


Validating

Main article: microformats validators

Test and validate your h-adr markup with:


Backward Compatibility

Publisher Compatibility

For backward compatibility, you may wish to use classic hCard 1.0 classnames in addition to the more future-proof h-card properties, for example:

<p class="h-card vcard">
  <span class="p-name fn">Joe Bloggs</span>,
  <span class="p-org org">Awesome Nonprofit</span>
  ...
</p>

The class vcard is a backward compatible root class name that indicates the presence of an hCard 1.0.

fn, org, and all the other backward compatibility hCard property class names are listed below.

Parser Compatibility

Microformats parsers SHOULD detect the following root class name and property names. A microformats2 parser may use existing microformats Microformats Parsers to extract these properties. If an "h-card" is found, don't look for a "vcard" on the same element.

Compat. root class name: vcard
Properties: (parsed as p- plain text unless otherwise specified)

  • fn - parse as p-name
  • honorific-prefix
  • given-name
  • additional-name
  • family-name
  • honorific-suffix
  • nickname
  • email - parse as u-
  • logo - parse as u-
  • photo - parse as u-
  • url - parse as u-
  • uid - parse as u-
  • category
  • adr - parse as p-adr h-adr including compat root class adr
  • extended-address
  • street-address
  • locality
  • region
  • postal-code
  • country-name
  • label
  • geo - parse as p-geo h-geo including compat root class geo
  • latitude
  • longitude
  • tel
  • note
  • bday - parse as dt-
  • key - parse as u-
  • org
  • organization-name
  • organization-unit
  • title - parse as p-job-title
  • role

Reserved: (backward compat properties that parsers MAY implement, if they do, they MUST implement in this way:

  • tz
  • rev - parse as dt-


Background

This work is based on the existing hCard 1.0 and vCard specifications specifications.

Design Principles

(stub, expand)

See Also