Microformats Wiki - User contributions [en]

irc-people

2008-02-07T21:54:06Z

Evan: evanpro == e_s_p

A list of [[irc|IRC]] regulars, sorted by nick, and their normal timezones (winter/summer).

* {{irc user|Adam Ballai|AdamBallai|-700/-700}}
* {{irc user|Adam Craven|AdamCraven|+0000}}
* {{irc user|Alexander Graf|AlexanderGraf|+0100}}
* {{irc user|Tomasino|aloneone|-0500}}
* {{irc user|AmanuelTewolde|Amanuel|-0500/-0400}}
* {{irc user|Amette|amette|+1000}}
* {{irc user|Amir Guindehi|AmirGuindehi|+1000}}
* {{irc user|Ajaswa|Andrew Jaswa|-0500}}
* {{irc user|AnselHalliburton|anselxyz|-0800/-0700}}
* {{irc user|Ashe Dryden|Ashe|-600}}
* {{irc user|Ashley|Ashley|+1000}}
* {{irc user|Azathoth|Florian Beer|+1000}}
* {{irc user|Tyler Roehmholdt|Baristo|-0800/-0700}}
* {{irc user|BenjaminCarlyle|BenjaminCarlyle|+1000}}
* {{irc user|HenriBergius|bergie|+0200/+0300}}
* {{irc user|Ben Ward|BenWard|+0000}}
* {{irc user|BenWest|bewest|-0800/-0700}}
* {{irc user|B.K._DeLong|bkdelong|-0500/-0400}}
* {{irc user|Robert|blueace|+0100}}
* {{irc user|BluesMoon|bluesmoon|+0530}}
* {{irc user|BobChao|BobChao|+0800}}
* {{irc user|Bob Jonkman|BobJonkman|-0500/-0400}}
* {{irc user|Boneill|boneill|+0000}}
* {{irc user|Brian|briansuda|+0000}}
* {{irc user|TimT|bringo|-0800/-0700}}
* {{irc user|Briski|Briski|+0000}}
* {{irc user|BryanL|BryanL|-0500/-0400}}
* {{irc user|BryanRieger|Bryan Rieger|+0000}}
* {{irc user|Bug-E|Bug-E|+0200}}
* {{irc user|CarlaHufstedler|carlamagpie|-0500/-0400}}
* {{irc user|Colin_Barrett|cbarrett|-1000}}
* {{irc user|ColinDDevroe|cdevroe|-0500/-0600}}
* {{irc user|Cgriego|cgriego|-0600/-0500}}
* {{irc user|Charlvn|Charl|+0200/+0200}}
* {{irc user|CharlesRoper|charles_r|0000/+0100}}
* {{irc user|ChristopherStJohn|cks|-0600/-0500}}
* {{irc user|Cloud|Cloud|+0000}}
* {{irc user|Cruster|cruster|+0200}}
* {{irc user|Csarven|csarven|-0500/-0400}}
* {{irc user|ChrisBrentano|ctb|-0800/-0700}}
* {{irc user|DanC|DanC|-0600/-0500}}
* {{irc user|DanielBurka|DanielBurka|-0400}}
* {{irc user|DanielJohnLewis|danieljohnlewis|0000}}
* {{irc user|DannyAyers|danja|+0100/+0200}}
* {{irc user|Dave Cardwell|davecardwell|+0000}}
* {{irc user|DavidMead|DavidMead|-0400}}
* {{irc user|DavidRussell|davidrussell|-0600/-0500}}
* {{irc user|DBounds|Darren Bounds|-0500
* {{irc user|DenisDefreyne|ddfreyne|+0100/+0200}}
* {{irc user|DeanEro|deanero|-0800/-0700}}
* {{irc user|DeepText|Deep Text|-0800/-0700}}
* {{irc user|DerrickPallas|DerrickPallas|-0800/-0700}}
* {{irc user|DimitriGlazkov|dglazkov|-0600/-0500}}
* {{irc user|DiegoBudny|DiegoBudny|<small>-unspecified-</small>}}
* {{irc user|Dan Kubb|dkubb|-0800/-0700}}
* {{irc user|DrErnie|DrErnie|-0800/-0700}}
* {{irc user|DrewMcLellan|drewinthehead|+0000/+0100}}
* {{irc user|DrewBell|droob|-0600/-0500}}
* {{irc user|DimitriosZachariadis|dzach|+0200/+0300}}
* {{irc user|DydimusTK|dydimustk|-0600}}
* {{irc user|Ed Summers|edsu|-0500/-0400}}
* {{irc user|Enric|Enric|-0800/-0700}} (alt sp "enric")
* {{irc user|Evan|evanpro|-0500}}
* {{irc user|Evan|e_s_p|-0500}}
* {{irc user|ChrisMessina|factoryjoe|-0800/-0700}}
* {{irc user|Fil|Fil|+0200}}
* {{irc user|CFinke|Finke|-0700/-0600}}
* {{irc user|MarkoMrdjenovic|friedcell|+0100/+0200}}
* {{irc user|GarethR|garethr|+0000/+0100}}
* {{irc user|Grantbow|Grantbow|-0800/-0700}}
* {{irc user|Griffin|Griffin|-0600/-0500}}
* {{irc user|Guillaume Lebleu|glebleu|-0800}}
* {{irc user|Aubergine10|Guy Fraser|+0100/+0000}}
* {{irc user|HenrichPoehls|HenrichP|+0100}}
* {{irc user|IanHickson|Hixie|-0800/-0700}}
* {{irc user|Hlb|hlb|+0800-0700}}
* {{irc user|EdwardOConnor|hober|-0800/-0700}}
* {{irc user|Ichigo|ichigo|+1000}}
* {{irc user|Alper|illustir|+0100}}
* {{irc user|Inkbase|inkbase|-0800/-0700}}
* {{irc user|IwaiMasaharu|iwaim|+0900}}
* {{irc user|Izo|IZO|<small>-unspecified-</small>}}
* {{irc user|JamieKnight|JamieKnight|+1000/0000}}
* {{irc user|JoeGregorio|jcgregorio|<small>-unspecified-</small>}}
* {{irc user|WizardIsHungry|jcw9|-0500/-0400}}
* {{irc user|Adactio|Jeremy Keith|+0000}}
* {{irc user|jrodgers|JesseRodgers|-0500}}
* {{irc user|JasonK|jkridner|-0600/-0500}}
* {{irc user|JeffMcNeill|jeffmcneill|-1000}}
* {{irc user|JimboJW|jimbojw|-0600/-0500}}
* {{irc user|Jonathan_Arkell|jonnay|-0700/0600}}
* {{irc user|JosephHolsten|josephholsten|-0600/-0500}}
* {{irc user|JulianStahnke|julianstahnke|+0000}}
* {{irc user|Kapowaz|kapowaz|+0000/+0100}}
* {{irc user|Keri Henare|kerihenare|+1200}}
* [http://epeus.blogspot.com/ KevinMarks] (-0800/-0700)
* {{irc user|RyanKing|kingryan|-0800/-0700}}
** [http://theryanking.com/blog/archives/2006/04/19/office-hours/ Office hours]: Wednesday, 21:00 UTC
* {{irc user|Lachlan Hunt|Lachy|+1000/+1100}}
* {{irc user|Levitation|levitation[A]|+0200/+0300}}
* {{irc user|Linmic|linmic|+0800-0700}}
* {{irc user|MarkNg|madness|+0000/+0100}}
* {{irc user|Mark Mansour|Mark Mansour|+1100}}
* {{irc user|MarkNormanFrancis|Mark Norman Francis|+0000/+0100}}
* {{irc user|MattBowen|Matt Bowen|-0500/-0400}}
* {{irc user|MattisManzel|Mattis Manzel|+0100/+0200}}
* {{irc user|CiaranMc|McNulty|+0000/+0100}}
* <span class="vcard"><span class="fn org">[[mfbot]]</span> - a bot which logs all edits to this wiki. It appends a number with a '+' or '-' sign, to indicate the number of characters added or removed as a result of the edit.</span>
* {{irc user|Mike|Michael McCracken(mmc)|-0800/-0700}}
* {{irc user|MikeKaply|mkaply|-0600/-0500}}
* {{irc user|SteveIvy|monkinetic/redmonk|-0700}}
* {{irc user|RobManson|nambor|+1000}}
* {{irc user|neuro|neuro|<small>-unspecified-</small>}}
* {{irc user|Niekie|niekie|+0100/+0200}}
* {{irc user|NTollervey|ntoll|+0000/+0100}}
* {{irc user|Andy Pemberton|pembertona|-0500/-0400}}
* {{irc user|Phae|Phae|+0000/+0100}}
* {{irc user|PriitLaes|plaes|+0200/+0300}}
* {{irc user|ChrisCasciano|pnhChris|-0500/-0400}}
* {{irc user|PetarPopov|popov|-0800/-0700}}
* {{irc user|DavidOsolkowski|qid|-0500}}
* {{irc user|RCanine|RCanine|-0500/-0400}}
* {{irc user|Remi|Remi|-0500/-0400}}
* {{irc user|RobertBachmann|RobertBachmann|+0100/+0200}}
** Office hours: <s>Wednesday, 18:00-20:00 UTC</s> (Currently no office hours}}
* {{irc user|Ronnos|Ron Kok|+0000}}
* {{irc user|SarahWorsham|sazbean|-0500/-0400}}
* {{irc user|ScottNelle|snelle|-0500/-0400}}
* {{irc user|ScottRozic|gravitas|-0500/+0100}}
* {{irc user|Dana Benson|Snowden|-0800/-0700}}
* {{irc user|Smackman|Steve Farrell|-0800/-0700}}
* {{irc user|SpikeUK|SpikeUK|+0000/+0100}}
* {{irc user|Steve Ganz|SteveGanz|-0800/-0700}}
* {{irc user|Stii|Stii|+0200 GMT}}
* {{irc user|ReinierZ|surial|+0100 GMT}}
* {{irc user|SuperPhly|SuperPhly|-600/-500}}
* {{irc user|SyedSRahman|syedsrahman|+0530}}
* <span class="vcard"><span class="fn">sym[[User:LynX|lynX]]</span> or (better) [[User:LynX|lynX]] on [http://about.psyc.eu PSYC] (+0100}}
* {{irc user|DavidLehn|taaz|-0500/-0400}}
* {{irc user|Tantek|Tantek|-0800/-0700}}
* {{irc user|Trovster|trovster|-0800/-0700}}
* {{irc user|Vadania|vadania|-0600/-0700}}
* {{irc user|Vant|vant|+0900}}
* {{irc user|Victor|victor|+0100/+0200}}
* {{irc user|V-I-P|V-I-P|+0100/+0200}}
* {{irc user|KrissWatt|VoodooChild|+0000/+0100}}
* {{irc user|WebOrganics|weborganics|+0100}}
* {{irc user|JacksonWilkinson|whafro|-0500/-0400}}
* {{irc user|Richard Conyard|WhiskeyM|+0000}}
* {{irc user|Veeliam|William Lawrence|-0800/-0700}}
* {{irc user|StevenWoods|woodss|+0000 GMT}}
* {{irc user|Wojciech|wzajac|+0100/+0200}}
* {{irc user|Ianloic|yakk|-0800/-0700}}
* {{irc user|LarsStrojny|mastaYoda|+0100}}
* {{irc user|ZimbaTm|zimbatm|+0100}}
* {{irc user|FoundAtion|Foundation|-0800}}

xfn-implementations

2008-02-07T21:52:15Z

Evan: /* new implementations */ Google Social Graph API

<h1> XFN Implementations </h1>
{{TOC-right}}
In addition to the [http://gmpg.org/xfn/tools XFN Tools] page, this page contains more more recent implementations.

== new implementations ==
The following implementations have been developed which either generate or parse [http://gmpg.org/xfn XFN relationship links]. If you have an XFN implementation, feel free to add it to the '''top''' of this list.
* [http://textcube.org TextCube] Blogging tool TextCube version 1.6(current Beta-phase) will support xfn enabled blog roll.
* [http://code.google.com/apis/socialgraph/ Google Social Graph API] uses XFN data from public Web sites as its main data source.

=== appear old or unverifiable ===
These sites appear to be too old, and or perhaps broken (like PHP error dump).
* [http://tagalag.com Tagalag] Tagalag [http://tagalag.com/tools.html#xfn supports] a partial XFN vocabulary.

== update streams and pingers ==
* [http://updates.elsewhere.im/ SixApart Relationship Update Stream] - launched 2007-10-19

== authoring publishing ==
The following tools, plugins, and extensions enable authors to eaily create and publish XFN links:
* [http://icite.net/develop/software.html#ll4blojsom LL4blojsom] is the LinkList plugin for the [http://blojsom.sf.net blojsom] blog engine. blojsom, written in Java, is the open source application behind the Tiger Weblog Server that is part of OS X server. The LL4blojsom plugin is used for creating XFN blogrolls.
* [http://www.zachinglis.com/projects/xfn-rel-creator/ XFN rel Creator] This script replaces any links within the designated tags and replaces them with a visual representation of the links. Default set as abbrevations but with CSS it is easy to replace them for images.
* [http://www.wordpress.org/ WordPress] has XFN support built-in to its Link Manager function, which is used for generating blogrolls. When in the administrative interface, choose the Links top-level menu item, then choose Add Link. The link form lets you choose which XFN properties you wish the link to have. When displaying the links on the site via any of the standard WordPress template tags, it will automatically format it with the appropriate tags in the rel attribute. (based on [http://gmpg.org/xfn/creator XFN Creator])
* [http://www.communityserver.org/ Community Server] has XFN support in its blog Link Lists. It allows you to select which XFN tag(s) to use for each link.
* [http://www.webstandards.org/action/dwtf/microformats/ Dreamweaver Extension suite] from the [http://webstandards.org/ Web Standards Project] enables the authoring of XFN links from within Dreamweaver 8.
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding XFN and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* [http://www.zachinglis.com/projects/xfn-rel-creator/ XFN rel Creator] This script replaces any links within the designated tags and replaces them with a visual representation of the links. Default set as abbrevations but with CSS it is easy to replace them for images.
== friends lists ==
Numerous services support both XFN friends lists, and even better XFN+[[hcard|hCard]] friends lists.
* See [[hcard-xfn-friends-lists|hCard+XFN friends lists]].

== rel me identity equivalency ==
* [http://wordpress.org/extend/plugins/yadis/ YADIS plugin] supports OpenID delegation links that are also compatible XFN rel-me links.
* [http://wink.com Wink] supports rel-me (see [http://wink.com/beach--profile])
** '''suboptimal''': uses "nofollow me" where it should just use "me". User entered profile information is first party, not 3rd party, and therefore should not be labeled with [[rel-nofollow]].

== validators ==
* [http://tools.microformatic.com/help/xhtml/rel-lint/ rel-lint] by [[User:DrewMcLellan|Drew McLellan]] will validate existence of XFN attributes.

== visualizers and browsers ==
* [http://services.alphaworks.ibm.com/manyeyes/view/SNnqRHsOtha6i5-m6iGTH2- XFN visualization] example at IBM's Many Eyes
* [http://xfngraph.sourceforge.net XFN Graph] — a multi-platform Java-based tool which creates spider diagrams of XFN relationships from any given starting URL.
* [http://xfnroll.new-bamboo.co.uk/people/popular XFNRoller] (to be lifestalker.com) XFN spider and browser focused on using blogs to represent individuals. Exports OPML of feeds for lists such as top 10 most popular people.

== search ==
* [http://xfnsearch.joshpeek.com/ XFN Search] (appears to require HTTP-authentication login)

== See Also ==
{{xfn-related-pages}}

error-message-examples

2007-07-18T04:28:47Z

Evan: It's not just about login errors, they're just the easiest to generate

<h1> Error Message Examples </h1>

== Contributors ==

* [http://evan.prodromou.name/ Evan Prodromou]

== Introduction ==

Examples of error messages published as chunks of readable (X)HTML by Web applications.

== Table of Contents ==

__TOC__

== Examples ==

Note that many of these examples are failed logins; they're just the easiest kind of error to generate.

* [http://www.mediawiki.org/ MediaWiki] failed login

<pre><div class="errorbox">
<h2>Login error:</h2>
Incorrect password or confirmation code entered. Please try again.
</div></pre>

* [http://www.wordpress.com/ WordPress], failed to enter required fields in comment

<pre><p>Error: please fill the required fields (name, email).</p></pre>

* [http://www.paypal.com/ PayPal] , trying to send negative dollars.

<pre><div class="messageBox error">
<p>Some required information is missing or incomplete. Please correct your entries and try again.</p>
<ul><li>Please enter an amount greater than zero.</li></ul>
</div></pre>

* [http://www.google.com/ Google] apps login error

<pre><div class="errormsg" id="errormsg_0_Passwd">
Username and password do not match. (You provided XXXXXXXXXX)
</div></pre>

* [http://www.technorati.com/ Technorati] login error

<pre><p class="error">Sorry, the member name and password
you entered do not match. Please try again.</p></pre>

* [http://www.yahoo.com/ Yahoo] failed login

<pre><div class="yregertxt"><strong>Invalid ID or password.</strong><br> Please try again.</div></pre>

== Open Questions ==
* How is this significantly different than the plethora of HTTP status codes? Most of the examples currently on this page are just failed logins. [[User:DerrickPallas|DerrickPallas]] 09:31, 14 Jul 2007 (PDT)
** [http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 401 Unauthorized]
** [http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3 402 Payment Required]
** [http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 403 Forbidden]
** ...

I used login errors just because they were easy to generate (see note above). It's actually kind of hard, as a user of these services, to generate a database connection error. Form validation errors are a little easier; I used an example from Paypal. I can go back and try to make some other errors happen, if you like, too.

I think that, first of all, many sites ''don't'' return a 4xx or 5xx error code when something goes wrong; they return 200 with an HTML error message as part of the content (often a very small part of the content, wrapped with the site's "skin" of header, footer, and navigational HTML). I think there's a case to be made that the response for a POSTed form with a mis-formatted phone number in it should have a status code of 400 or 409, but that's simply not how most Web sites work.

I also think that even if some Web site is perfectly RESTful and uses the correct HTTP status messages religiously, there's still some value in a ''specific'' section of the resulting page that defines the actual error. --[[User:Evan|Evan]] 21:28, 17 Jul 2007 (PDT)

== See Also ==

* [[error-message-brainstorming|error message brainstorming]]

criticism

2007-07-18T04:12:14Z

Evan: Well, not entirely ''criticism'' per se

=Criticism=

From time to time, there is criticism of a single, or all, microformats. Some is constructive, other less so.

The following list makes no judgement either way, but is included for reference, and in order that microformat advocates who wish to do so, may participate in the original discussion,.

If you choose to do so, please adopt a positive helpful manner, and act as an [[advocacy|ambassador for the microformat community]].

Unless stated, titles and dates are taken from original postings, verbatim.

Please add new items to the '''top''' of the list (they can be sorted into date-of-publication order after a week or so), and replicate the format of those already there.

==Recent==
*[http://www.webaim.org/discussion/mail_thread.php?thread=3259 WebAIM discussion of microformat accessibility] - 2007-01 / 2007-02. Includes discussion of [[abbr-design-pattern]]. Summary: criticism is nearly all from [http://www.cs.tut.fi/~jkorpela/ Jukka "Yucca" Korpela]. If you dig deep (do your best to dig past / ignore / filter inflammatory rhetoric and ridicule, e.g. use of the term "microbabble") you can find a few points we can use to improve microformats.

==2006==
*[http://www.voiceoftech.com/swhitley/index.php/?p=159 Committing An Act of hEresy - Part I] - 2006-12-11. Completely misrepresents microformats.
*[http://www.accessifyforum.com/viewtopic.php?t=6167&postdays=0&postorder=asc&start=0 Use of 'abbr' in microformats] - 2006-09-20. Issues: use of 'abbr'; Julian dates
*[http://cafe.elharo.com/xml/must-ignore-vs-microformats/ Must Ignore vs. Microformats] - 2006-07-12. Issues: "XML would be better"
*[http://evan.prodromou.name/RDFa_vs_microformats RDFa vs microformats] - 2006-05-29. Issues: lack of co-ordination & compatibility.
** Let me say that I actually like and use µFs a lot. I just think there's a potential for a conflict with RDFa in the future, and I think that it's best for developers if that conflict doesn't happen. --[[User:Evan|Evan]] 21:12, 17 Jul 2007 (PDT)
*[http://weblog.200ok.com.au/2006/01/limitations-of-rel-microformat.html limitations of rel="tag" microformat] - 2006-01-17 Summary: Under the current draft, tags and relevant tagspaces are potentially hard to create; and it's still easy to abuse the system. Humans can still be tricked and so can the machines. It's a great spec if you happen to have a compliant directory structure, but if your site doesn't match then you either recreate your entire system... or, more likely, you sadly advise the client that tags aren't happening.

==See also==
*[[accessibility]]
*[[microformats-issues]]
*The [[faq|microformats FAQ]], which answers many general criticisms/ issues that have been raised with microformats.

error-message-brainstorming

2007-06-28T15:38:16Z

Evan: some brainstorming examples

<h1>Error Message Brainstorming</h1>

Typical Web applications emit text messages to inform the user of error situations -- either user errors ("Invalid user name or password", "Failed to enter required fields") or system errors ("can't connect to database server", "Call to member function 'foo' on null object.").

There are a number of use-cases for having a standardized, machine-readable format for HTML error messages.

* Automated bug-reporting tools
* Enhanced technical support requests -- a client tool could store recent error messages and transmit them to the support technician
* Workaround-lookups ("What do I do now?") -- a client tool could automatically search company or external knowledge bases for fixes or workarounds for a given error

== Some potential fields ==

* A class that marks an element as being an error message. "error", "errormsg" and similar names are used already in [[error-message-examples|examples]].
* An error ID or number. Many systems have unique identifiers for errors, but don't share them with users (for whom they'd be mostly meaningless). This may be a potential use of the [[abbr-design-pattern]], like <nowiki><abbr class="error" title="E5405">Database index error.</abbr></nowiki>".
* Text describing the error situation.
* Instructions for workarounds or correcting user behavior. Possible implementations are an unordered list ("Try this, OR that, OR the other") and an ordered list ("Step one: do this. Step two: do that. Step three: do the other."). They could also be mixed in a hierarchical way. (Note: idea comes from Paypal, which uses an unordered list.)

== Brainstorming examples ==

Below are some brainstorming examples based on the above proposed fields, in roughly increasing order of complexity. Note that they all use "user login" errors, but that this specification is for any kind of error.

Just a text error message:

<pre><nowiki>
<div class="error">Login failed. User name and password not found.</div>
</nowiki></pre>

A text error message with a uniquely identifying error code:

<pre><nowiki>
<div class="error"><abbr title="E3316">Login failed. User name and password not found.</abbr></div>
</nowiki></pre>

An error with some options for correcting the situation:

<pre><nowiki>
<div class="error"><p>Login failed. User name and password not found.</p>
<ul class="instructions">
<li>Check your spelling and try again.</li>
<li>Check that the CAPS LOCK key is not on.</li>
<li>Use the <a href="password-recovery">password recovery</a> tool to get a new
password sent to you.</li>
<li>Contact our <a href="customer-support">customer support</a>.</li>
</ul>
</div>
</nowiki></pre>

An error with step-by-step instructions for fixing the situation:

<pre><nowiki>
<div class="error"><p>Login failed. User account locked due to unconfirmed email address.</p>
<ol class="instructions">
<li>Use the <a href="email-confirmation">email confirmation</a> tool to get a new
confirmation email sent to your account.</li>
<li>Copy the confirmation code you receive in the email
into the <a href="confirmation-code">confirmation code</a> form.</li>
<li>Enter your new password.</li>
</ol>
</div>
</nowiki></pre>

==See also==

*[[error-message-examples]]

error-message-brainstorming

2007-06-27T02:28:44Z

Evan: link to examples

<h1>Error Message Brainstorming</h1>

See also: [[error-message-examples]]

Typical Web applications emit text messages to inform the user of error situations -- either user errors ("Invalid user name or password", "Failed to enter required fields") or system errors ("can't connect to database server", "Call to member function 'foo' on null object.").

There are a number of use-cases for having a standardized, machine-readable format for HTML error messages.

* Automated bug-reporting tools
* Enhanced technical support requests -- a client tool could store recent error messages and transmit them to the support technician
* Workaround-lookups ("What do I do now?") -- a client tool could automatically search company or external knowledge bases for fixes or workarounds for a given error

== Some potential fields ==

* A class that marks an element as being an error message. "error", "errormsg" and similar names are used already in [[error-message-examples|examples]].
* An error ID or number. Many systems have unique identifiers for errors, but don't share them with users (for whom they'd be mostly meaningless). This may be a potential use of the [[abbr-design-pattern]], like <nowiki><abbr class="error" title="E5405">Database index error.</abbr></nowiki>".
* Text describing the error situation.
* Instructions for workarounds or correcting user behavior. Possible implementations are an unordered list ("Try this, OR that, OR the other") and an ordered list ("Step one: do this. Step two: do that. Step three: do the other."). They could also be mixed in a hierarchical way. (Note: idea comes from Paypal, which uses an unordered list.)

error-message-examples

2007-06-27T02:28:05Z

Evan: error brainstorming

error-message-brainstorming

2007-06-25T12:26:39Z

Evan: A couple of easy steps

error-message-brainstorming

2007-06-25T12:24:34Z

Evan: Brainstorming kickoff

Main Page

2007-06-24T18:34:23Z

Evan: /* Exploratory Discussions */ error messages

Welcome to the microformats wiki!

Please start with the [[introduction]] page and read [[how-to-play]] before making any edits.

__TOC__
==Getting Started==

* First, read up on what it means to be [http://microformats.org/wiki/posh <abbr title="Plain Old Semantic HTML">POSH</abbr>] {{NewMarker}}.
* See the [http://microformats.org/about/ about page], [http://microformats.org/ latest news], plus recent [[press]], [[presentations]], [[books]], [[podcasts]], and [[screencasts]].
* Have questions? Read the [[faq|frequently asked questions]] and see the [[glossary]] for new terms.
* Want to learn more in person? Check out microformats [[events]].

==Definition==
One popular definition from our [http://microformats.org/discuss/ mailing list] (see also: [[mailing-lists]]) is "simple conventions for embedding semantics in HTML to enable decentralized development." More precisely, microformats can be defined as:
:simple conventions
:for embedding semantic markup
::for a specific problem domain
:in human-readable (X)HTML/XML documents, Atom/RSS feeds, and "plain" XML
::that normalize existing content usage patterns
::using brief, descriptive class names
::often based on existing interoperable standards
:to enable decentralized development
::of resources, tools, and services

"Or do you just use your browser to browse? That's so 20th century." -- [http://diveintomark.org Mark Pilgrim]

See more explanations of [[what-are-microformats|what are microformats]], and [[what-can-you-do-with-microformats|what you can do with them]].

== How to contribute ==

Do you want to help take microformats to the next level? You can:

* [[advocacy|Advocate]] the use of microformats.
* Write a [[testimonial]].
* Do something on the [[to-do|to do list]].
* Join the [http://microformats.org/discuss mailing lists] and [[irc|IRC Channel]] to learn and help answer questions about microformats.
* [[Main_Page#microformats_wiki_translations_in_other_languages|Translate this microformats wiki into other languages]] to make microformats globally accessible.
* Find [[orphans|orphaned]] pages, and add links to them.
* Before proposing any new microformats, make sure your website is [[POSH]] and uses existing microformats, and then read the [[process]].

== Specifications ==
[[microformats|Microformats]] open standards specifications (see also: [[implementations]], [[examples-in-the-wild]])
* [[hcalendar|hCalendar]] - [http://microformats.org/code/hcalendar/creator hcalendar creator]
* [[hcard|hCard]] - [http://microformats.org/code/hcard/creator hcard creator]
* [[rel-license]]
* [[rel-nofollow]]
* [[rel-tag]]
* [[vote-links|VoteLinks]]
* [http://gmpg.org/xfn/ XFN] (see also: [[xfn-implementations]])
* [http://gmpg.org/xmdp/ XMDP]
* [[xoxo|XOXO]]

== Drafts ==
* [[adr|adr]]
* [[geo|geo]]
* [[hatom|hAtom]]
* [[hresume|hResume]]
* [[hreview|hReview]] - [http://microformats.org/code/hreview/creator hreview creator]
* [[rel-directory]]
* [[rel-enclosure]]
* [[rel-home]]
* [[rel-payment]]
* [[robots-exclusion|Robots Exclusion]]
* [[xfolk|xFolk]]

== Design Patterns ==

{{design_patterns}} 

== Exploratory Discussions ==
Per the microformats [[process]]: research and analysis of real-world [[examples]], existing formats, and brainstorming to motivate the microformat. Please check [[rejected-formats]] before making additions.

* alternates [[alternates-brainstorming|alternates brainstorming]], [[alternates-examples|alternates examples]]
*[[attention]]
* audio-info ([[audio-info-examples|examples]], [[audio-info-formats|formats]], [[audio-info-brainstorming|brainstorming]], [[audio-info-proposal|proposal]]) - Marking up information and metadata related to audio (speech, music, and sound in general). {{NewMarker}}
* blog description [[blog-description-examples|blog description examples]]
* blog info [[blog-info-examples|blog info examples]]
* blog post [[blog-post-examples|examples]], [[blog-post-formats|blog post formats]], and [[blog-post-brainstorming|blog post brainstorming]] (yielded the [[hatom|hAtom]] draft)
* book [[book-examples|book examples]], [[book-formats|book formats]], and [[book-brainstorming|book brainstorming]]
* chat [[chat-examples|chat examples]], [[chat-formats|chat formats]], and [[chat-brainstorming|chat brainstorming]]
* citation [[citation|citation effort]], [[citation-examples|citation examples]], [[citation-formats|citation formats]], [[citation-brainstorming|citation brainstorming]], and [[citation-faq|citation FAQ]]
* code [[code-examples| code examples]], [[code-brainstorming|code brainstorming]] {{NewMarker}}
* comment [[comment-problem|comment problem]], [[comment-examples|comment examples]], and [[comments-formats|comment formats]] (Some stuff needs to be extracted from [[comments-formats]])
* [[collection-description|collection description]] - for describing collections in libraries {{NewMarker}}
* [[course-catalog]]; [[course-catalog-examples]] {{NewMarker}}
* [[currency]]; [[currency-examples]]; [[currency-brainstorming]]; [[currency-proposal]]; [[currency-issues]]
* [[depend-examples]]: examples of dependency graphs, especially as they relate to software {{NewMarker}}
* [[digital-signatures]]: incorporation of digital signatures in Microformatted data; ([[digitalsignature-examples|digital-signature examples]], [[digitalsignature-brainstorming|digital-signatures brainstorming]]) {{NewMarker}}
* directions [[directions-examples|directions examples]] {{NewMarker}}
* directory inclusion [[directory-inclusion-examples|directory inclusion examples]], [[directory-inclusion-formats|directory inclusion formats]]. (see also [[rel-directory]])
* distributed conversation [[distributed-conversation|distributed conversation overview]], [[distributed-conversation-brainstorming|distributed conversation brainstorming]], [[distributed-conversation-examples|distributed conversation examples]], and [[distributed-conversation-formats|distributed conversation formats]]
* error messages [[error-message-examples|error message examples]], [[error-message-brainstorming|error message brainstorming]]
* forms [[forms-examples|forms examples]]
* file-format ([[file-format-examples|examples]], formats, brainstorming) - for the mark-up of file format information (size, type, codecs, bitrate, etc.) {{NewMarker}}
* genealogy [[genealogy-formats|genealogy exploration]]
* geo extensions
** [[geo-extension-strawman]] - extend geo for moons, other planets, etc.
** [[geo-elevation-examples]] - extend geo for representing altitude {{NewMarker}}
** [[geo-waypoint-examples]] - extend geo for representing routes and boundaries, using waypoints {{NewMarker}}
* group [[group-brainstorming|group brainstorming]] and [[group-examples|group examples]]
* grouping ([[grouping-examples|examples]], [[grouping-formats|formats]], [[grouping-brainstorming|brainstorming]], [[grouping-proposal|proposal]]) - Metadata markup of items that should be grouped together. {{NewMarker}}
* items [[items-brainstorming|items brainstorming]] and [[items-examples|items examples]]
* hash [[hash-examples|hash examples]]
* job listing [[job-listing-examples|job listing examples]] and [[job-listing-brainstorming|job listing brainstorming]]
* last modified [[last-modified-examples|last modified examples]], [[last-modified-formats|last modified formats]], and [[last-modified-brainstorming|last modified brainstorming]]
* hListing [[hlisting-proposal|hListing proposal]], and [[hlisting-feedback|hListing feedback]]
** Also, listing [[listing-examples|examples]], [[listing-formats|formats]], and [[listing-brainstorming|brainstorming]]
* [[product|hProduct]] - [[product-brainstorming|hProduct brainstorming]] | [[product-examples|hProduct examples]]
* [[htodo|hToDo]]
* location [[location-formats|location formats]]. (see also [[adr]] and [[geo]])
* measures and measurement units [[measure]]
* [[media-info]] ([[media-info-examples|media-info examples]], [[media-info-formats|media-info formats]], [[media-info-brainstorming|media-info brainstorming]]) {{UpdateMarker}}
* meeting minutes [[meeting-minutes-examples|meeting minutes examples]], [[meeting-minutes-formats|meeting minutes formats]], and [[meeting-minutes-brainstorming|meeting minutes brainstorming]]
* metalink [[metalink-examples|metalink examples]] {{NewMarker}}
* microsummary [[microsummary-brainstorming|microsummary brainstorming]]
* [[mfo-examples|MFO examples]]
* music [[music-examples|music examples]] {{UpdateMarker}}
* [[operating-hours]]: [[operating-hours-examples]] ..of stores, restaurants, etc. {{UpdateMarker}}
* [[payment]]
* photo note [[photo-note-examples|photo note examples]]
*[[question-answer]], [[question-answer-brainstorming]]; [[question-answer-examples]] {{NewMarker}}
* recipe [[recipe-examples|recipe examples]], [[recipe-brainstorming]] {{UpdateMarker}}
* rel-product [[rel-product-brainstorming|rel-product brainstorming]]
* requirements testing [[requirements-testing|requirements testing overview]], and [[requirements-testing-examples|requirements testing examples]]
* [[rest-examples|REST examples]]
* resume [[resume-brainstorming|resume brainstorming]], and [[resume-formats|resume formats]]
* review [[review-examples|review examples]], and [[review-formats|review formats]] (yielded the [[hreview|hReview]] draft)
* search results [[search-results-example|search results example]]
* show [[show-brainstorming|show brainstorming]]
* showroll [[showroll-brainstorming|brainstorming]]
* [[species]] - for the marking up of the scientific names of living things: [[species-examples]]; [[species-brainstorming]] {{UpdateMarker}}
* table [[table-examples|examples]]
* tagspeak [[tagspeak-examples|tagspeak examples]]
* tagcloud [[tagcloud-examples|tagcloud examples]], and [[tagcloud-brainstorming|tagcloud brainstorming]].
* transit table [[transit-table-examples|transit table examples]]
* [[uid]]
* widget [[widget-examples|widget examples]], and [[widget-brainstorming|widget brainstorming]]
* [[wiki-formats|wiki formats]]
* work of art [[work-of-art|work of art overview]], [[workofart-examples|work of art examples]], [[workofart-formats|work of art formats]], and [[workofart-brainstorming|work of art brainstorming]]
*[[xmdp-brainstorming|XMDP brainstorming]] (see also [[xmdp-faq]])
*[[realestate-propertydetail|realestate-propertydetail brainstorming]]

== Examples ==
* [[examples-in-the-wild]]
* [[implementations]]
* [[zen-garden]]

== Tools, Test Cases and Additional Research ==

The first place to look for examples, code, and test cases is in the pages for each individual microformat. There are only a few cross-cutting tools and services that need to process more than one microformat. This section is intended for editors, parsers, validators, test cases, and other information relevant across multiple microformats.

*[[accessibility]]
*[[faqs-for-rdf]]
*[[icalendar-implementations]]
*[[internationalization]]
*[[parsing-microformats]]
*[[selected-test-cases-from-the-web]]
*[http://hg.microformats.org/ Source code repository] -- [[mercurial-quick-start|HowTo: Download code from the repository]]
*[[vcard-implementations]], [[vcard-errata]], [[vcard-suggestions]]
*[[why-are-content-standards-hard]]
* [[profile-examples-in-wild|Profile examples, in the wild]]

== resources ==
* [[buttons]]
* [[icons]]
* [[spread-microformats]]
* [[demo]] - a page with links for quickly demonstrating microformats working in practice.
* [[events]]
* [[user-interface]]
* [[shortcuts]] to wiki pages with long names
* [[marked-for-deletion]]
* [[spellcheck|spell-check dictionary]]
* [[cheatsheets]] are handy if you need a quick reminder about a particular microformat.

== shared work areas ==
* [[to-do]]
* [[microformats-issues]] - issues related to more than one microformat.
* [[external-issues]]

== microformats wiki translations in other languages ==
You may read and edit microformats articles in many other languages:

* languages with over 100 articles
** [[Main_Page-fr|Français (French)]] {{UpdateMarker-fr}}
* languages with over 10 articles
** [[Main_Page-pt-br| Português (Brazilian Portuguese)]]
** [[Main_Page-ja|日本語 (Japanese)]]
* languages with over 2 articles
** [[Main_Page-es|Español (Spanish)]]
** [[Main_Page-de|Deutsch (German)]]
** [[Main_Page-ro|Romanian]]
* elsewhere
**[http://it.wikipedia.org/wiki/Microformat Italiano (Microformats on the Italian language Wikipedia)]

See also [[other-languages]], and [[how-to-start-new-translation|how-to-start-a-new-translation]].

error-message-examples

2007-06-24T18:23:23Z

Evan: Yahoo failed login

error-message-examples

2007-06-24T18:16:53Z

Evan: Technorati login error

error-message-examples

2007-06-24T18:13:00Z

Evan: Google login error

error-message-examples

2007-06-24T18:07:55Z

Evan: pre tags (doh!)

error-message-examples

2007-06-24T18:06:47Z

Evan: A few error messages

rel-tag-issues

2007-02-03T17:02:16Z

Evan: Machine tags

= relTag Issues =

These are externally raised issues about [[rel-tag]] with broadly varying degrees of merit. Thus some issues are REJECTED for a number of obvious reasons (but still documented here in case they are re-raised), and others contain longer discussions. Some issues may be ACCEPTED and perhaps cause changes or improved explanations in the spec. Submitted issues may (and probably will) be edited and rewritten for better terseness, clarity, calmness, rationality, and as neutral a point of view as possible. Write your issues well. — [http://tantek.com/log/ Tantek]

== Issues ==

Please use this format:
* {{OpenIssue}} YYYY-MM-DD raised by AUTHORNAME
*# ''Issue 1: Here is the first issue I have.''
*# ''Issue 2: Here is the second issue I have.''

* {{OpenIssue}} 2007-01-10 raised by [[User:AndyMabbett|Andy Mabbett]]
*# I recently received an e-mail circular, asking that images and blog posts about a particular event be tagged in the style:

::20070110 AB123YZ postcode:uk=AB123YZ upcoming:id=123456 upcoming:event=19876 upcoming:venue=14567 url=example.com geocoded geotagged geo:lat=52.3456 geo:lon=-1.2345

:Is any work being done, to document such tag "schema"? [[User:AndyMabbett|Andy Mabbett]] 12:43, 10 Jan 2007 (PST)

* {{OpenIssue}} 2005-06-21 raised by Hixie
*# ''Issue H-1: This specification is lacking a user agent conformance section. Does the UA simply crawl the DOM looking for all <html:a> elements with a "rel" attribute that contains a "tag" keyword (after space-separated splitting) and then grab the href="" value? How about relative links? Must they implement xml:base? <html:base>? Other things?
*# ''Issue H-2: What's the point? Isn't free-text search more effective than relying on people to remember to put a particular tag?

* 2006-01-10 raised by Adam Willard
*# ''Issue 1: Somewhat confused. Please either fix or elaborate the difference in the URLs in the Tag Spaces area -> is it /tag/ or /tags/ or /wiki/. Is this URI changeable or is this just showing other implementations. If this is the case I am confused on the implementation. Should /wiki/ only show tagged content of wiki? Should URIs be constructed as /definition/ /blog/ etc... to return those items? Or is it just returning pages and the webmaster just decided on /wiki/ or /tag/ or /applicationdir/?''
*#* ACCEPTED FAQ - We need to make this an FAQ entry. --[[User:RyanKing|RyanKing]] 14:46, 25 Jan 2006 (PST) (@TODO)
*# ''Issue 2: More information on actually implementing a tag space would be helpful. I wrote a tagging system on our intranet and we run IIS. So I had to install URLrewrite (ISAPI) to create the URI /tag/tagname. We horrible Microsoft people aren't as lucky to have Mod Rewrite.''
*#* REJECTED IRRELEVANT - Implementing a tagspace is well outside the bounds of the rel-tag specification. --[[User:RyanKing|RyanKing]] 14:46, 25 Jan 2006 (PST)

* 2006-02-09 raised by JonathanFeinberg
*# ''Issue 1: It's bizarre to have the tag be denoted by the URL. The content of the '''a''' tag is a perfectly suitable place to '''contain''' the tag.''
*#* REJECTED, IGNORES ESTABLISHED PRACTICE. Flickr and del.icio.us and other tagging sites established the defacto standard of having the tag term be denoted by the last segment in the URL. [[rel-tag]] was designed to leverage that existing behavior. Theoretical arguments about suitability are irrelevant in the fact of overwhelming existing practice.
*# ''Issue 2: There's no way to distinguish between an individual user's notion of a tag and a global tag (i.e., Fred's java tag versus all things tagged with java.''
*#* REJECTED UNTRUE. ACCEPTED FAQ. Tag spaces (see [[rel-tag]] specification) are used for distinguishing, e.g. Flickr does this with photos from one user with a tag, vs. photos from all users with a tag. [[to-do]] - add this to the the [[rel-tag-faq]].
*# ''Issue 3: It's not reasonable to restrict the host's REST implementation according to this spec's rather limited idea of a "good" tag URL. The idea of tags as query parameters is rejected without justification, for example. Query parameters are a perfectly legitimate means of denoting state.''
*#* REJECTED, IGNORES ESTABLISHED PRACTICE. Flickr and del.icio.us and other tagging sites established the defacto standard of having the tag term be denoted by the last segment in the URL and thus defined what makes a "good" tag URL. [[rel-tag]] has codified this good practice.

* 2006-02-09 raised by Robert Yates
*# ''Issue 1: So I work alongside Jonathan at Lotus / IBM and we have several systems in development each with their own tag implementations. All of them have their own pages that are dedicated to listing the things within them that have been tagged by a given tag. Some of these systems use a url notation that ends in /tag but many (the majority) do not. We are looking to have a standard way that these systems can sematically tag their tags and relTag looked very promising. However, given that some of the systems produce tag urls that do not end in /tag we are a little stuck. It would be extremely hard and somewhat impracticle to get all these groups to ensure that their tag urls end in /tag. Are you at all considering another approach. We'd love to use relTag within our products, but at the moment we can't. Looking for some help / guidance.''
*#* Clarification: By '/tag' do you mean '/<tag-name>'? --[[User:RyanKing|RyanKing]] 15:21, 9 Feb 2006 (PST)
*#*:* yes -- rob yates 18:56, 9 Feb 2006 (EST)
*#* I wanted to do a quick survey to see how many other sites would struggle to easily adopt this format, due to the fact that they don't currently end their tag urls '/<tag-name>'. While I definately agree that ending with '/<tag-name>' is a best practice, I do feel that their needs to be an option for sites that don't do this, but still want to semantically tag their tags. Here's some sites that I found that cannot easily adopt reltag without reworking server side logic. There's some pretty big names on this list.
*#*:* O'Reilly.com. See the tags at this url http://www.xml.com/pub/a/2004/11/10/delicious.html
*#*:* Dodgeball. http://boston.dodgeball.com/tags.php
*#*:* Any typepad blog. See for instance the categories here http://ideasinfood.typepad.com/ideas_in_food/
*#*:* Eventful. http://eventful.com/
*#*:* WordPress blogs, default permalink structure (http://example.com/?cat=N). Pretty permalinks (http://example.com/category/<tagname>) are supported through various methods, but cannot be enabled by default due to technical variances in web servers and setups. The rigidity of the spec has set a high technical barrier to entry. Even if the category name were put into the URL, it would have to be in the querystring for default WordPress setups, which isn't supported in the spec. A querystring fallback (?tag=<tagname>) would enable many more systems to use rel-tag. --[[User:MarkJaquith|MarkJaquith]] 15:39, 20 Oct 2006 (PDT)

* {{OpenIssue}} 2006-04-06 raised by [[User:Evan|Evan]]
*# ''The scope says 'rel="tag" is specifically designed for "tagging" content, typically web pages (or portions thereof, like blog posts).', but it's not clear how to associate a tag with one portion of a web page and not another. Some common use cases: image galleries, blog posts, yellow-pages directories, hcard directories, del.icio.us-style lists of bookmarks. Does the tag apply to the <a> element's immediate containing element? All containing elements? One possibility I suggest: the tag applies to the '''most immediately enclosing element with an "id" attribute''' (addressable, at least in XHTML, as #idval), or to the entire page if there is no such element. Another possibility is having a '''tagtarget''' class, so that the parent with that class is the object being tagged.''

* {{OpenIssue}} 2006-11-24 raised by [[User:AndyMabbett|Andy Mabbett]]
*# Why not ''also'' allow tagging on within-page links (i.e. after "#" as well as after "/")? Then, if I have a page with sub-sections, each of those could be a tag, according to their ID:

<pre><nowiki>
<ul class="navbar">
<li><a href="#whisky" rel="tag">Whisky</a></li>
<li><a href="#wine" rel="tag">Wine</a></li>
</ul>
[...]
<h2 id="whisky">"Whisky</h2>
[...]
<h2 id="wine">"Wine</h2>
[...]
</nowiki></pre>

* {{OpenIssue}} 2006-11-25 raised by [[User:AndyMabbett|Andy Mabbett]]
*#Caution should be advised when recommending Wikipedia as a name-space. For example, an article about Birmingham, Alabama, tagged with a link to http://en.wikipedia.org/wiki/Birmingham would link to an article about Birmingham, England. Similarly, a tag using http://wikitravel.org/en/Newcastle will link to a disambiguation page.

* {{OpenIssue}} 2006-11-26 raised by [[User:AndyMabbett|Andy Mabbett]]
*#There is a danger of encouraging users to breach [http://www.w3.org/TR/WCAG10/wai-pageauth.html#tech-meaningful-links WCAG 1.0 priority 2 guideline 13.6] "'''Clearly identify the target of each link'''". If a page has a link thus <code><a href="http://www.bbc.co.uk">BBC</a></code>, tagging it with a link thus <code><a href="http://www.example.com/BBC" rel="tag">BBC</a></code> will result in two links on the page, both labelled "BBC", with different targets.

*{{OpenIssue}} 2007-01-01 raised Jan 2006 by Ben Buchanan as [http://weblog.200ok.com.au/2006/01/limitations-of-rel-microformat.html limitations of rel="tag" microformat]
*#Summary: Under the current draft, tags and relevant tagspaces are potentially hard to create; and it's still easy to abuse the system. Humans can still be tricked and so can the machines. It's a great spec if you happen to have a compliant directory structure, but if your site doesn't match then you either recreate your entire system... or, more likely, you sadly advise the client that tags aren't happening.

* {{OpenIssue}} 2007-02-03 raised by [[User:Evan|Evan]]
*#There may be value in adopting, supporting or commenting on the [http://www.flickr.com/groups/api/discuss/72157594497877875/ machine tags] format in use at [http://flickr.com/ Flickr]. Machine tags (also called [http://geobloggers.com/archives/2007/01/24/offtopic-ish-flickr-ramps-up-triple-tag-support/ triple tags]) are a structured tag format with the syntax "''namespace'':''property''=''value''". Examples: "geo:city=Portland". It's not clear how machine tags interact with other microformats ("geo:long=..." and "geo:lat=..." are two commonly-used examples, which clearly overlaps with [[geo]]), whether other sites and services will support machine tags, and how to include them here.

== Need reformatting ==

These issues were mistakenly added to the [[rel-tag-faq]] and should have been put here in the first place. They need to be reformatted as issues.

===Are tags case sensitive?===
*Are tags case sensitive. Is "Dog" the same tag as "dog" and "DOG"?

===Multi-word tags===
*How should a multi-word tag be made? For instance, if using Wikipedia as a name space, a page about a Black Redstart (a bird) would be tagged '''Black_Redstart''', with an underscore [http://en.wikipedia.org/wiki/Black_Redstart]. Is there any way of aliasing alternatives ("BlackRedstart", "Black-Redstart", etc.)? Is any particular format preferable?

==Related pages==
{{rel-tag-related-pages}}

xoxo

2006-06-14T01:11:36Z

Evan: /* Draft Specification 2004-10-01 */ Removing "draft" from section headers for specs defined as "specifications" on the main page

<h1> XOXO 1.0: Extensible Open XHTML Outlines </h1>

XOXO is a simple, open outline format written in standard XHTML and suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. XOXO is one of several [[microformats|microformat]] open standards.

__TOC__

== Specification 2004-10-01 ==

=== Editor ===
[http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc]

=== Authors ===
* [http://epeus.blogspot.com/ Kevin Marks], [http://technorati.com Technorati, Inc]
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc] (formerly of [http://microsoft.com/ Microsoft Corporation])
* [http://diveintomark.org/ Mark Pilgrim], [http://ibm.com IBM]
* [http://www.blogologue.com/ Morten W. Petersen]

=== Copyright ===
{{MicroFormatCopyrightStatement2003}}

=== Patents ===
{{MicroFormatPatentStatement}}

== Preamble ==
When we were discussing [http://developers.technorati.com/wiki/attentionxml Attention.xml], Tantek pointed out that XHTML has everything necessary for semantically expressing outlines and blogroll-like subscriptions in an XML format that is both interactively renderable by browsers and parsable by strict XML engines. This page is here to discuss this idea.

=== Name ===
XOXO stands for eXtensible Open XHTML Outlines, and is pronounced variously as 'ecks oh ecks oh', 'zho-zho', or 'sho-sho'.

== Abstract ==
XOXO is one of several [[microformats]]. This specification defines a new XHTML document type that is based upon the module framework and modules defined in Modularization of XHTML ([http://www.w3.org/TR/xhtml-modularization XHTMLMOD]). The purpose of the XOXO document type is to serve as the basis for XHTML friendly outlines for processing by XML engines and for easy interactive rendering by browsers.

== The XOXO Document Type ==
The XOXO document type is made up of the following XHTML modules. The elements, attributes, and minimal content models associated with these modules are defined in "Modularization of XHTML" ([http://www.w3.org/TR/xhtml-modularization XHTMLMOD]). The elements are listed here for information purposes, but the definitions in "Modularization of XHTML" should be considered definitive. In the on-line version of this document, the module names in the list below link into the definitions of the modules within the current version of "Modularization of XHTML".

[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_structuremodule Structure Module]
body, head, html, title
[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_hypertextmodule Hypertext Module]
a
[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_listmodule List Module]
dl, dt, dd, ol, ul, li
[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_metamodule Metainformation Module]
meta
[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_stylemodule Stylesheet Module]
style element
[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_styleattributemodule Style Attribute Module]
style attribute
[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_linkmodule Link Module]
link
[http://www.w3.org/TR/xhtml-modularization/abstract_modules.html#s_legacymodule Legacy Module]
Attribute compact on ol and ul

=== The XOXO Profile ===

See [[xoxo-profile]] for the [http://gmpg.org/xmdp XMDP] profile of XOXO which defines the XOXO values for the class attribute.

== Simple XOXO Fragment ==

=== Markup ===

<pre><nowiki><ol class='xoxo'>
<li>Subject 1
<ol>
<li>subpoint a</li>
<li>subpoint b</li>
</ol>
</li>
<li>Subject 2
<ol compact="compact">
<li>subpoint c</li>
<li>subpoint d</li>
</ol>
</li>
<li>Subject 3
<ol>
<li>subpoint e</li>
</ol>
</li>
</ol>
</nowiki></pre>

=== Sample Rendering ===
<pre><nowiki>
1. Subject 1
a. subpoint a
b. subpoint b
2. Subject 2
3. Subject 3
a. subpoint e
</nowiki></pre>
=== Usage of 'compact' attribute ===

Note the use of the 'compact' attribute to indicate that the subpoints of the headline "Subject 2" are not in an expanded state. The absence of the 'compact' attribute elsewhere indicates that the other headlines are in an expanded state.

=== Possible Default Style Rules for Sample Rendering ===

<pre><nowiki>
ol.xoxo { list-style:decimal; }
ol.xoxo ol { list-style:lower-latin; }
ol[compact="compact"] { display:none; }
</nowiki></pre>

== More Simple Examples ==

MarkP has a set of examples that demonstrates both the simplicity of the markup and the presentational richness that is possible:

* [http://diveintomark.org/public/2004/01/xo-flat.xo simple XO file that can be embedded directly into an XHTML page]
* [http://diveintomark.org/public/2004/01/xo-embeddable.xo XO with nested groups, also directly embeddedable in XHTML]
* [http://diveintomark.org/public/2004/01/xo-standalone.xo XO as a standalone XHTML page] ([http://validator.w3.org/check?uri=http%3A%2F%2Fdiveintomark.org%2Fpublic%2F2004%2F01%2Fxo-standalone.xo valid XHTML])
* [http://diveintomark.org/public/2004/01/xo-with-style.xo XO as a standalone XHTML page, styled with CSS] ([http://validator.w3.org/check?uri=http%3A%2F%2Fdiveintomark.org%2Fpublic%2F2004%2F01%2Fxo-with-style.xo also valid XHTML])
* [http://homepage.mac.com/ctholland/thelab/outlines/ Chris Holland Outline Helper]: tweaked one of above samples, yanked CSS for simplicity, added reference to [http://homepage.mac.com/ctholland/thelab/outlines/outlines.css outlines.css] and [http://homepage.mac.com/ctholland/thelab/outlines/outlines.js outlines.js], pasted a few different combinations of ul/ol/li with the compact attribute.
** in trying to comply with semantic principles the "compact" attribute to ol and ul elements is what drives the display state. Via scripting, i'm setting classes on containing li element for added styling flexibility, though CSS Gurus might be able to replace "li.expanded" in outlines.css with some other CSS selector that says "select an li node that contains an ol node with a 'compact' attribute set".

== Properties of Outline Items ==
Outlines typically consist of a hierarchy of points and subpoints. Each of those points (outline items) itself may have some properties (AKA attributes or metadata) that need to be represented. Perhaps the most common additional property on outline items in practice is the URL as demonstrated in Mark Pilgrim's examples above. Even the text label/title of an outline item could be considered a common property. A few such common properties:
* text
* description
* url (often called xmlurl or htmlurl; sometimes called permalink)
* title
* type (hint of the MIME type of the resource indicated by the URL)

In general, properties on an outline item <code><nowiki><li></nowiki></code> are represented by a nested definition list <code><nowiki><dl></nowiki></code>. Strictly speaking, it is the first <code><nowiki><dl></nowiki></code> inside the <code><nowiki><li></nowiki></code> and before any following <code><nowiki><ol></nowiki></code>, <code><nowiki><ul></nowiki></code>, or <code><li></code>, e.g. here is an item "item 1" with a description property (the subpoints are there purely as a point of reference to an earlier example).

<pre><nowiki>
<ol class='xoxo'>
<li>item 1
<dl>
<dt>description</dt>
<dd>This item represents the main point we're trying to make.</dd>
</dl>
<ol>
<li>subpoint a</li>
<li>subpoint b</li>
</ol>
</li>
</nowiki></pre>

=== Special Properties ===
There are a handful of special properties which we are able to represent more directly and conveniently with the semantic XHTML building blocks that we have included, instead of terms in a definition list. Mostly taken from the above list of common properties, these are:
* text, url, title, type, and rel (short for relationship)

If we were to represent them simply as definition terms (including the "description" property from the previous example), they might look something like this:

Example for the sake of discussion only / not a canonical XOXO example:

<pre><nowiki>
<ol cla

</nowiki></pre>

vote-links

2006-06-14T01:11:20Z

Evan: /* Draft Specification 2005 */ Removing "draft" from section headers for specs defined as "specifications" on the main page

= Vote Links =
__TOC__
== Specification 2005 ==
=== Editor ===
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.] (formerly of [http://microsoft.com/ Microsoft Corporation])

=== Concept ===
* [http://epeus.blogspot.com/ Kevin Marks], [http://technorati.com, Technorati,Inc.]

=== Authors ===
* [http://epeus.blogspot.com/ Kevin Marks], [http://technorati.com Technorati, Inc]
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc]

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to everyone who has given feedback on VoteLinks. Thanks especially to EtanWexler, who provided the first really good documentation that VoteLinks should be using 'rev' instead of 'rel' (see [[VoteLinksFAQ]]), and John Allsopp who similarly challenged the use of 'rel', and helped co-author the [[RelFAQ]] exploring questions and issues about the use of the HTML4 'rel', 'rev' attributes and linktypes in general.

== Introduction ==
Indexing and tracking applications treat all links as endorsements, or expressions of support. This is a problem, as we need to link to those we disagree with as well, to discuss why.

== Specification ==
VoteLinks is an [[elemental-microformat|elemental microformat]], one of several [[microformats|microformat]] open standards.
We propose a set of three new values for the rev attribute of the <a> (hyperlink) tag in HTML.

The new values are "vote-for" "vote-abstain" or "vote-against", which are mutually exclusive, and represent agreement, abstention or indifference, and disagreement respectively.

A link without an explicit vote 'rev' value is deemed to have value "vote-for" or "vote-abstain", depending on the application.

Additional human-readable commentary can be added using the existing 'title' attribute, which most browsers show as a rollover.

Examples:
<pre><nowiki>
<a rev="vote-for" href="http://ragingcow.blogspot.com"
title="neat spoof">Raging Cow</a>
<a rev="vote-against" href="http://ragingcow.com"
title="nasty corn syrup drink">Raging Cow</a>
</nowiki></pre>

=== Deprecated: Using 'rel' for VoteLinks ===
A previous draft of the specification used the 'rel' value instead of the 'rev' attribute. Analysis and feedback has demonstrated this to have been inappropriate use of the 'rel' attribute, when the 'rev' attribute was much more important. See the [[RelFAQ]] for more details.

Implementations MAY support links with the VoteLinks values in the 'rel' attribute for backward compatibility with any existing VoteLinks content.

Authors MUST NOT use 'rel' for VoteLinks values.

== XMDP profile ==
<pre><nowiki>
<dl class="profile">
<dt id="rev">rev</dt>
<dd><p><a rel="help" href="http://www.w3.org/TR/html401/struct/links.html#adef-rev">
HTML4 definition of the 'rev' attribute.</a>
Here are some additional values.</p>
<dl>
<dt id="vote-for">vote-for</dt>
<dd>Indicates agreement with or recommendation for the referred resource.</dd>
<dt id="vote-abstain">vote-abstain</dt>
<dd>Indicates abstention or indifference for the referred resource.</dd>
<dt id="vote-against">vote-against</dt>
<dd>Indicates disagreement with or recommendation against the referred resource.</dd>
</dl>
</dd>
</dl>
</nowiki></pre>

== Implementations ==
This section is '''informative'''.

* [http://moloko.itc.it/paoloblog/ Paolo Massa] created [http://moloko.itc.it/paoloblog/semantic_links/ SemanticLinks], a small Firefox extension that shows vote-for, vote-against links information. (Note the download links for SemanticLinks have been removed by the author.)

== Normative References ==
* [http://gmpg.org/xmdp/ XMDP]

== Related Work ==
* [[xoxo]]
* [http://gmpg.org/xfn/ XFN]
* [http://developers.technorati.com/wiki/attentionxml Attention.xml]
* [[rellicense]]
* [[reltag]]
* [[relnofollow]]

== FAQ ==
* See [[votelinks-faq]] and the broader [[rel-faq]].
* See also [[votelinks-issues]] for issues which have been raised with the votelinks [[microformat]].

rel-tag

2006-06-14T01:11:02Z

Evan: /* Draft Specification 2005-01-10 */ Removing "draft" from section headers for specs defined as "specifications" on the main page

<h1> rel-tag </h1>

__TOC__

== Specification 2005-01-10 ==
=== Editor/Author ===
[http://tantek.com/ Tantek Çelik]

=== Concept ===
[http://powazek.com/ Derek Powazek]
[http://epeus.blogspot.com/ Kevin Marks]

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}

=== Patents ===
{{MicroFormatPatentStatement}}

== Abstract ==
[[Rel-Tag]] is one of several [[MicroFormats]]. By adding <code>rel="tag"</code> to a hyperlink, a page indicates that the destination of that hyperlink is an author-designated "tag" (or keyword/subject) of the current page. Note that a tag may just refer to a major portion of the current page (i.e. a blog post). e.g. by placing this link on a page,

<pre><nowiki><a href="http://technorati.com/tag/tech" rel="tag">tech</a></nowiki></pre>

the author indicates that the page (or some portion of the page) has the tag "tech".

The linked page SHOULD exist, and it is the linked page, rather than the link text, that defines the tag. The last path component of the URL
is the text of the tag, so

<pre><nowiki><a href="http://technorati.com/tag/tech" rel="tag">fish</a></nowiki></pre>

would indicate the tag "tech" rather than "fish".

== Scope ==
rel="tag" is specifically designed for "tagging" content, typically web pages (or portions thereof, like blog posts).

rel="tag" is NOT designed for "tagging" arbitrary URLs or external content. There is demand for a general decentralized syntax for tagging URLs, and that is certainly something to think about, but this is not meant for that. See [[xfolk|xFolk]] and [[hreview|hReview]] for ways to tag arbitrary URLs.

== XMDP profile ==
<pre><nowiki>
<dl class="profile">
<dt id="rel">rel</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/links.html#adef-rel">
HTML4 definition of the 'rel' attribute.</a>
Here is an additional value.</p>
<dl>
<dt id="tag">tag</dt>
<dd>Indicates that the referred resource serves as a "tag",
or keyword/subject, for the referring page.</dd>
</dl>
</dd>
</dl>
</nowiki></pre>

== Tag Spaces ==

Tags are embedded in HTTP URIs in a well-defined manner so that the tag embedded in an HTTP URI can be mechanically extracted from that URI. Specifically, the last segment of the path portion of the URI (after the final "/" character) contains the tag value. For example, the URI <pre><nowiki>http://www.example.com/tags/foo</nowiki></pre> contains the tag "foo".

Thus, for the purposes of comparing two HTTP URIs as tags, the last segment of the path portion should be extracted and only that value (that value of the tag) should be compared.

''Need more formal language about comparison and extraction process.''

The destination of a rel="tag" hyperlink is required to be a tag space (a place that collates or defines tags), where the last segment of the path of the URL is the tag, e.g.

<pre><nowiki>http://technorati.com/tag/tech </nowiki></pre>

is a URL for the tag "tech".

Tags may only be placed in the URL path, and only in the last segment of the path. Tags may not be placed in query parameters or fragment identifiers. e.g.

<pre><nowiki>http://technorati.com/tag/tech?tag=fish#emu </nowiki></pre>

is still a URL for the tag "tech", not "fish" or "emu".

Since the only part of a tag space URL of which any structure is required is the last path segment, a tag space URL can be hosted at any domain. Authors may choose to link to a tag at a particular tag space in order to provide a specific meaning. E.g. a tag for technology could link to:

<pre><nowiki> http://en.wikipedia.org/wiki/Technology </nowiki></pre>

Trailing slashes in tag URLs are ignored, that is:

<pre><nowiki> http://technorati.com/tag/Technology/ </nowiki></pre>
as a rel-tag URL is treated as:
<pre><nowiki> http://technorati.com/tag/Technology </nowiki></pre>

== Encodin

rel-nofollow

2006-06-14T01:10:41Z

Evan: /* Draft Specification 2005-01-10 */ Removing "draft" from section headers for specs defined as "specifications" on the main page

= rel="nofollow" =
__TOC__

== Specification 2005-01-10 ==

=== Editors ===
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]
* [http://epeus.blogspot.com/ Kevin Marks], [http://technorati.com Technorati, Inc.]

=== Concept ===
* [http://www.google.com/googleblog/ Matt Cutts], [http://google.com Google, Inc]
* [http://www.shellen.com/ Jason Shellen], [http://www.blogger.com Blogger]/[http://www.google.com Google]

=== Copyright ===
{{MicroFormatCopyrightStatement2005}}

=== Patents ===
{{MicroFormatPatentStatement}}

== Abstract ==
RelNoFollow is an [[elemental-microformat|elemental microformat]], one of several [[microformats|microformat]] open standards. By adding <code>rel="nofollow"</code> to a hyperlink, a page indicates that the destination of that hyperlink SHOULD NOT be afforded any additional weight or ranking by user agents which perform link analysis upon web pages (e.g. search engines). Typical use cases include links created by 3rd party commenters on blogs, or links the author wishes to point to, but avoid endorsing. For more specific endorsement (or lack thereof) semantics, see VoteLinks.

== XMDP profile ==
<pre><nowiki>
<dl class="profile">
<dt id="rel">rel</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/links.html#adef-rel">
HTML4 definition of the 'rel' attribute.</a>
Here is an additional value.</p>
<dl>
<dt id="nofollow">nofollow</dt>
<dd>Indicates that the referred resource was not necessarily linked to
by the author of the page, and thus said reference should not afford
the referred resource any additional weight or ranking by user agents. </dd>
</dl>
</dd>
</dl>
</nowiki></pre>

== normative references ==
* [http://gmpg.org/xmdp/ XMDP]
* http://www.google.com/googleblog/2005/01/preventing-comment-spam.html
* http://googleblog.blogspot.com/2005/01/preventing-comment-spam.html

== informative references ==
* VoteLinks can be used by an author to explicitly state their support for or against, or neutrality toward the destination of a link. Implementers implementing rel="nofollow" and VoteLinks should similarly not afford any additional weight or ranking to links with either <code>rev="vote-abstain"</code> or <code>rev="vote-against"</code>.
* Contributed from http://developers.technorati.com/wiki/RelNoFollow

== open issues ==
These are open issues that have been raised about rel="nofollow" that have been raised in various forums, in particular, on the public [http://lists.w3.org/Archives/Public/www-html W3C www-html mailing list]. They have been grouped into four areas.

* '''Definition'''. nofollow indicates a behavior rather than a relationship from which the behavior should be inferred as appropriate for the useragent. rel values should be nouns that indicates what the resource being referenced is in relation to the source.
* '''Name'''. nofollow is a bad name.
** overloading. does not mean the same as robots exclusion standards (robots.txt, meta robots) nofollow.
** does not mean what it says. does not mean "do not follow this link", rather it means " do not add weight from this link". [http://www.w3.org/mid/opsk3cccj9lo81gp@quark Asbjørn Ulsberg]
** not a noun. see above.
** suggested alternatives:
*** noendorse - [http://lists.w3.org/Archives/Public/www-html/2005Jan/0046.html Micah Dubinko]
*** none
*** noweight
*** unendorsed - [http://lists.w3.org/Archives/Public/www-html/2005Jan/0057.html Lachlan Hunt]
*** unrelated - [http://lists.w3.org/Archives/Public/www-html/2005Jan/0049.html Jens Meiert]
*** untrusted
*** nonauth - [http://www.mnot.net/blog/2003/12/29/comment_spam_and_google Mark Baker]
*** norank - [http://www.digitalburg.com/ Ben Pierce]
* '''Efficacy'''. nofollow will not affect spamming behavior.
* '''Collateral Damage'''. If tools automatically add nofollow to all 3rd party links, then many legitimate non-spam links will be ignored or given reduced weight, and thus the destination of such links will be unfortunate casualties.

=== additional lists of issues ===
Additional lists of issues raised against rel="nofollow" can be found at the following site(s):
* http://www.nonofollow.net/

rel-license

2006-06-14T01:10:25Z

Evan: /* Draft Specification 2005-02-06 */ Removing "draft" from section headers for specs defined as "specifications" on the main page

= rel="license" =

Rel-License is a simple, open, format for indicating content licenses which is embedable in (X)HTML, Atom, RSS, and arbitrary XML. Rel-License is one of several [[microformats|microformat]] open standards.

__TOC__

== Specification 2005-02-06 ==
=== Author ===
[http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.] (formerly of [http://microsoft.com/ Microsoft Corporation])

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}

=== Patents ===
{{MicroFormatPatentStatement}}

== Abstract ==

Rel-License is one of several MicroFormats. By adding <code>rel="license"</code> to a hyperlink, a page indicates that the destination of that hyperlink is license for the current page. E.g. with the following hyperlink:

<pre><nowiki>
<a href="http://creativecommons.org/licenses/by/2.0/" rel="license">cc by 2.0</a>
</nowiki></pre>

the author indicates that the page is licensed under a Creative Commons 2.0 Attribution Required license.

== Multiple Licenses ==
Multiple such rel="license" hyperlinks indicate that the page is available under any of the referred licenses. E.g. the following hyperlinks could be used to declare that a page is available under either a Creative Commons 2.0 Attribution Required license or the Apache 2.0 license:

<pre><nowiki><a href="http://creativecommons.org/licenses/by/2.0/" rel="license">cc by 2.0</a>
<a href="http://www.apache.org/licenses/LICENSE-2.0" rel="license">Apache 2.0</a></nowiki></pre>

== XMDP profile ==
<pre><nowiki>
<dl class="profile">
<dt id="rel">rel</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/links.html#adef-rel">
HTML4 definition of the 'rel' attribute.</a>
Here is an additional value.</p>
<dl>
<dt id="license">license</dt>
<dd>Indicates that the referred resource is a license for the referring page.</dd>
</dl>
</dd>
</dl>
</nowiki></pre>

== Implementations ==
* [http://www.webstandards.org/action/dwtf/microformats/ Dreamweaver Extension suite] from the [http://webstandards.org/ Web Standards Project] enables the authoring of rel-license links from within Dreamweaver 8. Includes (cc) defaults.
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding rel license and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* [http://creativecommons.org/license/ Creative Commons (cc) license chooser]
* [http://search.yahoo.com/cc Yahoo! (cc) search]
* [http://www.google.com/support/bin/answer.py?answer=29508 Google "Usage Rights" search]

== References ==
=== Normative References ===
* [http://gmpg.org/xmdp/ XMDP]

=== Informative References ===
* 20040211 rel="license" first proposed in presentation [http://tantek.com/presentations/2004etech/realworldsemanticspres.html real world semantics] at 2004 O'Reilly Emerging Technologies Conference, San Diego, CA, USA.
* 20040225 [http://tantek.com/log/2004/02.html#d25t1805 Thorough discussion of rel="license"] including advantages and presentation possibilities.
* [http://creativecommons.org/licenses/by/2.0/ Creative Commons 2.0 By (Attribution Required) license]
* [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0 license]
* Contributed from http://developers.technorati.com/wiki/RelLicense

== see also ==
* See [[rellicense-issues]] for issues which have been raised with this [[microformat]].

hcard

2006-06-14T01:10:11Z

Evan: Removing "draft" from section headers for specs defined as "specifications" on the main page

<h1>hCard</h1>

hCard is a simple, open, distributed contact information format for people, companies, and organizations, which is suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. hCard is a 1:1 representation of the vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]) in XHTML, one of several open [[microformats|microformat]] standards.

Want to get started with writing an [[hcard|hCard]]? Use the [http://microformats.org/code/hcard/creator hCard creator] to write up some contact information and publish it, or follow the [[hcard-authoring|hCard authoring tips]] to add hCard markup to your current contact page.

__TOC__

== Specification ==

=== Editor ===
[http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]

=== Authors ===
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc]
* [http://suda.co.uk/ Brian Suda]

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to: my good friend [http://vadim.com/ 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.

== Introduction ==
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt 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 is a 1:1 representation of the aforementioned vCard standard, in semantic XHTML. Bloggers can both embed vCards directly in their web pages, and style them with CSS to make them appear as desired. In addition, hCard enables applications to retrieve information about such vCards directly from web pages without having to reference a separate file.

Use the [http://microformats.org/code/hcard/creator hCard creator], copy the HTML code it generates to your blog or website to publish your contact info.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
=== In General ===
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt 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 XHTML elements.

=== More Semantic Equivalents ===
However, for some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:
* <code>URL</code> in vCard becomes <code><a class="url" href="...">...</a></code> inside the element with <code>class="vcard"</code> in hCard.
* 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>UID</code> in vCard simply becomes another semantic applied to a specific URL (or EMAIL) for an hCard.

=== Singular vs. Plural Properties ===

For properties which are singular (e.g. "N" and "FN"), the first descendant element with that class should take effect, any others being ignored.

For properties which can be plural (e.g. "TEL"), each class instance should create a instance of that property. Plural properties with subtypes (e.g. TEL with WORK, HOME, CELL) can be optimized to share a common element for the property itself, with each instance of subtype being an appropriately classed descendant of the property element.

==== 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.

=== Human vs. Machine readable ===

If an <code><abbr></code> element is used for a property, then the '<code>title</code>' attribute of the <code><abbr></code> element is the value of the property, instead of the contents of the element, which instead provide a human presentable version of the value.

If an <code><a></code> element is used for one or more properties, it must be treated as follows:
# For the "PHOTO" property and any other property that takes a URL as its value, the <code>href="..."</code> attribute provides the property value.
# For other properties, the element's content is the value of the property.

If an <code><img></code> element is used for one or more properties, it must be treated as follows:
# For the "PHOTO" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value.
# For other properties, the <code><img></code> element's '<code>alt</code>' attribute is the value of the property.

If an <code><object></code> element is used for one or more properties, it must be treated as follows:
# For the "PHOTO" property and any other property that takes a URL as its value, the <code>data="..."</code> attribute provides the property value.
# 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 should be 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 "<code>value</code>" is introduced 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:

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

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.

# '''NAME''', '''PROFILE''', '''SOURCE''', '''PRODID''', '''VERSION''' properties as defined in Sections 2.1.2, 2.1.3, 2.1.4, 3.6.3, 3.6.9 of RFC 2426. 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 <code><title></code> element in (X)HTML documents) to construct the NAME property, MAY output a PROFILE value of "<code>VCARD</code>" per RFC 2426, 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 or organization and should be treated as such. In this case the author MUST also 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 (RFC 2426) 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, [http://microformats.org/wiki/hcard#Organization_Contact_Info see above] for that.

# The content of "FN" is broken into two "words" separated by whitespace.
# The ''first'' word of the "FN" is interpreted as the "given-name" for the "N" property.
# The ''second/last'' word of the "FN" is interpreted as the "family-name" for the "N" property.
# 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 on the Web in actual content published on the Web (e.g. authors of [[hReview|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:

# The content of the "FN" is treated as a "nickname" property value.
# Parsers should handle the missing "N" property by implying empty values for all the "N" sub-properties.

Note: 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 can optionally 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.

=== Root Class Name ===

The root class name for an hCard is "vcard".

=== Property List ===

This is the list of properties (and subproperties, in parentheses, like this) in hCard, taken from vCard:

* fn, n (family-name, given-name, additional-name, honorific-prefix, honorific-suffix), nickname, sort-string
* url, email (type, value), tel (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
==== 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:
<pre><nowiki>
<span class="tel"><span class="type">Home</span> (<span class="type">pref</span>erred):
<span class="value">+1.415.555.1212</span>
</span>
</nowiki></pre>

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 [http://gmpg.org/xmdp XMDP] profile of hCard which contains the above complete list of properties, with references to their RFC 2426 definitions.

=== Parsing Details ===

See [[hcard-parsing|hCard parsing]].

== Examples ==

This section is informative.

=== Sample vCard ===

Here is a sample vCard:

<pre><nowiki>
BEGIN:VCARD
VERSION:3.0
N:Çelik;Tantek
FN:Tantek Çelik
URL:http://tantek.com/
ORG:Technorati
END:VCARD
</nowiki></pre>

and an equivalent in hCard with various elements optimized appropriately. See [[hcard-example1-steps| hCard Example 1]] for the derivation.

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

This hCard might be displayed as:

[http://tantek.com/ Tantek Çelik]<br />
Technorati

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.

=== More Examples ===

See [[hcard-examples]] for more examples, including all examples from vCard RFC 2426 converted into hCard.

== Examples in the wild ==
This section is '''informative'''.

The following sites have published hCards, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you have an hCard on your own page, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

=== New Examples ===
Please add new examples to this section.
* [http://www.vivabit.com/atmedia2006/speakers/ @media speakers] are marked up with hCard (photos depend on BASE tag support which makes this a good test case)
* [http://www.dougransom.com Doug Ransom] uses hCard for his financial advisory practice.
* [http://rubyandrails.org/usergroups/newcastle/members.html ncl.rb] uses hCard for contact information.
* [http://www.snowinteractive.com/ Snow Interactive] uses hCard for contact information.
* [http://flickr.com Flickr] now supports [[hcard|hCard]] and [http://gmpg.org/xfn XFN] on profile pages. See [http://flickr.com/photos/factoryjoe/113866484/ screenshot of Flickr UI in Flock browser using Flocktails extension - March 17th 2006].
* [http://www.ndiyo.org/contact Contact information for the Ndiyo project]
* [http://www.pixelenvy.co.uk/ Pixel Envy] uses hCard for contact information on every page
* [http://stilbuero.de/contact/ Klaus Hartl] uses hCard in the sidebar for contact information (maybe easier to parse through delivering xhtml as xml).
* [http://charlvn.virafrikaans.com/contact Charl van Niekerk's hCard]
* [http://billy-girlardo.com/WP/ BillyBLOGirlardo] uses hCard for contact information.
* [http://www.hicksdesign.co.uk/ Hicksdesign] uses hCard for contact information.
* http://www.gr0w.com/articles/press/growsearch_launched_press_release/ - hCard in a press release for the press contact info
* http://www.redmonk.com/cote/archives/2006/03/testing_out_mic.html - hCard with explanation
* [http://andy.ciordia.info/ it's my island], personal blog, hcard on the ''[http://andy.ciordia.info/pages/about_me About the Writer]'' page. [[User:Ciordia9|Andy Ciordia]]
* [http://www.windowonwoking.org.uk/ Window on Woking], a local community site in the UK, uses hCard in the homepage of each member organisation and local Councillor.
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site -- by [[User:ChrisCasciano|Chris Casciano]]
* [http://www.30boxes.com/ 30 Boxes],a social calendar application and digital lifestyle aggregator, automatically creates an hcard for you with your account. It is found under Settings > Syndication.
* [http://www.nearwhere.com/ Nearwhere.com] allow you to put an hcard on an interactive map.
* [http://www.brentozar.com/ Brent Ozar] added a [http://www.brentozar.com/contact.php contact] page hCard.
* [http://www.kerihenare.com/ Keri Henare] has rewritten his [http://www.kerihenare.com/contact/ contact] page hCard. Now using <code><object></code> instead of <code><img></code> for photo. (Thanks Brian Suda for updating the vCard converter)
* [http://michaelraichelson.com/contact/ Michael Raichelson] had an hCard on his contact page before SXSW, but never thought to add it here until Tantek requested it.
* [http://www.commoner.com/~lsimon/lindsey_simon_hcard.html Lindsey Simon] has added an hCard to his website as per Tantek's SXSW request for folks to try it
* [http://www.davidgagne.net/ David Gagne] has an hCard in his sidebar.
* [http://www.churchzip.com/map/ Churchzip.com/map] and [http://www.skiwhere.com/map/ Skiwhere.com/map], provide churches, hotels, and ski resorts on the same maps. Locations are formatted as hcards.
* All [http://www.iqdir.com/ IQ Directory Solutions] Yellow Pages web portals use [[hcard|hCard]] markup on listings. For example [http://www.yellowpages-cambodia.com/ Cambodia Yellow Pages] and [http://www.superpages.com.my/ Malaysia Super Pages]
* Ning's cloneable Group app uses fuzzy matching to map custom fields to [[hcard|hCard]] markup on its [http://group.ning.com/index.php?controller=person&action=view&content=JonathanAquino profile] pages.
* [http://claimid.com/factoryjoe Chris Messina' ClaimID hCard]
* [http://factoryjoe.com/blog/hcard Chris Messina' hCard]
* [http://flock.com/about Flock About]
* [http://tantek.com/microformats/2006/03-01-TechPlenAgenda.html Agenda: W3C Technical Plenary Day, March 1 2006] has [[hcard|hCard]] and [[hcalendar|hCalendar]] markup. ([http://www.w3.org/2006/03/01-TechPlenAgenda.html original here]).
* [http://www.gr0w.com/articles/press/growsearch_launched_press_release/ GrowSearch Launched (Press Release)] uses an hCard to provide Press Contact Point.
* The [http://www.arborday.org/ National Arbor Day Foundation] has started using hCards for their [http://arborday.org/programs/conferences/communityforestry/index.cfm upcoming] [http://arborday.org/programs/conferences/hazardtrees-treeplanting/ conferences].
* [http://www.multipack.co.uk The Multipack] has numerous hCards, especially on the [http://www.multipack.co.uk/members/ members page], as well as the next meeting information.
* [http://deadringrancor.livejournal.com/ Justin McDowell] used an hCard when [http://deadringrancor.livejournal.com/221332.html referring to a person in his blog post]
* [http://davecardwell.co.uk/cv/ Dave Cardwell] has included his hCard in his Curriculum Vitae.
* [http://blog.usweb.com/ Shaun Shull] has written a great post on [http://blog.usweb.com/archives/how-microformats-affect-search-engine-optimization-seo How Microformats Affect SEO], and has included his [[hcard|hCard]] as one of the examples.
* [http://www.thefutureoftheweb.com/ Jesse Skinner] has written a simple [http://www.thefutureoftheweb.com/blog/2006/1/hcard tutorial with examples]
* [http://www.w3.org/2005/12/allgroupoverview.html 2006 W3C Technical Plenary Week] has marked up the venue, contacts, and program committee members all with hCard.
* [http://www.avf-nexus.co.uk AVF-Nexus] have a hCard on their [http://www.avf-nexus.co.uk/contact/ contact page] - (by [http://creation.uk.com Creation"])
* [http://www.thefantasticos.com/andrew/ Andrew White] posted [http://www.thefantasticos.com/andrew/index.php/my-hcard/ his hCard] and [http://www.thefantasticos.com/andrew/index.php/62/microformats-the-should-have-been-obvious-web-dev-tool/ blogged about it].
* [http://www.2sheds.ru Oleg "2sheds" Kourapov] in his [http://www.2sheds.ru/blog/ blog] ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog X2V]) has turned personal profile into hCard ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog/hcard.html X2V]) and his blogroll - into combination XFN/hCards ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog/friends.html X2V])
* [http://www.approveddesign.co.uk Approved Design Consultancy] have a hCard on their [http://www.approveddesign.co.uk/about/contact/ contact page] as well as on their [http://www.approveddesign.co.uk/about/people/ people section] - (by [http://creation.uk.com Creation"])
* [http://weblog.200ok.com.au/ Ben Buchanan] and [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=colin+morris&format=search Colin Morris] have [http://weblog.200ok.com.au/2006/01/griffith-phonebook-adds-hcard-and.html implemented hCards and vCards] for the [http://www.griffith.edu.au Griffith University] [http://www.griffith.edu.au/find/content_phonebook.html online phone book]. Eg. [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=ben+buchanan&format=search Ben's vCard] and [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=colin+morris&format=search Colin's vCard]
* WWF-Australia [http://wwf.org.au/about/contactdetails/ contact details page]
* [http://rasterweb.net/raster/ Pete Prodoehl] used the hCard format on his [http://rasterweb.net/raster/contact.html Contact page]
* [http://alexander-mette.de amette] uses the hCard format in a module of his TikiWiki powered blog
* [http://staff.washington.edu/oren/weblog2/ Oren Sreebny] has an hcard on his blog main index template
* [http://www.cs.brandeis.edu/~zippy/ Patrick Tufts] has an hCard on his homepage.
* [http://ascii20.blogspot.com/ Mathias Kolehmainen and Jamie Taylor] have hCards on their weblog.
* [http://www.hoppsan.org/jamesb/blogger/ Barnaby James] has a hCard on his weblog.
* [http://esa-education.com/schools/map ESA Education] Uses hCards for their 100+ schools and each of the individual school sites.
* [http://www.thereisnocat.com/#vcard Ralph Brandi] has added an hCard to the sidebar of his weblog as a result of Tantek Çelik's portion of the Microformats presentation at SXSW 2006.
* [http://www.yellowpencil.com/contact/ Yellow Pencil] Using microformats to present company contact information
* [http://www.pierce.ctc.edu/ephone/ Pierce College] -- community college directory uses hCard on all individual directory entries.
* [http://www.ukoln.ac.uk/web-focus/events/workshops/webmaster-2006/ the Institutional Web Management Workshop 2006] have marked up all their [http://www.ukoln.ac.uk/web-focus/events/workshops/webmaster-2006/committee/ speakers with hCard].
* http://wikitravel.org/en/Singapore/Sentosa. Wikitravel is experimenting with hcard on its travel guides. This guide uses hcard for all its business listings. More info on http://wikitravel.org/en/Wikitravel_talk:Listings.
* [http://www.musik-erber.de/ Musik-Erber] uses to present contact information at the sidebar
* [http://cdevroe.com/about/#contact Colin D. Devroe] uses hCard to display his contact information on his about page
* The ECS (Scool of Electronics and Computer Science at the University of Southampton) [http://www.ecs.soton.ac.uk/people People Pages] use vCard. Contact cjg@ecs.soton.ac.uk if there's any bugs.
* [http://www.southwestern.edu/~ramseyp Pat Ramsey] has his contact information on his blog marked up with hCard. Contact [mailto:ramsey.pat@gmail.com ramsey.pat@gmail.com] if there are any bugs there.
* [http://www.meryl.net/ Meryl K. Evans] has a hidden hCard on her homepage.

=== Examples ===
* [http://thoughtport.blogspot.com/ Aiden Kenny] hasn't published his hCard yet, but he has [http://thoughtport.blogspot.com/2005/07/elemental-particles-of-web.html published his hCard icon]: http://photos1.blogger.com/blogger/4224/444/320/AK-Hcard-icon.gif
* [http://thedredge.org Andy Hume] uses hCards to mark-up the names and URLs of commentors on his blog, e.g. his [http://thedredge.org/2005/06/using-hcards-in-your-blog/ blog post on "Using hCards in your blog"].
* [http://www.bidclix.com/ BidClix]'s [http://www.bidclix.com/AboutContact.html Contact BidClix] page has it's ''contact info'' marked up with an hCard.
* [http://suda.co.uk/ Brian Suda] has managed to embed a photo in [http://suda.co.uk/contact/ his hCard] through the [http://www.ietf.org/rfc/rfc2397.txt data uri scheme] by converting the image to BASE64 code. View the Source to see how this is accomplished. [http://suda.co.uk/projects/X2V/get-vcard.php?uri=http%3A//suda.co.uk/contact/ The X2V link] will extract the image and encode it for a vCard which will be displayed in some address book applications.
* [http://cinematreasures.org Cinema Treasures] uses hCard to markup venue information for 10,000+ movie theaters.
* [http://www.w3.org/People/Connolly/events/ Dan Connolly's index of events and talks] has hCards for many of the people he has met at those events. In Mar 2006, he moved a bunch of hotel contact info from his PDA to this page; it's now up to 32 hCards.
* [http://doncrowley.blogspot.com/ Don Crowley] has published [http://www.crowley.nl/hcard.html his hCard] as well as a nifty hCard button: http://www.crowley.nl/images/hcard.png
* [http://loadaveragezero.com/hnav/contact.php Douglas W. Clifton] added all types of contact information
* [http://eventful.com Eventful] publishes all of its venue information pages with embedded hCards.
* [http://www.iowamilitaryveteransband.com/members/ Iowa Military Veterans Band Contacts] - 95 hCards [http://weblog.randomchaos.com/archive/2005/10/24/Microformats/ marked up by Scott Reynen]
* [http://JackWolfgang.blogspot.com Jack L. Wolfgang II] has [http://jack.randomata.com/resume/ converted the addresses in his resume to hCards].
* [http://www.efas.fupl.asso.fr/efas/_Mathieu-Drouet_.html Mathieu Drouet] and [http://www.efas.fupl.asso.fr/efas/_Annie-Leger_.html Annie Leger] both have hCards
* [http://www.ndunn.com Neil Dunn] has published his rather [http://www.ndunn.com/2005/10/7/hCard good looking hCard]
* [http://www.oliverbrown.me.uk/ Oliver Brown] has published his hCard.
* [http://www.paradigmproductions.org/contact/ Paradigm Productions] published a vcard as a ul (marked up by [http://www.linkingarts.com/ Peter Jacobson])
* [http://www.splintered.co.uk/ Patrick H. Lauke] has marked up [http://www.splintered.co.uk/about/ his contact info with hCard].
* [http://blah Paul Schreiber has published his hCard on [http://paulschreiber.com/about/?contact his about page].
* [http://paulschreiber.com/blog/ Paul Schreiber]'s [http://concerts.shrub.ca/ Sunnyvale House Concerts] site publishes hCards for upcoming artists, as well as an hCard for the page itself. In addition the [http://concerts.shrub.ca/shows Past Shows] page contains hCards for all past artists.
* [http://www.paulmichaelsmith.com/blog/hcard.htm Paul Smith] has created an hCard page which is Human Readable, and a link to X2V passing the same hCard page to generate a vCard.
* [http://www.windley.com/archives/2005/07/hcards_trying_o.shtml Phil Windley has published] [http://phil.windley.org/hcard.html his hCard].
* [http://www.go-curiosity.com/about.htm Piercarlo Slavazza] has published an hCard.
* [http://zooibaai.nl/ Rob Mientjes] has published his hCard on [http://zooibaai.nl/about/ his about page].
* [http://rbach.priv.at/Contact Robert Bachmann] has published his hCard and [http://rbach.priv.at/Images/hcard a button].
* [http://blah Scott Reynen has published his hCard on [http://www.randomchaos.com/document.php?source=scott_reynen his profile page].
* [http://www.stackframe.com/ StackFrame, LLC] has published [http://www.stackframe.com/people/ employee] and [http://www.stackframe.com/contact/ general] contact information as hCards.
* [http://www.wolfsreign.com Steven Ametjan] has published his hCard on [http://www.wolfsreign.com/about/ his about page].
* [http://tantek.com/microformats/2005/syndicate/speakers-list.html Syndicate - Speaker List] as a set of hCards
* [http://tagcamp.org/index.cgi?ContactList TagCamp contact list]
* [http://tantek.com/log Tantek's Thoughts] includes an inline author hCard at the bottom of the page.
* [http://technorati.com/ Technorati]'s [http://www.technorati.com/about/ About page] lists their '''Media Contact'''
* [http://www.deadringerart.com/ The Brothers McDowell] have hCards at their Contact page.
* [http://twinsparc.com/ Twinsparc] put an hCard in the header and footer of all their pages.
* [http://tantek.com/microformats/2005/web2/speakers.html Web 2.0 Conference speakers page marked up with hCard]
* [http://we05.com/ Web Essentials 05] marked up all their [http://we05.com/presenters.cfm presenters with hCard].

=== Examples with some problems ===
* [http://gbraad.nl/ Gerard Braad] has published an example on his [http://gbraad.nl/site/?p=profile profile] page that is almost consistent with his original [http://gbraad.nl/files/gbraad.vcf vCard] file. Also progress is made for transforming his [http://files.gbraad.nl/foaf.rdf FoaF] file to a hCard encoded representation. (also done for my spouse:[http://spouse.gbraad.nl/site/?p=profile Yong Yuan])
** (2005-09-27) PASSED, PASSED
** WARNINGS
*** uses 'n given-name' and 'n family-name' instead of nesting the given- and family- names inside the 'n'
*** has one 'tel' value with a bunch of values stuffed in
*** probably more problems --[[User:RyanKing|RyanKing]] 17:19, 5 Jan 2006 (PST)
* [http://kinrowan.net/ Cori Schlegel] [http://kinrowan.net/blog/wp/archives/2005/07/08/a-problem-with-the-structured-blogging-plug-in-for-wordpress/ discusses how he has updated] [http://kinrowan.net/blog/contact his contact page with hCard]
** INVALID - using 'prefix' instead of 'honorific-prefix' and type's in classnames (in both adr and tel) and has two photo's (the second could be 'logo') --[[User:RyanKing|RyanKing]] 15:15, 5 Jan 2006 (PST)
* The good ship [http://styrheim.com/test/leonid.html Leonid Miloslavskiy] spotted in the North Atlantic
** INVALID --[[User:RyanKing|RyanKing]] 00:50, 27 Oct 2005 (PDT)
*** class="family" should probably be family-name
*** the "n" property is missing and the "n" optimization can't be applied
*** the first geo propery is empty, the second one is invalid (ie, it doesn't contain lat/long)
* [http://landsbank.fo/#hCard Landsbanki Føroya]
** INVALID - using embedded rdf/xml invalidly
* [http://chrischerry.name/blog/contact/ Chris Cherry's contact page with his hCard]
** WARNING - uses class="cell" instead of <span class="type">cell</span>
* [http://www.bath.ac.uk/contact/ University of Bath] Person Finder results are encoded with hCards so you can easily create a vCard from any result.
** ERROR - attempt to use Implied-N optimization where that's not possible. --[[User:RyanKing|RyanKing]] 14:29, 5 Jan 2006 (PST)
** Error appears for external users only. Won't be fixed any time soon. -- [[User:PhilWilson|PhilWilson]] 00:03, 28 Jan 2006 (GMT)
* [http://richi.co.uk/blog/2005/12/structured-blogging.html Richi Jennings] has put up his attempt
** INVALID, missing FN --[[User:RyanKing|RyanKing]] 12:47, 5 Jan 2006 (PST)
* [http://www.shiftingpixel.com/about/ shifting pixel photoblog] has published an hCard.
** "organization_name" should be "organization-name" (s/_/-/), otherwise good --[[User:RyanKing|RyanKing]] 14:01, 5 Jan 2006 (PST)

== Implementations ==
This section is '''informative'''.

The following implementations have been developed which either generate or parse hCards. If you have an hCard implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.
* [http://kitchen.technorati.com/search Technorati Microformats Search] indexes [[hcard|hCard]], [[hcalendar|hCalendar]], and [[hreview|hReview]] as [http://tantek.com/log/2006/05.html#d31t1802 announced by Tantek].
** list of pages with indexing Issues so they can be looked into as to why data is not being extracted
** suda.co.uk/contact
** multipack.co.uk

* [http://www.webstandards.org/action/dwtf/microformats/ Dreamweaver Extension suite] from the [http://webstandards.org/ Web Standards Project] enables the authoring of hCards from within Dreamweaver 8.
* [http://scooch.gr0w.com/ Scooch] is a slide show and presentation creator that generates a [[hCard]] for individual slide show authors and comment authors with a CSS button to parse and download via [http://suda.co.uk/projects/X2V/ X2V]. Also uses [[hReview]] for slide ratings and [[rel-tag]] for categories.
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar
*[http://opensource.reevoo.com/2006/03/08/release-uformats-12/ uformats] is a ruby library that can parse [[hCalendar]], [[hCard]], [[hReview]] and [[rel-tag]]
* [http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence and details of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.
* [http://www.stripytshirt.co.uk/features/firefox/smartzilla Smartzilla is a Firefox Extension] that finds hCards on web pages and lets you add them to your addressbook.
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding hCard and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* There is [http://flickr.com/photos/factoryjoe/68755089/ evidence of built-in hCard support in the Konqueror browser]. Specifically, Konqueror 3.5, in KDE 3.5 (kubuntu Breezy w/ update).
* There is [http://tagcamp.org/index.cgi?ContactList evidence of a kwiki plugin for hCards]. Update: the [http://svn.kwiki.org/cwest/Kwiki-hCard/ hCard kwiki plugin svn repository]. See the [http://microwiki.caseywest.com/index.cgi?hCard documentation of the hCard kwiki plugin].
* [http://suda.co.uk/projects/X2V/ X2V] is a bookmarklet that parses hCard and produces a .vcf (vCard) stream. Note: needs to be updated as the spec is refined
* [http://www.stripytshirt.co.uk Duncan Walker] has built [http://www.stripytshirt.co.uk/features/firefox/smartzilla a Firefox extension] that gets hCard data from a webpage, uses Brian Suda's XSL (locally) to transform it to vcard format and opens the resulting .vcf file.
* [http://george.hotelling.net/90percent/ George] has written a [http://george.hotelling.net/90percent/geekery/greasemonkey_and_microformats.php Greasemonkey user script] that detects hCards and allows users to easily add them to their address book application. Relies on the X2V web service to do the conversion.
* [http://inside.glnetworks.de/ Martin Rehfeld] has updated the work of [http://blogmatrix.blogmatrix.com/ David Janes] and produced a [[Greasemonkey]] [http://inside.glnetworks.de/2006/06/05/microformats-have-arrived-in-firefox-15-greasemonkey-06/ script] that finds many microformat elements, including hCards, and [http://blog.davidjanes.com/mtarchives/2005_08.html#003379 provides a popup menu of actions]. The hCard to vCard conversion is done internally within the script. ''This will work with FireFox 1.5+/GreaseMonkey 0.6.4+ now.''
* [http://diveintomark.org/ Mark Pilgrim] has also written an [http://diveintomark.org/projects/greasemonkey/hcard/ hCard parser Greasemonkey user script]. It is self-contained and does not rely on the X2V web service.
* [http://www.oliverbrown.me.uk/2005/09/03/a-working-microformats-extension-to-simplexml/ Oliver Brown] has written an "extension" to [http://www.php.net/simplexml SimpleXML] that gives simple access to hCard information in PHP 5.
* [http://thedredge.org/ Andrew D. Hume] has built a system (Wordpress plugin?) for [http://thedredge.org/2005/06/using-hcards-in-your-blog/ using hcards in your blog] to represent people leaving comments on blog posts.
* The [http://tantek.com/microformats/hcard-creator.html hCard creator] is a very simple, yet illustrative, open source user interface / form / script which creates an hCard in real-time as you type in a set of contact information.
* [http://greenbytes.de/tech/webdav/rfc2629.xslt rfc2629.xslt] now attempts to generate hCard information ([http://ietf.org/rfc/rfc2629 RFC2629] is an XML format for authoring RFCs and Internet Drafts,

hcalendar

2006-06-14T01:08:41Z

Evan: Removing "draft" from section headers for specs defined as "specifications" on the main page

<h1> hCalendar </h1>

hCalendar is a simple, open, distributed calendaring and events format, based on the iCalendar standard ([http://www.ietf.org/rfc/rfc2445.txt RFC2445]), suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. hCalendar is one of several open [[microformats|microformat]] standards.

Want to get started with writing an [[hcalendar|hCalendar]] event? Use the [http://microformats.org/code/hcalendar/creator hCalendar creator] to write up an event and publish it.

__TOC__

== Specification ==

; Editor : [http://tantek.com/ Tantek Çelik] ([http://technorati.com Technorati, Inc])
; Authors : [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc]
: [http://suda.co.uk/ Brian Suda]

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to:
* Adam Bosworth for leading the [http://wiki.oreillynet.com/foocamp04/index.cgi?HTMLForCalendars FOO Camp 2004 HTML For Calendars presentation] which brought together a critical mass of interested parties.

== Introduction ==
The iCalendar standard ([http://www.ietf.org/rfc/rfc2445.txt RFC2445]), has been broadly interoperably implemented (e.g. Apple's "iCal" application built into MacOSX).

In addition, bloggers often discuss events on their blogs -- upcoming events, writeups of past events, etc. With just a tad bit of structure, bloggers can discuss events in their blog(s) in such a way that spiders and other aggregators can retrieve such events, automatically convert them to iCalendar, and use them in any iCalendar application or service.

This specification introduces the '''hCalendar''' format, which is a 1:1 representation of the aforementioned iCalendar standard, in semantic XHTML. Bloggers can both embed hCalendar events directly in their web pages, and style them with CSS to make them appear as desired. In addition, hCalendar enables applications to retrieve information about such events directly from web pages without having to reference a separate file.

== Semantic XHTML Design Principles ==

{{semantic-xhtml-design-principles}}

== Format ==

=== In General ===

The iCalendar standard ([http://www.ietf.org/rfc/rfc2445.txt RFC2445]) forms the basis of hCalendar.

Note: the editor and authors of this specification are tracking the [http://lists.osafoundation.org/pipermail/ietf-calsify/ "iCal-Basic" effort] and intend to base the core hCalendar profile on iCal-Basic. See references for a link to the current draft.

The basic format of hCalendar is to use iCalendar object/property names in lower-case for class names, and to map the nesting of iCalendar objects directly into nested XHTML.

=== More Semantic Equivalents ===

However, for some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:
* <code>URL</code> in iCalendar becomes <code><a class="url" href="...">...</a></code> inside the element with <code>class="vevent"</code> in hCalendar.
* <code>ATTENDEE</code>, <code>CONTACT</code>, and <code>ORGANIZER</code> in iCalendar may be represented by an [[hcard|hCard]] in hCalendar .
* A named <code>LOCATION</code> (potentially with an address and/or geo) in iCalendar may be represented by a nested [[hcard|hCard]] in hCalendar. Similarly, an address <code>LOCATION</code> may be represented by an [[adr]], and a geo (latitude and longitude) <code>LOCATION</code> may be represented by a [[geo]].
* <code>UID</code> in iCalendar simply becomes another semantic applied to a specific URL for an hCalendar event.

=== Singular vs. Plural Properties ===

For properties which are singular (e.g. "N" and "FN" from vCard), the first descendant element with that class should take effect, any others being ignored.

For properties which can be plural (e.g. "TEL" from vCard), each class instance should create a instance of that property. Plural properties with subtypes (e.g. TEL with WORK, HOME, CELL from vCard) can be optimized to share a common element for the property itself, with each instance of subtype being an appropriately classed descendant of the property element.

==== 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.

=== Human vs. Machine readable ===
If an <code><nowiki><abbr></nowiki></code> element is used for a property, then the '<code>title</code>' attribute of the <code><nowiki><abbr></nowiki></code> element is the value of the property, instead of the contents of the element, which instead provide a human presentable version of the value. This specification recommends that such <code><nowiki><abbr></nowiki></code> elements be used for the following iCalendar properties:
* DTSTART, DTEND, DURATION, RDATE, RRULE

== Example ==

Here is a sample event in an iCalendar:
<pre><nowiki>
BEGIN:VCALENDAR
PRODID:-//XYZproduct//EN
VERSION:2.0
BEGIN:VEVENT
URL:http://www.web2con.com/
DTSTART:20051005
DTEND:20051008
SUMMARY:Web 2.0 Conference
LOCATION:Argent Hotel\, San Francisco\, CA
END:VEVENT
END:VCALENDAR
</nowiki></pre>
and an equivalent event in hCalendar format with various elements optimized appropriately. See [[hcalendar-example1-steps]] for the derivation.

<pre><nowiki>
<span class="vevent">
<a class="url" href="http://www.web2con.com/">
<span class="summary">Web 2.0 Conference</span>:
<abbr class="dtstart" title="2005-10-05">October 5</abbr>-
<abbr class="dtend" title="2005-10-08">7</abbr>,
at the <span class="location">Argent Hotel, San Francisco, CA</span>
</a>
</span>
</nowiki></pre>
which could be displayed as:

[http://www.web2con.com/ Web 2.0 Conference: October 5-7, at the Argent Hotel, San Francisco, CA]

Note 1: The product information is not necessary since hCalendar is an interchange format. When transforming hCalendar back into iCalendar, the transforming engine should add its own product ID.

Note 2: A surrounding <code><nowiki><span class="vcalendar"></nowiki></code> element is optional, and is left out as such. It is optional since the context of a vcalendar is implied when a vevent is encountered. The implied context/scope is that of the document. Authors may explicitly use elements with class="vcalendar" to wrap sets of vevents that all belong to the same calendar, e.g. when publishing multiple calendars on the same page.

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

Note 4: ISO8601 dates (required by iCalendar) are not very human friendly. In addition, the year is often understood implicitly by humans from the context. Thus <code><nowiki><abbr></nowiki></code> elements are used to simultaneously provide a human friendly date and/or time in the visible contents of the element, while placing the respective machine parsable comprehensive ISO8601 datetime in the 'title' attribute.
The notation YYYY-MM-DD should be used for better readability.

Note 5: The difference between the DTEND ISO8601 date (2005-10-08) and the human readable date (7) is NOT a mistake. [http://lists.osafoundation.org/pipermail/ietf-calsify/2005-September/000769.html DTEND is exclusive], meaning, that the event ends just before the DTEND. Thus for events which start on one day and end on another day, the DTEND date must be specified as the day after the day that a human would say is the last day of the event.

Note 6: The location in this example contains implicit structure (venue name, city, state) which could be marked up explicitly as an [[hcard|hCard]]. See [http://microformats.org/wiki/hcalendar-brainstorming#hCard_locations hCalendar brainstorming: hCard locations] for a informative explanation of how to do this.

See [[hcalendar-examples]] for more hCalendar examples

== Examples in the wild ==
This section is '''informative'''.

The following sites have implemented hCalendar, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If events on your pages are marked up with hCalendar, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

=== New Examples ===
Please add new examples to this section.
* [http://www.thesession.org/events/ The Session events] uses hCalendar to mark up concerts, festivals and workshops related to Irish traditional music.
* [http://rubyandrails.org/usergroups/newcastle ncl.rb] uses hCalendar to mark up new meetings.
* [http://www.worldcupkickoff.com/ World Cup KickOff] where you can download and keep all the fixtures you are interested in so you will never miss a single game of the 2006 football World Cup!
** This link was on the [http://www.lifehacker.com/software/sports/world-cup-start-times-for-ical-etc-175393.php Lifehackers site] and made its way to the yahoo news site:

Mon May 22, 4:00 PM ET
The World Cup, one of the world's most watched sporting events, is almost upon us. If you've ever tried to follow your favorite team through the Cup you know that it can sometimes be difficult to know when they're on. World Cup Kickoff can help.

World Cup KickOff is all you will ever need for knowing all the match details for the upcoming World Cup 2006. Whether you use your mobile phone, MS Outlook, Apple iCal or Mozilla Calendar, you can download and keep all the fixtures you are interested in so you will never miss a single game!
ADVERTISEMENT

Next tip? We'll show you how to get up at 2 AM to watch your matches. ;0) Thanks to Tom for the tip!

* [http://gross.org.za/calendar GROSSUG Calendar] - Uses hCalendar to mark up meetings and other events.
* [http://www.socaltech.com socalTECH] is a news and information site. Their front page event listing is marked up with hCalendar.
* [http://www.webanalyticsassociation.org/en/calendarevents/search.asp Web Analytics Association] - hCalendar microformat is in place on all Tendenci sites on the calendar events search page and consolidated list page.
* [http://www.tendenci.com/en/calendarevents/search.asp Tendenci Calendar Events] with hCalendar
* [http://www.argolon.com/2006/04/17/web20-conference-in-dublin/ Web2.0 Conference in Dublin] hCalendar event
* [http://www.meetup.com/ Meetup.com] has marked up [http://www.meetup.com/cities/us/ny/new_york city event calendars], [http://photo.meetup.com/100/events/ group event lists], and [http://www.meetup.com/ signed-in homepages] with hCalendar.
* [http://ukwindsurfing.com/ ukwindsurfing.com] has marked upcoming events with hCalendar, and the [http://ukwindsurfing.com/events/ events page] in a table.
* [http://ocono.com/ ocono.com] has marked up it's "Upcoming Events" list with hCalendar.
* [http://www.austinbloggers.org/ Austin Bloggers] has marked up their "Upcoming Events" box with hCalendar ([http://www.austinbloggers.org/blog/a/001123.html announcement]).
* Ning's cloneable Group app has [[hcalendar|hCalendar]] markup on its [http://group.ning.com/index.php?controller=event&action=list event calendar] and [http://group.ning.com/index.php?controller=event&action=view&id=727220 event detail] pages.
* [http://tantek.com/microformats/2006/03-01-TechPlenAgenda.html Agenda: W3C Technical Plenary Day, March 1 2006] has [[hcard|hCard]] and [[hcalendar|hCalendar]] markup. ([http://www.w3.org/2006/03/01-TechPlenAgenda.html original here]).
* The National Arbor Day Foundation has started using hCalendars for their [http://arborday.org/programs/conferences/communityforestry/index.cfm upcoming] [http://arborday.org/programs/conferences/hazardtrees-treeplanting/ conferences].
* [http://www.multipack.co.uk The Multipack] features a vevent for the next meeting information.
* [http://www.stateofflux.com/ State of Flux street art site] has started adding events in hCalendar format
* The [http://barcamp.org/#BarCamps BarCamp home page lists upcoming BarCamps marked up with hCalendar] and even has a "Subscribe..." link.
* [http://www.w3.org/2005/12/allgroupoverview.html 2006 W3C Technical Plenary Week] has marked up the schedule and events for the week with hCalendar.
* [http://www.code4lib.org/2006/schedule code4lib Conference 2006 Schedule] is marked up with hCalendar as [http://www.code4lib.org/node/65 announced on their blog].
* [http://grouper.ieee.org/groups/754 IEEE 754 Working Group] - trying hCalendar for upcoming meetings.
* [http://www.pehuen.org/node/494 Elecciones 2005 Chile] - the first spanish language hCalendar event found in the wild.
* [http://www.codewitch.org/it/2005/11/17/no-creative-commons-no-party/ Giocolando » No Creative Commons? No Party!] is marked up with hCalendar
* [http://www.cmprofessionals.org/events/calendar.html CM Pros Events Calendar] by Bob Doyle
* [http://www.midgard-project.org/community/events/ Midgard CMS Event calendar] - as [http://bergie.iki.fi/blog/new-event-calendar-for-midcom.html blogged by Henri Bergius]
* [http://www.iowamilitaryveteransband.com/schedule/ Iowa Military Veterans Band Schedule] - hCalendar markup [http://weblog.randomchaos.com/archive/2005/10/24/Microformats/ added by Scott Reynen]
* [http://www.funfairgames.net/weblog/posts/00000011.html Upcoming events on Jason A.R. Moody Amusements Weblog] posted by Jason Moody on 15 Oct 2005. [http://www.funfairgames.net/weblog/index.html His weblog] in general has hCalendar events posted inside the blog posts.
* [http://tantek.com/microformats/2005/syndicate/tracks-sessions-schedule.html Syndicate - Tracks & Sessions]
* [http://tantek.com/microformats/2005/web2/program.html Web 2.0 Conference schedule page marked up with hCalendar]
* [http://www.thisiscmon.com/ C'MON] is a rock band from Canada, and their [http://www.thisiscmon.com/shows/ tour dates] have been marked up by [http://www.d2digitalmedia.com/ Ray Dickman] with hCalendar.
* [http://ifreebusy.com/ ifreebusy.com] will display freebusy information using hCalendar. See this [http://ifreebusy.com/neiljensen/freebusy/ example].
* [http://we05.com/ Web Essentials 05] has marked up their [http://we05.com/program.cfm program schedule table with hCalendar], using the 'axis' and 'headers' attributes.
* [http://www.asdvbonaparte.nl/ ASDV Bonaparte] is a Dutch debating society. Their events calendar has been marked up with the hCalendar conventions.
* [http://chocnvodka.blogware.com/blog Suw Charman] has marked up [http://suw.org.uk/archives/category/events/ her events] with hCalendar.
* [http://www.blogbusinesssummit.com/ Blog Business Summit] has published their [http://www.blogbusinesssummit.com/details.htm event details] marked up with hCalendar.
* [http://eventful.com Eventful.com] publishes all events with hCalendar and venues with [[hcard|hCard]]. Took them only 15 minutes to implement both! Their Atom feeds also contain hCalendar/hCard.
* [http://upcoming.org Upcoming.org] publishes all events and lists of events with hCalendar. Took them only an hour to add hCalendar support to the site.
* The [http://laughingsquid.com/squidlist/calendar/ Laughing Squid Calendar] events, [http://laughingsquid.com/squidlist/calendar/9949/2005/5/9 e.g. this party], now supports hCalendar.
* [http://paulschreiber.com/ Paul] Schreiber's [http://concerts.shrub.ca/ Sunnyvale House Concerts] site publishes hCalendar event information for upcoming concerts. In addition the [http://concerts.shrub.ca/shows Past Shows] page contains hCalendar events for all past concerts.
* [http://paulschreiber.com/ Paul] Schreiber's [http://iceoasis.shrub.ca/ unofficial schedule site] publishes hCalendar information for upcoming hockey games at [http://www.iceoasis.com/ Ice Oasis]
* [http://www.complexspiral.com/ Complex Spiral Consulting], both in the "Events" box on left side, and the separate [http://www.complexspiral.com/events/ Events page].
* [http://tantek.com/log Tantek's Thoughts], specifically the "Events" roll in the right-most column.
* [http://suda.co.uk/projects/holidays/ Lesser Known Holidays], a list of holidays on [http://suda.co.uk suda.co.uk] that can be imported via iCal and hCal so you can compare actual transformation versus intended.
* [http://norman.walsh.name/2005/itinerary/ Norm Walsh's travel schedule] use hCalendar as well as GRDDL.
* [http://www.policyawareweb.org/2005/ftf2/paw-mtg Policy Aware Web (PAW) Project Meeting] uses hCalendar to record date-related decisions, and uses a vtodo microformat to record action items.
* The [http://www.kiez-ev.de/ Kiez] is a small cinema and has published its [http://www.kiez-ev.de/programm.htm program] marked up with hCalendar.
* The [http://lufgi4.informatik.rwth-aachen.de Laboratory for Dependable Distributed Systems] publishes it's [http://lufgi4.informatik.rwth-aachen.de/cfps list of notable CfPs on dependability and security] with hCalendar-todo elements.
* The [http://laughingsquid.com/laughing-squid-10th-anniversary-party/ Laughing Squid 10th Anniversary Party] has an hcalendar page.
* SPRACI has hcalendar versions of its nightlife/clubbing/gigs/festivals listings for many cities worldwide - eg: [http://www.spraci.com/listhcalendar.php?parea=sydney&category=all Events in Sydney] (check the [http://www.spraci.com/api/ API] pages in the faq section of [http://www.spraci.com/ SPRACI] for more info about the area/city keywords and category tags to use to get data for your city/categories
* WWF-Australia events calendars: [http://wwf.org.au/act/events/ What's on], [http://wwf.org.au/act/volunteer/ Volunteer]
* [http://rubyholic.com rubyholic] uses hCalendar to publish calendars for ruby groups.
* [http://www.bath.ac.uk/whats-on/ University of Bath What's On] uses hCalendar on individual event pages

=== Examples with some problems ===
* [http://www.bokle.de/ s'Bokle] is a German music pub. Their events calendar has been marked up with hCalendar.
** improper use of rrule --[[User:RyanKing|RyanKing]] 16:04, 6 Jan 2006 (PST)

== Implementations ==
This section is '''informative'''.

The following implementations have been developed which either generate or parse hCalendars. If you have an hCalendar implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

=== Authoring ===
Implementations you can use to author, create, and publish hCalendar events.

==== Blogging and CMS tools ====
;Midgard CMS : [http://www.midgard-project.org/documentation/net-nemein-calendar/ Midgard CMS - net.nemein.calendar] - as [http://bergie.iki.fi/blog/new-event-calendar-for-midcom.html blogged by Henri Bergius]

;Drupal module : [http://hybernaut.com/upcoming-hcal Drupal Upcoming.org syndication module emits hCalendar]
;MovableType and WordPress plug-ins : [http://structuredblogging.org/formats.php StructuredBlogging] is a set of plugins [http://structuredblogging.org/structuredblogging-wp-latest.zip for WordPress] and [http://structuredblogging.org/structuredblogging-wp-latest.zip for MovableType] that supports embedding hCalendar and other microformats in templates and blog posts.
;Textpattern plug-in : [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding hCalendar and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].

==== Browser scripts and plug-ins ====
Browser plugins that work with existing authoring tools:
; Any browser with javascript and a little bit of CSS : [http://microformats.org/code/hcalendar/creator microformats.org hCalendar creator] (see also original: [http://theryanking.com/ Ryan King] has an [http://theryanking.com/microformats/hcalendar-creator.html hCalendar creator]).
; Firefox Greasemonkey user script hCalendar creator : [http://www.decafbad.com/blog/2005/06/08/greasemonkey_magic magic_hcalendar Greasemonkey user script by Les Orchard] - allows easy form entry of an event into any textarea, e.g. into a blog post text area.
; Firefox Greasemonkey user script hCalendar to Google Calendar: [http://torrez.us Elias Torres] has created a [http://torrez.us/archives/2006/04/13/431/ simple script] that will parse hCalendar entries and create a link to add event to [http://www.google.com/calendar/ Google Calendar's] service. Based on [http://virtuelvis.com/archives/2005/11/learn-to-love-microformats George's] and [http://virtuelvis.com/archives/2005/11/learn-to-love-microformats Arve's] work.

==== Desktop Authoring Tools ====
;Dreamweaver Extension : [http://www.webstandards.org/action/dwtf/microformats/ Extension suite] for Dreamweaver 8 from the [http://webstandards.org/ Web Standards Project].
;xfy :
In [https://www.xfytec.com/community/ xfy Community], there are some hCalendar implementations.

* [https://www.xfytec.com/community/modules/mydownloads/singlefile.php?cid=15&lid=25 hCalendar via RSS] parses an RSS feed, retrieves XHTML documents linked from that feed, and syndicates hCalendars into a calendar view.
* [https://www.xfytec.com/community/modules/mydownloads/singlefile.php?cid=19&lid=23 hCalendar Marker XVCD] helps to mark up an event information in XHTML document with hCalendar.
* [https://www.xfytec.com/community/modules/mydownloads/singlefile.php?cid=15&lid=17 Simple RDF Calendar XVCD] is a schedule tool which uses RDF Calendar format. It also converts RDF Calendar format to iCalendar and hCalendar format.

=== Search and Discovery ===

* [http://kitchen.technorati.com/search Technorati Microformats Search] indexes [[hcard|hCard]], [[hcalendar|hCalendar]], and [[hreview|hReview]] as [http://tantek.com/log/2006/05.html#d31t1802 announced by Tantek].

=== Conversion and Import ===
Implementations you can use to importing into a Calendar Application, typically by converting hCalendar to iCalendar/vCalendar.

==== Web Services ====
These return iCalendar (.ics) and other calendar formats for easy importing into typical calendar programs or other processing.
* [http://feeds.technorati.com/events Technorati Events Feed service] uses X2V library to parse hCalendar and return iCalendar (.ics). Note friendly URL, e.g. http://feeds.technorati.com/events/http%3A//microformats.org
* [http://suda.co.uk/projects/X2V/ X2V] parses hCalendar and produces a .ics (iCalendar) stream. Note: needs to be updated to track changes in the specification as they occur.
* [http://lifelint.net/ Life Lint Parser] parses hCalendar and produces .ics, .rdf and debugging information and attempts to be more fully compliant to the iCal standard than previous implementations. It can be used in the same manner as X2V. Can output iCal (w optional Outlook 2002 compat), and RDF.
* [http://spanningsalesforce.com/ Spanning Salesforce] produces hCalendar-enabled RSS feeds and .ics calendars from Salesforce.com.

==== Firefox Greasemonkey Plugins ====
* [http://george.hotelling.net/90percent/ George] has built a [http://george.hotelling.net/90percent/geekery/greasemonkey_and_microformats.php Greasemonkey user script that detects hCalendar events and allows users to easily add them to their calendar application(s)].
* [http://inside.glnetworks.de/ Martin Rehfeld] has updated the work of [http://blogmatrix.blogmatrix.com/ David Janes] and produced a [[Greasemonkey]] [http://inside.glnetworks.de/2006/06/05/microformats-have-arrived-in-firefox-15-greasemonkey-06/ script] that finds many microformat elements, including hCalendar events, and [http://blog.davidjanes.com/mtarchives/2005_08.html#003379 provides a popup menu of actions]. The hCalendar to vCalendar conversion is done internally within the script. ''This will work with FireFox 1.5+/GreaseMonkey 0.6.4+ now.''

==== Aggregators ====
* [http://kula.jp/software/endo/screenshots/ Endo], an OS X aggregator, supports discovering hCal and adding those events to iCal. Look at the last screenshot at the bottom of the page.

=== Browsing ===
Implementations that detect, display and otherwise highlight hCalendar events in pages.

* In [http://www.xfytec.com/community/ xfy Community], there are some hCalendar implementations. "hCalendar via RSS" parses an RSS feed, retrieves XHTML documents linked from that feed, and syndicates hCalendars into a calendar view.
* [http://web.mit.edu/glasser/www/JSCalendar/ JSCalendar] parses hCalendar and produces a displayable HTML table/CSS-based calendar.

==== Firefox extension ====
[http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.

==== Flock extension ====
[http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar

=== Libraries ===
Open source libraries of hCalendar parsers and other related code for building hCalendar implementations.
; Javascript : [http://virtuelvis.com/archives/2005/11/learn-to-love-microformats simple hCalendar parser] by [http://virtuelvis.com/ Arve Bersvendsen]
; PHP : [http://randomchaos.com/microformats/base/ Microformat Base] is an open-source PHP microformat aggregation crawler, currently recognizing hreview, hcalendar, and hcard.
; Ruby : [http://opensource.reevoo.com/2006/03/08/release-uformats-12/ uformats] is a ruby library that can parse [[hCalendar]], [[hCard]], [[hReview]] and [[rel-tag]]
; XSLT :
* X2V is available as an XSLT library
* [http://dev.w3.org/cvsweb/2001/palmagent/ palmagent] by [[User:DanC]] includes toICal.xsl and test materials; it works much like xhtml2vcal.xsl in X2V. See also: [http://www.w3.org/2002/12/cal/ RDF Calendar workspace] with icalendar test materials.

=== Potential implementations ===

These are open source projects that could be potentially enhanced to support hCalendar.

* [http://www.k5n.us/webcalendar.php?topic=About WebCalendar]
* [http://phpicalendar.net/documentation/index.php?title=Main_Page PHP iCalendar]
* [http://www.vcalendar.org VCalendar]
* Investigation: [http://wiki.mozilla.org/Calendar_Talk:Lightning#hCalendar_publish_and_subscribe_support Mozilla Calendar / Lightning / Sunbird hCalendar support discussion]

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [[hcard|hCard]]
* [http://www.ietf.org/rfc/rfc2445.txt iCalendar RFC2445]

=== Informative References ===
* [http://w3.org/TR/REC-CSS1 CSS1]
* [http://tantek.com/log/2004/09.html#hcalendar hCalendar term introduced and defined on the Web, 20040930]
* [http://wiki.oreillynet.com/foocamp04/index.cgi?HTMLForCalendars FOO Camp 2004 HTML For Calendars presentation, 20040911]
* [http://wiki.oreillynet.com/foocamp04/index.cgi?SimpleSemanticFormats FOO Camp 2004 Simple Semantic Formats presentation, 20040910]
* [http://www.ietf.org/internet-drafts/draft-royer-ical-basic-04.txt iCal-Basic draft 04]
* Contributed from http://developers.technorati.com/wiki/hCalendar
* [http://www.w3.org/TR/xhtml11 XHTML 1.1]

==== Related ====
* [[icalendar-implementations|iCalendar implementations]]
* [[hcalendar-tests]]
* [http://lists.osafoundation.org/pipermail/ietf-calsify/ IETF-calsify archives]
* [http://www.livejournal.com/users/jwz/444651.html jwz - Hula] (required reading)
* [http://www.jwz.org/doc/groupware.html Groupware Bad by Jamie Zawinski] crystalizes the reason for hCalendar ('''emphasis''' added):
<blockquote>"Right now people can do that by publishing .ics files, but it's not trivial to do so, and it's work on the part of other people to look at them. '''If it's not HTML hanging off our friend's home page that can be viewed in any browser on a public terminal in a library, the bar to entry is too high and it's useless.'''"</blockquote>

* [http://muddybranch.thejkgroup.com/ Jason Klemow's blog]
* [http://www.softwarestudio.org/iCal/2445Issues.html RFC2445 Issues List]
* [http://ietf.webdav.org/calsify/ CALSIFY WG Links And Resources]

=== Similar Work ===
* [[XOXO]]

== Discussions ==

This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. There is a separate document where we are keeping our brainstorms and other explorations relating to hCalendar:

* [[hcalendar-brainstorming]]

* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
** [http://weblog.infoworld.com/udell/2006/01/11.html#a1368 Moving forward with microformats] by [http://weblog.infoworld.com/udell Jon Udell] provides an hCalendar example and some discussion.

=== Q&A ===
* If you have any questions about hCalendar, check the [[hcalendar-faq]], and if you don't find answers, add your questions!

=== Issues ===
* Please add any issues with the specification to the separate [[hcalendar-issues]] document.

vote-links-faq

2006-05-25T19:29:42Z

Evan:

= VoteLinks Frequently Asked Questions (FAQ) =

This page documents questions and answers regarding VoteLinks.

''Q: Why only for and against? How about something more nuanced?''

A: The point of this is to provide a strong yes/no response. Finer-grained measures of agreement don't make much sense on an individual basis; aggregating many votes is more interesting. For example, consider how eBay's user rating system has been reduced to a like/dislike switch by users. The 'Ayes, Noes, abstentions' model has served well in politics and committees, when a division is called for.

''Q: Aren't there much richer ways to express this idea and similar ones using RDF and semantic web ideas?''

A: Indeed there are, but typing them by hand and remembering them is beyond most mere mortals, and automated tools don't do this either. This is meant to be very simple, memorable and easy to type in the current generation of blogging tools, that largely need manual entry of URLs. Similarly, it is easily added to an automated tool.

''Q: How do you show a visual representation on the page of these different types?''

A: You can do that by defining 'vote-for' 'vote-against' and 'vote-abstain' CSS2 attribute selectors and applying them to the post as well. E.g.

'''<pre><nowiki>
a[rev~="vote-for"] { background:lime }
a[rev~="vote-against"] { background:red }
a[rev~="vote-abstain"] { background:gray }
</nowiki></pre>'''

''Q: Won't all this negativity lead to trolling and flame wars?''

A: Trolling is a problem already - Google's PageRank rewards being linked to, so notoriety is valued as highly as popularity. This leads to a 'no publicity is bad publicity' approach. For relentless positivists, the 'vote-against' and 'vote-abstain' values could be taken as signals meaning "don't index this link". For Vote tallying, however, positive and negative responses are both valuable and clear.
The possibility of a personally filtered search, which reflects your own values expressed by your own links is greatly enhanced by the ability to define negative links as well.

''Q: Could you add a css style rule for thumbs-up/thumbs-down/thumb flat icons?''

A:
'''<pre><nowiki>
a[rev~="vote-for"]:after { content:url(thumbs-up.png) }
a[rev~="vote-against"]:after { content:url(thumbs-down.png) }
a[rev~="vote-abstain"]:after { content:url(thumbs-flat.png) }
</nowiki></pre>'''

''Q: Could you use a period as the separator in your 'vote' rels, so you would have 'vote.for', 'vote.against', and 'vote.abstain'? The reason being interoperability with prior art, specifically Dublin Core with their 'DC.whatever". They (DC) even have an RFC which describes this prefixing mechanism, albeit with the <meta> element, not the <a> element.''

A: You have misinterpreted the "-" in the values, which just serves to hyphenate in lieu of just leaving a space between the words in the values. Values in the 'rel' attribute cannot contain spaces themselves because the 'rel' attribute as a whole is a space separated set of rel values.

There is no interoperability issue here, merely a convention that one particular namespace-camp has adopted. If VoteLinks were to adopt something similar to the "DC." convention, then values might be something like 'VL.vote-for', 'VL.vote-against', 'VL.vote-abstain'. At this point there is no need for such namespace syntactic vinegar, so therefore we're going to keep it simple and just stick to the plain human readable values. For followup Q&A about VoteLinks and namespaces, see NamespacesChickenLittling.

''Q: Why not use nouns and keep with the current 'rel' idiom? EtanWexler''

A: The values are all nouns.

''Q: Okay, so 'vote-for' means "a vote for", not "to vote for". The current idiom holds that "[ starting anchor of link ] has [ properties described by 'rel' ] which are [ ending anchor of link ]." and that "[ ending anchor of link ] has [ properties described by 'rev' ] which are [ starting anchor of link ]." For example, <link rel="index" href="http://example.com/an_index_for_Document_1"> in an HTML document at http://example.com/Document_1 means that "<http://example.com/Document_1> has an index which is <http://example.com/an_index_for_a_Document_1>". Suppose that there is a thesis, <http://example.com/thesis>. Suppose that there is a commentary, <http://example.com/commentary>, which agrees with the thesis. Suppose that the commentary contains a link to the thesis via the fragment <http://example.com/commentary#a_link> Suppose that the commentary's author wishes to assert within <http://example.com/commentary#a_link> that "<http://example.com/thesis> has a vote of agreement which is <http://example.com/commentary#a_link>". The proposed VoteLinks terms fit better with the 'rev' attribute (reverse relationship) than with the 'rel' attribute (forward relationship). The proposal still breaks from the current idiom. Is this an Earth-shattering discrepancy? No. Is this a wart? Yes. Is it better to cure warts early in the life of a specification than to attack those warts at some later time? Yes. So, to come back to asking a question, Is there any wiggle room at Technorati on the terms or on the choice of attribute? —EtanWexler''

A: EtanWexler is correct. Further analysis of the HTML4 specification, of the existing 'rel' values, etc. has led me to come to the same conclusion as Etan. 'rev' is more appropriate than 'rel' and thus VoteLinks has been changed to use 'rev' instead of 'rel'. See the ["RelFAQ"] for more analysis. Thanks very much for this feedback, and thanks for your patience while we figured it out as well.

Q: ''Is a VoteLink to a page a vote for/against etc. that page, or what that page represents?''

A: VoteLinks does not specify whether the vote applies only to just the page that is being linked to, or to what the page being linked to represents, e.g. a page on Amazon representing a book for example, or both. We are leaning towards the more inclusive consideration of the having the VoteLink refer to both the page and what the page represents. We expect implementation and authoring experience to help shape and refine the answer to this question.

rel-faq

2006-05-23T03:09:53Z

Evan: balance quote marks

<h1> "rel" attribute frequently asked questions </h1>

This document serves to answer and discuss frequently asked questions about the HTML4 "rel" and "rev" attributes, and their linktype values. Specifically this document explores a number of issues common to and exposed by the various [[microformats]] which extend the HTML4 rel attribute, such as [[rel-license]], [[rel-tag]], [[vote-links]], and [http://gmpg.org/xfn/ XFN].

__TOC__

== Authors ==
* John Allsopp, [http://westciv.com Western Civilisation]
* [http://tantek.com Tantek Çelik], [http://technorati.com Technorati, Inc]

== FAQ ==

=== What is the proper use of the 'rel' attribute? ===

First, you can use the [http://www.w3.org/TR/html4/types.html#type-links linktype] as specified is [http://www.w3.org/TR/html4/ HTML 4]. A well known example of this is rel="stylesheet". Second, you "can extend the rel attribute using a [http://www.w3.org/TR/html4/types.html#type-links profile"], but "[http://www.w3.org/TR/html4/types.html#idx-link_type-2 HTML doesn't specify/recommend a profile format]". XMDP can be used to formally define new rel values.

=== What does a rel value really mean? ===

The rel values in HTML follow a consistent pattern which at a minimum ''implies'' a deliberate design. rel describes the relationship of a hyperlink in terms of what the destination (href) is, to the source, or from the source's perspective. rel="stylesheet" is perhaps the easiest example to understand in this manner, because it is saying that this resource over there (indicated with the href) ''is'' a "stylesheet" for the current document. Similarly, rel="help" link states that the resource indicated by the href is "help" (e.g. a help file or FAQ) for the current document. All the rest of the values defined in HTML4 also follow this pattern of being a ''noun'' which labels the resource indicated by the href, from the perspective of the current document.

=== Then what does "rev" mean? ===

"rev" is the precise opposite (or "reverse") of the "rel" attribute. E.g. a rev="help" link indicates that ''the current document'' is "help" for the resource indicated by the href.

=== Is rel single or bi directional? ===

Though the HTML4 specification is not specific on this point, all the rel values in the HTML4 specification follow a very consistent pattern that indicate a specific directionality to the value of the rel attribute. The ''only'' exception to this is the value "alternate", which, is actually inherently symmetric, so rel="alternate" means pretty much the same thing as rev="alternate". I say pretty much because in theory (and in practice) one of a pair of alternates is likely to be more definitive, and thus one is more a primary resource, with the other being an alternative. In theory you could extend rel with a new value, e.g. "original" which could be used to point back the original version of a document. This could be used for example with translations, where translations of a document would point back to the original with rel="original".

=== Are "rel" attributes, and linktypes in general, just document to document? ===

The vast majority of the rel values defined in HTML4 are from a document to a document. rel="stylesheet" is a bit of an exception, as it from an HTML document to a style sheet, which is more like a set of styling rules and instructions than a "document" in the classical sense. Two notable exceptions are rel="copyright" and rel="bookmark" which describe the relationship from the current document to (potentially) only part of a document. The 'rev' attribute adds an interesting perspective on this question. Specifically, [http://www.w3.org/TR/html4/struct/links.html#rev-link 12.3.1 of HTML4] shows an example of two links one using rel and the other using rev which mean the same thing. Thus linktypes in general may be either from a whole document or part of a document to a whole document or a part of a document. For example, the RelTag specification introduces the rel="tag" value, and notes that it indicates a relation from a document or major portion thereof to a document. Finally, XFN probably stretches rel the farthest, as it uses rel to indicate a person to person relationship. This person to person scope was not introduced by XFN, but merely adopted. It was introduced by bloggers who have taken to linking to other bloggers by name and thus using people's blog URLs as proxies for people themselves.

=== Is/Was VoteLinks a proper use of rel? ===

No. The problem with using rel for VoteLinks is made apparent with the following example:

<pre><nowiki>
<a href="http://www2005.org" rel="vote-for">WWW2005 is a great conference</a>
</nowiki></pre>

Following the reasoning in the earlier answer to the question of what a rel value means, this link would mean:

The resource indicated by http://www2005.org is a "vote-for" the current document.

That clearly doesn't make any sense, and was certainly not the intent of VoteLinks. Ironically, the reverse makes a lot more sense:

The current document is a "vote-for" the resource indicated by http://www2005.org.

And generalizing to the same cultural usage links as XFN:

The current document, as a proxy for the person who wrote it (e.g. the blogger whose blog it is),
is a vote-for the resource indicated by http://www2005.org.

Fortunately the "rev" attribute captures this "reverse" relationship semantic, and thus the above example should be written like this:

<pre><nowiki>
<a href="http://www2005.org" rev="vote-for">WWW2005 is a great conference</a>
</nowiki></pre>

And thus VoteLinks has been changed to use "rev" instead of "rel", in order to keep the well known and easily understandable "vote-for", "vote-abstain", and "vote-against" values.

=== When a 'rel' value refers to a relationship to or from a page or document, is it referring to just the page, or the contents of the page, or both? ===

The consensus (and convention) is that such rel values are referring to the page itself including its immediate contents, but not for example to embedded contents of like images, objects, frames etc.

== See Also ==

* [[rel-directory]]
* [[rel-license]]
* [[rel-payment]]
* [[rel-tag]], [[rel-tag-faq]]
* [[vote-links]]
* [http://gmpg.org/xfn/ XFN], [http://gmpg.org/xfn/faq XFN FAQ]

rel-faq

2006-05-23T02:54:27Z

Evan: replace *something* with ''something'' globally

<h1> "rel" attribute frequently asked questions </h1>

This document serves to answer and discuss frequently asked questions about the HTML4 "rel" and "rev" attributes, and their linktype values. Specifically this document explores a number of issues common to and exposed by the various [[microformats]] which extend the HTML4 rel attribute, such as [[rel-license]], [[rel-tag]], [[vote-links]], and [http://gmpg.org/xfn/ XFN].

__TOC__

== Authors ==
* John Allsopp, [http://westciv.com Western Civilisation]
* [http://tantek.com Tantek Çelik], [http://technorati.com Technorati, Inc]

== FAQ ==

=== What is the proper use of the 'rel' attribute? ===

First, you can use the [http://www.w3.org/TR/html4/types.html#type-links linktype] as specified is [http://www.w3.org/TR/html4/ HTML 4]. A well known example of this is rel="stylesheet". Second, you "can extend the rel attribute using a [http://www.w3.org/TR/html4/types.html#type-links profile"], but "[http://www.w3.org/TR/html4/types.html#idx-link_type-2 HTML doesn't specify/recommend a profile format]". XMDP can be used to formally define new rel values.

=== What does a rel value really mean? ===

The rel values in HTML follow a consistent pattern which at a minimum ''implies'' a deliberate design. rel describes the relationship of a hyperlink in terms of what the destination (href) is, to the source, or from the source's perspective. rel="stylesheet" is perhaps the easiest example to understand in this manner, because it is saying that this resource over there (indicated with the href) ''is'' a "stylesheet" for the current document. Similarly, rel="help" link states that the resource indicated by the href is "help" (e.g. a help file or FAQ) for the current document. All the rest of the values defined in HTML4 also follow this pattern of being a ''noun'' which labels the resource indicated by the href, from the perspective of the current document.

=== Then what does "rev" mean? ===

"rev" is the precise opposite (or "reverse) of the "rel" attribute. E.g. a rev="help" link indicates that ''the current document'' is "help" for the resource indicated by the href.

=== Is rel single or bi directional? ===

Though the HTML4 specification is not specific on this point, all the rel values in the HTML4 specification follow a very consistent pattern that indicate a specific directionality to the value of the rel attribute. The ''only'' exception to this is the value "alternate", which, is actually inherently symmetric, so rel="alternate" means pretty much the same thing as rev="alternate". I say pretty much because in theory (and in practice) one of a pair of alternates is likely to be more definitive, and thus one is more a primary resource, with the other being an alternative. In theory you could extend rel with a new value, e.g. "original" which could be used to point back the original version of a document. This could be used for example with translations, where translations of a document would point back to the original with rel="original".

=== Are "rel" attributes, and linktypes in general, just document to document? ===

The vast majority of the rel values defined in HTML4 are from a document to a document. rel="stylesheet" is a bit of an exception, as it from an HTML document to a style sheet, which is more like a set of styling rules and instructions than a "document" in the classical sense. Two notable exceptions are rel="copyright" and rel="bookmark" which describe the relationship from the current document to (potentially) only part of a document. The 'rev' attribute adds an interesting perspective on this question. Specifically, [http://www.w3.org/TR/html4/struct/links.html#rev-link 12.3.1 of HTML4] shows an example of two links one using rel and the other using rev which mean the same thing. Thus linktypes in general may be either from a whole document or part of a document to a whole document or a part of a document. For example, the RelTag specification introduces the rel="tag" value, and notes that it indicates a relation from a document or major portion thereof to a document. Finally, XFN probably stretches rel the farthest, as it uses rel to indicate a person to person relationship. This person to person scope was not introduced by XFN, but merely adopted. It was introduced by bloggers who have taken to linking to other bloggers by name and thus using people's blog URLs as proxies for people themselves.

=== Is/Was VoteLinks a proper use of rel? ===

No. The problem with using rel for VoteLinks is made apparent with the following example:

<pre><nowiki>
<a href="http://www2005.org" rel="vote-for">WWW2005 is a great conference</a>
</nowiki></pre>

Following the reasoning in the earlier answer to the question of what a rel value means, this link would mean:

The resource indicated by http://www2005.org is a "vote-for" the current document.

That clearly doesn't make any sense, and was certainly not the intent of VoteLinks. Ironically, the reverse makes a lot more sense:

The current document is a "vote-for" the resource indicated by http://www2005.org.

And generalizing to the same cultural usage links as XFN:

The current document, as a proxy for the person who wrote it (e.g. the blogger whose blog it is),
is a vote-for the resource indicated by http://www2005.org.

Fortunately the "rev" attribute captures this "reverse" relationship semantic, and thus the above example should be written like this:

<pre><nowiki>
<a href="http://www2005.org" rev="vote-for">WWW2005 is a great conference</a>
</nowiki></pre>

And thus VoteLinks has been changed to use "rev" instead of "rel", in order to keep the well known and easily understandable "vote-for", "vote-abstain", and "vote-against" values.

=== When a 'rel' value refers to a relationship to or from a page or document, is it referring to just the page, or the contents of the page, or both? ===

The consensus (and convention) is that such rel values are referring to the page itself including its immediate contents, but not for example to embedded contents of like images, objects, frames etc.

== See Also ==

* [[rel-directory]]
* [[rel-license]]
* [[rel-payment]]
* [[rel-tag]], [[rel-tag-faq]]
* [[vote-links]]
* [http://gmpg.org/xfn/ XFN], [http://gmpg.org/xfn/faq XFN FAQ]

rel-faq

2006-05-23T02:51:49Z

Evan: *implies* -> ''implies''

<h1> "rel" attribute frequently asked questions </h1>

This document serves to answer and discuss frequently asked questions about the HTML4 "rel" and "rev" attributes, and their linktype values. Specifically this document explores a number of issues common to and exposed by the various [[microformats]] which extend the HTML4 rel attribute, such as [[rel-license]], [[rel-tag]], [[vote-links]], and [http://gmpg.org/xfn/ XFN].

__TOC__

== Authors ==
* John Allsopp, [http://westciv.com Western Civilisation]
* [http://tantek.com Tantek Çelik], [http://technorati.com Technorati, Inc]

== FAQ ==

=== What is the proper use of the 'rel' attribute? ===

First, you can use the [http://www.w3.org/TR/html4/types.html#type-links linktype] as specified is [http://www.w3.org/TR/html4/ HTML 4]. A well known example of this is rel="stylesheet". Second, you "can extend the rel attribute using a [http://www.w3.org/TR/html4/types.html#type-links profile"], but "[http://www.w3.org/TR/html4/types.html#idx-link_type-2 HTML doesn't specify/recommend a profile format]". XMDP can be used to formally define new rel values.

=== What does a rel value really mean? ===

The rel values in HTML follow a consistent pattern which at a minimum ''implies'' a deliberate design. rel describes the relationship of a hyperlink in terms of what the destination (href) is, to the source, or from the source's perspective. rel="stylesheet" is perhaps the easiest example to understand in this manner, because it is saying that this resource over there (indicated with the href) *is* a "stylesheet" for the current document. Similarly, rel="help" link states that the resource indicated by the href is "help" (e.g. a help file or FAQ) for the current document. All the rest of the values defined in HTML4 also follow this pattern of being a *noun* which labels the resource indicated by the href, from the perspective of the current document.

=== Then what does "rev" mean? ===

"rev" is the precise opposite (or "reverse) of the "rel" attribute. E.g. a rev="help" link indicates that *the current document* is "help" for the resource indicated by the href.

=== Is rel single or bi directional? ===

Though the HTML4 specification is not specific on this point, all the rel values in the HTML4 specification follow a very consistent pattern that indicate a specific directionality to the value of the rel attribute. The *only* exception to this is the value "alternate", which, is actually inherently symmetric, so rel="alternate" means pretty much the same thing as rev="alternate". I say pretty much because in theory (and in practice) one of a pair of alternates is likely to be more definitive, and thus one is more a primary resource, with the other being an alternative. In theory you could extend rel with a new value, e.g. "original" which could be used to point back the original version of a document. This could be used for example with translations, where translations of a document would point back to the original with rel="original".

=== Are "rel" attributes, and linktypes in general, just document to document? ===

The vast majority of the rel values defined in HTML4 are from a document to a document. rel="stylesheet" is a bit of an exception, as it from an HTML document to a style sheet, which is more like a set of styling rules and instructions than a "document" in the classical sense. Two notable exceptions are rel="copyright" and rel="bookmark" which describe the relationship from the current document to (potentially) only part of a document. The 'rev' attribute adds an interesting perspective on this question. Specifically, [http://www.w3.org/TR/html4/struct/links.html#rev-link 12.3.1 of HTML4] shows an example of two links one using rel and the other using rev which mean the same thing. Thus linktypes in general may be either from a whole document or part of a document to a whole document or a part of a document. For example, the RelTag specification introduces the rel="tag" value, and notes that it indicates a relation from a document or major portion thereof to a document. Finally, XFN probably stretches rel the farthest, as it uses rel to indicate a person to person relationship. This person to person scope was not introduced by XFN, but merely adopted. It was introduced by bloggers who have taken to linking to other bloggers by name and thus using people's blog URLs as proxies for people themselves.

=== Is/Was VoteLinks a proper use of rel? ===

No. The problem with using rel for VoteLinks is made apparent with the following example:

<pre><nowiki>
<a href="http://www2005.org" rel="vote-for">WWW2005 is a great conference</a>
</nowiki></pre>

Following the reasoning in the earlier answer to the question of what a rel value means, this link would mean:

The resource indicated by http://www2005.org is a "vote-for" the current document.

That clearly doesn't make any sense, and was certainly not the intent of VoteLinks. Ironically, the reverse makes a lot more sense:

The current document is a "vote-for" the resource indicated by http://www2005.org.

And generalizing to the same cultural usage links as XFN:

The current document, as a proxy for the person who wrote it (e.g. the blogger whose blog it is),
is a vote-for the resource indicated by http://www2005.org.

Fortunately the "rev" attribute captures this "reverse" relationship semantic, and thus the above example should be written like this:

<pre><nowiki>
<a href="http://www2005.org" rev="vote-for">WWW2005 is a great conference</a>
</nowiki></pre>

And thus VoteLinks has been changed to use "rev" instead of "rel", in order to keep the well known and easily understandable "vote-for", "vote-abstain", and "vote-against" values.

=== When a 'rel' value refers to a relationship to or from a page or document, is it referring to just the page, or the contents of the page, or both? ===

The consensus (and convention) is that such rel values are referring to the page itself including its immediate contents, but not for example to embedded contents of like images, objects, frames etc.

== See Also ==

* [[rel-directory]]
* [[rel-license]]
* [[rel-payment]]
* [[rel-tag]], [[rel-tag-faq]]
* [[vote-links]]
* [http://gmpg.org/xfn/ XFN], [http://gmpg.org/xfn/faq XFN FAQ]

listing-brainstorming

2006-04-13T21:30:23Z

Evan: /* A Basic Data Structure */

=Listing Brainstorming=

==Some initial thoughts==
* The format should at is most basic be easily implemented by current listing sites without having to modify their existing setups (ie: tinkering with their SQL). For example: http://www.villagevoice.com/classifieds/index.php?page=ads&category=Employment&sort=1&database=0&a=0&class=4025 has a very simple data structure, one can imagine this simple data structure coming from an SQL database. If they need to alter their SQL to adapt to the microformat it will not be adopted (or at least not quickly). Ideally all it would took for current sites to adopt it is just a redesign.
* The format should be extendable enough to allow for specific data to be extracted from it so that specialized services ( format specific aggregators, social aggregators, collaborative filtering, discovery agents ) could be built on top of it.
* The format should be flexible enough to be easily added to current CMS and blogging systems.
* The format should be flexible enough to not interfeer with existing business models of stablished web based listing sites. For example a Job Listings site may get revenue from commissions on actual prospects found and contracted through their site. If the actual way of contacting the prospect is required in the format (rather than a link to the actual listing on their site), they might be weary of implementing the microformat (since it would take them out the loop, so to say). A similar argument could be made for other types of listings sites. However if they can implement a simple data structure that can then be traced to their sites, they would probably implement it since it would help in the discovery process of their listings (through aggregators or crawlers).

== A Basic Data Structure ==
* At its most basic web based listing schemas could be narrowed to:
** name of the item
** description (Some sites don´t even seem to have Title)
** listing date
** contact info. (hCard might be used for this)
* Contextual or Implied Info.
** Regardless of the actual schemas that can be extracted from the html pages there is some information that is implied either contextually or by navigation in all of the examples found. For Example:
*** A listing on ebay.de implies ( contextually ) that the actual location of the listing in itself is in the country of Germany. Other examples: paris.craiglists.org, a classified ad on nytimes.com or (NY) globo.com.br (Brazil) or www.timeout.com (London).
*** A category or "Type" of the listing in itself is generally implied by navigation through the sites. For example: When accesing craiglist.org one chooses the type of listing one wants to see ( housing > housing wanted ). Some sites have specialized data structures depending on the type of listing (For example, it´s fairly common for Vehicles for sale to have a field for brand, model, year.)
** This suggests that location and type should be included in the base format. (Deciding on this may be quite tricky. Particullarly Types, since locations can be extracted from Contact. )

== Extending the Base Structure By Listing Type==
* Once a basic format is decided, it could be extended to more specific types of data structures.
** Type For Sale
*** Base
**** title could map to product name. (This mapping thing is just an idea, but it seems to be fairly common)
**** description could map to product description.
**** product category (may be part of the basic format category. No idea how to go with this.)
**** product condition (Used|New)
*** Optional
**** price ammount
**** price currency (currency is either specified or implied contextually when naming a Price. A price could be considered an specific ammount of an specific currency.)
**** photo (Optional, might be more than one *)
**** duration or expiry date of the offer.
**** availability (If there is more than one for sale, or even none.)
** Type For Sale, Product Category = vehicle (May extend for sale)
*** brand
*** model
*** year
** Type Wanted
*** title could map to product name.
*** description could map to product description.
*** duration or expiry date.
** Type Job Offer
*** title could map to job category (seems to be a common practice)
*** description could map to job description
*** requirements
*** contract type (part time| full time | temp)
*** contact could map to company or recruiter

* More extended types should be considered...

== See Also ==
* [[listing-examples]]
* [[listing-brainstorming]]
* [[listing-formats]]

hcard

2006-04-13T19:24:36Z

Evan: /* Examples in the wild */ Wikitravel Singapore/Sentosa

<h1>hCard</h1>

hCard is a simple, open, distributed contact information format for people, companies, and organizations, which is suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. hCard is a 1:1 representation of the vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]) in XHTML, one of several open [[microformats|microformat]] standards.

Want to get started with writing an [[hcard|hCard]]? Use the [http://microformats.org/code/hcard/creator hCard creator] to write up some contact information and publish it.

__TOC__

== Draft Specification ==

=== Editor ===
[http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]

=== Authors ===
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc]
* [http://suda.co.uk/ Brian Suda]

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to: my good friend [http://vadim.com/ 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.

== Introduction ==
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt 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 is a 1:1 representation of the aforementioned vCard standard, in semantic XHTML. Bloggers can both embed vCards directly in their web pages, and style them with CSS to make them appear as desired. In addition, hCard enables applications to retrieve information about such vCards directly from web pages without having to reference a separate file.

Use the [http://microformats.org/code/hcard/creator hCard creator], copy the HTML code it generates to your blog or website to publish your contact info.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
=== In General ===
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt 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 XHTML elements.

=== More Semantic Equivalents ===
However, for some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:
* <code>URL</code> in vCard becomes <code><a class="url" href="...">...</a></code> inside the element with <code>class="vcard"</code> in hCard.
* 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>

=== Singular vs. Multivalued Properties ===

For properties which are singular (e.g. "N" and "FN"), the first descendant element with that class should take effect, any others being ignored.

For properties which can be plural (e.g. "TEL"), each class instance should create a instance of that property.

==== 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.

=== Human vs. Machine readable ===

If an <code><abbr></code> element is used for a property, then the '<code>title</code>' attribute of the <code><abbr></code> element is the value of the property, instead of the contents of the element, which instead provide a human presentable version of the value.

Similarly, if an <code><img></code> element is used for one or more properties, it must be treated as follows:
# For the "PHOTO" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value.
# For other properties, the <code><img></code> element's '<code>alt</code>' attribute is the value of the property.

=== Value excerpting ===

Sometimes only part of an element which is the equivalent for a property should be 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 "<code>value</code>" is introduced 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:

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

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.

# '''NAME''', '''PROFILE''', '''SOURCE''', '''PRODID''', '''VERSION''' properties as defined in Sections 2.1.2, 2.1.3, 2.1.4, 3.6.3, 3.6.9 of RFC 2426. 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 <code><title></code> element in (X)HTML documents) to construct the NAME property, MAY output a PROFILE value of "<code>VCARD</code>" per RFC 2426, 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 or organization and should be treated as such. In this case the author MUST also 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 (RFC 2426) 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, [http://microformats.org/wiki/hcard#Organization_Contact_Info see above] for that.

# The content of "FN" is broken into two "words" separated by whitespace.
# The ''first'' word of the "FN" is interpreted as the "given-name" for the "N" property.
# The ''second/last'' word of the "FN" is interpreted as the "family-name" for the "N" property.
# 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 on the Web in actual content published on the Web (e.g. authors of [[hReview|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:

# The content of the "FN" is treated as a "nickname" property value.
# Parsers should handle the missing "N" property by implying empty values for all the "N" sub-properties.

Note: 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".

=== Root Class Name ===

The root class name for an hCard is "vcard".

=== Property List ===

This is the list of properties (and subproperties, in parentheses, like this) in hCard, taken from vCard:

* fn, n (family-name, given-name, additional-name, honorific-prefix, honorific-suffix), nickname, sort-string
* url, email (type, value), tel (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
==== 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:
<pre><nowiki>
<span class="tel"><span class="type">Home</span> (<span class="type">pref</span>erred):
<span class="value">+1.415.555.1212</span>
</span>
</nowiki></pre>

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 [http://gmpg.org/xmdp XMDP] profile of hCard which contains the above complete list of properties, with references to their RFC 2426 definitions.

=== Parsing Details ===

See [[hcard-parsing|hCard parsing]].

== Examples ==

This section is informative.

=== Sample vCard ===

Here is a sample vCard:

<pre><nowiki>
BEGIN:VCARD
VERSION:3.0
N:Çelik;Tantek
FN:Tantek Çelik
URL:http://tantek.com/
ORG:Technorati
END:VCARD
</nowiki></pre>

and an equivalent in hCard with various elements optimized appropriately. See [[hcard-example1-steps| hCard Example 1]] for the derivation.

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

This hCard might be displayed as:

[http://tantek.com/ Tantek Çelik]<br />
Technorati

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.

=== More Examples ===

See [[hcard-examples]] for more examples, including all examples from vCard RFC 2426 converted into hCard.

== Examples in the wild ==
This section is '''informative'''.

The following sites have published hCards, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you have an hCard on your own page, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

=== New Examples ===
Please add new examples to this section.
* [http://gross.org.za/contact Charl van Niekerk's hCard]
* [http://billy-girlardo.com/WP/ BillyBLOGirlardo] uses hCard for contact information.
* [http://www.hicksdesign.co.uk/ Hicksdesign] uses hCard for contact information.
* http://www.gr0w.com/articles/press/growsearch_launched_press_release/ - hCard in a press release for the press contact info
* http://www.redmonk.com/cote/archives/2006/03/testing_out_mic.html - hCard with explanation
* [http://andy.ciordia.info/ it's my island], personal blog, hcard on the ''[http://andy.ciordia.info/pages/about_me About the Writer]'' page. [[User:Ciordia9|Andy Ciordia]]
* [http://www.windowonwoking.org.uk/ Window on Woking], a local community site in the UK, uses hCard in the homepage of each member organisation and local Councillor.
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site -- by [[User:ChrisCasciano|Chris Casciano]]
* [http://www.30boxes.com/ 30 Boxes],a social calendar application and digital lifestyle aggregator, automatically creates an hcard for you with your account. It is found under Settings > Syndication.
* [http://www.nearwhere.com/ Nearwhere.com] allow you to put an hcard on an interactive map.
* [http://www.brentozar.com/ Brent Ozar] added a [http://www.brentozar.com/contact.php contact] page hCard.
* [http://www.kerihenare.com/ Keri Henare] has rewritten his [http://www.kerihenare.com/contact/ contact] page hCard.
* [http://michaelraichelson.com/contact/ Michael Raichelson] had an hCard on his contact page before SXSW, but never thought to add it here until Tantek requested it.
* [http://www.commoner.com/~lsimon/lindsey_simon_hcard.html Lindsey Simon] has added an hCard to his website as per Tantek's SXSW request for folks to try it
* [http://www.davidgagne.net/ David Gagne] has an hCard in his sidebar.
* [http://www.churchzip.com/map/ Churchzip.com/map] and [http://www.skiwhere.com/map/ Skiwhere.com/map], provide churches, hotels, and ski resorts on the same maps. Locations are formatted as hcards.
* All [http://www.iqdir.com/ IQ Directory Solutions] Yellow Pages web portals use [[hcard|hCard]] markup on listings. For example [http://www.yellowpages-cambodia.com/ Cambodia Yellow Pages] and [http://www.superpages.com.my/ Malaysia Super Pages]
* Ning's cloneable Group app uses fuzzy matching to map custom fields to [[hcard|hCard]] markup on its [http://group.ning.com/index.php?controller=person&action=view&content=JonathanAquino profile] pages.
* [http://claimid.com/factoryjoe Chris Messina' ClaimID hCard]
* [http://factoryjoe.com/blog/hcard Chris Messina' hCard]
* [http://flock.com/about Flock About]
* [http://tantek.com/microformats/2006/03-01-TechPlenAgenda.html Agenda: W3C Technical Plenary Day, March 1 2006] has [[hcard|hCard]] and [[hcalendar|hCalendar]] markup. ([http://www.w3.org/2006/03/01-TechPlenAgenda.html original here]).
* [http://www.gr0w.com/articles/press/growsearch_launched_press_release/ GrowSearch Launched (Press Release)] uses an hCard to provide Press Contact Point.
* The [http://www.arborday.org/ National Arbor Day Foundation] has started using hCards for their [http://arborday.org/programs/conferences/communityforestry/index.cfm upcoming] [http://arborday.org/programs/conferences/hazardtrees-treeplanting/ conferences].
* [http://www.multipack.co.uk The Multipack] has numerous hCards, especially on the [http://www.multipack.co.uk/members/ members page], as well as the next meeting information.
* [http://deadringrancor.livejournal.com/ Justin McDowell] used an hCard when [http://deadringrancor.livejournal.com/221332.html referring to a person in his blog post]
* [http://davecardwell.co.uk/cv/ Dave Cardwell] has included his hCard in his Curriculum Vitae.
* [http://blog.usweb.com/ Shaun Shull] has written a great post on [http://blog.usweb.com/archives/how-microformats-affect-search-engine-optimization-seo How Microformats Affect SEO], and has included his [[hcard|hCard]] as one of the examples.
* [http://www.thefutureoftheweb.com/ Jesse Skinner] has written a simple [http://www.thefutureoftheweb.com/blog/2006/1/hcard tutorial with examples]
* [http://www.w3.org/2005/12/allgroupoverview.html 2006 W3C Technical Plenary Week] has marked up the venue, contacts, and program committee members all with hCard.
* [http://www.avf-nexus.co.uk AVF-Nexus] have a hCard on their [http://www.avf-nexus.co.uk/contact/ contact page] - (by [http://creation.uk.com Creation"])
* [http://www.thefantasticos.com/andrew/ Andrew White] posted [http://www.thefantasticos.com/andrew/index.php/my-hcard/ his hCard] and [http://www.thefantasticos.com/andrew/index.php/62/microformats-the-should-have-been-obvious-web-dev-tool/ blogged about it].
* [http://www.2sheds.ru Oleg "2sheds" Kourapov] in his [http://www.2sheds.ru/blog/ blog] ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog X2V]) has turned personal profile into hCard ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog/hcard.html X2V]) and his blogroll - into combination XFN/hCards ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog/friends.html X2V])
* [http://www.approveddesign.co.uk Approved Design Consultancy] have a hCard on their [http://www.approveddesign.co.uk/about/contact/ contact page] as well as on their [http://www.approveddesign.co.uk/about/people/ people section] - (by [http://creation.uk.com Creation"])
* [http://weblog.200ok.com.au/ Ben Buchanan] and [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=colin+morris&format=search Colin Morris] have [http://weblog.200ok.com.au/2006/01/griffith-phonebook-adds-hcard-and.html implemented hCards and vCards] for the [http://www.griffith.edu.au Griffith University] [http://www.griffith.edu.au/find/content_phonebook.html online phone book]. Eg. [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=ben+buchanan&format=search Ben's vCard] and [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=colin+morris&format=search Colin's vCard]
* WWF-Australia [http://wwf.org.au/about/contactdetails/ contact details page]
* [http://rasterweb.net/raster/ Pete Prodoehl] used the hCard format on his [http://rasterweb.net/raster/contact.html Contact page]
* [http://alexander-mette.de amette] uses the hCard format in a module of his TikiWiki powered blog
* [http://staff.washington.edu/oren/weblog2/ Oren Sreebny] has an hcard on his blog main index template
* [http://www.cs.brandeis.edu/~zippy/ Patrick Tufts] has an hCard on his homepage.
* [http://ascii20.blogspot.com/ Mathias Kolehmainen and Jamie Taylor] have hCards on their weblog.
* [http://www.hoppsan.org/jamesb/blogger/ Barnaby James] has a hCard on his weblog.
* [http://esa-education.com/schools/map ESA Education] Uses hCards for their 100+ schools and each of the individual school sites.
* [http://www.thereisnocat.com/#vcard Ralph Brandi] has added an hCard to the sidebar of his weblog as a result of Tantek Çelik's portion of the Microformats presentation at SXSW 2006.
* [http://www.yellowpencil.com/contact/ Yellow Pencil] Using microformats to present company contact information
* [http://www.pierce.ctc.edu/ephone/ Pierce College] -- community college directory uses hCard on all individual directory entries.
* [http://www.ukoln.ac.uk/web-focus/events/workshops/webmaster-2006/ the Institutional Web Management Workshop 2006] have marked up all their [http://www.ukoln.ac.uk/web-focus/events/workshops/webmaster-2006/committee/ speakers with hCard].
* http://wikitravel.org/en/Singapore/Sentosa. Wikitravel is experimenting with hcard on its travel guides. This guide uses hcard for all its business listings. More info on http://wikitravel.org/en/Wikitravel_talk:Listings.

=== Examples ===
* [http://thoughtport.blogspot.com/ Aiden Kenny] hasn't published his hCard yet, but he has [http://thoughtport.blogspot.com/2005/07/elemental-particles-of-web.html published his hCard icon]: http://photos1.blogger.com/blogger/4224/444/320/AK-Hcard-icon.gif
* [http://thedredge.org Andy Hume] uses the hcard format to mark-up the names and URLs of commentors on his blog.
* [http://www.bidclix.com/ BidClix]'s [http://www.bidclix.com/AboutContact.html Contact BidClix] page has it's ''contact info'' marked up with an hCard.
* [http://suda.co.uk/ Brian Suda] has managed to embed a photo in [http://suda.co.uk/contact/ his hCard] through the [http://www.ietf.org/rfc/rfc2397.txt data uri scheme] by converting the image to BASE64 code. View the Source to see how this is accomplished. [http://suda.co.uk/projects/X2V/get-vcard.php?uri=http%3A//suda.co.uk/contact/ The X2V link] will extract the image and encode it for a vCard which will be displayed in some address book applications.
* [http://cinematreasures.org Cinema Treasures] uses hCard to markup venue information for 10,000+ movie theaters.
* [http://www.w3.org/People/Connolly/events/ Dan Connolly's index of events and talks] has hCards for many of the people he has met at those events. In Mar 2006, he moved a bunch of hotel contact info from his PDA to this page; it's now up to 32 hCards.
* [http://doncrowley.blogspot.com/ Don Crowley] has published [http://www.crowley.nl/hcard.html his hCard] as well as a nifty hCard button: http://www.crowley.nl/images/hcard.png
* [http://loadaveragezero.com/hnav/contact.php Douglas W. Clifton] added all types of contact information
* [http://eventful.com Eventful] publishes all of its venue information pages with embedded hCards.
* [http://www.iowamilitaryveteransband.com/members/ Iowa Military Veterans Band Contacts] - 95 hCards [http://weblog.randomchaos.com/archive/2005/10/24/Microformats/ marked up by Scott Reynen]
* [http://JackWolfgang.blogspot.com Jack L. Wolfgang II] has [http://jack.randomata.com/resume/ converted the addresses in his resume to hCards].
* [http://www.efas.fupl.asso.fr/efas/_Mathieu-Drouet_.html Mathieu Drouet] and [http://www.efas.fupl.asso.fr/efas/_Annie-Leger_.html Annie Leger] both have hCards
* [http://www.ndunn.com Neil Dunn] has published his rather [http://www.ndunn.com/2005/10/7/hCard good looking hCard]
* [http://www.oliverbrown.me.uk/ Oliver Brown] has published his hCard.
* [http://www.paradigmproductions.org/contact/ Paradigm Productions] published a vcard as a ul (marked up by [http://www.linkingarts.com/ Peter Jacobson])
* [http://www.splintered.co.uk/ Patrick H. Lauke] has marked up [http://www.splintered.co.uk/about/ his contact info with hCard].
* [http://blah Paul Schreiber has published his hCard on [http://paulschreiber.com/about/?contact his about page].
* [http://paulschreiber.com/blog/ Paul Schreiber]'s [http://concerts.shrub.ca/ Sunnyvale House Concerts] site publishes hCards for upcoming artists, as well as an hCard for the page itself. In addition the [http://concerts.shrub.ca/shows Past Shows] page contains hCards for all past artists.
* [http://www.paulmichaelsmith.com/blog/hcard.htm Paul Smith] has created an hCard page which is Human Readable, and a link to X2V passing the same hCard page to generate a vCard.
* [http://www.windley.com/archives/2005/07/hcards_trying_o.shtml Phil Windley has published] [http://phil.windley.org/hcard.html his hCard].
* [http://www.go-curiosity.com/about.htm Piercarlo Slavazza] has published an hCard.
* [http://zooibaai.nl/ Rob Mientjes] has published his hCard on [http://zooibaai.nl/about/ his about page].
* [http://rbach.priv.at/Contact Robert Bachmann] has published his hCard and [http://rbach.priv.at/Images/hcard a button].
* [http://blah Scott Reynen has published his hCard on [http://www.randomchaos.com/document.php?source=scott_reynen his profile page].
* [http://www.stackframe.com/ StackFrame, LLC] has published [http://www.stackframe.com/people/ employee] and [http://www.stackframe.com/contact/ general] contact information as hCards.
* [http://www.wolfsreign.com Steven Ametjan] has published his hCard on [http://www.wolfsreign.com/about/ his about page].
* [http://tantek.com/microformats/2005/syndicate/speakers-list.html Syndicate - Speaker List] as a set of hCards
* [http://tagcamp.org/index.cgi?ContactList TagCamp contact list]
* [http://tantek.com/log Tantek's Thoughts] includes an inline author hCard at the bottom of the page.
* [http://technorati.com/ Technorati]'s [http://www.technorati.com/about/ About page] lists their '''Media Contact'''
* [http://www.deadringerart.com/ The Brothers McDowell] have hCards at their Contact page.
* [http://twinsparc.com/ Twinsparc] put an hCard in the header and footer of all their pages.
* [http://tantek.com/microformats/2005/web2/speakers.html Web 2.0 Conference speakers page marked up with hCard]
* [http://we05.com/ Web Essentials 05] marked up all their [http://we05.com/presenters.cfm presenters with hCard].

=== Examples with some problems ===
* [http://gbraad.nl/ Gerard Braad] has published an example on his [http://gbraad.nl/site/?p=profile profile] page that is almost consistent with his original [http://gbraad.nl/files/gbraad.vcf vCard] file. Also progress is made for transforming his [http://files.gbraad.nl/foaf.rdf FoaF] file to a hCard encoded representation. (also done for my spouse:[http://spouse.gbraad.nl/site/?p=profile Yong Yuan])
** (2005-09-27) PASSED, PASSED
** WARNINGS
*** uses 'n given-name' and 'n family-name' instead of nesting the given- and family- names inside the 'n'
*** has one 'tel' value with a bunch of values stuffed in
*** probably more problems --[[User:RyanKing|RyanKing]] 17:19, 5 Jan 2006 (PST)
* [http://kinrowan.net/ Cori Schlegel] [http://kinrowan.net/blog/wp/archives/2005/07/08/a-problem-with-the-structured-blogging-plug-in-for-wordpress/ discusses how he has updated] [http://kinrowan.net/blog/contact his contact page with hCard]
** INVALID - using 'prefix' instead of 'honorific-prefix' and type's in classnames (in both adr and tel) and has two photo's (the second could be 'logo') --[[User:RyanKing|RyanKing]] 15:15, 5 Jan 2006 (PST)
* The good ship [http://styrheim.com/test/leonid.html Leonid Miloslavskiy] spotted in the North Atlantic
** INVALID --[[User:RyanKing|RyanKing]] 00:50, 27 Oct 2005 (PDT)
*** class="family" should probably be family-name
*** the "n" property is missing and the "n" optimization can't be applied
*** the first geo propery is empty, the second one is invalid (ie, it doesn't contain lat/long)
* [http://landsbank.fo/#hCard Landsbanki Føroya]
** INVALID - using embedded rdf/xml invalidly
* [http://chrischerry.name/blog/contact/ Chris Cherry's contact page with his hCard]
** WARNING - uses class="cell" instead of <span class="type">cell</span>
* [http://www.bath.ac.uk/contact/ University of Bath] Person Finder results are encoded with hCards so you can easily create a vCard from any result.
** ERROR - attempt to use Implied-N optimization where that's not possible. --[[User:RyanKing|RyanKing]] 14:29, 5 Jan 2006 (PST)
** Error appears for external users only. Won't be fixed any time soon. -- [[User:PhilWilson|PhilWilson]] 00:03, 28 Jan 2006 (GMT)
* [http://richi.co.uk/blog/2005/12/structured-blogging.html Richi Jennings] has put up his attempt
** INVALID, missing FN --[[User:RyanKing|RyanKing]] 12:47, 5 Jan 2006 (PST)
* [http://www.shiftingpixel.com/about/ shifting pixel photoblog] has published an hCard.
** "organization_name" should be "organization-name" (s/_/-/), otherwise good --[[User:RyanKing|RyanKing]] 14:01, 5 Jan 2006 (PST)

== Implementations ==
This section is '''informative'''.

The following implementations have been developed which either generate or parse hCards. If you have an hCard implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.
* [http://www.webstandards.org/action/dwtf/microformats/ Dreamweaver Extension suite] from the [http://webstandards.org/ Web Standards Project] enables the authoring of hCards from within Dreamweaver 8.
* [http://scooch.gr0w.com/ Scooch] is a slide show and presentation creator that generates a [[hCard]] for individual slide show authors and comment authors with a CSS button to parse and download via [http://suda.co.uk/projects/X2V/ X2V]. Also uses [[hReview]] for slide ratings and [[rel-tag]] for categories.
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar
*[http://opensource.reevoo.com/2006/03/08/release-uformats-12/ uformats] is a ruby library that can parse [[hCalendar]], [[hCard]], [[hReview]] and [[rel-tag]]
* [http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence and details of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.
* [http://www.stripytshirt.co.uk/features/firefox/smartzilla Smartzilla is a Firefox Extension] that finds hCards on web pages and lets you add them to your addressbook.
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding hCard and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* There is [http://flickr.com/photos/factoryjoe/68755089/ evidence of built-in hCard support in the Konqueror browser]. Specifically, Konqueror 3.5, in KDE 3.5 (kubuntu Breezy w/ update).
* There is [http://tagcamp.org/index.cgi?ContactList evidence of a kwiki plugin for hCards]. Update: the [http://svn.kwiki.org/cwest/Kwiki-hCard/ hCard kwiki plugin svn repository]. See the [http://microwiki.caseywest.com/index.cgi?hCard documentation of the hCard kwiki plugin].
* [http://suda.co.uk/projects/X2V/ X2V] is a bookmarklet that parses hCard and produces a .vcf (vCard) stream. Note: needs to be updated as the spec is refined
* [http://www.stripytshirt.co.uk Duncan Walker] has built [http://www.stripytshirt.co.uk/features/firefox/smartzilla a Firefox extension] that gets hCard data from a webpage, uses Brian Suda's XSL (locally) to transform it to vcard format and opens the resulting .vcf file.
* [http://george.hotelling.net/90percent/ George] has written a [http://george.hotelling.net/90percent/geekery/greasemonkey_and_microformats.php Greasemonkey user script] that detects hCards and allows users to easily add them to their address book application. Relies on the X2V web service to do the conversion.
* [http://blogmatrix.blogmatrix.com/ David Janes] has written a [[Greasemonkey]] [http://www.blogmatrix.com/include/microformat-find.user.js script] that finds many microformat elements, including hCards, and [http://blog.davidjanes.com/mtarchives/2005_08.html#003376 provides a popup menu of actions]. The hCard to vCard conversion is done internally within the script. ''This does not work with FireFox 1.5+/GreaseMonkey 0.6.4+.''
* [http://diveintomark.org/ Mark Pilgrim] has also written an [http://diveintomark.org/projects/greasemonkey/hcard/ hCard parser Greasemonkey user script]. It is self-contained and does not rely on the X2V web service.
* [http://www.oliverbrown.me.uk/2005/09/03/a-working-microformats-extension-to-simplexml/ Oliver Brown] has written an "extension" to [http://www.php.net/simplexml SimpleXML] that gives simple access to hCard information in PHP 5.
* [http://thedredge.org/ Andrew D. Hume] has built a system (Wordpress plugin?) for [http://thedredge.org/2005/06/using-hcards-in-your-blog/ using hcards in your blog] to represent people leaving comments on blog posts.
* The [http://tantek.com/microformats/hcard-creator.html hCard creator] is a very simple, yet illustrative, open source user interface / form / script which creates an hCard in real-time as you type in a set of contact information.
* [http://greenbytes.de/tech/webdav/rfc2629.xslt rfc2629.xslt] now attempts to generate hCard information ([http://ietf.org/rfc/rfc2629 RFC2629] is an XML format for authoring RFCs and Internet Drafts, see [http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html example document])
* [http://tantek.com/microformats/buddylist2hcards.html iChat buddy list to hCards] - Open source AppleScript to automatically convert one's buddy list in the MacOSX iChat AIM client into a valid XHTML 1.0 Strict list of hCards.
* [http://dev.w3.org/cvsweb/2001/palmagent/ palmagent] is a collection of palmpilot and sidekick tools. It includes X2V derivatives xhtml2hcard.xsl and toICal.xsl plus some [http://dev.w3.org/cvsweb/2001/palmagent/hcardTest.html hcardTest] materials
* [http://www.openpsa.org/ OpenPsa 2.x] CRM application uses hCard for all person listings. The widget is [http://www.midgard-project.org/midcom-permalink-922834501b71daad856f35ec593c7a6d reusable across Midgard CMS]
* [http://www.metonymie.com Emiliano Martínez Luque] has written an experimental [http://www.metonymie.com/hCard_extract/app.html hCard finder and structured search application] that finds hCards within a given set of URLs and returns the ones that match the specified search criteria.
* [http://randomchaos.com/microformats/base/ Microformat Base] is an open-source PHP microformat aggregation crawler, currently recognizing hreview, hcalendar, and hcard.

== Additional Applications ==
This section is '''informative'''.

There are numerous potential additional uses and applications for hCards on the Web. The following are merely a few thoughts and possibilities that folks have come up with:

* As an open standard/format for [http://www.gravatar.com/ Gravatars].
* Marking up individual authors of blog posts on a group blog
* Marking up people's names and URLs in a blogroll
* Any reference to people in blog posts (e.g. when citing them, or referencing them, or describing them, by name).
* ...

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://www.ietf.org/rfc/rfc2426.txt vCard RFC2426]

=== Informative References ===
* [http://www.w3.org/2002/12/cal/rfc2426 HTML reformatted version of RFC2426]
* [http://w3.org/TR/REC-CSS1 CSS1]
* [http://tantek.com/log/2004/09.html#hcard hCard term introduced and defined on the Web, 20040930]
* [http://wiki.oreillynet.com/foocamp04/index.cgi?SimpleSemanticFormats FOO Camp 2004 Simple Semantic Formats presentation, 20040910]
* Contributed from http://developers.technorati.com/wiki/hCard.
* [http://www.w3.org/TR/xhtml11 XHTML 1.1]

==== Specifications That Use hCard ====
* [[adr]]
* [[geo]]
* [[hcalendar|hCalendar]]
* [[hreview|hReview]]

==== Similar Work ====
* [http://www.intertwingly.net/wiki/pie/PaceBetterPersonElement Atom PaceBetterPersonElement]
* [http://www.jabber.org/jeps/jep-0054.html JEP-0054: vcard-temp]

== Related Pages ==
* [[hcard-faq|hCard FAQ]] - If you have any questions about hCard, check here, and if you don't find answers, add your questions!
* [[hcard-parsing|hCard parsing]] - Normatively details of how to parse hCards.
* [[hcard-issues|hCard issues]] - Please add any issues with the specification to the issues page.
* [[hcard-profile|hCard profile]] - The XMDP profile for hCard

This 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|hCard Brainstorming]] - where we are keeping our brainstorms and other explorations relating to hCard
* [[hcard-tests|hCard tests]] - a wiki page with actual embedded hCards to try parsing.

== Further Reading ==
* [http://www.digital-web.com/articles/microformats_primer/ Digital Web Magazine: Microformats Primer] by Garrett Dimon has a good intro to hCard
* [http://24ways.org/advent/practical-microformats-with-hcard Practical Microformats with hCard] by Drew McLellan
* [http://thedredge.org/ Andrew D. Hume] has written a blog post on [http://usabletype.com/articles/2005/usable-microformats/ usable microformats] which discusses hCard
* [http://www.thefutureoftheweb.com/blog/2006/1/hcard Jesse Skinner's introduction to hCard]
* [http://blog.usweb.com/ Shaun Shull's] great post on [http://blog.usweb.com/archives/how-microformats-affect-search-engine-optimization-seo How Microformats Affect SEO], including his [[hcard|hCard]] as an example.
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page] and the [http://technorati.com/tags/hcard hCard tag]

rel-tag-issues

2006-04-08T14:27:11Z

Evan: tagtarget?

rel-license-issues

2006-04-07T15:23:11Z

Evan: link to link types for reference

==Issues==

* 2005-06-21 raised by Hixie
*# ''Issue H-1: This specification is lacking a user agent conformance section. There's basically nothing that says how rel=license must be handled.
*#* ACCEPTED. The specification should have a conformance section describing what UAs should do.
*# ''Issue H-2: What's the point of rel="license"?
*#* ACCEPTED. The specification should provide better documentation explaining this (it tries to now, but obviously failed for this particular reader). In particular rel="license" enables a content author to explicitly express in a machine readable way what license(s) the content is licensed under, in particular, by using licenses that reside at external URLs, commonly maintained by various open source and related organizations.

* 2005-12-09 raised by Kenny Heaton
*# ''There needs to be an explicit explanation of when to use rel-license which "Indicates that the referred resource is a license for the referring page.", and when to use the W3C defined copyright link type which "Refers to a copyright statement for the current document." since copyright and licensing are similar concepts and can be confused.
*#* ACCEPTED. MOVE TO FAQ. The HTML 4.01 spec defines the 'copyright' rel value as: "Refers to a copyright statement for the current document." Indeed this is very similar to the license provision, however not exactly the same. Often documents have a their own local copyright statement which includes links to one or more licenses. See the [http://gmpg.org/xfn/ XFN home page] for example, which uses both a <code><link rel="copyright></code> in the header to reference a local copyright statement, and within that, links to a Creative Commons license with rel="license".

* 2006-04-07 raised by [[User:Evan|Evan]]
*# ''Issue 1: It's not clear how to associate a license with part of a page, such as an image or embedded object in the page, or a single news entry on a news page. A typical use-case would be a [http://flickr.com/photos/mauve_porno_rod/4458687/ Flickr page], for which the image is licensed under a CC license but the page itself is not.''
*# ''Issue 2: there's not a clear explanation of how/when to use a <link> element with rel='copyright' (as definied in the [http://www.w3.org/TR/REC-html40/types.html#type-links HTML spec]) and an <a> element with rel='license'.''
*# ''Issue 3: the [http://www.dublincore.org/documents/dcmi-terms/ Dublin Core] 'license' element seems to have the exact same semantics as this standard. There's an [http://www.dublincore.org/documents/dcq-html/ encoding standard for Dublin Core in <meta> and <link> elements], which seems like it would be an easy extension to rel attributes in <a> elements. Can we find some compatibility between the Dublin Core 'license' and rel='license'?''

rel-license-issues

2006-04-07T15:21:24Z

Evan: parts of a page, link vs. a, Dublin Core

==Issues==

* 2005-06-21 raised by Hixie
*# ''Issue H-1: This specification is lacking a user agent conformance section. There's basically nothing that says how rel=license must be handled.
*#* ACCEPTED. The specification should have a conformance section describing what UAs should do.
*# ''Issue H-2: What's the point of rel="license"?
*#* ACCEPTED. The specification should provide better documentation explaining this (it tries to now, but obviously failed for this particular reader). In particular rel="license" enables a content author to explicitly express in a machine readable way what license(s) the content is licensed under, in particular, by using licenses that reside at external URLs, commonly maintained by various open source and related organizations.

* 2005-12-09 raised by Kenny Heaton
*# ''There needs to be an explicit explanation of when to use rel-license which "Indicates that the referred resource is a license for the referring page.", and when to use the W3C defined copyright link type which "Refers to a copyright statement for the current document." since copyright and licensing are similar concepts and can be confused.
*#* ACCEPTED. MOVE TO FAQ. The HTML 4.01 spec defines the 'copyright' rel value as: "Refers to a copyright statement for the current document." Indeed this is very similar to the license provision, however not exactly the same. Often documents have a their own local copyright statement which includes links to one or more licenses. See the [http://gmpg.org/xfn/ XFN home page] for example, which uses both a <code><link rel="copyright></code> in the header to reference a local copyright statement, and within that, links to a Creative Commons license with rel="license".

* 2006-04-07 raised by [[User:Evan|Evan]]
*# ''Issue 1: It's not clear how to associate a license with part of a page, such as an image or embedded object in the page, or a single news entry on a news page. A typical use-case would be a [http://flickr.com/photos/mauve_porno_rod/4458687/ Flickr page], for which the image is licensed under a CC license but the page itself is not.''
*# ''Issue 2: there's not a clear explanation of how/when to use a <link> element with rel='copyright' and an <a> element with rel='license'.''
*# ''Issue 3: the [http://www.dublincore.org/documents/dcmi-terms/ Dublin Core] 'license' element seems to have the exact same semantics as this standard. There's an [http://www.dublincore.org/documents/dcq-html/ encoding standard for Dublin Core in <meta> and <link> elements], which seems like it would be an easy extension to rel attributes in <a> elements. Can we find some compatibility between the Dublin Core 'license' and rel='license'?''

hcard-issues

2006-04-07T04:03:27Z

Evan: categories and tags

= hCard issues =

These are externally raised issues about [[hcard|hCard]] with broadly varying degrees of merit. Thus some issues are REJECTED for a number of obvious reasons (but still documented here in case they are re-raised), and others contain longer discussions. Some issues may be ACCEPTED and perhaps cause changes or improved explanations in the spec. Submitted issues may (and probably will) be edited and rewritten for better terseness, clarity, calmness, rationality, and as neutral a point of view as possible. Write your issues well. — [http://tantek.com/log/ Tantek]

See related [[hcalendar-issues]].

== Issues ==

* 2005-06-21 raised by Hixie
*# ''Issue H-1: This specification is lacking a user agent conformance section. There's basically nothing that says how hCards must be parsed, how to handle errors, and so forth. Is it defined in terms of the DOM? Is it defined in terms of a serialisation? How do you handle unexpected content or missing content?
*#*A: ACCEPTED RESOLVED. See [[hcard-parsing]] for how hCards must be parsed. For errors/unexpected content/missing content, please provide specific examples.

* 2005-06-30 raised by Jack L. Wolfgang II. Please feel free to move these to the FAQs if they are better suited there.
*# ''Handling middle names and suffixes: How does one handle middle initials/names in the hCard format and suffixes that are not honorific suffixes (e.g. Jr., Sr., II, III, etc. as opposed to Ph.D., Esq., M.D., etc.)?''
*#*A: ACCEPTED FAQ. By [http://suda.co.uk Brian Suda] (2005-11-08 updated by [http://tantek.com/log/ Tantek]) hCard is based of the RFC2426 spec. I you want to use a middle initial it can be expanded using the abbr element. <code><abbr title="Middle Name" class="additional-name">M</abbr></code>. Honorific Suffixes in the RFC include Jr. Esq. and other inherited suffixes, so i would just use <code><span class="honorific-suffix">Jr.</span></code> etc.
*# ''Handling different types of addresses: How does one handle the TYPE (e.g. postal, work, etc.) specification for addresses as specified in RFC 2426 Section 3.2.1?''
*#*A: ACCEPTED FAQ. By [http://suda.co.uk Brian Suda] (2005-11-08 updated by [http://tantek.com/log/ Tantek]) If you want to add a type to certain elements, including address and telephone it may be done in the following manner:
<pre><nowiki>
<span class="adr">
<span class="type">work</span>:
...
</span>
</nowiki></pre>
<pre><nowiki>
<span class="tel">
<span class="type">work</span>:
<span class="value">123.456.7890</span>
</span>
</nowiki></pre>
the TYPE needs to be a sub-element of the property (adr, tel, etc) NOTE: EMAIL does NOT have many TYPE attributes, only INTERNET and X400

* 2005-07-22 raised by DanConnolly
*# ''...in my cellphone/sidekick address book, I have a number of entries for companies. I wrote [http://dev.w3.org/cvsweb/2001/palmagent/asHCard.xsl asHCard.xsl] to convert the data from RDF to hCard, but I don't know what to do with entries for companies, since FN is mandatory in hCard.''
*#*A: ACCEPTED FAQ. This should be an FAQ. "How do I write an hCard for a company?" The vCard specification is silent on this point (entries for companies). Thus there are two options as far as the hCard standard is concerned:
*#*# Set "fn" and "org" to the same value. E.g. <code><span class="fn org">W3C</span></code> (recommended)
*#*# Set "org" as usual, and set "fn" explicitly to empty. E.g. <code><span class="fn"></span><span class="org">W3C</span></code> or
*#*#* Simply have no "fn", and on the parsing side, if there is no "fn" present, but there is an "org" property, then duplicate the "org" value as "fn"
*#*The last two options are effectively the same and are both not explicit and easily confusable with a "missing data" condition. Thus option 1 is preferred. For converting applications (hCard to vCard), they ''may'' consider using proprietary extensions to make the distinction explicit in generated vCards, based on either case 1 or 2 above. E.g. Apple's Address Book application supports the property: <code>X-ABShowAs:COMPANY</code>
*#*We are looking for descriptions of how other vCard supporting applications treat "company" vCards differently from "person" vCards. Please provide descriptions here:
*#** Address Book / MacOSX.3:
*#*** Export (e.g. drag & drop to desktop, view in text editor)
*#**** Sets "FN" and "ORG" to the name of the company
*#**** Sets proprietary <code>X-ABShowAs:COMPANY</code>
*#*** Import (e.g. edit in text editor, drag & drop from desktop)
*#**** By setting "FN" and "ORG' to the same name (e.g. Banana Computers Inc.)
*#**** And removing any proprietary properties (e.g. X-ABShowAs)
*#**** Address Book user interface showed new vCard as a "company" contact rather an a person
*#** Address Book MacOSX.4:
*#*** same results as above -RyanKing
*#** The Danger Hiptop (aka T-Mobile Sidekick) addressbook:
*#*** Export (e.g. [http://lists.w3.org/Archives/Public/www-archive/2005Sep/0007.html email to a mailing list])
*#**** Sets "FN" to the empty string and puts the company name in "ORG".
*#*** Import - could not find a way to import a .vcf, by email, IM, or other means into the Sidekick.
*#** Contacts / Outlook 2003 Windows
*#*** Export (e.g. Highlight contact, File, Save As, vcard)
*#**** Sets "N" and "ORG to the name of the company
*#**** Sets "FN" to value in "File as:"
*#** Add another vCard app here.

* 2005-07-23 raised by DanConnolly
*# ''Are class names case sensitive or not? [[hcard]] says "If names in the source schema are case-insensitive, then use an all lowercase equivalent."''
*#* A: ACCEPTED FAQ. Class names are case sensitive per the HTML4 specification. Hence hCard explicitly specifies the case of class name to use for source schema names that are case-insensitive.
*# ''...but I find example data with class="Given-Name"''
*#* A: ACCEPTED RESOLVED. That is from an older preliminary version of the hCard spec which used mixed case class names. Such class names are no longer valid hCard. Please note which examples (URLs) are using the older class names and hopefully we can get them fixed.
*#** A: By [http://suda.co.uk Brian Suda] I have fixed all the references in the [[hcard-brainstorming]] page to reflect the lower-case style, this is a hold-over from the original design, X2V has been updated.
*# ''..and code that supports it [data with class="Given-Name"].''
*#* A: ACCEPTED RESOLVED. Any code supporting the older class name(s) is for backward compatibility only, and should be phased out. Any new hCard code SHOULD NOT support such mixed case class names.
*#** [http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html rfc2629xslt.html] uses Street-Address, Family-Name, etc.
*#*** A: By [http://greenbytes.de/tech/webdav/ Julian Reschke] Fixed rfc2629.xslt (2005-10-29)
*#** [http://suda.co.uk/projects/X2V/ X2V] Version 0.5.1 2005-07-08 supports Family-Name etc.
*#*** A: By [http://suda.co.uk Brian Suda] I agree that the upper-case class names can be removed from the code, this was a hold-over and will be trimmed.
*# ''The ul/ol stuff for multiple values of a property seems to be in the X2V code and in [[hcard-brainstorming]] but not in the [[hcard]] spec.''
*#* A. ACCEPTED RESOLVED. This needs to be added to the spec. 2005-11-08 Update: the way multiple values has been updated to work much better and not require ul/ol.
*# ''the [[hcard-profile]] says country-name but X2V and lots of the data I've seen says country''
*#* A. ACCEPTED RESOLVED. RFC 2426 clearly says "country name" in both the prose and the grammar, thus "country-name" is the correct class name to use. If X2V uses just "country", it needs to be fixed to use "country-name", and any such examples as well. Please note which examples (URLs) are using the class name "country" and hopefully we can get them fixed.
*#** A: By [http://suda.co.uk Brian Suda] I have fixed all the references in the [[hcard-brainstorming]] page to reflect the proper country-name, X2V will support this in the next iteration when i fix several bugs at once.

* 2005-08-12 raised by [http://home.alltel.net/jackwolfgang/contact/ Jack L. Wolfgang II]. Use of mailto transport functionality for the E-Mail address field.
*# ''As stated in the [[hcard-brainstorming]] document, mailto is abused by spammers. As a result, many organizations have moved to form-based contacts as opposed to mailto's. According to [http://www.ietf.org/rfc/rfc2426.txt RFC 2426], Section 3.3.2, "A non-standard value can also be specified." Does this refer to a non-standard e-mail address value or type value?''
*#* A: ACCEPTED FAQ. Type value.

* 2005-10-30 raised by [http://greenbytes.de/tech/webdav/ Julian Reschke].
*# ''Several implementations'' '''(Which ones? Please provide links.)''' ''seem to assume that any class attribute that contains the substring "vcard" indeed signals the presence of vcard information. Not so: there are examples'' '''(What examples? Please provide links.)''' ''of where a token in the class attribute indeed only ''starts with'' "vcard", in which it should be ignored. Implemenations using XPath (such as XSLT or Greasemonkey scripts) should be advised to do a <code>contains(concat(@class,' '),'vcard ')</code>.
*#* REJECTED VAGUE. Which implementations? And which examples?
*#*''(Note: the code <code>contains(concat(@class,' '),'vcard ')</code> is broken see [[parsing-microformats#Parsing_class_values]] for a correct example --[[User:RobertBachmann|Robert Bachmann]])''

* 2005-12-08 raised by [http://www.heatonarts.com Kenny Heaton].
*# ''The specification gives no way to to declare a telephone extention, as in (800) 234-5678 ext. 101''
*#* ACCEPTED FAQ. What is the best way to declare a telephone extension in a "tel" property? (also seems like it would be a vCard FAQ).

* 2006-01-21 raised by [http://inspire.server101.com/ben/resume/ Ben Boyle].
*# ''Have run into issues trying to use definition lists with hCard, specifically around nesting requirements for tel where the DT element takes a class "type" (e.g. Telephone, Facsimile) and the DD element marks the value. It is invalid to place any other elements within a DL that wrap around the DT/DD pairs so there is no available element to assign the class "tel" to. XHTML2 proposes a DI element that will resolve this issue. I am hoping for an interim solution for those that wish to use definition lists, perhaps that "any class that would be placed on the DI parent (in XHTML2) must instead be placed on the first DT element". I realise this will cause headaches for those implementing hCard parsers. I'd also like to note this may affect other (current or future) microformats and relates to the general hassle of definition lists in current (X)HTML recommendations. For your consideration - thanks!''
*#* REJECTED WORKAROUND AVAILABLE. Either don't use definition lists in this manner (because the description of a defintion should go completely in the DD element, and thus you should be able to put the class on that), or use separate DLs in the cases where you would otherwise have needed a DI element.

* 2006-01-28 raised by [http://rbach.priv.at/Microformats-IRC/2006-01-28#T075222 Tantek on #microformats]
*# ''Is hCard is really appropriate for a named phone bridge, or do we need something else for a named phone numbers that are neither people nor organizations (the current two precise semantics that can be defined by hCard). For example see the "Zakim" hCard on http://www.w3.org/2005/12/allgroupoverview.html ''

* 2006-02-13 raised by [http://microformats.org/wiki/User:Eron_Wright Eron Wright]
*# ''Few systems contemplate the altitude component of a coordinate, yet it exists. Altitude becomes important when working with 3D mapping software such as Google Earth. Indeed, the geocoding service that Google Earth uses returns a three-dimensional coordinate. I suggest that hCard provide explicit support for altitude.''
*#* REJECTED POSTPONED. Not in vCard. There is no "altitude" component in vCard (RFC 2426), and thus (certainly for now) there won't be any in hCard. If a new version of vCard were to come out with altitude, then we would add it to hCard. At some point we may also consider adding explicit extensions beyond vCard, but if we were to do so, we would capture them first on the [[hcard-brainstorming]] page.

* 2006-02-19 raised by Miika Mäkinen.
*# ''Couldn't the types for tel numbers be specified in a class? Now, for a phone number one needs to add the type as "visible" text, which is not always preferred. For example, type "Work", many times more suitable label could be "Office" or similar and sometimes you might not want to display any type information at all.''
*#* REJECTED TRIED ALREADY. Using class names for the "type" of a tel or adr [http://microformats.org/wiki/hcard-parsing#ISSUE_2 was attempted], and failed in many situations. In addition, the "type" information is actual data, not just a property name, and thus deserves to be in the ''visible'' markup. Note that you can use abbreviations, e.g. <code><nowiki><abbr class="type" title="work">W:</abbr></nowiki></code> in order to present the type in a way that may better fit in with the rest of your presentation.

* 2006-02-23 raised by [http://www.thefutureoftheweb.com/ Jesse Skinner] and [http://www.thefutureoftheweb.com/blog/2006/1/hcard#comment1 Ben Buchanan].
*# ''Are multiple URLs allowed? The [http://microformats.org/wiki/hcard#Property_List Property List] suggests not, whereas email and tel have multiple type/value pairs. However, the [http://microformats.org/wiki/hcard-parsing#finding_hCard_properties parsing page] suggests multiple URLs are OK. Either way, it seems clear that a type cannot be associated with a URL. So how exactly does hCard deal with multiple URLs?''

* 2006-03-07 raised by [http://tantek.com Tantek].
*# ''Issue 1: In 99% of the cases I am finding the need to explicitly do "n" markup, the person has a three word fn which is in the form "given-name additional-name(or initial) family-name". Should we make three word fn's into another shorthand notation to make this easier for authors?''

* 2006-04-06 raised by [[User:Evan|Evan]].
*# ''What is the relationship between the CATEGORY property and [[rel-tag]]? Can you add a tag to an hCard? How can you add a tag to a particular hcard on a page without tagging the other cards on a page?''

== Template ==

Please use this format (copy and paste this to the end of the list to add your issues):
* YYYY-MM-DD raised by [http://yourhomepage.example.com YOURNAME].
*# ''Issue 1: Here is the first issue I have.''
*# ''Issue 2: Here is the second issue I have.''

hcard-parsing

2006-04-07T00:39:59Z

Evan: /* hCard properties */ unrecongized -> unrecognized

<h1>hCard parsing</h1>

by [http://tantek.com/log/ Tantek Çelik]

== introduction ==

When I first conceived of [[hcard|hCard]], it was clear to me how to unambiguously parse both for the existence of hCards in arbitrary (X)HTML (and anywhere that arbitrary (X)HTML can be embedded, e.g. RSS, Atom, "generic XML"), and hCard properties and values.

I worked directly with Brian Suda to capture these thoughts in an implementation, and Brian wrote X2V, an XSLT script that converts hCards to vCards, thus simultaneously demonstrating the parsability of hCards, and the immediate utility of hCard content interoperating with widespread existing vCard applications.

I am now documenting those thoughts directly here so that additional implementations, rather than having to reverse engineer X2V, can be built directly from these elementary concepts.
__TOC__

== scope ==

Although this page is written specifically to explain how to parse [[hcard|hCard]], the concepts and algorithms contained therein serve as an example for how other [[compound-microformat|compound microformats]] are to be parsed.

== URL handling ==

An hCard parser may begin with a URL to retrieve.

If the URL lacks a fragment identifier, then the parser should parse the entire retrieved resource for hCards.

If the URL has a fragment identifier, then the parser should parse ''only'' the node indicated by the fragment identifier and its descendants, looking for hCards, starting with the indicated node, which may itself be a single hCard.

== root class name ==

Each compound microformat starts with a root element with a relatively unique class name. By that I mean a class name which isn't simply a common word, and is unlikely to have been used outside the context of the microformat. By choosing such a root class name the microformat avoids (for all practical purposes) colliding with existing class names that may exist within the (X)HTML context. This is essential to enabling such compound microformats to be ''embedded'' inside current, existing content, as well as future content.

Fortunately this is not a new problem to solve. The root object names chosen for vCard (RFC 2426) and iCalendar (RFC 2445) similarly had to avoid such collisions and did so by choosing names that were unlikely to have been introduced into a MIME object context. The principle of ''reuse'' dictates that we should reuse the names for these root objects in those RFCs rather than invent our own. Given the same semantics, a design should reuse the names, rather than inventing a second name for the same semantic (a common design mistake made in environments that require namespaces).

In the vCard specification, the names are case-insensitive due to the (lack of) requirements of their context. (X)HTML class names are case sensitive per those specifications. Thus we are required to pick a canonical case for the class name equivalents of vCard object and property names. All lowercase is chosen to follow the precedent (i.e. ''reuse'' the pattern) set by XHTML, which similarly had to canonicalize the case of element and attribute names that it took from HTML4, which itself was case-insensitive due to its context (SGML). Additionally, reasons for avoiding mixed-case (e.g. camel case) in the context of class names may be found in the essay [http://tantek.com/log/2002/12.html#L20021216t2238 A Touch of Class], specifically, the section titled [http://tantek.com/log/2002/12.html#atoc_csensitivity Class sensitivity].

Thus the root class name of an [[hcard|hCard]] is "vcard".

== finding hCards ==

An (X)HTML document indicates that it may contain hCards by referencing the [[hcard-profile|hCard XMDP profile]]. See [http://gmpg.org/xmdp/description XMDP] for more details.

A parser finds hCards in an (X)HTML context by looking for elements with the root class name "vcard" just as the following CSS class selector does:
<pre>
.vcard
</pre>

For example, the following CSS style rule sets the background of all hCards to green:
<pre>
.vcard { background: green; }
</pre>

Note that the (X)HTML class attribute is a space separated set of class names.

Thus all of the following are valid hCard root elements:
* <code><div class="vcard"> </div></code>
* <code><span class="attendee vcard"> </span></code>
* <code><address class="vcard author"> </address></code>
* <code><li class="reviewer vcard first"> </li></code>

Once the root element of an hCard is found, that element and all its descendants are all that is needed to parse the hCard.

Thus it is possible for a well-formed hCard to be extracted from an overall non well-formed context, if the parser has the ability to find elements by class name within that non well-formed context.

== hCard properties ==

The complete list of class names for hCard properties are documented in the [[hcard-profile|hCard profile]].

=== forward compatible parsing ===

When parsing the contents of an hCard, any unrecognized class names must be ignored.

Similarly, unrecognized values for hCard properties must also be ignored.

=== finding hCard properties ===

To parse an hCard for an hCard property (e.g. "fn"), the parser simply looks for the first element with that class name inside the hCard.

This can also be expressed as the first element that matches this CSS selector:

<pre>
.vcard .fn
</pre>

Some properties, like "fn", should only appear once, and thus the parser stops looking for the property after it has found one occurrence. Additional occurrences are ignored.

Other properties, like "adr", "email", "url", "tel", etc., may (and often do) appear more than once, and thus the parser continues to look for each occurrence within the contents of the hCard.

=== parsing hCard properties and values ===

Once an element for a property is found, the contents of the element are used for the value.

There are several exceptions to accomodate [http://microformats.org/wiki/hcard#Semantic_XHTML_Design_Principles semantic XHTML and more semantic equivalents].

For the "email" property in particular, when the element is:
* <code><a href="mailto:..."></code> : parse the value of the 'href' attribute, omitting the "mailto:" prefix and any "?" query suffix (if present), in the attribute. For details on the "mailto:" URL scheme, see RFC 2368.

For properties that may take type URL or URI, parsers MUST handle relative URLs and normalize them to their respective absolute URLs, following the containing document's language's rules for resolving relative URLs (e.g. <base> for HTML, xml:base for XML). In addition, when the element for that property is:
* <code><a href></code> : use the value of the 'href' attribute.
* <code><img src></code> : use the value of the 'src' attribute. If the 'src' is a "data:" URL, use the MIME type in that "data:" URL for the TYPE subproperty, otherwise if the the 'type' attribute is present, us that for the TYPE subproperty.
* <code><object data></code> : use the value of the 'data' attribute for the value.If the 'data' is a "data:" URL, use the MIME type in that "data:" URL for the TYPE subproperty, otherwise if the the 'type' attribute is present, us that for the TYPE subproperty.

For properties with values NOT of type URL or URI, when the element for a property is:
* <code><img alt></code> : use the value of the 'alt' attribute.

For all properties, when the element for a property is:
* <code><abbr></code>: use the value of the 'title' attribute if present, otherwise the contents of the element.
** For properties which take an ISO8601 datetime value, parsers *should* pad any necessary precision (e.g. seconds), and *should* normalize any datetimes with timezone offsets, (e.g. <code>20050814T2305-0700</code>) into UTC (<code>20050815T060500Z</code>).

For all properties, if the element for a property has one or more children with a class name of "value", then concatenate the node values for all those child elements with class name of "value" in their document order, and use that concatenation as the value of the property.

==== white-space handling ====

hCard parsers should handle white-space parsing per XML white-space handling rules, with the following two additions:

# <code><pre></code> handling. Any content parsed as part of an hCard property that is inside a <pre> element must preserve all white-space per XML white-space preservation rules.
# <code><br /></code> handling. Any occurance of a <code><br /></code> inside the element(s) for a value must be treated as a carriage-return (\n) in the respective location in the value.

=== hCard sub-properties ===

There are some hCard properties whose values themselves have structure (AKA structured type value) and are composed of multiple pieces, which we refer to as sub-properties.

For example, the "n" property consists of the sub-properties "family-name", "given-name", "additional-name", "honorific-prefix", and "honorific-suffix".

E.g. from section 3.1.2 of RFC 2426, modified to include Ph.D.

<pre>
N:Public;John;Quinlan;Mr.;Esq.,Ph.D.
</pre>

In hCard this "n" property would be marked up as

<pre>
<span class="n">
<span class="honorific-prefix">Mr.</span>
<span class="given-name">John</span>
<span class="additional-name">Quinlan</span>
<span class="family-name">Public</span>,
<span class="honorific-suffix">Esq.</span>,
<span class="honorific-suffix">Ph.D.</span>
</span>
</pre>

Which would be rendered as:

Mr. John Quinlan Public, Esq., Ph.D.

=== hCard property parameters ===

Some hCard properties have one or more parameters, most often "type", with an enumerated set of values. We represent the specific ''value'' of the parameter as a class name on an element inside the element representing the property.

For example, the "adr" property has a type parameter which takes the values: "dom", "intl", "post", "parcel", "home", "work", "pref".

The "type" parameter is treated like a sub-property.

To encode the "type" of an "adr" property, a nested element with class="type" is used to markup the value of the type parameter.

Example with the "tel" property with a value of type "work":

<pre>
<span class="tel">
<span class="type">work</span>:
<span class="value">+1.123.456.7890</span>
</span>
</pre>

=== Value excerpting ===

Note the element with class="value" used in the above example.

Sometimes only part of an element which is the equivalent for a property should be 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 introduced to excerpt out the subset of the element that is the value of the property.

== Proposed Additions ==
These are proposed additions to hCard parsing. Implementations MAY follow these conventions in order to gain implementation experience, and SHOULD report back on the results.

=== DEL element handling ===

When dealing with an HTML document that is hCard encoded, the parser SHOULD honor the <code><del></code> element.

There are two possibilities here (adopting both may be possible):

1. Skip any occurences of <code><del></code> elements and their contents entirely inside the contents of a property.

2. If the <code><del></code> element is used for a property itself, it could be useful as a way communication the of tombstoning / obsoleting of that particular property value, and thus while a parser that is converting to a vCard SHOULD simply do what is indicated in (1), applications which parsed hCard directly (rather than only supporting vCard) COULD treat such occurences of <code><del></code> elements as a way to remove obsolete information (with user confirmation of course) from a local contact information store.

=== Plain Text Formatting of Structural/Semantic HTML ===
There are several structural/semantic elements in HTML which have useful default styling which could be converted into ASCII (AKA Plain Text) equivalents as a low resolution way of communicating that structure. Note that <code><br /></code> and <code><pre></code> are already handled in the section above titled [http://microformats.org/wiki/hcard-parsing#white-space_handling White-space Handling].

When parsing the DESCRIPTION property, hierarchically convert the following HTML tags into their plain text styling equivalents.

* <code><div></code>, <code></div></code>, <code><dl></code>, <code></dl></code>, <code><dt></code>, <code></li></code>, <code></dd></code> - Append a soft <code>\n</code> to the output. By "soft <code>\n</code>", we mean only do so if there isn't already a line break (in contrast to a "hard" (implied by default) <code>\n</code>). Two things in particular order to ensure that <code><div> <div></code> does not result in two <code>\n</code> characters in a row:
*# only output the <code>\n</code> if something other than whitespace (including <code>\n</code>) was outputted immediately previously.
*# omit any immediately subsequent whitespace characters.
* <code><li></code> - Append a soft <code>\n</code> and then </code> * </code>. (Note: Indenting the contents of the list item is not particularly practical, since that would require line-breaking, and that would depend on knowing the width of when the plain text is rendered. Wrapping to 70 characters may be a good assumption for plain text email, but is probably a very bad assumption for vCard output).
* <code></dt></code> - Append <code>:\n</code>
* <code><dd></code> - Append a soft <code>\n</code> and then </code> </code> (two space ASCII 32 characters).
* <code><h1></code>, <code></h1></code>, <code><h2></code>, <code></h2></code>, <code><h3></code>, <code></h3></code>, <code><h4></code>, <code></h4></code>, <code><h5></code>, <code></h5></code>, <code><h6></code>, <code></h6></code> - Append a soft <code>\n</code> followed by a hard <code>\n</code>. (Note: we may want to consider some conventions to indicate the heading level. Perhaps only the relative heading level inside the property matters, e.g. whatever level HTML heading is seen first is treated as a first level heading, then any subsequent HTML heading elements are treated relative to that original heading (this is because it is likely that the property is embedded somewhere deep inside an HTML document following higher heading levels). Any subsequent higher level headings should perhaps cause a warning, and then simply be treated as a first level heading. Given that, the [http://microformats.org/wiki/wiki-formats#straw_proposals straw proposal for heading syntax] from Ian Hickson is one reasonable possibility, with the only issue being that for first and second level headings, how wide to make the line of '-'s or '='s, which is a similar problem to the line-breaking problem noted above when considering indenting the contents of list-items. Thus perhaps it might be sufficient to simply set a first level heading in ALL CAPS (same as the third level heading in Ian's proposed syntax), and let second and deeper level headings be simply implied by the "one line of text with two line breaks both before and after" convention. Rarely has there been more than one level of heading found within a DESCRIPTION property, and I've never seen more than two even if it is possible.)
* <code><p></code>, <code></p></code> - Append a soft <code>\n</code> followed by a hard <code>\n</code>. (Note: Typical books indent the start of a paragraph approximately three spaces "<code> </code>", and implementations may wish to consider doing so as well. Keep in mind that on the Web, typical paragraphs do not start with a first line indent.)
* <code><q></code>, <code></q></code> - Append a double-quote '"' character.
* <code><sub></code> - Append an open parenthesis "("
* <code></sub></code> - Append a a close parenthesis ")".
* <code><sup></code> - Append an open bracket "["
* <code></sup></code> - Append a a close bracket "[". <code><sup></code> are often used for footnotes which in plain text are often formatted as bracketed numbers.
* <code><table></code>, <code></table></code>, <code><tbodygt;</code>, <code></tbody></code>, <code><thead></code>, <code></thead></code>, <code><tfoot></code>, <code></tfoot></code>, <code><tr></code>, <code></tr></code>, <code><caption></code>, <code></caption></code> - Append a soft <code>\n</code>. Of course one could try to do a lot more with representing the structure of the table, but that is almost certainly more work than it is worth, nevermind the complexities introduced by COLSPAN, ROWSPAN etc. At least by approximating the table sections and rows the table may be more readable.
* <code></td></code>, <code></th></code> - Append a space and a tab character (ASCII 32, ASCII 9 respectively). It's not clear that what subsequent application would be able to make use of this visually, but at least the tabular nature of the structure is indicated and it makes it possible to copy and paste the table into something that handles tabular content like a spreadsheet and have the tabular structure reflected.

==== More challenging elements ====
* <code><ol></code> - it would be nice to number list items inside an ordered list rather than bullet them, but keeping track of list item numbers/counts is a non-trivial piece of state information for the parser to deal with, and thus we are omitting this behavior for now.

==== Use of CSS computed styles instead of HTML default styles ====
Rather than assuming the default presentation for these elements, and using that for the basis of plain text formatting, a parser could use the respective equivalent computed style properties and use those instead. However, requiring an hCard parser to also implement Cascading Style Sheets (e.g. CSS1) is out of scope. Some environments (i.e. a browser DOM) may already provide this information, and in that case, it may be easy for an hCard parser (e.g. a clientside javascript parser) to use computed style properties. E.g. instead of the elements above, the following computed styles could be used:
* display:block - Append a soft <code>\n</code>
** text-indent (non-zero value, on an element with display:block or display:list-item) - Append a number of spaces equivalent to value of the text-ident property divided by the computed font-size property of the element.
** margin-top, margin-bottom (non-zero value, on an element with display:block or display:list-item) - Append a number of "\n" equivalent to the value divided by the computed font-size property of the element. Obviously this won't properly collapse vertical margins.
* display:list-item - Append a soft <code>\n</code> followed by " * "
* etc.
This is enough extra work that I'm not sure it is worth spending the time documenting more equivalents. The above are sufficient to illustrate the possibility.

== Outstanding Issues ==

=== Issues 3 ===

Might be worth considering defining the parsing in terms of the DOM, so that it applies to HTML and XHTML equally without ambiguity.

== Resolved Issues ==

This section is informative.

The following issues have been explored and resolved

=== Resolved as of 2005-09-16 ===

==== ISSUE 1 ====

Should we make plural sub-property names into singular versions and simply allow multiple instances? I.e. the singular honorific prefix would make more sense if it was classed as such, and the list implied by the value for honorific-suffixes could be made more explicit (and thus more easily machine parseable):

<pre>
<span class="n">
<span class="honorific-prefix">Mr.</span>
<span class="given-name">John</span>
<span class="additional-names">Quinlan</span>
<span class="family-name">Public</span>,
<span class="honorific-suffix">Esq.</span>,
<span class="honorific-suffix">Ph.D.</span>
</span>
</pre>

RESOLUTION: Adopt singular class name equivalents for plural property and sub-property names.

==== ISSUE 2 ====

Restricting the "type" sub-property values to being expressed in class names seems less than ideal. It's taking a piece of information which is very often visible in the content, and forcing it to be invisible.

Here is an example of an extensive bit of contact information on a web page:

http://www.patchlink.com/company/contact.html

<pre>
Maiilng Address
3370 N. Hayden Road, #123-175
Scottsdale, AZ 85251-6632

Physical Address
8515 E Anderson
Scottsdale, AZ 85255
</pre>

Note that the type information for each "adr" is explicit in the content. This content could be marked up like this:

<pre>
<div class="adr">
<abbr style="display:block" class="type" title="postal,parcel">Mailing Address</abbr>
<div class="street-address">3370 N. Hayden Road, #123-175</div>
<span class="locality">Scottsdale</span>, <span class="region">AZ</span>
<span class="postal-code">85251-6632</span>
</div>
<div class="adr">
<abbr style="display:block" class="type" title="work,pref">Physical Address</abbr>
<div class="street-address">8515 E Anderson</div>
<span class="locality">Scottsdale</span>, <span class="region">AZ</span>
<span class="postal-code">85255</span>
</div>
</pre>

RESOLUTION: The "type" parameter MUST be marked-up when content is available (like the above two examples). We are ditching the type-value-as-another class name pattern.

In addition since there are some potentical problems with the "type" parameter for TEL and EMAIL properties. Since there are no defined sub-properties (unlike ADR's post-code, locality, etc) the entire node-value of TEL is taken as the value. For example:
<pre>
<span class="tel">+1.123.456.7890 <abbr class="type" title="work">(work)</abbr></span>
</pre>
would be represented in vCard as:
<pre>
TEL;TYPE=work:+123.456.7890 (work)
</pre>

We are introducing another sub-property class="value" to enable excerpting of a the value of an element of for a property.

<pre>
<span class="tel"><span class="value">+1.123.456.7890</span> <abbr class="type" title="work">(work)</abbr></span>
</pre>

Then parsers would first need to look for class="value" and take the node value of that if it exists rather than class="tel".

If one or more child elements with the class name of "value" are present inside the element for a property, then concatenate the node values of those child elements (in the order found) and use that as the value of the property. This would be before using the node value of the element for a property itself.

== References ==

=== Normative References ===
* [[hcard|hCard]]
* vCard (RFC 2426)
* [http://w3.org/TR/XHTML1 XHTML 1.0 Recommendation]
* [http://w3.org/TR/html401 HTML 4.01 Recommendation]
* [http://gmpg.org/xmdp/ XMDP]

=== Informative References ===
* [http://w3.org/TR/REC-CSS1 CSS1 Recommendation]

rel-tag-issues

2006-04-07T00:34:58Z

Evan: bold, preposition

rel-tag-issues

2006-04-07T00:33:43Z

Evan: tag for a portion of a page

User:Evan

2006-04-03T22:42:46Z

Evan: me

[http://www.mediawiki.org/ MediaWiki] developer and tech director of [http://wikitravel.org/en/ Wikitravel].

irc

2006-04-03T22:41:59Z

Evan: /* People on irc */ me

__NOTOC__
= Microformats IRC =

We have an IRC channel, [irc://irc.freenode.net#microformats #microformats on the freenode network].

There's typically someone there at any point during the day, though there isn't always active discussion. Sometimes, though this is the best place to discuss issues that need lots of back and forth discussion.

== People on irc ==
A list of IRC regulars and their normal timezones.

* [[User:Amette|amette]] (+1000)
* [[User:B.K._DeLong|bkdelong]] (-0500)
* [[User:Ben Ward|BenWard]] (+0000)
* [[User:BenjaminCarlyle|BenjaminCarlyle]] (+1000)
* [[User:Boneill|boneill]] (+0000)
* [[User:Brian|briansuda]] (-0600)
* [[User:Cgriego|cgriego]] (-0600)
* [[User:ChrisCasciano|pnhChris]] (-0500)
* [[User:ChrisMessina|factoryjoe]] (-0800)
* [[User:ChristopherStJohn|cks]] (-0600)
* [[User:Dave Cardwell|davecardwell]] (+0000)
* [[User:DimitriGlazkov|dglazkov]] (-0600)
* [[User:EdwardOConnor|hober]] (-0800)
* [[User:Enric|enric]] (-0800)
* [[User:Evan|evanpro]] (-0500)
* [[User:Fil|Fil]] (+0200)
* [[User:Hlb|hlb]] (+0800)
* [[User:IanHickson|Hixie]] (-0800)
* [[User:Izo|IZO]]
* [[User:JoeGregorio|jcgregorio]]
* [[User:Jonathan_Arkell|jonnay]] (-0700/0600)
* [http://epeus.blogspot.com/ KevinMarks] (-0800)
* [[User:Mark Mansour|Mark Mansour]] (+1100)
* [[User:neuro|neuro`]]
* [[User:RobertBachmann|RobertBachmann]] (+0100, summer: +0200)
* [[User:RyanKing|kingryan]] (-0800)
* [[User:Steve Ganz|SteveGanz]] (-0800)
* [[User:Tantek|Tantek]] (-0800)

=== bots ===

* [[mfbot]]
* [[mflogbot]]
* [http://joi.ito.com/joiwiki/JiBot jibot]

== Logs ==

Available here: http://rbach.priv.at/Microformats-IRC/

== IRC meetups ==

The idea of having IRC meetups (that is, a set time for meeting on IRC) has been suggested by [[User:RyanKing|Ryan King]], as it appears to work well for the WordPress community and may help us from time-to-time. As of yet, there are no plans to have meetups, though.

hreview-issues

2006-04-03T21:17:21Z

Evan: price, price range

= hReview issues =

These are externally raised issues about [[hreview|hReview]] with broadly varying degrees of merit. Thus some issues are REJECTED for a number of obvious reasons (but still documented here in case they are re-raised), and others contain longer discussions. Some issues may be ACCEPTED and perhaps cause changes or improved explanations in the spec. Submitted issues may (and probably will) be edited and rewritten for better terseness, clarity, calmness, rationality, and as neutral a point of view as possible. Write your issues well. — [http://tantek.com/log/ Tantek]

See related [[hcalendar-issues]] and [[hcard-issues]].

== Template ==

Please use this format (copy and paste this to the end of the list to add your issues):
* YYYY-MM-DD raised by [http://yourhomepage.example.com YOURNAME].
*# ''Issue 1: Here is the first issue I have.''
*# ''Issue 2: Here is the second issue I have.''

== rel="self" ==

2005-01-04 by [[User:DavidJanes|David Janes]]:

Atom defines rel="self" [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html#rfc.section.4.2.7 here]

: The value "self" signifies that the IRI in the value of the href attribute identifies a resource equivalent to the containing element.

HTML rel="boomark" [http://www.w3.org/TR/REC-html40/types.html#type-links here]

: Refers to a bookmark. A bookmark is a link to a key entry point within an extended document. The title attribute may be used, for example, to label the bookmark. Note that several bookmarks may be defined in each document.

Since we're using "bookmark" to mean the entry point to the hReview, isn't the "self" redundant or overly subtle?

== default lower bound ==

* YYYY-MM-DD????? raised by [[User:ScottReynen|Scott Reynen]]
*# ''Why is the default lower bound 1 when the [[reviews-formats|real world examples]] almost all have a lower bound of 0?''
*#* REJECTED INVALID ASSUMPTION. Most [[review-examples|real-world examples]] have a lower bound of 1, not 0.

== default range ==
* 2006-02-23 raised by Andy Mabbett
*# ''Not all marks give ratings "out of five". The value should be a percentage. Zero should be allowed.''
*#* REJECTED IGNORES RESEARCH. Most [[review-examples|real-world examples]] have a range of 1.0-5.0 not a percentage. You may set the "best" bound to 100 explicitly, and the "worst" bound to 0 explicitly per the spec if necessary.
*#* "most" != "all"; indeed, the page you cite has examples of "1-10" and "0-100%". I never claimed that many examples use percentages, but I'm sure a mathematician would explain that values in the range "1-5" may be expressed as percentages.
*#* REJECTED RTFM. Most examples are what the defaults are based on. Please re-read both the spec and the previous resolution, 1-10 is allowed (you have to explicitly set "best" to 10), and so is 0-100 (you have to explicitly set "worst" to 0 and "best" to 100).

== Specification Clarifications ==

* 2006-02-01 raised by [http://tantek.com Tantek].
*# ''The spec needs to clarify that there is only one "item" per "hreview".''
*#* ACCEPTED. Resolved in hReview 0.3.

== Multilinguism ==

* 2006-03-22 raised by Fil
*# the reviewer spec can't say ''For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer.'' as this word ("anonymous") is going to be apparent on the page, and is not multilingual (and even in English someone might want to use another word, like "an anonymous coward")

== Price ==

* 2006-04-04 raised by [[User:Evan|Evan]].
*# It doesn't seem possible to give an approximate, average, or absolute '''price''' of the product or service in question. Examples: for a piece of software, the suggested retail price. For a restaurant, average price of an entree, ''or'' a '''price range'''. Prices should almost definitely have a ''currency'' marker and an ''amount''. Suggestion: ''<nowiki><span class="price"><abbr class="currency" title="Canadian dollars">$</abbr><span class="amount">10.99</span></span></nowiki>''. For a range, ''<nowiki><span class="pricerange"><span class="price"> ... </span> to <span class="price"> ... </span></span></nowiki>''.

hcard

2006-04-03T20:02:20Z

Evan: parantheses -> parentheses

<h1>hCard</h1>

hCard is a simple, open, distributed contact information format for people, companies, and organizations, which is suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. hCard is a 1:1 representation of the vCard standard ([http://www.ietf.org/rfc/rfc2426.txt RFC2426]) in XHTML, one of several open [[microformats|microformat]] standards.

Want to get started with writing an [[hcard|hCard]]? Use the [http://microformats.org/code/hcard/creator hCard creator] to write up some contact information and publish it.

__TOC__

== Draft Specification ==

=== Editor ===
[http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]

=== Authors ===
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc]
* [http://suda.co.uk/ Brian Suda]

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to: my good friend [http://vadim.com/ 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.

== Introduction ==
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt 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 is a 1:1 representation of the aforementioned vCard standard, in semantic XHTML. Bloggers can both embed vCards directly in their web pages, and style them with CSS to make them appear as desired. In addition, hCard enables applications to retrieve information about such vCards directly from web pages without having to reference a separate file.

Use the [http://microformats.org/code/hcard/creator hCard creator], copy the HTML code it generates to your blog or website to publish your contact info.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
=== In General ===
The vCard standard ([http://www.ietf.org/rfc/rfc2426.txt 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 XHTML elements.

=== More Semantic Equivalents ===
However, for some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:
* <code>URL</code> in vCard becomes <code><a class="url" href="...">...</a></code> inside the element with <code>class="vcard"</code> in hCard.
* 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>

=== Singular vs. Multivalued Properties ===

For properties which are singular (e.g. "N" and "FN"), the first descendant element with that class should take effect, any others being ignored.

For properties which can be plural (e.g. "TEL"), each class instance should create a instance of that property.

==== 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.

=== Human vs. Machine readable ===

If an <code><abbr></code> element is used for a property, then the '<code>title</code>' attribute of the <code><abbr></code> element is the value of the property, instead of the contents of the element, which instead provide a human presentable version of the value.

Similarly, if an <code><img></code> element is used for one or more properties, it must be treated as follows:
# For the "PHOTO" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value.
# For other properties, the <code><img></code> element's '<code>alt</code>' attribute is the value of the property.

=== Value excerpting ===

Sometimes only part of an element which is the equivalent for a property should be 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 "<code>value</code>" is introduced 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:

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

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.

# '''NAME''', '''PROFILE''', '''SOURCE''', '''PRODID''', '''VERSION''' properties as defined in Sections 2.1.2, 2.1.3, 2.1.4, 3.6.3, 3.6.9 of RFC 2426. 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 <code><title></code> element in (X)HTML documents) to construct the NAME property, MAY output a PROFILE value of "<code>VCARD</code>" per RFC 2426, 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 or organization and should be treated as such. In this case the author MUST also 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 (RFC 2426) 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, [http://microformats.org/wiki/hcard#Organization_Contact_Info see above] for that.

# The content of "FN" is broken into two "words" separated by whitespace.
# The ''first'' word of the "FN" is interpreted as the "given-name" for the "N" property.
# The ''second/last'' word of the "FN" is interpreted as the "family-name" for the "N" property.
# 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 on the Web in actual content published on the Web (e.g. authors of [[hReview|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:

# The content of the "FN" is treated as a "nickname" property value.
# Parsers should handle the missing "N" property by implying empty values for all the "N" sub-properties.

Note: 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".

=== Root Class Name ===

The root class name for an hCard is "vcard".

=== Property List ===

This is the list of properties (and subproperties, in parentheses, like this) in hCard, taken from vCard:

* fn, n (family-name, given-name, additional-name, honorific-prefix, honorific-suffix), nickname, sort-string
* url, email (type, value), tel (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
==== 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:
<pre><nowiki>
<span class="tel"><span class="type">Home</span> (<span class="type">pref</span>erred):
<span class="value">+1.415.555.1212</span>
</span>
</nowiki></pre>

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 [http://gmpg.org/xmdp XMDP] profile of hCard which contains the above complete list of properties, with references to their RFC 2426 definitions.

=== Parsing Details ===

See [[hcard-parsing|hCard parsing]].

== Examples ==

This section is informative.

=== Sample vCard ===

Here is a sample vCard:

<pre><nowiki>
BEGIN:VCARD
VERSION:3.0
N:Çelik;Tantek
FN:Tantek Çelik
URL:http://tantek.com
ORG:Technorati
END:VCARD
</nowiki></pre>

and an equivalent in hCard with various elements optimized appropriately. See [[hcard-example1-steps| hCard Example 1]] for the derivation.

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

This hCard might be displayed as:

[http://tantek.com/ Tantek Çelik]<br />
Technorati

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.

=== More Examples ===

See [[hcard-examples]] for more examples, including all examples from vCard RFC 2426 converted into hCard.

== Examples in the wild ==
This section is '''informative'''.

The following sites have published hCards, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you have an hCard on your own page, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

=== New Examples ===
Please add new examples to this section.

* [http://www.hicksdesign.co.uk/ Hicksdesign] uses hCard for contact information.
* http://www.gr0w.com/articles/press/growsearch_launched_press_release/ - hCard in a press release for the press contact info
* http://www.redmonk.com/cote/archives/2006/03/testing_out_mic.html - hCard with explanation
* [http://andy.ciordia.info/ it's my island], personal blog, hcard on the ''[http://andy.ciordia.info/pages/about_me About the Writer]'' page. [[User:Ciordia9|Andy Ciordia]]
* [http://www.windowonwoking.org.uk/ Window on Woking], a local community site in the UK, uses hCard in the homepage of each member organisation and local Councillor.
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site -- by [[User:ChrisCasciano|Chris Casciano]]
* [http://www.30boxes.com/ 30 Boxes],a social calendar application and digital lifestyle aggregator, automatically creates an hcard for you with your account. It is found under Settings > Syndication.
* [http://www.nearwhere.com/ Nearwhere.com] allow you to put an hcard on an interactive map.
* [http://www.brentozar.com/ Brent Ozar] added a [http://www.brentozar.com/contact.php contact] page hCard.
* [http://www.kerihenare.com/ Keri Henare] has rewritten his [http://www.kerihenare.com/contact/ contact] page hCard.
* [http://michaelraichelson.com/contact/ Michael Raichelson] had an hCard on his contact page before SXSW, but never thought to add it here until Tantek requested it.
* [http://www.commoner.com/~lsimon/lindsey_simon_hcard.html Lindsey Simon] has added an hCard to his website as per Tantek's SXSW request for folks to try it
* [http://www.davidgagne.net/ David Gagne] has an hCard in his sidebar.
* [http://www.churchzip.com/map/ Churchzip.com/map] and [http://www.skiwhere.com/map/ Skiwhere.com/map], provide churches, hotels, and ski resorts on the same maps. Locations are formatted as hcards.
* All [http://www.iqdir.com/ IQ Directory Solutions] Yellow Pages web portals use [[hcard|hCard]] markup on listings. For example [http://www.yellowpages-cambodia.com/ Cambodia Yellow Pages] and [http://www.superpages.com.my/ Malaysia Super Pages]
* Ning's cloneable Group app uses fuzzy matching to map custom fields to [[hcard|hCard]] markup on its [http://group.ning.com/index.php?controller=person&action=view&content=JonathanAquino profile] pages.
* [http://claimid.com/factoryjoe Chris Messina' ClaimID hCard]
* [http://factoryjoe.com/blog/hcard Chris Messina' hCard]
* [http://flock.com/about Flock About]
* [http://tantek.com/microformats/2006/03-01-TechPlenAgenda.html Agenda: W3C Technical Plenary Day, March 1 2006] has [[hcard|hCard]] and [[hcalendar|hCalendar]] markup. ([http://www.w3.org/2006/03/01-TechPlenAgenda.html original here]).
* [http://www.gr0w.com/articles/press/growsearch_launched_press_release/ GrowSearch Launched (Press Release)] uses an hCard to provide Press Contact Point.
* The [http://www.arborday.org/ National Arbor Day Foundation] has started using hCards for their [http://arborday.org/programs/conferences/communityforestry/index.cfm upcoming] [http://arborday.org/programs/conferences/hazardtrees-treeplanting/ conferences].
* [http://www.multipack.co.uk The Multipack] has numerous hCards, especially on the [http://www.multipack.co.uk/members/ members page], as well as the next meeting information.
* [http://deadringrancor.livejournal.com/ Justin McDowell] used an hCard when [http://deadringrancor.livejournal.com/221332.html referring to a person in his blog post]
* [http://davecardwell.co.uk/cv/ Dave Cardwell] has included his hCard in his Curriculum Vitae.
* [http://blog.usweb.com/ Shaun Shull] has written a great post on [http://blog.usweb.com/archives/how-microformats-affect-search-engine-optimization-seo How Microformats Affect SEO], and has included his [[hcard|hCard]] as one of the examples.
* [http://www.thefutureoftheweb.com/ Jesse Skinner] has written a simple [http://www.thefutureoftheweb.com/blog/2006/1/hcard tutorial with examples]
* [http://www.w3.org/2005/12/allgroupoverview.html 2006 W3C Technical Plenary Week] has marked up the venue, contacts, and program committee members all with hCard.
* [http://www.avf-nexus.co.uk AVF-Nexus] have a hCard on their [http://www.avf-nexus.co.uk/contact/ contact page] - (by [http://creation.uk.com Creation"])
* [http://www.thefantasticos.com/andrew/ Andrew White] posted [http://www.thefantasticos.com/andrew/index.php/my-hcard/ his hCard] and [http://www.thefantasticos.com/andrew/index.php/62/microformats-the-should-have-been-obvious-web-dev-tool/ blogged about it].
* [http://www.2sheds.ru Oleg "2sheds" Kourapov] in his [http://www.2sheds.ru/blog/ blog] ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog X2V]) has turned personal profile into hCard ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog/hcard.html X2V]) and his blogroll - into combination XFN/hCards ([http://suda.co.uk/projects/X2V/get-vcard.php?uri=http://www.2sheds.ru/blog/friends.html X2V])
* [http://www.approveddesign.co.uk Approved Design Consultancy] have a hCard on their [http://www.approveddesign.co.uk/about/contact/ contact page] as well as on their [http://www.approveddesign.co.uk/about/people/ people section] - (by [http://creation.uk.com Creation"])
* [http://weblog.200ok.com.au/ Ben Buchanan] and [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=colin+morris&format=search Colin Morris] have [http://weblog.200ok.com.au/2006/01/griffith-phonebook-adds-hcard-and.html implemented hCards and vCards] for the [http://www.griffith.edu.au Griffith University] [http://www.griffith.edu.au/find/content_phonebook.html online phone book]. Eg. [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=ben+buchanan&format=search Ben's vCard] and [http://www.griffith.edu.au/cgi-bin/phone_search.pl?string=colin+morris&format=search Colin's vCard]
* WWF-Australia [http://wwf.org.au/about/contactdetails/ contact details page]
* [http://rasterweb.net/raster/ Pete Prodoehl] used the hCard format on his [http://rasterweb.net/raster/contact.html Contact page]
* [http://alexander-mette.de amette] uses the hCard format in a module of his TikiWiki powered blog
* [http://staff.washington.edu/oren/weblog2/ Oren Sreebny] has an hcard on his blog main index template
* [http://www.cs.brandeis.edu/~zippy/ Patrick Tufts] has an hCard on his homepage.
* [http://ascii20.blogspot.com/ Mathias Kolehmainen and Jamie Taylor] have hCards on their weblog.
* [http://www.hoppsan.org/jamesb/blogger/ Barnaby James] has a hCard on his weblog.
* [http://esa-education.com/schools/map ESA Education] Uses hCards for their 100+ schools and each of the individual school sites.
* [http://www.thereisnocat.com/#vcard Ralph Brandi] has added an hCard to the sidebar of his weblog as a result of Tantek Çelik's portion of the Microformats presentation at SXSW 2006.
* [http://www.yellowpencil.com/contact/ Yellow Pencil] Using microformats to present company contact information
* [http://www.pierce.ctc.edu/ephone/ Pierce College] -- community college directory uses hCard on all individual directory entries.

=== Examples ===
* [http://thoughtport.blogspot.com/ Aiden Kenny] hasn't published his hCard yet, but he has [http://thoughtport.blogspot.com/2005/07/elemental-particles-of-web.html published his hCard icon]: http://photos1.blogger.com/blogger/4224/444/320/AK-Hcard-icon.gif
* [http://thedredge.org Andy Hume] uses the hcard format to mark-up the names and URLs of commentors on his blog.
* [http://www.bidclix.com/ BidClix]'s [http://www.bidclix.com/AboutContact.html Contact BidClix] page has it's ''contact info'' marked up with an hCard.
* [http://suda.co.uk/ Brian Suda] has managed to embed a photo in [http://suda.co.uk/contact/ his hCard] through the [http://www.ietf.org/rfc/rfc2397.txt data uri scheme] by converting the image to BASE64 code. View the Source to see how this is accomplished. [http://suda.co.uk/projects/X2V/get-vcard.php?uri=http%3A//suda.co.uk/contact/ The X2V link] will extract the image and encode it for a vCard which will be displayed in some address book applications.
* [http://cinematreasures.org Cinema Treasures] uses hCard to markup venue information for 10,000+ movie theaters.
* [http://www.w3.org/People/Connolly/events/ Dan Connolly's index of events and talks] has hCards for many of the people he has met at those events. In Mar 2006, he moved a bunch of hotel contact info from his PDA to this page; it's now up to 32 hCards.
* [http://doncrowley.blogspot.com/ Don Crowley] has published [http://www.crowley.nl/hcard.html his hCard] as well as a nifty hCard button: http://www.crowley.nl/images/hcard.png
* [http://loadaveragezero.com/hnav/contact.php Douglas W. Clifton] added all types of contact information
* [http://eventful.com Eventful] publishes all of its venue information pages with embedded hCards.
* [http://www.iowamilitaryveteransband.com/members/ Iowa Military Veterans Band Contacts] - 95 hCards [http://weblog.randomchaos.com/archive/2005/10/24/Microformats/ marked up by Scott Reynen]
* [http://JackWolfgang.blogspot.com Jack L. Wolfgang II] has [http://jack.randomata.com/resume/ converted the addresses in his resume to hCards].
* [http://www.efas.fupl.asso.fr/efas/_Mathieu-Drouet_.html Mathieu Drouet] and [http://www.efas.fupl.asso.fr/efas/_Annie-Leger_.html Annie Leger] both have hCards
* [http://www.ndunn.com Neil Dunn] has published his rather [http://www.ndunn.com/2005/10/7/hCard good looking hCard]
* [http://www.oliverbrown.me.uk/ Oliver Brown] has published his hCard.
* [http://www.paradigmproductions.org/contact/ Paradigm Productions] published a vcard as a ul (marked up by [http://www.linkingarts.com/ Peter Jacobson])
* [http://www.splintered.co.uk/ Patrick H. Lauke] has marked up [http://www.splintered.co.uk/about/ his contact info with hCard].
* [http://blah Paul Schreiber has published his hCard on [http://paulschreiber.com/about/?contact his about page].
* [http://paulschreiber.com/blog/ Paul Schreiber]'s [http://concerts.shrub.ca/ Sunnyvale House Concerts] site publishes hCards for upcoming artists, as well as an hCard for the page itself. In addition the [http://concerts.shrub.ca/shows Past Shows] page contains hCards for all past artists.
* [http://www.paulmichaelsmith.com/blog/hcard.htm Paul Smith] has created an hCard page which is Human Readable, and a link to X2V passing the same hCard page to generate a vCard.
* [http://www.windley.com/archives/2005/07/hcards_trying_o.shtml Phil Windley has published] [http://phil.windley.org/hcard.html his hCard].
* [http://www.go-curiosity.com/about.htm Piercarlo Slavazza] has published an hCard.
* [http://zooibaai.nl/ Rob Mientjes] has published his hCard on [http://zooibaai.nl/about/ his about page].
* [http://rbach.priv.at/Contact Robert Bachmann] has published his hCard and [http://rbach.priv.at/Images/hcard a button].
* [http://blah Scott Reynen has published his hCard on [http://www.randomchaos.com/document.php?source=scott_reynen his profile page].
* [http://www.stackframe.com/ StackFrame, LLC] has published [http://www.stackframe.com/people/ employee] and [http://www.stackframe.com/contact/ general] contact information as hCards.
* [http://www.wolfsreign.com Steven Ametjan] has published his hCard on [http://www.wolfsreign.com/about/ his about page].
* [http://tantek.com/microformats/2005/syndicate/speakers-list.html Syndicate - Speaker List] as a set of hCards
* [http://tagcamp.org/index.cgi?ContactList TagCamp contact list]
* [http://tantek.com/log Tantek's Thoughts] includes an inline author hCard at the bottom of the page.
* [http://technorati.com/ Technorati]'s [http://www.technorati.com/about/ About page] lists their '''Media Contact'''
* [http://www.deadringerart.com/ The Brothers McDowell] have hCards at their Contact page.
* [http://twinsparc.com/ Twinsparc] put an hCard in the header and footer of all their pages.
* [http://tantek.com/microformats/2005/web2/speakers.html Web 2.0 Conference speakers page marked up with hCard]
* [http://we05.com/ Web Essentials 05] marked up all their [http://we05.com/presenters.cfm presenters with hCard].

=== Examples with some problems ===
* [http://gbraad.nl/ Gerard Braad] has published an example on his [http://gbraad.nl/site/?p=profile profile] page that is almost consistent with his original [http://gbraad.nl/files/gbraad.vcf vCard] file. Also progress is made for transforming his [http://files.gbraad.nl/foaf.rdf FoaF] file to a hCard encoded representation. (also done for my spouse:[http://spouse.gbraad.nl/site/?p=profile Yong Yuan])
** (2005-09-27) PASSED, PASSED
** WARNINGS
*** uses 'n given-name' and 'n family-name' instead of nesting the given- and family- names inside the 'n'
*** has one 'tel' value with a bunch of values stuffed in
*** probably more problems --[[User:RyanKing|RyanKing]] 17:19, 5 Jan 2006 (PST)
* [http://kinrowan.net/ Cori Schlegel] [http://kinrowan.net/blog/wp/archives/2005/07/08/a-problem-with-the-structured-blogging-plug-in-for-wordpress/ discusses how he has updated] [http://kinrowan.net/blog/contact his contact page with hCard]
** INVALID - using 'prefix' instead of 'honorific-prefix' and type's in classnames (in both adr and tel) and has two photo's (the second could be 'logo') --[[User:RyanKing|RyanKing]] 15:15, 5 Jan 2006 (PST)
* The good ship [http://styrheim.com/test/leonid.html Leonid Miloslavskiy] spotted in the North Atlantic
** INVALID --[[User:RyanKing|RyanKing]] 00:50, 27 Oct 2005 (PDT)
*** class="family" should probably be family-name
*** the "n" property is missing and the "n" optimization can't be applied
*** the first geo propery is empty, the second one is invalid (ie, it doesn't contain lat/long)
* [http://landsbank.fo/#hCard Landsbanki Føroya]
** INVALID - using embedded rdf/xml invalidly
* [http://chrischerry.name/blog/contact/ Chris Cherry's contact page with his hCard]
** WARNING - uses class="cell" instead of <span class="type">cell</span>
* [http://www.bath.ac.uk/contact/ University of Bath] Person Finder results are encoded with hCards so you can easily create a vCard from any result.
** ERROR - attempt to use Implied-N optimization where that's not possible. --[[User:RyanKing|RyanKing]] 14:29, 5 Jan 2006 (PST)
** Error appears for external users only. Won't be fixed any time soon. -- [[User:PhilWilson|PhilWilson]] 00:03, 28 Jan 2006 (GMT)
* [http://richi.co.uk/blog/2005/12/structured-blogging.html Richi Jennings] has put up his attempt
** INVALID, missing FN --[[User:RyanKing|RyanKing]] 12:47, 5 Jan 2006 (PST)
* [http://www.shiftingpixel.com/about/ shifting pixel photoblog] has published an hCard.
** "organization_name" should be "organization-name" (s/_/-/), otherwise good --[[User:RyanKing|RyanKing]] 14:01, 5 Jan 2006 (PST)

== Implementations ==
This section is '''informative'''.

The following implementations have been developed which either generate or parse hCards. If you have an hCard implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.
* [http://scooch.gr0w.com/ Scooch] is a slide show and presentation creator that generates a [[hCard]] for individual slide show authors and comment authors with a CSS button to parse and download via [http://suda.co.uk/projects/X2V/ X2V]. Also uses [[hReview]] for slide ratings and [[rel-tag]] for categories.
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar
*[http://opensource.reevoo.com/2006/03/08/release-uformats-12/ uformats] is a ruby library that can parse [[hCalendar]], [[hCard]], [[hReview]] and [[rel-tag]]
* [http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence and details of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.
* [http://www.stripytshirt.co.uk/features/firefox/smartzilla Smartzilla is a Firefox Extension] that finds hCards on web pages and lets you add them to your addressbook.
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding hCard and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* There is [http://flickr.com/photos/factoryjoe/68755089/ evidence of built-in hCard support in the Konqueror browser]. Specifically, Konqueror 3.5, in KDE 3.5 (kubuntu Breezy w/ update).
* There is [http://tagcamp.org/index.cgi?ContactList evidence of a kwiki plugin for hCards]. Update: the [http://svn.kwiki.org/cwest/Kwiki-hCard/ hCard kwiki plugin svn repository]. See the [http://microwiki.caseywest.com/index.cgi?hCard documentation of the hCard kwiki plugin].
* [http://suda.co.uk/projects/X2V/ X2V] is a bookmarklet that parses hCard and produces a .vcf (vCard) stream. Note: needs to be updated as the spec is refined
* [http://www.stripytshirt.co.uk Duncan Walker] has built [http://www.stripytshirt.co.uk/features/firefox/smartzilla a Firefox extension] that gets hCard data from a webpage, uses Brian Suda's XSL (locally) to transform it to vcard format and opens the resulting .vcf file.
* [http://george.hotelling.net/90percent/ George] has written a [http://george.hotelling.net/90percent/geekery/greasemonkey_and_microformats.php Greasemonkey user script] that detects hCards and allows users to easily add them to their address book application. Relies on the X2V web service to do the conversion.
* [http://blogmatrix.blogmatrix.com/ David Janes] has written a [[Greasemonkey]] [http://www.blogmatrix.com/include/microformat-find.user.js script] that finds many microformat elements, including hCards, and [http://blog.davidjanes.com/mtarchives/2005_08.html#003376 provides a popup menu of actions]. The hCard to vCard conversion is done internally within the script. ''This does not work with FireFox 1.5+/GreaseMonkey 0.6.4+.''
* [http://diveintomark.org/ Mark Pilgrim] has also written an [http://diveintomark.org/projects/greasemonkey/hcard/ hCard parser Greasemonkey user script]. It is self-contained and does not rely on the X2V web service.
* [http://www.oliverbrown.me.uk/2005/09/03/a-working-microformats-extension-to-simplexml/ Oliver Brown] has written an "extension" to [http://www.php.net/simplexml SimpleXML] that gives simple access to hCard information in PHP 5.
* [http://thedredge.org/ Andrew D. Hume] has built a system (Wordpress plugin?) for [http://thedredge.org/2005/06/using-hcards-in-your-blog/ using hcards in your blog] to represent people leaving comments on blog posts.
* The [http://tantek.com/microformats/hcard-creator.html hCard creator] is a very simple, yet illustrative, open source user interface / form / script which creates an hCard in real-time as you type in a set of contact information.
* [http://greenbytes.de/tech/webdav/rfc2629.xslt rfc2629.xslt] now attempts to generate hCard information ([http://ietf.org/rfc/rfc2629 RFC2629] is an XML format for authoring RFCs and Internet Drafts, see [http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html example document])
* [http://tantek.com/microformats/buddylist2hcards.html iChat buddy list to hCards] - Open source AppleScript to automatically convert one's buddy list in the MacOSX iChat AIM client into a valid XHTML 1.0 Strict list of hCards.
* [http://dev.w3.org/cvsweb/2001/palmagent/ palmagent] is a collection of palmpilot and sidekick tools. It includes X2V derivatives xhtml2hcard.xsl and toICal.xsl plus some [http://dev.w3.org/cvsweb/2001/palmagent/hcardTest.html hcardTest] materials
* [http://www.openpsa.org/ OpenPsa 2.x] CRM application uses hCard for all person listings. The widget is [http://www.midgard-project.org/midcom-permalink-922834501b71daad856f35ec593c7a6d reusable across Midgard CMS]
* [http://www.metonymie.com Emiliano Martínez Luque] has written an experimental [http://www.metonymie.com/hCard_extract/app.html hCard finder and structured search application] that finds hCards within a given set of URLs and returns the ones that match the specified search criteria.
* [http://randomchaos.com/microformats/base/ Microformat Base] is an open-source PHP microformat aggregation crawler, currently recognizing hreview, hcalendar, and hcard.

== Additional Applications ==
This section is '''informative'''.

There are numerous potential additional uses and applications for hCards on the Web. The following are merely a few thoughts and possibilities that folks have come up with:

* As an open standard/format for [http://www.gravatar.com/ Gravatars].
* Marking up individual authors of blog posts on a group blog
* Marking up people's names and URLs in a blogroll
* Any reference to people in blog posts (e.g. when citing them, or referencing them, or describing them, by name).
* ...

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://www.ietf.org/rfc/rfc2426.txt vCard RFC2426]

=== Informative References ===
* [http://www.w3.org/2002/12/cal/rfc2426 HTML reformatted version of RFC2426]
* [http://w3.org/TR/REC-CSS1 CSS1]
* [http://tantek.com/log/2004/09.html#hcard hCard term introduced and defined on the Web, 20040930]
* [http://wiki.oreillynet.com/foocamp04/index.cgi?SimpleSemanticFormats FOO Camp 2004 Simple Semantic Formats presentation, 20040910]
* Contributed from http://developers.technorati.com/wiki/hCard.
* [http://www.w3.org/TR/xhtml11 XHTML 1.1]

==== Specifications That Use hCard ====
* [[adr]]
* [[geo]]
* [[hcalendar|hCalendar]]
* [[hreview|hReview]]

==== Similar Work ====
* [http://www.intertwingly.net/wiki/pie/PaceBetterPersonElement Atom PaceBetterPersonElement]
* [http://www.jabber.org/jeps/jep-0054.html JEP-0054: vcard-temp]

== Related Pages ==
* [[hcard-faq|hCard FAQ]] - If you have any questions about hCard, check here, and if you don't find answers, add your questions!
* [[hcard-parsing|hCard parsing]] - Normatively details of how to parse hCards.
* [[hcard-issues|hCard issues]] - Please add any issues with the specification to the issues page.
* [[hcard-profile|hCard profile]] - The XMDP profile for hCard

This 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|hCard Brainstorming]] - where we are keeping our brainstorms and other explorations relating to hCard
* [[hcard-tests|hCard tests]] - a wiki page with actual embedded hCards to try parsing.

== Further Reading ==
* [http://www.digital-web.com/articles/microformats_primer/ Digital Web Magazine: Microformats Primer] by Garrett Dimon has a good intro to hCard
* [http://24ways.org/advent/practical-microformats-with-hcard Practical Microformats with hCard] by Drew McLellan
* [http://thedredge.org/ Andrew D. Hume] has written a blog post on [http://usabletype.com/articles/2005/usable-microformats/ usable microformats] which discusses hCard
* [http://www.thefutureoftheweb.com/blog/2006/1/hcard Jesse Skinner's introduction to hCard]
* [http://blog.usweb.com/ Shaun Shull's] great post on [http://blog.usweb.com/archives/how-microformats-affect-search-engine-optimization-seo How Microformats Affect SEO], including his [[hcard|hCard]] as an example.
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page] and the [http://technorati.com/tags/hcard hCard tag]