RSS Feed Internals

Each web has a WebRss topic which includes part of this GenealogyRssBase topic. This topic is the base for the RSS feed and generates an RSS 1.0 feed for TWiki:Codev/TWikiSyndication.

The WebRss topic in each web contains the following text:

<channel rdf:about="%SCRIPTURL%/view%SCRIPTSUFFIX%/%INCLUDINGWEB%">
  <title>%WIKITOOLNAME%'s %INCLUDINGWEB% web</title>
  <link>%SCRIPTURL%/view%SCRIPTSUFFIX%/%INCLUDINGWEB%</link>
  <description>(the description of the web). TWiki is a Web-Based Collaboration Platform for the Corporate World.</description>
%INCLUDE{"%TWIKIWEB%.WebRssBase"}%

Below part is included by each WebRss topic:

%STARTINCLUDE%<image rdf:resource="%WIKILOGOIMG%" />
  <dc:language>en-au</dc:language>
  <dc:rights>%WEBRSSCOPYRIGHT%.</dc:rights>
  <dc:publisher>%WIKIUSERNAME% [%WIKIUSERNAME%]</dc:publisher>
  <dc:creator>%WIKIUSERNAME% [%WIKIUSERNAME%]</dc:creator>
  <dc:source>%WIKITOOLNAME%</dc:source>
  <wiki:interwiki>
    <rdf:Description link="%SCRIPTURL%/view%SCRIPTSUFFIX%/%INCLUDINGWEB%/">
      <rdf:value>TWiki.%INCLUDINGWEB%</rdf:value>
    </rdf:Description>
  </wiki:interwiki>
  <items>
    <rdf:Seq>
%SEARCH{".*" web="Genealogy" regex="on" nosearch="on" order="modified" reverse="on" nototal="on" limit="16" format="      <rdf:li rdf:resource=\"%SCRIPTURL%/view%SCRIPTSUFFIX%/$web/$topic\" />"}%
    </rdf:Seq>
  </items>
</channel>
<image rdf:about="%WIKILOGOIMG%">
  <title>%WIKILOGOALT%.%INCLUDINGWEB%</title>
  <link>%SCRIPTURL%/view%SCRIPTSUFFIX%/%INCLUDINGWEB%</link>
  <url>%WIKILOGOIMG%</url>
</image>
%SEARCH{".*" web="%INCLUDINGWEB%" regex="on" nosearch="on" order="modified" reverse="on" nototal="on" limit="16" format="<item rdf:about=\"%SCRIPTURL%/view%SCRIPTSUFFIX%/$web/$topic\">$n  <title>$topic</title>$n  <link>%SCRIPTURL%/view%SCRIPTSUFFIX%/$web/$topic?t=$isodate</link>$n  <description>$summary</description>$n  <dc:date>$isodate</dc:date>$n  <dc:contributor>$n    <rdf:Description link=\"%SCRIPTURL%/view%SCRIPTSUFFIX%?topic=$wikiusername\">$n      <rdf:value>$username</rdf:value>$n    </rdf:Description>$n  </dc:contributor>$n  <wiki:version>$rev</wiki:version>$n  <wiki:status>updated</wiki:status>$n  <wiki:importance>new</wiki:importance>$n  <wiki:diff>%SCRIPTURL%/rdiff%SCRIPTSUFFIX%/$web/$topic</wiki:diff>$n  <wiki:history>%SCRIPTURL%/rdiff%SCRIPTSUFFIX%/$web/$topic</wiki:history>$n</item>"}%
%STOPINCLUDE%

RSS Feed Usage

• The URL for an RSS feed is http://subwiki.honeypot.net/cgi-bin/view/<web>/WebRss?skin=rss
• For this Sandbox web it is http://subwiki.honeypot.net/cgi-bin/view/Sandbox/WebRss?skin=rss (or http://subwiki.honeypot.net/cgi-bin/view/Main/WebRss?skin=rss&contenttype=text/plain for plain text RSS)
• You can also create a custom feed based on a search. Add a search=value parameter to the URL, e.g. http://subwiki.honeypot.net/cgi-bin/view/Sandbox/WebRss?skin=rss&search=plugin is a what's new feed about Plugins.

See also: TWiki:Codev/RichSiteSummary, TWiki:Codev/TWikiSyndication

Note: Included topic DocsComments^? does not exist yet

See TWiki:Codev/TWikiSyndication for the URLs to use when accessing TWiki RSS feeds, and templates/view.rss.tmpl in BeijingRelease^? for the skin to be used. This is also available in CVS, see CVSget:templates/view.rss.tmpl (save this file and view in a text editor, as browsers may be upset by its use of near-XML).

See also:

• Codev.WikiRssExtension^?
• http://openwiki.com/?a=rss
• http://openwiki.com/?WikiSites
• http://openwiki.com/?WikiSites/Aggregation

-- JohnCoe - 29 Mar 2004