Difference between revisions of "Multi-language content filter"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.9. Up-to-date documentation for the latest stable version of Moodle may be available here: Multi-language content filter.

(Added see also *[https://moodle.org/mod/forum/discuss.php?d=320980 this forum thread] about translating a MOOC)
(Enabling the multi-language content filter, page update)
Line 1: Line 1:
 
{{Filters}}
 
{{Filters}}
The Multi-language content filter enables resources to be created in multiple languages. When turned on, it looks for <nowiki><span lang="xx" class="multilang"></nowiki> tags which indicate that a text contains multiple languages. Then it selects and outputs the best language for the current user. The language of the resource will change when the user changes their selected Moodle language.
+
==Displaying text in multiple languages==
 +
The multi-language content filter enables resources to be created in multiple languages. When turned on, it looks for <nowiki><span lang="xx" class="multilang"></nowiki> tags which indicate that a text contains multiple languages. Then it selects and outputs the text in the user's language (as set in their browser or in their preferences).
 +
 
 +
==Enabling the multi-language content filter==
 +
 
 +
An admin can enable the multi-language content filter as follows:
 +
 
 +
# Go to ''Site administration > Plugins > Filters > Manage filters'' and in the dropdown menu for multi-language content select 'On'.
 +
# If headings are to be shown in multiple languages too, select 'Content and headings' in the 'Apply to' column. Note that this may affect site performance.
  
 
== How to use in a course ==
 
== How to use in a course ==
Line 12: Line 20:
  
 
==How to use for assignment submission agreements==
 
==How to use for assignment submission agreements==
#Since Moodle 2.8.2 it's possible to have assignment submission statements in different languages.
+
 
#With the filter enabled, go to Site administration>Plugins>Activity modules>Assignment>Assignment settings.
+
#With the filter enabled, go to ''Site administration > Plugins > Activity modules > Assignment > Assignment settings.
 
#In the submission statement, add (for example)
 
#In the submission statement, add (for example)
  
Line 34: Line 42:
 
* If the course setting is "force" some language, you won't be able to change the displayed language.
 
* If the course setting is "force" some language, you won't be able to change the displayed language.
 
* Extra spaces in language span tag
 
* Extra spaces in language span tag
* Can not easily access language choice dropdown! Unfortunately you must go to the site homepage or your own profile to change the displayed language. It is possible to manually quickly change displayed lang by editing the URL in the browsers address bar. See Tips and tricks below!
 
 
* The multilang filter does not work with the course short name! A course's short name is meant as a unique course identifier, so it does not use the multilang filter
 
* The multilang filter does not work with the course short name! A course's short name is meant as a unique course identifier, so it does not use the multilang filter
 
==Tips and tricks==
 
 
===Changing language displayed without going to front page===
 
It is possible to change the displayed language by manually changing the link. 
 
*Here is the default language page at id=2306. This link is in English, the default language:
 
:http://moodle.org/mod/resource/view.php?id=2306
 
*The link to change the page display to Spanish is
 
:http://moodle.org/mod/resource/view.php?id=2306&lang=es ,
 
*When the default language is an other language, to change the page to an English version, the link would be:
 
:http://moodle.org/mod/resource/view.php?id=2306&lang=en
 
 
Thus, with a bit of editing, you can manually change the displayed language by adding "&lang=xx" to the URL in the location bar of the browser. Where xx is the abbreviation for the language you want.
 
  
 
==The 'Restriction by language' additional plugin==
 
==The 'Restriction by language' additional plugin==
 +
[[File:Restriction by language.png|thumb|Restriction by language]]
 
Language filters are great, but sometimes they can make your resources and activities very complex.
 
Language filters are great, but sometimes they can make your resources and activities very complex.
  
The 'Restriction by language' availability condition is an additional plugin for Moodle 2.7, available in the [https://moodle.org/plugins/view.php?plugin=availability_language Moodle plugins database], that makes it easy to show an English resource only to English users and an activity in French only to French speaking students.
+
The [https://moodle.org/plugins/view.php?plugin=availability_language Restriction by language availability condition] is an additional plugin that makes it easy to show an English resource only to English users and an activity in French only to French speaking students.
 +
 
 +
==Any questions?==
  
[[File:Restriction by language.png]]
+
Please post in the [https://moodle.org/mod/forum/view.php?id=43 Languages forum] on moodle.org.
  
 
==See also==  
 
==See also==  
Line 61: Line 58:
 
*[[Language]]
 
*[[Language]]
 
*Custom menu items in [[Theme settings]]
 
*Custom menu items in [[Theme settings]]
*[https://moodle.org/mod/forum/discuss.php?d=320980 this forum thread] about translating a MOOC
+
*[https://moodle.org/mod/forum/discuss.php?d=320980 Translation of MOOC] forum discussion
  
 
[[Category:Language]]
 
[[Category:Language]]

Revision as of 11:14, 7 December 2015

Displaying text in multiple languages

The multi-language content filter enables resources to be created in multiple languages. When turned on, it looks for <span lang="xx" class="multilang"> tags which indicate that a text contains multiple languages. Then it selects and outputs the text in the user's language (as set in their browser or in their preferences).

Enabling the multi-language content filter

An admin can enable the multi-language content filter as follows:

  1. Go to Site administration > Plugins > Filters > Manage filters and in the dropdown menu for multi-language content select 'On'.
  2. If headings are to be shown in multiple languages too, select 'Content and headings' in the 'Apply to' column. Note that this may affect site performance.

How to use in a course

To use this feature first create your contents in multiple languages (in the same resource). Then enclose each language block (aka multilang block) in the following tags:

      <span lang="XX" class="multilang">your_content_here</span>
      <span lang="YY" class="multilang">your_content_in_other_language_here</span>

It is essential to be in the code editing mode (press [<>] in the HTML editor), when you enter these tags for them to work. Only spaces, tabs and enters can be used between the individual languages in the multilang block.

How to use for assignment submission agreements

  1. With the filter enabled, go to Site administration > Plugins > Activity modules > Assignment > Assignment settings.
  2. In the submission statement, add (for example)
      <span lang="en" class="multilang">This assignment is my own work, except where I have acknowledged the use of the works of other people.</span>
<span lang="fr" class="multilang">Ce devoir est le fruit de mon travail personnel, sauf aux endroits où l'utilisation d'oeuvre d'autres auteurs est clairement indiquée.</span> 

How it works internally

  1. Filter first looks for multilang blocks in the text
  2. For each multilang block:
    • If there are texts in the currently active language, print them
    • Else, if there exists texts in the current parent language, print them
    • Else, print the first language found in the text
  3. Text outside of multilang blocks will be shown always

Common problems

  • The multilang filter is not enabled. It can be enabled by a site administrator in Settings > Site administration > Plugins > Filters > Manage filters.
  • Extra characters between language span tags - editor might add <br /> or other tags, please review the html in source view
  • If the course setting is "force" some language, you won't be able to change the displayed language.
  • Extra spaces in language span tag
  • The multilang filter does not work with the course short name! A course's short name is meant as a unique course identifier, so it does not use the multilang filter

The 'Restriction by language' additional plugin

Restriction by language

Language filters are great, but sometimes they can make your resources and activities very complex.

The Restriction by language availability condition is an additional plugin that makes it easy to show an English resource only to English users and an activity in French only to French speaking students.

Any questions?

Please post in the Languages forum on moodle.org.

See also