Blame README

Packit Service 6a275b
ibus-typing-booster
Packit Service 6a275b
Packit Service 6a275b
Faster typing by context sensitive completion.
Packit Service 6a275b
Packit Service 6a275b
Introduction
Packit Service 6a275b
Packit Service 6a275b
Ibus-typing-booster is a completion input method to speedup typing.
Packit Service 6a275b
Packit Service 6a275b
The project was started in 2010 for Fedora 15. The original purpose was to make typing of
Packit Service 6a275b
Indic languages easier and faster by providing completion and spell checking suggestions.
Packit Service 6a275b
Packit Service 6a275b
Originally it was forked from ibus-table whose developer was Yu Yuwei acevery@gmail.com,
Packit Service 6a275b
with contributions from Caius “kaio” Chance me@kaio.net.
Packit Service 6a275b
Packit Service 6a275b
Since then ibus-typing-booster has been improved to support many other languages as well
Packit Service 6a275b
(most languages except Chinese and Japanese are supported).
Packit Service 6a275b
Packit Service 6a275b
Recently the capapility to type different languages at the same time without having to
Packit Service 6a275b
switch between languages has been added.
Packit Service 6a275b
Packit Service 6a275b
Developers:
Packit Service 6a275b
  
Packit Service 6a275b
  • Mike FABIAN mfabian@redhat.com
Packit Service 6a275b
  • Anish Patil anish.developer@gmail.com
Packit Service 6a275b
Packit Service 6a275b
Features
Packit Service 6a275b
  
Packit Service 6a275b
  • Context sensitive completions.
Packit Service 6a275b
  • Learns from user input.
Packit Service 6a275b
  • Can be trained by supplying files containing typical user input.
Packit Service 6a275b
  • If available, hunspell and hunspell dictionaries will also be used to provide not only
Packit Service 6a275b
    completion but also spellchecking suggestions (But ibus-typing-booster works also
Packit Service 6a275b
    without hunspell by learning only from user input).
Packit Service 6a275b
  • Can be used with any keyboard layout.
Packit Service 6a275b
  • Almost all input methods supplied by libm17n are supported (including the inscript2
Packit Service 6a275b
    input methods).
Packit Service 6a275b
  • Several input methods and languages can be used at the same time without switching.
Packit Service 6a275b
  • Predicts Unicode symbols and emoji as well.
Packit Service 6a275b
Packit Service 6a275b
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Packit Service 6a275b
Packit Service 6a275b
You can report bugs here:
Packit Service 6a275b
Packit Service 6a275b
https://github.com/mike-fabian/ibus-typing-booster/issues
Packit Service 6a275b
Packit Service 6a275b
Online documentation can be found here:
Packit Service 6a275b
Packit Service 6a275b
http://mike-fabian.github.io/ibus-typing-booster/
Packit Service 6a275b
http://mike-fabian.github.io/ibus-typing-booster/documentation.html
Packit Service 6a275b
Packit Service 6a275b
The key bindings and mouse bindings are documented here:
Packit Service 6a275b
Packit Service 6a275b
http://mike-fabian.github.io/ibus-typing-booster/documentation.html#key-bindings
Packit Service 6a275b
http://mike-fabian.github.io/ibus-typing-booster/documentation.html#mouse-bindings
Packit Service 6a275b
Packit Service 6a275b
A copy of that key bindings and mouse bindings documentation is
Packit Service 6a275b
included here for convenience:
Packit Service 6a275b
Packit Service 6a275b
Key bindings
Packit Service 6a275b
Packit Service 6a275b
┏━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
Packit Service 6a275b
┃  Key combination  │                         Effect                          ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Commit the preëdit (or the selected candidate, if any)  ┃
Packit Service 6a275b
┃ Space             │ and send a space to the application, i.e. commit the    ┃
Packit Service 6a275b
┃                   │ typed string followed by a space.                       ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Return            │ Commit the preëdit (or the selected candidate, if any)  ┃
Packit Service 6a275b
┃                   │ and send a Return to the application.                   ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Enter             │ Commit the preëdit (or the selected candidate, if any)  ┃
Packit Service 6a275b
┃                   │ and send a Enter to the application.                    ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │   • If the option “☐ Enable suggestions by Tab key” is  ┃
Packit Service 6a275b
┃                   │     not set: “Tab” behaves like the other “commit       ┃
Packit Service 6a275b
┃                   │     keys”, i.e. it commits the preëdit (or the selected ┃
Packit Service 6a275b
┃                   │     candidate, if any) and sends a Tab to the           ┃
Packit Service 6a275b
┃                   │     appplication.                                       ┃
Packit Service 6a275b
┃                   │   • If the option “☑ Enable suggestions by Tab key” is  ┃
Packit Service 6a275b
┃                   │     set, no candidate list is shown by default:         ┃
Packit Service 6a275b
┃                   │       □ If Tab has not yet been typed: Request to show  ┃
Packit Service 6a275b
┃                   │         the candidate list (nothing might be shown if   ┃
Packit Service 6a275b
┃ Tab               │         no candidates can be found).                    ┃
Packit Service 6a275b
┃                   │       □ If Tab has been typed already, i.e. the         ┃
Packit Service 6a275b
┃                   │         candidate list has already been requested:      ┃
Packit Service 6a275b
┃                   │         Commit selected candidate (or preëdit if no     ┃
Packit Service 6a275b
┃                   │         candidate is selected), then pass the Tab to    ┃
Packit Service 6a275b
┃                   │         the application. *And* hide the candidate list  ┃
Packit Service 6a275b
┃                   │         again after each commit! That means that when   ┃
Packit Service 6a275b
┃                   │         typing continues after each commit, no          ┃
Packit Service 6a275b
┃                   │         candidate list is shown until one types Tab to  ┃
Packit Service 6a275b
┃                   │         request it.                                     ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │   • When a candidate is selected (no matter whether     ┃
Packit Service 6a275b
┃                   │     this is a normal lookup table or a “related” lookup ┃
Packit Service 6a275b
┃                   │     table): Show the first page of that lookup table    ┃
Packit Service 6a275b
┃                   │     again with no candidate selected.                   ┃
Packit Service 6a275b
┃ Escape            │   • When no candidate is selected:                      ┃
Packit Service 6a275b
┃                   │       □ When a lookup table with related candidates is  ┃
Packit Service 6a275b
┃                   │         shown: go back to the original lookup table.    ┃
Packit Service 6a275b
┃                   │       □ When a normal lookup table is shown: close it   ┃
Packit Service 6a275b
┃                   │         and clear the preëdit.                          ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Move cursor one typed key left in the preëdit text. May ┃
Packit Service 6a275b
┃ Left (Arrow left) │ trigger a commit if the left end of the preëdit is      ┃
Packit Service 6a275b
┃                   │ reached.                                                ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Move cursor to the left end of the preëdit text. If the ┃
Packit Service 6a275b
┃ Control+Left      │ cursor is already at the left end of the preëdit text,  ┃
Packit Service 6a275b
┃                   │ trigger a commit and send a Control+Left to the         ┃
Packit Service 6a275b
┃                   │ application.                                            ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Right (Arrow      │ Move cursor one typed key right in preëdit text. May    ┃
Packit Service 6a275b
┃ right)            │ trigger a commit if the right end of the preëdit is     ┃
Packit Service 6a275b
┃                   │ reached.                                                ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Move cursor to the right end of the preëdit text. If    ┃
Packit Service 6a275b
┃ Control+Right     │ the cursor is already at the right end of the preëdit   ┃
Packit Service 6a275b
┃                   │ text, trigger a commit and send a Control+Right to the  ┃
Packit Service 6a275b
┃                   │ application.                                            ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Backspace         │ Remove the typed key to the left of the cursor in the   ┃
Packit Service 6a275b
┃                   │ preëdit text.                                           ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Control+Backspace │ Remove everything to the left of the cursor in the      ┃
Packit Service 6a275b
┃                   │ preëdit text.                                           ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Delete            │ Remove the typed key to the right of the cursor in the  ┃
Packit Service 6a275b
┃                   │ preëdit text.                                           ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Control+Delete    │ Remove everything to the right of the cursor in the     ┃
Packit Service 6a275b
┃                   │ preëdit text.                                           ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Down (Arrow down) │ Select the next candidate.                              ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Up (Arrow up)     │ Select the previous candidate.                          ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Page_Up           │ Show next page of candidates.                           ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Page_Down         │ Show previous page of candidates.                       ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ F1                │ Commit the candidate with the label “1” followed by a   ┃
Packit Service 6a275b
┃                   │ space                                                   ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ F2                │ Commit the candidate with the label “2” followed by a   ┃
Packit Service 6a275b
┃                   │ space                                                   ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ ...               │ ...                                                     ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ F9                │ Commit the candidate with the label “9” followed by a   ┃
Packit Service 6a275b
┃                   │ space                                                   ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Remove the candidate with the label “1” from the        ┃
Packit Service 6a275b
┃ Control+F1        │ database of learned user input (If possible, if this    ┃
Packit Service 6a275b
┃                   │ candidate is not learned from user input, nothing       ┃
Packit Service 6a275b
┃                   │ happens).                                               ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Remove the candidate with the label “2” from the        ┃
Packit Service 6a275b
┃ Control+F2        │ database of learned user input (If possible, if this    ┃
Packit Service 6a275b
┃                   │ candidate is not learned from user input, nothing       ┃
Packit Service 6a275b
┃                   │ happens).                                               ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ …                 │ …                                                       ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Remove the candidate with the label “9” from the        ┃
Packit Service 6a275b
┃ Control+F9        │ database of learned user input (If possible, if this    ┃
Packit Service 6a275b
┃                   │ candidate is not learned from user input, nothing       ┃
Packit Service 6a275b
┃                   │ happens).                                               ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Same as F1 … F9 if the option “Use digits as select     ┃
Packit Service 6a275b
┃                   │ keys” is enabled. Enabling that option makes selecting  ┃
Packit Service 6a275b
┃                   │ candidates a bit easier because the number keys 1 … 9   ┃
Packit Service 6a275b
┃                   │ are closer to the fingers then F1 … F9 on most          ┃
Packit Service 6a275b
┃                   │ keyboards. On the other hand, it makes completing when  ┃
Packit Service 6a275b
┃ 1 … 9             │ typing numbers impossible and it makes typing strings   ┃
Packit Service 6a275b
┃                   │ which are combinations of letters and numbers like “A4” ┃
Packit Service 6a275b
┃                   │ more difficult. If digits are used as select keys,      ┃
Packit Service 6a275b
┃                   │ numbers can only be typed when no candidate list is     ┃
Packit Service 6a275b
┃                   │ shown. In most cases this means that numbers can only   ┃
Packit Service 6a275b
┃                   │ be typed when nothing else has been typed yet and the   ┃
Packit Service 6a275b
┃                   │ preëdit is empty.                                       ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Control+1 …       │ Same as Control+F1 … Control+F9 if the option “Use      ┃
Packit Service 6a275b
┃ Control+9         │ digits as select keys” is enabled.                      ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Toggle the emoji and Unicode symbol prediction on/off.  ┃
Packit Service 6a275b
┃ AltGr+F6          │ This has the same result as using the setup tool to     ┃
Packit Service 6a275b
┃                   │ change this.                                            ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                   │ Toggle the “Off the record” mode. This has the same     ┃
Packit Service 6a275b
┃                   │ result as using the setup tool to change this.          ┃
Packit Service 6a275b
┃                   │ While “Off the record” mode is on, learning from user   ┃
Packit Service 6a275b
┃                   │ input is disabled. If learned user input is available,  ┃
Packit Service 6a275b
┃ AltGr+F9          │ predictions are usually much better than predictions    ┃
Packit Service 6a275b
┃                   │ using only dictionaries. Therefore, one should use this ┃
Packit Service 6a275b
┃                   │ option sparingly. Only if one wants to avoid saving     ┃
Packit Service 6a275b
┃                   │ secret user input to disk it might make sense to use    ┃
Packit Service 6a275b
┃                   │ this option temporarily.                                ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ AltGr+F10         │ Open the setup tool                                     ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ AltGr+F12         │ Show related emoji and Unicode symbols or related words ┃
Packit Service 6a275b
┠───────────────────┼─────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ AltGr+Space       │ Insert a literal space into the preëdit.                ┃
Packit Service 6a275b
┗━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Packit Service 6a275b
Packit Service 6a275b
Packit Service 6a275b
When more than one input method at the same time is used, the following
Packit Service 6a275b
additional key bindings are available:
Packit Service 6a275b
Packit Service 6a275b
┏━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
Packit Service 6a275b
┃      Key      │                           Effect                            ┃
Packit Service 6a275b
┃  combination  │                                                             ┃
Packit Service 6a275b
┠───────────────┼─────────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Control+Down  │ Switch input method used for the preëdit to the next input  ┃
Packit Service 6a275b
┃               │ method                                                      ┃
Packit Service 6a275b
┠───────────────┼─────────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Control+Up    │ Switch input method used for the preëdit to the previous    ┃
Packit Service 6a275b
┃               │ input method.                                               ┃
Packit Service 6a275b
┗━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Packit Service 6a275b
Packit Service 6a275b
Packit Service 6a275b
Packit Service 6a275b
Mouse bindings
Packit Service 6a275b
Packit Service 6a275b
┏━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
Packit Service 6a275b
┃   Mouse event    │                          Effect                          ┃
Packit Service 6a275b
┠──────────────────┼──────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Button 1 click   │ Commit the candidate clicked on followed by a space      ┃
Packit Service 6a275b
┃ on a candidate   │ (Same as F1…F9).                                         ┃
Packit Service 6a275b
┠──────────────────┼──────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Control + Button │ Remove clicked candidate from database of learned user   ┃
Packit Service 6a275b
┃ 1 click on a     │ input (If possible, if this candidate is not learned     ┃
Packit Service 6a275b
┃ candidate        │ from user input, nothing happens).                       ┃
Packit Service 6a275b
┠──────────────────┼──────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Button 3 click   │ Show related emoji and Unicode symbols or related words  ┃
Packit Service 6a275b
┃ on a candidate   │ (Same as Alt+F12).                                       ┃
Packit Service 6a275b
┠──────────────────┼──────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃ Control + Button │ Toggle the emoji and Unicode symbol prediction on/off    ┃
Packit Service 6a275b
┃ 3 click anywhere │ (Same as Alt+F6). This has the same result as using the  ┃
Packit Service 6a275b
┃ in the candidate │ setup tool to change this.                               ┃
Packit Service 6a275b
┃ list             │                                                          ┃
Packit Service 6a275b
┠──────────────────┼──────────────────────────────────────────────────────────┨
Packit Service 6a275b
┃                  │ Toggle the “Off the record” mode (Same as Alt+F9). This  ┃
Packit Service 6a275b
┃                  │ has the same result as using the setup tool to change    ┃
Packit Service 6a275b
┃                  │ this.                                                    ┃
Packit Service 6a275b
┃ Alt + Button 3   │ While “Off the record” mode is on, learning from user    ┃
Packit Service 6a275b
┃ click anywhere   │ input is disabled. If learned user input is available,   ┃
Packit Service 6a275b
┃ in the candidate │ predictions are usually much better than predictions     ┃
Packit Service 6a275b
┃ list             │ using only dictionaries. Therefore, one should use this  ┃
Packit Service 6a275b
┃                  │ option sparingly. Only if one wants to avoid saving      ┃
Packit Service 6a275b
┃                  │ secret user input to disk it might make sense to use     ┃
Packit Service 6a275b
┃                  │ this option temporarily.                                 ┃
Packit Service 6a275b
┗━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛