TWiki/WebAtomBase.mdwn

   1 # <a name="ATOM News Feeds"></a> ATOM News Feeds
   2
   3 ## <a name="Find out What&#39;s New"></a> Find out What's New
   4
   5 There are several ways to find out what's new in each TWiki web:
   6
   7 1. Visit [[WebChanges]] to see recent changes
   8 2. Subscribed in [[WebNotify]] get notified of recent changes by e-mail
   9 3. Use a news readers such as TWiki:Plugins/HeadlinesPlugin to display the recent changes
  10   - The source can be a RSS 1.0 feed ([[WebRss]]) or ATOM 1.0 feed ([[WebAtom]])
  11   - Learn more on RSS at [[WebRssBase]] and TWiki:Codev/TWikiSyndication
  12   - Learn more on ATOM at TWiki:Codev/AtomSyndication
  13
  14 ## <a name="ATOM Feed Usage"></a> ATOM Feed Usage
  15
  16 - The URL for an RSS feed is `http://www.dementia.org/twiki/view/<web>/WebAtom`
  17 - For this %WEB% web it is [[http://www.dementia.org/twiki/view/%WEB%/WebAtom|%WEB%/WebAtom]]
  18 - You can also create a custom feed based on a search. Add a `search=value` parameter to the URL, e.g. [[http://www.dementia.org/twiki/view/%WEB%/WebAtom?search=plugin|%WEB%/WebAtom?search=plugin]] is a what's new feed about Plugins.
  19
  20 ## <a name="ATOM Feed Internals"></a> ATOM Feed Internals
  21
  22 Each web has a [[WebAtom]] topic which includes part of this %TOPIC% topic. This topic is the base for the ATOM feed and generates an [[WebAtom]] 1.0 feed for TWiki:Codev/AtomSyndication.
  23
  24 The [[WebAtom]] topic in each web contains the following text:
  25
  26 ----
  27
  28     <title><nop>%WIKITOOLNAME%'s <nop>%INCLUDINGWEB% web</title>
  29     <subtitle>(the description of the web, plain text with no markup and no wikiwords). TWiki is an Enterprise Collaboration Platform.</subtitle>
  30     %INCLUDE{"%SYSTEMWEB%.WebAtomBase"}% <!--
  31        * Set SKIN = rss
  32     -->
  33
  34 ----
  35
  36 Below part is included by each WebAtom topic:
  37
  38 ----
  39
  40     %STARTINCLUDE%<link rel="self" type="application/atom+xml" href="%SCRIPTURL{"view"}%/%INCLUDINGWEB%/%BASETOPIC%"/>
  41     <id>%SCRIPTURL{"view"}%/%INCLUDINGWEB%</id>
  42     <rights>%WEBRSSCOPYRIGHT%</rights>%CALC{$SET(c,0)}%
  43     %SEARCH{"%URLPARAM{"search" encode="quote" default=".*" }%" web="%INCLUDINGWEB%" type="regex" 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"}%/$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>"}%
  44     %STOPINCLUDE%
  45
  46 ----
  47
  48 **_See also_**: [[WebRssBase]], TWiki:Codev/AtomSyndication