data/TWiki/WebRssBase.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
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="8"}%
colas@0
     2
---+ RSS News Feeds
colas@0
     3
colas@0
     4
---++ Find out What's New
colas@0
     5
colas@0
     6
There are several ways to find out what's new in each TWiki web:
colas@0
     7
   1. Visit WebChanges to see recent changes
colas@0
     8
   1. Subscribed in WebNotify get notified of recent changes by e-mail
colas@0
     9
   1. Use a news readers such as TWiki:Plugins/HeadlinesPlugin to display the recent changes
colas@0
    10
      * The source can be a RSS 1.0 feed (WebRss) or ATOM 1.0 feed (WebAtom)
colas@0
    11
      * Learn more on RSS at TWiki:Codev/TWikiSyndication
colas@0
    12
      * Learn more on ATOM at WebAtomBase and TWiki:Codev/AtomSyndication
colas@0
    13
colas@0
    14
---++ RSS Feed Usage
colas@0
    15
colas@0
    16
   * The URL for an RSS feed is =%SCRIPTURL{"view"}%/&lt;web&gt;/WebRss=
colas@0
    17
   * For this <nop>%WEB% web it is %SCRIPTURL{"view"}%/%WEB%/WebRss
colas@0
    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%/WebRss?search=plugin is a what's new feed about Plugins.
colas@0
    19
colas@0
    20
---++ RSS Feed Internals
colas@0
    21
colas@0
    22
Each web has a WebRss topic which includes part of this <nop>%TOPIC% topic. This topic is the base for the RSS feed and generates an RSS 1.0 feed for TWiki:Codev/TWikiSyndication.
colas@0
    23
colas@0
    24
The WebRss topic in each web contains the following text:
colas@0
    25
colas@0
    26
-----
colas@0
    27
<pre>
colas@0
    28
&lt;channel rdf:about="%<nop>SCRIPTURL{"view"}%/%<nop>INCLUDINGWEB%">
colas@0
    29
  &lt;title>%<nop>WIKITOOLNAME%'s &lt;nop>%<nop>INCLUDINGWEB% web&lt;/title>
colas@0
    30
  &lt;link>%<nop>SCRIPTURL{"view"}%/%<nop>INCLUDINGWEB%&lt;/link>
colas@0
    31
  &lt;description>(the description of the web). TWiki is a Web-Based Collaboration Platform for the Enterprise.&lt;/description>
colas@0
    32
%<nop>INCLUDE{"%SYSTEMWEB%.WebRssBase"}% &lt;!--
colas@0
    33
   * Set <nop>SKIN = rss
colas@0
    34
-->
colas@0
    35
</pre>
colas@0
    36
-----
colas@0
    37
colas@0
    38
colas@0
    39
Below part is included by each <nop>WebRss topic:
colas@0
    40
colas@0
    41
colas@0
    42
-----
colas@0
    43
<verbatim>
colas@0
    44
%STARTINCLUDE%<image rdf:resource="%WIKILOGOIMG%" />
colas@0
    45
  <dc:language>en-us</dc:language>
colas@0
    46
  <dc:rights>%WEBRSSCOPYRIGHT%</dc:rights>
colas@0
    47
  <dc:publisher>%WIKIWEBMASTERNAME% [%WIKIWEBMASTER%]</dc:publisher>
colas@0
    48
  <dc:creator>The contributing authors of %WIKITOOLNAME%</dc:creator>
colas@0
    49
  <dc:source>%WIKITOOLNAME%</dc:source>
colas@0
    50
  <items>
colas@0
    51
    <rdf:Seq>
colas@0
    52
%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\" />"}%
colas@0
    53
    </rdf:Seq>
colas@0
    54
  </items>
colas@0
    55
</channel>
colas@0
    56
<image rdf:about="%WIKILOGOIMG%">
colas@0
    57
  <title>%WIKILOGOALT%.%INCLUDINGWEB%</title>
colas@0
    58
  <link>%SCRIPTURL{"view"}%/%INCLUDINGWEB%</link>
colas@0
    59
  <url>%WIKILOGOIMG%</url>
colas@0
    60
</image>
colas@0
    61
%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>"}%
colas@0
    62
%STOPINCLUDE%
colas@0
    63
</verbatim>
colas@0
    64
-----
colas@0
    65
colas@0
    66
__See also__: WebAtomBase, TWiki:Codev/RichSiteSummary, TWiki:Codev/TWikiSyndication 
colas@0
    67