From f4f2723dd6fa1b5fdf488080f65beeeda4ac47eb Mon Sep 17 00:00:00 2001 From: Helium314 Date: Sun, 15 Sep 2024 16:17:32 +0200 Subject: [PATCH] Created Customization (markdown) --- Customization.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 Customization.md diff --git a/Customization.md b/Customization.md new file mode 100644 index 0000000..6123a22 --- /dev/null +++ b/Customization.md @@ -0,0 +1,33 @@ +Besides "normal" settings, HeliBoard allows for more advanced customization in some areas, for which you find information on this page. + +# Theme colors +You can set a user-defined theme, for day and night themes separately. +Once the user-defined theme is enabled, an "adjust colors" item will appear, which takes you to another screen. +The items show the color to be used on the left, and the switch on the right indicates whether the color is determined automatically (off) or set manually (on). Switching the switch off when you have set a custom color switches to automatic color, but does _not_ delete the custom color (just enable the switch again). + +When clicking the color or the text, a color selector opens in which you can set whatever color and transparency (the bottom slider) you like. Adjusting transparency is disabled for "keyboard background". The text field allows entering a hexadecimal RGB color (without the leading `#`). + +In the "..." menu on top right, you can show additional colors for more fine-grained adjustments, or you can show _all colors_ that are used internally. +The latter option shows a lot of colors, and is meant specifically for users who want a lot of control, even if it's at the cost of convenience. The starting color for each entry is random, just based on the name of the color (so you can tell the colors apart), and there is no option to set a reasonably usable color automatically. +Since the colors correspond to what is used internally, the list of colors might change due to adding or removing colors during development. + +The "..." menu also offers saving the current selection of colors to a file, or to clipboard, so you can do a backup or share your theme. The _load_ option allows loading such data. +Colors are saved in a format that allows loading to both day and night themes. + +On the bottom you have a text field that serves no purpose but to preview the current theme. + +# Layouts +You can customize all keyboard layouts available in the app. + +For the main layout, you can do this in _languages & layouts_, when _use system languages_ is disabled. Then tap on a language and select the `+` next to "layout" and click "add custom layout". Then you can either load a layout from a file, or copy an existing layout. Once you have the new layout, tap to edit it. +[Simple layouts](https://github.com/Helium314/HeliBoard/blob/main/layouts.md#simple-format) are mostly straightforward to edit, but the more powerful and customizable [Json format](https://github.com/Helium314/HeliBoard/blob/main/layouts.md#json-format) may be cumbersome to work with, especially when you just use the internal text box editor. + +Other layouts are available in _advanced settings_, and can be edited the same way (but not loaded from files directly). + +# Dictionaries + +You can add custom dictionaries, or replace a built-in "main" dictionary. Adding is done in _languages & layouts_ by tapping the `+` next to _dictionaries_. Alternatively you can open a .dict file in a file explorer with HeliBoard and choose the language. +Each dictionary has a _type_, which is unique per language. So when the dictionary has _type_ "main", it will replace any existing main dictionary for that language. + +Creating dictionaries is a somewhat complex process, you can find information in the readme at https://codeberg.org/Helium314/aosp-dictionaries. +In the same repository you can also find more dictionaries gathered from various sources. \ No newline at end of file