MDL-20700 coding style cleanup - cvs keywords removed, closign php tag removed, trail...
[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 in multiple languages.
8     - Enclose every language content between:
9         <span lang="XX" class="multilang">your_content_here</span><span lang="YY" class="multilang">your_content_other_lang</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, print the first language found in the text.
18     - text out of "lang blocks" will be showed always.
20 Definition of "lang block":
21     Is a collection of lang tags separated only by whitespace chars (space,
22     tab, linefeed or return chars).
24 One example in action:
25     - This text:
26         <span lang="en" class="multilang">Hello!</span><span lang="es" class="multilang">Hola!</span>
27         This text is common for every language because it's out from any lang block.
28         <span lang="en" class="multilang">Bye!</span><span lang="it" class="multilang">Ciao!</span>
30     - Will print, if current language is English:
31         Hello!
32         This text is common for every language because it's out from any lang block.
33         Bye!
35     - And, in Spanish, it will print:
36         Hola!
37         This text is common for every language because it's out from any lang block.
38         Bye!
39     
41 Ciao, Eloy :-)
42 stronk7@moodle.org
43 2005-11-16
45 Syntax was changed in 1.8, the conversion of existing text is done from admin/multilangupgrade.php
46 Ciao, skodak :-)
47 2006-12-11