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.

(Tips and tricks: hack for bandwidth link)
(How to use in a course: order of span tags (MDL-55197))
 
(18 intermediate revisions by 7 users not shown)
Line 1: Line 1:
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.
+
{{Filters}}
 +
==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).
  
The multilang syntax was changed in 1.8. <nowiki><lang></nowiki> is not supported any more. It is required to add ''class="multilang"'' into each <nowiki><span></nowiki> tag in multilang block. The new syntax is backwards compatible with old plugins, which means it can be used in older Moodle version.
+
==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 10: Line 17:
 
       <span lang="YY" class="multilang">your_content_in_other_language_here</span></nowiki>
 
       <span lang="YY" class="multilang">your_content_in_other_language_here</span></nowiki>
  
It is essential to be in '''the code editing mode''' (press <nowiki>[<>]</nowiki> 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. Please note that ''class="multilang"'' is not required prior to 1.8. There is a lang drop-down markup tool in the HTML editor in later versions of Moodle. The first versions, at least to 1.8.2, do not make "multilang" language tags. If you are working in a sufficiently new version of the HTML editor you can add these tags without going to the code editing mode.  If something doesn't work properly you should check how the markup looks in code mode.  
+
It is essential to be in '''the code editing mode''' (press <nowiki>[<>]</nowiki> 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.
  
Following code
+
Note: If your site uses a child language pack (see [[Language packs]] for the list), then the first span tag must be the parent language. Otherwise, when a user using the child language views the text, it will not be in the correct language for them (as reported in MDL-55197). For example, if your site uses en_us then the en span tag (as parent language) must be first i.e.
      <nowiki><lang="XX">your_content_here</lang>
 
      <lang="YY">your_content_in_other_language_here</lang></nowiki>
 
does NOT work.
 
  
The obsoleted HTML tagging
+
<nowiki><span lang="en" class="multilang">your_content_in English</span>
      <nowiki><lang lang="XX">your_content_here</lang>
+
       <span lang="de" class="multilang">your_content_in_German_here</span></nowiki>
       <lang lang="YY">your_content_in_other_language_here</lang>
 
  
      <span lang="XX">your_content_here</span>
+
==How to use for assignment submission agreements==
      <span lang="YY">your_content_in_other_language_here</span></nowiki>
+
 
will not work in 1.8 and later. In 1.8 the lang attribute without ''class="multilang"'' can be used to mark the language of the text - see http://www.w3.org/TR/html4/struct/dirlang.html
+
#With the filter enabled, go to ''Site administration > Plugins > Activity modules > Assignment > Assignment settings.
 +
#In the submission statement, add (for example)
 +
 
 +
      <nowiki><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> </nowiki>
  
 
== How it works internally ==
 
== How it works internally ==
Line 33: Line 40:
 
#* Else, print the first language found in the text
 
#* Else, print the first language found in the text
 
# Text outside of multilang blocks will be shown always
 
# Text outside of multilang blocks will be shown always
 
==Course summary and title tags==
 
 
To be able to change text such as resource titles and summaries, an administrator must choose ''Filter all strings'' in the site administration.
 
 
<nowiki> <span lang="en" class="multilang">Matematically</span> <span lang="sv" class="multilang">Matematiskt (svenska)</span></nowiki>
 
functions as English or Swedish title.
 
 
It doesn't work for course titles and site names (neither long nor short version) in some versions of Moodle. At least from 1.8.2 long course titles and site name, both full and breadcrumb were multilang filtered. 
 
 
In the course summary:
 
 
<nowiki><span lang="en" class="multilang">Growth is often a major concern in planning society.
 
How can one avoid superficial conclusions? <br>
 
(Exists in Swedish too. Finns på svenska också)</span>
 
<span lang="sv" class="multilang">Tillväxt är ofta använt i samhällsdebatten.
 
Hur kan man undvika ytliga slutsatser?
 
(Finns på engelska också. Exists in English too.)
 
<br /></span> </nowiki>
 
 
Can show in the chosen language (and point out that the other language is there). Please note that ''class="multilang"'' is not required prior to Moodle 1.8.
 
 
== Translations with tags ==
 
If you wish to translate a word or phrase in an English text to another language:
 
 
<nowiki>If I want to include an explanation <span lang="en"> </span>
 
<span lang="sv" class="multilang">(sv: förklaring)</span> in a running text
 
can I do it?</nowiki>
 
or
 
<nowiki><span lang="en" class="multilang>If I want to include an explanation
 
in a running text can I do it? </span>
 
<span lang="sv" class="multilang>If I want to include an explanation (sv:
 
förklaring) in a running text can I do it?</span></nowiki>
 
 
would both work, but not:
 
 
<nowiki>If I want to include an explanation <span lang="en" class="multilang></span>
 
<span lang="sv" class="multilang>(sv: förklaring)</span> in a running text
 
can I do it?</nowiki>
 
or
 
<nowiki>If I want to include an explanation <span lang="sv" class="multilang>
 
(sv: förklaring)</span> in a running text can I do it?</nowiki>
 
which would show the Swedish even if English was the chosen language. NOTE that before 1.8 the "span lang=en" must contain something, at least a space.
 
 
== New multilang syntax ==
 
{{Moodle 1.8}}
 
* <nowiki><span lang="xx"> and <lang></nowiki> should not be used anymore
 
* Existing content can be upgraded using the admin/multilangupgrade.php script, there is a link in the admin notification page if a multilang upgrade is required.
 
* The multilang filter can be configured to use old syntax only - see ''Multi-Language Content Settings''; this setting may be removed in 1.9
 
* New syntax is forced during a new 1.8 installation, for upgraded sites the new syntax is enabled after the multilang upgrade
 
  
 
== Common problems ==
 
== Common problems ==
  
* The multilang filter is not enabled. The administrator for the Moodle site you are using must go to Site administration> modules> Multilanguage Content and enable it (by clicking on the "eye")
+
* The multilang filter is not enabled. It can be enabled by a site administrator in ''Settings > Site administration > Plugins > Filters > Manage filters''.
* ''Filter all strings'' not enabled on sites that need multilang in titles, navigation, headings, etc.  The administrator for the Moodle site you are using must go to Site administration> appearance> Filter settings and set a check in "filter alll strings". This will increase server load slightly, so don't do it unless you really need it.
 
 
* Extra characters between language span tags - editor might add <nowiki><br /></nowiki> or other tags, please review the html in source view
 
* Extra characters between language span tags - editor might add <nowiki><br /></nowiki> 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.
 
* 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. Want a change? see [http://tracker.moodle.org/browse/MDL-11531 MDL-11531]. 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
 
 
==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
 
  
Thusly, 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==
 +
[[File:Restriction by language.png|thumb|Restriction by language]]
 +
Language filters are great, but sometimes they can make your resources and activities very complex.
  
===Bandwidth-adaptivity===
+
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.
One inventive fellow has made a hack to use the multilang filter to be able to adapt the sent content to a users chosen bandwidth. Especiallly international courses can have users with extremely varied Internet connection speeds and this can allow them to chose what level of content (Low = text and small pictures, medium = some mp3, high = some video and other heavy stuff) suits them.
 
[http://paaralan.blogspot.com/2009/08/hack-bandwidth-adaptivity-for-moodle.html the blog with description and downloads]
 
  
== See also ==
+
==Any questions?==
  
*[[Filters|Filters administration]]
+
Please post in the [https://moodle.org/mod/forum/view.php?id=43 Languages forum] on moodle.org.
Using Moodle forum discussions:
 
  
*[http://moodle.org/mod/forum/discuss.php?d=51603 Multilanguage filter - does not work ...]
+
==See also==  
*[http://moodle.org/mod/forum/discuss.php?d=74340 Problems with multilang filter and SPAN tags]
 
*[http://moodle.org/mod/forum/discuss.php?d=94006 Multilingual Content]
 
*[http://moodle.org/mod/forum/discuss.php?d=95134 Multilingual VS HTML editor]
 
  
 +
*[[Language]]
 +
*Custom menu items in [[Theme settings]]
 +
*[https://moodle.org/mod/forum/discuss.php?d=320980 Translation of MOOC] forum discussion
  
[[Category:Teacher]]
+
[[Category:Language]]
[[Category:Filter]]
 
  
[[es:Filtros (Administrador)]]
+
[[de:Mehrsprachiger Inhalt]]
 +
[[es:Filtro de contenido multi-idioma]]
 
[[fr:Contenu multilingue]]
 
[[fr:Contenu multilingue]]
 
[[ja:多言語シンタックス]]
 
[[ja:多言語シンタックス]]

Latest revision as of 12:58, 28 September 2016

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.

Note: If your site uses a child language pack (see Language packs for the list), then the first span tag must be the parent language. Otherwise, when a user using the child language views the text, it will not be in the correct language for them (as reported in MDL-55197). For example, if your site uses en_us then the en span tag (as parent language) must be first i.e.

<span lang="en" class="multilang">your_content_in English</span>
      <span lang="de" class="multilang">your_content_in_German_here</span>

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