(this section is a stub and needs to be expanded with real world examples and minimal properties)

-

Fallback:

+

=== Parser Compatibility ===

+

When <span id="Parsing">parsing</a> a page for an h-feed, in addition to just following the [[microformats2-parsing]] specification, implementations may do the following for backward compatibility with existing [[hatom|hAtom]] content.

+

+

(this section is a stub and needs review and citations to note what real world examples would each of these rules actually help parse)

If there is no explicit "h-feed" element, implementations may:

If there is no explicit "h-feed" element, implementations may:

Revision as of 20:24, 12 September 2017

h-feed is a simple, open format for publishing a stream or feed of h-entry posts, like complete posts on a home page or archive pages, or summaries or other brief lists of posts. h-feed is one of several open microformat draft standards suitable for embedding data in HTML.

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 2017-12-14, the editors have made this specification available under the Open Web Foundation Agreement Version 1.0.

Draft Properties

Proposed Properties

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.

Status

h-feed is a microformats.org draft specification. Public discussion on h-feed takes place on h-entry-feedback and the #microformats irc channel on irc.freenode.net.

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".

Use Cases

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.

Backward Compatibility

Publisher Compatibility

(this section is a stub and needs to be expanded with real world examples and minimal properties)

Parser Compatibility

When parsing</a> a page for an h-feed, in addition to just following the microformats2-parsing specification, implementations may do the following for backward compatibility with existing hAtom content.

(this section is a stub and needs review and citations to note what real world examples would each of these rules actually help parse)

FAQ

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:

<htmlclass="h-feed">
…
<titleclass="p-name">sandeep.io</title>
…

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?