Extension:FeaturedFeeds

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
FeaturedFeeds

Release status: stable

px
Implementation Data extraction, API, Hook
Description Adds syndication feeds of wiki's featured content
Author(s) Max Semenik (MaxSemtalk)
Latest version continuous updates
MediaWiki 1.19+
PHP 5.2+
Database changes no
License WTFPL 2.0
Download
CHANGELOG
Parameters

$wgFeaturedFeedsDefaults
$wgFeaturedFeeds
$wgDisplayFeedsInSidebar

Hooks used
BeforePageDisplay

ArticleSaveComplete
SkinTemplateOutputPageBeforeExec
FeaturedFeeds::getFeeds

Translate the FeaturedFeeds extension if possible

Check usage and version matrix; code metrics
Bugs: list open list all report

FeaturedFeeds is an extension that creates daily feeds (Atom or RSS) of wiki's featured content (ranging from Featured Articles to Media of the Day). The feeds are added to site's main page and are available via the API. See also: /WMF deployment, wikis using this extension.

Using FeaturedFeeds[edit | edit source]

This extension requires that wikis use an automated process to publish their featured content daily (or at least very often).

Installation[edit | edit source]

  1. Download the files from Git or download a snapshot. Choose the version that matches your version of MediaWiki.
  2. Create a directory FeaturedFeeds in your $IP/extensions directory.
  3. Extract the files to this $IP/extensions/FeaturedFeeds directory.
  4. Add to the end of LocalSettings.php:
    require_once("$IP/extensions/FeaturedFeeds/FeaturedFeeds.php");
  5. Installation can now be verified through Special:Version on your wiki

Configuration[edit | edit source]

A wiki must have some means of caching set up to use FeaturedFeeds, or everything will be super slow.

Settings[edit | edit source]

Variable name Description
$wgFeaturedFeeds Contains array of feed definitions in the following format:
'feed name' => array(
	'page' => <message name>,
	'title' => <message name>,
	'description' => <message name>,
	'entryName' => <message name>,
)

Mandatory items:

'page'
Name of the message that contains expression that evaulates to the title of the page with today's feed entry. For example, for English Wikipedia's featured articles feed it could contain Wikipedia:Today's featured article/{{#time:F j, Y}} that evaluates (using ParserFunctions, but ordinary date/time magic words may be used as well) to Wikipedia:Today's featured article/April 15, 2014. This message always uses content language.
'title'
Name of the message that contains feed title, for example "Joe's wiki nonsense of the day feed".
'description'
A longer description of the feed, used for <subtitle> Atom element and <description> RSS element.
'entryName'
Name of the message that contains heading of feed's individual entries.

Also see below for optional settings.

$wgFeaturedFeedsDefaults Provides default values for some parameters of every feed from $wgFeaturedFeeds.

Default value:

array(
	'limit' => 10,
	'inUserLanguage' => false,
)
'limit'
Maximum number of entries (ie number of days) in the feed.
'inUserLanguage'
Whether user's preferred language should be honored by the feed. For example, it doesn't make much sense to have English Wikipedia's featured articles feed in languages other than English as the content is always in English anyway. But Commons' picture of the day feed contains images and their descriptions that are available in many languages, so it actually benefits from its description's localisation.
$wgDisplayFeedsInSidebar Whether links to feeds should be displayed in sidebar on main page

On-site configuration[edit | edit source]

API module[edit | edit source]

FeaturedFeeds adds API action=featuredfeed. Parameters:

feedformat
feed format, rss or atom. If omitted, RSS will be assumed.
feed
Feed name. Required.
language
Feed language. Not the language of Wikipedia from which to retrieve data, but akin to uselang=<...> parameter to index.php. Might be ignored, depending on each feed's settings. If omitted, content language will be assumed.