hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. This page gives hints on how to use, implement and embed hAtom, backgrounders and other information closely related to the hAtom spec but that doesn't strictly belong on the main page.
If there's a conflict between this page and the spec, the spec is correct.
This page is currently out-of-date. Consult the accordant microformat specification for up-to-date information.
Note: Please see the hatom-issues document for discussion on property names.
|Concept||Atom Identifier||hAtom Microformat Usage|
|Feed|| || Add class name |
|Entry|| || Add class name |
|Entry Title|| || Add class name |
|Entry Content|| || Add class name |
|Entry Summary|| || Add class name |
|Entry Permalink|| || Add a rel value of |
|Entry Published|| || Use class name |
|Entry Updated|| || Use class name|
|Entry Author|| || Add class name |
|Concept||Nests In||hAtom Opaque||Cardinality|| Logical Cardinality|
|Entry Title|| Entry|
|Entry Permalink|| Entry|
|Entry Published|| Entry|
|Entry Updated|| Entry|
"hAtom Opaque" specifies whether a hAtom parser should not "look inside" the element for further hAtom content. If there are multiple rules applied to the same element take the OR of the two (i.e. "Yes/Opaque" always wins)
- hAtom Opaque is designed to make parsing rules less ambiguous. In particular, it allows "quoted" hAtom elements (from another blog being blockquoted, for example) ti be ignored. It also allows 'embedded' hAtom to be potentially delivered within hAtom itself, and to prevent accidental 'leaking' of other microformat information up into the hAtom container. A general concept of opaqueness (need link) has also been proposed but it will complement, not replace this.
How many times can an element of the given type appear in it's nesting/parent element.
This column is informative -- Atom has a number of rules for deciding what is required depending on the context and other elements, many which aren't strictly applicable to here.
From a modeling/logical perspective, the number of times can an element appear.
- This is all rule dependent, see below. For example, an Entry Permalink may appear 6 times, but each one must be the same value; an Entry Content element may appear 3 times, but they are all concatenated together to make a single logical element.
- you could have multiple feeds on news pages, or weblogs with "mini-blogs" on the sidebar.
- class="hfeed hentry" is OK for feeds with a single entry.
- Entry Permalinks SHOULD be the same as the
rss:link) used in syndication feeds
- The intention of the previous two rules to gently force people to use strings that can be byte compared for equivalence. In general, the canonical URI should be the link used in an Atom entry.
- if an Entry has multiple elements marked as the Entry Permalink, they MUST have exactly the same URI
- h-entry - latest markup spec for Atom entries in HTML
- h-feed - brainstorm/experiment for feeds in HTML
- hAtom - the draft proposal.
- hAtom Cheatsheet - hAtom properties.
- hAtom Examples, in the Wild
- hAtom Hints - help for implementors.
- hAtom Issues - problems? complaints? ideas? Put them here.
- hatom-brainstorming - active work on iterations toward the next version of hAtom
- hAtom FAQ - knowledge base.
- hAtom advocacy - encourage others to use hAtom.