Release status: stable
|Implementation||Special page, Notify|
|Description||Allows translators sign up for translation notifications|
|Author(s)||Jon Harald Soby, Amir Aharoni, Santhosh Thottingal, Niklas Laxström, Siebrand Mazeland|
|License||GPL 2.0 or later|
Translate the TranslationNotifications extension if it is available at translatewiki.net
|Check usage and version matrix; code metrics|
This extension provides a way to manage the communication with translators on a wiki which uses the Translate extension.
The extension has two main parts:
- For translators
- A form where translators sign themselves up for notifications. They can indicate the languages into which they can translate and preferred contact methods and frequency, including digest options.
- For translation managers
- A form for sending out page translation requests. The notification will be delivered to all translators matching the conditions either immediately or later in a digest email.
Prerequisites[edit | edit source]
The extension is useful only if the Translate extension is installed and configured.
Download instructions[edit | edit source]
The extension can be retrieved directly from Git [?]:
- Browse code
- Some extensions have tags for stable releases.
- Browse tags
- Select the tag
- Click "snapshot"
- Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).
- Browse branches
- Select a branch name
- Click "Continue"
Extract the snapshot and place it in the extensions/TranslationNotifications/ directory of your MediaWiki installation.
If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:
cd extensions/ git clone
Installation[edit | edit source]
To install this extension, add the following to LocalSettings.php:
Configuration[edit | edit source]
The following configuration variables are used:
$wgTranslationNotificationsContactMethods configures which contact methods are enabled. These are the default values:
$wgTranslationNotificationsContactMethods = array( 'email' => true, 'talkpage' => true, 'talkpage-elsewhere' => false, );
$wgNotificationUsername and $wgNotificationUserPassword configure the username and the password for notifying on other wikis. This must be an existing global account on the wiki family. Example:
$wgNotificationUsername = 'TranslationManager'; $wgNotificationUserPassword = 'Loc01izah';
Special pages[edit | edit source]
Special:TranslatorSignup[edit | edit source]
A special page where translators can sign up. Example: Special:TranslatorSignup on Wikimedia's Meta-wiki. Users can set their language preferences (first, second and third language) and the contact method such as email or talk page notifications. It's also possible to ask to be notified on a talk page on a different wiki in the same CentralAuth-based wiki family. They can also choose the frequency of notifications: always (every time there is something to translate), weekly digest or monthly digest. The email option will be available only for users who confirmed their email address.
In the case you have enabled email notification for user talk edits in the wiki of choice, you'll get it also for translation notifications, so it's probably better to select only email as method, to avoid duplicate messages.
Special:NotifyTranslators[edit | edit source]
This page is available for translation managers. They use it notify about the availability of a translatable page (notifications for other message groups are not supported). They can optionally set a deadline and a priority and add a custom message. They can also send the notification only to translators to particular languages. If no languages are set, all the translators who signed up will receive the notification.
The user right required to operate this page is 'translate-manage'. For example, to allow all sysops to use this page, add the following line to your LocalSettings.php file:
$wgGroupPermissions['sysop']['translate-manage'] = true;
Notification configuration[edit | edit source]
The DigestEmailer script needs to be configured using a cron job. For example, it can be scheduled to run on every Sunday 10AM using a crontab entry like the following one:
0 10 * * 7 /usr/bin/php /www/wiki/extensions/TranslationNotifications/scripts/DigestEmailer.php 2>&1 > /var/log/digestEmail.log
The script will not start sending emails immediately. It starts inserting email jobs to the MediaWiki job queue. Depending on the configured job queue scheduling the mails will be send out.
Footnotes[edit | edit source]
- And if the wiki is a part of such a family, of course.
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|