n/futokb
1
0
Fork 0
mirror of https://gitlab.futo.org/keyboard/latinime.git synced 2024-09-28 14:54:30 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add README for make-keyboard-text-py

Browse Source
This commit is contained in:
Aleksandras Kostarevas 2024-07-24 21:32:49 +03:00
parent 68f7f4251a
commit db82511d92
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
tools/make-keyboard-text-py/README.md Normal file
View File

@ -0,0 +1,21 @@
# make-keyboard-text-py
Keyboard texts define language-specific key specifications, morekeys, etc.
For example, they allow a language to have a custom comma symbol, or custom parentheses, without needing
special cases in the keyboard layout definitions.
## Definitions
These are defined in json files located in the locales directory. There are a few predefined keys that act as prefixes.
For example, `morekeys.a` automatically becomes `!text/morekeys_a`. Items in the `other` key are prefix-less.
In morekeys, values can be arrays that are automatically joined by commas.
In general, morekeys for a specific letter such as "a" for a specific language should contain letters required to type in that language.
Other general morekeys can be placed in the "misc_a", and the user has the option to disable these extra letters.
## Updating
After updating a json file it's necessary to run the `src/generate.py` script to update the corresponding java file.
This script must be run in the `make-keyboard-text-py` directory by running `python3 src/generate.py`.
It is dependent on relative paths and it's necessary to be in the `make-keyboard-text-py` directory.