Total engine refactoring (#44)

* totally refactored the Languages, the Database and the IME module. New and more clear folder/package structure

* CharMap and LangHelper are no more

* removed many unused icons, translations and other resources

* deleted the old keymap samples

* Update user-manual.md

* Preferences are stored in Preferences, not in the database.

* removed some unclear and unused settings from the Preferences screen and the code.

* fixed issues with displaying the UI

* removed all non-English words and words with foreign spelling from the English dictionary

* 0 now works as it should in all modes.

* a more clear newline character in suggestions view

* last used input mode is now preserved and restored the next time

* removed the smiley and symbol dialogs

* capsMode -> textCase

* language names are no longer translated

* updated build instructions

* better use of threads for DB operations

* current text candidate is as long as the sequence, to make it more intuitive

* single characters are added to the end of the suggestion, when there are no more in the database

* Added ѝ to Bulgarian character map

* disabled adding words in a user-friendly manner

* when adding a new word is not possible, a toast message appears, for better user experience

* an error is logged when there are duplicate language IDs

* settings -> settings_legacy

* custom Logger class for easier debugging and no logcat flood in the Release version

* removed unnecessary single letters and invalid words from the dictionaries

* more translations cleanup; also corrected some weird translations

* upgraded gradle

docs/user-manual.md

@@ -4,42 +4,68 @@ TT9 is an IME (Input Method Editor) for Android devices with hardware keypad. It
 Source code and documentation are available on Github: [https://github.com/sspanak/tt9](https://github.com/sspanak/tt9).
 
 ## Initial Setup
-TODO: Initial config, loading a dictionary...
+In order to use Traditional T9, you need to enable it as an Android keyboard. To do so:
+
+- Go to Android Settings → System → Languages → Keyboards.
+- Add Traditional T9 IME.
+
+_The actual menu names may vary depending on your Android version and phone._
+
+### Enabling Predictive Mode
+With the default settings, it is only possible to type in 123 and ABC modes. In order to enable the Predictive mode, there are additional steps:
+
+- Open the [TT9 Configuration screen](#configuration-options).
+- Select the desired languages.
+- Load the dictionaries.
+
+_If you don't do the above, nothing will happen when you try to type in Predictive mode._
 
 ## Hotkeys
 #### D-pad Up (↑):
-Select previous word suggestion
+Select previous word suggestion.
 
 #### D-pad Down (↓):
-Select next word suggestion
+Select next word suggestion.
 
 #### Left Soft Key:
-Insert symbol or Add word depending on state and context. Add word only available in Predictive input mode.
+Open Traditional T9 Configuration screen.
 
 #### Right Soft Key:
-- **Short press:** Cycle input modes (Predictive → Abc → 123)
-- **Long press:** Bring up the TT9 preference screen
+Backspace.
 
-#### Star (\*):
-- **Short press:** Change case
-- **Long press:**
-    - When multiple languages are enabled: Change language
-    - When single language is enabled: Bring up smiley insert dialog
-    - Numeric mode: Insert a star
+#### 0 key
+- In 123 mode: type "0" or hold it to type "+".
+- In ABC mode: type secondary punctuation or hold to type "0".
+- In Predictive mode: type space or hold to type "0".
 
-#### Hash/Pound (#):
-- **Short press:** Space
-- **Long press:**
-    - New line
-    - Numeric mode: Insert hash/pound (#)
+#### 1 to 9 keys
+- In 123 mode: type the respective number.
+- In ABC and Predictive mode: type a letter/punctuation character or hold to type the respective number.
 
-#### Back (↩):
-- **Short Press when there is text:** Usually, "backspace". However, some applications, most notably Firefox and Spotify, forbid this action in their search fields. This is due to the fact Android allows applications to take over control of the physical keypad and redefine what buttons do. Unfortunately, nothing can be done in such cases, "Back" will function as the application authors intended, instead of as backspace.
-- **Short Press when there is no text:** System default, no special action (usually, go back)
-- **Long Press:** System default, no special action
+#### Text Mode Key (Hash/Pound/#):
+- **Short press:** Cycle input modes (abc → ABC → Predictive → 123)
+- **Short press while typing:** Change between UPPERCASE and lowercase.
+- **Long press:** Select the next language.
+- **Number-only fields:** Type a "#". Changing the mode is not possible in such fields.
+
+#### Other Actions Key (Star/✱):
+- **Short press:** Add a word to the dictionary.
+- **Long press:** Open Traditional T9 Preferences screen.
+
+#### Backspace Key (Back/↩):
+- Just deletes text.
+
+**Note:** "Back" key plays a somewhat special role in Android. This role needs to be preserved for your phone to remain usable. Have in mind the notes below:
+- **Short Press when there is no text**: Go back to the previous screen (the system default action).
+- **Short Press when there is text:** Some applications, most notably Firefox and Spotify, take full control of the "Back" key. This means, it may function as the application authors intended, instead of as backspace. In such cases, you could use the on-screen backspace instead. Unfortunately, nothing else could be done, because this is a restriction posed by Android.
+- **Long Press**: Whatever the system default action is (i.e. show running applications list).
 
 ## Configuration Options
-TODO...
+On the Configuration screen, you can choose your preferred languages, load a dictionary for Predictive mode or view this manual.
+
+To access it:
+- Start typing in a text field to wake up TT9.
+- Use the on-screen gear button or hold Other Actions Key.
 
 ## License
 - The source code, the logo image and the icons are licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
@@ -49,4 +75,4 @@ TODO...
 - "Negotiate" and "Vibrocentric" fonts are under [The Fontspring Desktop/Ebook Font End User License](desktop-ebook-EULA-1.8.txt)
 
 ## Privacy Policy
-Traditional T9 does not collect any information about you or about the way you are using using the application.
+Traditional T9 does not collect any information about you or about the way you are using using the application.