Skip to content

Commit

Permalink
documentation update + version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
sspanak committed Jul 21, 2024
1 parent cc6d659 commit 00680e8
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ _Storage usage for the dictionaries depends on the word root count and the avera
### ⚠️ Compatibility
If you own a phone with Android 2.2 up to 4.4, please refer to the original version of Traditional T9 from 2016.

TT9 may not work well on Kyocera phones, especially ones running Android 10 or newer, and some other devices that run highly customized Android versions, where all apps are integrated and intended to work with the respective native keyboard. You may experience missing functionality or unexpected text/numbers appearing when you try to type.
TT9 may not work well on TCL Flip 2, Kyocera phones, especially ones running Android 10 or newer, and some other devices that run highly customized Android versions, where all apps are integrated and intended to work with the respective native keyboard. You may experience missing functionality, empty gaps/misaligned items on the screen, or unexpected text/numbers appearing when you try to type.

Compatibility has been verified only on the following devices:
- Unihertz Atom L (Android 11)
Expand All @@ -67,11 +67,11 @@ As with many other open-source projects, this one is also maintained by its auth
Your PRs are welcome!

## 👍 Support
If you like Traditional T9, you could donate on [buymeacoffee.com](https://www.buymeacoffee.com/sspanak).
If you like Traditional T9, you could donate on [buymeacoffee.com](https://www.buymeacoffee.com/sspanak). So far, your donations have bought a Sonim XP3800 phone and helped fix numerous Sonim-specific problems.

Or if you just want to show your appreciation, give the project a star. Higher-ranked projects on GitHub have the opportunity to use development tools for free and apply for funding more easily.
If you own another device that does not run TT9 smoothly, you can fund the purchase of one. Just leave a comment you are donating to support the purchase of a testing device. Here is how much some of the most popular phones cost: a TCL Flip 2 + delivery is about 50 USD; Kyocera Dura XV Extreme is around 180 USD.

Thanks to your donations, a brand new testing device is available, a Sonim XP3800! This will result in much better compatibility with Sonim in the future. So, keep going!
Or if you just want to show your appreciation, give the project a star. Higher-ranked projects on GitHub have the opportunity to use development tools for free and apply for funding more easily.

## 🕮 License
- The source code, the logo image, and the icons are licensed under the conditions described in [LICENSE.txt](LICENSE.txt).
Expand Down
4 changes: 2 additions & 2 deletions app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:tools="http://schemas.android.com/tools"
android:versionCode="609"
android:versionName="35.10"
android:versionCode="612"
android:versionName="36.0"
xmlns:android="http://schemas.android.com/apk/res/android">

<uses-permission android:name="android.permission.POST_NOTIFICATIONS"/> <!-- allows displaying notifications on Android >= 13 -->
Expand Down
23 changes: 20 additions & 3 deletions docs/user-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,11 @@ Below is a list of the possible commands:
- **Show the Settings Screen (Default Combo: ✱, 1-key).** On the Settings screen, you can choose languages for typing, configure the keypad hotkeys, change the application appearance, or improve compatibility with your phone.
- **Add a Word (Default Combo: ✱, 2-key).** Add a new word to the dictionary for the current language. You can also add new emojis and then access them by pressing 1-1-3. Regardless of the currently selected language, all emojis will be available in all languages.
- **Voice Input (Default Combo: ✱, 3-key).** Activate the voice input on the phones that support it. See [below](#voice-input) for more info.
- **Select a Different Keyboard (Default Combo: ✱, 0-key).** Open the Android Change Keyboard dialog allowing you to select between all installed keyboards.
- **Text Editing (Default Combo: ✱, 5-key).** Show the text editing panel, which allows you to select, cut, copy, and paste text. You can close the panel by pressing the "✱" key again or, in most applications, by pressing the Back button. Details are available [below](#text-editing).
- **Select a Different Keyboard (Default Combo: ✱, 8-key).** Open the Android Change Keyboard dialog allowing you to select between all installed keyboards.

_This key does not do anything when the Screen Layout is set to "Virtual Keyboard" because all keys for all possible functions are already available on the screen._

If you do have a hardware keypad and prefer having more screen space, disable the software keys from the Settings → Appearance.

## Voice Input
The voice input function allows for speech-to-text input, similar to Gboard. Like all other keyboards, Traditional T9 does not perform speech recognition by itself, but it asks your phone to do it.

Expand All @@ -142,6 +141,8 @@ Other phones without Google will generally not support voice input. Chinese phon
## On-screen Keypad
On touchscreen-only phones, a fully functional on-screen keypad is available and it will be enabled automatically. If, for some reason, your phone was not detected to have a touchscreen, enable it by going to Settings → Appearance → On-Screen Layout, and selecting "Virtual Numpad".

If you do have both a touchscreen and a hardware keypad and prefer having more screen space, disable the software keys from Settings → Appearance.

It is also recommended to disable the special behavior of the "Back" key working as "Backspace". It is useful only for a hardware keypad. Usually, it will happen automatically too, but if it does not, go to Settings → Keypad → Select Hotkeys → Backspace key, then select the "--" option.

### Resizing the Keyboard Panel While Typing
Expand All @@ -156,6 +157,22 @@ The default setting of 100% is a good balance between usable button size and scr

_If the available screen space is limited, TT9 will ignore this setting and reduce its height automatically, to leave enough room for the current application._

## Text Editing
From the Text Editing panel, you can select, cut, copy, and paste text, similar to what is possible with a computer keyboard. To exit Text Editing, press the "✱" key, or the Back key (except in web browsers, Spotify, and a few more applications). Or press the letters key on the On-screen Keyboard.

Below is a list of the possible text commands:
1. Select the previous character (like Shift+Left on a computer keyboard)
2. Select none
3. Select the next character (like Shift+Right)
4. Select the previous word (like Ctrl+Shift+Left)
5. Select all
6. Select the next word (like Ctrl+Shift+Right)
7. Cut
8. Copy
9. Paste

For easier editing, backspace, space, and OK keys are also active.

## Settings Screen
On the Settings screen, you can choose languages for typing, configure the keypad hotkeys, change the application appearance, or improve compatibility with your phone.

Expand Down

0 comments on commit 00680e8

Please sign in to comment.