Skip to content

Commit

Permalink
Item13619: Sync up with default WebRssBase
Browse files Browse the repository at this point in the history 
 - Prepare for noautolink,
 - Use BASEWEB instead of INCLUDINGWEB
 - Clean up whitespace an make search more readable.
 - Add chili formatting for the verbatim block
  • Loading branch information
@gac410
gac410 committed Aug 20, 2015
1 parent c45e3b7 commit 8ae4f3f
Showing 1 changed file with 51 additions and 22 deletions.
73 changes: 51 additions & 22 deletions data/System/WebRssBaseWC.txt
View file
@@ -1,15 +1,15 @@
%META:TOPICINFO{author="ProjectContributor" date="1407719249" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1440078688" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminToolsCategory"}%
---+ RSS News Feeds
%JQREQUIRE{"chili"}%

---++ Find out What's New

There are several ways to find out what's new in each Foswiki web:
1. Visit WebChanges to see recent changes
1. Subscribed in WebNotify get notified of recent changes by e-mail
1. Use a news readers such as Foswiki:Extensions/HeadlinesPlugin to display the recent changes
* The source can be a RSS 1.0 feed (WebRss) or ATOM 1.0 feed (WebAtom)
* Learn more on RSS at %SYSTEMWEB%/WebRssBase
* Learn more on ATOM at %SYSTEMWEB%/WebAtomBase
There are several ways to find out what's new in each web:
1. Visit [[WebChanges]] to see recent changes
1. Subscribe in [[WebNotify]] to get notified of recent changes by e-mail
1. Use a news reader such as Foswiki:Extensions/HeadlinesPlugin to display the recent changes
* The source can be an RSS 1.0 feed ([[WebRss]]) or ATOM 1.0 feed ([[WebAtom]])

---++ RSS Feed Usage

Expand All @@ -19,28 +19,29 @@ There are several ways to find out what's new in each Foswiki web:

---++ RSS Feed Internals

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 Foswiki Syndication.
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.

The WebRss topic in each web contains the following text:
The [[WebRss]] topic in each web contains the following text:

-----
<pre>
&lt;channel rdf:about="%<nop>SCRIPTURL{"view"}%/%<nop>INCLUDINGWEB%">
&lt;title>%<nop>WIKITOOLNAME%'s &lt;nop>%<nop>INCLUDINGWEB% web&lt;/title>
&lt;link>%<nop>SCRIPTURL{"view"}%/%<nop>INCLUDINGWEB%&lt;/link>
&lt;description>(the description of the web). Foswiki - The Free and Open Source Wiki.&lt;/description>
&lt;channel rdf:about="%<nop>SCRIPTURL{"view"}%/%<nop>BASEWEB%">
&lt;title>%<nop>WIKITOOLNAME%'s &lt;nop>%<nop>BASEWEB% web&lt;/title>
&lt;link>%<nop>SCRIPTURL{"view"}%/%<nop>BASEWEB%&lt;/link>
&lt;description>&lt;literal>%<nop>MAKETEXT{"The [_1] web of [_2]." args="<nop>%<nop>WEB%,<nop>%<nop>WIKITOOLNAME%"}% <nop>%<nop>WEBSUMMARY%&lt;/literal>&lt;/description>
%<nop>INCLUDE{"%SYSTEMWEB%.WebRssBase"}% &lt;!--
* Set <nop>SKIN = rss
* Set <nop>COVER = rss
-->
</pre>
-----
*Note:* The description is expanded from the %<nop>WEB%, %<nop>WIKITOOLNAME% and %<nop>WEBSUMMARY% macros. These *must* expand to plain text with no links or html markup. &lt;literal> is used to avoid links if the web name or any of the macros expand to include WikiWords or other markup.


Below part is included by each <nop>WebRss topic:
The part below is included by each <nop>WebRss topic:


-----
<verbatim>
<verbatim class="tml">
%STARTINCLUDE%<image rdf:resource="%WIKILOGOIMG%" />
<dc:language>en-us</dc:language>
<dc:rights>%WEBRSSCOPYRIGHT%</dc:rights>
Expand All @@ -49,19 +50,47 @@ Below part is included by each <nop>WebRss topic:
<dc:source>%WIKITOOLNAME%</dc:source>
<items>
<rdf:Seq>
%SEARCH{"%URLPARAM{"search" encode="quote" default=".*" }%" web="%URLPARAM{"web" encode="quote" default="%INCLUDINGWEB%" }%" excludetopic="%URLPARAM{"excludetopic" encode="quote" default="WebStatistics" }%" type="%URLPARAM{"type" encode="quote" default="regex" }%" nosearch="on" order="modified" reverse="on" nototal="on" limit="%URLPARAM{"limit" encode="quote" default="16" }%" scope="%URLPARAM{"scope" encode="quote" default="text" }%" casesensitive="%URLPARAM{"casesensitive" encode="quote" default="on" }%" date="%URLPARAM{"date" encode="quote" default="" }%" format="<item rdf:about=\"%SCRIPTURL{"view"}%/$web/$topic\">$n <title>$topic</title>$n <link>%SCRIPTURL{"view"}%/$web/$topic</link>$n <description>%REVCOMMENT[rev=''$rev'' web=''$web'' topic=''$topic'' pre=''ChangeLog: '' delimiter='' -- '' post='''']%</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>"}%
%SEARCH{
"%URLPARAM{"search" encode="quote" default=".*" }%"
web="%URLPARAM{"web" encode="quote" default="%BASEWEB%" }%"
excludetopic="%URLPARAM{"excludetopic" encode="quote" default="%STATISTICSTOPIC%" }%"
type="%URLPARAM{"type" encode="quote" default="regex" }%"
nosearch="on"
order="modified"
reverse="on"
nototal="on"
limit="%URLPARAM{"limit" encode="quote" default="16" }%"
scope="%URLPARAM{"scope" encode="quote" default="text" }%"
casesensitive="%URLPARAM{"casesensitive" encode="quote" default="on" }%"
date="%URLPARAM{"date" encode="quote" default="" }%"
format="<item rdf:about=\"%SCRIPTURL{"view"}%/$web/$topic\">$n <title>$topic</title>$n <link>%SCRIPTURL{"view"}%/$web/$topic</link>$n <description>%REVCOMMENT[rev=''$rev'' web=''$web'' topic=''$topic'' pre=''ChangeLog: '' delimiter='' -- '' post='''']%</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>"
}%
</rdf:Seq>
</items>
</channel>
<image rdf:about="%WIKILOGOIMG%">
<title>%WIKILOGOALT%.%INCLUDINGWEB%</title>
<link>%SCRIPTURL{"view"}%/%INCLUDINGWEB%</link>
<title>%WIKILOGOALT%.%BASEWEB%</title>
<link>%SCRIPTURL{"view"}%/%BASEWEB%</link>
<url>%WIKILOGOIMG%</url>
</image>
%SEARCH{"%URLPARAM{"search" default=".*" }%" web="%URLPARAM{"web" encode="quote" default="%INCLUDINGWEB%" }%" excludetopic="%URLPARAM{"excludetopic" encode="quote" default="WebStatistics" }%" type="%URLPARAM{"type" encode="quote" default="regex" }%" nosearch="on" order="modified" reverse="on" nototal="on" limit="%URLPARAM{"limit" encode="quote" default="16" }%" scope="%URLPARAM{"scope" encode="quote" default="text" }%" casesensitive="%URLPARAM{"casesensitive" encode="quote" default="on" }%" date="%URLPARAM{"date" encode="quote" 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>"}%
%SEARCH{
"%URLPARAM{"search" encode="quote" default=".*" }%"
web="%URLPARAM{"web" encode="quote" default="%BASEWEB%" }%"
excludetopic="%URLPARAM{"excludetopic" encode="quote" default="%STATISTICSTOPIC%" }%"
type="%URLPARAM{"type" encode="quote" default="regex" }%"
nosearch="on"
order="modified"
reverse="on"
nototal="on"
limit="%URLPARAM{"limit" encode="quote" default="16" }%"
scope="%URLPARAM{"scope" encode="quote" default="text" }%"
casesensitive="%URLPARAM{"casesensitive" encode="quote" default="on" }%"
date="%URLPARAM{"date" encode="quote" 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>"
}%
%STOPINCLUDE%
</verbatim>
-----

__See also__: %SYSTEMWEB%.WebAtomBase, %SYSTEMWEB%.WebRssBase
*See also*: [[WebAtomBase]], [[WebRssBase]]

0 comments on commit 8ae4f3f

Please sign in to comment.