h-feed: Difference between revisions
(→Converters: blog post announcing) |
(has had stable consensus on properties and content for a while, time to make this a formal microformats draft, note implementations Shrewdness and Bridgy) |
||
| Line 1: | Line 1: | ||
{{stub}} | {{stub}} | ||
'''<dfn>h-feed</dfn>''' is a [[microformats2]] | '''<dfn>h-feed</dfn>''' is a [[microformats2]] draft for marking up a top level feed object that contains [[h-entry]] posts. | ||
root class name: h-feed | root class name: h-feed | ||
| Line 17: | Line 15: | ||
== Use Cases == | == 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 | * Generate an Atom feed | ||
** This seems like a legacy use-case, not sufficient to actually justify h-feed. | ** This seems like a legacy use-case, not sufficient to actually justify h-feed. | ||
| Line 31: | Line 32: | ||
== Implementations == | == Implementations == | ||
=== Readers === | |||
* Shrewdness | |||
=== Proxies === | |||
* Bridgy | |||
=== Converters === | === Converters === | ||
* '''[http://pipes.yahoo.com/pipes/pipe.info?_id=afc5568b4e8643bfb05436b1caaf91bc microformats to RSS]''' - a Yahoo! pipe that converts a URL containing an [[h-feed]] containing h-entries, into an [[RSS]] feed. ([http://waterpigs.co.uk/notes/4SeNi5/ 2013-10-21 blog post announcing]) | * '''[http://pipes.yahoo.com/pipes/pipe.info?_id=afc5568b4e8643bfb05436b1caaf91bc microformats to RSS]''' - a Yahoo! pipe that converts a URL containing an [[h-feed]] containing h-entries, into an [[RSS]] feed. ([http://waterpigs.co.uk/notes/4SeNi5/ 2013-10-21 blog post announcing]) | ||
| Line 68: | Line 75: | ||
== See Also == | == See Also == | ||
* [[h-feed-issues]] | |||
* [[h-entry]] | * [[h-entry]] | ||
* [[microformats2]] | * [[microformats2]] | ||
* [[hAtom]] | * [[hAtom]] | ||
[[Category:Draft Specifications]] | |||
Revision as of 18:53, 14 January 2015
This article is a stub. You can help the microformats.org wiki by expanding it.
h-feed is a microformats2 draft for marking up a top level feed object that contains h-entry posts.
root class name: h-feed
properties:
- p-name - name of the feed
- p-author - author of the feed, optionally embed an h-card Main article: h-card
- u-url - URL of the feed
- u-photo - representative photo / icon for the feed
children:
- nested h-entry objects representing the items of the feed
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.
- http://tantek.com/ uses h-feed with p-name and p-author properties and child h-entry posts.
Implementations
Readers
- Shrewdness
Proxies
- Bridgy
Converters
- 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)
Parsing
When parsing a page for an h-feed, do so per microformats2.
Fallback:
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.
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>
…
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.
Related: http://indiewebcamp.com/reader