Extension:TranslationNotifications

MediaWiki extensions manual

TranslationNotifications 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
Latest version	Continuous updates
MediaWiki	1.34+
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review
Example	translatewiki.net
Parameters $wgTranslationNotificationsAlwaysHttpsInEmail $wgTranslationNotificationsSignupLegalMessage $wgTranslationNotificationsContactMethods
Hooks used BeforeCreateEchoEvent GetPreferences
Quarterly downloads	5 (Ranked 129th)
Translate the TranslationNotifications extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The TranslationNotifications 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.

• 
  Signup form
• 
  Notification form

Prerequisites

The extension is useful only if the Translate extension is installed and configured. It uses the MassMessage extension to leave messages on user's talk pages, so that extension should also be installed.

Installation

• Download and move the extracted TranslationNotifications 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/TranslationNotifications
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'TranslationNotifications' );
  

• Configure as required.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

The following configuration variables are used:

$wgTranslationNotificationsContactMethods configures which contact methods are enabled. These are the default values:

$wgTranslationNotificationsContactMethods = [
	'email' => true,
	'talkpage' => true,
	'talkpage-elsewhere' => false,
];

Special pages

Special:TranslatorSignup

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

This page is available for translation managers. They use it to 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

The notifications - email, digest emails, talk page notifications - are done with the help of the Job Queue. You need to configure the job queue execution time as explained in the Job queue manual.

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 sent out.