OpenBoard upgrade, WIP

This is mostly a development version. On updates there may be changes that reset some settings. Consider all releases as beta quality at best and always have another keyboard installed in case of really bad bugs.

Plan for actual release

The plans for major changes are completed, and most features appear to be stable enough for a proper release. So what comes next:

Work on issues with the when ready label
Rename app, package and this repository
New icon
Drop support for Android 4.4?
Use a translation tool (probably weblate)
Release on F-Droid
Maybe add a version that does not allow providing a glide typing library, for people concerned about security

Features

Allow loading Glide typing library
- not included in the app, as there is no compatible open source library
- can be extracted from GApps packages (swypelibs), or downloaded here
Multilingual typing
Load external dictionaries
- get them here, or in the experimental section (quality may vary)
- add them in language settings (click on the language, then on + next to dictionary), or open the file in a file explorer
- additional dictionaries for emojis or scientific symbols can be used to provide suggestions ("emoji search")
- note that for Korean layouts, suggestions only work using this dictionary, the tools in the dictionary repository are not able to create working dictionaries
Adjust keyboard themes (style and colors)
- can follow the system's day/night setting on Android 10+ (and on some versions of Android 9)
Split keyboard (if the screen is large enough)
Number row
Number pad
Show all available extra characters on long pressing a key
Backup your learned word / history data
Add custom keyboard layouts
Adjustable bottom padding

Hidden functionality

Features that may go unnoticed, and further potentially useful information

Long-pressing the Clipboard Key (the optional one in the suggestion strip) pastes system clipboard contents.
Long-pressing keys in the suggestion strip toolbar pins them to the suggestion strip.
Long-press the Comma-key to access Clipboard View, Emoji View, One-handed Mode, Settings, or Switch Language:
- Emoji View and Language Switch will disappear if you have the corresponding key enabled;
- For some layouts it's not the Comma-key, but the key at the same position (e.g. it's q for Dvorak layout).
When incognito mode is enabled, no words will be learned, and no emojis will be added to recents.
Sliding key input: Swipe from shift to another key to type a single uppercase key:
- This also works for the ?123 key to type a single symbol from the symbols keyboard, and for related keys.
Long-press a suggestion in the suggestion strip to show more suggestions, and a delete button to remove this suggestion.
Swipe up from a suggestion to open more suggestions, and release on the suggestion to select it.
Long-press an entry in the clipboard history to pin it (keep it in clipboard until you unpin).
Swipe left in clipboard view to remove an entry (except when it's pinned)
You can add dictionaries by opening them in a file explorer:
- This only works with content-uris and not with file-uris, meaning that it may not work with some file explorers.
When using debug mode / debug APK
- Long-press a suggestion in the suggestion strip twice to show the source dictionary.
- When using debug APK, you can find Debug Settings within the Advanced Preferences, though the usefulness is limited except for dumping dictionaries into the log.
- In the event of an application crash, you will be prompted whether you want the crash logs when you open the Settings.
- When using multilingual typing, space bar will show an confidence value used for determining the currenly used language.
- Suggestions will have some tiny numbers on top showing some internal score and source dictionary (can be disabled)
For users doing manual backups with root access: Starting at Android 7, the shared preferences file is not in the default location, because the app is using device protected storage. This is necessary so the settings can be read before the device is unlocked, e.g. at boot. The file is located in /data/user_de/0/package_id/shared_prefs/, though this may depend on the device and Android version.

Ideas for further improvements

More customizable theming
Improved / less bad suggestions in some specific situations
Sliding key input for toolbar and emojis (like ?123 and shift sliding input)
More tunable behavior, e.g for delete and spacebar swipe, for toolbar, for spell checker,...
Adjust arrangement of settings, maybe hide settings irrelevant for most users behind some "more settings mode"
Migrate to internally use language tags (problematic due to lack of support on older Android versions)
Support providing background images (for keyboard, and possibly also for keys)
and general bug fixing

Important differences and changes to OpenBoard

Debug version can be installed along OpenBoard
Allow users to add and replace built-in dictionaries
- modified / improved from openboard-team#569 and openboard-team#578
- some AOSP dictionaries are available here
  - experimental dictionaries with next-word suggestions created from sentence lists are also available, but they may contain unwanted words, and may be missing other features
- dictionary files starting with "main_" replace the built-in dictionary for the language, all other names work as add-on dictionaries
- emoji dictionaries can be used to get emoji suggestions
Fixes / improvements regarding suggestions
- Remove suggestions by long pressing on suggestion strip while the more suggestions popup is open (suggestions get re-added if they are entered again)
- Allow using contacts for suggestions
- several small adjustments and fixes
Reduce amount of unwanted automatic space insertions, openboard-team#576
Add multi-lingual typing, slightly modified from openboard-team#586, openboard-team#593
Allow loading an external library to enable gesture typing, openboard-team#3
- based on wordmage's work
- tested with Google libraries and others (when building with the rename)
Theming: allow adjusting keyboard colors, openboard-team#124
- Optionally make the navigation bar follow current theme, #4
- Allow defining day/night themes
Remove suggestions by long pressing on suggestion strip while the more suggestions popup is open, openboard-team#106
- suggestions get re-added if they are entered again
Optionally add typed words to system personal dictionary
Improve issues with emoji deletion (still happens with delete gesture), #22
Add Unicode 15 emojis, #25
Better currency selection, #21 / https://github.com/Helium314/openboard/commit/0d1106649f95ecbd7d8f6d950428547666059564
Reduce space between keys, with option to use old values, #8
Fix number row not split in split keyboard view, #27
Fix issue with spell checker incorrectly flagging words before a period as wrong on newer Android versions, openboard-team#679
- maybe not properly fixed, this causes some other issues, #55
Fix always-dark settings on some Android versions, #69
Fix bug with space before word being deleted in some apps / input fields, https://github.com/Helium314/openboard/commit/ce0bf06545c4547d3fc5791cc769508db0a89e87
Allow using auto theme on some devices with Android 9
Add number pad
Overhauled language settings
Updated translations
Open dictionary files with the app
Add more options to the language switch key
New keyboard parser (no need to use tools:make-keyboard-text:makeText any more)
- Can use simple text files or JSON files as used by FlorisBoard

readme for original version of OpenBoard below

OpenBoard

100% FOSS keyboard, based on AOSP.

Table of content

Community
Contribution ❤
License
Credits

Community

Join our [matrix] channel here.

Contribution ❤

Issue reporting

Whether you encountered a bug, or want to see a new feature in OpenBoard, you can contribute to the project by opening a new issue here. Your help is always welcomed !

Before opening a new issue, be sure to check the following :

Does the issue already exist ? Make sure a similar issue has not been reported by browsing existing issues.
Is the issue still relevant ? Make sure your issue is not already fixed in the latest version of OpenBoard.
Did you use the issue template ? It is important to make life of our kind contributors easier by avoiding issues that miss key informations to their resolution.

Please avoid opening issues to ask for a release date, for PR reviews/merges, for more activity on the project, or worth for more contributors. If you have any interrogations on these topics, read this comment from issue #619.

Translation

You can help in translating OpenBoard in your language through our Weblate project.

Dictionary creation

To create or update a dictionary for your language, you can use this tool. You will need a wordlist, as described here. The output .dict file must be put in res/raw, and its wordlist in dictionaries.

For your dictionary to be merged into OpenBoard, you must provide the wordlist you used, as well as its license if any.

Code contribution

Getting started

OpenBoard project is based on Gradle and Android Gradle Plugin. To get started, you'll just need to install Android Studio, and import project 'from Version Control / Git / Github' by providing this git repository URL (or git SSH URL).

Once everything got setted up correctly, you're ready to go !

Guidelines

OpenBoard is a complex application, when contributing, you must take a step back and make sure your contribution :

Uses already in-place mechanism and take advantage of them. In other terms, does not reinvent the wheel or uses shortcuts that could alter the consistency of the existing code.
Has the lowest footprint possible. OpenBoard code has been written by android experts (AOSP/Google engineers). It has been tested and runned on millions of devices. Thus, existing code will always be safer than new code. The less we alter existing code, the more OpenBoard will stay stable. Especially in the input logic scope.
Does not bring any non-free code or proprietary binary blobs. This also applies to code/binaries with unknown licenses. Make sure you do not introduce any closed-source library from Google.
Complies with the user privacy principle OpenBoard follows.

In addition to previous elements, OpenBoard must stick to F-Droid inclusion guidelines.

Current TODO list

In no particular order, here is the non-exhaustive list of known wanted features :

Tooling

Edit keyboards content

Keyboards content is often a complex concatenation of data from global to specific locales. For example, additional keys of a given key, also known as 'more keys' in code, are determined by concatenating infos from : common additional keys for a layout (eg. numbers), global locale (eg. common symbols) and specific locale (eg. accents or specific letters).

To edit these infos, you'll need to generate the KeyboardTextsTable.java file. To do so :

Make your modifications in tools/make-keyboard-text/src/main/resources/values-YOUR LOCALE.
Generate the new version of KeyboardTextsTable.java by running Gradle task 'makeText' :
```
./gradlew tools:make-keyboard-text:makeText
```

Update emojis

See make-emoji-keys tool README.

License

OpenBoard project is licensed under GNU General Public License v3.0.

Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.

See repo's LICENSE file.

Helium314/openboard