WebAtomBase < System < BACCHUS Wiki

You are here: BACCHUS Wiki>System Web>WebAtomBase (revision 1) (raw view)

---+ ATOM News Feeds

---++ Find out What's New

There are several ways to find out what's new in each web:
   1. Visit WebChanges to see recent changes
   1. Subscribed in WebNotify get notified of recent changes by e-mail
   1. Use a news readers such as Foswiki:Extensions.HeadlinesPlugin to display the recent changes
      * The source can be a RSS 1.0 feed (WebRss) or ATOM 1.0 feed (WebAtom)
      * Learn more at WebRssBase and Foswiki:Support.SupplementalDocuments

---++ ATOM Feed Usage

   * The URL for an RSS feed is =%SCRIPTURL{view}%/&lt;web&gt;/WebAtom=
   * For this <nop>%WEB% web it is %SCRIPTURL{view}%/%WEB%/WebAtom
   * You can also create a custom feed based on a search. Add a =search=value= parameter to the URL, e.g. %SCRIPTURL{"view"}%/%WEB%/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 <nop>%TOPIC% topic. This topic is the base for the ATOM feed and generates an WebAtom 1.0 feed.

The WebAtom topic in each web contains the following text:

-----
<pre>
&lt;title>&lt;nop>%<nop>WIKITOOLNAME%'s &lt;nop>%<nop>BASEWEB% web&lt;/title>
&lt;subtitle>&lt;literal>%MAKETEXT{"The [_1] web of [_2]." args="<nop>%<nop>WEB%,<nop>%<nop>WIKITOOLNAME%"}% <nop>%<nop>WEBSUMMARY%&lt;/literal>&lt;/subtitle>
%<nop>INCLUDE{"%<nop>SYSTEMWEB%.WebAtomBase"}% &lt;!--
   * Set <nop>SKIN = rssatom
   * Set <nop>COVER = rssatom
--&gt;
</pre>
-----
*Note:* The subtitle is expanded from the %<nop>WEB%, %<nop>WIKITOOLNAME% and %<nop>WEBSUMMARY% macros.  These *must* expand to plain text with no links or html markup. &lt;literal> is used to avoid links if the web name or any of the macros expand to include WikiWords or other markup.

Below part is included by each <nop>WebAtom topic:

-----
<verbatim>
%STARTINCLUDE%<link rel="self" type="application/atom+xml" href="%SCRIPTURL{"view"}%/%BASEWEB%/%BASETOPIC%"/>
<id>%SCRIPTURL{"view"}%/%BASEWEB%</id>
<rights>%WEBRSSCOPYRIGHT%</rights>%CALC{$SET(c,0)}%
%SEARCH{"%URLPARAM{"search" encode="quote" default=".*" }%" web="%BASEWEB%" type="regex" nosearch="on" order="modified" reverse="on" nototal="on" limit="16" format="$percentCALC{$IF($GET(c)>0, , <updated>$isodate</updated>$CHAR(10))$SETM(c, +1)}$percent<entry>$n <title>$topic</title>$n <link rel=\"alternate\" type=\"text/html\" href=\"%SCRIPTURL{"view"}%/$web/$topic?t=$isodate\"/>$n <id>%SCRIPTURL{"view"}%/$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%
</verbatim>
-----

*See also*: WebRssBase

Topic revision: r1 - 13 Aug 2010, ProjectContributor

System

Copyright &© by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding BACCHUS Wiki? Send feedback