hCard cheatsheet

(Difference between revisions)

Jump to: navigation, search
m
Current revision (00:31, 1 August 2011) (view source)
(entry title)
 
(57 intermediate revisions not shown.)
Line 1: Line 1:
-
*class="'''vcard'''"
+
<entry-title>hCard cheatsheet</entry-title>
-
**class="''[[adr]]''"
+
-
***class="type" [work|home|pref|postal|dom|intl]
+
-
***class="post-office-box"
+
-
***class="''street-address''"
+
-
***class="extended-address"
+
-
***class="region"
+
-
***class="locality"
+
-
***class="postal-code"
+
-
***class="country-name"
+
-
**class="''agent''"
+
-
**class="[[hcard-singular-properties#bday|bday]]" ([[datetime-design-pattern |ISO date]])
+
-
**class="[[hcard-singular-properties#class|class]]" – confidentiality/access classification of the ''entire'' hCard
+
-
**class="''category''"
+
-
**class="''email''"
+
-
***class="type"
+
-
***class="value"
+
-
**class="'''[[hcard-singular-properties#fn|fn]]'''"
+
-
**class="[[geo]]"
+
-
***class="latitude"
+
-
**class="longitude"
+
-
**class="''key''"
+
-
**class="''label''"
+
-
**class="''logo''"
+
-
**class="''mailer''"
+
-
**class="[[hcard-singular-properties#n|n]]"
+
-
***class="''honorific-prefix''"
+
-
***class="given-name"
+
-
***class="''additional-name''"
+
-
***class="family-name"
+
-
***class="''honorific-suffix''"
+
-
**class="''nickname''"
+
-
**class="''note''"
+
-
**class="''org''"
+
-
***class="organization-name"
+
-
***class="''organization-unit''"
+
-
**class="''photo''"
+
-
**class="[[hcard-singular-properties#rev|rev]]" – datetime of the revision of the ''entire'' hCard
+
-
**class="''role''"
+
-
**class="[[hcard-singular-properties#sort-string|sort-string]]"
+
-
**class="''sound''"
+
-
**class="''title''"
+
-
**class="''tel''"
+
-
***class="type" [home|work|pref|fax|cell|pager]
+
-
***class="value"
+
-
**class="[[hcard-singular-properties#tz|tz]]" – timezone of the person
+
-
**class="[[hcard-singular-properties#uid|uid]]" – applies to the ''entire'' hCard
+
-
**class="''url''"
+
-
:Key
+
[[hcard|hCard]] properties and how to use them.
-
::'''Single occurrence required'''
+
-
::'''''One or more, required'''''
+
-
::single occurrence optional
+
-
::''zero or more occurrence''
+
-
::[common list of values]
+
-
::(data format)
+
-
----
+
==Profile==
 +
Place the following into the <nowiki><head></nowiki> of your document:
-
* <code>URL</code> in vCard becomes  <code><a class="url" href="...">...</a></code> inside the element with <code>class="vcard"</code> in hCard.
+
<source lang=html4strict>
 +
<link rel="profile" href="http://microformats.org/profile/hcard">
 +
</source>
 +
See [[rel-profile]] for details.
 +
 
 +
==Properties  (Class Names)==
 +
 
 +
*'''vcard''' {1}
 +
**''[[adr]]''*
 +
***type [work|home|pref|postal|dom|intl]?
 +
***post-office-box?
 +
***''street-address''*
 +
***extended-address?
 +
***region?
 +
***locality?
 +
***postal-code?
 +
***country-name?
 +
**''agent''*
 +
**[[hcard-singular-properties#bday|bday]]? ''([[datetime-design-pattern |ISO date]])''
 +
**[[hcard-singular-properties#class|class]]? ''confidentiality/access classification of the ''entire'' hCard''
 +
**''category''*
 +
**''email''*
 +
***type?
 +
***value?
 +
**'''[[hcard-singular-properties#fn|fn]]''' {1}
 +
**[[geo]]?
 +
***latitude?
 +
***longitude?
 +
**''key''*
 +
**''label''*
 +
**''logo''*
 +
**''mailer''*
 +
**[[hcard-singular-properties#n|n]]?
 +
***''honorific-prefix''*
 +
***''given-name''*
 +
***''additional-name''*
 +
***''family-name''*
 +
***''honorific-suffix''*
 +
**''nickname''*
 +
**''note''*
 +
**''org''*
 +
***organization-name?
 +
***''organization-unit''*
 +
**''photo''*
 +
**[[hcard-singular-properties#rev|rev]]? ''datetime of the revision of the ''entire'' hCard''
 +
**''role''*
 +
**[[hcard-singular-properties#sort-string|sort-string]]?
 +
**''sound''*
 +
**''tel''* ''(Note [http://en.wikipedia.org/wiki/E.123 E.123] for formatting info.)''
 +
***type [home|work|pref|fax|cell|pager]?
 +
***value?
 +
**''title''*
 +
**[[hcard-singular-properties#tz|tz]]? ''timezone of the person''
 +
**[[hcard-singular-properties#uid|uid]]?  ''applies to the ''entire'' hCard''
 +
**''url''*
 +
 
 +
{{cheatsheet-key}}
 +
{| border="1" cellpadding="2"
 +
| pref || preferred
 +
|-
 +
| dom || domestic
 +
|-
 +
| intl || international
 +
|-
 +
| cell || mobile
 +
|}
 +
 
 +
===Notes===
 +
*{{rfc-2119-intro}}
 +
* <code>URL</code> in vCard becomes  <code><a class="url" href=...>...</a></code> inside the element with class <code>vcard</code> in hCard.
* Similarly, <code>EMAIL</code> in vCard becomes <code><nowiki><a class="email" href="mailto:...">...</a></nowiki></code>
* Similarly, <code>EMAIL</code> in vCard becomes <code><nowiki><a class="email" href="mailto:...">...</a></nowiki></code>
-
* <code>PHOTO</code> in vCard becomes <code><img class="photo" src="..." alt="Photo of ..." /></code> or <code><object class="photo" data="..." type="...">Photo of ...</object></code>
+
* <code>FN</code> is an abbreviation of "'''formatted name'''".
 +
* <code>PHOTO</code> in vCard becomes <code><img class="photo" src=... alt="Photo of ..." /></code> or <code><object class="photo" data=... type=...>Photo of ...</object></code>
* <code>UID</code> in vCard simply becomes another semantic applied to a specific URL (or EMAIL) for an hCard.
* <code>UID</code> in vCard simply becomes another semantic applied to a specific URL (or EMAIL) for an hCard.
 +
* Compare <code>TITLE</code> of "Wing Commander" with <code>ROLE</code> of "pilot".
 +
 +
====Adr====
 +
{{adr-note}}
 +
 +
====Geo====
 +
{{geo-note}}
 +
 +
==Deprecated==
 +
=== profile attribute===
 +
Previously this cheatsheet advised adding a profile attribute to the <nowiki><head></nowiki> like this:
 +
<source lang=html4strict>
 +
<head profile="http://www.w3.org/2006/03/hcard" />
 +
</source>
 +
 +
This technique is valid for HTML4.x and XHTML1.x, however [http://stackoverflow.com/questions/1585220/use-of-profile-attribute-in-html-head-tag this is invalid for HTML5], thus authors are advised to use <nowiki><link rel=profile ...></nowiki> instead as [[#Profile|described above]] See [[hcard#Profile| hCard:Profile]] for more information.
==Related pages==
==Related pages==
{{hcard-related-pages}}
{{hcard-related-pages}}
 +
*[[rel-profile]]
 +
*{{cheatsheets}}

Current revision


hCard properties and how to use them.

Contents

Profile

Place the following into the <head> of your document:

<link rel="profile" href="http://microformats.org/profile/hcard">

See rel-profile for details.

Properties (Class Names)

Key

Based on Perl's standard quantifiers:

bold {1} MUST be present exactly once
italic* OPTIONAL, and MAY occur more than once
+ MUST be present, and MAY occur more than once
 ? OPTIONAL, but MUST NOT occur more than once
[square brackets] list of common values
(parentheses) data format
# comment
 ! awaiting documentation
pref preferred
dom domestic
intl international
cell mobile

Notes

Adr

Geo

<abbr class="geo" title="37.386013;-122.082932">home</abbr>

Deprecated

profile attribute

Previously this cheatsheet advised adding a profile attribute to the <head> like this:

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

This technique is valid for HTML4.x and XHTML1.x, however this is invalid for HTML5, thus authors are advised to use <link rel=profile ...> instead as described above See hCard:Profile for more information.

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.

hCard cheatsheet was last modified: Monday, August 1st, 2011

Views