add overview over the different layouts

Helium314 2025-01-11 18:13:25 +01:00
parent 0a86465d64
commit 178c25ad3b

@ -2,6 +2,20 @@
See https://github.com/Helium314/HeliBoard/wiki/Customization#layouts.
# What layouts exist in HeliBoard?
HeliBoard has a bunch of different layout files for different parts of the keyboard, and for different input fields. As of HeliBoard 2.3 these are:
- The "**main**" layout which you can select in the _Languages & Layouts_ section. For custom layouts, click the `+` button next to _Layouts_ after selecting a language.
- The "**functional**" layout, which are the keys surrounding the main layout (shift, space, comma, the action key, ...). You can adjust it in _Advanced_ settings -> _Customize functional key layouts_. For historic reasons you can customize functional key layouts for _symbols_ and _more symbols_ separately. This is outdated since introduction of the `keyboard_state_selector`, and the _symbols_ and _more symbols_ functional key layouts might get removed at some point.
- The "**symbols**" layout is the layout you see when pressing the `?123` button. It comes in a special variation for Arabic script (might get removed later). This and all layouts below can be adjusted in _Advanced_ settings -> _Customize symbol and number layouts_.
- The "**more symbols**" layout is when you go to the symbols layout and press the `= \ <` key (`~ [ <` on tablets).
- The "**numbers**" layout comes up when an input field explicitly requests number input (but not phone).
- The "**numpad**" layout is reached (by default) from the symbols layout via the `12 / 34` key. It can be customized separately for landscape mode.
- The "**phone**" layout is shown when the input field requests phone input.
- When pressing the `* #` button on the phone layout, you will get the "**phone symbols**" layout.
- The "**number row**" is a single row layout that's shown only when number row is enabled in _Preferences_
- "**emoji / clipboard bottom row**" are the single row layouts shown in emoji resp. clipboard views.
# What a JSON file looks like for Heliboard?
- The JSON file: