Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
jQuery based input methods library
JavaScript CSS
branch: master

This branch is 141 commits behind wikimedia:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
css
examples Remove unused variables in example
images
libs
rules
src Update incomplete documentation
test
.gitignore
.gitmodules Start very basic test support
.jshintignore
.jshintrc
.travis.yml
GPL-LICENSE
Gruntfile.js
MIT-LICENSE jshint cleanup and grunt setup
README.md
package.json

README.md

jQuery.IME

jQuery.IME is a jQuery based input method editor library supporting more than 135 input methods across more than 62 languages.

These input methods are well tested. Initially the input methods were contributed by the Wikimedia community. By now many input methods have also been contributed by Red Hat.

This project is a Wikimedia foundation initiative to provide language technology tools to a wider audience outside the Wikimedia universe.

This input tool is widely deployed in all Wikimedia projects(eg: wikipedia).

Quick start

git clone https://github.com/wikimedia/jquery.ime.git

To add input method support to the editable fields of a web page:

$( 'textarea' ).ime();

jquery.ime provides a jquery plugin function $.fn.ime() to add input method support for any editable elements in a page.

Example

See an example page where jquery.ime in action.

To try the example locally, after checking out the code, start a local webserver to serve the files. This is very easy.

If you have python installed, run

python -m SimpleHTTPServer

or, In case you have python3

python3 -m http.server

Alternatively you can use tools like webfsd. If you know how to use advanced web servers like apache or nginx, you already know how to put the code in a webserver.

Plugin Options

Option Description
imePath Relative/Absolute path for the rules folder of jquery.ime. Default value: '../'
languages Languages to be used- by default all languages. Default value: []. Eg: ['hi', 'ml']. It can also be a function returning an array.
helpHandler Called for each ime option in the menu, default value: null

Browser extensions

This input tool is also available as Firefox and Chrome extensions.

For Developers

Read rules/README to learn how to write an input method for a language.

Read test/README.md to learn how to write and run tests for an input method.

Read the technical specification of the project from wiki.

Do watch the code walkthrough by Chris Forno: http://www.youtube.com/watch?v=LPec-KIBVeI

License

This project is dual licensed with GPLv2+ and MIT license. See the license files in the source code for more details.

Something went wrong with that request. Please try again.