Updated a bit to explain how the multilang filter works.
[moodle.git] / filter / multilang / README.txt
1 $Id$
3 To Install it:
4     - Enable if from "Administration/Filters".
5   
6 To Use it:
7     - Create your contents into multiple languages.
8     - Enclose every language content between:
9         <span lang="XX>your_content_here</span>
10     - Test it (by changing your language).
12 How it works:
13     - look for "lang blocks" in the code.
14     - for each "lang block":
15         - if there are texts in the currently active language, print them.
16         - else, if there exists texts in the current parent language, print them.
17         - else, if there are English texts, print them
18         - else, print the first language found in the text.
19     - text out of "lang blocks" will be showed always.
21 Definition of "lang block":
22     Is a collection of lang tags separated only by whitespace chars (space,
23     tab, linefeed or return chars). For each detected lang 
25 One example in action:
26     - This text:
27         <span lang="en">Hello!</span><span lang="es">Hola!</span>
28         This text is common for every language because it's out from any lang block.
29         <span lang="en">Bye!</span><span lang="it">Ciao!</span>
31     - Will print, if current language is English:
32         Hello!
33         This text is common for every language because it's out from any lang block.
34         Bye!
36     - And, in Spanih, it will print:
37         Hola!
38         This text is common for every language because it's out from any lang block.
39         Bye!
40     
42 Ciao, Eloy :-)
43 stronk7@moodle.org
44 2005-11-16