hcard-cheatsheet: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Replace <entry-title> with {{DISPLAYTITLE:}}) |
||
| (14 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:hCard cheatsheet}} | |||
[[hcard|hCard]] properties and how to use them. | |||
==Profile== | ==Profile== | ||
<nowiki><head profile="http:// | Place the following into the <nowiki><head></nowiki> of your document: | ||
<source lang=html4strict> | |||
<link rel="profile" href="http://microformats.org/profile/hcard"> | |||
</source> | |||
See [[rel-profile]] for details. | |||
==Properties (Class Names)== | ==Properties (Class Names)== | ||
| Line 47: | Line 54: | ||
**[[hcard-singular-properties#sort-string|sort-string]]? | **[[hcard-singular-properties#sort-string|sort-string]]? | ||
**''sound''* | **''sound''* | ||
**''tel''* ''(Note [http://en.wikipedia.org/wiki/E.123 E.123] for formatting info.)'' | **''tel''* ''(Note [http://en.wikipedia.org/wiki/E.123 E.123] for formatting info.)'' | ||
***type [home|work|pref|fax|cell|pager]? | ***type [home|work|pref|fax|cell|pager]? | ||
***value? | ***value? | ||
**''title''* | |||
**[[hcard-singular-properties#tz|tz]]? ''timezone of the person'' | **[[hcard-singular-properties#tz|tz]]? ''timezone of the person'' | ||
**[[hcard-singular-properties#uid|uid]]? ''applies to the ''entire'' hCard'' | **[[hcard-singular-properties#uid|uid]]? ''applies to the ''entire'' hCard'' | ||
| Line 70: | Line 77: | ||
* <code>URL</code> in vCard becomes <code><a class="url" href=...>...</a></code> inside the element with class <code>vcard</code> in hCard. | * <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>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>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==== | ||
| Line 78: | Line 87: | ||
====Geo==== | ====Geo==== | ||
{{geo-note}} | {{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}} | *{{cheatsheets}} | ||
Latest revision as of 16:25, 18 July 2020
hCard properties and how to use them.
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)
- vcard {1}
- adr*
- type [work|home|pref|postal|dom|intl]?
- post-office-box?
- street-address*
- extended-address?
- region?
- locality?
- postal-code?
- country-name?
- agent*
- bday? (ISO date)
- class? confidentiality/access classification of the entire hCard
- category*
- email*
- type?
- value?
- fn {1}
- geo?
- latitude?
- longitude?
- key*
- label*
- logo*
- mailer*
- n?
- honorific-prefix*
- given-name*
- additional-name*
- family-name*
- honorific-suffix*
- nickname*
- note*
- org*
- organization-name?
- organization-unit*
- photo*
- rev? datetime of the revision of the entire hCard
- role*
- sort-string?
- sound*
- tel* (Note E.123 for formatting info.)
- type [home|work|pref|fax|cell|pager]?
- value?
- title*
- tz? timezone of the person
- uid? applies to the entire hCard
- url*
- adr*
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
- 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.
URLin vCard becomes<a class="url" href=...>...</a>inside the element with classvcardin hCard.- Similarly,
EMAILin vCard becomes<a class="email" href="mailto:...">...</a> FNis an abbreviation of "formatted name".PHOTOin vCard becomes<img class="photo" src=... alt="Photo of ..." />or<object class="photo" data=... type=...>Photo of ...</object>UIDin vCard simply becomes another semantic applied to a specific URL (or EMAIL) for an hCard.- Compare
TITLEof "Wing Commander" withROLEof "pilot".
Adr
- At least one child-property MUST be present in
adr. - If an adr-child (e.g
street-address) is present it will ONLY be considered part of theadrdata IF it is inside anadr. - FAQ: "why 'adr'?"
Geo
- Coordinates MUST use the datum of WGS84.
- If latitude is present, so MUST be longitude, and vice versa.
- Coordinates MAY be combined a single <abbr> element; then the latitude and longitude MUST be separated by a semicolon in the title attribute and latitude MUST be first:
<abbr class="geo" title="37.386013;-122.082932">home</abbr>
- Best practice is that the same number of decimal places SHOULD be used in each value, with trailing zeroes if applicable.
- Some sources for latitude/ longitude coordinates
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
- 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 parsing - normative details of how to parse hCards.
- hCards and pages - semantic distinctions between different hCards on a page, and how to identify each
- 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.
- rel-profile
- Other cheatsheets: hAtom cheatsheet, hCard cheatsheet (also adr cheatsheet + geo cheatsheet), hCalendar cheatsheet, hResume cheatsheet, hReview cheatsheet, PDF cheatsheet