Extension:WikimediaCampaignEvents

Category:Extensions without an imageCategory:GPL licensed extensions
MediaWiki extensions manual
WikimediaCampaignEvents
Release status: stableCategory:Stable extensions
Implementation Special page Category:Special page extensions
Description Provides Wikimedia specific features for the CampaignEvents extension.
Author(s) Campaigns Team
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.Category:Extensions with release branches compatibility policy
Database changes Yes
License GNU General Public License 2.0 or later
Download Category:Extensions in Wikimedia version control
Help Help:Extension:WikimediaCampaignEvents
  • $wgWikimediaCampaignEventsFluxxOauthUrl
  • $wgWikimediaCampaignEventsSparqlEndpoint
  • $wgWikimediaCampaignEventsFluxxClientSecret
  • $wgWikimediaCampaignEventsFluxxClientID
  • $wgWikimediaCampaignEventsFluxxBaseUrl
Quarterly downloads 1 (Ranked 113rd)
Translate the WikimediaCampaignEvents extension if it is available at translatewiki.net
Issues Open tasks · Report a bug
Category:All extensions

Installation

  • Download and move the extracted WikimediaCampaignEvents folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikimediaCampaignEvents
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'WikimediaCampaignEvents' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Add the credentials for the Fluxx API to your LocalSettings.php
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Dependencies

Configuration

Setting name Default value Description
$wgWikimediaCampaignEventsFluxxOauthUrl 'https://wmf.fluxx.io/oauth/token' Oauth URL for the Fluxx API.
$wgWikimediaCampaignEventsFluxxBaseUrl 'https://wmf.fluxx.io/api/rest/v2/' Base URL of the Fluxx API.
$wgWikimediaCampaignEventsFluxxClientID null Client ID to use for the Fluxx API.
$wgWikimediaCampaignEventsFluxxClientSecret null Client secret to use for the Fluxx API.
$wgWikimediaCampaignEventsSparqlEndpoint 'https://query-main.wikidata.org/sparql' The URL of the primary SPARQL endpoint.

API

Documentation of all the API endpoints is available.

Integration with the Wikidata Query Service

The extension integrates with the Wikidata Query Service to show a list of all WikiProjects on Special:AllEvents. This functionality is implemented via the WikiProjectIDLookup class, which is based on SparqlClient.

WikiProjects are stored in the main stash for up to one week. However, the list is regenerated as soon as the value is older than one hour. All the value regenerations happen in a deferred update that does not block the main request: the user might be served a stale value while the fresh list is regenerated asynchronously.

Note that, if nobody visits the Special:AllEvents page for a whole week, the list of WikiProjects would expire, and an error would be shown upon loading the page. A data update should be enqueued at the same time, so the data should become available again shortly afterwards.

See also

Category:Extensions used on Wikimedia#WikimediaCampaignEvents Category:Wiki-specific extensions
Category:All extensions Category:CampaignEventsGetAllEventsTabs extensions Category:CampaignEventsGetEventDetails extensions Category:CampaignEventsRegistrationFormLoad extensions Category:CampaignEventsRegistrationFormSubmit extensions Category:Extensions in Wikimedia version control Category:Extensions used on Wikimedia Category:Extensions with release branches compatibility policy Category:Extensions without an image Category:GPL licensed extensions Category:LoadExtensionSchemaUpdates extensions Category:ParserFirstCallInit extensions Category:Special page extensions Category:Stable extensions Category:Wiki-specific extensions