Extension:CampaignEvents/pl
CampaignEvents is a MediaWiki extension, created and maintained by the Wikimedia Foundation Connection Team, which provides tools for organizing and running events, including registration, communication and an organizer dashboard. See Pomoc:Rozszerzenie:CampaignEvents and Registration for more information.
Instalacja
- Pobierz i umieść plik(i) w katalogu o nazwie
CampaignEventsw folderzeextensions/.
Developers and code contributors should install the extension from Git instead, using:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CampaignEvents
- Dodaj poniższy kod na dole twojego pliku LocalSettings.php:
wfLoadExtension( 'CampaignEvents' );
- Uruchom skrypt aktualizujący, który automatycznie stworzy potrzebne tabele dla tego rozszerzenia.
- Install the CLDR extension. This is a hard dependency but cannot be declared as such due to a bug in the MediaWiki installer.
- Schedule a cronjob that runs the #script to update timezones (optional), and one for the #script to aggregate participant answers.
Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.
Konfiguracja
User rights
| Right | Description |
|---|---|
| campaignevents-enable-registration | Włączanie rejestracji na wydarzenia |
| campaignevents-delete-registration | Usuwanie rejestracji na wydarzenia |
| campaignevents-organize-events | Organizowanie wydarzeń |
| campaignevents-email-participants | Wysyłanie e-maili do uczestników wydarzeń |
Parameters
| Variable name | Default value | Description |
|---|---|---|
$wgCampaignEventsProgramsAndEventsDashboardInstance |
null |
Determines which instance of the P&E Dashboard should be used, if any. Supported values are 'production', 'staging', or null to not use the dashboard.
Note that this setting should use the same value for all wikis sharing the same central database for events: otherwise, the application might crash or show inconsistent data when viewing an event created on another wiki. |
$wgCampaignEventsProgramsAndEventsDashboardAPISecret |
null |
API secret to use with the selected P&E Dashboard instance. Must be configured if you intend to use the P&E Dashboard. |
$wgCampaignEventsEnableWikimediaParticipantQuestions |
true |
Whether to enable Wikimedia-specific questions that can be asked to participants, such as whether they belong to a Wikimedia affiliate. |
$wgCampaignEventsEventNamespaces |
[ NS_EVENT, NS_PROJECT ] |
List of permitted namespaces for event registration |
The extension can be configured to store data into a database other than the main wiki DB.
You do so by configuring the virtual-campaignevents domain, see Manual:$wgVirtualDomainsMapping.
For instance:
$wgVirtualDomainsMapping['virtual-campaignevents'] = [ 'db' => 'my_central_db' ];
This is especially useful in combination with a central database that stores event for a whole wiki family. Note, if you do so, that the wiki farm needs to use central user IDs.
API
Documentation of all the API endpoints is available.
Maintenance scripts
Script to update timezones
The extension stores the local time and timezone for each event, to guarantee that the local time remains accurate even if time zone rules change. However,internally it also stores UTC timestamps so that certain operations like sorting are possible. The UTC timestamps may go out of sync with the local ones if time zone rules change, which happens more commonly than you may think. You can read more details. In order to mitigate that, the extension provides a maintenance script that recomputes the UTC timestamps for all events according to the latest timezone rules, and stores them back into the database.
In order for this to work, you have to make sure that PHP has access to the latest version of the tz database. The PHP manual provides some context about this. The easiest solution is to install the timezonedb PECL package and make sure to keep it up-to-date.
Assuming that PHP has access to the latest timezone rules, you can run the script with:
$ php maintenance/run.php ./extensions/CampaignEvents/maintenance/UpdateUTCTimestamps.php
The script also takes an optional --timezone parameter where you can specify the name of a time zone whose rules changed; this parameter can be repeated multiple times.
If passed, the script will only update events whose timezone matches one of the timezones specified via this parameter.
If you upgrade the time zone database automatically (e.g., with a cronjob), you can make that job also execute this script, so that you don't have to do it manually every time you upgrade the time zone database. Otherwise, you can manually run the script after you update the time zone info, or just have it run on a fixed schedule (like once a day).
Script to aggregate participant answers
The extension provides a maintenance script that aggregates participant answers after a 90 day period. The script can be run with:
$ php maintenance/run.php ./extensions/CampaignEvents/maintenance/AggregateParticipantAnswers.php
The script should be configured to run automatically (e.g., as an hourly cronjob) to make sure that PII isn't retained for longer than it needs to.
Zobacz też
- High-level project overview on meta
- Extension:WikimediaCampaignEvents - provides Wikimedia-specific add-ons
 | To rozszerzenie jest wykorzystywane przez jeden lub więcej projektów Wikimedia. Oznacza to prawdopodobnie, że to rozszerzenie jest stabilne i działa wystarczająco dobrze, aby wykorzystywać je na stronach o dużym natężeniu ruchu. Odnajdź nazwę tego rozszerzenia w plikach konfiguracyjnych Wikimedia CommonSettings.php oraz InitialiseSettings.php, aby zobaczyć gdzie są zainstalowane. Pełną listę rozszerzeń zainstalowanych na określonej wiki można znaleźć na stronie Special:Version na danej wiki. |