adjust templates and stuff

This commit is contained in:
Helium314 2024-06-29 15:08:18 +02:00
parent efd7d53ca1
commit cec47bf03d
7 changed files with 16 additions and 24 deletions

View file

@ -10,7 +10,10 @@ tl;dr:
* a single issue per topic
* reduce screenshot size
<!-- issue template below, please remove above text before submitting (and the template too if you think it's a good idea) -->
<!--
issue template below, please remove above text before submitting (and the template too if you think it's a good idea)
Please choose a meaningful title for your issue
-->
**Describe the bug**

View file

@ -10,7 +10,10 @@ tl;dr:
* a single issue per topic
* reduce screenshot size
<!-- issue template below, please remove above text before submitting (and the template too if you think it's a good idea) -->
<!--
issue template below, please remove above text before submitting (and the template too if you think it's a good idea)
Please choose a meaningful title for your issue
-->
**Is your feature request related to a problem? Please describe.**

View file

@ -9,4 +9,4 @@ tl;dr:
* a single issue per topic
* reduce screenshot size
<!-- please remove above text before submitting -->
<!-- please remove above text before submitting, and choose a meaningful title for your issue -->

View file

@ -1,16 +0,0 @@
---
name: Spell checker issue
about: Issue related to spell checker (this is the component that underlines mis-spelled words in red)
labels: "spell checker"
---
Please see the appropriate readme section for issue reporting guidelines: https://github.com/Helium314/HeliBoard?tab=readme-ov-file#reporting-issues
tl;dr:
* search for duplicates, also in closed issues
* a single issue per topic
* reduce screenshot size
Make sure you actually enabled HeliBoard spell checker. Usually it can be found in System Settings -> System -> Languages -> Advanced -> Spell Checker, but this may depend on Android version.
Note that the menu when tapping a word underlined in red is coming form the Android system and is not under control of HeliBoard.
<!-- please remove above text before submitting -->

View file

@ -1,4 +1,4 @@
See the contributing readme for more detailed guideline: https://github.com/Helium314/HeliBoard/blob/main/CONTRIBUTING.md
See the contributing readme for more detailed guideline, please understand and accept them: https://github.com/Helium314/HeliBoard/blob/main/CONTRIBUTING.md
tl;dr (you should still read the full list though):
* make sure it's wanted
* a single thing only
@ -13,4 +13,4 @@ Further
* If you add a keyboard layout, make sure you have read https://github.com/Helium314/HeliBoard/blob/main/layouts.md#adding-new-layouts--languages
* Please avoid force-pushing when doing changes. This way it's not possible which parts have changed since the previous state.
(please remove the template text before submitting the PR)
<!-- (please remove the text above before submitting the PR) -->

View file

@ -19,7 +19,7 @@ HeliBoard is a complex application, when contributing, you must take a step back
If your contribution contains code that is not your own, provide a link to the source.
- **Complies with the user privacy principle HeliBoard follows**.
(and please leave dependency upgrades to the maintainers, unless it's an actual security issue)
(and leave dependency upgrades to the maintainers, unless it's an actual security issue)
In addition to previous elements, HeliBoard must stick to [F-Droid inclusion guidelines](https://f-droid.org/docs/Inclusion_Policy/).
# Adding Layouts

View file

@ -9,20 +9,22 @@ Adding too many keys or too long texts will make the keyboard look awkward or br
There are some sanity checks when adding a layout to avoid such issues, but they do not cover all possible cases.
Further there is no check whether the layout actually contains characters of the selected language.
If you use an external glide typing library, you likely will have issues if your layout contains duplicate keys, or keys with text longer than a single letter.
If you use an external glide typing library, you likely will have issues if your layout contains duplicate keys, or keys with text longer than a single character.
If the layout has exactly 2 keys in the bottom row, these keys will replace comma and period keys. More exactly: the first key will replace the first functional key with `"groupId": 1` in the bottom row, and the second key with replace the first key with `"groupId": 2`.
## Simple format
* One key per line
* Key format: [label] [popup keys], all separated by space, e.g. `a 0 + *` will create a key with text `a`, and the keys `0`, `+`, and `*` on long press
* see [below](#labels) for information about special labels
* Two consecutive newlines mark beginning of a new row
## Json format
* Normal json layout with [lenient](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-builder/is-lenient.html) parsing, and ignoring lines starting with `//`.
* For anything else than small changes and copy/pasting text the in-app editor is unsuitable. A proper text editor (e.g. Kate or Notepad++) can significantly simplify work on json files.
* 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)
* Support is not 100% there yet, notably `kana_selector` and `char_width_selector` do not work.
* Lines _starting_ with `//` are ignored.
* 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 (please avoid contributing layout with unnecessary codes to HeliBoard)
* Note that not all _special codes_ (negative numbers) from FlorisBoard are supported