|
|
| Line 1: |
Line 1: |
| {{Template:Migrated|newDocId=/general/development/process/translation/plugins}}
| | This page is now located in the user docs: [[:en:Translating plugins|Translating plugins]] |
| {{Translation}}
| |
| ==Looking for translated plugins in the Moodle plugins database==
| |
| | |
| * Almost all contributed plugins published in Moodle Plugins directory have been imported into [http://lang.moodle.org/ AMOS] and are ready to be translated.
| |
| *Watch this video tutorial on [https://www.youtube.com/watch?v=E_20uU1ibcA&feature=youtu.be Translating a Moodle plugin]
| |
| * When a user is looking at the [https://moodle.org/plugins/ Moodle plugins database], in ' Description tab > Useful links section' there is a link to 'Contribute translation for (your preferred language)' that points to [http://lang.moodle.org/ AMOS].
| |
| * Have a look at an example for the very popular [https://moodle.org/plugins/view.php?plugin=mod_hotpot HotPot] plugin:
| |
| | |
| [[File:Link to Plugin translations in Moodle plugins database.png|300px]]
| |
| | |
| * You can click on the 'Contribute translation for (your preferred language)' link.
| |
| * '''CURRENTLY:''' If you do not have an AMOS account, you would have to 'Create a new account' by using the appropriate link.
| |
| * If you have a translator account in AMOS, you can use AMOS to contribute the translation.
| |
| * If you select all the language packs (except English fixes) and write '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).
| |
| | |
| [[File:Plugins translations in AMOS.png|400px]]
| |
| | |
| * 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.
| |
| | |
| ==Plugin translation priority==
| |
| * Please help Moodle users in other languages by translating your favourite plugins.
| |
| * Moodle has a continuously updated [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 :)
| |
| * In mid-2019, the [https://moodle.org/plugins/mod_hvp H5P plugin] is the most downloaded additional activity plugin and it is expected to [https://docs.moodle.org/dev/Roadmap#Moodle_3.8_and_beyond:_in_progress be incorporated into Moodle 3.8 core].
| |
| * You can find the plugins with the largest number of downloads in the last three 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.
| |
| * See the [https://moodle.org/mod/forum/discuss.php?d=325804 list of (year 2015) favorite plugins] by Gavin Henrick
| |
| * Special cases:
| |
| ** All plugins with ''mobile'' in their name, and all [https://moodle.org/plugins/browse.php?list=set&id=62 server side plugins] to support the [https://docs.moodle.org/38/en/Moodle_Mobile Moodle mobile app]
| |
| ** [https://moodle.org/plugins/local_moodlecloudsignup MoodleCloud strings] are used for accessing the [https://moodle.com/cloud/ MoodleCloud] free and paid hosting services.
| |
| | |
| ===Elementary school teaching===
| |
| If your Moodle site will serve kids, consider [https://docs.moodle.org/38/en/Language_packs#Can_I_make_a_language_pack_for_kids.3F making a language pack for kids].
| |
| | |
| ===Plugins for K-12 teaching===
| |
| For [https://en.wikipedia.org/wiki/K%E2%80%9312 K-12] teaching and learning environments, please consider translating the plugins that are included in the [https://moodle.com/cloud/school/?utm_source=Sendy&utm_medium=Email&utm_campaign=Newsletter_July2016 Moodle for School at MoodleCloud]:
| |
| * [https://moodle.org/plugins/mod_attendance Attendance]
| |
| * [http://bigbluebutton.org/ BigBlueButton]
| |
| * [https://moodle.org/plugins/mod_checklist Checklist]
| |
| * [https://moodle.org/plugins/atto_chemistry Chemistry editor]
| |
| * [https://moodle.org/plugins/mod_choicegroup Group choice]
| |
| * [https://moodle.org/plugins/block_xp Level up!]
| |
| * [https://moodle.org/plugins/mod_quizgame Quizventure]
| |
| * [https://moodle.org/plugins/tinymce_wordcount Word count]
| |
| | |
| ===Plugins for University teaching===
| |
| For universities, there is a [https://docs.moodle.org/38/en/Tertiary_education#Moodle_plugins_by.2Ffor_Universities list of plugins by/for Universities], and a [https://docs.moodle.org/38/en/Tertiary_education#Discipline-specific_plugins link to discipline-specific plugins], which might be worth translating.
| |
| | |
| ==H5P plugin==
| |
| ===H5P translations in AMOS===
| |
| You must translate all the H5P (and hvp) related plugins in AMOS:
| |
| | |
| [[File:h5p TRANSLATIONS IN amos 1.png|400px]]
| |
| | |
| [[File:h5p TRANSLATIONS IN amos 2.png|400px]]
| |
| | |
| THEN you will ALSO have to translate the H5P module strings in the H5P site. You can do it either using weblate (preferred method) or GitHub (old method).
| |
| | |
| ===H5P translation using weblate (preferred method)===
| |
| Visit [https://translate-h5p.tk/contributing/ https://translate-h5p.tk/contributing/] and register.
| |
| | |
| If there is a maintainer for your language, you can make suggestions for string translations.
| |
| | |
| Check [https://h5p.org/forum/6 https://h5p.org/forum/6] for the FAQs and your questions/doubts/problems.
| |
| | |
| If there are no maintainers for your language, you may request to become a maintainer (send an email to serettig@posteo.de).
| |
| | |
| If one (or a few) of the English source strings is blank, you can simply leave it blank in your translation, too. Weblate might complain about an untranslated string, but you can ignore that!
| |
| | |
| It is VERY IMPORTANT to make sure that all the English language strings have been translated. If that file has only been partially translated, you should use the original English language strings. If you leave an empty field, there will be a serious ERROR that will block weblate progress. See the following screeens:
| |
| | |
| [[File:H5P weblate problem with strings not translated.png|500px]]
| |
| | |
| And the weblate will CLOSE this module for translation:
| |
| | |
| [[File:H5P weblate problem with strings not translated WEBLATE blocked.png|700px]]
| |
| | |
| If weblate closes a module for translation, you can only add or change language strings vía GitHub (see below).
| |
|
| |
| If you are a language maintainer, ONLY after making sure ALL the strings for one H5P module have been properly translated into your language, you should Commit your changes to wordslate ('Manage' -> Commit). THEN you should PUSH your changes ('Manage' -> Repository maintenance -> PUSH). You must then wait for the people responsible for the GitHub code to review and accept your pull requests by way of weblate.
| |
| | |
| Don't forget to always push your changes once you've finished a library so that Joubel can review and accept them.
| |
| | |
| If you notice a typo or any other error in the original English language strings, you can write an issue (or a Pull request) in the GitHub page of the original H5P module. They will be very happy to check it and fix it if necessary.
| |
| | |
| ====Translation of H5P module's names using weblate====
| |
| | |
| After translating all the H5P strings using weblate, you may consider translating [https://next.lumi.education/ LUMI] using weblate, as that will allow H5P users to see the H5P modules' names and descriptions in languages other than English when they use the free [https://next.lumi.education/ LUMI] app to produce .h5p files to be used in a Moodle course.
| |
| | |
| [[File:H5P LUMI 3.png|600px]]
| |
| | |
| The description of each H5P module in other languages might make it easier for many new Moodle users of H5P:
| |
| | |
| [[File:H5P Flashcards LUMI en español.png|600px]]
| |
| | |
| | |
| ===H5P translation using GitHub (old method)===
| |
| While the [https://moodle.org/plugins/mod_hvp H5P plugin for Moodle] is currently (April 2020) installed in 14333 sites, and the Moodle roadmap shows 'improved H5P integration' contemplated for Moodle 3.8 and beyond, only 30 languages (April 2020) have any translated language strings in AMOS.
| |
| | |
| [[File:H5P editor french language.png|600px]]
| |
| | |
| Even after translating the [https://moodle.org/plugins/mod_hvp H5P plugin for Moodle] in AMOS, most users of this plugin in languages other than English may see (partly or totally) untranslated strings when using it. This is because all H5P libraries ("components" / "plugins") have their own separate [https://github.com/h5p/h5p-contribution-docs/blob/master/en/translations.md translation infrastucture] which is not related to the H5P Moodle plugin and we are not sure what is the frequency of merging and distributing the contributed translation pull requests that we see on each library's repository on GitHub.
| |
| | |
| [[File:H5P editor es_mx language.png|600px]]
| |
| | |
| There is a page providing an overview of the H5P content-type translation status at [https://localization.h5p.org/ https://localization.h5p.org/ ]
| |
| | |
| [[File:H5P_translation_02.png|600px]]
| |
| | |
| When you click on a language (Spanish in this example), you will see all the H5P modules with the proportion of strings translated into that language.
| |
| | |
| [[File:H5P translation 03.png|600px]]
| |
| | |
| When you click on a module (Audio in this example) you will see a list of all the untranslated and translated strings for that language for that module
| |
| | |
| [[File:H5P translation 04.png|600px]]
| |
| | |
| At the botton of that page, there will be a link to 'Head over to the source repository'. If you click on that link, you will be taken to the GitHub page for that module, where you can fix or add the translations for your language and make a 'Pull request' to contribute this translation.
| |
| | |
| [[File:H5P translation 05.png|600px]]
| |
| | |
| See also:
| |
| | |
| * [https://translate-h5p.tk/ h5p.tk] - a user-friendliy platfform that you can use to translate H5P strings.
| |
| * the [https://h5p.org/adding-content-type-translation-via-github Guide for Adding content type translations via GitHub].
| |
| | |
| ==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 not available for translation with AMOS.
| |
| | |
| ===Plugins in the [https://moodle.org/plugins/browse.php?list=category&id=38 Other] category===
| |
| The plugins classified as '[https://moodle.org/plugins/browse.php?list=category&id=38 Other] ' (Utilities, Experimental or Incubating) are not translatable by AMOS (see [http://lang.moodle.org/mod/forum/discuss.php?d=3113 this forum thread]). You can use the [[:en:Language customization|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 [https://moodle.org/plugins/ Moodle plugins directory] may not have English language strings available for translation in [https://lang.moodle.org/ AMOS] because of [https://docs.moodle.org/dev/index.php?title=Plugin_contribution_checklist&redirect=no coding errors], that must be identified and fixed by the plugin maintainer, See [https://docs.moodle.org/dev/Plugin_contribution_checklist#Strings Plugin contribution checklist:Strings]:
| |
| * 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 [http://php.net/manual/en/language.operators.string.php concatenation], [http://php.net/manual/en/language.types.string.php 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.
| |
| | |
| ===Plugins with hard-wired English language strings===
| |
| Sometimes you might have translated 100% of the strings available in AMOS for a given plugin, and you can still view the original English (non-translated) strings.
| |
| * Please check that you have purged your browser cache and the server cache, waited for one hour (for AMOS to update the language packs), and updated your language packs.
| |
| * If the problem persists, please write the plugin maintainer by clicking at the 'Bug tracker' link shown in the given plugin's page in the [https://moodle.org/plugins/index.php Moodle plugins database].
| |
| * If the plugin author has nested additional 'Lang' folders inside any subdirectories within the plugin folder structure, the English language strings in these nested Lang folder will not be available for AMOS, and they would seem to be hard-wired. Please contact the plugin author.
| |
| * Most Moodle plugin authors have been very fast at replacing the English hard-coded strings with strings variables that can now be translated in AMOS.
| |
| * If you suspect the problem is in a core plugin, you can post an issue in the [https://lang.moodle.org/mod/forum/view.php?id=5 AMOS translation forum].
| |
|
| |
| ===Log descriptions can not be translated===
| |
| * See [https://docs.moodle.org/dev/Translation_FAQ#Why_are_log_descriptions_displayed_in_English.3F why log descriptions are not translated].
| |
| | |
| ===Items that must NOT be translated===
| |
| * See the [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 the [https://docs.moodle.org/dev/Translation_FAQ Translation FAQ]
| |
| | |
| ==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 [http://lang.moodle.org/mod/forum/discuss.php?d=3939 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.
| |
| | |
| [[File:Found language file debugging message.jpg|400px]]
| |
| | |
| The Language strings inside a properly installed downloaded plugin will overwrite the strings translations of the language pack, but they can be overwritten by the strings defined with the Language customization.
| |
| | |
| ===Strings priority===
| |
| When displaying text language strings, Moodle 2.x and 3.x will have the following priority:
| |
| # Strings defined by the [[:en:Language customization|language customization]] tool
| |
| # Strings defined in an installed child language pack (eg, the es_ve language pack)
| |
| # Strings defined in an installed parent language pack (eg, the es language pack)
| |
| # Strings enclosed inside the plugin_name/lang/xx/yy.php folder (where xx is a language code other than the en folder) from a downloaded and installed plugin ZIP file (eg, inside the /server/moodle/theme/adaptable/lang/es/theme_adaptable.php file)
| |
| # Original Australian English language strings shipped with the downloaded Moodle branch.
| |
| # Original Australian English language strings inside the /lang/en folder in the downloaded/updated plugin ZIP file
| |
| | |
| Note: See the [https://moodle.org/plugins/local_string_override local String override plugin] that makes it possible for plugins to override existing translations regardless if they're bundled with Moodle or they're originated from a community plugin.
| |
| | |
| ==See also==
| |
| | |
| * [http://lang.moodle.org/mod/forum/discuss.php?d=2485 Contributed plugins are now automatically imported into AMOS] announcement explaining the mechanism
| |
| * [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 the [https://docs.moodle.org/dev/Translation_FAQ Translation FAQ]
| |
| | |
| [[Category:Plugins]]
| |
