h-feed

(Difference between revisions)

Jump to: navigation, search
(Parser Compatibility: https indieweb url)
(Parser Compatibility: wordpress suggestions)
Line 80: Line 80:
* Use https://indieweb.org/authorship to discover authorship of posts.
* Use https://indieweb.org/authorship to discover authorship of posts.
* Treat top level [[h-entry]] elements as items in the feed.
* Treat top level [[h-entry]] elements as items in the feed.
 +
 +
If there is a "hfeed" element, implementations may:
 +
* Treat site-title as p-name [wordpress has this by default, and without it implied p-name will be the whole feed]
 +
* Treat site-description as p-summary [wordpress has this by default]
== FAQ ==
== FAQ ==

Revision as of 23:41, 12 September 2017


Tantek Çelik (Editor)


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.

h-feed is the microformats2 update to hAtom, and in particular its "hfeed" root class.

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

Contents

Properties

h-feed properties, inside an element with class h-feed. All properties are optional.

root class name: h-feed

Core Properties

The following core h-feed properties have broad consensus:

children:

Draft Properties

None currently.

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:

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

Examples in the wild

Add any examples in the wild that you find to the top of this list.

Implementations

Readers

Proxies

Converters

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 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)

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

If there is a "hfeed" element, implementations may:

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:

<html class="h-feed"><title class="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?

A feed reader should subscribe to the first h-feed it finds at a URL.

Related: http://indiewebcamp.com/reader

See Also

Categories

h-feed was last modified: Wednesday, December 31st, 1969

Views