Difference between revisions of "h-feed"

From Microformats Wiki
Jump to navigation Jump to search
(Parsing with fallback)
(add use cases with commentary from sandeepshetty)
Line 15: Line 15:
 
children:
 
children:
 
* nested [[h-entry]] objects representing the items of the feed
 
* nested [[h-entry]] objects representing the items of the feed
 +
 +
== Use Cases ==
 +
* 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 the <em>explicitly</em> 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 ==
 
== Examples in the wild ==

Revision as of 18:35, 28 June 2013

This article is a stub. You can help the microformats.org wiki by expanding it.

h-feed is a microformats2 experiment with a top level feed object to contain h-entry posts.

From experience with hAtom 0.1, it's not clear that there's actually a need (use-case) for a top level feed, but for those that wish to experiment with it, here it is.

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

  • 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 the 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

  • http://tantek.com/ uses h-feed with p-name and p-author properties and child h-entry posts.
  • ...

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

See Also