Extension:FeaturedFeeds

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg 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.4+
Database changes	No
License	WTFPL 2.0
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate> CHANGELOG
Parameters $wgFeaturedFeedsDefaults $wgDisplayFeedsInSidebar $wgFeaturedFeeds
Hooks used BeforePageDisplay PageSaveComplete SidebarBeforeOutput
Hooks provided FeaturedFeeds::getFeeds
Quarterly downloads
Public wikis using
Translate the FeaturedFeeds extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

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 featuredfeed API module. See also: Extension:FeaturedFeeds/WMF deployment .

Using FeaturedFeeds

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

Installation

• <translate> [[<tvar name=2>Special:ExtensionDistributor/FeaturedFeeds</tvar>|Download]] and move the extracted <tvar name=name>FeaturedFeeds</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/FeaturedFeeds
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'FeaturedFeeds' );
  

• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration

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

Settings

Variable name	Description
$wgFeaturedFeeds	Contains array of feed definitions in the following format: 'feed name' => [ 'page' => <message name>, 'title' => <message name>, 'description' => <message name>, 'entryName' => <message name>, ] Mandatory items: 'page' Name of the interface message that contains an expression that evaluates 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/December 24, 2024. This message always uses content language. 'title' Name of the interface message that contains feed title, for example "My Page of the Day Feed". 'description' A longer description of the feed, used for ‎<subtitle> Atom element, and ‎<description> RSS element. 'entryName' Name of the interface 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: [ '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

See the full subpage for details on the Wikimedia projects configuration

{{#lst:Extension:FeaturedFeeds/WMF deployment|messages}}

API module

www.linuxwebexpert.com has no featured feeds, so the generated API documentation on this wiki is not very useful.

Instead, see the generated API documentation on enwiki, which lists the feeds it provides and has a working example.