mirror of
https://github.com/Helium314/HeliBoard.git
synced 2025-04-16 04:12:02 +00:00
update readme and layout info
This commit is contained in:
Helium314
parent
bd534bf5c0
commit
93dfecfe9e
2 changed files with 33 additions and 135 deletions
153
README.md
153
README.md
|
|
@ -1,14 +1,11 @@
|
|||
# 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](https://github.com/Helium314/openboard/labels/when%20ready) 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
|
||||
|
|
@ -19,7 +16,7 @@ So what comes next:
|
|||
* can be extracted from GApps packages (_swypelibs_), or downloaded [here](https://github.com/erkserkserks/openboard/tree/master/app/src/main/jniLibs)
|
||||
* Multilingual typing
|
||||
* Load external dictionaries
|
||||
* get them [here]( https://codeberg.org/Helium314/aosp-dictionaries#dictionaries), or in the [experimental](https://codeberg.org/Helium314/aosp-dictionaries#experimental-dictionaries) section (quality may vary)
|
||||
* get them [here](https://codeberg.org/Helium314/aosp-dictionaries#dictionaries), or in the [experimental](https://codeberg.org/Helium314/aosp-dictionaries#experimental-dictionaries) 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](https://github.com/openboard-team/openboard/commit/83fca9533c03b9fecc009fc632577226bbd6301f), the tools in the dictionary repository are not able to create working dictionaries
|
||||
|
|
@ -30,7 +27,7 @@ So what comes next:
|
|||
* Number pad
|
||||
* Show all available extra characters on long pressing a key
|
||||
* Backup your learned word / history data
|
||||
* Add custom keyboard layouts
|
||||
* Add custom keyboard [layouts](layouts.md)
|
||||
* Adjustable bottom padding
|
||||
|
||||
## Hidden functionality
|
||||
|
|
@ -57,119 +54,23 @@ Features that may go unnoticed, and further potentially useful information
|
|||
* 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](https://developer.android.com/reference/android/content/Context#createDeviceProtectedStorageContext()). 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](https://github.com/Helium314/openboard/issues?q=is%3Aopen+is%3Aissue+label%3Abug) 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 https://github.com/openboard-team/openboard/pull/569 and https://github.com/openboard-team/openboard/pull/578
|
||||
* some AOSP dictionaries are available [here](https://codeberg.org/Helium314/aosp-dictionaries/src/branch/main/dictionaries)
|
||||
* experimental dictionaries with next-word suggestions created from sentence lists [are also available](https://codeberg.org/Helium314/aosp-dictionaries/src/branch/main/dictionaries_experimental), 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, https://github.com/openboard-team/openboard/pull/576
|
||||
* Add multi-lingual typing, slightly modified from https://github.com/openboard-team/openboard/pull/586, https://github.com/openboard-team/openboard/pull/593
|
||||
* Allow loading an external library to enable gesture typing, https://github.com/openboard-team/openboard/issues/3
|
||||
* based on [wordmage's work](https://github.com/openboard-team/openboard/tree/57d33791d7674e3fe0600eddb72f6b4317b5df00)
|
||||
* tested with [Google libraries](https://github.com/erkserkserks/openboard/tree/master/app/src/main/jniLibs) and [others](https://github.com/openboard-team/openboard/issues/3#issuecomment-1200456262) (when building with the [rename](https://github.com/openboard-team/openboard/tree/57d33791d7674e3fe0600eddb72f6b4317b5df00))
|
||||
* Theming: allow adjusting keyboard colors, https://github.com/openboard-team/openboard/issues/124
|
||||
* Optionally make the navigation bar follow current theme, https://github.com/Helium314/openboard/issues/4
|
||||
* Allow defining day/night themes
|
||||
* Remove suggestions by long pressing on suggestion strip while the more suggestions popup is open, https://github.com/openboard-team/openboard/issues/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), https://github.com/Helium314/openboard/issues/22
|
||||
* Add Unicode 15 emojis, https://github.com/Helium314/openboard/pull/25
|
||||
* Better currency selection, https://github.com/Helium314/openboard/pull/21 / https://github.com/Helium314/openboard/commit/0d1106649f95ecbd7d8f6d950428547666059564
|
||||
* Reduce space between keys, with option to use old values, https://github.com/Helium314/openboard/pull/8
|
||||
* Fix number row not split in split keyboard view, https://github.com/Helium314/openboard/pull/27
|
||||
* Fix issue with spell checker incorrectly flagging words before a period as wrong on newer Android versions, https://github.com/openboard-team/openboard/pull/679
|
||||
* maybe not properly fixed, this causes some other issues, https://github.com/Helium314/openboard/issues/55
|
||||
* Fix always-dark settings on some Android versions, https://github.com/Helium314/openboard/pull/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](https://github.com/florisboard/florisboard/tree/master/app/src/main/assets/ime/keyboard/org.florisboard.layouts/layouts)
|
||||
|
||||
-----
|
||||
# readme for original version of OpenBoard below
|
||||
-----
|
||||
<h1 align="center"><b>OpenBoard</b></h1>
|
||||
<h4 align="center">100% FOSS keyboard, based on AOSP.</h4>
|
||||
<p align="center"><img src='fastlane/metadata/android/en-US/images/icon.png' height='128'></p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/openboard-team/openboard/actions/workflows/android-build.yml"><img src="https://img.shields.io/github/workflow/status/openboard-team/openboard/Build" alt="GitHub Workflow Status"></a>
|
||||
<a href="https://hosted.weblate.org/engage/openboard/"><img src="https://hosted.weblate.org/widgets/openboard/-/openboard/svg-badge.svg" alt="Translation status"></a>
|
||||
<a href="https://matrix.to/#/#openboard:matrix.org?via=matrix.org"><img src="https://img.shields.io/matrix/openboard:matrix.org" alt="Matrix"></a></p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/openboard-team/openboard/releases"><img src="https://img.shields.io/github/v/release/openboard-team/openboard" alt="GitHub release (latest by date)"></a>
|
||||
<a href="https://f-droid.org/packages/org.dslul.openboard.inputmethod.latin"><img alt="F-Droid Version" src="https://img.shields.io/f-droid/v/org.dslul.openboard.inputmethod.latin?color=green&logo=f-droid"></a>
|
||||
<a href="https://play.google.com/store/apps/details?id=org.dslul.openboard.inputmethod.latin"><img alt="Google Play Version" src="https://img.shields.io/endpoint?logo=google-play&url=https%3A%2F%2Fplayshields.herokuapp.com%2Fplay%3Fi%3Dorg.dslul.openboard.inputmethod.latin%26l%3Dgoogle-play%26m%3D%24version"></a>
|
||||
<a href="https://github.com/openboard-team/openboard/releases"><img src="https://img.shields.io/github/release-date/openboard-team/openboard" alt="GitHub Release Date"></a>
|
||||
<a href="https://github.com/openboard-team/openboard/commits/master"><img src="https://img.shields.io/github/commits-since/openboard-team/openboard/latest" alt="GitHub commits since latest release (by date)"></a></p>
|
||||
<p align="center">
|
||||
<a href='https://f-droid.org/packages/org.dslul.openboard.inputmethod.latin'><img src='https://fdroid.gitlab.io/artwork/badge/get-it-on.png' alt='Get it on F-Droid' height='60'></a>
|
||||
<a href='https://play.google.com/store/apps/details?id=org.dslul.openboard.inputmethod.latin&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' height='60'/></a></p>
|
||||
|
||||
# Table of content
|
||||
|
||||
- [Community](#community)
|
||||
- [Contribution ❤](#contribution-)
|
||||
* [Issue reporting](#issue-reporting)
|
||||
* [Translation](#translation)
|
||||
* [Dictionary creation](#dictionary-creation)
|
||||
* [Code contribution](#code-contribution)
|
||||
+ [Getting started](#getting-started)
|
||||
+ [Guidelines](#guidelines)
|
||||
+ [Current TODO list](#current-todo-list)
|
||||
+ [Project's side tools](#tooling)
|
||||
- [License](#license)
|
||||
- [Credits](#credits)
|
||||
|
||||
# Community
|
||||
Join our [matrix] channel [here](https://matrix.to/#/#openboard:matrix.org?via=matrix.org).
|
||||
|
||||
<img src="images/matrix_qr.png" alt="Matrix QR Code" height="128">
|
||||
|
||||
# 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](https://github.com/openboard-team/openboard/issues). Your help is always welcomed !
|
||||
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](https://github.com/openboard-team/openboard/issues). Your help is always welcome!
|
||||
|
||||
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](https://github.com/openboard-team/openboard/issues).
|
||||
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](https://github.com/Helium314/openboard/issues). Please search open and closed 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](https://github.com/openboard-team/openboard/issues/619#issuecomment-1179534276) from issue [#619](https://github.com/openboard-team/openboard/issues/619).*
|
||||
|
||||
## Translation
|
||||
You can help in translating OpenBoard in your language through our [Weblate project](https://hosted.weblate.org/engage/openboard/).
|
||||
|
||||
[](https://hosted.weblate.org/engage/openboard/)
|
||||
Currently there is no simple way of translating the app, but it's coming soon...
|
||||
|
||||
## Dictionary creation
|
||||
To create or update a dictionary for your language, you can use [this tool](https://github.com/remi0s/aosp-dictionary-tools). You will need a wordlist, as described [here](dictionaries/sample.combined). The output .dict file must be put in [res/raw](app/src/main/res/raw), and its wordlist in [dictionaries](/dictionaries).
|
||||
|
||||
For your dictionary to be merged into OpenBoard, **you must provide the wordlist you used**, as well as its license if any.
|
||||
There will not be any further dictionaries bundled in this app. However, you can add dictionaries to the [dictionaries repository](https://codeberg.org/Helium314/aosp-dictionaries).
|
||||
To create or update a dictionary for your language, you can use [this tool](https://github.com/remi0s/aosp-dictionary-tools). You will need a wordlist, as described [here](https://codeberg.org/Helium314/aosp-dictionaries/src/branch/main/wordlists/sample.combined) and in the repository readme.
|
||||
|
||||
## Code contribution
|
||||
|
||||
|
|
@ -189,48 +90,30 @@ OpenBoard is a complex application, when contributing, you must take a step back
|
|||
|
||||
In addition to previous elements, OpenBoard must stick to [F-Droid inclusion guidelines](https://f-droid.org/docs/Inclusion_Policy/).
|
||||
|
||||
### Current TODO list
|
||||
In no particular order, here is the non-exhaustive list of known wanted features :
|
||||
- [x] ~~Updated emoji support~~
|
||||
- [ ] MaterialYou ([M3](https://m3.material.io/)) support
|
||||
- [x] ~~One-handed mode feature~~
|
||||
- [ ] Android [autofill](https://developer.android.com/guide/topics/text/ime-autofill) support
|
||||
- [x] ~~Clipboard history feature~~
|
||||
- [ ] Text navigation/selection panel
|
||||
- [ ] Multi-locale typing
|
||||
- [ ] Emoji search
|
||||
- [ ] Emoji variant saving
|
||||
- [ ] Glide typing
|
||||
### Adding layouts
|
||||
|
||||
### Tooling
|
||||
See [layouts.md](layouts.md) for how to add new layouts to the app.
|
||||
|
||||
#### 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](app/src/main/java/org/dslul/openboard/inputmethod/keyboard/internal/KeyboardTextsTable.java) file.
|
||||
To do so :
|
||||
1. Make your modifications in [tools/make-keyboard-text/src/main/resources](tools/make-keyboard-text/src/main/resources)/values-YOUR LOCALE.
|
||||
2. Generate the new version of [KeyboardTextsTable.java](app/src/main/java/org/dslul/openboard/inputmethod/keyboard/internal/KeyboardTextsTable.java) by running Gradle task 'makeText' :
|
||||
```sh
|
||||
./gradlew tools:make-keyboard-text:makeText
|
||||
```
|
||||
|
||||
#### Update emojis
|
||||
### Update emojis
|
||||
|
||||
See make-emoji-keys tool [README](tools/make-emoji-keys/README.md).
|
||||
|
||||
# License
|
||||
|
||||
OpenBoard project is licensed under GNU General Public License v3.0.
|
||||
OpenBoard (and this yet unnamed fork) 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](/LICENSE) file.
|
||||
See repo's [LICENSE](/LICENSE-GPL-3) file.
|
||||
|
||||
Since the app is based on Apache 2.0 licensed AOSP Keyboard, an [Apache 2.0](LICENSE-Apache-2.0) license file is provided too.
|
||||
|
||||
# Credits
|
||||
- Icon by [Marco TLS](https://www.marcotls.eu)
|
||||
- [OpenBoard](https://github.com/openboard-team/openboard)
|
||||
- [AOSP Keyboard](https://android.googlesource.com/platform/packages/inputmethods/LatinIME/)
|
||||
- [LineageOS](https://review.lineageos.org/admin/repos/LineageOS/android_packages_inputmethods_LatinIME)
|
||||
- [Simple Keyboard](https://github.com/rkkr/simple-keyboard)
|
||||
- [Indic Keyboard](https://gitlab.com/indicproject/indic-keyboard)
|
||||
- Our [contributors](https://github.com/openboard-team/openboard/graphs/contributors)
|
||||
- [FlorisBoard](https://github.com/florisboard/florisboard/)
|
||||
- Our [contributors](https://github.com/Helium314/openboard/graphs/contributors)
|
||||
|
|
|
|||
15
layouts.md
15
layouts.md
|
|
@ -24,3 +24,18 @@ One special label that might be wanted though is `$$$`, which will be replaced b
|
|||
* There is no need for specifying a code, it will be determined from the label automatically
|
||||
* Specify it if you want key label and code to be different
|
||||
* You can add a _labelFlag_ to a key for some specific effects, see [here](app/src/main/res/values/attrs.xml) in the section _keyLabelFlags_ for names and numeric values
|
||||
* More details on the formal will be provided. For now you can check other layouts, often you just need to copy lines and change the labels.
|
||||
|
||||
## Adding new layouts / languages
|
||||
* You need a layout file in one of the formats above, and add it to [layouts](app/src/main/assets/layouts)
|
||||
* Add a layout entry to [method.xml](app/src/main/res/xml/method.xml)
|
||||
* `KeyboardLayoutSet` must be set to the name of your layout file (without file ending)
|
||||
* If you add a layout to an existing language, add a string with the layout name to use instead of `subtype_generic`. `%s` will be replaced with the language
|
||||
* If you add a new language, you might want to provide a [language_key_texts](/app/src/main/assets/language_key_texts) file
|
||||
* `[morekeys]` section contains popup keys that are similar to the letter (like `a` and `ä` or `य` and `य़`)
|
||||
* Such forms should _not_ be in the layout. They will apply to all layouts of that language, even custom ones
|
||||
* Use `%` to mark all preceding keys as "important" (ses the popup key order setting)
|
||||
* The `punctuation` key is typically the period key. `morekeys` set here override the default.
|
||||
* `[labels]` may contain non-default labels for the following keys `symbol`, `alphabet`, `shift_symbol`, `shift_symbol_tablet`, `comma`, `period`, `question`
|
||||
* `[number_row]` may contain a custom number row (1-9 and 0 separated by space). You should also add the language to `numberRowLocales` in [`PreferencesSettingsFragment`](app/src/main/java/org/dslul/openboard/inputmethod/latin/settings/PreferencesSettingsFragment.java) so the user can opt into having a localized number row.
|
||||
* `[extra_keys]` are typically keys shown in the default layout of the language. This is currently only used for latin layouts to avoid duplicating layouts for just adding few keys on the right side. The layout name need to end with `+`, but the `+` is removed when looking up the actual layout.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue