Extension:CentralNotice

CentralNotice allows central distribution of small bits of translatable content (a.k.a banners) to subscribing wikis from one central infrastructure wiki. If you only need to post one global message (sitenotice) to a single wiki, consider using MediaWiki:Sitenotice instead.

Installation
Note: CentralNotice is developed, tested, and known to be deployed only on wikis that do not use table prefixing. If your setup uses table prefixing there is no guarantee this plugin will work.

For all wikis

 * 1) Download the latest snapshot and extract it to your extensions directory.
 * 2) Add  or similar (depending on where your extension directory is located) to LocalSettings.php.

The infrastructure wiki

 * 1) From the command line, go to the wiki root and run
 * 2) Edit   and set ...
 * 3)   to true
 * 4)   to be an array of projects that will subscribe to the central wiki. For example
 * 5) By default the   group is the only group with the ability to administer CentralNotice. If additional groups are needed, assign them the   and   permissions.

Subscribing wikis
Edit  and set... (For more information about these and other settings, please see .)
 * 1)   to false
 * 2)   to be an entry in
 * 3)   to the protocol (potentially neutral) and domain of the central wiki. For example
 * 4)   to the public script path on the central wiki. For example
 * 5)   to the URL of Special:BannerRandom on the central wiki. For example:
 * 6)   to the URL of Special:RecordImpression on the central wiki. For example:

Getting help
The wikimedia fundraising team are the maintainers of CentralNotice. For questions about installation, bug reports, or usage of CentralNotice please send an email to [mailto:wikitech-l@lists.wikimedia.org wikitech-l@lists.wikimedia.org] or join us on Freenode in channel #wikimedia-fundraising.

Permissions

 *   — Permission required to modify campaigns and banners. Relevant only to the infrastructure wikis (see also 26377).
 *   is required to edit banner content.

Design concepts
From a user facing perspective, the high level CentralNotice objects are campaigns (a.k.a. notices) and banners (a.k.a. templates). These are affected by the back end concepts of selectors and allocation.


 * Banner — a single block of translatable html/wikitext/css/javascript that will display at the top of  pages. The user status, device type, UI language selectors are applied to banners.
 * Banners may be grouped by category. All banners in a category share user side cookies, such as the hiding cookie that is set when a user clicks a banner close button.
 * Campaign — a collection of banners. The project, country and content language selectors apply at the campaign level. The system allows as many active campaigns at the same time as you want dynamically calculating an allocation for each banner in an active campaign. Campaigns are defined as active if the central wiki time is greater than the campaign start time, less than the campaign end time, and the campaign is marked as enabled.
 * Banners in a campaign are assigned a bucket and weight. Buckets are yet another selector, and weight affects the relative allocation of banners inside a campaign.
 * There are four priority levels in CentralNotice. Higher priority campaigns will get a greater allocation of page views.
 * Campaigns may be locked which will prevent editing and deletion of the campaign; but not the banners inside a campaign.
 * Selector — any property which may be filtered on for the purposes of allocation. This allows, for example, different banners to be shown to logged in versus logged out users in Argentina browsing Wikipedia in English.
 * A selection vector is the complete set of selectors a user presents to the central wiki when requesting a banner.
 * Allocation — The chance a banner will be shown to a user under a given selection vector.

Design documents

 * Banner allocation algorithm
 * Database schema / table layout

Usage
Full usage instructions can be found at meta:Help:CentralNotice.

New Banner

 * 1) Load Special:NoticeTemplate
 * 2) Click on the add banner link at the bottom of the page (must be logged in as an admin).
 * 3) Enter in a name and the raw HTML for the given banner.
 * 4) If this banner is going to be translated then enclose any text to be translated with triple parens -.
 * 5) Submit

New Campaign

 * Each banner has its banner definition stored in MediaWiki:Centralnotice-template-
 * All of its messages are stored below the banner def ala MediaWiki:Centralnotice-template- - /


 * 1) Load Special:CentralNotice
 * 2) Add a campaign with a given start time at the bottom portion of the page and click submit.
 * 3) If this campaign is only run on a specific wiki and or language then select it from the pull downs.
 * 4) Click on the new campaign and add the banners you want within this running campaign and their respective weights.
 * 5) If all looks well then set this campaign to enabled and it will show at the corresponding time.

Testing
You can test-load any banner on any wiki by adding  to the end of the URL.

You can simulate loading a wiki page from any country (to test campaign geotargeting) by adding ? to the end of the URL. (Use the 2-letter ISO 3166-1 code.)

API
CentralNotice adds an API call centralnoticeallocations. This call returns the expected allocation of banners for both anonymous and logged in users in a given country, language, and project group.

It accepts three arguments
 * project - The project to filter on, ie: 'wikipedia' or 'wikibooks'
 * country - The ISO country code to filter on, ie: 'US' or 'RU'
 * language - The ISO language code to filter on, ie: 'en' or 'es'

As of this time, the XML output of this API does not work.

Development

 * /Phase 2 - Completed
 * /Phase 3 - Completed
 * /Caching Overhaul -- Edge Side Includes
 * /BannerController Events
 * /Caching Overhaul - Frontend Proxy