hatom

2005-10-29T09:20:26Z

Allergie: /* Entry */

= hAtom =

hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. hAtom is a strongly based on a subset of the [http://www.atomenabled.org/ Atom] syndication format; every concept in hAtom has a corresponding definition in Atom.

NOTE: the structure is in the process of being constructed, please give me a few days to get it in shape! [[DavidJanes]]

__TOC__

== Draft Specification ==

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

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

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

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

== Introduction ==

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

== Format ==
=== In General ===

=== Schema ===
Schema elements are based on the Atom nomenclature and follow the microformat pattern of prefixing a unique identifier (in this case, <code>atom</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]]. Note the renaming of 'EntryGroup' to 'Feed' to be more consistent with Atom ternminology.

==== Nomenclature ====

{| width="100%" border="1" cellspacing="0"
|-
! width="150" | Concept
! Atom Identifier
! hAtom Microformat Usage
|-
| Feed
| <code>atom:feed</code>
| add <code>class="atomfeed"</code>; OR implicit in the XHTML page
|-
| Feed Title
| <code>atom:title</code>
| ''Not defined in the first iteration of this proposal.''
|-
| Feed Permalink
| <code>atom:link@rel=alternate</code>
| ''Not defined in the first iteration of this proposal.''
|-
| Entry
| <code>atom:entry</code>
| Add <code>class="atomentry"</code>; if practical, also define <code>id="unique-identifier"</code> to the Entry.
|-
| Entry Title
| <code>atom:title</code>
| Use <code><h#></code> in block elements; OR non-preferentially add <code>class="title"</code> in inline elements.
|-
| Entry Content
| <code>atom:content</code>
| Add <code>class="content"</code> to all appropriate blocks. Multiple Entry Content blocks are logically considered one concatenated <code>atom:content</code> equivalent.
|-
| Entry Summary
| <code>atom:summary</code>
| Add <code>class="summary"</code> to all appropriate blocks. Multiple Entry Summary blocks are logically considered one concatenated <code>atom:summary</code> equivalent.
|-
| Entry Permalink
| <code>atom:link</code>
| Add <code>rel="bookmark"</code>.
|-
| Entry Published
| <code>atom:published</code>
| Use <code><abbr class="published" title="YYYYMMYYThh:mm:ss"></code>...<code></abbr></code>, following the [[datetime-design-pattern]].
|-
| Entry Author
| <code>atom:author</code>
| Use <code><address class="vcard"></code>...<code></address></code>
|}

==== Nesting Rules ====

{| width="100%" border="1" cellspacing="0"
|-
! width="150" | Concept
! Nests In
! Cardinality
! Notes
|-
| Feed
|-
| Feed Title
|-
| Feed Permalink
|-
| Entry
|-
| Entry Title
|-
| Entry Content
|-
| Entry Summary
|-
| Entry Permalink
|-
| Entry Published
|-
| Entry Author
|}

==== Disambiguation ====

==== Rules and Definitions ====
===== Feed =====
* an XHTML Feed element is identified by <code>class="atomfeed"</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]
: ''In particular, as a container for Entrys.''
* hAtom documents SHOULD enclose Entrys in a Feed element
: ''If there is no enclosing Feed element, context is assumed from the document itself and its header.''
* hAtom documents MAY have multiple, non-nested Feed elements
: ''This may happen on news pages, or weblogs with "mini-blogs" on the sidebar.''

===== Feed Title =====
''Not defined in the first iteration of this proposal.''

===== Feed Permalink =====
''Not defined in the first iteration of this proposal.''

===== Entry =====
* an Entry element is identified by <code>class="atomentry"</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]
* a weblog entry MUST be enclosed in a single Entry element
: ''That's what it's for, after all.''
* Entrys MUST NOT be nested
: ''See [[#Disabmiguation]] and [[#Entry_Content]] for more details.''
* Entrys MUST NOT belong to more than one Feed element
: ''That is, an Entry belongs to 0 or 1 Feeds.''

===== Entry Title =====
* an Entry Title element is identified <code><h#></code> in block elements OR non-preferentially <code>class="title"</code> in inline elements
* 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]
* an Entry MUST have exactly 0 or 1 Entry Titles
: ''We need to add disambiguation rules, since obviously multiple <code><h#></code> items could appear. But logically speaking there can be at most one.''

===== Entry Content =====
* an Entry Content element is identified by <code>class="content"</code>
* 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
: ''We recognize this varies from the Atom spec: see the next rule.''
* 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.''
* the "logical Entry Content" MUST be complete; that is, be the entire content of the Entry
: ''Otherwise it should be marked as Entry Summary.''
* XHTML elements within Entry Content are '''entirely opaque''' to this microformat
: ''That is, if hAtom elements are within the Entry Content, ignore them. This allows hAtom to be transported within itself. (!)''

===== Entry Summary =====
* an Entry Summary element is identified by <code>class="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
: ''We recognize this varies from the Atom spec: see the next rule.''
* the "logical Entry Summary" of an Entry is the concatenation, in order of appearance, of all the Entry Summarys within the Entry
* the "logical Entry Summary" may differ in different copies of the Entry
: ''There is the major difference with Entry Content. We can summarize an Entry in different way in different places with no requirement for consistency. There may be issues with this for modelers: if so, take it up in [[hatom-issues]].''

===== Entry Permalink =====
IN PROGRESS OF BEING WRITTEN

* an XHTML Entry Permalink element is identified by <code>rel="bookmark"</code>
: ''We recognize that we have broken from Atom terminology at this point. See [[hatom-issues]] for discussion.''
* a 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]

===== Entry Published =====
IN PROGRESS OF BEING WRITTEN

* an XHTML Entry Published element is identified by <code>class="posted"</code>
* a Entry Published element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.9 atom published]

===== Entry Author =====
IN PROGRESS OF BEING WRITTEN

* an Entry Author element is identified by <code>class="xxx"</code>
* a 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]

=== XMDP Profile ===

=== Parsing Details ===

== Examples ==

This section is informative.

=== Transformation 1 ===

A well behaved weblog.

Original:

<pre><nowiki>
<body>
<div id="wrap">
<div id="content">
...
<div class="entry">
<h3 id="post-60">
<a href="http://www.microformats.org/blog/..." rel="bookmark" title="...">Wiki Attack</a>
</h3>
<p>We had a bit of trouble with ...</p>
<p>We’ve restored the wiki and ...</p>
<p>If anyone is working to combat said spammers ...</p>

<h4 class="tags">Technorati Tags:</h4>
<ul class="tags">
<li><a href="http://technorati.com/tag/mediawiki" rel="tag">mediawiki</a></li>
<li><a href="http://technorati.com/tag/microformats" rel="tag">microformats</a></li>
<li><a href="http://technorati.com/tag/spam" rel="tag">spam</a></li>
</ul>

<ul class="post-info">
<li>
<a href="http://www.microformats.org/blog/..." rel="bookmark" title="...">October 10th, 2005</a>
</li>
<li>
<address class="vcard"><a class="url fn" href="http://theryanking.com">Ryan King</a></address>
</li>
<li>
<a href="http://www.microformats.org/blog/...">4 Comments</a>
</li>
</ul>
</div>

<div class="entry">
....
</div>
...
</div>
</div>
</body>
</nowiki></pre>

Transformed to hAtom compliant (shown in UPPER CASE for visibility only):

<pre><nowiki>
<body>
<div id="wrap">
<div id="ATOMFEED content">
...
<div class="ATOMENTRY entry" ID="post-60">
<h3>
<a href="http://www.microformats.org/blog/..." rel="LINK bookmark" title="...">Wiki Attack</a>
</h3>
<DIV CLASS="CONTENT">
<p>We had a bit of trouble with ...</p>
<p>We’ve restored the wiki and ...</p>
<p>If anyone is working to combat said spammers ...</p>
</DIV>

<h4 class="tags">Technorati Tags:</h4>
<ul class="tags">
<li><a href="http://technorati.com/tag/mediawiki" rel="tag">mediawiki</a></li>
<li><a href="http://technorati.com/tag/microformats" rel="tag">microformats</a></li>
<li><a href="http://technorati.com/tag/spam" rel="tag">spam</a></li>
</ul>

<ul class="post-info">
<li>
<a href="http://www.microformats.org/blog/..." rel="LINK bookmark"
title="..."><ABBR CLASS="POSTED" TITLE="20051010T14:07:00-0700">October 10th, 2005</ABBR></a>
</li>
<li>
<address class="vcard"><a class="url fn" href="http://theryanking.com">Ryan King</a></address>
</li>
<li>
<a href="http://www.microformats.org/blog/...">4 Comments</a>
</li>
</ul>
</div>

<div class="entry entry" ID="post-59">
....
</div>
...
</div>
</div>
</body>
</nowiki></pre>

Changes:
* Added <code>class="feed"</code> to Feed
* Added <code>class="entry"</code> to each Entry
* Moved <code>id="###"</code> from <code><h3></code> to Entry
* Added <code>rel="link"</code> to all Entry Permalinks
* Added <code><div class="content"></code>...<code></div></code> around the Entry Content
* Added <code><abbr class="posted" title="YYYYMMDDThh:mm:ss+ZZZZ"></code>...<code></abbr></code> around the Entry Datetime

Also note:
* We did not need to add a <code><address></code> element
* We did not need to add a <code><h#></code> element

=== Transformation 2 ===

A not-so well behaved weblog (an older blogspot weblog)

Original:

<pre><nowiki>
<body bgcolor="...">

<div class="posts">
<a name="112993192128302715"> </a><br>
<div style="clear:both;"></div><strong>Nelson's final prayer</strong>
written on the night before Trafalgar:<blockquote>May the Great God, ... heart.
<div style="clear:both; padding-bottom: 0.25em;"></div>
<br>
<span class="byline">
posted by Natalie at
<a href="2005_10_16_nataliesolent_archive.html#112993192128302715">9:49 PM</a>
</span>
</div>

<div class="posts">
<a name="112993022840118939"> </a>
<br>
<div style="clear:both;"></div><strong>I really, truly </strong>didn't go ... view.
<div style="clear:both; padding-bottom: 0.25em;"></div>
<br>
<span class="byline">
posted by Natalie at
<a href="2005_10_16_nataliesolent_archive.html#112993022840118939">9:28 PM</a>
</span>
</div>
...

</body>
</nowiki></pre>

Transformed to hAtom compliant (shown in UPPER CASE for visibility only):

<pre><nowiki>
<body bgcolor="...">

<DIV CLASS="ATOMFEED">
<div class="ATOMENTRY posts" ID="112993192128302715">
<strong CLASS="TITLE CONTENT">
Nelson's final prayer
</strong>
<SPAN CLASS="CONTENT">
written on the night before Trafalgar:<blockquote>May the Great God, ... heart.
</SPAN>
<DIV>
<span class="byline">posted by <address>Natalie</address> at
<a REL="LINK" href="HTTP://NATALIESOLENT.BLOGSPOT.COM/2005_10_16_nataliesolent_archive.html#112993192128302715">
<ABBR CLASS="POSTED" TITLE="20051024T094900-0000">9:49 PM</ABBR></a>
</span>
</DIV>
</div>

<div class="entry posts" ID="112993022840118939">
<strong CLASS="TITLE CONTENT">I really, truly </strong>
<SPAN CLASS="CONTENT">
didn't go ... view.
</SPAN>
<DIV>
<span class="byline">
posted by <address>Natalie</address> at
<a REL="LINK" href="HTTP://NATALIESOLENT.BLOGSPOT.COM/2005_10_16_nataliesolent_archive.html#112993022840118939">
<ABBR CLASS="POSTED" TITLE="20051024T094900-0000">9:28 PM</ABBR></a>
</span>
</DIV>
</div>
...
</DIV>

</body>
</nowiki></pre>

Changes:
* Added <code>class="feed"</code> to Feed
* Added <code>class="entry"</code> to each Entry
* Moved <code>id="###"</code> up to the Entry (and deleted the empty anchor block)
* Added <code>rel="link"</code> to the Entry Permalinks
* Made the Entry Permalink non-relative
* Added <code><span class="title"></code>...<code></div></code> around the Entry Title
* Added <code><span class="content"></code>...<code></div></code> around the Entry Title (!)
* Added <code><span class="content"></code>...<code></div></code> around the Entry Content
* Added <code><abbr class="posted" title="YYYYMMDDThh:mm:ss+ZZZZ"></code>...<code></abbr></code> around the Entry Datetime
* Added <code><address></code> to the poster's name

Also note:
* there are multiple content blocks, because Natalie Solent embeds the title in the content
* cleaned up lots of crap HTML presentation stuff, with the assumption it would be fixed in the stylesheet
* this is one of the uglier transformations you're likely to see

=== Transformation 3 ===

A media page.

Original:

<pre><nowiki>
</nowiki></pre>

Transformed to hAtom compliant:

<pre><nowiki>
</nowiki></pre>

Changes:
*

=== Transformation 4 ===

A bulletin board ([http://forums.punbb.org/viewtopic.php?id=9135 PunBB])

Original:

<pre><nowiki>
<body>
<div id="punwrap">
<div id="punviewtopic" class="pun">

<div id="brdheader" class="block">
... header stuff ...
</div>

<div id="announce" class="block">
... announcement stuff ...
</div>

<div class="linkst">
... controls for the blog
</div>

<div id="p54390" class="blockpost rowodd firstpost">
<h2>
<span><span class="conr">#1 </span>
<a href="viewtopic.php?pid=54390#p54390">2005-10-16 10:36:24</a></span>
</h2>
<div class="box">
<div class="inbox">
<div class="postleft">
<dl>
<dt><strong><a href="profile.php?id=2">Rickard</a></strong></dt>

<dd class="usertitle"><strong>PunBB Developer</strong></dd>
<dd class="postavatar"><img src="img/avatars/2.png" width="60" height="60" alt="" /></dd>
<dd>From: 127.0.0.1</dd>
<dd>Registered: 2001-11-02</dd>
<dd>Posts: 7806</dd>
<dd class="usercontacts"><a href="http://www.punbb.org/">Website</a></dd>

</dl>
</div>
<div class="postright">
<h3>PunBB 1.2.9</h3>
<div class="postmsg">
<p>Just a quick note this time....</p>

</div>
<div class="postsignature"><hr />"Programming is like sex: ...</div>
</div>
<div class="clearer"></div>
<div class="postfootleft"><p>Offline</p></div>
<div class="postfootright"><div> </div></div>
</div>
</div>

</div>

<div id="p54392" class="blockpost roweven">
<h2><span><span class="conr">#2 </span><a href="viewtopic.php?pid=54392#p54392">2005-10-16 10:54:41</a></span></h2>
<div class="box">
<div class="inbox">
<div class="postleft">
<dl>
<dt><strong><a href="profile.php?id=5298">IdleFire</a></strong></dt>

<dd class="usertitle"><strong>Member</strong></dd>
<dd class="postavatar"></dd>
<dd>Registered: 2005-10-14</dd>
<dd>Posts: 27</dd>
</dl>
</div>
<div class="postright">

<h3> Re: PunBB 1.2.9</h3>
<div class="postmsg">
<p>...</p>
</div>
</div>
<div class="clearer"></div>
<div class="postfootleft"><p>Offline</p></div>

<div class="postfootright"><div> </div></div>
</div>
</div>
</div>

... more entries ...

<div id="brdfooter" class="block">
... footer stuff ...
</div>

</div>
</div>
</body>
</nowiki></pre>

Transformed to hAtom compliant (changes shown in UPPER CASE for visibility only):

<pre><nowiki>
<body>
<div id="punwrap">
<div id="punviewtopic" class="pun">

<div id="brdheader" class="block">
... header stuff ...
</div>

<div id="announce" class="block">
... announcement stuff ...
</div>

<div class="linkst">
... controls for the blog
</div>

<div id="p54390" class="ATOMENTRY blockpost rowodd firstpost">
<h2>
<span><span class="conr">#1 </span>
<a REL="BOOKMARK" href="HTTP://FORUMS.PUNBB.ORG/viewtopic.php?pid=54390#p54390">
<ABBR CLASS="POSTED" TITLE="20051016T103624-0500">2005-10-16 10:36:24</ABBR>
</a></span>
</h2>
<div class="box">
<div class="inbox">
<div class="postleft">
<dl>
<dt><strong><ADDRESS><a href="profile.php?id=2">Rickard</a></ADDRESS></strong></dt>

<dd class="usertitle"><strong>PunBB Developer</strong></dd>
<dd class="postavatar"><img src="img/avatars/2.png" width="60" height="60" alt="" /></dd>
<dd>From: 127.0.0.1</dd>
<dd>Registered: 2001-11-02</dd>
<dd>Posts: 7806</dd>
<dd class="usercontacts"><a href="http://www.punbb.org/">Website</a></dd>

</dl>
</div>
<div class="postright">
<h3>PunBB 1.2.9</h3>
<div class="CONTENT postmsg">
<p>Just a quick note this time....</p>

</div>
<div class="postsignature"><hr />"Programming is like sex: ...</div>
</div>
<div class="clearer"></div>
<div class="postfootleft"><p>Offline</p></div>
<div class="postfootright"><div> </div></div>
</div>
</div>

</div>

<div id="p54392" class="ATOMENTRY blockpost roweven">
<h2>
<span><span class="conr">#2 </span>
<a REL="BOOKMARK" href="HTTP://FORUMS.PUNBB.ORG/viewtopic.php?pid=54392#p54392">
<ABBR CLASS="POSTED" TITLE="20051016T1105441-0500">2005-10-16 10:54:41</ABBR>
</a></span>
</h2>
<div class="box">
<div class="inbox">
<div class="postleft">
<dl>
<dt><strong><ADDRESS><a href="profile.php?id=5298">IdleFire</a></ADDRESS></strong></dt>

<dd class="usertitle"><strong>Member</strong></dd>
<dd class="postavatar"></dd>
<dd>Registered: 2005-10-14</dd>
<dd>Posts: 27</dd>
</dl>
</div>
<div class="postright">

<h3> Re: PunBB 1.2.9</h3>
<div class="CONTENT postmsg">
<p>...</p>
</div>
</div>
<div class="clearer"></div>
<div class="postfootleft"><p>Offline</p></div>

<div class="postfootright"><div> </div></div>
</div>
</div>
</div>

... more entries ...

<div id="brdfooter" class="block">
... footer stuff ...
</div>

</div>
</div>
</body>
</nowiki></pre>

Changes:
*

Notes:
*

Questions:
* should the <code>address</code> enclose the entire author block?

=== More Examples ===

See [[hatom-examples]].

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

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

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://www.atomenabled.org/ Atom]

=== Informative References ===

==== Specifications That Use hAtom ====

==== Similar Work ====

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

== 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 [[htom-issues|hAtom issues]] document.

==See Also==
* [[hatom|hAtom]] - the draft proposal
* [[hatom-issues]] - problems? complaints? ideas? Put them here
* [[hatom-faq]] - knowledge base
* [[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)

Microformats Wiki - User contributions [en]

hatom