From 7454389f486f5c8ffd8509ad554b3302a832b9a4 Mon Sep 17 00:00:00 2001 From: Spike <126838489+Spike-from-NH@users.noreply.github.com> Date: Thu, 19 Sep 2024 17:48:56 -0400 Subject: [PATCH] doc: Point to code for built-in bottom row and number row for use as starting points (#756) --- doc/Custom-layouts.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/Custom-layouts.md b/doc/Custom-layouts.md index fc9176d..b5fbb57 100644 --- a/doc/Custom-layouts.md +++ b/doc/Custom-layouts.md @@ -34,11 +34,19 @@ Here is a complete keyboard file with a single row containing an "a" key on the ## Keyboard metadata + The ``...`` pair follows the declaration tag and encloses the whole keyboard. The following properties may be used (The first two appear in the example above): + * `name`: The name of the keyboard. The name you specify will appear in the Settings menu. If not present, the layout will just appear as “Custom layout”. + * `script`: The (main) writing system that the keyboard supports. The possible values are `arabic`, `armenian`, `bengali`, `cyrillic`, `devanagari`, `gujarati`, `hangul`, `hebrew`, `latin`, `persian`, `shavian`, and `urdu`. It defaults to `latin`. + * `numpad_script`: The script to use for the numpad. This is useful for scripts where a different, non-ASCII set of numerals is used, like Devanagari and Arabic. It defaults to the same as `script`. -* `bottom_row`: Whether or not to show the common bottom row. It accepts `true` or `false`, and defaults to `true`. If your custom layout defines the bottom row, then specify `bottom_row="false"` to disable the built-in bottom row. + +* `bottom_row`: Whether or not to show the built-in bottom row. It accepts `true` or `false`, and defaults to `true`. If your custom layout defines the bottom row, then specify `bottom_row="false"` to disable the built-in bottom row. + + We recommend your layout use the built-in bottom row, because it is still evolving and your layout will incorporate innovations in future versions. However, to define your own, the current definition of the bottom row is in [bottom_row.xml](https://github.com/Julow/Unexpected-Keyboard/res/xml/bottom_row.xml). You can copypaste this XML into your custom layout as a starting point. + + Likewise, the current definition of the top (number) row is in [number_row.xml](https://github.com/Julow/Unexpected-Keyboard/res/xml/number_row.xml). + * `locale_extra_keys`: Whether Unexpected should add language-dependent extra keys from [method.xml](../res/xml/method.xml) to this layout. It accepts `true` or `false`, and defaults to `true`. To disable these automatic additions, specify `locale_extra_keys="false"`. ## Row