README
Ibus-table is a framework for table based input methods using IBus.

Ibus-table is mostly used for Chinese, table based input methods like
ZhengMa, WuBi, ErBi, CangJie and so on.

But it can be used for other languages as well and some tables are
available for other languages.

Authors and contributors:

  • Yuwei YU (‘acevery’) acevery@gmail.com (Original Author)
  • Mike FABIAN mfabian@redhat.com (Current maintainer and Fedora package maintainer)
  • Caius ‘kaio’ CHANCE kaio@fedoraproject.org (Current maintainer)
  • Peng Huang
  • BYVoid
  • Peng Wu
  • koterpilla
  • Zerng07
  • Bernard Nauwelaerts
  • Xiaojun Ma
  • mozbugbox
  • Seán de Búrca

You can report bugs here:

https://github.com/kaio/ibus-table/issues

Online documentation can be found here:

http://kaio.github.io/ibus-table/
http://kaio.github.io/ibus-table/documentation.html

The keybindings are documented here:

http://kaio.github.io/ibus-table/documentation.html#key-bindings

A  copy of that key-bindings documentation is included here for
convenience:

Key bindings

┏━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃    Key combination    │                       Effect                        ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Space                 │ Commit the preëdit string.                          ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Escape                │ Clear preëdit and discard contents.                 ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Left (Arrow left)     │ Move cursor one character left in the preëdit text. ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Control+Left          │ Move cursor to the left end of the preëdit text.    ┃
┃ (Control+Arrow_Left)  │                                                     ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Right (Arrow right)   │ Move cursor one characater right in preëdit text.   ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Control+Right         │ Move cursor to the right end of the preëdit text.   ┃
┃ (Control+Arrow_Right) │                                                     ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Backspace             │ Remove the character to the left of the cursor in   ┃
┃                       │ the preëdit text.                                   ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Control+Backspace     │ Remove everything left of the cursor in the preëdit ┃
┃                       │ text.                                               ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Delete                │ Remove the character to the right of the cursor in  ┃
┃                       │ the preëdit text.                                   ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Control+Delete        │ Remove everything to the right of the cursor in the ┃
┃                       │ preëdit text.                                       ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Down (Arrow down)     │ Select the next candidate.                          ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Up (Arrow up)         │ Select the previous candidate.                      ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Page_Up               │ Show next page of candidates.                       ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Page_Down             │ Show previous page of candidates.                   ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ -                     │ When not being used as a valid input key, same as   ┃
┃                       │ Page_Up.                                            ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ =                     │ When not being used as a valid input key, same as   ┃
┃                       │ Page_Down.                                          ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃                       │ Commit the candidate labelled with that number.     ┃
┃                       │ Note that a table can define other keys than the    ┃
┃ 1 … 9                │ numbers 1 … 9 as select keys to be able to use      ┃
┃                       │ numbers as input. For example, the “latex” table    ┃
┃                       │ needs number as input. Therefore, the “latex” table ┃
┃                       │ defines F1 … F9 as select keys.                     ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Control+1 … Control+9 │ Commit the candidate labelled with that number to   ┃
┃                       │ the preëdit.                                        ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Alt+1 … Alt+9         │ Remove the candidate labelled with that number from ┃
┃                       │ the database of learned user input.                 ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃                       │   • When the preëdit is empty: toggle the input     ┃
┃ Shift_L (Left Shift   │     mode between direct input mode (e.g. “English”) ┃
┃ key)                  │     and table mode (e.g. “Chinese”).                ┃
┃                       │   • When the preëdit is not empty: commit the first ┃
┃                       │     candidate to the preëdit.                       ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Shift_R (Right Shift  │   • When in table mode: Toggle between pinyin mode  ┃
┃ key)                  │     and normal mode.                                ┃
┃                       │   • When in direct input mode: No function.         ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Shift+1 … Shift+5     │ When in pinyin mode, input the tones. The tones are ┃
┃ (Right or Left Shift  │ displayed in the aux area as ↑1, ↑2, ↑3, ↑4, ↑5. 1  ┃
┃ key)                  │ is YinPin, 2 is YangPin, 3 is ShangSheng, 4 is      ┃
┃                       │ QuSheng, 5 is QingSheng.                            ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃                       │ Toggle “one char mode”, i.e. toggle between showing ┃
┃ Control+,             │ only single characters and several characters at    ┃
┃                       │ once in the candidate list.                         ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Control+.             │ Toggle between fullwidth and halfwidth punctuation. ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Control+/             │ Toggle “autocommit mode”.                           ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃                       │ Toggle between the 5 Chinese modes:                 ┃
┃                       │                                                     ┃
┃                       │   • Simplified Chinese                              ┃
┃ Control+;             │   • Traditional Chinese                             ┃
┃                       │   • Simplified Chinese first                        ┃
┃                       │   • Traditional Chinese first                       ┃
┃                       │   • All Chinese characters                          ┃
┠───────────────────────┼─────────────────────────────────────────────────────┨
┃ Shift+Space           │ Toggle letter width between fullwidth and halfwidth ┃
┗━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛