Skip to content

Instantly share code, notes, and snippets.

@vhf

vhf/web-syndication-feeds-specs.md

Last active June 20, 2016 16:29
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save vhf/e29f260296d03b5849aaec35c5e52c92 to your computer and use it in GitHub Desktop.
Save vhf/e29f260296d03b5849aaec35c5e52c92 to your computer and use it in GitHub Desktop.
Download ZIP
RSS and Atom specifications in a more readable format.
Raw
web-syndication-feeds-specs.md

RSS 2.0

  • channel
    • title
      • GoUpstate.com News Headlines
    • link
    • description
      • The latest news from GoUpstate.com, a Spartanburg Herald-Journal Web site.
    • [language]
      • en-us
    • [copyright]
      • Copyright 2002, Spartanburg Herald-Journal
    • [managingEditor]
    • [webMaster]
    • [pubDate] - RFC822
      • Sat, 07 Sep 2002 00:00:01 GMT
    • [lastBuildDate] - RFC822
      • Sat, 07 Sep 2002 09:42:31 GMT
    • [category] - 0 or more
      • <category domain="http://www.fool.com/cusips">MSFT</category>
      • <category domain="http://www.example.com/t">Newspaper</category>
    • [generator]
      • MightyInHouse Content System v2.3
    • [docs]
    • [cloud] - rssCloud interface
      • <cloud domain="rpc.sys.com" port="80" path="/RPC2" registerProcedure="pingMe" protocol="soap"/>
    • [ttl] - minutes
    • [image]
    • [rating]
    • [textInput] - mystery
    • [skipHours]
    • [skipDays]
    • [item] - 0 or more
      • All elements of an item are optional, however at least one of title or description must be present.
      • description is a synopsis of the story, and the link points to the full story. An item may also be complete in itself, if so, the description contains the text (entity-encoded HTML is allowed; see examples), and the link and title may be omitted
      • [title]
        • Venice Film Festival Tries to Quit Sinking
      • [link] - URL of the item.
      • [description]
      • [author]
      • [category] - 0 or more
        • <category domain="http://www.fool.com/cusips">MSFT</category>
        • <category domain="http://www.example.com/t">Newspaper</category>
      • [comments] - URL
      • [enclosure]
        • three required attributes. url says where the enclosure is located, length says how big it is in bytes, and type says what its type is, a standard MIME type. The url must be an http url.
        • <enclosure url="http://www.scripting.com/mp3s/weatherReportSuite.mp3" length="12216320" type="audio/mpeg" />
      • [guid]
        • When present, an aggregator may choose to use this string to determine if an item is new.
        • <guid>http://some.server.com/weblogItem3207</guid>
      • [pubDate]
        • If it's a date in the future, aggregators may choose to not display the item until that date.
      • [source]
        • Its value is the name of the RSS channel that the item came from, derived from its <title>. It has one required attribute, url, which links to the XMLization of the source.
        • The purpose of this element is to propagate credit for links, to publicize the sources of news items. It can be used in the Post command of an aggregator. It should be generated automatically when forwarding an item from an aggregator to a weblog authoring tool.
        • <source url="http://www.tomalak.org/links2.xml">Tomalak's Realm</source>

Atom

  • All elements described in this document must be in the http://www.w3.org/2005/Atom namespace.
  • All timestamps in Atom must conform to RFC 3339.
  • Unless otherwise specified, all values must be plain text (i.e., no entity-encoded html).
  • xml:lang may be used to identify the language of any human readable text.
  • xml:base may be used to control how relative URIs are resolved.
  • feed - <feed xmlns="http://www.w3.org/2005/Atom">
    • title
      • GoUpstate.com News Headlines
    • updated
    • id - <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
    • [link] - <link href="http://example.org/"/>
    • [author]
    • [category] - 0 or more <category term="sports"/>
    • [contributor] - 0 or more
      • [name]
      • [email]
      • [uri]
    • [generator] - <generator uri="/myblog.php" version="1.0">Example Toolkit</generator>
    • [icon] - <icon>/icon.jpg</icon>
    • [logo] - <logo>/logo.jpg</logo>
    • [rights] - <rights>© 2005 John Doe</rights> - <rights type="html">&amp;copy; 2005 John Doe</rights>
    • [subtitle] - <subtitle>all your examples are belong to us</subtitle>
    • [entry] - 0 or more
      • id
      • title
      • updated
      • [author] - 0 or more
        • [name]
        • [email]
        • [uri]
      • [content]
        • <content> either contains, or links to, the complete content of the entry.
        • In the most common case, the type attribute is either text, html, xhtml, in which case the content element is defined identically to other text constructs, which are described here.
        • Otherwise, if the src attribute is present, it represents the URI of where the content can be found. The type attribute, if present, is the media type of the content.
        • Otherwise, if the type attribute ends in +xml or /xml, then an xml document of this type is contained inline.
        • Otherwise, if the type attribute starts with text, then an escaped document of this type is contained inline.
        • Otherwise, a base64 encoded document of the indicated media type is contained inline.
      • [link] - <link href="http://example.org/2003/12/13/atom03"/> - <link rel="alternate" href="/blog/1234"/>
        • <link> is patterned after html’s link element. It has one required attribute, href, and five optional attributes: rel, type, hreflang, title, and length.
      • [summary]
      • [category] - 0 or more <category term="sports"/>
      • [contributor] - 0 or more
        • [name]
        • [email]
        • [uri]
      • [published]
      • [source]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment