View source for Extension:FeaturedFeeds/WMF deployment

== Notes to site administrators ==

=== Wikimedia feeds ===
The following feeds are supported:
<!-- "In user language" according to ['inUserLanguage'] = true; mediawiki-config/wmf-config/FeaturedFeedsWMF.php spage 2015-07-26 -->
{| class="wikitable"
! Name !! Description !! Projects available on || In user language
|-
| featured || [[w:WP:FA|Featured articles]] || Wikipedia ||
|-
| onthisday || [[w:WP:OTD|On this day...]] || Wikipedia ||
|-
| dyk || [[w:WP:DYK|Did you know?]] || Wikipedia ||
|-
| motd || [[commons:COM:MOTD|Media of the day]] || Wikipedia, Commons || yes
|-
| potd || [[w:WP:POTD|Picture of the day]] || Wikipedia, Commons || yes
|-
| qotd || [[q:WQ:QOTD|Quote of the day]] || Wikiquote ||
|-
| wotd, fwotd || [[wikt:WT:WOTD|Word of the day]], [[wikt:WT:FWOTD|Foreign word of the day]] || Wiktionary ||
|-
| featuredtexts || [[s:Portal:Featured_texts|Featured text]] || Wikisource ||
|-
| technews || [[m:Tech/News|Tech News]] || Meta-wiki ||
|}

<section begin="messages"/>

=== Message names ===

Each feed has the following [[Manual:System message|messages]] controlling its behavior (replace ''*'' with feed name, chosen among those above):

{| class="wikitable"
! Message !! Description !! Example
|-
| ffeed-*-page
| Title of the page that contains day's featured content.<br/>Has one optional [[Localisation#Message parameters|parameter]], <code>$1</code>, which gets substituted with feed language code for use in multilingual feeds (currently, only on Commons).
| <code><nowiki>Wikipedia:Today's featured article/{{#time:F j, Y}}</nowiki></code>
|-
| 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 || <code><nowiki>{{CURRENTMONTHNAME}} {{CURRENTDAY}} Wikipedia featured article</nowiki></code>
|}

=== How to set up a feed ===

Create a page named <code>MediaWiki:Ffeed-*-page</code> 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. [[w:Wikipedia:Today's featured article/{{#time:F j, Y}}|Wikipedia:Today's featured article/{{#time:F j, Y}}]] on the English Wikipedia. In such case, the title can use [[Help:Magic words#Date and time|date and time magic words]] or <code>{{ll|Help:Extension:ParserFunctions#.23time|<nowiki>#time</nowiki>}}</code> parser functions to incorporate the date in the page title. The title in the example here is <code><nowiki>Wikipedia:Today's featured article/{{#time:F j, Y}}</nowiki></code>.
* The wiki uses a single template that uses date magic internally to display proper content. In such cases, either point <code>MediaWiki:Ffeed-*-page</code> to that template directly, or, if it has {{tag|noinclude|open}} sections not intended for readers to see, point it to a page that contains a transclusion of the said template and nothing else.

{{note|If you need to translate or tweak interface messages of a feed, do that before creating <code>MediaWiki:Ffeed-*-page</code>, 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.

<section end="messages"/>

== FAQ ==
=== When FeaturedFeeds can be used and when it can't? ===
This extension requires an automatic featured content rotation system based on date. Currently, only content that changes once per day or less frequently is supported. Manual updates won't work.

=== Where can the feed be accessed? ===
The feed address will be in the form <code>https://it.wikiquote.org/w/api.php?action=featuredfeed&feed=qotd&feedformat=atom</code> (with your domain and feed name, obviously).
Feeds are linked from the {{tag|head|open}} HTML section of the main page.
The extension creates a permanent link for each feed entry (e.g. [[q:it:Speciale:FeedItem/qotd/20120117000000/it]]) even if the feed is loaded from a single template.

=== Our wiki's current featured content changes less than once per day, how can we use FeaturedFeeds? ===
FeaturedFeeds outputs 10 days worth of featured content by default. Thus, if your content changes at least once per 10 days, everything will work. Just make sure that <code>ffeed-*-page</code> evaluates to a valid title only on days there's new content available. Examples:

* '''Featured article every Monday''': <code><nowiki>{{#ifeq: 1 | {{LOCALDOW}} | Template:Featured article/{{LOCALYEAR}}/{{LOCALWEEK}} |}}</nowiki></code> will evaluate to ''Template:Featured article/{{LOCALYEAR}}/{{LOCALWEEK}}'' every monday and will be empty on other days.

* '''Sometimes we have a new featured picture, sometimes not''': <code><nowiki>{{#ifexist: Wikipedia:POTD/{{#time:F j, Y}} | {{POTD}} |}}</nowiki></code>.

=== I have made an edit to a relevant message, but the feed does not change ===
Feeds are cached for up to one hour. Because they are all cached in one batch, you may also not see a change after adding a new feed.

=== Can we put whole featured articles into the feed? ===
You'd better not. Typical featured articles on Wikipedia are huge and are slow to render - even though rendered text is cached, it still requires CPU time and bandwidth to serve. You don't want to have a sysadmin running after you with a huge banhammer, do you? <code>:)</code> Just stick to the same short excerpts shown on main page along with "read more" links.

=== Our wiki has a type of featured content not currently supported. Can we just reuse an existing feed name? ===
For the sake of reusers that might expect a certain type of content under a feed name, just ask us to add a new feed type and we'll do it quickly.

=== Our wiki uses timezone other than UTC. Anything we should know? ===
FeaturedFeeds honors time zones. You might want to use functions that output local time and date such as <nowiki>{{LOCALTIME}} instead of {{CURRENTTIME}}</nowiki>.

=== I did not understand a single word! ===
Just ask for help on [[IRC]], channels {{irc|mediawiki}} and {{irc|wikimedia-mobile}}, we'll be happy to help you set up the extension on your wiki.

== Technical notes for deployment ==
* WMF configuration enables FeaturedFeeds on most Wikimedia wikis.
* WMF configuration runs the hook code in {{git file |project=operations/mediawiki-config|file=wmf-config/FeaturedFeedsWMF.php}} on the <code>FeaturedFeeds::getFeeds</code> event to configure the feeds [[#Wikimedia feeds | described above]] on each wiki.
* <code>$wgDisplayFeedsInSidebar</code> is generally set to false.

== Per-site rollout ==
For languages [[User:MaxSem|yours sincerely]] could grok in 5 minutes ''(back in 2012, mostly)'':

=== Commons ===
* POTD: [[:commons:MediaWiki:ffeed-potd-page|<nowiki>{{Template:Potd|lang={{int:lang}}|noeditlinks=1}}</nowiki>]]
* MOTD: [[:commons:MediaWiki:ffeed-motd-page|<nowiki>{{Template:Motd|lang={{int:lang}}|noeditlinks=1}}</nowiki>]]

=== Wikipedias ===
English (en)
* FA: [[w:MediaWiki:ffeed-featured-page|<nowiki>Wikipedia:Today's featured article/{{#time:F j, Y}}</nowiki>]]
* OTD: [[w:MediaWiki:ffeed-onthisday-page|<nowiki>Wikipedia:Selected anniversaries/{{#time:F j}}</nowiki>]]
* POTD: [[w:MediaWiki:ffeed-potd-page|<nowiki>Template:POTD protected/{{#time:Y-m-d}}</nowiki>]]

Indonesian (id)
* Rotating FA
* OTD: [[:id:MediaWiki:ffeed-onthisday-page|<nowiki>Templat:HariIniDalamSejarah/{{CURRENTDAY}} {{CURRENTMONTHNAME}}</nowiki>]]
* Has a daily DYK at <nowiki>Wikipedia:Tahukah Anda/{{CURRENTDAY}} {{CURRENTMONTHNAME}}</nowiki>

Malay (ms)
* Monthly FA
* Weekly pics
* Weekly DYK
* OTD: [[:ms:MediaWiki:ffeed-onthisday-page|<nowiki>Wikipedia:Hari ulang tahun pilihan/{{CURRENTDAY}} {{CURRENTMONTHNAME}}</nowiki>]]

Bulgarian (bg)
* Weekly FA: [[:bg:MediaWiki:ffeed-featured-page|<nowiki>Шаблон:Избрана статия {{#time: W o}}</nowiki>]]
* OTD: [[:bg:MediaWiki:ffeed-onthisday-page|<nowiki>Шаблон:Начална страница {{CURRENTDAY}} {{CURRENTMONTHNAME}}</nowiki>]]
* POTD from Commons

Catalan (ca)
* FA: [[:ca:MediaWiki:ffeed-featured-page|<nowiki>Plantilla:article {{LOCALMONTHNAME}} {{LOCALDAY}}</nowiki>]]
* OTD: [[:ca:MediaWiki:ffeed-onthisday-page|<nowiki>Plantilla:{{LOCALMONTHNAME}} {{LOCALDAY}}</nowiki>]]

Chinese (zh)
* Weekly FA: [[:zh:MediaWiki:ffeed-featured-page|<nowiki>Wikipedia:特色条目/{{CURRENTYEAR}}年第{{CURRENTWEEK}}周</nowiki>]]
* OTD:  [[:zh:MediaWiki:ffeed-onthisday-page|<nowiki>Wikipedia:历史上的今天/{{CURRENTMONTHNAME}}{{CURRENTDAY}}日</nowiki>]]
* DYK: ?
* ITN: ?
* GA: ?
* POTD: [[:zh:MediaWiki:ffeed-potd-page|<nowiki>Wikipedia:每日图片/{{CURRENTYEAR}}年{{CURRENTMONTHNAME}}{{CURRENTDAY}}日</nowiki>]]

French (fr)
* FA: [[:fr:MediaWiki:ffeed-featured-page|<nowiki>Wikipédia:Lumière sur/{{ucfirst:{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</nowiki>]]
* POTD: [[:fr:MediaWiki:ffeed-potd-page|<nowiki>Wikipédia:Image du jour/{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}</nowiki>]]

Tamil (ta)
* OTD: [[:ta:MediaWiki:ffeed-onthisday-page|<nowiki>விக்கிப்பீடியா:ஆண்டு_நிறைவுகள்/{{#time:F j}}</nowiki>]]
* DYK Weekly on Wednesday : [[:ta:MediaWiki:ffeed-dyk-page|<nowiki>விக்கிப்பீடியா:உங்களுக்குத்_தெரியுமா/{{CURRENTMONTHNAME}}_{{#expr: {{CURRENTDAY}} - {{CURRENTDOW}} + 3}}, {{LOCALYEAR}}</nowiki>]]
* FA Weekly on Sunday : [[:ta:MediaWiki:ffeed-featured-page|<nowiki>விக்கிப்பீடியா:முதற்பக்கக் கட்டுரைகள்/{{CURRENTMONTHNAME}} {{#expr: {{CURRENTDAY}} - {{CURRENTDOW}}}}, {{LOCALYEAR}}</nowiki>]]
* ITN: [[:ta:MediaWiki:ffeed-news-page|<nowiki>{{வார்ப்புரு:நடப்பு_நிகழ்வுகள்/தலைப்புச்_செய்திகள்}}</nowiki>]]

Czech (cs)
* FA: Weekly: [[:cs:MediaWiki:ffeed-featured-page|<nowiki>Wikipedie:Článek týdne/{{#time:o/W}}</nowiki>]]
* OTD: [[:cs:MediaWiki:ffeed-onthisday-page|<nowiki>Wikipedie:Vybraná výročí dne/{{CURRENTDAY}}. {{CURRENTMONTHNAME}}</nowiki>]]
* POTD: Weekly: [[:cs:MediaWiki:ffeed-potd-page|<nowiki>Wikipedie:Obrázek týdne/{{#time:o/W}}</nowiki>]]
* DYK: Weekly [[:cs:MediaWiki:ffeed-dyk-page|<nowiki>Wikipedie:Zajímavosti/{{#time:o/W}}</nowiki>]]

Swedish (sv)
* OTD: [[:sv:MediaWiki:ffeed-onthisday-page|<nowiki>Mall:{{LOCALDAY}} {{LOCALMONTHNAME}}</nowiki>]]

Persian (fa)
* FA: Weekly: [[:fa:MediaWiki:ffeed-featured-page|<nowiki>ویکی‌پدیا:نوشتار پیشنهادی هفته/{{CURRENTYEAR}}/{{CURRENTWEEK}}
</nowiki>]]
* OTD: Daily: [[:fa:MediaWiki:ffeed-onthisday-page|<nowiki>ویکی‌پدیا:یادبودهای برگزیده/{{CURRENTDAY}} {{CURRENTMONTHNAME}}
</nowiki>]]
* POTD: Daily: [[:fa:MediaWiki:ffeed-potd-page|<nowiki>الگو:نر محافظت شده/{{formatnum:{{#time:Y-m-d}}|R}}
</nowiki>]]
* DYK: Daily: [[:fa:MediaWiki:ffeed-dyk-page|<nowiki>ویکی‌پدیا:آیا می‌دانستید که...؟/هفته {{#time: W}}
</nowiki>]]