/python/engine/XingMa/README

 1## Notice: 
 2this IME framework is under development, and further implementation will be
 3merged in the further, although it is already very powerful now:)
 4
 51.Requirement:
 6>=python-2.5 (we need the sqlite3 in it)
 7If you build python by yourself
 8please make sure you make the sqlite3 feather available.
 9If you use gentoo, make sure you emerge python with sqlite USE
10
11>=scim-python-0.1.10 or svn version.
12In Gentoo, you only need to use gentoo-china overlay, which contain the
13scim-python-9999.ebuild.
14
15
162.Install:
17You can use XMCreateDB.py to build up a database:
18
19python XMCreateDB.py -n tables/zm.db -s zhengma.txt.bz2
20
21then, copy the XingMa directory to /usr/share/scim-python/engine/ which
22already contain the PinYin and EnglishWriter directories.
23copy the zhengma.png to /usr/share/scim/icons/
24
25logout your Xsession, stop gdm/kdm/xdm, clear your /tmp/ and then login your
26Xsession, it should be work now.
27
283.Usage
293.1 Basic input:
30<Space> : directly commit string to program;
31<Shift> : not in inputting, change input mode between XingMa and English;
32          during inputting, commit string to preedit string, this is for user define phrase;
33<Arrow Left> and <Arrow Right> : move cursor in preedit string;
34<Backspace> : remove input chars or remove a char in preedit string;
35<Delete> : delete a char in preedit string;
36<Control> + <Arrow Left>  : move to the start of a phrase in preedit string;
37<Control> + <Arrow Right> : move to the end of a phrase in preedit string;
38<Control> + <Backspace>   : remove to the start of a phrase in preedit string;
39<Control> + <Delete>      : delete to the end of a phrase in preedit string;
40<Arrow Down> : move cursor to the next phrase in lookup table;
41<Arrow Up> : move cursor to the before phrase in lookup table;
42<Return> : when not press <Shift> (do not commit to preedit string), commit input chars as English words into programe; else clean the preedit string;
43<Esc> : reset the IME;
44<Num 1> ~ <Num 9> : select phrase in lookup table and commit preedit string to program;
45<Control> + ( <Num 1> ~ <Num 9>): select phrase in lookup table and only commit it into preedit string, this is for user define phrases.
46
474 DIY:
48to add your diy IME, you need a source file of your IME, you can learn needed config variables from zhengma.txt.bz2