data/TWiki/WebAtomBase.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1163619832" format="1.0" version="4"}%
     2 ---+ ATOM News Feeds
     3 
     4 ---++ Find out What's New
     5 
     6 There are several ways to find out what's new in each TWiki web:
     7    1. Visit WebChanges to see recent changes
     8    1. Subscribed in WebNotify get notified of recent changes by e-mail
     9    1. 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 ---++ ATOM Feed Usage
    15 
    16    * The URL for an RSS feed is =%SCRIPTURL{view}%/&lt;web&gt;/WebAtom=
    17    * For this <nop>%WEB% web it is %SCRIPTURL{view}%/%WEB%/WebAtom
    18    * 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.
    19 
    20 ---++ ATOM Feed Internals
    21 
    22 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 for TWiki:Codev/AtomSyndication.
    23 
    24 The WebAtom topic in each web contains the following text:
    25 
    26 -----
    27 <pre>
    28 &lt;title>&lt;nop>%<nop>WIKITOOLNAME%'s &lt;nop>%<nop>INCLUDINGWEB% web&lt;/title>
    29 &lt;subtitle>(the description of the web, plain text with no markup and no wikiwords). TWiki is an Enterprise Collaboration Platform.&lt;/subtitle>
    30 %<nop>INCLUDE{"%<nop>SYSTEMWEB%.WebAtomBase"}% &lt;!--
    31    * Set <nop>SKIN = rss
    32 --&gt;
    33 </pre>
    34 -----
    35 
    36 
    37 Below part is included by each <nop>WebAtom topic:
    38 
    39 -----
    40 <verbatim>
    41 %STARTINCLUDE%<link rel="self" type="application/atom+xml" href="%SCRIPTURL{"view"}%/%INCLUDINGWEB%/%BASETOPIC%"/>
    42 <id>%SCRIPTURL{"view"}%/%INCLUDINGWEB%</id>
    43 <rights>%WEBRSSCOPYRIGHT%</rights>%CALC{$SET(c,0)}%
    44 %SEARCH{"%URLPARAM{"search" 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>"}%
    45 %STOPINCLUDE%
    46 </verbatim>
    47 -----
    48 
    49 __See also__: WebRssBase, TWiki:Codev/AtomSyndication 
    50