luckyimnotanigger/HeliBoard
1
0
Fork 0
mirror of https://github.com/Helium314/HeliBoard.git synced 2025-04-19 21:59:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readmes

Browse source
This commit is contained in:
Helium314 2024-03-11 19:08:40 +01:00
parent 3b8b44b34b
commit 1ffa4766af
2 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -24,16 +24,16 @@ Does not use internet permission, and thus is 100% offline.
* Customize keyboard themes (style, colors and background image) * Customize keyboard themes (style, colors and background image)
* can follow the system's day/night setting on Android 10+ (and on some versions of Android 9) * can follow the system's day/night setting on Android 10+ (and on some versions of Android 9)
* can follow dynamic colors for Android 12+ * can follow dynamic colors for Android 12+
* Customize keyboard [layouts](layouts.md) (only when disabling _use system languages_) * Customize keyboard [layouts](layouts.md) (only available when disabling _use system languages_)
* Multilingual typing * Multilingual typing
* Glide typing (_only with closed source library_) * Glide typing (_only with closed source library_ ☹️)
* library not included in the app, as there is no compatible open source library available * library not included in the app, as there is no compatible open source library available
* can be extracted from GApps packages ("_swypelibs_"), or downloaded [here](https://github.com/erkserkserks/openboard/tree/master/app/src/main/jniLibs) * can be extracted from GApps packages ("_swypelibs_"), or downloaded [here](https://github.com/erkserkserks/openboard/tree/master/app/src/main/jniLibs)
* if you are concerned about security implications of loading user-provides libraries, please use the _nouserlib_ build variant, which removes this option. If HeliBoard is installed as system app, and _swypelibs_ are available for the system, they will be used. * if you are concerned about security implications of loading user-provides libraries, please use the _nouserlib_ build variant, which removes this option. If HeliBoard is installed as system app, and _swypelibs_ are available for the system, they will be used.
* If the app is installed as a system app and _swypelibs_ are available, glide typing will be available independent of the version. * If the app is installed as a system app and _swypelibs_ are available, glide typing will be available independent of the version.
* Clipboard history * Clipboard history
* One-handed mode * One-handed mode
* Split keyboard (if the screen is large enough) * Split keyboard (only available if the screen is large enough)
* Number pad * Number pad
* Backup and restore your learned word / history data * Backup and restore your learned word / history data
@ -43,13 +43,14 @@ Does not use internet permission, and thus is 100% offline.
* __Cannot switch choose layout__: This is only possible when _use system languages_ is disabled. * __Cannot switch choose layout__: This is only possible when _use system languages_ is disabled.
* __No suggestions for some language__: Check [dictionaries repo](https://codeberg.org/Helium314/aosp-dictionaries) whether a dictionary is available. If there is one, download it and add it in the language settings for this language. * __No suggestions for some language__: Check [dictionaries repo](https://codeberg.org/Helium314/aosp-dictionaries) whether a dictionary is available. If there is one, download it and add it in the language settings for this language.
* __No suggestions in some app / text field__: This app respects the [no suggestions flag](https://developer.android.com/reference/android/text/InputType#TYPE_TEXT_FLAG_NO_SUGGESTIONS) set by some input fields, i.e. the developer does not want you to see suggestions here. Best do in issue report for that app if you think this behavior is wrong. Alternatively you can enable the _always show suggestions_ setting that overrides the _no suggestions_ flag. * __No suggestions in some app / text field__: This app respects the [no suggestions flag](https://developer.android.com/reference/android/text/InputType#TYPE_TEXT_FLAG_NO_SUGGESTIONS) set by some input fields, i.e. the developer does not want you to see suggestions here. Best do in issue report for that app if you think this behavior is wrong. Alternatively you can enable the _always show suggestions_ setting that overrides the _no suggestions_ flag.
* __Multilingual typing__: Enable in _Languages & Layouts_, select the main language and tap the `+` button next to _multilingual typing_ to add a language. Note that the selection is limited to languages with the same script as the main language, and to languages that have a dictionary (see above for how to add).
* __How to enable glide typing__: There is no glide typing built into this app, but you can load compatible libraries: Go to advanced settings -> _load gesture typing library_ and point to a file (setting not available in _nouserlib_ version). You can extract the file from GApps packages ("_swypelibs_"), or download one [here](https://github.com/erkserkserks/openboard/tree/master/app/src/main/jniLibs). Make sure to use the correct version (app will tell you in the dialog to load the library). * __How to enable glide typing__: There is no glide typing built into this app, but you can load compatible libraries: Go to advanced settings -> _load gesture typing library_ and point to a file (setting not available in _nouserlib_ version). You can extract the file from GApps packages ("_swypelibs_"), or download one [here](https://github.com/erkserkserks/openboard/tree/master/app/src/main/jniLibs). Make sure to use the correct version (app will tell you in the dialog to load the library).
* __Glide typing is not working after loading a library__: Possibly the download was corrupted, or you downloaded the wrong file. If you get a "_unknown file_" confirmation popup, it is likely you are not using the correct file (or you might be using a different version of the library). * __Glide typing is not working after loading a library__: Possibly the download was corrupted, or you downloaded the wrong file. If you get a "_unknown file_" confirmation popup, it is likely you are not using the correct file (or you might be using a different version of the library).
* __What is the _nouserlib_ version?__: The normal version (_release_) allows the user to provide a library for glide typing. Running code that isn't supplied with the app is _dynamic code loading_, which is a security risk. Android Studio warns about this: * __What is the _nouserlib_ version?__: The normal version (_release_) allows the user to provide a library for glide typing. Running code that isn't supplied with the app is _dynamic code loading_, which is a security risk. Android Studio warns about this:
> Dynamically loading code from locations other than the application's library directory or the Android platform's built-in library directories is dangerous, as there is an increased risk that the code could have been tampered with. Applications should use loadLibrary when possible, which provides increased assurance that libraries are loaded from one of these safer locations. Application developers should use the features of their development environment to place application native libraries into the lib directory of their compiled APKs. > Dynamically loading code from locations other than the application's library directory or the Android platform's built-in library directories is dangerous, as there is an increased risk that the code could have been tampered with. Applications should use loadLibrary when possible, which provides increased assurance that libraries are loaded from one of these safer locations. Application developers should use the features of their development environment to place application native libraries into the lib directory of their compiled APKs.
The app checks the SHA256 checksum of the library and warns the user if it doesn't match with known library versions. A mismatch indicates the library was modified, but may also occur if the user intentionally provides a different library than expected (e.g. a self-built variant). The app checks the SHA256 checksum of the library and warns the user if it doesn't match with known library versions. A mismatch indicates the library was modified, but may also occur if the user intentionally provides a different library than expected (e.g. a self-built variant).
* (_to be expanded_...) <!-- auto-correct? incognito always on? can't load library? --> * (_to be expanded_...)
## Hidden Functionality ## Hidden Functionality
Features that may go unnoticed, and further potentially useful information Features that may go unnoticed, and further potentially useful information
@ -72,7 +73,7 @@ Features that may go unnoticed, and further potentially useful information
* Long-press a suggestion in the suggestion strip twice to show the source dictionary. * 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. * 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. * 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. * When using multilingual typing, space bar will show an confidence value used for determining the currently used language.
* Suggestions will have some tiny numbers on top showing some internal score and source dictionary (can be disabled) * 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, some files and the main shared preferences file are 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 and layout files can be read before the device is unlocked, e.g. at boot. The files are usually located in `/data/user_de/0/<package_id>/`, though the location may depend on the device and Android version. * For users doing manual backups with root access: Starting at Android 7, some files and the main shared preferences file are 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 and layout files can be read before the device is unlocked, e.g. at boot. The files are usually located in `/data/user_de/0/<package_id>/`, though the location may depend on the device and Android version.
@ -86,11 +87,11 @@ 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/HeliBoard/issues). Please search open and closed issues. - **Does the issue already exist?** Make sure a similar issue has not been reported by browsing [existing issues](https://github.com/Helium314/HeliBoard/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 HeliBoard. - **Is the issue still relevant?** Make sure your issue is not already fixed in the latest version of HeliBoard.
- **Did you use the issue template?** It is important to make life of our kind contributors easier by avoiding issues that miss key information to their resolution. - **Did you use the issue template?** It is important to make life of our kind contributors easier by avoiding issues that miss key information to their resolution.
Note that issues that that ignore part of the issue template will likely get treated with very low priority, as often they are needlessly hard to read or understand (e.g. huge screenshots, or addressing multiple topics). Note that issues that that ignore part of the issue template will likely get treated with very low priority, as often they are needlessly hard to read or understand (e.g. huge screenshots, not providing a proper description, or addressing multiple topics).
## Translation ## Translation
Translations can be added using [Weblate](https://translate.codeberg.org/projects/heliboard/). You will need an account to update translations and add languages. Add the language you want to translate to in Languages -> Manage translated languages in the top menu bar. Translations can be added using [Weblate](https://translate.codeberg.org/projects/heliboard/). You will need an account to update translations and add languages. Add the language you want to translate to in Languages -> Manage translated languages in the top menu bar.
Updating translations in a PR will not be accepted, as it may cause conflicts with Weblate tranlations. Updating translations in a PR will not be accepted, as it may cause conflicts with Weblate translations.
## Dictionary Creation ## Dictionary Creation
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). 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).
@ -136,8 +137,7 @@ See make-dict-list tool [README](tools/make-dict-list/README.md).
Planned features and improvements Planned features and improvements
* Customizable functional key layout * Customizable functional key layout
* Will likely result in having the same functional key layout for alphabet and symbols layouts * Will likely result in having the same functional key layout for alphabet and symbols layouts
* Requires adjusting names and codes for compatibility with FlorisBoard layouts * Support for _alt_, _ctrl_, _meta_ and _fn_ (#479)
* Support for "special keys" like _alt_ and _ctrl_ (#479)
* Less complicated addition of languages (e.g. #519) * Less complicated addition of languages (e.g. #519)
* Additional and customizable key swipe functionality * Additional and customizable key swipe functionality
* Some functionality will not be possible when using glide typing * Some functionality will not be possible when using glide typing

2
layouts.md
View file

@ -23,8 +23,10 @@ If you want different key label and use text, set the label to [label]|[text], e
## Json format ## Json format
* Allows more flexibility than the simple format, e.g. changing keys depending on input type, shift state or layout direction * Allows more flexibility than the simple format, e.g. changing keys depending on input type, shift state or layout direction
* You can use character layouts from [FlorisBoard](https://github.com/florisboard/florisboard/blob/master/CONTRIBUTING.md#adding-the-layout) * You can use character layouts from [FlorisBoard](https://github.com/florisboard/florisboard/blob/master/CONTRIBUTING.md#adding-the-layout)
* Support is not 100% there yet, notably `kana_selector` and `char_width_selector` do not work.
* There is no need for specifying a code, it will be determined from the label automatically * There is no need for specifying a code, it will be determined from the label automatically
* You can still specify it, but it's only necessary if you want key label and code to be different * You can still specify it, but it's only necessary if you want key label and code to be different
* Note that not all _special codes_ (negative numbers) from FlorisBoard are supported
* You can add the numeric value of 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. * You can add the numeric value of 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. * 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.