git clone https://github.com/wikimedia/jquery.i18n.gitFirst, get a copy of the git repo by running:
git clone git://github.com/wikimedia/jquery.i18n.gitMake sure you have grunt installed by testing:
grunt -versionIf not, run:
npm install -g gruntTo run tests locally, run grunt, and this will run the tests in PhantomJS.
You can also run the tests in a browser by navigating to the test/ directory, but first run grunt to install submodules.
While initializing the jquery.i18n, the locale for the page can be given using the locale option. For example
$.i18n({
locale: 'he' // Locale is Hebrew
});In case locale option is not given, jquery.i18n plugin will use the language attribute given for the html tag. For example
<html lang="he" dir="rtl">In this case the locale will be he(Hebrew). If that lang attribute is also missing, it will try to use the locale specified by the browser.
It is possible to switch to another locale after plugin is initialized. See below example:
$.i18n({
locale: 'he' // Locale is Hebrew
});
$.i18n( 'message_hello' ); // This will give the Hebrew translation of message key `message_hello`.
$.i18n().locale = 'ml'; // Now onwards locale is 'Malayalam'
$.i18n( 'message_hello' ); // This will give the Malayalam translation of message key `message_hello`. JSON formatted messages can be loaded to the plugin using multiple ways.
Following example shows loading messages for two locales- localex, and localey. Here localex and localey are just examples. They should be valid IS0 639 language codes(eg: en, ml, hi, fr, ta etc)
$.i18n().load({
'localex' : {
'x' : 'X' // Message for localex.
},
'localey' : {
'y' : 'Y' // Message for locale y
}
});If we want to load the messages for a specific locale, it can be done like this:
$.i18n().load({
'message_hello' : 'Hello World',
'message_welcome' : 'Welcome',
}, 'en');Note the second argument for the load method. It should be a valid language code.
It is also possible to refer messages from an external URL. See below example
$.i18n().load({
'en' : {
'message_hello' : 'Hello World',
'message_welcome' : 'Welcome'
},
'hi' : 'i18n/messages-hi.json', // Messages for Hindi
'de' : 'i18n/messages-de.json'
});See http://thottingal.in/projects/js/jquery.i18n/demo/
Messages take parameters. They are represented by $1, $2, $3, … in the message texts, and replaced at run time. Typical parameter values are numbers ("Delete 3 versions?"), or user names ("Page last edited by $1"), page names, links, and so on, or sometimes other messages.
var message = "Welcome, $1";
$.i18n(message, 'Alice'); // This gives "Welcome, Alice"To make the syntax of sentence correct, plural forms are required. jquery.i18n support plural forms in the message using the syntax {{PLURAL:$1|pluralform1|pluralform2|...}}
For example:
var message = "Found $1 {{PLURAL:$1|result|results}}";
$.i18n(message, 1); // This gives "Found 1 result"
$.i18n(message, 4); // This gives "Found 4 results"Note that {{PLURAL:...}} is not case sensitive. It can be {{plural:...}} too.
In case of English, there are only 2 plural forms, but many languages use more than 2 plural forms. All the plural forms can be given in the above syntax, separated by pipe(|)
Similar to plural, depending on gender of placeholders, mostly user names, the syntax changes dynamically. An example in English is "Alice changed her profile picture" and "Bob changed his profile picture". To support this {{GENDER...}} syntax can be used as show in example
var message = "$1 changed {{GENDER:$2|his|her}} profile picture";
$.i18n(message, 'Alice', 'female' ); // This gives "Alice changed her profile picture"
$.i18n(message, 'Bob', 'male' ); // This gives "Bob changed his profile picture"Note that {{GENDER:...}} is not case sensitive. It can be {{gender:...}} too.
$.i18n( { locale: 'fi' } );
var message = "{{grammar:genitive|$1}}";
$.i18n(message, 'talo' ); // This gives "talon"
$.i18n().locale = 'hy'; // Switch to locale Armenian
$.i18n(message, 'Մաունա'); // This gives "Մաունայի"See https://github.com/wikimedia/jquery.i18n/wiki/Specification
Please follow jQuery coding guidelines
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent