feed

From IndieWeb
(Redirected from mf2 feed)

A feed is a dynamic set of posts, typically listed in reverse-chronological order, often only the most recent (like 10), published on the IndieWeb as separate feed files and on homepages with h-feed markup.

Homepage feeds usually contain all posts by the author, but many also choose to publish filtered feeds, for example posts of a particular type, or tagged with a particular tag.

Feeds, if correctly marked up, can be subscribed to, parsed and presented by readers.

Historically feeds have been served in separate feed files, in specialized XML formats like RSS or Atom, that are typically polled for updates by feed readers or aggregators.

Feeds can also be (and are more and more often) served by marking up existing HTML pages with h-feed/h-entry, e.g. homepages and archive pages, thus not requiring a separate feed URL that duplicates content (and all the downsides of doing so).

IndieWeb Examples

Many examples of feeds marked up with HTML+microformats can be found, e.g. on h-entry examples in the wild and h-feed indieweb examples. Add yourself below!

Aaron Parecki

Aaron uses p3k to publish various feeds on aaronparecki.com, all marked up with h-entry and h-card:

  • homepage feed containing all Aaron’s posts apart from responses and metrics
  • Content-specific feeds, for example notes, articles and replies
  • Tag-filtered feeds, for example #indieweb — note that this includes not only posts by Aaron but also posts tagged with #indieweb which he’s replied to
  • A mentions feed, of every mention Aaron’s site has received

Barnaby Walters

Barnaby uses Taproot publishes various feeds on waterpigs.co.uk, all marked up with h-feed, h-entry and h-card:

  • homepage feed containing all Barnaby’s notes (including replies, checkins, photos), articles and tunes
  • Content-specific feeds of notes, articles and music
  • A (currently very ugly --Barnaby Walters 05:40, 16 March 2014 (PDT)) mentions feed of all the mentions waterpigs.co.uk has received

Tantek

Tantek Çelik uses Falcon to publish h-feed with quite a few h-entry items on tantek.com using Falcon. In addition he publishes a legacy Atom feed at tantek.com/updates.atom (reduced to only a handful most recent items as of 2013-09-29 due to Atom inefficiency).

Mrs. D

Mrs. D publishes a marked-up h-feed as well as atom, json, and rss feeds from her homepage at dianoetic.net.

Kevin Marks

Kevin Marks has a marked up h-feed with summaries (and title only for older posts as this is a manual until it hurts effort) at kevinmarks.com and h-feed and legacy feeds at known.kevinmarks.com

How to

The easiest way to mark up, publish and consume feeds is to use HTML+microformats2, specifically the h-entry and h-feed vocabularies.

How to Publish

A simple feed can be marked up simply as a page with multiple h-entries on. The h-entries should be marked up in the same way they’re marked up on post permalink pages, although most people choose to leave comments/mentions out in feeds, instead showing comment/like/repost counts. For example: 

<article class="h-entry">
  <p class="p-author h-card">Barnaby Walters</p>
  <div class="e-content">Good grief the weather here changes quickly. sun/hail/snow/sun/rain/snow/sun in 1hr</div>
  <p><a class="u-url" href="/posts/100"><time class="dt-published">2014-03-12 12:00:16+00:00</time></a></p>
</article>
<article class="h-entry">
  •••
</article>
•
•
•

It is recommended that you also wrap the h-entries in an h-feed. This allows your feed to be given a specific name, author, and representative icon.

In addition, consider adding support for WebSub notifications to turn your feed into a real-time stream for WebSub subscribers.

How to indicate that a feed item is only a summary of the full post

Mark it up with h-entry as normal, but don’t provide the e-content property, only p-name and optionally p-summary.

How to mark up authorship without repeating an h-card for every item

How To Test

How To Consume

With microformats2 h-entry, generic microformats2 parsers, you can get a JSON representation of any HTML page instead of relying on a separate XML feed.

Use the following algorithm to get feed posts and details for a page:

  • Look for the first h-feed. If one is found:
    • let the feed name be the name property of the h-feed
    • let the default author of posts in the feed be the author property of the h-feed, if it exists
    • let the posts in the feed be any h-entry children of the h-feed
  • otherwise, let the name of the feed be the value of the <title> of the page
  • let the default author be the representative h-card found on the page
  • let the posts in the feed be any h-entries found on the page
  • to find earlier/later posts from the same feed, look for rel=prev[ious] and rel=next URLs, parse them in the same way
  • Use the h-entry consumption algorithm to process each h-entry found in the feed

If you don't find a feed on a page, or want to discover all available feeds, look for a property in the rels object named feed. You can then repeat this process with any urls provided in this array (you probably want to de-dup it first).

See also: microformats wiki section about Parsing h-feed.

Past Work

There is a long history (since 1997) of the development of feeds, most of which has died to due the widespread abandonment of XML as a foundation of anything actually served on the web (largely replaced by HTML and JSON).

There is however still some inertial legacy XML support, some of which you may find sufficiently useful to implement — see backward compatibility.

Criticism

XML feeds like RSS and Atom are known to be problematic for a variety of reasons, here are a few.

  • DRY violation - feed/post content is typically already visible on HTML pages, thus the XML version is a (sometimes lower fidelity even) duplicate.
    • RSS Date Formats blog documents the many hilarious ways people publish date-times in RSS/Atom feeds.
  • Bad RSS link User Experience - visiting a link to an RSS or Atom feed results in seeing a pile of XML in the browser. There have been attempts to make the XML more presentable using XSLT and CSS, basically resulting in what looks like a web page
  • Maintenance tax - added maintenance cost of separate code path for generating XML, coercing embedded content to be XML-friendly, validating, testing etc.
  • Inefficient code to generate[1] (perhaps because extra code to support them was hastily written due to being lower priority than visible HTML)
  • Dated - not rich enough - "RSS and Atom are not rich enough to describe the kind of social web activities that we have today" — [2]
  • Atom feed files many times larger than equivalent HTML - An Atom feed file is up to (maybe greater than) 4.5x the size of the equivalent HTML+microformats file.[3]
    • When the HTML is split into separate files for each post, that plus the index is still barely bigger than a single Atom file.[4].
    • When a single Atom file is compared to the equivalent single HTML file, whether for one post, or for many posts, in that one file, the Atom file is significantly bigger.
    • For text notes, an Atom file is a multiple of the size of the equivalent HTML file.
  • Consuming feed files is problematic and fragile. Consuming ATOM or RSS has been shown to be problematic and fragile — one of the creators of NewsGator documented 40+ common problems with feeds, most of which don’t happen when consuming visible HTML web pages (e.g. marked up with h-entry). Some of them still might, but in general most of them either don't, or are quickly automatically fixed because, well, people (including readers of a site) notice that visible HTML is broken and it typically gets fixed quite quickly.

All of the above should not obliterate the fact that RSS can be used a signal for new content and as a failover mechanism when microformats or other richer format is not available.

Backward Compatibility

There are legacy systems, e.g. some feed readers, which only support older technologies such as XML-based feeds. For backward compatibility with those you may want to consider publishing the following:

  • Atom
    • Atom ActivityStreams object-type annotations, e.g. inside entry elements:

      <object-type xmlns="http://activitystrea.ms/spec/1.0/">http://activitystrea.ms/schema/1.0/note</object-type>

      or

      <object-type xmlns="http://activitystrea.ms/spec/1.0/">http://activitystrea.ms/schema/1.0/article</object-type>

      for the note and article post types respectively.
      • (any known live Atom ActivityStreams consumers?)
  • How to set up your realtime feed - lots of helpful information related to setting up and testing an ATOM+ActivityStreams+PuSH feed

Shutdowns

Documentation of when sites stop publishing and/or consuming legacy RSS/Atom feeds. See also site-deaths.

2021

Google Groups

  • 2021-10-10 [5] "The blink-dev and Mozilla dev-platform intent messages are not showing up on @intenttoship because RSS feeds have been removed from Google Groups. Thanks Google 😐"

2018

Mozilla Firefox

  • 2018-12-02 [6] Firefox removes built in support for web feeds, citing small use, high maintenance, ready alternatives and other initiatives like Pocket and Reader mode.

2015

Google Calendar

  • 2015-11-18 Starting on November 18th, 2015, [Atom] XML feeds from Google Calendar will no longer be available.[7].

2013

Apple iTunes

HubMed

  • 2013-08-14 Switching off HubMed's RSS and Atom feeds:

    I've been considering stopping HubMed's feeds, and the demise of Google Reader seemed like a good incentive to do some spring cleaning. They were quite inefficient old scripts, which made the shared hosting provider unhappy, so today I decided to switch the feeds off.

    emphasis added.

Yahoo RSS Alerts

  • 2013-07-01 Yahoo! RSS Alerts shut down.[8][9]

Google Reader

  • 2013-06-30 Google Reader (RSS and Atom consumer) shut down.

Evernote

  • 2013-04-11 Evernote Removing RSS support for public notebooks:

    We currently have support for RSS feeds for public notebooks to allow subscribers to automatically get updates to those notebooks. Last night's (4/10/2013) release of the web service removed this support. Attempts to access Public Notebook RSS feeds will return a 404 HTTP response code instead of the heretofore expected content. At this point, the feature was imposing excessive load on the service relative to its use and utility, and the decision was made to remove it.

Twitter

2012

FeedBurner APIs

Apple Safari Mail

  • 2012 Apple quietly removes RSS support from OSX Mountain Lion's Safari and Mail [10]

Brainstorming

Can we deprecate feeds

Is it time to deprecate feeds, or at least drop any federated social dependence on feeds?

With microformats2 h-entry, generic microformats2 parsers for Node and PHP is there any more need for bespoke XML or JSON feeds/formats when you can get any HTML page as JSON?

Books About

Books about feeds:

Front and back of 2010 book Feed by Mira Grant Front of 2002 book Feed by M.T. Anderson


See Also

Retrieved from "https://indieweb.org/wiki/index.php?title=feed&oldid=79688"