Extension:WikimediaCampaignEvents
Release status: stable |
|
---|---|
Implementation | Special page |
Description | Provides Wikimedia specific features for the CampaignEvents extension. |
Author(s) | Connection Team |
Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
Database changes | Yes |
Tables | wikimedia_campaign_events_grant |
License | GNU General Public License 2.0 or later |
Download | |
Help | Help:Extension:WikimediaCampaignEvents |
|
|
Translate the WikimediaCampaignEvents extension if it is available at translatewiki.net | |
Issues | Open tasks · Report a bug |
Provides Wikimedia-specific features for the CampaignEvents extension. In particular, adds support for grants, and communicates with fluxx.io's grant management software. Organizers can associate their Grant ID with Event Registration data, so that it is easier to analyze the impact of their events.
Installation
[edit ]- Download and move the extracted
WikimediaCampaignEvents
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cdextensions/ gitclonehttps://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
[edit ]Configuration
[edit ]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
[edit ]Documentation of all the API endpoints is available.
Integration with the Wikidata Query Service
[edit ]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
[edit ]- Stable extensions
- Special page extensions
- GPL licensed extensions
- Extensions in Wikimedia version control
- BeforePageDisplay extensions
- CampaignEventsGetAllEventsTabs extensions
- CampaignEventsGetEventDetails extensions
- CampaignEventsRegistrationFormLoad extensions
- CampaignEventsRegistrationFormSubmit extensions
- LoadExtensionSchemaUpdates extensions
- ParserFirstCallInit extensions
- All extensions
- Extensions used on Wikimedia
- Wiki-specific extensions