NOTE: This is a DistributionDocument. Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

ATOM News Feeds

Find out What's New

There are several ways to find out what's new in each TWiki web:

1. Visit WebChanges to see recent changes
2. Subscribed in WebNotify get notified of recent changes by e-mail
3. Use a news readers such as TWiki:Plugins/HeadlinesPlugin to display the recent changes
   • The source can be a RSS 1.0 feed (WebRss) or ATOM 1.0 feed (WebAtom)
   • Learn more on RSS at WebRssBase and TWiki:Codev/TWikiSyndication
   • Learn more on ATOM at TWiki:Codev/AtomSyndication

ATOM Feed Usage

• The URL for an RSS feed is http://twiki.org/cgi-bin/view/<web>/WebAtom
• For this TWiki web it is http://twiki.org/cgi-bin/view/TWiki/WebAtom (or http://twiki.org/cgi-bin/view/TWiki/WebAtom?skin=rssatom&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://twiki.org/cgi-bin/view/TWiki/WebAtom?search=plugin is a what's new feed about Plugins.

ATOM Feed Internals

Each web has a WebAtom topic which includes part of this WebAtomBase topic. This topic is the base for the ATOM feed and generates an WebAtom 1.0 feed for TWiki:Codev/AtomSyndication.

The WebAtom topic in each web contains the following text:

<title><nop>%WIKITOOLNAME%'s <nop>%INCLUDINGWEB% web</title>
<subtitle>(the description of the web, plain text with no markup and no wikiwords). TWiki is an Enterprise Collaboration Platform.</subtitle>
%INCLUDE{"%TWIKIWEB%.WebAtomBase"}% <!--
   * Set SKIN = rss
-->

Below part is included by each WebAtom topic:

%STARTINCLUDE%<link rel="self" type="application/atom+xml" href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%INCLUDINGWEB%/%HOMETOPIC%"/>
<id>%SCRIPTURL%/view%SCRIPTSUFFIX%/%INCLUDINGWEB%</id>
<rights>%WEBRSSCOPYRIGHT%</rights>%CALC{$SET(c,0)}%
%SEARCH{"%URLPARAM{"search" default=".*" }%" web="%INCLUDINGWEB%" regex="on" nosearch="on" order="modified" reverse="on" nototal="on" limit="16" format="$percntCALC{$IF($GET(c)>0, , <updated>$isodate</updated>$CHAR(10))$SETM(c, +1)}$percnt<entry>$n <title>$topic</title>$n <link rel=\"alternate\" type=\"text/html\" href=\"%SCRIPTURL%/view%SCRIPTSUFFIX%/$web/$topic?t=$isodate\"/>$n <id>%SCRIPTURL%/view%SCRIPTSUFFIX%/$web/$topic</id>$n <updated>$isodate</updated>$n <summary>$summary (last changed by <nop>$wikiname)</summary>$n <author>$n  <name><nop>$wikiname</name></author>$n</entry>"}%
%STOPINCLUDE%

See also: TWiki:Codev/AtomSyndication

-- TWiki:Main.PeterThoeny - 23 Jan 2006

Comments & Questions about this Distribution Document Topic