rssSpec20.opml

Contents
    What is RSS?
    Sample files
    About this document
    Required channel elements
    Optional channel elements
    Elements of
    Comments
    Extending RSS
    Roadmap
    Copyright and disclaimer
  1.5
    bold
What is RSS?
  RSS is a Web content syndication format.
  Its name is an acronym for Really Simple Syndication.
  RSS is dialect of XML. All RSS files must conform to the XML 1.0 specification, as published on the World Wide Web Consortium (W3C) website.
  At the top level, a RSS document is a <rss> element, with a mandatory attribute called version, that specifies the version of RSS that the document conforms to.
  Subordinate to the <rss> element is a single <channel> element, which contains information about the channel (metadata) and its contents.
Sample files
  Here are sample files for: RSS 0.91, 0.92 and 2.0.
  Note that the sample files may point to documents and services that no longer exist. The 0.91 sample was created when the 0.91 docs were written. Maintaining a trail of samples seems like a good idea.
About this document
  This document represents the status of RSS as of the Fall of 2002.
  It incorporates all changes and additions, starting with the basic spec for RSS 0.91 (June 2000) and includes new features introduced in RSS 0.92 (December 2000) and RSS 0.94 (August 2002).
  Change notes are here.
  First we document the required and optional sub-elements of ; and then document the sub-elements of . The final sections answer frequently asked questions, and provide a roadmap for future evolution, and guidelines for extending RSS.
Required channel elements
  Here's a list of the required channel elements, each with a brief description, an example, and where available, a pointer to a more complete description.
  {includemessage (159, false, false)}
Optional channel elements
  Here's a list of optional channel elements.
  {includemessage (161, false, false)}
<image> sub-element of <channel>
  <image> is an optional sub-element of <channel>, which contains three required and three optional sub-elements.
  <url> is the URL of a GIF, JPEG or PNG image that represents the channel.
  <title> describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.
  <link> is the URL of the site, when the channel is rendered, the image is a link to the site. (Note, in practice the image <title> and <link> should have the same value as the channel's <title> and <link>.
  Optional elements include <width> and <height>, numbers, indicating the width and height of the image in pixels. <description> contains text that is included in the TITLE attribute of the link formed around the image in the HTML rendering.
  Maximum value for width is 144, default value is 88.
  Maximum value for height is 400, default value is 31.
<cloud> sub-element of <channel>
  is an optional sub-element of .
  It specifies a web service that supports the rssCloud interface which can be implemented in HTTP-POST, XML-RPC or SOAP 1.1.
  Its purpose is to allow processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds.
  In this example, to request notification on the channel it appears in, you would send an XML-RPC message to radio.xmlstoragesystem.com on port 80, with a path of /RPC2. The procedure to call is xmlStorageSystem.rssPleaseNotify.
  A full explanation of this element and the rssCloud interface is here.
<ttl> sub-element of <channel>
  is an optional sub-element of .
  ttl stands for time to live. It's a number of minutes that indicates how long a channel can be cached before refreshing from the source. This makes it possible for RSS sources to be managed by a file-sharing network such as Gnutella.
  Example: 60
<textInput> sub-element of <channel>
  A channel may optionally contain a <textInput> sub-element, which contains four required sub-elements.
  <title> -- The label of the Submit button in the text input area.
  <description> -- Explains the text input area.
  <name> -- The name of the text object in the text input area.
  <link> -- The URL of the CGI script that processes text input requests.
  The purpose of the element is something of a mystery. You can use it to specify a search engine box. Or to allow a reader to provide feedback. Most aggregators ignore it.
Elements of <item>
  A channel may contain any number of <item>s. An item may represent a "story" -- much like a story in a newspaper or magazine; if so its 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), and the link and title may be omitted. All elements of an item are optional, however at least one of title or description must be present.
  {includemessage (162, false, false)}
<source> sub-element of <item>
  <source> is an optional sub-element of <item>.
  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.
  Tomalak's Realm
  The purpose of this element is to propogate credit for links, to publicize the sources of news items. It's used in the post command in the Radio UserLand aggregator. It should be generated automatically when forowarding an item from an aggregator to a weblog authoring tool.
<enclosure> sub-element of <item>
  <enclosure> is an optional sub-element of <item>.
  It has 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" />
  A use-case narrative for this element is here
<category> sub-element of <item>
  <category> is an optional sub-element of <item>.
  It has one optional attribute, domain, a string that identifies a categorization taxonomy.
  The value of the element is a forward-slash-separated string that identifies a hierarchic location in the indicated taxonomy. Processors may establish conventions for the interpretation of categories. Two examples are provided below:
  Grateful Dead
  MSFT
  You may include as many category elements as you need to, for different domains, and to have an item cross-referenced in different parts of the same domain.
<pubDate> sub-element of <item>
  is an optional sub-element of .
  Its value is a date, indicating when the item was published. If it's a date in the future, aggregators may choose to not display the item until that date.
  Sun, 19 May 2002 15:21:36 GMT
<guid> sub-element of <item>
  is an optional sub-element of .
  guid stands for globally unique identifier. It's a string that uniquely identifies the item. When present, an aggregator may choose to use this string to determine if an item is new.
  http:\//some.server.com/weblogItem3207
  There are no rules for the syntax of a guid. Aggregators must view them as a string. It's up to the source of the feed to establish the uniqueness of the string.
  If the guid element has an attribute named "isPermaLink" with a value of true, the reader may assume that it is a permalink to the item, that is, a url that can be opened in a Web browser, that points to the full item described by the element. An example:
  http:\//inessential.com/2002/09/01.php#a2
  isPermaLink is optional, its default value is true. If its value is false, the guid may not be assumed to be a url, or a url to anything in particular.
<comments> sub-element of <item>
  is an optional sub-element of .
  If present, it is the url of the comments page for the item.
  http:\//rateyourmusic.com/yaccs/commentsn/blogId=705245&itemId=271
<author> sub-element of <item>
  is an optional sub-element of .
  It's the email address of the author of the item. For newspapers and magazines syndicating via RSS, the author is the person who wrote the article that the describes. For collaborative weblogs, the author of the item might be different from the managing editor or webmaster. For a weblog authored by a single individual it would make sense to omit the element.
  cary\@crophound.net (Cary Dactaraw)
Comments
  RSS places restrictions on the first non-whitespace characters of the data in <link> and <url> elements. The data in these elements must begin with http:\// or ftp:\//. Among others, https:, file:, mailto:, news:, and javascript: are not permitted.
  In RSS 0.91, various elements are restricted to 500 or 100 characters. There can be no more than 15 in a 0.91 . There are no string-length or XML-level limits in RSS 0.92 and greater. Processors may impose their own limits, and generators may have preferences that say no more than a certain number of s can appear in a channel, or that strings are limited in length.
  In RSS 2.0, a provision is made for linking a channel to its identifier in a cataloging system, using the channel-level category feature, described above. For example, to link a channel to its Syndic8 identifier, include a category element as a sub-element of , with domain "Syndic8", and value the identifier for your channel in the Syndic8 database. The appropriate category element for Scripting News would be 1765.
  A frequently asked question about s is how do they compare to s. Aren't they the same thing? Yes, in some content systems, and no in others. In some systems, is a permalink to a weblog item. However, in other systems, each is a synopsis of a longer article, points to the article, and is the permalink to the weblog entry. In all cases, it's recommended that you provide the guid, and if possible make it a permalink. This enables aggregators to not repeat items, even if there have been editing changes.
Extending RSS
  In 1999, the W3C published a recommendation for namespaces in XML.
  In 2002, with the release of RSS 2.0, we now include the ability to extend RSS, using namespaces.
  It's very simple. A RSS feed may contain elements not described on this page, only if those elements are defined in a namespace.
  For guidance on how to do that, please refer to the W3C document.
Roadmap
  RSS is by no means a perfect format, but it is very popular and widely supported. Having a settled spec is something RSS has needed for a long time. The purpose of this work is to help it become a unchanging thing, to foster growth in the market that is developing around it, and to clear the path for innovation in new syndication formats. Therefore, the RSS spec is, for all practical purposes, frozen at version 2.0. We anticipate possible 2.0.1 or 2.0.2 versions, etc. only for the purpose of clarifying the specification, not for adding new features to the format. Subsequent work should happen in modules, using namespaces, and in completely new syndication formats, with new names.
Copyright and disclaimer
  © Copyright 1997-2002 UserLand Software. All Rights Reserved.
  This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and these paragraphs are included on all such copies and derivative works.
  This document may not be modified in any way, such as by removing the copyright notice or references to UserLand or other organizations. Further, while these copyright restrictions apply to the written RSS specification, no claim of ownership is made by UserLand to the format it describes. Any party may, for commercial or non-commercial purposes, implement this format without royalty or license fee to UserLand. The limited permissions granted herein are perpetual and will not be revoked by UserLand or its successors or assigns.
  This document and the information contained herein is provided on an "AS IS" basis and USERLAND DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.