Per CC0, to the extent possible under law, the editors have waived all copyright and related or neighboring rights to this work. In addition, as of 2016-06-29, the editors have made this specification available under the Open Web Foundation Agreement Version 1.0.
h-feed properties, inside an element with class h-feed. All properties are optional.
root class name: h-feed
The following core h-feed properties have broad consensus:
p-name- name of the feed
p-author- author of the feed, optionally embed an h-cardMain article: h-card
u-url- URL of the feed
u-photo- representative photo / icon for the feed
- nested h-entry objects representing the items of the feed
The following properties are proposed additions based on various observed examples in the wild, but are awaiting at least one reader / real world consuming code example to become a draft property:
p-summary- based on non-trivial actual content usage of "atom:subtitle" on Blogger and WordPress.com featured blogs's Atom feeds.
p-entry- to be more consistent with the cascading of p-author or p-comment.
h-feed is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-feed up as a classic hAtom "hfeed".
- Named feeds
- IndieWeb Readers are consuming home page feeds marked up with h-feed and using the name of the h-feed in their user interfce.
- Generate an Atom feed
- This seems like a legacy use-case, not sufficient to actually justify h-feed.
- Feed per channel of content - needs a name
- "I will have a feed per tag (channel) so I want to name them." - Sandeep Shetty in #indiewebcamp
- It appears there is some desire to create separate feeds for an indieweb site for separate subsets of content, and name them explicitly accordingly. This presents a need for a container object for the h-entry elements, where the container itself can have a name. This is a potential interesting use-case for an explicit 'h-feed'.
Examples in the wild
Add any examples in the wild that you find to the top of this list.
- http://sandeep.io/ uses h-feed with p-name and p-author properties and child h-entry posts. In particular using h-feed on the <html> element allows using p-name on the <title> element and re-using the visible window title of the HTML page as the name of the feed, neatly avoiding a DRY violation.
- http://tantek.com/ uses h-feed with p-name and p-author properties and child h-entry posts.
- microformats to RSS - a Yahoo! pipe that converts a URL containing an h-feed containing h-entries, into an RSS feed. (2013-10-21 blog post announcing)
When parsing a page for an h-feed, do so per microformats2.
If there is no explicit "h-feed" element, implementations may:
- Treat the
<title>of the page or the URL of the page as the p-name
- Use http://indiewebcamp.com/authorship to discover authorship of posts.
- Treat top level h-entry elements as items in the feed.
How do I avoid duplicating the page title
I want to use the name (title) of my page as the name of my feed, how do I avoid duplicating the page title somewhere invisibly on the page as the feed name?
If you want re-use the <title> of your page as the name of your feed, you can do so by putting the h-feed root class name on the <html> element, and the p-name property class name on the <title> element, e.g. here's a snippet showing how those tags would look:
<html class="h-feed"> … <title class="p-name">sandeep.io</title> …
Real world example:
- Sandeep Shetty has marked up his home page, http://sandeep.io/ in this way.
What should a subscriber do with a page with multiple feeds
What do I do when a user subscribes to a URL with multiple distinct h-feeds?
A feed reader should subscribe to the first h-feed it finds at a URL.