Extension: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 | ||
| Last version | 2.22 (2013-06-09) | ||
| MediaWiki | 1.21 | ||
| License | GPL | ||
| Download | |||
|
|||
|
|||
| Check usage and version matrix; stats |
|||
| Bugs: list open list all report | |||
The RSS extension renders ("displays") one or more RSS feeds on a wiki page in a standard or user-definable format. Since version 2.00, the extension is compatible with Extension:WikiArticleFeeds which generates RSS or ATOM feeds from MediaWiki pages (authoring tool).
Contents |
Download[edit]
You can download the extension directly from the MediaWiki source code repository (browse code). You can get:
- One of the extensions tags
Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag
- Go to the tags list
- Click the name of the tag you want to download
- Click "snapshot"
- The latest version of one of the extensions branches
Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.
- Go to the branches list
- Click the branch name
- Click "snapshot"
- A snapshot made during the release of a MediaWiki version.
This might be unstable and is not guaranteed to work with the associated MediaWiki version.
After you've got the code, save it into the extensions/RSS directory of your wiki.
If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:
cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/RSS.git
Installation[edit]
- Download and extract the files in a directory called "
RSS" in your extensions/ folder. - Add the following code to your LocalSettings.php (at the bottom)
require_once( "$IP/extensions/RSS/RSS.php" );
Done – Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.
Usage[edit]
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:
| optional tag attributes | comment |
|---|---|
template="name" |
'name' (default: rss-item) is the name of a page in the MediaWiki template namespace (default: MediaWiki:Rss-item), which is a template which comprises the name of another template (default: MediaWiki:Rss-feed since version 1.90; Template:RSSPost before version 1.90) and a list of named variables of RSS Feed channel subelements (item), these values then being passed to this other template to finally format the RSS items |
templatename="Pagename" or
|
'Pagename' is the name of a template page which is used in the default template MediaWiki:Rss-item (defining the channel subelements) to finally format the RSS items; the template can be in the template namespace (first example denotes a page Template:Pagename) or any other namespace (second example uses the full specified form Namespace:Pagename) |
max="n" |
show at most n channel subelements (items) |
highlight="term1 term2 ..." |
highlight terms in different colours |
filter="term1 term2 ..." |
show only RSS items with at least one of the terms |
filterout="term1 term2 ..." |
do not show any RSS item containing any of these terms |
reverse |
display the RSS items in reverse order |
date="(Y-m-d H:i:s)" |
date format string[1] (since r111347) |
item-max-length="1000" |
limits the number of character in item descriptions (since r111350) This is not correctly working in v2.18 see bug 30377. |
This extension supports filtering-out (i.e. grep -v) items based on title when in short list mode.
Templates for channel subelements and styling the RSS Feed[edit]
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-item template:
; '''<span class='plainlinks'>[{{{link}}} {{{title}}}]</span>'''
: {{{description}}}
: {{{author}}} {{{date}}}<!-- don't use newline here -->
An alternative improved MediaWiki:Rss-item 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 -->
Example[edit]
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">http://blog.wikimedia.org/feed/</rss>
- A beautiful movement for free access to Wikipedia is growing from a slum in South Africa
- Joe Slovo Park (Cape Town, South Africa) as seen from the entrance to Sinenjongo High School. Joe Slovo Park is a slum. Mass unemployment. Drunkenness and drug addiction. Gangs. Teenage pregnancy. ...
- — 2013-06-19 12:00:02
- Call for input on the new Wikimedia Foundation privacy policy
- Since the launch of Wikipedia in 2001, the community has grown from a few inspired individuals to tens of thousands of volunteers, working on twelve official Wikimedia Projects, in hundreds of lang...
- — 2013-06-18 18:00:51
- Swedish Wikipedia surpasses 1 million articles with aid of article creation bot
- On June 15, 2013, Swedish Wikipedia hit one million articles, joining the club of English, Dutch, German, French, Italian, Russian and Spanish Wikipedias. The article that broke the barrier was the...
- — 2013-06-17 17:48:44
- PRISM, government surveillance, and Wikimedia: Request for community feedback
- Last week, news outlets published information about a U.S. government internet surveillance program called PRISM[1] that reportedly enables the U.S. government to directly collect personal...
- — 2013-06-14 23:30:18
Configuration settings[edit]
| parameter | default | comment |
|---|---|---|
| $wgRSSCacheAge | 3600 (one hour) | Store entries in memcached for this many seconds |
| $wgRSSCacheCompare | false | Check cached content, if available, against remote. $wgRSSCacheCompare should be set to false or a timeout in seconds which is less than $wgRSSCacheAge after which a comparison will be made. |
| $wgRSSFetchTimeout | 15 (since version 1.94) 5 (until version 1.93) |
read timeout in seconds |
| $wgRSSUserAgent | 'MediaWikiRSS/<Version> (+http://www.mediawiki.org/wiki/Extension:RSS) / MediaWiki RSS extension' | User-Agent to use for fetching feeds |
| $wgRSSNamespaces | null | Ignore the RSS tag in all but the namespaces listed here
|
| $wgRSSUrlWhitelist
|
array() (deny any URL = no whitelisted URLs) | URL whitelist of RSS Feeds, the whitelist is empty by default and no URLs are allowed. If there are items in the array, and the used feed URL isn't in the array, it will not be allowed. Use array( "*" ) if you as admin want to allow anyone to use any feed Url. |
| $wgRSSAllowedFeeds
|
array() (allow any URL ) | URL whitelist of RSS Feeds: if there are items in the array, and the used URL isn't in the array, it will not be allowed (originally proposed in bug 27768) |
| $wgRSSUrlNumberOfAllowedRedirects
|
0 (no redirects are allowed) | Maximum number of redirects to follow (defaults to 0). This should only be used when the target URLs are trusted to avoid attacks on intranet services accessible by HTTP. |
| $wgRSSProxy | false | Optional proxy server to be used for fetching feeds false: no proxy used |
| $wgRSSDateDefaultFormat | "Y-m-d H:i:s" | default date format[1] for RSS publication dates (since r111347) |
| $wgRSSItemMaxLength (deactivated in version 2.12 r113297; will be activated later.)[3] |
200 | default maximum length of item descriptions (since r111350) |
| $wgRSSAllowLinkTag | false | to allow active links in feed items |
| $wgRSSAllowImageTag | false | If you allow to see images in feed items. Do not confuse this parameter with $wgAllowImageTag of MediaWiki core, Display of images causes privacy problems, because the image is fetched in the browser context, so the (image-) server log will contain data of the requesting browser, see the discussion here. |
Technical history and attributions[edit]
RSS extension is a heavily modified version of the engines RSS by Mafs, RSS by Rdb78, RSS by Duesentrieb, and RSSFeed by Mutante.
See also[edit]
- ↑ 1.0 1.1 http://php.net/date
- ↑ 2.0 2.1 2.2 Former versions before 1.90 used the name Template:RSSPost in the template MediaWiki:Rss-item which thus had the default value
{{ RSSPost | title = {{{title}}} | link = {{{link}}} | date = {{{date}}} | author = {{{author}}} }} - ↑ bug30377
- Alternate extensions:
 |
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. |
