This plugin allows translation of user-generated content in Moodle.

It is part of a set, which also includes Moodle Atto Translations and Moodle TinyMCE Translations as companion plugins.

Full documentation available at: https://docs.moodle.org/en/Content_translation_plugin_set.

To Install it manually

• Unzip the filter_translations plugin in your "moodleroot""/filter/translations directory.


• Also install the companion editor plugins:
  -- TinyMCE plugin from: https://github.com/moodleacademy/moodle-tiny_translations
  -- Atto plugin from: https://github.com/andrewhancox/moodle-atto_translations

To Enable it

• Go to "Site Administration >> Plugins >> Filters >> Manage filters" and enable the 'Content translations' plugin there.


• Go to "Site Administration >> Plugins >> Filters >> Content translations" and choose a caching level appropriate to your site.

Caching

Since the filter makes database calls and, if Google Translate is enabled, web service calls, it is advisable to enable caching by working with the cachingmode setting. If you have a small volume of course material in active use then Application mode caching is advised, if you have a large volume then Session. In any case, the default of Request is rarely the optimal choice.

How it chooses translations

• 
  

  Get a prioritised list of the languages we could translate into - starting with the user's preferred language, then working through parent languages.

  
  


• 
  

  Get the translation(s) that fit the highest priority language.

  
  


• 
  

  If a span tag with an MD5 key in the data-translationhash property and a translation with a matching md5key can be found then use that one.

  
  


• 
  

  Otherwise, if a translation can be found which has an MD5 key matching the MD5 hash of the content then use that.

  
  


• 
  

  Finally, if a translation has a 'last generated hash' (meaning the MD5 hash of the content it was last updated in reference to) which matches the MD5 hash of the content then use that.

  
  

To Use it

Users with the 'filter/translations:edittranslations' capability will see an icon in the top right hand corner of the screen to enable the translator view of the course. At this point all translatable text will have an icon injected next to it to allow it to be translated.

Scheduled tasks

There are a number of scheduled tasks that can be enabled, if needed. These scheduled tasks are disabled by default and should only be enabled if content translation is to be applied to the whole site.

Insert translation spans: This task scans records in specified tables/columns and adds a translation span tag if one is not found.

Replace duplicate hashes: This task checks for duplicate translation hashes in specified tables/columns and replaces duplicate hashes with a new "unique" hash.

Copy translations: This task finds matching translations for each content in specified tables/columns and copies them under the translation hash for that content.

Cleanup translation issues: This task cleans up the translation issues table by deleting records older than 7 days.

To migrate from filter_fulltranslate

A CLI tool is available to migrate all translations across from the filter_fulltranslate.

It is recommended that you clean out any unwanted translations that may have been generated as follows:

delete from mdl_filter_fulltranslate where sourcetext like '%{mlang%';

You can then copy the translations from filter_fulltranslate into filter_translations as follows:

php cli/migrate_filter_fulltranslate.php --confirm

To add translation span tags to existing data

A CLI tool is available to automatically add span tags to existing data. Please use with extreme caution.

You can run the tool as follows which will show help text:

php cli/insert_spans.php

Author

The module was written by Andrew Hancox on behalf of Open Source Learning.
It is currently maintained by Rajneel Totaram for Moodle Academy

Useful links

• Open Source Learning


• Bug tracker

License

This program is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this
program. If not, see http://www.gnu.org/licenses/.