~kosova/+junk/tuxfamily-twiki

« back to all changes in this revision

Viewing changes to foswiki/data/System/WebAtomBase.txt

  • Committer: James Michael DuPont
  • Date: 2009-07-18 19:58:49 UTC
  • Revision ID: jamesmikedupont@gmail.com-20090718195849-vgbmaht2ys791uo2
added foswiki

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
%META:TOPICINFO{author="ProjectContributor" date="1231502400" format="1.1" version="1"}%
 
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 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 Foswiki:Extensions.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 at WebRssBase and Foswiki::Support.SupplementalDocuments
 
12
 
 
13
---++ ATOM Feed Usage
 
14
 
 
15
   * The URL for an RSS feed is =%SCRIPTURL{view}%/<web>/WebAtom=
 
16
   * For this <nop>%WEB% web it is %SCRIPTURL{view}%/%WEB%/WebAtom
 
17
   * 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.
 
18
 
 
19
---++ ATOM Feed Internals
 
20
 
 
21
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.
 
22
 
 
23
The WebAtom topic in each web contains the following text:
 
24
 
 
25
-----
 
26
<pre>
 
27
&lt;title>&lt;nop>%<nop>WIKITOOLNAME%'s &lt;nop>%<nop>BASEWEB% web&lt;/title>
 
28
&lt;subtitle>(the description of the web, plain text with no markup and no wikiwords). Foswiki is the Free and Open Source Wiki.&lt;/subtitle>
 
29
%<nop>INCLUDE{"%<nop>SYSTEMWEB%.WebAtomBase"}% &lt;!--
 
30
   * Set <nop>SKIN = rssatom
 
31
   * Set <nop>COVER = rssatom
 
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"}%/%BASEWEB%/%BASETOPIC%"/>
 
42
<id>%SCRIPTURL{"view"}%/%BASEWEB%</id>
 
43
<rights>%WEBRSSCOPYRIGHT%</rights>%CALC{$SET(c,0)}%
 
44
%SEARCH{"%URLPARAM{"search" encode="quote" default=".*" }%" web="%BASEWEB%" 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
 
50