Extension:TranslationNotifications

From MediaWiki.org
Jump to: navigation, search

Other languages:
English 100% • ‎español 57% • ‎polski 10% • ‎português do Brasil 100% • ‎中文 10%
MediaWiki extensions manual
Crystal Clear action run.png
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
MediaWiki 1.20 or later; only 1.21 alpha or later after 38156
License GPL 2.0 or later
Download
Example translatewiki.net

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]

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

  • Go to the tags list
  • Click the name of the tag you want to download
  • Click "snapshot"
The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

  • Go to the branches list
  • Click the branch name
  • Click "snapshot"
A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

After you've got the code, save it into the extensions/TranslationNotifications directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/TranslationNotifications.git

Installation[edit | edit source]

To install this extension, add the following to LocalSettings.php:

require_once("$IP/extensions/TranslationNotifications/TranslationNotifications.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';

Notice that the username and the password appear in plain text, so they must not be publicly accessible (like $wgDBuser. and $wgDBpassword).

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.[1] 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 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 send out.

Footnotes[edit | edit source]

  1. And if the wiki is a part of such a family, of course.