Erweiterung:FeaturedFeeds

This page is a translated version of the page Extension:FeaturedFeeds and the translation is 83% complete.
Other languages:
MediaWiki-Erweiterungen
OOjs UI icon advanced-invert.svg
FeaturedFeeds
Freigabestatus: stabil
px
Einbindung Daten-Extraktion, API , Hook
Beschreibung Adds syndication feeds of wiki's featured content
Autor(en) Max Semenik (MaxSemDiskussion)
Letzte Version continuous updates
MediaWiki 1.19+
PHP 5.4+
Datenbankänderungen Nein
Lizenz WTFPL 2.0
Herunterladen
CHANGELOG
  • $wgFeaturedFeedsDefaults
  • $wgDisplayFeedsInSidebar
  • $wgFeaturedFeeds
Übersetze die FeaturedFeeds-Erweiterung, wenn sie auf translatewiki.net verfügbar ist

Prüfe die Benutzungs- und Versionsmatrix.

Probleme Offene Aufgaben · Einen Fehler melden

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).

Herunterladen

Die Erweiterung kann direkt von Git bezogen werden [?]:

  • Den Code ansehen
  • Einige Erweiterungen haben Tags für stabile Versionen.
  • Jeder Zweig ist mit einer früheren MediaWiki-Freigabe verknüpft. Es gibt auch einen „Master“-Zweig, der die aktuellste Alpha-Version enthält (möglicherweise ist dafür eine Alpha-Version von MediaWiki erforderlich).

Extrahiere den Snapshot und kopiere ihn in das extensions/FeaturedFeeds/-Verzeichnis der MediaWiki-Installation.

Falls man sich mit git auskennt und einen Konsolen-Zugang zum Server hat, kann man die Erweiterung auch so bekommen:

cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/FeaturedFeeds.git

Installation

  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens FeaturedFeeds im Ordner extensions/ ablegen.
  • Folgenden Code am Ende deiner LocalSettings.php hinzufügen:
    wfLoadExtension( 'FeaturedFeeds' );
    
  •   Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Konfiguration

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

Einstellungen

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/August 4, 2022. 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


Message names

Each feed has the following messages controlling its behavior (replace * with feed name, chosen among those above):

Message Description Example
ffeed-*-page Title of the page that contains day's featured content.
Has one optional parameter, $1, which gets substituted with feed language code for use in multilingual feeds (currently, only on Commons).
Wikipedia:Today's featured article/{{#time:F j, Y}}
ffeed-*-title Feed name Wikipedia featured articles feed
ffeed-*-short-title Short feed name, could be used on sidebar in the future Featured articles
ffeed-*-desc More lengthy feed description Best articles on Wikipedia!!!
ffeed-*-entry Title of each day's entry {{CURRENTMONTHNAME}} {{CURRENTDAY}} Wikipedia featured article

How to set up a feed

Create a page named MediaWiki:Ffeed-*-page containing the page title (again, replace * with the feed's name). Two cases are possible here:

  • The wiki has a new page for each day, e.g. Wikipedia:Today's featured article/August 4, 2022 on the English Wikipedia. In such case, the title can use date and time magic words or #time parser functions to incorporate the date in the page title. The title in the example here is Wikipedia:Today's featured article/{{#time:F j, Y}}.
  • The wiki uses a single template that uses date magic internally to display proper content. In such cases, either point MediaWiki:Ffeed-*-page to that template directly, or, if it has ‎<noinclude> sections not intended for readers to see, point it to a page that contains a transclusion of the said template and nothing else.
If you need to translate or tweak interface messages of a feed, do that before creating MediaWiki:Ffeed-*-page, otherwise your new feed might take up to one hour to catch up these changes.

How to publish feeds in the sidebar

Just create page MediaWiki:Ffeed-enable-sidebar-links with content other than a dash (-) or an empty string. A section called "Featured content feeds" will appear in the sidebar on the main page.


API module

www.mediawiki.org 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.