h-feed - Revision history

Tantek: /* Properties */ editorial: more explicit clarification of existing functionality that all properties are optional and plural meaning they may have multiple instances, not that each property instance takes multiple values (no one has ever implemented that, fortunately)

2024-05-23T17:50:42Z

Properties: editorial: more explicit clarification of existing functionality that all properties are optional and plural meaning they may have multiple instances, not that each property instance takes multiple values (no one has ever implemented that, fortunately)

← Older revision		Revision as of 17:50, 23 May 2024
Line 17:		Line 17:

	== Properties ==		== Properties ==
	h-feed properties, inside an element with class '''h-feed'''. All properties are optional.		h-feed properties, inside an element with class '''h-feed'''. All properties are both optional and may have multiple instances, e.g. multiple name, url, photo etc. properties.

	root class name: h-feed		root class name: h-feed

GRegorLove: s///

2023-07-26T21:19:49Z

s/<source>/<syntaxhighlight>/

← Older revision		Revision as of 21:19, 26 July 2023
Line 80:		Line 80:
	For backward compatibility, you may wish to use classic [[hAtom]] classnames in addition to the more future-proof h-feed properties, for example:		For backward compatibility, you may wish to use classic [[hAtom]] classnames in addition to the more future-proof h-feed properties, for example:

	<~~source~~ lang=~~html4strict~~>		<syntaxhighlight lang="html">
	<div class="h-feed hfeed">		<div class="h-feed hfeed">
	<h1 class="p-name site-title">The Markup Blog</h1>		<h1 class="p-name site-title">The Markup Blog</h1>
Line 114:		Line 114:

	</div>		</div>
	</~~source~~>		</syntaxhighlight>

	{{note\|Note: you may use any valid HTML5 elements. The <code>article h1 h2 address time</code> elements are used in the example as semantically richer suggestions, however in general <code>div span</code> work fine too. The <code>time</code> element is special though in that its <code>datetime</code> attribute provides a more author/user friendly way of separating a machine readable ISO8601 datetime from a human readable summary.		{{note\|Note: you may use any valid HTML5 elements. The <code>article h1 h2 address time</code> elements are used in the example as semantically richer suggestions, however in general <code>div span</code> work fine too. The <code>time</code> element is special though in that its <code>datetime</code> attribute provides a more author/user friendly way of separating a machine readable ISO8601 datetime from a human readable summary.
Line 147:		Line 147:

	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:		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:
	<~~source~~ lang=~~html4strict~~>
			<syntaxhighlight lang="html">
	<html class="h-feed">		<html class="h-feed">
	…		…
	<title class="p-name">The Markup Blog</title>		<title class="p-name">The Markup Blog</title>
	…		…
	</~~source~~>		</syntaxhighlight>

	== See Also ==		== See Also ==

GRegorLove: move editor to the
like other specs, remove redundant DisplayTitle:h-feed

2022-10-01T18:30:07Z

move editor to the <dl> like other specs, remove redundant DisplayTitle:h-feed

← Older revision		Revision as of 18:30, 1 October 2022
Line 1:		Line 1:
	~~{{DISPLAYTITLE:h-feed}}~~

	~~<span class="h-card vcard"><span class="p-name fn">[[User:Tantek\|Tantek Çelik]]</span> (<span class="p-role role">Editor</span>)</span>~~
	~~----~~
	<dfn style="font-style:normal;font-weight:bold">h-feed</dfn> 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 [[microformats\|microformat]] draft standards suitable for embedding data in HTML.		<dfn style="font-style:normal;font-weight:bold">h-feed</dfn> 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 [[microformats\|microformat]] draft standards suitable for embedding data in HTML.

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


	;<span id="status">Status</span>		;<span id="status">Status</span>
Line 15:		Line 10:
	:[https://github.com/microformats/h-feed/issues Open Issues]		:[https://github.com/microformats/h-feed/issues Open Issues]
	:[[IRC]]		:[[IRC]]
			;Editor
			:<span class="h-card vcard"><span class="p-name fn">[[User:Tantek\|Tantek Çelik]]</span> (<span class="p-role role">Editor</span>)</span>
	;License		;License
	: {{cc0-owfa-license}}		: {{cc0-owfa-license}}

Tantek: /* Implied h-feed */ single h-card is used for authorship per implementation consensus (ParseThis, X-Ray)

2021-12-30T04:32:15Z

Implied h-feed: single h-card is used for authorship per implementation consensus (ParseThis, X-Ray)

← Older revision		Revision as of 04:32, 30 December 2021
Line 67:		Line 67:

	=== Implied h-feed ===		=== Implied h-feed ===
	In the absence of an explicit "h-feed" element, implementations may infer an h-feed of all top level microformats items in the document (as determined by [[microformats2-parsing]] the document).		In the absence of an explicit "h-feed" element, implementations may infer an h-feed of all top level microformats items in the document (as determined by [[microformats2-parsing]] the document). Among those top level items, if precisely one of them is an "h-card" then it is used to imply a "p-author h-card" property of the implied "h-feed" and is removed from the "children" array of the implied "h-feed".

	E.g. if an archive page has a collection of h-entry elements at the top level, implementations may imply an h-feed container for all of them and treat the entire document as a feed.		E.g. if an archive page has a collection of h-entry elements at the top level, implementations may imply an h-feed container for all of them and treat the entire document as a feed.

Tantek: /* Discovery */ fetch a URL, link parsing to mf2 parsing spec

2021-10-03T17:43:18Z

Discovery: fetch a URL, link parsing to mf2 parsing spec

← Older revision		Revision as of 17:43, 3 October 2021
Line 55:		Line 55:
	**# get its href,		**# get its href,
	**# do any relative-URL resolution needed on that href to construct an absolute URL		**# do any relative-URL resolution needed on that href to construct an absolute URL
	**# ~~parse~~ that absolute URL (within a specific element matching a fragment in the URL if any) for microformats2 items,		**# fetch that absolute URL and [[microformats2-parsing\|parse it]] (within a specific element matching a fragment in the URL if any) for microformats2 items,
	**# look for top-level items (within that fragment element subtree if any) of type "h-feed"		**# look for top-level items (within that fragment element subtree if any) of type "h-feed"
	** ALSO implementations MAY ~~parse the whole document per~~ [[microformats2-parsing]] and look in its top level items for those of type "h-feed"		** ALSO implementations MAY [[microformats2-parsing\|parse the whole document]] and look in its top level items for those of type "h-feed"

	* If the implementation has already parsed an HTML document, it may look for elements with a class name of "h-feed"		* If the implementation has already parsed an HTML document, it may look for elements with a class name of "h-feed"

	Details:		Details:
	* Implementations may ~~load~~ public h-feeds without having to pass cookies or any other user-identifying information		* Implementations may fetch public h-feeds without having to pass cookies or any other user-identifying information
	* Implementations should parse h-feed documents without executing any scripts (parse as if scripting is disabled or unimplemented)		* Implementations should parse h-feed documents without executing any scripts (parse as if scripting is disabled or unimplemented)
	* If an implementation needs only one h-feed, it should take the first one found ~~in any of~~ the above methods		* If an implementation needs only one h-feed, it should take the first one found per the above methods

	=== Implied h-feed ===		=== Implied h-feed ===

Tantek: /* Discovery */ rewrite as more list items to make it more step-by-step like

2021-10-03T06:17:19Z

Discovery: rewrite as more list items to make it more step-by-step like

← Older revision		Revision as of 06:17, 3 October 2021
Line 48:		Line 48:

	== Discovery ==		== Discovery ==
	Implementations may discover one or more h-feeds in several ways:		Implementations may discover one or more h-feeds in several ways.
	* If the implementation has already parsed an HTML document, it can look for all elements with a class name of "h-feed" in the DOM tree.
	* If the implementation ~~has been~~ given a URL (e.g. from a user entering it) to do h-feed discovery, it ~~may~~:		* If the implementation is given a URL (e.g. from a user entering it) to do h-feed discovery, it:
	** ~~Parse the document per [[microformats2-parsing]] and look in the top level collection of items for those of type "h-feed"~~		** SHOULD do traditional feed discovery by looking through link elements with a rel value of "alternate"
	** OR it may also do traditional feed discovery by looking through link elements with a rel value of "alternate"~~, and once it finds one~~ with media type of "[https://indieweb.org/text/mf2%2Bhtml text/mf2+html]", get its href, ~~perform~~ any relative-URL resolution as needed~~, and then~~ parse ~~the given~~ URL (within a specific element matching a fragment in the URL if any) for microformats2 items, ~~again looking~~ for top-level items (within that fragment element subtree if any) of type "h-feed"		** For each link alternate with a media type of <code>[https://indieweb.org/text/mf2%2Bhtml text/mf2+html]</code>
			**# get its href,
			**# do any relative-URL resolution needed on that href to construct an absolute URL
			**# parse that absolute URL (within a specific element matching a fragment in the URL if any) for microformats2 items,
			**# look for top-level items (within that fragment element subtree if any) of type "h-feed"
			** ALSO implementations MAY parse the whole document per [[microformats2-parsing]] and look in its top level items for those of type "h-feed"

			* If the implementation has already parsed an HTML document, it may look for elements with a class name of "h-feed"

	Details:		Details:

Dshanske: /* FAQ */

2021-09-29T03:03:14Z

FAQ

← Older revision		Revision as of 03:03, 29 September 2021
Line 149:		Line 149:
	…		…
	</source>		</source>

	~~=== 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 ==		== See Also ==

Dshanske: /* Implementations */

2021-09-29T02:31:58Z

Implementations

← Older revision		Revision as of 02:31, 29 September 2021
Line 68:		Line 68:
	See https://indieweb.org/h-feed#IndieWeb_Examples for examples of h-feed in the wild.		See https://indieweb.org/h-feed#IndieWeb_Examples for examples of h-feed in the wild.

	== ~~Implementations~~ ==		== Consumers ==
	~~=== Readers ===~~
	* [https://github.com/kylewm/woodwind Woodwind]
	* [https://github.com/barnabywalters/shrewdness Shrewdness]

	~~=== Proxies ===~~		See https://indieweb.org/h-feed#Consumers_of_H-Feed for examples of implementations that consume h-feed.
	* Bridgy

	~~=== Converters ===~~
	* '''[http://~~unmung~~.~~com unmung]'''~~ - ~~will transform an RSS or Atom~~ feed ~~into an [[~~h-feed~~]] containing h-entries~~

	== Backward Compatibility ==		== Backward Compatibility ==

Dshanske at 02:21, 29 September 2021

2021-09-29T02:21:22Z

← Older revision		Revision as of 02:21, 29 September 2021
Line 63:		Line 63:

	E.g. if an archive page has a collection of h-entry elements at the top level, implementations may imply an h-feed container for all of them and treat the entire document as a feed.		E.g. if an archive page has a collection of h-entry elements at the top level, implementations may imply an h-feed container for all of them and treat the entire document as a 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 <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 ==

Dshanske: /* Move Examples in the wild out of the spec and cite the IndieWeb wiki */

2021-09-29T02:19:11Z

Move Examples in the wild out of the spec and cite the IndieWeb wiki

← Older revision		Revision as of 02:19, 29 September 2021
Line 76:		Line 76:

	== Examples in the wild ==		== 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.
	* ...

	See https://indieweb.org/h-feed#IndieWeb_Examples for ~~many more~~ examples of h-feed in the wild.		See https://indieweb.org/h-feed#IndieWeb_Examples for examples of h-feed in the wild.

	== Implementations ==		== Implementations ==