Each text or string that you want to translate is associated to a key. These associations are placed in "property files". Each property file is associated to a language and a character encoding.

The following code retrieves the current language code into the lang variable.

$lang = jApp::config()->locale;

To be able to retrieve a string in the current language, simply call jLocale::get('the.key.of.the.string'), or in templates, use the syntax dedicated to locales (see the template page).

In the configuration file of your application (mainconfig.ini.php), you have several parameters to configure the language and charset used in your application:

• locale: indicates the language code of the lang to use in the application. It can be changed on the fly if needed. Values follow a specific syntax, similar to IETF language tags: a primary tag + "_" + a subtag. The primary tag is a lang code, and the subtag is the country code. By default, the locale is en_US.
• charset: indicates the charset to use. By default it is UTF-8.
• availableLocales: contains the list of language that your application supports.
• There is also a section [langToLocale]. See below.

Property files are files containing translations. They follow strict conventions. They are located in the locales/ directory of modules. This directory has a specific organization. It has a sub-directories for each language. Example: locales/fr_FR/ for France's french, locales/en_US/ for United States' english, and so on. In each language directory there are many property files, corresponding to the same language. However you can have different files containing same strings, but for different character encoding.

You can also store all properties files of all modules in a same main directory outside modules. It's then easy for people who translate to find files. The directory <yourapp>/var/locales/ should content one folder for each lang, and in these foldes, one folder for each module, following this scheme: <yourapp>/var/locales/<lang>/<modules>/locales/<file.properties>. For example: myapp/var/locales/fr_FR/my_module/locales/example.properties.

You can then copy easily all files of <yourapp>/var/locales/<lang>/ in a new lang directory to translate to a new language.

There is also the possibility to redefine properties file by copying them into the <yourapp>/var/overloads/ directory. See [overloads|the corresponding chapter].

Since Jelix 1.6.28, there is also an other possibility to store properties files into <yourapp>/app/locales/, in the same way as into <yourapp>/var/locales/. This allows to keep the var/ directory with only "variables" files.

File name ¶

File content ¶

title.offlineElements = elements to check
title.onlineElements = online elements
buttons.save = Save
buttons.ok=Ok
buttons.cancel=Cancel
buttons.search=Search

title.offlineElements = éléments à traiter
title.onlineElements = éléments en ligne
buttons.save = Enregistrer
buttons.ok=Valider
buttons.cancel=Annuler
buttons.search=Rechercher

intro=this is a very very\
long text in\
several lines
message=this is a regular line

intro=this is a very very\nlong text in\nseveral lines, but in\n one line\nin the source

nospace= #this is using a regular space
space= \w#this is using a \w space

my.nice.title.of.my.paragraph.html = <strong>My nice title of my paragraph</strong>

To retrieve a string, you have to use the get static method of jLocale. This method accepts a selector as the first argument, which has the following structure: MODULE~NAME.KEY. The "MODULE~" part is optional if the requested property file is in the current module.

For example, to retrieve the value of "buttons.save" in generic.UTF-8.properties in the "website" module:

  $string = jLocale:get("website~generic.buttons.save");

In a template, use this notation:

  <input type="button" value="{@website~generic.buttons.save@}" />

It could be useful to have localized string with dynamic parameters. For example, you want to write this string:

   You will go on the http://www.jelix.org website and you will click on the 'documentation' section.

But you would like to use the same sentence with different websites or sections: you want to dynamically indicate the url of the web site and the name of the section. This is the purpose of parameters in the jLocale component.

  $string = jLocale::get("website~generic.sentence", array('http://www.jelix.org', 'documentation'));

And in the property file, you have to put a %s where you want to insert these dynamic values:

   sentence = You will go on the %s web site and you will click on the '%s' category.

Since the translated string is parsed by the sprintf php function, you should follow its syntax. This means that you use %d for a number, %s for a string, and so on. The order of the parameters is extremely important.

    $string = jLocale::get("website~generic.sentence", array('http://www.jelix.org', 'documentation'));
    //will give you You will go on the http://www.jelix.org website and you will click on the 'documentation' section.

    $string = jLocale::get("website~generic.sentence", array('documentation', 'http://www.jelix.org'));
    //will give you You will go on the documentation website and you will click on the 'http://www.jelix.org' section.

It may happen in some language that the translation causes a change in the order of parameters. But since the code is language generic, you won't pass the parameters in a different order. So you will use the syntax %x$s where x is the order id. For example, you could have this sentence in english:

   sentence = You will go on the %s web site and you will click on the '%s' section.

But in another language, the translator would like to change the order of the parameters: the first parameter in the sentence will be the section name, not the website url. So for example, in French, it could be translated like this:

   sentence = Cliquez sur la rubrique %2$s lorsque vous irez sur le site %1$s.

The first parameter will replace %1$s, the second parameter will replace %2$s, and so on.

Note that in template, you can't use the "@localeSelector@" syntax to indicate parameters. The only option left is to use the jLocale plugin:

   <p>{jlocale "website~generic.sentence", array('http://www.jelix.org', 'documentation')}</p>

Jelix provides a coordinator plugin supporting dynamic switching of languages: autolocale, located in lib/jelix/plugins/coord/. (see the documentation about coordinator plugins).

The autolocale plugin scans urls looking for a specific parameter indicating a language. If found, it switches your application and your user to this language by storing it in session. locale configuration option is re-written by autolocale after being loaded from the configuration, so the configuration file remains untouched.

Even though the autolocale modifies the locale setting, you still get the current locale as usual:

$lang = jApp::config()->locale;

To use autolocale plugin, copy lib/jelix/plugins/coord/autolocale/autolocale.coord.ini.php.dist into var/config/ and rename it to autolocale.coord.ini.php.

There are two configuration options in this file, to allow lang change:

enableUrlDetection = on
urlParamNameLanguage = lang

enableUrlDetection activate url-scanning. urlParamNameLanguage is the name of the url parameter defining a language code. You can then add a parameter on your urls to switch to other languages:

  <a href="?lang=fr_FR">français</a>
  <a href="?lang=en_US">english</a>

Since Jelix 1.4, you can also give values without the country part of the code:

  <a href="?lang=fr">français</a>
  <a href="?lang=en">english</a>

Of course, if you use the significant url engine, you can still rewrite your urls specifically for each language. You can have also automatic parameters for language in significant urls. See the corresponding documentation. In this case, and if all URLs have a "lang" or "locale" part, probably you don't need the autolocale plugin.

Note also that if the URL parameter does not contain a language code that is not listed into the availableLocales parameter of the main configuration, jLocale tries first to use the available locale that is near the given locale, and if it doesn't find one, jLocale will use the default locale of the application.

The last step is to activate the plugin. In Jelix configuration file, edit [coordplugins] section:

[coordplugins]
autolocale = autolocale.coord.ini.php

The autolocale plugin also allows to detect automatically the language of the user, by checking the HTTP headers sent by the browser of the user when he visits your website for the first time.

If you want to enable this auto detection, you have to set the useDefaultLanguageBrowser parameter to on in the configuration of autolocale. It calls the method jLocale::getPreferedLocaleFromRequest(), that you can use of course in your own classes (controllers for example).

There are situations where it would be better to localize an entire template than to create lots of locale strings.

To achieve this, just move your template in a sub-folder of its templates directory. As for locale files, there must be one sub-folder for each language (Example: templates/en_US/, templates/fr_FR/).

With a lang code (like "en", "fr" etc..), Jelix can give the corresponding default language code ("en_US" for "en", "fr_FR" for "fr" etc). However it could not be the language code we want. For "en", you would want "en_GB" for example. Or you would want to support a language code that doesn't exist ("en_EN" for example, that is deprecated since Jelix 1.4), or to support a lang that Jelix doesn't know (all known lang code are in the file Flib/jelix/core/lang_to_locale.ini.php@@).

To fix this problem, you have to fill the section [langToLocale] into the main configuration. The parameter key is the lang code, and the value is the language code.

[langToLocale]
en = en_GB
; or to have compatibility with old modules:
en = en_EN

Jelix and some modules have been translated into several languages, via the web site Transifex. Some translations are not fully complete, and perhaps you won't find translations for your prefered language. You are then strongly encouraged to translate on Transifex.

The resulting properties files are available on https://download.jelix.org/jelix/langpacks/.

Download any package, unzip them into the directory <yourapp>/app/locales/ (probably you need to create it). Empty the temp directory, configure the application to support the new language (see above) and you could use Jelix modules with these translations.