hatom: Difference between revisions

This document represents a draft microformat specification. Although drafts are somewhat mature in the development process, the stability of this document cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Watch this wiki page, or follow discussions on the #microformats IRC channel to stay up-to-date.

hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. hAtom is based on a subset of the Atom syndication format. hAtom will be one of several microformats open standards.

Draft Specification

Contributors

Benjamin Carlyle

Tantek Çelik (http://tantek.com/ and before at Technorati, Inc.)

copyright and patents statements apply.

Status

hAtom 0.1 is a microformats.org draft specification. Public discussion on hAtom takes place on hatom-feedback, the #microformats irc channel on irc.freenode.net, and microformats-discuss mailing list.

Available languages

The English version of this specification is the only normative version. For translations of this document see the #translations section.

Errata and Updates

Known errors and issues in this specification are corrected in resolved and closed issues. Please check there before reporting issues.

The hAtom 0.2 update is currently under development and incorporates known errata corrections as well as the value-class-pattern.

Introduction

hAtom is a microformat for identifying semantic information in weblog posts and practically any other place 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.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Example

Here is a simple blog post example:

<article class="hentry">
 <h1 class="entry-title">Microformats are amazing</h1>
 <p>Published by <span class="author vcard"><span class="fn">W. Developer</span></span>
 on <time class="published" datetime="2013年06月13日 12:00:00">13<sup>th</sup> June 2013</time></p>
 
 <p class="entry-summary">In which I extoll the virtues of using microformats.</p>
 
 <div class="entry-content">
 <p>Blah blah blah</p>
 </div>
</article>

Get started

The class hentry is a root class name that indicates the presence of an hAtom entry.

entry-title, author, published, entry-summary, entry-content and the other hAtom property classnames listed below define properties of the entry.

Format

In General

The 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, 'h') 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 (hfeed). optional.
  • feed category. optional. keywords or phrases, using rel-tag .
  • hentry (hentry).
    • entry-title. required. text.
    • entry-content. optional (see field description). text. [*]
    • entry-summary. optional. text.
    • updated. required using value class pattern date and time. [*]
    • published. optional using value class pattern date and time.
    • author. required using hCard . [*]
    • bookmark (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 hfeed
• a Feed element represents the concept of an 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 Atom category inside a feed
• Feed Category elements MUST appear inside a Feed element but not inside an Entry element
• the rel-tag href encodes the atom category:term; the link text defines the atom category:label

Entry

• an Entry element is identified by class name hentry
• an Entry element represents the concept of an Atom entry
• any microformat content inside a <blockquote> or <q> 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 Atom category inside an entry
• the rel-tag href encodes the atom category:term; the link text defines the atom category:label

Entry Title

• an Entry Title element is identified by the class name entry-title
• an Entry SHOULD have an Entry Title
• an Entry Title element represents the concept of an Atom entry title
• if the Entry Title is missing, use
  • the first <h#> element in the Entry, or
  • the <title> 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 entry-content
• an Entry SHOULD have Entry Content
• an Entry Content element represents the concept of an 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 web logs split content into multiple sections with a "Read More" link and JavaScript tricks. This is also needed in cases where Entry Titles are coded in-line 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 entry-summary
• an Entry Summary element represents the concept of an 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 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 updated
• an Entry Updated element represents the concept of Atom updated
• an Entry SHOULD have an Entry Updated element
• use the value class pattern date and time 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 published
• an Entry Published element represents the concept of Atom published
• use the value class pattern date and time to encode the published datetime

Entry Author

• an Entry Author element is represented by class name author
• an Entry Author element represents the concept of an Atom author
• an Entry Author element MUST be encoded in an hCard
• an Entry Author element SHOULD be encoded in an <address> 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 Nearest In Parent <address> element(s) with class name author and that is/are a valid hCard
  • otherwise the entry is invalid hAtom

XMDP Profile

See hatom-profile.

Examples

See hatom-examples.

Examples in the wild

See hatom-examples-in-wild.

Implementations

See hatom-implementations.

Copyright

This specification is (C) 2005-2025 by the authors. However, the authors intend to submit (or already have submitted, see details in the spec) this specification to a standards body with a liberal copyright/licensing policy such as the GMPG, IETF, and/or W3C. Anyone wishing to contribute should read their copyright principles, policies and licenses (e.g. the GMPG Principles) and agree to them, including licensing of all contributions under all required licenses (e.g. CC-by 1.0 and later), before contributing.

• Tantek: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
  • When all authors/editors have done so, we can remove the MicroFormatCopyrightStatement template reference and replace it with the MicroFormatPublicDomainContributionStatement.

Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

Semantic HTML Design Principles

References

Normative References

• XHTML 1.0 SE
• RFC4287: The Atom Syndication Format
• hcard-parsing
• RFC 2119
• ISO8601

Informative References

• atomenabled.org

Further Reading

• Getting Semantic With Microformats, Part 5: hAtom by Emily Lewis

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

Version 0.1

Version 0.1 was released 28 February 2006.

Discussions

• See blogs discussing this page.

Q&A

• If you have any questions about hAtom, check the 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 document.

See Also

• 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.
• rel-enclosure - how to semantically reference enclosures (e.g. podcasts) in hAtom
• blog-post-brainstorming
• blog-post-formats
• blog-post-examples
• blog-post-feed-equivalence
• blog-description-format - how to describe a blog (as opposed to the individual entries, which is what we're doing here)
• xhtml-syndication

Translations

Read the hAtom draft specification in additional languages:

• français

• Draft Specifications
• hAtom