Extension:LocalisationUpdate

From MediaWiki.org
Jump to: navigation, search
This extension is bundled with MediaWiki 1.21 and above. Thus you do not have to download it again.
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
LocalisationUpdate

Release status:Extension status stable

ImplementationTemplate:Extension#type Database
DescriptionTemplate:Extension#description Allows to keep the localized messages as up to date as possible
Author(s)Template:Extension#username Tom Maaswinkel (12wiki), Niklas Laxström (maintainer)
Latest versionTemplate:Extension#version 1.3.0 (2014-09-04)
MediaWikiTemplate:Extension#mediawiki 1.19+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download Included in Language Extension Bundle

Readme
ExampleTemplate:Extension#example Wikipedia
Hooks usedTemplate:Extension#hook
MessageNotInMwNs
LocalisationCacheRecache

Translate the LocalisationUpdate extension if it is available at translatewiki.net

Check usage and version matrix.

Issues:

Open tasks · Report a bug

The LocalisationUpdate extension allows to update the localizations for MediaWiki messages at any time, without needing to upgrade the MediaWiki software.

Installation[edit]

  • Download and place the file(s) in a directory called LocalisationUpdate in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'LocalisationUpdate' );
$wgLocalisationUpdateDirectory = "$IP/cache";
  • Create a cache folder in the installation directory, and be sure the server has permissions to write on it.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing extensions using wfLoadExtension(), since MediaWiki 1.25. If you need to install this extension in earlier versions, instead of wfLoadExtension( 'LocalisationUpdate' );, you need to use:

require_once "$IP/extensions/LocalisationUpdate/LocalisationUpdate.php";

Note Note: If localization updates don't seem to come through, you may need to run php maintenance/rebuildLocalisationCache.php --force.

Configuration[edit]

$wgLocalisationUpdateDirectory

Directory to store cache files in, if not set then it uses default $wgCacheDirectory. LocalisationUpdate requires some place to store files in to work; if neither $wgLocalisationUpdateDirectory nor $wgCacheDirectory is set, LocalisationUpdate's update.php script will not work.

$wgLocalisationUpdateDirectory is set to false by default.

$wgLocalisationUpdateRepository

Default repository source to fetch translation. Github is set to default repository. This is added with version 1.1.

$wgLocalisationUpdateRepositories

Array of repositories URLs from which to retrieve localisations for core MediaWiki and extensions. Default is set to Github's MediaWiki Git repositories and you should not change this unless you're using this performance improvement or otherwise know what you're doing. This is added with version 1.1.

Example for using github

$wgLocalisationUpdateRepositories['github'] = array(
        'mediawiki' =>
                'https://raw.github.com/wikimedia/mediawiki/master/%PATH%',
        'extension' =>
                'https://raw.github.com/wikimedia/mediawiki-extensions-%NAME%/master/%PATH%',
        'skin' =>
                'https://raw.github.com/wikimedia/mediawiki-skins-%NAME%/master/%PATH%'
);

Example for local filesystem configuration

$wgLocalisationUpdateRepositories['local'] = array(
        'mediawiki' =>
                'file:///resources/projects/mediawiki/master/%PATH%',
        'extension' =>
                'file:///resources/projects/mediawiki-extensions/extensions/%NAME%/%PATH%',
        'skin' =>
                'file:///resources/projects/mediawiki-skins/skins/%NAME%/%PATH%'
);

Usage[edit]

Whenever you want to run an update, run php extensions/LocalisationUpdate/update.php on the command line, or set up a cron job.

NOTE: LocalisationUpdate does not update automatically. If you want to update your localizations regularly, you need to setup a cron job yourself.

Script parameters[edit]

With version 1.1,

--repoid: Fetch translations from repositories identified by this

Known issues[edit]

If you enable this extension directly from the web installer, it doesn't configure the $wgLocalisationUpdateDirectory variable, so if you don't configure it explicitly, it would throw an exception when viewing any page (task T48885). You must manually configure that variable after installing the extension.

See also[edit]


Language: English  • 日本語