Microformats Wiki - User contributions [en]

hatom-examples-in-wild

2008-02-15T23:41:15Z

GuyLeech: /* 0.1 hAtom examples */ Corected hyperlink for personal site.

=hAtom Examples in the Wild=

The following sites have implemented [[hatom|hAtom]], and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If your site marked up with hAtom, feel free to add it o the '''top''' of this list. Please check back after a few days, to see if anyone has found any problems with the examples supplied.

== 0.1 hAtom examples==

* [http://blog.livedoor.jp/forestk/ forestk's blog] uses hAtom (note it is Japanese!)
* [http://www.niallkennedy.com/blog/ Niall Kennedy's Weblog] features hAtom on every page. includes comments.
* [http://weborganics.co.uk/ WebOrganics] - Has hAtom feeds on every page.
* [http://journal.redflavor.com/ Reprise] - A [http://redflavor.com/reprise.rb minimal blog] application which uses hAtom out of the box.
* [http://www.bbc.co.uk/worldservice/bangladeshboat BBC World Service Bangladesh River Journey] a social network mashup, with hAtom entries & other microformats. See [http://dharmafly.com/blog/bangladeshboat Dharmafly blog discussion].
* [http://www.people.com/people/news/ People Magazine] uses hAtom to markup the latest news stories.
* [http://www.bo.ingv.it/italiano/News.html Istituto Nazionale Geofisica e Vulcanologia, Bologna] implemented hAtom entries with embedded rel-tags for categories in its news-page (custom template for [http://www.modxcms.com MODx CMS]).
* [http://v1.itvp.pl/blog/przebojowanoc/i.tvp/idb/24/ ITVP] uses hAtom for entries. See [http://twitter.com/Wojtek/statuses/299700082 Wojtek's announcement 2007-09-28].
* [http://shiftingpixel.com Shifting Pixel] uses hAtom for blog posts and comments.
* [http://lazylibrary.com LazyLibrary] uses hAtom on book results pages.
* [http://findsubstance.com Find Substance Blog] uses hAtom for blog posts.
* [http://www.blogger.com Blogger]
** [http://groups.google.com/group/bloggerDev/browse_thread/thread/69344c5cc35b472e Announcement] on Blogger Dev that all new blogs will have hAtom classes
* AOL
**[http://news.aol.com AOL News], AOL News has implemented hAtom into their center column. This display will be used on other AOL channels as well
**[http://sports.aol.com AOL Sports], AOL Sports is the second AOL channel to use the hAtom display for its center column data
* [http://www.creation.uk.com Creation design & marketing] uses hAtom for a lot of the content as well as [http://www.creation.uk.com/news/2007/06/06/easy-money/ comments on articles].
* [http://www.sndbx.org/ The Sandbox Designs Competition] uses hAtom for all content, hCard for participant (the competition designers) and sponsor information, hCalendar for the competition schedule, XFN for links, and rel-license for licensing information. It's all GNU GPL.
* [http://guyleech.net guyleech.net] uses hAtom for blog posts, and uses hCard for contact information. There is also an [http://guyleech.net/technical/css/bnb-navigation article] on how to minimise hAtom, to save time and code.
* [http://kpumuk.info/ Dmytro Shteflyuk] uses hAtom for all blog posts.
* [http://blog.no-panic.at Florian Beer] uses hAtom to mark up all the blog posts. There is also a [http://blog.no-panic.at/2006/11/16/hatom-and-wordpress/ tutorial] on how to convert Wordpress themes to include hAtom.
* [http://ficlets.com/ Ficlets] uses hAtom on the [http://ficlets.com/stories main stories page] and on [http://ficlets.com/stories/12 individual story pages].
* [http://www.international.unt.edu UNT International] uses hAtom combined with hCard on news/announcement pages (e.g., [http://www.international.unt.edu/quick/news the main news page]) in addition to providing traditional Atom feeds
* [http://www.absalom.net.au Absalom Media] uses hAtom combined with hCard for articles.
* [http://www.joomlamug.com Joomla! Melbourne User Group] uses hAtom combined with hCard for articles.
* [http://www.volume.co.uk Volume] - Main news page is marked up as hAtom 0.1
* [http://yedda.com Yedda] - Yedda support hAtom on exploration of questions where there is also support for Atom and RSS feeds. ([http://yedda.com/questions/recent/ example])
* The [http://www.westmidlandbirdclub.com/ West Midland Bird Club's] frequently-updated [http://www.westmidlandbirdclub.com/new.htm What's New] page, [http://www.westmidlandbirdclub.com/ladywalk/latest.htm news from its Ladywalk Reserve] and [http://www.westmidlandbirdclub.com/worcs/grimley/latest.htm news from Grimley Pits] — comments welcome on my talk page [[User:AndyMabbett|Andy Mabbett]]
* [http://pixelsebi.com pixelsebi's repository] uses hAtom 0.1 for blog posts (and hCard, hCalendar, XFN, xFolk and many more) based on manual WordPress template modifications
* [http://www.geekinthepark.co.uk Geek in the Park] uses hAtom for the comments. -- by [[User:Trovster|trovster]]
* [http://www.csarven.ca Sarven Capadisli] uses hAtom for the articles and comments -- by [[User:Csarven|csarven]]
* [http://www.fberriman.com fberriman.com] uses hAtom 0.1 for blog posts (WordPress loop) and hCard throughout — by [[User:Phae|Frances Berriman]] (Also - [http://www.fberriman.com/?p=86 Implementing hAtom: The Entries Code])
* [http://www.capital.edu Capital University] uses hAtom 0.1 to mark up the feed of latest posts by student bloggers on its home page.
* [http://blog.davidjanes.com Ranting and Roaring] (David Janes)
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site — by [[User:ChrisCasciano|Chris Casciano]]
* [http://sedna.spip.org/sedna/ Sedna RSS] (a feed aggregator based on SPIP, by Fil, IZO and others; GPLd sources are available at [http://zone.spip.org/trac/spip-zone/browser/_squelettes_/sedna SPIP-Zone])
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Sound Advice] (Benjamin Carlyle)
* [http://quotedprintable.com/pages/scribbish Scribbish] is a Typo theme which uses hAtom.
* [http://rbach.priv.at/hAtom2Atom/Changelog/ hAtom2Atom.xsl's Changelog] is published as hAtom and Atom.
* [http://federali.st/ federali.st]'s webbed Federalist Papers are each marked up in hAtom.
* [http://www.plaintxt.org/themes/sandbox/ Sandbox] is a theme for [http://wordpress.org/ WordPress] that uses hAtom.
** The theme is also available to accounts on the [http://wordpress.com/ <username>.wordpress.com] hosting service. The [http://blog.coworking.info Coworking] and [http://barcamp.wordpress.com BarCamp] blogs are examples of custom Sandbox themes.
** Over 40 designs available for the Sandbox at the [http://www.sndbx.org/ Sandbox Designs Competition], which also uses hAtom
* [http://www.whump.com/dropbox/Strangelove.zip Strangelove] is a modification of the default WordPress theme (Kubrick) with hAtom support.
** It points to the hAtom2Atom proxy service as the link for syndication feeds.
* All [http://www.plaintxt.org/themes/ plaintxt.org themes] for [http://wordpress.org/ WordPress] now use hAtom. The themes are also coded for hCard compliance. The themes, by name, are:
** [http://www.plaintxt.org/themes/barthelme/ Barthelme] (two-column, fluid), [http://www.plaintxt.org/themes/blogtxt/ blog.txt] (two- or three-column, elastic), [http://www.plaintxt.org/themes/plaintxtblog/ plaintxtBlog] (three-column, fluid), [http://www.plaintxt.org/themes/simplr/ Simplr] (one column, elastic), [http://www.plaintxt.org/themes/veryplaintxt/ veryplaintxt] (two column, fluid)
* [http://archgfx.net/blog/index.php/themes/disconnected/ Disconnected], a theme for WordPress, also incorporated hAtom with version 1.2
* [http://www.pats.ua.ac.be/courses PATS Courses], the PATS Research Group uses hAtom to mark up the latest course documents for some of their courses
* [http://mix.excite.co.uk Excite MIX], the Ajax Start Page from Excite Europe, uses hAtom 0.1 and hCard in the Feed Viewer to mark up feed entries and authors.
* [http://last.fm Last.FM], a social music sharing platform, uses hAtom markup for [http://blog.last.fm/2007/05/30/rss-your-shoutbox-and-you shoutbox], and recommends using [http://tools.microformatic.com microformatic]'s transcode tool
* [http://vlograzor.com/ Vlog Razor] - Contains multiple hAtom feeds on the same page.


==Examples with some problems==

Entries may be moved here if there's a problem with the way hAtom is used on the page concerned. If the page is yours, and you want to improve it, see the [[hatom-faq|hAtom FAQ]], or raise any queries on [[hatom-issues|hAtom Issues]] or [[mailing-lists#microformats-discuss|the mailing list]], where people will be happy to help you.

=== Pre 0.1 hAtom examples===
These pages conform to an older draft standard and need to be updated.

* [http://www.myelin.co.nz/post/ Second p0st] (Phil Pearson)

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

hcard-brainstorming

2008-02-13T23:53:50Z

GuyLeech: /* Encoding "modern" attributes */

<h1> hCard Brainstorming </h1>
{{TOC-right}}
This page is for brainstorming about various uses and details of [[hcard|hCard]]. This page contains <em>proposals</em>. For the current state please see [[hcard|hCard]].

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

== Contributors ==
* [[User:Atamido|Atamido]]
* [[User:ChrisMessina|ChrisMessina]]
* [[User:DimitriGlazkov|DimitriGlazkov]]
* [[User:AndyMabbett|Andy Mabbett]]
* ...
* ... and many others

== Problems Being Solved ==

Some of the problems that [[hcard|hCard]] helps to solve:

* having to enter business cards that go out of date (subscribe to someone's syndicated [[hcard|hCard]] instead).
* annoying "update your contact info" email from various centralized contact info services
* [[social-network-portability]] through the use of [[hcard-supporting-user-profiles|hCard supporting user profiles]] and [[hcard-xfn-supporting-friends-lists|hCard+XFN supporting friends lists]]

== Named locations ==
Most hCards contain contact information for people or organizations. But locations that aren't organizations are also deserving of their own hCard (e.g. somebody's house/apartment). This situation can be represented by combining "fn" and "extended-address".

=== "fn" and "extended-address" combination ===

'''Proposal''': Similar to [[hcard#Organization_Contact_Info|organization contact info]], if the "fn" property and an "extended-address" property have the exact same value (typically because they are set on the same element, e.g. <code>class="fn extended-address"</code>), then

# The hCard represents contact information for a place and SHOULD be treated as such.
# The author also MUST NOT set the "N" property, or set it (and any sub-properties) explicitly to the empty string "".
# Parsers SHOULD handle the missing "n" property by implying empty values for all the "n" sub-properties.

'''Further proposal''': Consider also an hCard for a City, "Birmingham, England": Birmingham may be the "fn" and the "locality", but it's not an "extended-address". Perhaps the rule should be that the hCard is for a place if the "fn" is on any address component (e.g "fn locality" or "fn street-address")?

=== Examples in the wild ===

* The named location "Picnic benches" in the address "Picnic benches, South Park, San Francisco, California" in [http://adactio.com/journal/1364/ a blog post on adactio.com].
<pre><nowiki>
<span class="vcard">
<span class="adr">
<span class="fn extended-address">Picnic benches</span>
<span class="street-address">South Park</span>
<span class="locality">San Francisco</span>
<span class="region">California</span>
</span>
</span>
</nowiki></pre>

==== Potential examples in the wild ====

* The location "Phone Boxes by the Sealife Centre" [http://upcoming.yahoo.com/venue/5668/ on Upcoming] is currently marked up as "fn org":
<pre><nowiki>
<div class="vcard">
<div class="fn org">Phone Boxes by the Sealife Centre</div>
<div class="adr">
<span class="street-address">Marine Parade</span><br />
<span class="locality">Brighton & Hove</span>,
<span class="region">England</span>
<span class="postal-code">BN2 1TB</span><br />
<span class="country">United Kingdom</span><br />
<span class="tel">01273 606674</span>
</div>
<div class="note">Just a meeting place, in case the venue changes.</div>
</div>
</nowiki></pre>
This could be marked up as:
<pre><nowiki>
<div class="vcard">
<div class="adr">
<div class="fn extended-address">Phone Boxes by the Sealife Centre</div>
<span class="street-address">Marine Parade</span><br />
<span class="locality">Brighton & Hove</span>,
<span class="region">England</span>
<span class="postal-code">BN2 1TB</span><br />
<span class="country">United Kingdom</span><br />
<span class="tel">01273 606674</span>
</div>
<div class="note">Just a meeting place, in case the venue changes.</div>
</div>
</nowiki></pre>

===Concerns===
The above seems to be an elegant solution, but a wider variety of examples form published pages are needed, to be sure it meets all common scenarios. these should include cases where "adr" is not already used; note that in that case an extra level of nesting is required. The implications of this, for hCards already published, should be considered.

Also, what about hCards for published locations, which already include an extended address?

e.g.

<pre><nowiki>
<div class="vcard">
<span class="fn org">Powell's Pool</span>
<span class="adr">
<span class="extended-address">Sutton Park</span>
<span class="locality">Birmingham</span>
<span class="country-name">England</span>
</span>
</div>
</nowiki></pre>

[[User:AndyMabbett|Andy Mabbett]] 05:40, 15 Dec 2007 (PST)

===Revised proposal===
*See revised proposal at [http://microformats.org/discuss/mail/microformats-discuss/2007-December/011169.html microformats-discuss/2007-December/011169.html]

=== named location formats ===
Previous named location format efforts:

==== Simple GeoRSS featurename ====
The [http://georss.org/simple Simple GeoRSS] vocabulary contains the following named location example in the "Additional Properties" section that references a <strong><code>featurename</code></strong> tag.

<blockquote><h3>Feature Type, Feature Name, and Relationship Tags</h3><p>The Feature Type, Feature Name, and Relationship tags are specified as GeoRSS elements.</p><pre><nowiki>
<georss:point>45.256 -110.45</georss:point>
<georss:featuretypetag>city</georss:featuretypetag>

<georss:relationshiptag>is-centered-at</georss:relationshiptag>

<georss:featurename>Podunk</georss:featurename>
</nowiki></pre></blockquote>

A [http://www.google.com/search?q=site%3Ageorss.org%20featurename search for featurename on georss.org] fails to find any other references however, including a definition.

An [http://lists.eogeo.org/pipermail/georss/2006-December/000895.html email on the georss list from Dec 2006] thread "featurename, other missing bits from the site" notes that "there is some updating to do" in response to a concern that "that descriptions of "featurename" are not present on GeoRSS Simple and the GeoRSS Model. GeoRSS GML makes no mention of the non-geometric properties at all."

== FN Nickname semantic ==
There are many sites (e.g. [http://flickr.com Flickr], [http://consumating.com/ Consumating]) which permit the user to '''both''' have a multi-word login/handle/alias, '''and''' not show their ''real'' name (fn, n, given-name, family-name etc.).

For the people represented by the profile pages of these sites, the best we can do is mark-up their login/handle/alias as their "nickname". Originally, we had thought that such handles etc. were single words only, and thus we created the [[hcard#Implied_.22nickname.22_Optimization|Implied nickname optimization]] accordingly, where you can markup the handle as an "fn", and have it automatically set a "nickname" property value, and empty values for all the "n" sub-values.

In order to deal with multi-word handles, similar to the [[hcard#Organization_Contact_Info|hCard Organization contact info]] method, the following is proposed:

=== "fn" and "nickname" combination ===

Due to the use of potentially multi-word nicknames/handles/usernames in content published on the Web, (e.g. on sites like [http://flickr.com Flickr] and [http://consumating.com/ Consumating]), hCard has a mechanism for specifying a multi-word "fn" that is also a "nickname" without affecting any "n" sub-properties that are otherwise specified, and explicitly implying empty defaults for "n" sub-properties.

Similar to the [[hcard#Implied_.22nickname.22_Optimization|implied "nickname" optimization]], if the "fn" property and a "nickname" property have the exact same value (typically because they are set on the same element, e.g. <code>class="fn nickname"</code>), 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.

== Implied FN from N ==
Since the "n" property is more detailed and structured than the "fn" property, and [[hcard-examples-in-wild]] have shown that very often what is specified for "n" sub-properties is also specified for the "fn" property, we could add the following implied "fn" optimization which would permit sites to only use "n" and its subproperties.

In addition, some sites don't have contiguous uninterrupted text that represents the desired "fn" value, and would much rather have the "fn" implied from "n" subproperties. E.g. "Citizen Space Citizens" on [[hcard-examples-in-wild]].

=== implied "fn" from "n" optimization ===
If an hCard has no "fn", yet has an "n" property with one or more subproperties, then the "fn" property value can be implied by concatenating the "n" subproperty values as follows, with a space between each subproperty value, and multiple subproperty instances.

* 'honorific-prefix'es (as found in document order)
* 'given-name'
* 'additional-name's (as found in document order)
* 'family-name'
* 'honorific-suffix'es (as found in document order)

== Implied N from its subproperties ==
Since the "n" subproperties are sufficiently uniquely named (that is, they are not used by any other hCard property), and "n" is one of the [[hcard-singular-properties]], it is possible to consider leaving out the "n" property itself fo the hCard, and simply directlly using the subproperties, as properties of the hCard.

=== implied "n" from its subproperties ===
If an hCard has no "fn" nor "n" properties, then the entire scope of the hCard is considered to be inside an implied "n" property.

E.g. this markup:
<pre><nowiki>
<span class="vcard">
<span class="given-name">Tantek</span>
<span class="family-name">Çelik</span>
</span>
</nowiki></pre>

would be treated from a parsing perspective as:

<pre><nowiki>
<span class="vcard"><span class="n">
<span class="given-name">Tantek</span>
<span class="family-name">Çelik</span>
</span></span>
</nowiki></pre>

Which, with the '''implied "fn" from "n" optimization''', would then be effectively treated as:

<pre><nowiki>
<span class="vcard"><span class="fn n">
<span class="given-name">Tantek</span>
<span class="family-name">Çelik</span>
</span></span>
</nowiki></pre>

* a related request from the mailing list: http://microformats.org/discuss/mail/microformats-discuss/2007-September/010791.html

== Examples ==

* See [[hcard-examples]], which provides several illustrative instructive examples, as well as 1:1 hCard examples for each example in [http://www.ietf.org/rfc/rfc2426.txt RFC 2426].

=== Using RFC2806 with hCard ===

[http://www.ietf.org/rfc/rfc2806.txt RFC 2806] defines the telephone scheme "tel:", "fax:" and "modem:" to handle phone communications with URIs in the same way, "mailto:" is defined for email. It's part of the list or registered schemes by IANA : [http://www.iana.org/assignments/uri-schemes Uniform Resource Identifier (URI) SCHEMES]

<pre><nowiki>
tel telephone [RFC2806]
fax fax [RFC2806]
modem modem [RFC2806]
</nowiki></pre>

It is practical to write your tel number like this.

<pre><nowiki>
<a class="tel" href="tel:+1-919-555-7878">+1-919-555-7878</a>
</nowiki></pre>

or even

<pre><nowiki>
<a class="tel" href="tel:+1-919-555-7878">Mr Smith's phone</a>
</nowiki></pre>

You can add support for "tel:" to your desktop and to your browser

* For Gnome, edit ~/.gnome/Gnome and add something to the URL Handlers section. (Dan Connolly uses this to get galeon to launch telnum from [http://dev.w3.org/cvsweb/2001/telagent/ telagent sources] for tel URIs)
* In Mozilla, [http://dizzy.mozdev.org/ Dizzy]
* In Internet Explorer, [http://msdn.microsoft.com/workshop/networking/pluggable/overview/overview.asp Asynchronous Pluggable Protocols]

On the CSS front… You could for example add automagically an icon. I have put the property !important for those who wants to add it to their own stylesheet in their browsers, so they know type of links when browsing.

<pre><nowiki>
a[href^="tel:"]:before {
content: '\260f ' !important;
padding-left: 20px !important; }

a[href^="mailto:"]:before {
content: '\2709 ' !important;
padding-left: 20px !important; }
</nowiki></pre>

== Encoding "modern" attributes ==

Since vCard was first established, various interactive communication technologies and addressing schemes have been widely adopted. Although there aren't specific properties for these technologies / addressing schemes, they can be captured as URLs or email addresses.

This has now been written up for the most part. See:

http://microformats.org/wiki/hcard-examples#New_Types_of_Contact_Info

Still to be addressed:

* iChat mac.com addresses, simply store "@mac.com" email addresses, e.g.
** <code><nowiki><a class="email" href="mailto:steve@mac.com">...</nowiki></code>
* MSN Instant Messenger, you can simple store "@hotmail.com" or "@msn.com" or "@passport.com" email addresses.
* Internet Relay Chat (IRC), use "irc:" URLs.

A suggestion relating to the rise of VoIP protocol (Skype, etc):

Should these protocols be marked up using the <code><nowiki><span type="tel"></nowiki></code>. It seems logical that a means to communicate with another via voice should be marked up as a telephone address, rather than the currently suggested URL property.

== Auto-Discovery ==

See [[hcard-brainstorming-autodiscovery]]

== geo improvements ==
''See [[geo-brainstorming]]''

== Other use cases ==
Please add your suggestions!

hCard microformats could be used to:
*Calculate and display the subject's age "as of today".
*Calculate and display the subject's age at death (if a [[hcard-date-of-death|Date of Death]] is available)
*Generate a recurring iCal for a living subject's birthday
*Generate a recurring iCal for a dead subject's "anniversary of birth" (if a [[hcard-date-of-death|Date of Death]] is available)
*...

== Issues with vCard Applications ==
See [[vcard-implementations]].

== Open Questions ==

Q: since many of the components would be using CSS classes for encoding data, it is possible to MIX two different profiles. (e.g. hCard and XFN) There are no real constraints on where/how to enforce class names, these are based on the html profile, since it is difficult to associate the text within the attribute to a specific profile.

<pre><nowiki>
...
<a href="mailto:joe.smith@example.com" class="fn" rel="met">Joe Smith</a>
...
</nowiki></pre>

-- [http://suda.co.uk/ Brian Suda]

Q: Preserving White space? Should the transforming applications preserve extra white space characters? For example:
<pre><nowiki>
<a href="http://mywebsite.com/" class="fn n">
<span class="given-name">John</span>
<span class="other-names">Q.</span>
<span class="family-name">Public</span>
</a>
</nowiki></pre>

When transformed into a vCard, the N property will pick apart the span tags and create the value for N correctly seperated by colons. The FN property will take a string and simply display it. There are two possible renderings for FN:
<pre><nowiki>
John Q. Public

John
Q.
Public
</nowiki></pre>

Either the white-space is preserved or it is not. Which should the transforming applications render?

-- [http://suda.co.uk/ Brian Suda]

A: The parsing application should follow the white space collapsing rules of the mime type it retrieves. I.e. if it retrieves a "text/html" document, it should do HTML white space collapsing.

-- [http://tantek.com/log/ Tantek]

Many of the Questions and Answers are relevant to both ["hCal"] and hCard.

Q: Would it be appropriate to wrap the name of the vCard owner with <dfn/>? This may give the hCard some added semantic value in the XHTML document.
<pre><nowiki>
<span class="agent">
<span class="vcard">
<span class="email">
<a class="internet" href="mailto:jfriday@host.com">
<dfn>
<span class="fn">Joe Friday</span>
</dfn>
</a>
</span>
<span class="tel">+1-919-555-7878</span>
<span class="title">Area Administrator, Assistant</span>
</span>
</span>
</nowiki></pre>
-- [http://www.ben-ward.co.uk/ Ben Ward]
* If the answer to the above Q is "yes", why not use the following?
<pre><nowiki>
<dfn class="fn">Joe Friday</dfn>
</nowiki></pre>
or
<pre><nowiki>
<span class="agent">
<dfn class="vcard">
<span class="email">
<a class="internet" href="mailto:jfriday@host.com">
<span class="fn">Joe Friday</span>
</a>
</span>
<span class="tel">+1-919-555-7878</span>
<span class="title">Area Administrator, Assistant</span>
</dfn>
</span>
</nowiki></pre>
This would mark the entire hcard as the "defining instance".

[[User:Bob Jonkman|Bob Jonkman]] 10:07, 13 Jul 2007 (PDT)

== Applications ==
Applications that are hCard aware or can convert hCard to vCard formats.

=== Copy hCards favelet(s) ===
* I think a Favelet would work nicely here. When you find a page that is hCard friendly, you click the favlet and you get yourself a vCard. This is done! See X2V in the implementations section of the [[hcard|hCard]] spec.

=== Distributed Commentor Icons ===

''The URL reffered to in this section is no longer available. The thoughts on using icons are however still relevant.'' [[User:WilleRaab|WilleRaab]] 16:55, 23 Jul 2007 (PDT)

* See [http://thedredge.org/2005/06/using-hcards-in-your-blog/ using hCards in your blog] for an example of hCards used for comment authors (commentors). The system used there, "Gravatars", is a centralized site that serves commentor icons that requires login etc.

What if we gave each commentor the option of hosting their own icon?

A distributed commentor icon implementation could work like this:

# Given the URL of a commentor, look for an <code><address></code> element with classname of "vcard" at the commentor's URL. The <code><address></code> element is supposed to be the contact information for the page (see [[hcard-faq|hCard FAQ]] for more info), so this makes sense.
# Next, look for the first element inside that hcard that has a classname of "logo".
# Hopefully that element is an <code><img></code>, and if so, use its src to get the commentor's icon.
# Presto. You've got distributed commentor icons!

== Spam prevention ==
hCard uses <code>mailto:</code> links, and therefore
it automatically "inherits" the disadvantage of <code>mailto:</code> links:
These links can be easily detected by emails spiders (used by spammers).

Email addresses are picked up like any other link crawled by a search engine and trustworthy crawlers may be deterred from adding emphasis while indexing these links by including rel="nofollow" (See [[rel-nofollow]]). However, email addresses used for spam are crawled by email spiders which will likely ignore this attribute.

There are ways to prevent email address detection by simple email spiders, while
still retaining full compatibility with (X)HTML applications.
One common way is to "encode" the the "m" of "mail" and "@" with character entities, yet it's unwise to follow a convention of only encoding specific characters because the email spiders can pick up on this too:

Example of the original link:
<pre><nowiki>
<a class="email" href="mailto:john.smith@example.com">john.smith@example.com</a>
</nowiki></pre>

Example of the "encoded" link (with rel-nofollow added):
<pre><nowiki>
<a class="e&#109;ail" rel="nofollow" href="&#109;ailto:john.smith&#064;example.com">john.smith&#064;example.com</a>
</nowiki></pre>

Simple email spiders which do not do character entity decoding will therefore not be able to find your email address.

''Note:'' Perhaps there are or will be email spiders which can decode entities, so the this technique will only help with some (cheap) email spiders.
(See also: http://rbach.priv.at/Misc/2005/EmailSpiderTest)

=== Other prevention methods to consider ===
* Using server-side code to implement character entities randomly
* Displaying the address in a way thought to be only human readable (thus breaking the link):
** Using an image instead of text (could still be machine readable using OCR)
** Using human readable text that conveys the need for editing before use (eg PLEASE-NO-SPAM_name@example_NO-SPAM.com)
* Using javascript for client-side decryption of an encrypted address (requires javascript to be enabled)
* Pointing to an email form or other URL instead of an email address

== Tutorials ==
* How to hCard encode entries in Popular blog software.
* Good reasons to publish your hCard
** as a business, get people to put you in their address book so they'll find you later
** as a business with an email list, get people to add you (with email address) to their address book so that your email list works via whitelisting via the address book.

* [http://24ways.org/2006/styling-hcards-with-css Styling hCards with CSS] is a text on how to use CSS to make an improved presentation of an hCards contents.

== Parsing ==

See [[hcard-parsing-brainstorming]]

== Birthday Reminders ==
*hCard consumers could calculate the current age of hCard subjects, from the DoB. [[User:AndyMabbett|Andy Mabbett]] 07:47, 20 Apr 2007 (PDT)
*for hCards with DoB, hCard consumers could generate and export a recurring hCalendar. [[User:AndyMabbett|Andy Mabbett]] 08:06, 20 Apr 2007 (PDT)
**If/ when [[hcard-date-of-death|Date of Death]] is added to hCard, parsers could instead generate a recurring "death-anniversary" hCalendar. [[User:AndyMabbett|Andy Mabbett]] 08:08, 20 Apr 2007 (PDT)

== Post vCard additions ==

Keeping hCard properties and values as a 1:1 representation of vCard properties and values has numerous benefits such as simplicity, stability, interoperability with the vast number of existing vCard applications etc.

However some have found vCard to be limiting in terms of the data/properties/fields they want to express in contact information. Some implementations use vCard extensions to express such information [citation needed].

This section is for documentation of such suggested additions. Empirical evidence of actual *real world* examples on the Web of people publishing this information would be a good step towards considering any such additions/extensions.

* '''altitude'''. From [[hcard-issues]].
**See [[geo-elevation-examples]]
* '''vat-number''' : for VAT numbers of companies, which are used a lot in Europe and they need to be published on Belgian publications (including websites).

* '''gender'''
** See [[vcard-suggestions#Gender]]

* '''date-of-death'''
** See [[hcard-date-of-death]]

Thus see (and add to): [[vcard-suggestions]]

Another path to consider is the development of another microformat which includes an hCard and then extends it with additional properties for a particular domain. In many ways [[hresume|hResume]] has already done this. Other related efforts:
* [[genealogy]]
* [[profile]]

Using hCard as a stable building block for additional microformats may seem more desirable than incrementally growing hCard itself.

Of course if vCard were extended itself, that may provide impetus to add such extensions to hCard in order to maintain the 1:1
representation of properties/values.

==Wikipedia's Persondata==
Wikipedia's [http://en.wikipedia.org/wiki/Wikipedia:Persondata Persondata] aligns very closely with hCard, but has additional date and place of birth & death fields. [[User:AndyMabbett|Andy Mabbett]] 13:02, 28 Jan 2007 (PST)

== TODO ==

* The [[hcard-profile]] needs verification and perhaps a URL for retrieving the actual XMDP, rather than as <pre> text on a wiki page.
* Complete translating the examples from the vCard spec into hCard, and place them on a separate hCard examples page.
* Create a "rich" but realistic hCard example, say for example for a salesperson, who wants to put a whole bunch of contact information on their website in order to be found/contacted easily.
* Provide examples of how to encode instant messaging (IM) accounts. Figure out what would the mailto: or aim: URL in hCard look like in vCard. And take a look at what vCard applications do today with IM addresses.
* Clarify contradictory copyright statements, per http://microformats.org/discuss/mail/microformats-discuss/2007-July/010243.html

== CSS Styles ==
Not only can you create semantics with the hCard values, but you can add CSS styles to them as well. You are free to style the terms in any way you want, but here we can list a few ideas for how to style terms.

If you want to encode hCard data, but do NOT want to display it in the HTML code (WARNING: This is very much recommended AGAINST, and in general against the microformat principle of marking up visible data), then you can hide that tag in CSS with the following code:
<pre><nowiki>
<span style="display: none">Hidden Data</span>
</nowiki></pre>
Transforming applications will still find the data and use it when converting hCards to vCards.

== Other Implementations/Ideas ==
* [http://www.w3.org/TR/2001/NOTE-vcard-rdf-20010222/ Representing vCard Objects in RDF/XML] This could allow conversion of vCard data from XHTML to RDF and from RDF to XHTML
* It would also be possible to convert XFN and hCard to FoaF.
* [http://microid.org/ MicroID in hCard]

== Accepted Suggestions ==

=== Encoding Company data as a Business Card (proposal) ===

( Accepted: http://microformats.org/wiki/hcard#Organization_Contact_Info )

In the wild there are several hCards that do not currently validate because they are businesses that have omitted the "fn" property in favor of the "org" property.

Proposal: hCards representing a business or organization MUST set fn AND org to the same value. Parsers may then use this equivalence, if detected, to treat an hCard as the contact info for a business or organization rather than an individual.

Note that [http://microformats.org/wiki/vcard-implementations#organization_vs._individual Apple Address Book supports this semantic when importing vCards].

See the [http://technorati.com/about/contact.html Technorati Contact Info] for an example.

=== Implied "FN and N" Optimization (proposal) ===

Right now a parser first looks for an "n" element.

And then if no "n" is present, look for an "fn" element to use to imply an "n" element per the "implied n property" rules in the spec.

BACKGROUND:

Due to the prevalence of the use of "nicknames" or "handles" on the Web, in actual content published on the Web (e.g. authors of reviews), there has been a discussion about adding a "fn" shortcut to the "n" shortcut that used the "nickname" as a fallback.

PROPOSAL:

We should consider adding one more implied optimization after the steps documented above and that is:

If no "fn" is present either, then look for a "nickname" element to use to imply both the "fn", and the "n/given-name", leaving the "n/family-name" as empty.

This would enable "nickname" only hCards for denoting and individual on a website, which is quite common on blogs and reviews published on the Web.
* +1 [[User:Atamido|Atamido]]
* +1 [[User:ChrisMessina|ChrisMessina]] - note: multiple alternate nicknames should also be allowed
* +1 [[User:DimitriGlazkov|DimitriGlazkov]]

== Implied work tel ==

=== Problem ===

Some phone numbers are not always documented of type 'work'. The type 'work' is usually implied from context.

=== Examples in the wild ===

[[http://www.nvidia.com/page/contact_information.html NVidia contact information]]

Only 'Tel' is specified. The fact that it is of type 'work' can be assumed from the context: the name of an organization is present.

<pre>
<P><B>NVIDIA CORPORATE OFFICE:</B> <BR>
2701 San Tomas Expressway<BR>
Santa Clara, CA 95050<BR>
Tel: 408-486-2000<BR>

Fax: 408-486-2200<BR>
...
</P>
</pre>

[[http://www.supermarketguru.com/page.cfm/369 Supermarketguru.com]]

<pre>
<p>
<font face="Verdana, Helvetica, Arial" size=2>
<b>Phil Lempert:</b> <a href="mailto:plempert@supermarketguru.com">plempert@supermarketguru.com</a><br>
</font>
<font face="Verdana, Helvetica, Arial, sans-serif" size=2>SupermarketGuru.com<br>
3015 Main Street, Suite 320<BR>Santa Monica, California 90405<br>
Telephone: 323-860-3070
</font>
</p>
</pre>

Here only 'Telephone:' is specified, a FN is present ('Phil Lempert') but because an ORG is present ('SupermarketGuru.com'), it can be safely implied that '323-860-3070' is a tel or type work.

=== Proposal ===

If an ORG is present in a VCARD, a TEL with no TYPE has an implied TYPE 'work'

==== Comments ====
* Though it may be safe to make that assumption for the given example (and though it might have been wise to make this rule from the outset), we now can't know that it will alwyas be safe to do so, for all pre-existing hCards. Consider people whose organisation represents voluntary work, honorary roles and so forth. [[User:AndyMabbett|Andy Mabbett]] 00:33, 8 Jan 2008 (PST)

== Rejected Suggestions ==

Suggestion: ''The use of class="url" on an <a> tag to represent an hCard URL property is redundant. By virtue of the <a> tag you know this is a URL.''

Rejected. This is a bad suggestion because although it appears to reduce redunancy and keep things cleaner, it also creates a few problems. Without explicitly noting that this is a URL then any <a> tags within a 'vcard' would be considered a URL, for example:
<pre><nowiki>
<span class="vcard">
...
<ul class="categories">
<li><a href="http://w3c.org">W3C</a></li>
</ul>
...
</span>
</nowiki></pre>

There is no way to "turn-off" the encoding of the W3C URL, whereas if "url" needed to be explicitly listed in the class attribute list, then by NOT listing it you could effectively turn it off.

== References ==

=== Normative References ===
* [http://www.ietf.org/rfc/rfc2426.txt RFC 2426] vCard RFC
* [http://www.ietf.org/rfc/rfc2397 RFC 2397] data URI RFC
* [http://gmpg.org/xmdp/ XMDP]

=== Informative References ===
* [http://www.imc.org/pdi/ Personal Data Interchange (PDI) at the Internet Mail Consortium]
* [http://tantek.com/log/2004/07.html#d27t1049 Markup language design notes]
* [http://tantek.com/log/2002/12.html#L20021216t2238 A Touch of Class]
* [http://www.icao.int/mrtd/download/technical.cfm ICAO - Machine Readable Travel Documents format]

== Related Pages ==

{{hcard-related-pages}}
* [[adr-poll]]

hcard-issues

2008-02-13T23:50:11Z

GuyLeech: /* closed issues */

<h1> hCard issues </h1>
{{TOC-right}}
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.

'''IMPORTANT''': Please read the [[hcard-faq|hCard FAQ]] and the [[hcard-issues-resolved|hCard resolved issues]] ''before'' giving any feedback or raising any issues as your feedback/issues may already be resolved/answered.

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/ Tantek]

For matters relating to the vCard specification itself, see [[vcard-errata]] and [[vcard-suggestions]].

See other [[issues]] also.

== closed issues ==
See: [[hcard-issues-resolved]]

== resolved issues ==
See: [[hcard-issues-resolved]]

== issues ==
<span id="Issues">Please add new issues</span> to the '''bottom''' of the list by copy and pasting the [[hcard-issues#Template|Template]]. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.

=== 2006 ===

* {{OpenIssue}} 2006-10-21 raised by [[User:AndyMabbett|Andy Mabbett]]
*# ''There should be some way to say that the URL of an hCard or hCalendar event is the URL of the page itself, without having to include a redundant, and accessibility-damaging link to that page, on the page itself.''
*#* Quite often I see "a" webpage accessible with several different URLs. Typically 1 URL is the "preferred" URL, expected to have a long lifetime. Sometimes other URLs are "convenience" URLs that may have been linked to in the past, but are expected to go away soon, which resolve to the same file (the "latest version"). Then there are "archive" URLs that show an exact copy of that webpage as it appeared some time in the past. I think we want to always use the "preferred" URL, no matter which of those URLs we happen to stumble upon first -- so the URL is not actually redundant. (How exactly is it "accessibility-damaging" for a page to link to itself? Could you explain or add a link to an explanation?) --[[User:DavidCary|DavidCary]] 17:44, 5 Apr 2007 (PDT)
*#**"''How exactly is it "accessibility-damaging" for a page to link to itself?''" - Novice user clicks on link; nothing (it appears) happens. Repeat ad infinitum, until user leaves site to do something else. [[User:AndyMabbett|Andy Mabbett]] 02:43, 6 Apr 2007 (PDT)
*#*A: ACCEPTED THEORETICAL. While I tend to agree with the accessibility guidelines/issues noted herein in theory, to make this a real world issue worthy of higher priority, we need documentation of examples in the wild where the URL of an hCard or hCalendar event is the URL of the page itself, so that we can use those examples to inform brainstorming towards a solution. [[User:Tantek|Tantek]] 15:11, 10 Apr 2007 (PDT)
*#** Examples in the wild where the URL of an hCard is the URL of the page itself:
*#*** [http://2007.sxsw.com/music/showcases/band/999918.html The Pipettes] page at SXSW 2007 (1 of 1000+ bands). There are no links to the page itself on the page to markup with class="url". Thus it would be nice to have a way for the hCard for The Pipettes to indicate that the page itself is the URL for the hCard.
*#*** See also the proposal to use this pattern in [[representative-hcard]]
*#** Examples in the wild where the URL of an hCalendar event is the URL of the page itself:
*#*** [http://2007.sxsw.com/music/showcases/band/999918.html The Pipettes at La Zona Rosa] page at SXSW 2007 (1 of 1000+ concerts, yes, same page as the page for The Pipettes the org). There are no links to the page itself on the page to markup with class="url". Thus it would be nice to have a way for the hCalendar event for The Pipettes at La Zona Rosa to indicate that the page itself is the URL for the hCalendar event.
*#** This is also an [[hreview-issues|hReview issue]] and any other microformat which has a "url" property. Examples where the URL of an (potential) hReview *item* is the URL of the page itself:
*#*** [http://www.amazon.com/exec/obidos/ASIN/0553380958 Snow Crash (Bantam Spectra Book) (Paperback) on Amazon] (millions of potential hReview items/products with reviews on their item pages).

=== 2007 ===
* {{OpenIssue}} 2007-01-26 raised by [[User::JamesCraig|JamesCraig]].
*# RFC2426 'type' values cannot be localized/internationalized in hCard. In the example below, there is no solution to mark the Spanish version with a type of 'home' since the RFC2426 values are defined in English. <strong>abbr-design-pattern</strong> would suggest using abbr, but 'Casa' is not an abbreviated form of 'home', therefore the currently recommended version (below) is not valid.<pre><nowiki>
<span class="tel" xml:lang="es">
<abbr class="type" title="home">Casa</abbr> (<span class="type">pref</span>erido):
<span class="value">+1.415.555.1212</span>
</span>
</nowiki></pre>
*#* REJECTED. TOO LITTLE INFORMATION. Please provide the precise URL to the specific statement on the accessify forum discussion that asserts that using abbr is not valid. Please also provide a precise URL to a *real world* (as opposed to an artificially constructed test case) example in the wild of an non-English hCard which attempts to specify RFC2426 type information on a "tel" property and fails to do so.
*#* REOPENED and clarified (Also removed Accessify reference pulled from [[http://microformats.org/wiki?title=accessibility&oldid=12943 original raising]]).
*#*# Though erroneously first raised on the accessibility page, this is not an accessibility issue. It is an HTML semantics issue for internationalization. <code>abbr[title]</code> should be an expanded form of <code>abbr</code> contents, in the same language.
*#*# There are real-world non-English examples in the current Mac OS 10.5 (Leopard) developer seed. This code example illustrates the point sufficiently.
*#*# Please leave the clarification as-is even if you feel you must RE-REJECT (add-on, don't revert). My original points were lost when they were taken out of context and moved here. -[[User::JamesCraig|JamesCraig]]

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2007-03-19</span> raised by <span class="fn">[[User::ChristinaHope|Christina Hope]]</span></span>
<div class="description">
*# ''Does Microsoft Outlook 2003 allow the use of the "role" property? I have added it to all of my hCards and it is not appearing. Am I doing something wrong?''
*#** URL? (if no URL to a demonstrative example is provided within a year of this issue being raised, it will be closed as REJECTED INSUFFICIENT INFORMATION.)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2007-03-31</span> raised by <span class="fn">[[User:AndyMabbett|Andy Mabbett]]</span></span>
<div class="description">
*# The [http://en.wikipedia.org/wiki/World_Geodetic_System WGS84 scehma] used as a default by <code>geo</code> will not remain valid forever. Fortunately, the proposed [[geo-extension-strawman|geo extension]], originally intended for lunar/ Martian coordinates, also provides a facility for the specification of other, Earth-bound schema, which will alleviate this problem. [[User:AndyMabbett|Andy Mabbett]] 13:00, 31 Mar 2007 (PDT)
*#* Note also the forthcoming [http://www.euref-iag.net/ European Terrestrial Reference System 89 schema] (See also [http://en.wikipedia.org/wiki/European_Terrestrial_Reference_System_1989 Etrs89 on Wikipedia]. [[User:AndyMabbett|Andy Mabbett]] 03:11, 5 Apr 2007 (PDT)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2007-04-19</span> raised by <span class="fn">[[User:AndyMabbett|Andy Mabbett]]</span></span>
<div class="description">
*#How should we handle [http://en.wikipedia.org/wiki/Old_Style_and_New_Style_dates Old Style and New Style dates] (i.e. Julian calendar vs. Gregorian), in DoB? For instance, [http://en.wikipedia.org/wiki/Boris_Pasternak Boris Pasternak], born "10 February [O.S. January 29] 1890". Should the hCard spec. specify New Style, using the [[abbr-design-pattern]] (or its successor) if necessary: <nowiki><abbr title="1890-02-10">29 January 1890</abbr></nowiki>?
</div>
</div>

===2008===

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-01-01</span> raised by <span class="fn">[[User:AndyMabbett|Andy Mabbett]]</span> in [http://microformats.org/discuss/mail/microformats-discuss/2008-January/011182.html microformats-discuss/2008-January/011182.html]</span>
<div class="description">
*# The "n" optimisation rules (nickname, fn) should not apply where the fn is on part of adr or label: e.g <code><nowiki>
<span class="fn locality">New York</span></nowiki></code>; <code><nowiki><span class="fn label">Asia</span></nowiki></code>, since, in these examples, "Asia" is not a nickname, "New" is not a given-name and "York" is not a family-name. (see also [[hcard-brainstorming#Named_locations]])
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary"><span class="dtstart">2008-01-09</span> <span id="tel-type-lang">2008- moved from vcard-suggestions</span></span>
<div class="description">
*#We can't have a generic type name cause we have to localize in French. so, for us, hCard work phone number is: <nowiki><div class="tel"><span class="type">Travail</span> : <span class="value">0321596224</span></div></nowiki>. How will a bot recognize that type ? We cannot specify every types in every languages in the specification. That's why i think something like this would be better: <nowiki>Travail : <span class="telwork">0321596224</span></nowiki> Please, use class and id attributes ONLY for micro formats specifications ! XML #cdata and #data are localized ! Thanks !
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-02-02</span> raised by <span class="fn">[[User:AndyMabbett|Andy Mabbett]]</span></span>
<div class="description">
*# The "<code>n</code>" optimisation rules (<code>nickname</code>, <code>fn</code>) should not apply where the <code>fn</code> is also the <code>role</code> or <code>title</code>: e.g <code><nowiki>
<span class="fn role">Webmaster</span></nowiki></code>; <code><nowiki><span class="fn title">Duty Manager</span></nowiki></code>, since, in these examples, "Webmaster" is not a nickname, "Duty" is not a given-name and "Manager" is not a family-name.
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-02-06</span> raised by <span class="fn">[[User:Guillaume Lebleu| Guillaume Lebleu]]</span></span>
<div class="description">
*# It seems to me that FN has been reused beyond its original vCard scope of person names, to cover any name. This led to the fn/title debate, but it seems some implementors are confused between following the vCard semantics (FN only for person names) or the hCard ones (FN for any name). See. http://cinematreasures.org/theater/365/, which uses an empty FN, resulting in their vCard not being detected by Operator, only the address.
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-02-07</span> raised by <span class="fn">[[User:AndyMabbett|Andy Mabbett]]</span></span>
<div class="description">
*# The "<code>fn</code>" optimisation rule should not apply where the full <code>fn</code> is also the <code>nickname</code>: e.g <code><nowiki><span class="fn nickname">Plastic Bertram</span></nowiki></code>, since a given-name+family-name pair is not usually a nickname. (But how to deal with pseudonyms such as "Maurice Micklewhite (known professionally as Michael Caine)"?)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-02-07</span> raised by <span class="fn">[[User:AndyMabbett|Andy Mabbett]]</span> in [http://microformats.org/discuss/mail/microformats-discuss/2008-February/011552.html microformats-discuss/2008-February/011552.html]</span>
<div class="description">
*# Is "n" optional or mandatory? The spec says yes (with exceptions) the cheat-sheet says no. Parsers and common practice seem to indicate not.
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-02-07</span> raised by <span class="fn">[[User:AndyMabbett|Andy Mabbett]]</span> in [http://microformats.org/discuss/mail/microformats-discuss/2008-February/011552.html microformats-discuss/2008-February/011552.html]</span>
<div class="description">
*# "<code>nickname</code>" and "<code>fn</code>" optimisation does not work for some or all names in Asian languages. See [http://zh.wikipedia.org/wiki/%E6%B9%AF%E5%A7%86%C2%B7%E5%85%8B%E9%AD%AF%E6%96%AF Tom Cruise on Chinese Wikipedia], where the <code>fn</code> and nickname are the same. This could be partly remedied by not applying such optimisation when the page's (or element's) language is set to one of a set of affected languages (may also apply to other languages, such as Greek). '''Cpmment from people fluent in such languages would be welcome.'''
</div>
</div>

<div class="vevent">
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-02-08</span> raised by <span class="fn">[[User:Guillaume Lebleu| Guillaume Lebleu]]</span></span>
<div class="description">
*# The required FN makes it difficult to use hCard in HTML Tables without resorting to hiding information (as in http://www.bo.ingv.it/contents/INGV-Bologna/Staff.html) or using the [[include-pattern]]. Perhaps FN should not be required if some N are present. Originally raised in [http://rbach.priv.at/Microformats/IRC/2008-02-08#T181749]
</div>
</div>

== template ==

{{issues-format}}

== related pages ==
{{hcard-related-pages}}</nowiki>

hatom

2007-05-26T13:42:05Z

GuyLeech: /* Examples in the wild */

<h1> hAtom 0.1 </h1>

hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. hAtom is based on a subset of the [http://www.atomenabled.org/ Atom] syndication format. hAtom is one of several [[microformats]] open standards.

__TOC__
== Draft Specification ==

=== Editor/Author ===
* [http://blogmatrix.blogmatrix.com/ David Janes], [http://www.blogmatrix.com BlogMatrix, Inc.]

=== Contributors ===
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Benjamin Carlyle]
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]

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

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

== Introduction ==

hAtom is a [[microformat]] for identifying semantic information in weblog posts and practically any other place [http://www.atomenabled.org/ Atom] may be used, such as news articles. hAtom content is easily added to most blogs by simple modifications to the blog's template definitions.

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

== Format ==
=== In General ===
The [http://atomenabled.org/developers/syndication/#person Atom Syndication Format] provides the conceptual basis for this microformat, with the following caveats:

* Atom provides a lot more functionality than we need for a "blog post" microformat, so we've taken the minimal number of elements needed.
* the "logical" model of hAtom is that of Atom. If there is a conflict, Atom should be taken as correct.
* the "physical" model of hAtom -- the actual writing of elements -- is a lot more varied than Atom provides for, due to the variety of ways weblogs are actually produced in the wild. The hAtom microformat provides a number of rules for "bridging the gap"

=== Schema ===
Schema elements are based on the Atom nomenclature and follow the microformat pattern of prefixing a unique identifier (in this case, '<code>h</code>') on the outermost container elements -- the Feed or Entry. The parts of this microformat are based on analysis of many weblog, bulletin board and media posts and can be read [[blog-post-brainstorming#Discovered_Elements]].

The hAtom schema consists of the following:

* hfeed ('''<code>hfeed</code>'''). optional.
* hentry ('''<code>hentry</code>''').
** '''<code>entry-title</code>'''. required. text.
** '''<code>entry-content</code>'''. optional (see field description). text.
** '''<code>entry-summary</code>'''. optional. text.
** '''<code>updated</code>'''. required using [[datetime-design-pattern]].
** '''<code>published</code>'''. optional using [[datetime-design-pattern]].
** '''<code>author</code>'''. required using '''[[hcard|hCard]]'''.
** '''<code>bookmark</code>''' (permalink). optional, using '''[[rel-bookmark]]'''.
** tags. optional. keywords or phrases, using '''[[rel-tag]]'''.

Some required elements have defaults if missing, see below.

=== Field and Element Details ===

===== Feed =====
* a Feed element is identified by the class name <code>hfeed</code>
* a Feed element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.1 Atom feed]
* the Feed element is optional and, if missing, is assumed to be the page
* hAtom documents MAY have multiple Feed elements

===== Feed Category =====
* a Feed Category element is identified by [[rel-tag]]
* a Feed MAY have a Feed Category
* a Feed Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside a [http://www.atomenabled.org/developers/syndication/#optionalFeedElements feed]
* Feed Category elements MUST appear inside a Feed element but not inside an Entry element
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code>

===== Entry =====
* an Entry element is identified by class name <code>hentry</code>
* an Entry element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.2 Atom entry]
* any microformat content inside a <code><blockquote></code> or <code><q></code> element within the Entry should not be considered part of the Entry.
: ''This allows quoting other microformated data without worry of corrupting the model''

===== Entry Category =====
* an Entry Category element is identified by [[rel-tag]]
* an Entry MAY have an Entry Category
* an Entry Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside an [http://www.atomenabled.org/developers/syndication/#optionalEntryElements entry]
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code>

===== Entry Title =====
* an Entry Title element is identified by the class name <code>entry-title</code>
* an Entry SHOULD have an Entry Title
* an Entry Title element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.14 Atom entry title]
* if the Entry Title is missing, use
** the first <code><h#></code> element in the Entry, or
** the <code><title></code> of the page, if there is no enclosing Feed element, or
** assume it is the empty string

===== Entry Content =====
* an Entry Content element is identified by class name <code>entry-content</code>
* an Entry SHOULD have Entry Content
* an Entry Content element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#atomContent Atom content]
* an Entry MAY have 0 or more Entry Content elements. The "logical Entry Content" of an Entry is the concatenation, in order of appearance, of all the Entry Contents within the Entry
: ''Many weblogs split content into multiple sections with a "Read More" link and javascript tricks. This is also needed in cases where Entry Titles are coded inline and are considered part of the content.''
* if the Entry Content is missing, assume it is the empty string

===== Entry Summary =====
* an Entry Summary element is identified by class name <code>entry-summary</code>
* an Entry Summary element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.13 Atom summary]
* an Entry MAY have 0 or more Entry Summary elements. The "logical Entry Summary" of an Entry is the concatenation, in order of appearance, of all the Entry Summarys within the Entry

===== Entry Permalink =====
* an Entry Permalink element is identified by [[rel-bookmark]]
* an Entry SHOULD have an Entry Permalink
* an Entry Permalink element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.7 Atom link in an entry]
* if the Entry Permalink is missing, use the URI of the page; if the Entry has an "id" attribute, add that as a fragment to the page URI to distinguish individual entries

===== Entry Updated =====
* an Entry Updated element is identified by class name <code>updated</code>
* an Entry Updated element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.15 Atom updated]
* an Entry SHOULD have an Entry Updated element
* use the [[datetime-design-pattern]] to encode the updated datetime
* if there is no Entry Updated element,
** use the Entry Published element, if present
** otherwise the page is invalid hAtom

===== Entry Published =====
* an Entry Published element is identified by the class name <code>published</code>
* an Entry Published element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.9 Atom published]
* use the [[datetime-design-pattern]] to encode the published datetime

===== Entry Author =====
* an Entry Author element is represented by class name <code>author</code>
* an Entry Author element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.1 Atom author]
* an Entry Author element MUST be encoded in an [[hcard|hCard]]
* an Entry Author element SHOULD be encoded in an <code><address></code> element
* an Entry SHOULD have at least one Entry Author element
* an Entry MAY have more than one Entry Author elements
* if the Entry Author is missing
** find the [[algorithm-nearest-in-parent|Nearest In Parent]] <code><address></code> element(s) with class name <code>author</code> and that is/are a valid [[hcard|hCard]]
** otherwise the entry is invalid hAtom

=== XMDP Profile ===
<pre>
<dl class="profile">
<dt>class</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
HTML4 definition of the 'class' attribute.</a>
This meta data profile defines some 'class' attribute values (class names)
and their meanings as suggested by a
<a href="http://www.w3.org/TR/WD-htmllink-970328#profile">
draft of "Hypertext Links in HTML"</a>.
<dl>
<dt>hfeed</dt>
<dd>
The concept of atom:feed from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>hentry</dt>
<dd>
The concept of atom:entry from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>entry-title</dt>
<dd>
The concept of atom:title inside of an atom:entry from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>entry-content</dt>
<dd>
The concept of atom:content from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>entry-summary</dt>
<dd>
The concept of atom:summary from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>bookmark</dt>
<dd>
The concept of atom:link (without any "rel") with an atom:entry from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>published</dt>
<dd>
The concept of atom:published from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>updated</dt>
<dd>
The concept of atom:updated from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>author</dt>
<dd>
The concept of atom:author from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
</dl>
</dd>
</dl>
</pre>

== Examples ==

See [[hatom-examples]].

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

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

=== 0.1 hAtom examples===
* [http://guyleech.net guyleech.net] uses hAtom for blog posts, and uses hCard for contact information. There is also an [http://guyleech.net/2007/7 article] on how to minimise hAtom, to save time and code.
* [http://kpumuk.info/ Dmytro Shteflyuk] uses hAtom for all blog posts.
* [http://blog.no-panic.at Florian Beer] uses hAtom to mark up all the blog posts. There is also a [http://blog.no-panic.at/2006/11/16/hatom-and-wordpress/ tutorial] on how to convert Wordpress themes to include hAtom.
* [http://ficlets.com/ Ficlets] uses hAtom on the [http://ficlets.com/stories main stories page] and on [http://ficlets.com/stories/12 individual story pages].
* [http://www.international.unt.edu UNT International] uses hAtom combined with hCard on news/announcement pages (e.g., [http://www.international.unt.edu/quick/news the main news page]) in addition to providing traditional Atom feeds
* [http://www.absalom.net.au Absalom Media] uses hAtom combined with hCard for articles.
* [http://www.joomlamug.com Joomla! Melbourne User Group] uses hAtom combined with hCard for articles.
* [http://www.volume.co.uk Volume] - Main news page is marked up as hAtom 0.1
* [http://yedda.com Yedda] - Yedda support hAtom on exploration of questions where there is also support for Atom and RSS feeds. ([http://yedda.com/questions/recent/ example])
* The [http://www.westmidlandbirdclub.com/ West Midland Bird Club's] frequently-updated [http://www.westmidlandbirdclub.com/new.htm What's New] page, [http://www.westmidlandbirdclub.com/ladywalk/latest.htm news from its Ladywalk Reserve] and [http://www.westmidlandbirdclub.com/worcs/grimley/latest.htm news from Grimley Pits] — comments welcome on my talk page [[User:AndyMabbett|Andy Mabbett]]
* [http://pixelsebi.com pixelsebi's repository] uses hAtom 0.1 for blog posts (and hCard, hCalendar, XFN, xFolk and many more) based on manual WordPress template modifications
* [http://www.geekinthepark.co.uk Geek in the Park] uses hAtom for the comments. -- by [[User:Trovster|trovster]]
* [http://www.csarven.ca Sarven Capadisli] uses hAtom for the articles and comments -- by [[User:Csarven|csarven]]
* [http://www.fberriman.com fberriman.com] uses hAtom 0.1 for blog posts (WordPress loop) and hCard throughout -- by [[User:Phae|Frances Berriman]] (Also - [http://www.fberriman.com/?p=86 Implementing hAtom: The Entries Code])
* [http://www.capital.edu Capital University] uses hAtom 0.1 to mark up the feed of latest posts by student bloggers on its home page.
* [http://blog.davidjanes.com Ranting and Roaring] (David Janes)
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site -- by [[User:ChrisCasciano|Chris Casciano]]
* [http://sedna.spip.org/sedna/ Sedna RSS] (a feed aggregator based on SPIP, by Fil, IZO and others; GPLd sources are available at [http://zone.spip.org/trac/spip-zone/browser/_squelettes_/sedna SPIP-Zone])
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Sound Advice] (Benjamin Carlyle)
* [http://quotedprintable.com/pages/scribbish Scribbish] is a Typo theme which uses hAtom.
* [http://rbach.priv.at/hAtom2Atom/Changelog/ hAtom2Atom.xsl's Changelog] is published as hAtom and Atom.
* [http://federali.st/ federali.st]'s webbed Federalist Papers are each marked up in hAtom.
* [http://www.plaintxt.org/themes/sandbox/ Sandbox] is a theme for [http://wordpress.org/ WordPress] that uses hAtom.
** The theme is also available to accounts on the [http://wordpress.com/ <username>.wordpress.com] hosting service. The [http://blog.coworking.info Coworking] and [http://barcamp.wordpress.com BarCamp] blogs are examples of custom Sandbox themes.
* [http://www.whump.com/dropbox/Strangelove.zip Strangelove] is a modification of the default WordPress theme (Kubrick) with hAtom support.
** It points to the hAtom2Atom proxy service as the link for syndication feeds.
* All [http://www.plaintxt.org/themes/ plaintxt.org themes] for [http://wordpress.org/ WordPress] now use hAtom. The themes are also coded for hCard compliance. The themes, by name, are:
** [http://www.plaintxt.org/themes/barthelme/ Barthelme] (two-column, fluid), [http://www.plaintxt.org/themes/blogtxt/ blog.txt] (two- or three-column, elastic), [http://www.plaintxt.org/themes/plaintxtblog/ plaintxtBlog] (three-column, fluid), [http://www.plaintxt.org/themes/simplr/ Simplr] (one column, elastic), [http://www.plaintxt.org/themes/veryplaintxt/ veryplaintxt] (two column, fluid)
* [http://archgfx.net/blog/index.php/themes/disconnected/ Disconnected], a theme for WordPress, also incorporated hAtom with version 1.2
* [http://www.pats.ua.ac.be/courses PATS Courses], the PATS Research Group uses hAtom to mark up the latest course documents for some of their courses

===Examples with some problems===

Entries may be moved here if there's a problem with the way hAtom is used on the page concerned. If the page is yours, and you want to improve it, see the [[hatom-faq|hAtom FAQ]], or raise any queries on [[hatom-issues|hAtom Issues]] or [[mailing-lists#microformats-discuss|the mailing list]], where people will be happy to help you.

==== Pre 0.1 hAtom examples====
These pages conform to an older draft standard and need to be updated.

* [http://www.myelin.co.nz/post/ Second p0st] (Phil Pearson)

== Implementations ==

This section is '''informative'''.

The following implementations have been developed which either generate or parse hAtom links. If you have an hAtom 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://dichotomize.com/uf/hatom/creator.html hAtom Creator] modified from the other creators by BenWest.
* the [http://tools.blogmatrix.com/extract/ Almost Universal Microformat Parser] can extract hAtom content from webpages ([http://tools.blogmatrix.com/extract/?uri=http%3A%2F%2Fblog.davidjanes.com&microformat=hatom&submit=Submit example])
* the [http://www.trinityanne.com/tools/greasemonkey/microformat-action.user.js microformat-action] [[greasemonkey|Greasemonkey]] script detects hAtom content on webpages and will call the [http://tools.blogmatrix.com/extract/ Almost Universal Microformat Parser]
* [http://rbach.priv.at/hAtom2Atom/ hAtom2Atom.xsl] transforms hAtom to Atom (as the name suggests.)
* There is now an [http://www.lukearno.com/projects/hatom2atom/ hatom2atom proxy] that uses hAtom2Atom.xsl.
* [http://placenamehere.com/article/185/SubscribingTohAtomFeedsWithNetNewsWire Subscribe To hAtom] is a script that provides [http://ranchero.com/netnewswire/ NetNewsWire 2.x] users with the ability to subscribe to hAtom documents as they would any other feed. by [[User:ChrisCasciano|Chris Casciano]].
* [http://boxtheweb.mihopa.net/code/apis/#outlineclasses Outline Classes] - has GPL'ed PHP code for reading hAtom
* [http://boxtheweb.4x2.net/ BoxtheWeb] - supports subscribing to hAtom as a feed format

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://www.ietf.org/rfc/rfc4287 RFC4287: The Atom Syndication Format]
* [[hcard-parsing]]

=== Informative References ===
* [http://www.atomenabled.org/ atomenabled.org]

== Work in progress ==
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 hAtom:

* [[blog-post-brainstorming|blog-post Brainstorming]]

=== Version 0.1 ===

Version 0.1 was released 28 February 2006.

== Discussions ==

* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page].

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

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

==See Also==
{{hatom-related-pages}}
* [[rel-enclosure]] - how to semantically reference enclosures (e.g. podcasts) in hAtom
* [[blog-post-brainstorming]]
* [[blog-post-formats]]
* [[blog-post-examples]]
* [[blog-description-format]] - how to describe a blog (as opposed to the individual entries, which is what we're doing here)

hatom

2007-05-26T13:39:36Z

GuyLeech: /* Examples in the wild */

<h1> hAtom 0.1 </h1>

hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. hAtom is based on a subset of the [http://www.atomenabled.org/ Atom] syndication format. hAtom is one of several [[microformats]] open standards.

__TOC__
== Draft Specification ==

=== Editor/Author ===
* [http://blogmatrix.blogmatrix.com/ David Janes], [http://www.blogmatrix.com BlogMatrix, Inc.]

=== Contributors ===
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Benjamin Carlyle]
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]

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

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

== Introduction ==

hAtom is a [[microformat]] for identifying semantic information in weblog posts and practically any other place [http://www.atomenabled.org/ Atom] may be used, such as news articles. hAtom content is easily added to most blogs by simple modifications to the blog's template definitions.

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

== Format ==
=== In General ===
The [http://atomenabled.org/developers/syndication/#person Atom Syndication Format] provides the conceptual basis for this microformat, with the following caveats:

* Atom provides a lot more functionality than we need for a "blog post" microformat, so we've taken the minimal number of elements needed.
* the "logical" model of hAtom is that of Atom. If there is a conflict, Atom should be taken as correct.
* the "physical" model of hAtom -- the actual writing of elements -- is a lot more varied than Atom provides for, due to the variety of ways weblogs are actually produced in the wild. The hAtom microformat provides a number of rules for "bridging the gap"

=== Schema ===
Schema elements are based on the Atom nomenclature and follow the microformat pattern of prefixing a unique identifier (in this case, '<code>h</code>') on the outermost container elements -- the Feed or Entry. The parts of this microformat are based on analysis of many weblog, bulletin board and media posts and can be read [[blog-post-brainstorming#Discovered_Elements]].

The hAtom schema consists of the following:

* hfeed ('''<code>hfeed</code>'''). optional.
* hentry ('''<code>hentry</code>''').
** '''<code>entry-title</code>'''. required. text.
** '''<code>entry-content</code>'''. optional (see field description). text.
** '''<code>entry-summary</code>'''. optional. text.
** '''<code>updated</code>'''. required using [[datetime-design-pattern]].
** '''<code>published</code>'''. optional using [[datetime-design-pattern]].
** '''<code>author</code>'''. required using '''[[hcard|hCard]]'''.
** '''<code>bookmark</code>''' (permalink). optional, using '''[[rel-bookmark]]'''.
** tags. optional. keywords or phrases, using '''[[rel-tag]]'''.

Some required elements have defaults if missing, see below.

=== Field and Element Details ===

===== Feed =====
* a Feed element is identified by the class name <code>hfeed</code>
* a Feed element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.1 Atom feed]
* the Feed element is optional and, if missing, is assumed to be the page
* hAtom documents MAY have multiple Feed elements

===== Feed Category =====
* a Feed Category element is identified by [[rel-tag]]
* a Feed MAY have a Feed Category
* a Feed Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside a [http://www.atomenabled.org/developers/syndication/#optionalFeedElements feed]
* Feed Category elements MUST appear inside a Feed element but not inside an Entry element
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code>

===== Entry =====
* an Entry element is identified by class name <code>hentry</code>
* an Entry element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.2 Atom entry]
* any microformat content inside a <code><blockquote></code> or <code><q></code> element within the Entry should not be considered part of the Entry.
: ''This allows quoting other microformated data without worry of corrupting the model''

===== Entry Category =====
* an Entry Category element is identified by [[rel-tag]]
* an Entry MAY have an Entry Category
* an Entry Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside an [http://www.atomenabled.org/developers/syndication/#optionalEntryElements entry]
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code>

===== Entry Title =====
* an Entry Title element is identified by the class name <code>entry-title</code>
* an Entry SHOULD have an Entry Title
* an Entry Title element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.14 Atom entry title]
* if the Entry Title is missing, use
** the first <code><h#></code> element in the Entry, or
** the <code><title></code> of the page, if there is no enclosing Feed element, or
** assume it is the empty string

===== Entry Content =====
* an Entry Content element is identified by class name <code>entry-content</code>
* an Entry SHOULD have Entry Content
* an Entry Content element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#atomContent Atom content]
* an Entry MAY have 0 or more Entry Content elements. The "logical Entry Content" of an Entry is the concatenation, in order of appearance, of all the Entry Contents within the Entry
: ''Many weblogs split content into multiple sections with a "Read More" link and javascript tricks. This is also needed in cases where Entry Titles are coded inline and are considered part of the content.''
* if the Entry Content is missing, assume it is the empty string

===== Entry Summary =====
* an Entry Summary element is identified by class name <code>entry-summary</code>
* an Entry Summary element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.13 Atom summary]
* an Entry MAY have 0 or more Entry Summary elements. The "logical Entry Summary" of an Entry is the concatenation, in order of appearance, of all the Entry Summarys within the Entry

===== Entry Permalink =====
* an Entry Permalink element is identified by [[rel-bookmark]]
* an Entry SHOULD have an Entry Permalink
* an Entry Permalink element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.7 Atom link in an entry]
* if the Entry Permalink is missing, use the URI of the page; if the Entry has an "id" attribute, add that as a fragment to the page URI to distinguish individual entries

===== Entry Updated =====
* an Entry Updated element is identified by class name <code>updated</code>
* an Entry Updated element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.15 Atom updated]
* an Entry SHOULD have an Entry Updated element
* use the [[datetime-design-pattern]] to encode the updated datetime
* if there is no Entry Updated element,
** use the Entry Published element, if present
** otherwise the page is invalid hAtom

===== Entry Published =====
* an Entry Published element is identified by the class name <code>published</code>
* an Entry Published element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.9 Atom published]
* use the [[datetime-design-pattern]] to encode the published datetime

===== Entry Author =====
* an Entry Author element is represented by class name <code>author</code>
* an Entry Author element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.1 Atom author]
* an Entry Author element MUST be encoded in an [[hcard|hCard]]
* an Entry Author element SHOULD be encoded in an <code><address></code> element
* an Entry SHOULD have at least one Entry Author element
* an Entry MAY have more than one Entry Author elements
* if the Entry Author is missing
** find the [[algorithm-nearest-in-parent|Nearest In Parent]] <code><address></code> element(s) with class name <code>author</code> and that is/are a valid [[hcard|hCard]]
** otherwise the entry is invalid hAtom

=== XMDP Profile ===
<pre>
<dl class="profile">
<dt>class</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
HTML4 definition of the 'class' attribute.</a>
This meta data profile defines some 'class' attribute values (class names)
and their meanings as suggested by a
<a href="http://www.w3.org/TR/WD-htmllink-970328#profile">
draft of "Hypertext Links in HTML"</a>.
<dl>
<dt>hfeed</dt>
<dd>
The concept of atom:feed from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>hentry</dt>
<dd>
The concept of atom:entry from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>entry-title</dt>
<dd>
The concept of atom:title inside of an atom:entry from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>entry-content</dt>
<dd>
The concept of atom:content from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>entry-summary</dt>
<dd>
The concept of atom:summary from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>bookmark</dt>
<dd>
The concept of atom:link (without any "rel") with an atom:entry from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>published</dt>
<dd>
The concept of atom:published from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>updated</dt>
<dd>
The concept of atom:updated from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt>author</dt>
<dd>
The concept of atom:author from
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>,
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
</dl>
</dd>
</dl>
</pre>

== Examples ==

See [[hatom-examples]].

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

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

=== 0.1 hAtom examples===
* [http://guyleech.net guyleech.net] uses hAtom for blog posts, and uses hCard for contact information.
* [http://kpumuk.info/ Dmytro Shteflyuk] uses hAtom for all blog posts.
* [http://blog.no-panic.at Florian Beer] uses hAtom to mark up all the blog posts. There is also a [http://blog.no-panic.at/2006/11/16/hatom-and-wordpress/ tutorial] on how to convert Wordpress themes to include hAtom.
* [http://ficlets.com/ Ficlets] uses hAtom on the [http://ficlets.com/stories main stories page] and on [http://ficlets.com/stories/12 individual story pages].
* [http://www.international.unt.edu UNT International] uses hAtom combined with hCard on news/announcement pages (e.g., [http://www.international.unt.edu/quick/news the main news page]) in addition to providing traditional Atom feeds
* [http://www.absalom.net.au Absalom Media] uses hAtom combined with hCard for articles.
* [http://www.joomlamug.com Joomla! Melbourne User Group] uses hAtom combined with hCard for articles.
* [http://www.volume.co.uk Volume] - Main news page is marked up as hAtom 0.1
* [http://yedda.com Yedda] - Yedda support hAtom on exploration of questions where there is also support for Atom and RSS feeds. ([http://yedda.com/questions/recent/ example])
* The [http://www.westmidlandbirdclub.com/ West Midland Bird Club's] frequently-updated [http://www.westmidlandbirdclub.com/new.htm What's New] page, [http://www.westmidlandbirdclub.com/ladywalk/latest.htm news from its Ladywalk Reserve] and [http://www.westmidlandbirdclub.com/worcs/grimley/latest.htm news from Grimley Pits] — comments welcome on my talk page [[User:AndyMabbett|Andy Mabbett]]
* [http://pixelsebi.com pixelsebi's repository] uses hAtom 0.1 for blog posts (and hCard, hCalendar, XFN, xFolk and many more) based on manual WordPress template modifications
* [http://www.geekinthepark.co.uk Geek in the Park] uses hAtom for the comments. -- by [[User:Trovster|trovster]]
* [http://www.csarven.ca Sarven Capadisli] uses hAtom for the articles and comments -- by [[User:Csarven|csarven]]
* [http://www.fberriman.com fberriman.com] uses hAtom 0.1 for blog posts (WordPress loop) and hCard throughout -- by [[User:Phae|Frances Berriman]] (Also - [http://www.fberriman.com/?p=86 Implementing hAtom: The Entries Code])
* [http://www.capital.edu Capital University] uses hAtom 0.1 to mark up the feed of latest posts by student bloggers on its home page.
* [http://blog.davidjanes.com Ranting and Roaring] (David Janes)
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site -- by [[User:ChrisCasciano|Chris Casciano]]
* [http://sedna.spip.org/sedna/ Sedna RSS] (a feed aggregator based on SPIP, by Fil, IZO and others; GPLd sources are available at [http://zone.spip.org/trac/spip-zone/browser/_squelettes_/sedna SPIP-Zone])
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Sound Advice] (Benjamin Carlyle)
* [http://quotedprintable.com/pages/scribbish Scribbish] is a Typo theme which uses hAtom.
* [http://rbach.priv.at/hAtom2Atom/Changelog/ hAtom2Atom.xsl's Changelog] is published as hAtom and Atom.
* [http://federali.st/ federali.st]'s webbed Federalist Papers are each marked up in hAtom.
* [http://www.plaintxt.org/themes/sandbox/ Sandbox] is a theme for [http://wordpress.org/ WordPress] that uses hAtom.
** The theme is also available to accounts on the [http://wordpress.com/ <username>.wordpress.com] hosting service. The [http://blog.coworking.info Coworking] and [http://barcamp.wordpress.com BarCamp] blogs are examples of custom Sandbox themes.
* [http://www.whump.com/dropbox/Strangelove.zip Strangelove] is a modification of the default WordPress theme (Kubrick) with hAtom support.
** It points to the hAtom2Atom proxy service as the link for syndication feeds.
* All [http://www.plaintxt.org/themes/ plaintxt.org themes] for [http://wordpress.org/ WordPress] now use hAtom. The themes are also coded for hCard compliance. The themes, by name, are:
** [http://www.plaintxt.org/themes/barthelme/ Barthelme] (two-column, fluid), [http://www.plaintxt.org/themes/blogtxt/ blog.txt] (two- or three-column, elastic), [http://www.plaintxt.org/themes/plaintxtblog/ plaintxtBlog] (three-column, fluid), [http://www.plaintxt.org/themes/simplr/ Simplr] (one column, elastic), [http://www.plaintxt.org/themes/veryplaintxt/ veryplaintxt] (two column, fluid)
* [http://archgfx.net/blog/index.php/themes/disconnected/ Disconnected], a theme for WordPress, also incorporated hAtom with version 1.2
* [http://www.pats.ua.ac.be/courses PATS Courses], the PATS Research Group uses hAtom to mark up the latest course documents for some of their courses

===Examples with some problems===

Entries may be moved here if there's a problem with the way hAtom is used on the page concerned. If the page is yours, and you want to improve it, see the [[hatom-faq|hAtom FAQ]], or raise any queries on [[hatom-issues|hAtom Issues]] or [[mailing-lists#microformats-discuss|the mailing list]], where people will be happy to help you.

==== Pre 0.1 hAtom examples====
These pages conform to an older draft standard and need to be updated.

* [http://www.myelin.co.nz/post/ Second p0st] (Phil Pearson)

== Implementations ==

This section is '''informative'''.

The following implementations have been developed which either generate or parse hAtom links. If you have an hAtom 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://dichotomize.com/uf/hatom/creator.html hAtom Creator] modified from the other creators by BenWest.
* the [http://tools.blogmatrix.com/extract/ Almost Universal Microformat Parser] can extract hAtom content from webpages ([http://tools.blogmatrix.com/extract/?uri=http%3A%2F%2Fblog.davidjanes.com&microformat=hatom&submit=Submit example])
* the [http://www.trinityanne.com/tools/greasemonkey/microformat-action.user.js microformat-action] [[greasemonkey|Greasemonkey]] script detects hAtom content on webpages and will call the [http://tools.blogmatrix.com/extract/ Almost Universal Microformat Parser]
* [http://rbach.priv.at/hAtom2Atom/ hAtom2Atom.xsl] transforms hAtom to Atom (as the name suggests.)
* There is now an [http://www.lukearno.com/projects/hatom2atom/ hatom2atom proxy] that uses hAtom2Atom.xsl.
* [http://placenamehere.com/article/185/SubscribingTohAtomFeedsWithNetNewsWire Subscribe To hAtom] is a script that provides [http://ranchero.com/netnewswire/ NetNewsWire 2.x] users with the ability to subscribe to hAtom documents as they would any other feed. by [[User:ChrisCasciano|Chris Casciano]].
* [http://boxtheweb.mihopa.net/code/apis/#outlineclasses Outline Classes] - has GPL'ed PHP code for reading hAtom
* [http://boxtheweb.4x2.net/ BoxtheWeb] - supports subscribing to hAtom as a feed format

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://www.ietf.org/rfc/rfc4287 RFC4287: The Atom Syndication Format]
* [[hcard-parsing]]

=== Informative References ===
* [http://www.atomenabled.org/ atomenabled.org]

== Work in progress ==
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 hAtom:

* [[blog-post-brainstorming|blog-post Brainstorming]]

=== Version 0.1 ===

Version 0.1 was released 28 February 2006.

== Discussions ==

* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page].

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

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

==See Also==
{{hatom-related-pages}}
* [[rel-enclosure]] - how to semantically reference enclosures (e.g. podcasts) in hAtom
* [[blog-post-brainstorming]]
* [[blog-post-formats]]
* [[blog-post-examples]]
* [[blog-description-format]] - how to describe a blog (as opposed to the individual entries, which is what we're doing here)

xoxo

2007-04-11T12:02:42Z

GuyLeech: /* More Simple Examples */

<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__

== Draft 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".
*** The CSS selector for "an li node that contains an ol node with a 'compact' attribute set" would be 'li ol[compact="compact"]'.

== 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 class='xoxo'>
<li>
<dl>
<dt>text</dt>
<dd>item 1</dd>
<dt>description</dt>
<dd> This item represents the main point we're trying to make.</dd>
<dt>url</dt>
<dd>http://example.com/more.xoxo</dd>
<dt>title</dt>
<dd>title of item 1</dd>
<dt>type</dt>
<dd>text/xml</dd>
<dt>rel</dt>
<dd>help</dd>
</dl>
</li>
</nowiki></pre>

However, by taking advantage of the semantic <code><a href></code> element, we are able to dramatically simplify the common cases that utilize these properties. From a parser's perspective, this applies to the first <code><a href></code> element directly inside the <code><nowiki><li></nowiki></code>.

Actual XOXO Example:

<pre><nowiki>
<ol class='xoxo'>
<li><a href="http://example.com/more.xoxo"
title="title of item 1"
type="text/xml"
rel="help">item 1</a>

<dl>
<dt>description</dt>
<dd>This item represents the main point we're trying to make.</dd>
</dl>
</li>
</nowiki></pre>

Any other properties are simply added to the definition list in the same way as the "description" property.

== Publishing XOXO ==

XOXO may be published in two forms, valid XHTML, and simple well-formed XML.

=== Valid XHTML XOXO ===

A valid XHTML XOXO page is a complete XHTML document.

<pre><nowiki>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>XOXO page</title>
</head>
<body>
<ol class="xoxo">
<li><a href="URL-one">TEXT-one</a></li>
<li><a href="URL-two">TEXT-two</a></li>
...
</ol>
</body>
</html>
</nowiki></pre>

==== Content-Type ====

Valid XHTML XOXO SHOULD be served with this Content-Type header for maximum browser compatibility.

<pre><nowiki>
Content-Type: text/html; charset=utf-8
</nowiki></pre>

It MUST be served with one of these Content-Type headers:

<pre><nowiki>
Content-Type: text/html; charset=utf-8
Content-Type: application/xhtml+xml
</nowiki></pre>

=== Simple well-formed XML XOXO ===

The root element of a simple well-formed XML XOXO page is either an <code>ol</code> or <code>ul</code> with class name of "xoxo". This variant is ideal for syndication and transclusion into (X)HTML pages with [[rest/ahah|AHAH]].

<pre><nowiki>
<ol class="xoxo">
<li><a href="URL-one">TEXT-one</a></li>
<li><a href="URL-two">TEXT-two</a></li>
...
</ol>
</nowiki></pre>

==== Content-Type ====

Simple well-formed XML XOXO SHOULD be served with this Content-Type header:
<pre><nowiki>
Content-Type: text/xml; charset=utf-8
</nowiki></pre>

It MUST be served with one of these Content-Type headers:

<pre><nowiki>
Content-Type: text/xml; charset=utf-8
Content-Type: application/xml
Content-Type: application/xml; charset=utf-8
</nowiki></pre>

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

There are many wild examples. Nearly every blogroll on the Web can be parsed as XOXO, since they are typically an unordered list of list items of hyperlinks, which is within the XOXO profile. List examples here, when the list becomes too long we can move to a dedicated page.

* [http://api.talis.com/bf/stores/ukbib/services/facet?query=feynman&fields=title%2Csubject&top=10&output=html HTML output from a faceting service for book data]

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

* [http://chneukirchen.org/blog/ Christian Neukirchen] has [http://chneukirchen.org/blog/archive/2006/01/xoxo-rb-0-1-released.html written a xoxo.rb, a XOXO parser and generator for Ruby]
* [http://odeo.com Odeo] publishes users' subscription lists in XOXO. See Ryan King's list [http://odeo.com/profile/RyanKing/xoxo here].
* [http://www.decafbad.com/blog/ Les Orchard] has [http://www.decafbad.com/blog/2005/07/12/xoxo_outliner_experiment written] a [http://www.decafbad.com/2005/07/map-test/tree2.html nice XOXO outline editor in javascript].
* http://homepage.mac.com/ctholland/thelab/outlines/ is a great demonstration of dynamic interactive XOXO with use of "compact" and DHTML to collapse/expand.
* http://tool-man.org/examples/sorting.html is a great demonstration of drag and drop sortable XOXO lists with javascript and CSS.
* http://www.opendarwin.org/~drernie/xoxo-datatypes.html Mapping XOXO to [http://developer.apple.com/documentation/Cocoa/Conceptual/PropertyLists/Concepts/XMLPListsConcept.html Mac OS X property lists]
* [http://weblog.techno-weenie.net/2005/9/30/if_i_had_a_tumblelog single line of rails to convert XOXO to HTML]

=== Sample Code ===

* See the [[xoxo-sample-code]] page for open source sample code to read and write XOXO files.
* See also the [[xoxo-compact-sample]] page with source for CSS and JS that alters the look and feel of some very plain XOXO to have twiddlable triangles for nested lists that respect the compact attribute as well.

== XOXO Schemas ==
This section is informative.

Note: these may be out of date and require updating to reflect the use of <dl> for annotating XOXO items with arbitrary properties.
* [[DTDs]]
* [http://www.nidelven-it.no/projects/XOXO/xoxo-0.1.tgz Schemas (Relax NG and DTDs)]

== References ==
=== Normative References ===
* [http://www.w3.org/TR/xhtml1 XHTML 1.0]
* [http://www.w3.org/TR/xhtml-modularization XHTMLMOD]
* [http://gmpg.org/xmdp/ XMDP]
* [http://gmpg.org/xfn/ XFN]

=== Informative References ===
This section is '''informative'''.
* [http://developers.technorati.com/wiki/attentionxml Attention.xml]
* [[VoteLinks]]
* [http://www.w3.org/TR/xhtml11 XHTML 1.1]
* [http://opml.scripting.com/spec OPML 1.0]
* Contributed from http://developers.technorati.com/wiki/XOXO

=== Similar Work ===
* [http://dannyayers.com/archives/001961.html XHTML Outlines] - DannyAyers independently came up with idea in 2003 October (just a month or two before Kevin and Tantek independently came up with XOXO) to use a simple profile of XHTML to semantically represent outlines using existing building blocks from XHTML.
* [http://semtext.org/2004-02/ XOW] - making them editable, producing RDF and bookmark lists from them (DannyAyers)

=== Related Reading ===
* [http://patricklogan.blogspot.com/2005/08/lists-really-can-we-expect-better.html Patrick Logan on why OPML and a Microsoft Lists extension are both unnecessary].
* [http://raybenchen.blogspot.com/2005/11/is-crappy-format-worth-saving.html Dr. Tao Chen on why it is better to use XOXO than OPML going forward]

=== Unrelated Reading ===
* [http://www.questionablecontent.net/view.php?comic=493 Questionable Content comic #493] - apparently the Faye character is a fan of XOXO.

=== Promotional Materials / Schwag ===
* There is an entire XOXO clothing and accessories line. [http://www.xoxo.com/home.php Buy XOXO stuff online].

== 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 XOXO:

* See [[xoxo-brainstorming]] for additional thoughts on how to use XOXO for specific uses.
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
** [http://blogxoxo.blogspot.com/ XOXO Blog]

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

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