TWiki/WebRssBase.mdwn

   1 # <a name="RSS News Feeds"></a> RSS 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 TWiki:Codev/TWikiSyndication
  12   - Learn more on ATOM at [[WebAtomBase]] and TWiki:Codev/AtomSyndication
  13
  14 ## <a name="RSS Feed Usage"></a> RSS Feed Usage
  15
  16 - The URL for an RSS feed is `http://www.dementia.org/twiki/view/<web>/WebRss`
  17 - For this %WEB% web it is [[http://www.dementia.org/twiki/view/%WEB%/WebRss|%WEB%/WebRss]]
  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%/WebRss?search=plugin|%WEB%/WebRss?search=plugin]] is a what's new feed about Plugins.
  19
  20 ## <a name="RSS Feed Internals"></a> RSS Feed Internals
  21
  22 Each web has a [[WebRss]] topic which includes part of this %TOPIC% topic. This topic is the base for the RSS feed and generates an RSS 1.0 feed for TWiki:Codev/TWikiSyndication.
  23
  24 The [[WebRss]] topic in each web contains the following text:
  25
  26 ----
  27
  28     <channel rdf:about="%SCRIPTURL{"view"}%/%INCLUDINGWEB%">
  29       <title>%WIKITOOLNAME%'s <nop>%INCLUDINGWEB% web</title>
  30       <link>%SCRIPTURL{"view"}%/%INCLUDINGWEB%</link>
  31       <description>(the description of the web). TWiki is a Web-Based Collaboration Platform for the Enterprise.</description>
  32     %INCLUDE{"TWiki.WebRssBase"}% <!--
  33        * Set SKIN = rss
  34     -->
  35
  36 ----
  37
  38 Below part is included by each WebRss topic:
  39
  40 ----
  41
  42     %STARTINCLUDE%<image rdf:resource="%WIKILOGOIMG%" />
  43       <dc:language>en-us</dc:language>
  44       <dc:rights>%WEBRSSCOPYRIGHT%</dc:rights>
  45       <dc:publisher>%WIKIWEBMASTERNAME% [%WIKIWEBMASTER%]</dc:publisher>
  46       <dc:creator>The contributing authors of %WIKITOOLNAME%</dc:creator>
  47       <dc:source>%WIKITOOLNAME%</dc:source>
  48       <items>
  49         <rdf:Seq>
  50     %SEARCH{"%URLPARAM{"search" default=".*" }%" web="%URLPARAM{"web" default="%INCLUDINGWEB%" }%" excludetopic="%URLPARAM{"excludetopic" default="WebStatistics" }%" type="%URLPARAM{"type" default="regex" }%" nosearch="on" order="modified" reverse="on" nototal="on" limit="%URLPARAM{"limit" default="16" }%" scope="%URLPARAM{"scope" default="text" }%" casesensitive="%URLPARAM{"casesensitive" default="on" }%" date="%URLPARAM{"date" default="" }%" format="      <rdf:li rdf:resource=\"%SCRIPTURL{"view"}%/$web/$topic\" />"}%
  51         </rdf:Seq>
  52       </items>
  53     </channel>
  54     <image rdf:about="%WIKILOGOIMG%">
  55       <title>%WIKILOGOALT%.%INCLUDINGWEB%</title>
  56       <link>%SCRIPTURL{"view"}%/%INCLUDINGWEB%</link>
  57       <url>%WIKILOGOIMG%</url>
  58     </image>
  59     %SEARCH{"%URLPARAM{"search" default=".*" }%" web="%URLPARAM{"web" default="%INCLUDINGWEB%" }%" excludetopic="%URLPARAM{"excludetopic" default="WebStatistics" }%" type="%URLPARAM{"type" default="regex" }%" nosearch="on" order="modified" reverse="on" nototal="on" limit="%URLPARAM{"limit" default="16" }%" scope="%URLPARAM{"scope" default="text" }%" casesensitive="%URLPARAM{"casesensitive" default="on" }%" date="%URLPARAM{"date" default="" }%" format="<item rdf:about=\"%SCRIPTURL{"view"}%/$web/$topic\">$n  <title>$topic</title>$n  <link>%SCRIPTURL{"view"}%/$web/$topic</link>$n  <description>$summary (last changed by <nop>$wikiname)</description>$n  <dc:date>$isodate</dc:date>$n  <dc:contributor>$n    <rdf:Description link=\"%SCRIPTURL{"view"}%?topic=$wikiusername\">$n      <rdf:value>$username</rdf:value>$n    </rdf:Description>$n  </dc:contributor>$n</item>"}%
  60     %STOPINCLUDE%
  61
  62 ----
  63
  64 **_See also_**: [[WebAtomBase]], TWiki:Codev/RichSiteSummary, TWiki:Codev/TWikiSyndication