Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Translating plugins: Difference between revisions

From MoodleDocs
(Added link to * [https://docs.moodle.org/dev/Translation_FAQ#Are_there_items_which_are_not_to_be_translated.3F Items that are not to be translated] in)
(Added * Moodle has a list of plugins that have received the [https://moodle.org/plugins/browse.php?list=award&id=1 Reviewers' choice award].)
Line 21: Line 21:
* Please help Moodle users in other languages by translating your favourite plugins. Moodle has a [https://moodle.org/plugins/report/index.php?report=favourites&p=0&l=50&s=favourited&d=DESC list of the most favourite plugins], which might be worth considering for translation  :)
* Please help Moodle users in other languages by translating your favourite plugins. Moodle has a [https://moodle.org/plugins/report/index.php?report=favourites&p=0&l=50&s=favourited&d=DESC list of the most favourite plugins], which might be worth considering for translation  :)
* You can find the plugins with the largest number of downloads in the last year (or in the last two months) at [https://moodle.org/plugins/stats.php https://moodle.org/plugins/stats.php]. These are the plugins most likely to be most useful when translated to your language. It would probably be a good idea to translate them first.
* You can find the plugins with the largest number of downloads in the last year (or in the last two months) at [https://moodle.org/plugins/stats.php https://moodle.org/plugins/stats.php]. These are the plugins most likely to be most useful when translated to your language. It would probably be a good idea to translate them first.
* Moodle has a list of plugins that have received the [https://moodle.org/plugins/browse.php?list=award&id=1 Reviewers' choice award]. These are given by the plugins guardians and reviewers for particularly useful, well coded or otherwise interesting plugins. It would be very desirable/useful to have these translated.





Revision as of 17:39, 20 November 2015

Looking for translated plugins in the Moodle plugins database

  • Almost all contributed plugins published in Moodle Plugins directory have been imported into AMOS and are ready to be translated.
  • When a user is looking at the Moodle plugins database, in ' Description tab > Useful links section' there is a link to 'Contribute translation for (your preferred language)' that points to AMOS.
  • Have a look at an example for the very popular HotPot plugin:

Link to Plugin translations in Moodle plugins database.png

  • You can click on the 'Contribute translation for (your preferred language)' link.
  • CURRENTLY: If you do not have an account in AMOS, you would have to 'Create a new account' by using the appropriate link.
  • If you have a translator account at AMOS, you can use AMOS to contribute a translation.
  • If the user then selects all the language packs (except English fixes) and writes 'pluginname' in the box for 'String identifier', AMOS will display the name of the plugin in all available translations.
  • Make sure that you have selected the Moodle branch(es) that you are interested in (eg, 2.5 in the image below).

Plugins translations in AMOS.png

  • In the above example, there are a total of 123 different language packs registered in AMOS; 63 of these are missing a translation for HotPot, which means that there are 60 different language translations already available for the HotPot plugin, a fair number for this popular plugin :)
  • When no translation is available for any/many language(s), the box named 'Translation' will be empty for those languages.
  • If a plugin name has been translated, there is a fair chance (but no certainty) that this plugin has been (completely) translated into that language. You can change the settings in AMOS and check for yourself.
  • Please help Moodle users in other languages by translating your favourite plugins. Moodle has a list of the most favourite plugins, which might be worth considering for translation  :)
  • You can find the plugins with the largest number of downloads in the last year (or in the last two months) at https://moodle.org/plugins/stats.php. These are the plugins most likely to be most useful when translated to your language. It would probably be a good idea to translate them first.
  • Moodle has a list of plugins that have received the Reviewers' choice award. These are given by the plugins guardians and reviewers for particularly useful, well coded or otherwise interesting plugins. It would be very desirable/useful to have these translated.


Non-translatable strings

While AMOS does a great job for translating the Moodle core and most Moodle plugin language strings, some English language strings are (as of February 2015) not yet available for translation with AMOS.

Plugins in the Other category

The plugins classified as 'Other ' (Utilities, Experimental or Incubating) are not translatable by AMOS (see this forum thread). You can use the language customization tool within your Moodle (production or local) server to produce the .php file containing the translated language strings for your language and email this file to the particular 'other' plugin maintainer, so that it can be included in the lang folder within the downloadable Zip file for the plugin.

Plugins with coding errors

Some plugins (of types different from 'Other') available for download in the Moodle plugins directory may not have English language strings available for translation in AMOS because of coding errors, that must be identified and fixed by the plugin maintainer:

  • The plugin code must not rely on trailing and leading whitespace in strings.
  • The string file must be considered as pure data file with the syntax $string['id'] = 'value';
  • No other PHP syntax such as concatenation, heredoc and nowdoc is supported by the tools that AMOS use when processing the strings (even if it may work in Moodle itself).
  • Use neither string concatenation operators nor other PHP logic inside string files. Those should really be considered as plain data files with simple $string['key'] = 'value'; syntax, nothing more.

If translations are available in AMOS for some Moodle branches but not available for other branches

Sometimes a plugin may have its English language strings available for translations for some Moodle branches (e.g. 2.0 to 2.4), but not for other branches (e.g. 2.5 to 2.7), even though the plugin itself is indeed available for download for all branches (2.0 to 2.7) in the Moodle plugins database.

Please see an example in this post. The cause is very likely a programming error (see 'Plugins with coding errors' above), that must be fixed by the plugin maintainer.

What happens if a plugin ZIP file includes translation(s) inside the lang folder

If a site has debugging on, there will be a warning message about 'Found language file' when the user installs the plugin, but the installation may proceed.

Found language file debugging message.jpg

See also