Skip to content

Commit

Permalink
initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
@pfefferle
pfefferle committed Mar 20, 2015
0 parents commit b60cc9d
Show file tree
Hide file tree
Showing 59 changed files with 7,439 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
cache
microformats2.tgz
18 changes: 18 additions & 0 deletions Microformats2.docset/Contents/Info.plist
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleIdentifier</key>
<string>microformats2</string>
<key>CFBundleName</key>
<string>Microformats2</string>
<key>DocSetPlatformFamily</key>
<string>microformats2</string>
<key>DashDocSetFamily</key>
<string>dashtoc</string>
<key>dashIndexFilePath</key>
<string>microformats.org/wiki/microformats2.html</string>
<key>isDashDocset</key>
<true/>
</dict>
</plist>
306 changes: 306 additions & 0 deletions Microformats2.docset/Contents/Resources/Documents/microformats.org/wiki/h-adr.html

Large diffs are not rendered by default.

445 changes: 445 additions & 0 deletions Microformats2.docset/Contents/Resources/Documents/microformats.org/wiki/h-card.html

Large diffs are not rendered by default.

265 changes: 265 additions & 0 deletions Microformats2.docset/Contents/Resources/Documents/microformats.org/wiki/h-cite.html

Large diffs are not rendered by default.

491 changes: 491 additions & 0 deletions Microformats2.docset/Contents/Resources/Documents/microformats.org/wiki/h-entry.html

Large diffs are not rendered by default.

331 changes: 331 additions & 0 deletions Microformats2.docset/Contents/Resources/Documents/microformats.org/wiki/h-event.html

Large diffs are not rendered by default.

232 changes: 232 additions & 0 deletions Microformats2.docset/Contents/Resources/Documents/microformats.org/wiki/h-feed.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xmlns="http://www.w3.org/1999/xhtml"><!-- Mirrored from microformats.org/wiki/h-feed by HTTrack Website Copier/3.x [XR&CO'2014], Fri, 20 Mar 2015 22:27:21 GMT --><!-- Added by HTTrack --><head><meta content="text/html;charset=utf-8" http-equiv="content-type"/><!-- /Added by HTTrack -->

<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>

<meta content="MediaWiki 1.13.2" name="generator"/>
<meta content="h-feed,DRY,RSS,h-card,h-entry,h-entry-feedback,hAtom,irc,microformats2,h-feed-issues" name="keywords"/>
<link href="http://microformats.org/favicon.ico" rel="shortcut icon"/>
<link href="http://microformats.org/wiki/opensearch_desc.php" rel="search" title="Microformats Wiki (en)" type="application/opensearchdescription+xml"/>
<link href="http://microformats.org/wiki/index.php?title=Special:RecentChanges&amp;feed=rss" rel="alternate" title="Microformats Wiki RSS Feed" type="application/rss+xml"/>
<link href="http://microformats.org/wiki/index.php?title=Special:RecentChanges&amp;feed=atom" rel="alternate" title="Microformats Wiki Atom Feed" type="application/atom+xml"/>
<link href="skins/common/shared.css" rel="stylesheet" type="text/css"/>
<link href="skins/Microformats/microformats.css" rel="stylesheet" type="text/css"/>

<style type="text/css">/*<![CDATA[*/
@import "http://microformats.org/wiki/index.php?title=MediaWiki:Common.css&amp;usemsgcache=yes&amp;action=raw&amp;ctype=text/css&amp;smaxage=18000";
@import "http://microformats.org/wiki/index.php?title=MediaWiki:Microformats_Wiki.css&amp;usemsgcache=yes&amp;action=raw&amp;ctype=text/css&amp;smaxage=18000";
@import "http://microformats.org/wiki/index.php?title=-&amp;action=raw&amp;gen=css&amp;maxage=18000&amp;useskin=Microformats+Wiki";
/*]]>*/</style>




<style type="text/css">/*<![CDATA[*/
.source-html4strict {line-height: normal;}
.source-html4strict li {line-height: normal;}
/**
* GeSHi Dynamically Generated Stylesheet
* --------------------------------------
* Dynamically generated stylesheet for html4strict
* CSS class: source-html4strict, CSS id:
* GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann
* (http://qbnz.com/highlighter/ and http://geshi.org/)
* --------------------------------------
*/
.source-html4strict .de1, .source-html4strict .de2 {font-family: monospace; font-weight: normal; font-style: normal;}
.source-html4strict .imp {font-weight: bold; color: red;}
.source-html4strict li, .source-html4strict li.li1 {font-weight: normal;}
.source-html4strict li.li2 {font-weight: bold;}
.source-html4strict .kw1 {color: #b1b100;}
.source-html4strict .kw2 {color: #000000; font-weight: bold;}
.source-html4strict .kw3 {color: #000066;}
.source-html4strict .coMULTI {color: #808080; font-style: italic;}
.source-html4strict .es0 {color: #000099; font-weight: bold;}
.source-html4strict .br0 {color: #66cc66;}
.source-html4strict .sy0 {color: #66cc66;}
.source-html4strict .st0 {color: #ff0000;}
.source-html4strict .nu0 {color: #cc66cc;}
.source-html4strict .sc0 {color: #00bbdd;}
.source-html4strict .sc1 {color: #ddbb00;}
.source-html4strict .sc2 {color: #009900;}
.source-html4strict .ln-xtra, .source-html4strict li.ln-xtra, .source-html4strict div.ln-xtra {color: #cc0; background-color: #ffc;}

/*]]>*/
</style>
<style type="text/css">/*<![CDATA[*/
@import "http://microformats.org/wiki/index.php?title=MediaWiki:Geshi.css&amp;usemsgcache=yes&amp;action=raw&amp;ctype=text/css&amp;smaxage=18000";
/*]]>*/
</style>

<title>h-feed · Microformats Wiki</title>

<style id="dash-style" type="text/css">.content { width: 100%; }</style></head>
<!-- TODO: Template-dervied body class: spec and draft -->
<body class="page-h-feed specification draft">



<div class="content hentry">



<h1 class="entry-title">h-feed</h1>

<p class="sub-title"></p>

<!-- TODO: Jump nav -->
<div id="jump-to-nav">Jump to: <a href="#sidebar">navigation</a>,
<a href="#search">search</a>
</div>

<div class="entry-content">
<p><br/>
<dfn style="font-style:normal;font-weight:bold">h-feed</dfn> is a <a href="microformats2.html" title="microformats2">microformats2</a> draft for marking up a top level feed object that contains <a href="h-entry.html" title="h-entry">h-entry</a> posts.
</p><p>h-feed is the <a href="microformats2.html" title="microformats2">microformats2</a> update to <a class="mw-redirect" href="http://microformats.org/wiki/hAtom" title="hAtom">hAtom</a>'s "hfeed".
</p><p><small>Per <a class="external text" href="http://creativecommons.org/publicdomain/zero/1.0/" rel="nofollow" title="http://creativecommons.org/publicdomain/zero/1.0/">CC0</a>,
to the extent possible under law, the editors have waived
all copyright and related or neighboring rights to this work.
In addition, as of 2015-03-20,
the editors have made this specification available under the
<a class="external text" href="http://www.openwebfoundation.org/legal/the-owf-1-0-agreements/owfa-1-0" rel="nofollow" title="http://www.openwebfoundation.org/legal/the-owf-1-0-agreements/owfa-1-0">Open Web Foundation Agreement Version 1.0</a>.</small>
</p>

<a name="Properties"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Properties"></a> Properties </span></h2>
<p>h-feed properties, inside an element with class <b>h-feed</b>. All properties are optional.
</p><p>root class name: h-feed
</p><p>properties:
</p>
<ul><li> <b><code>p-name</code></b> - name of the feed
</li><li> <b><code>p-author</code></b> - author of the feed, optionally embed an <a href="h-card.html" title="h-card">h-card</a> <div style="text-indent:2em;font-style:italic">Main article: <a href="h-card.html" title="h-card">h-card</a></div>
</li><li> <b><code>u-url</code></b> - URL of the feed
</li><li> <b><code>u-photo</code></b> - representative photo / icon for the feed
</li></ul>
<p>children:
</p>
<ul><li> nested <a href="h-entry.html" title="h-entry">h-entry</a> objects representing the items of the feed
</li></ul>
<a name="Status"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Status"></a> Status </span></h2>
<p><b>h-feed</b> is a microformats.org draft specification. Public discussion on h-feed takes place on <a href="http://microformats.org/wiki/h-entry-feedback" title="h-entry-feedback">h-entry-feedback</a> and the #microformats <a href="http://microformats.org/wiki/irc" title="irc">irc</a> channel on irc.freenode.net.
</p><p>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 <a class="mw-redirect" href="http://microformats.org/wiki/hAtom" title="hAtom">hAtom</a> "hfeed".
</p>
<a name="Use_Cases"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Use%20Cases"></a> Use Cases </span></h2>
<ul><li> Named feeds
<ul><li> IndieWeb Readers are consuming home page feeds marked up with h-feed and using the name of the h-feed in their user interfce.
</li></ul>
</li></ul>
<ul><li> Generate an Atom feed
<ul><li> This seems like a legacy use-case, not sufficient to actually justify h-feed.
</li></ul>
</li></ul>
<ul><li> Feed per channel of content - needs a name
<ul><li> "I will have a feed per tag (channel) so I want to name them." - Sandeep Shetty in #indiewebcamp
</li><li> 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'.
</li></ul>
</li></ul>
<a name="Examples_in_the_wild"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Examples%20in%20the%20wild"></a> Examples in the wild </span></h2>
<p>Add any examples in the wild that you find to the top of this list.
</p>
<ul><li> ...
</li><li> <a class="external free" href="http://sandeep.io/" rel="nofollow" title="http://sandeep.io/">http://sandeep.io/</a> uses h-feed with p-name and p-author properties and child h-entry posts. In particular using h-feed on the &lt;html&gt; element allows using p-name on the &lt;title&gt; element and re-using the visible window title of the HTML page as the name of the feed, neatly avoiding a <a class="mw-redirect" href="http://microformats.org/wiki/DRY" title="DRY">DRY</a> violation.
</li><li> <a class="external free" href="http://tantek.com/" rel="nofollow" title="http://tantek.com/">http://tantek.com/</a> uses h-feed with p-name and p-author properties and child h-entry posts.
</li></ul>
<a name="Implementations"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Implementations"></a> Implementations </span></h2>
<a name="Readers"></a><h3> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Readers"></a> Readers </span></h3>
<ul><li> Shrewdness
</li><li> <a class="external free" href="http://notenoughneon.com/feed.php" rel="nofollow" title="http://notenoughneon.com/feed.php">http://notenoughneon.com/feed.php</a>
</li></ul>
<a name="Proxies"></a><h3> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Proxies"></a> Proxies </span></h3>
<ul><li> Bridgy
</li></ul>
<a name="Converters"></a><h3> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Converters"></a> Converters </span></h3>
<ul><li> <b><a class="external text" href="http://pipes.yahoo.com/pipes/pipe.info?_id=afc5568b4e8643bfb05436b1caaf91bc" rel="nofollow" title="http://pipes.yahoo.com/pipes/pipe.info?_id=afc5568b4e8643bfb05436b1caaf91bc">microformats to RSS</a></b> - a Yahoo! pipe that converts a URL containing an <strong class="selflink">h-feed</strong> containing h-entries, into an <a class="mw-redirect" href="http://microformats.org/wiki/RSS" title="RSS">RSS</a> feed. (<a class="external text" href="http://waterpigs.co.uk/notes/4SeNi5/" rel="nofollow" title="http://waterpigs.co.uk/notes/4SeNi5/">2013-10-21 blog post announcing</a>)
</li></ul>
<a name="Parsing"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/Parsing"></a> Parsing </span></h2>
<p>When parsing a page for an h-feed, do so per <a href="microformats2.html" title="microformats2">microformats2</a>.
</p><p>Fallback:
</p><p>If there is no explicit "h-feed" element, implementations may:
</p>
<ul><li> Treat the <code>&lt;title&gt;</code> of the page or the URL of the page as the p-name
</li><li> Use <a class="external free" href="http://indiewebcamp.com/authorship" rel="nofollow" title="http://indiewebcamp.com/authorship">http://indiewebcamp.com/authorship</a> to discover authorship of posts.
</li><li> Treat top level <a href="h-entry.html" title="h-entry">h-entry</a> elements as items in the feed.
</li></ul>
<a name="FAQ"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/FAQ"></a> FAQ </span></h2>
<a name="How_do_I_avoid_duplicating_the_page_title"></a><h3> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/How%20do%20I%20avoid%20duplicating%20the%20page%20title"></a> How do I avoid duplicating the page title </span></h3>
<p><i>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?</i>
</p><p>If you want re-use the &lt;title&gt; of your page as the name of your feed, you can do so by putting the h-feed root class name on the &lt;html&gt; element, and the p-name property class name on the &lt;title&gt; element, e.g. here's a snippet showing how those tags would look:
</p>
<div dir="ltr" style="text-align: left;"><pre class="source-html4strict"><span class="sc2"><span class="kw2">&lt;html</span> <span class="kw3">class</span><span class="sy0">=</span><span class="st0">"h-feed"</span><span class="kw2">&gt;</span></span>
…
<span class="sc2"><span class="kw2">&lt;title</span> <span class="kw3">class</span><span class="sy0">=</span><span class="st0">"p-name"</span><span class="kw2">&gt;</span></span>sandeep.io<span class="sc2"><span class="kw2">&lt;/title&gt;</span></span>
…</pre></div>
<p>Real world example:
</p>
<ul><li> Sandeep Shetty has marked up his home page, <a class="external free" href="http://sandeep.io/" rel="nofollow" title="http://sandeep.io/">http://sandeep.io/</a> in this way.
</li></ul>
<p><br/>
</p>
<a name="What_should_a_subscriber_do_with_a_page_with_multiple_feeds"></a><h3> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/What%20should%20a%20subscriber%20do%20with%20a%20page%20with%20multiple%20feeds"></a> What should a subscriber do with a page with multiple feeds </span></h3>
<p><i>What do I do when a user subscribes to a URL with multiple distinct h-feeds?</i>
</p><p>A feed reader should subscribe to the first h-feed it finds at a URL.
</p><p>Related: <a class="external free" href="http://indiewebcamp.com/reader" rel="nofollow" title="http://indiewebcamp.com/reader">http://indiewebcamp.com/reader</a>
</p>
<a name="See_Also"></a><h2> <span class="mw-headline"><a class="dashAnchor" name="//apple_ref/cpp/Section/See%20Also"></a> See Also </span></h2>
<ul><li> <a class="new" href="http://microformats.org/wiki/index.php?title=h-feed-issues&amp;action=edit&amp;redlink=1" title="h-feed-issues (not yet written)">h-feed-issues</a>
</li><li> <a href="h-entry.html" title="h-entry">h-entry</a>
</li><li> <a href="microformats2.html" title="microformats2">microformats2</a>
</li><li> <a class="mw-redirect" href="http://microformats.org/wiki/hAtom" title="hAtom">hAtom</a>
</li></ul>

<!--
NewPP limit report
Preprocessor node count: 41/1000000
Post-expand include size: 491/2097152 bytes
Template argument size: 6/2097152 bytes
Expensive parser function count: 0/100
-->
<div class="printfooter">
Retrieved from "<a href="h-feed.html">http://microformats.org/wiki/h-feed</a>"</div>
</div>

<h2>Categories</h2>
<div id="category-links">
<ul>
<li><a href="http://microformats.org/wiki/Category:Draft_Specifications" rel="tag">
Draft Specifications </a></li>
</ul>
</div>





</div>

<!-- end of the sidebar -->

<div id="footer">


<address class="vcard">
The content of this wiki is the combined effort of the
<a class="fn org url" href="http://microformats.org/">
microformats community
</a>.
</address>

<ul>
<li id="about"><a href="http://microformats.org/wiki/Microformats_Wiki:About" title="Microformats Wiki:About">About Microformats Wiki</a></li>
<li id="disclaimer"><a href="http://microformats.org/wiki/Microformats_Wiki:General_disclaimer" title="Microformats Wiki:General disclaimer">Disclaimers</a></li>
<li>Powered by <a href="http://mediawiki.org/">MediaWiki</a> | <a href="http://mediatemple.net/">(mt) media temple</a></li>
</ul>
</div>


<!-- Served in 0.222 secs. -->






</body><!-- Mirrored from microformats.org/wiki/h-feed by HTTrack Website Copier/3.x [XR&CO'2014], Fri, 20 Mar 2015 22:27:21 GMT --></html>
Loading

0 comments on commit b60cc9d

Please sign in to comment.