Repository :
http://git.fedorahosted.org/git/?p=ibus-typing-booster.git
On branch : master
---------------------------------------------------------------
commit 5261de0a0abf4641df34bbd7be40c54a9381ad0f
Author: Mike FABIAN <mfabian(a)redhat.com>
Date: Fri Sep 9 11:08:52 2016 +0200
Update README with latest key binding and mouse binding documentation
---------------------------------------------------------------
README | 365 ++++++++++++++++++++++++++++++++++++++--------------------------
1 files changed, 218 insertions(+), 147 deletions(-)
diff --git a/README b/README
index d437ad2..5077177 100644
--- a/README
+++ b/README
@@ -1,151 +1,222 @@
-== Introduction ==
-ibus-typing-booster is a completion input method to speedup typing.
+ibus-typing-booster
-Originally it was forked from ibus-table whose Project Owner &
-Developer is Yu Yuwei <acevery(a)gmail.com>, with contributions from
-Caius "kaio" Chance <cchance(a)redhat.com>.
+Faster typing by context sensitive completion.
+
+Introduction
+
+Ibus-typing-booster is a completion input method to speedup typing.
+
+The project was started in 2010 for Fedora 15. The original purpose was to make typing
of
+Indic languages easier and faster by providing completion and spell checking
suggestions.
+
+Originally it was forked from ibus-table whose developer was Yu Yuwei acevery(a)gmail.com,
+with contributions from Caius ���kaio��� Chance me(a)kaio.net.
+
+Since then ibus-typing-booster has been improved to support many other languages as well
+(most languages except Chinese and Japanese are supported).
+
+Recently the capapility to type different languages at the same time without having to
+switch between languages has been added.
Developers:
-Mike FABIAN <mfabian(a)redhat.com>
-Anish Patil <anish.developer(a)gmail.com>
-
-== Key Bindings ==
-Space Commit the pre��dit and send a space to the application,
- i.e. commit the typed string followed by a space.
-Return Commit the pre��dit and send a Return to the application.
-Enter Commit the pre��dit and send a Enter to the application.
-Tab If the option ���Enable suggestions by Tab key��� is
- *not* set:
- ���Tab��� behaves like ���Space���, i.e. it commits
- the typed string followed by a space.
- If the option ���Enable suggestions by Tab key��� is
- set:
- ���Tab��� toggles the display of the candidate list.
- I.e. it shows the candidate list if it was
- hidden and hides the candidate list if it was
- shown.
-
-Escape Clear pre��dit and discard contents.
-
-Left (Arrow left) Move cursor one typed key left in the pre��dit text.
- May trigger a commit if the left end of the pre��dit
- is reached.
-Control+Left Move cursor to the left end of the pre��dit text.
- If the cursor is already at the left end of the pre��dit
- text, trigger a commit and send a Control+Left
- to the application.
-Right (Arrow right) Move cursor one typed key right in pre��dit text.
- May trigger a commit if the right end of the pre��dit
- is reached.
-Control+Right Move cursor to the right end of the pre��dit text.
- If the cursor is already at the right end of the pre��dit
- text, trigger a commit and send a Control+Right
- to the application.
-Backspace Remove the typed key to the left of the cursor in
- the pre��dit text.
-Control+Backspace Remove everything to the left of the cursor in the
- pre��dit text.
-Delete Remove the typed key 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.
-
-F1 Commit the candidate with the label ���1���
-F2 Commit the candidate with the label ���2���
-���
-F9 Commit the candidate with the label ���9���
-Control+F1 Remove the candidate with the label ���1��� from the
- database of learned user input
-Control+F2 Remove the candidate with the label ���2��� from the
- database of learned user input
-���
-Control+F9 Remove the candidate with the label ���9��� from the
- database of learned user input
-1���9 Same as F1���F9 if the option ���Use digits as select keys���
- is enabled. This makes selecting candidates a bit easier
- because the number keys 1���9 are closer to the fingers then
- F1���F9 on most keyboards. On the other hand, it makes
- completing when typing numbers impossible and it makes
- typing strings which are combinations of letters and
- numbers like ���A4��� more difficult. If digits are used as
- select keys, numbers can only be typed when no candidate
- list is shown. In most cases this means that numbers can
- only be typed when nothing else has been typed yet and
- the pre��dit is empty.
-Control+1���Control+9 Same as Control+F1���Control+F9 if the option
- ���Use digits as select keys��� is enabled.
-
-When more than one input method at the same time is used:
-
-Control+Down Switch input method used for the pre��dit to the
- next input method
-Control+Up Switch input method used for the pre��dit to the
- previous input method.
-
-
-== Multilingual input ==
-
-ibus-typing-booster supports using more than one input
-method/transliteration at the same time.
-
-For example, if one uses the ibus-typing-booster engine "mr-IN",
-i.e. the engine for the Indian language Marathi, one can select one of
-the Marathi input methods mr-itrans, mr-phonetic, mr-inscript, and
-mr-inscript2 in the setup tool. Keys typed will be transliterated
-using the selected transliteration method and looked up in the mr_IN
-hunspell dictionary and the user database of previous input.
-
-To add English as a second language to use at the same time, one can
-use the checkbox option ���Add direct input��� in the setup tool. If that
-option is selected, direct keyboard input is added as a second input
-method and the en_GB (British English) dictionary is added as a second
-dictionary in addition to the mr_IN dictionary.
-
-If more than one input/transliteration method is enabled, the typed
-keys will will be transliterated with each transliteration
-method and each result will be looked up in the enabled dictionaries
-and in the user database of previous input.
-
-That way, to type English, one does not have to switch off the Marathi
-engine of ibus-typing-booster, one can just type and suitable English
-candidates will show up as well in the candidate list. After typing a
-few characters, Marathi input is unlikely to match English candidates
-and English input is unlikely to match Marathi candidates. This works
-even better after ibus-typing-booster has learned a while from the
-user input because ibus-typing-booster tries to complete the currently
-typed word by also using the last few words typed before as additional
-information. Therefore, if the user types a combination of words again
-he has already typed previously, the prediction for the currently
-typed word will be much better.
-
-Using the setup tool it is currently only possible to add British
-English as a second language to the main language of an
-ibus-typing-booster engine.
-
-But internally, ibus-typing-booser already supports any combination
-of input methods and dictionaries, only the setup tool is not
-yet able to set this up. It can be done by setting the
-appropriate dconf keys manually though.
-
-Example:
-
-Setting three input/transliteration methods:
-
- $ dconf write /desktop/ibus/engine/typing-booster/typing-booster-mr-in/inputmethod
'"mr-itrans,t-latn-post,NoIme"'
-
-sets the three transliteration methods, ���mr-itrans��� (Marathi Itrans),
-���t-latn-post��� (A postscript input method to type accented Latin
-characters, e.g. typing ���u"��� will produce ��������), and ���NoIme��� (direct
-keyboard input without any transliteration).
-
-Setting 3 dictionaries:
-
- $ dconf write /desktop/ibus/engine/typing-booster/typing-booster-mr-in/dictionary
'"mr_IN,en_GB,de_DE"'
-
-sets the Marathi, the British English,and the German dictionary.
+ ��� Mike FABIAN mfabian(a)redhat.com
+ ��� Anish Patil anish.developer(a)gmail.com
+
+Features
+
+ ��� Context sensitive completions.
+ ��� Learns from user input.
+ ��� Can be trained by supplying files containing typical user input.
+ ��� If available, hunspell and hunspell dictionaries will also be used to provide not
only
+ completion but also spellchecking suggestions (But ibus-typing-booster works also
+ without hunspell by learning only from user input).
+ ��� Can be used with any keyboard layout.
+ ��� Almost all input methods supplied by libm17n are supported (including the
inscript2
+ input methods).
+ ��� Several input methods and languages can be used at the same time without
switching.
+ ��� Predicts Unicode symbols and emoji as well.
+
+������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+
+You can report bugs here:
+
+https://github.com/mike-fabian/ibus-typing-booster/issues
+
+Online documentation can be found here:
+
+http://mike-fabian.github.io/ibus-typing-booster/
+http://mike-fabian.github.io/ibus-typing-booster/documentation.html
+
+The key bindings and mouse bindings are documented here:
+
+http://mike-fabian.github.io/ibus-typing-booster/documentation.html#key-bindings
+http://mike-fabian.github.io/ibus-typing-booster/documentation.html#mouse-bindings
+
+A copy of that key bindings and mouse bindings documentation is
+included here for convenience:
+
+Key bindings
+
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Key combination ��� Effect ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Commit the pre��dit (or the selected candidate, if any) ���
+��� Space ��� and send a space to the application, i.e. commit the ���
+��� ��� typed string followed by a space. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Return ��� Commit the pre��dit (or the selected candidate, if any) ���
+��� ��� and send a Return to the application. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Enter ��� Commit the pre��dit (or the selected candidate, if any) ���
+��� ��� and send a Enter to the application. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� ��� If the option ������ Enable suggestions by Tab key��� is
���
+��� ��� not set: ���Tab��� behaves like the other ���commit
���
+��� ��� keys���, i.e. it commits the pre��dit (or the selected ���
+��� ��� candidate, if any) and sends a Tab to the ���
+��� ��� appplication. ���
+��� ��� ��� If the option ������ Enable suggestions by Tab key��� is
���
+��� ��� set, no candidate list is shown by default: ���
+��� ��� ��� If Tab has not yet been typed: Request to show ���
+��� ��� the candidate list (nothing might be shown if ���
+��� Tab ��� no candidates can be found). ���
+��� ��� ��� If Tab has been typed already, i.e. the ���
+��� ��� candidate list has already been requested: ���
+��� ��� Commit selected candidate (or pre��dit if no ���
+��� ��� candidate is selected), then pass the Tab to ���
+��� ��� the application. *And* hide the candidate list ���
+��� ��� again after each commit! That means that when ���
+��� ��� typing continues after each commit, no ���
+��� ��� candidate list is shown until one types Tab to ���
+��� ��� request it. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� ��� When a candidate is selected (no matter whether ���
+��� ��� this is a normal lookup table or a ���related��� lookup
���
+��� ��� table): Show the first page of that lookup table ���
+��� ��� again with no candidate selected. ���
+��� Escape ��� ��� When no candidate is selected: ���
+��� ��� ��� When a lookup table with related candidates is ���
+��� ��� shown: go back to the original lookup table. ���
+��� ��� ��� When a normal lookup table is shown: close it ���
+��� ��� and clear the pre��dit. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Move cursor one typed key left in the pre��dit text. May ���
+��� Left (Arrow left) ��� trigger a commit if the left end of the pre��dit is ���
+��� ��� reached. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Move cursor to the left end of the pre��dit text. If the ���
+��� Control+Left ��� cursor is already at the left end of the pre��dit text, ���
+��� ��� trigger a commit and send a Control+Left to the ���
+��� ��� application. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Right (Arrow ��� Move cursor one typed key right in pre��dit text. May ���
+��� right) ��� trigger a commit if the right end of the pre��dit is ���
+��� ��� reached. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Move cursor to the right end of the pre��dit text. If ���
+��� Control+Right ��� the cursor is already at the right end of the pre��dit ���
+��� ��� text, trigger a commit and send a Control+Right to the ���
+��� ��� application. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Backspace ��� Remove the typed key to the left of the cursor in the ���
+��� ��� pre��dit text. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Control+Backspace ��� Remove everything to the left of the cursor in the ���
+��� ��� pre��dit text. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Delete ��� Remove the typed key 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. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� F1 ��� Commit the candidate with the label ���1��� followed by a
���
+��� ��� space ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� F2 ��� Commit the candidate with the label ���2��� followed by a
���
+��� ��� space ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ... ��� ... ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� F9 ��� Commit the candidate with the label ���9��� followed by a
���
+��� ��� space ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Remove the candidate with the label ���1��� from the
���
+��� Control+F1 ��� database of learned user input (If possible, if this ���
+��� ��� candidate is not learned from user input, nothing ���
+��� ��� happens). ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Remove the candidate with the label ���2��� from the
���
+��� Control+F2 ��� database of learned user input (If possible, if this ���
+��� ��� candidate is not learned from user input, nothing ���
+��� ��� happens). ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� ��� ���
���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Remove the candidate with the label ���9��� from the
���
+��� Control+F9 ��� database of learned user input (If possible, if this ���
+��� ��� candidate is not learned from user input, nothing ���
+��� ��� happens). ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� ��� Same as F1 ��� F9 if the option ���Use digits as select
���
+��� ��� keys��� is enabled. Enabling that option makes selecting ���
+��� ��� candidates a bit easier because the number keys 1 ��� 9 ���
+��� ��� are closer to the fingers then F1 ��� F9 on most ���
+��� ��� keyboards. On the other hand, it makes completing when ���
+��� 1 ��� 9 ��� typing numbers impossible and it makes typing strings ���
+��� ��� which are combinations of letters and numbers like ���A4���
���
+��� ��� more difficult. If digits are used as select keys, ���
+��� ��� numbers can only be typed when no candidate list is ���
+��� ��� shown. In most cases this means that numbers can only ���
+��� ��� be typed when nothing else has been typed yet and the ���
+��� ��� pre��dit is empty. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Control+1 ��� ��� Same as Control+F1 ��� Control+F9 if the option ���Use
���
+��� Control+9 ��� digits as select keys��� is enabled. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� AltGr+F12 ��� Show related emoji and Unicode symbols or related words ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� AltGr+Space ��� Insert a literal space into the pre��dit. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+
+
+When more than one input method at the same time is used, the following
+additional key bindings are available:
+
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Key ��� Effect ���
+��� combination ��� ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Control+Down ��� Switch input method used for the pre��dit to the next input ���
+��� ��� method ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Control+Up ��� Switch input method used for the pre��dit to the previous ���
+��� ��� input method. ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+
+
+
+Mouse bindings
+
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Mouse event ��� Effect ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Button 1 click on ��� Commit the candidate clicked on followed by a space ���
+��� a candidate ��� (Same as F1���F9). ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Control + Button ��� Remove clicked candidate from database of learned user ���
+��� 1 click on a ��� input (If possible, if this candidate is not learned ���
+��� candidate ��� from user input, nothing happens). ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������
+��� Button 3 click on ��� Show related emoji and Unicode symbols or related words ���
+��� a candidate ��� (Same as Alt+F12). ���
+���������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������