README-En.md

hallelujahIM

hallelujahIM is an english input method with auto-suggestions and spell check features.

1. The auto-suggestion words are derived from Google's 1/3 million most frequent English words. I have refined this list to 140,402 words, removing nearly all misspelled ones. Candidate words are sorted by frequency.
2. HallelujahIM also functions as a Spell-Checker: when you input an incorrect word, it will suggest the right alternatives.
3. HallelujahIM also serves as a Text Expander: it loads the file ~/.you_expand_me.json from your Home directory. Here, you can define your favorite substitutions, such as {"te":"text expander", "yem":"you expand me"}.
4. Instant translation is available as you type words (currently, it only supports English-to-Chinese, but the translation dictionary can be configured later on).
5. Pinyin to English: you can input Hanyu Pinyin and receive the matching English word.
6. Fuzzy phonetic match is another feature. For example, you can input cerrage or kerrage to get courage, and aosome or ausome to get awesome.
7. You can switch to the default English input mode (the normal, quiet, or silent mode) by pressing the right shift key. Pressing shift again will switch back to the auto-suggestion mode.

download and install

1. download releases

• for macOS 10.12 ~ 14.2: https://github.com/dongyuwei/hallelujahIM/releases/latest, download the .pkg installer.
• for macOS 10.9 ~ 10.11(Deprecated version): https://github.com/dongyuwei/hallelujahIM/releases/tag/v1.1.1, deprecated version, need to install the .app manually.
• Windows: ported to Windows based on PIME，https://github.com/dongyuwei/Hallelujah-Windows/releases, download the .exe installer.
• Linux：https://github.com/fcitx-contrib/fcitx5-hallelujah, thanks Qijia Liu！
• Android: https://github.com/dongyuwei/Hallelujah-Android

2. unzip the app, copy it to /Library/Input\ Methods/ or ~/Library/Input\ Methods/
3. go to System Preferences --> Input Sources --> click the + --> select English --> select hallelujah
4. switch to hallelujah input method

update/reinstall

1. delete the hallelujah from Input Sources
2. kill the old hallelujah Process (kill it by pkill -9 hallelujah, check it been killed via ps ax|grep hallelujah )
3. replace the hallelujah app in /Library/Input Methods/.
4. add the hallelujah to Input Sources
5. switch to hallelujah, use it.

Why it's named hallelujahIM?

Inspired by hallelujah_autocompletion.

preferences setting

click Preferences... or visit web ui: http://localhost:62718/index.html

setup:

Build project

1. open hallelujah.xcworkspace
2. build the project.

License

GPL3(GNU GENERAL PUBLIC LICENSE Version 3)

About libmarisa / marisa-trie

1. The static libmarisa.a lib was built from marisa-trie @006020c1df76d0d7dc6118dacc22da64da2e35c4.
2. To build the libmarisa.a lib, run:

git clone git://github.com/s-yata/marisa-trie.git
cd marisa-trie
brew install autoconf automake libtool -verbose
autoreconf -i
./configure --enable-static
make
## ls -alh lib/marisa/.libs/libmarisa.a
make install ## we can use marisa-build marisa-lookup marisa-reverse-lookup marisa-common-prefix-search marisa-predictive-search marisa-dump marisa-benchmark cli commands to do some tests and pre-build the trie data.

Thanks to the following projects:

1. marisa-trie
2. dictionary/cedict.json is transformed from cc-cedict
3. cmudict and https://github.com/mphilli/English-to-IPA
4. GCDWebServer
5. talisman, using its phonex algorithm to implement fuzzy phonics match.
6. MDCDamerauLevenshtein, using it to calculate the edit distance.
7. squirrel, I shamelessly copied the script to install and build pkg App for Mac.

snapshots

auto suggestion from local dictionary:

Text Expander:

translation(inspired by MacUIM):

spell check:

pinyin in, English out:

Paid Support

If functional you need is missing but you're ready to pay for it, feel free to contact me. If not, create an issue anyway, I'll take a look as soon as I can.

Contact me

• wechat: dongyuwei
• gmail: newdongyuwei