Extension:RSS

MediaWiki extensions manual

RSS Release status: stable
Implementation	Tag
Description	Display RSS feeds on a wiki page
Author(s)	K. Elliott-McCrea, mutante, D. Kinzler, Rdb, Mafs, Alxndr, T. Gries, C. Reigrut, K001, J. De Dauw, J. Phoenix, M.A. Hershberger
Latest version	2.25.1 (2017-04-21)
MediaWiki	1.23+
PHP	5.4+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review README RELEASE-NOTES
Example	https://spookyverse.de/wiki/Vorlage:TV-Termine and https://spookyverse.de/wiki/Vorlage:RSS_News (see main the wikis' mains page where the rss feeds are displayed)
Parameters $wgRSSUserAgent $wgRSSDateDefaultFormat $wgRSSNamespaces $wgRSSUrlNumberOfAllowedRedirects $wgRSSFetchTimeout $wgRSSItemMaxLength $wgRSSAllowImageTag $wgRSSProxy $wgRSSCacheAge $wgRSSAllowLinkTag $wgRSSCacheCompare $wgRSSUrlWhitelist
Hooks used ParserFirstCallInit
Quarterly downloads	49 (Ranked 88th)
Public wikis using	1,691 (Ranked 202nd)
Translate the RSS extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The RSS extension renders ("displays") one or more RSS feeds on a wiki page in a standard or user-definable format.

• Download and move the extracted RSS folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/RSS
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'RSS' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Use one section between ‎<rss>-tags for each feed. The rss element may contain parameters if you provide them as attributes to the rss element:

All pages in a wiki which use the RSS extension are automatically added to the RSS tracking Category:Pages_with_RSS_feeds.

The RSS extension renders feeds on wiki page by using two templates in the MediaWiki system namespace, which can be changed, or which wiki admins can redirected to user-editable namespaces. The mechanism is perhaps not easy to understand, but after its installation, the extension starts with a useful set of templates; a manual set-up is not required.

If a template is not specified, then the one in MediaWiki:Rss-item is used and determines only which RSS feed channel subelements (items) are used. The other template MediaWiki:Rss-feed determines how the complete feed is shown on wiki pages i.e. how and which channel items are shown are listed.

This is the template MediaWiki:Rss-item (since version 1.90) which determines which item elements are used^[2]

{{ MediaWiki:Rss-feed \
| title = {{{title}}} \
| link = {{{link}}} \
| date = {{{date}}} \
| author = {{{author}}} \
| description = {{{description}}} }}

The selected items are passed to the other template MediaWiki:Rss-feed (since version 1.90)^[2] which determines how the RSS Feed is rendered on the wiki pages. It iterates over each <item> of the RSS feed and substitutes the value of each element found there, e.g. <title>, <link>, <date>, <author>, etc.

Basic MediaWiki:Rss-feed template:

; '''<span class='plainlinks'>[{{{link}}} {{{title}}}]</span>'''
: {{{description}}}
: {{{author}}} {{{date}}}<!-- don't use newline here -->

An alternative improved MediaWiki:Rss-feed template requires the Extension:ParserFunctions:

<!-- The second is an improved version which requires Extension:ParserFunctions --> \
; '''<span class='plainlinks'>[{{{link}}} {{{title}}}]</span>''' \
{{#if: {{{description|}}} \
|: {{{description}}}}}{{#if: {{{author|}}} \
| {{#if: {{{date|}}} |: — {{{author}}} {{{date}}}}} \
| {{#if: {{{author|}}}|: — {{{author}}}}} {{#if: {{{date|}}}|:{{{date}}}}}|}}<!-- don't use newline here -->

The following code renders the four recent items of the wikimedia blog feed on the present page and highlights some terms. The layout depends on the content of feed template MediaWiki:Rss-feed and also of the item template MediaWiki:Rss-item as mentioned above:

<rss max=4 highlight="community wiki foundation">https://wikimediafoundation.org/news/feed/</rss>

Add any one of the following settings you want to customize to your LocalSettings.php .

if ( isset( $wgRSSAllowImageTag ) && $wgRSSAllowImageTag ) {
            $extraInclude[] = "img";
        } else {
            $extraExclude[] = "img";
        }

RSS extension is a heavily modified version of the engines RSS by Mafs, RSS by Rdb78, RSS by Duesentrieb, and RSSFeed by Mutante.

• Category:RSS extensions
• A tool to generate RSS feeds for pages in MediaWiki categories: toollabs:mediawiki-feeds

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.

This extension is included in the following wiki farms/hosts and/or packages: BlueSpice Miraheze MyWikis ShoutWiki WikiForge This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.