[Docs] Improve Unicode documentation #8676
Conversation
|
Added a short summary of steps needed to get Unicode working to the start of the doc. This makes the doc more suitable for quick reference, and also makes it less likely that users will skip a step when setting up Unicode on their board (seems to happen somewhat frequently). |
|
@ridingqwerty Have you had a chance to finish reviewing this yet? |
|
No worries, thanks a lot for reviewing! |
|
I had tried several different markup variations for the section headers before ending up with the current one. I think it's the clearest in terms of showing the three main steps that need to be taken to enable Unicode input on a board, as well as giving an overview of the three different methods supported under the first step. |
|
If you haven't seen it If you need to fine tune formatting/markdown, that is probably the best way to do so. |
|
Thanks, yeah, I used the doc server to test and fine-tune these changes. |
|
Is there anything else I need to add/update to help get this merged? |
|
Sorry, no, shouldn't be anything else. Though, I would like @noroadsleft to give it a check at least, since he's the resident wordsmith. |
| send_unicode_hex_string("0028 30CE 0CA0 75CA 0CA0 0029 30CE 5F61 253B 2501 253B"); | ||
| ``` | ||
| ## Additional Language Support | ||
|
|
||
| An easy way to convert your Unicode string to this format is by using [this site](https://r12a.github.io/app-conversion/), and taking the result in the "Hex/UTF-32" section. | ||
| In `quantum/keymap_extras`, you'll see various language files — these work the same way as the ones for alternative layouts such as Colemak or BÉPO. When you include one of these language headers, you gain access to keycodes specific to that language / national layout. Such keycodes are defined by a 2-letter country/language code, followed by an underscore and a 4-letter abbreviation of the character to which the key corresponds. For example, including `keymap_french.h` and using `FR_UGRV` in your keymap will output `ù` when typed on a system with a native French AZERTY layout. | ||
|
|
||
| ## Additional Language Support | ||
| If the primary system layout you use on your machine is different from US ANSI, using these language-specific keycodes can help your QMK keymaps better match what will actually be output on the screen. However, keep in mind that these keycodes are just aliases for the corresponding default US keycodes under the hood, and that the HID protocol used by keyboards is itself inherently based on US ANSI. |
There was a problem hiding this comment.
I'm struggling to offer good advice for this section. I actually followed your doc to enable Unicode Map on my KC60 (using WinCompose), but I haven't yet worked out the magic solution to get this to work fully, because I mainly use English Dvorak at the OS level, and something about that seems to break the feature. It wasn't clear to me from this that it only works with US ANSI arrangement.
Enabling this to work with other keys in unicode_input_start() would be a good improvement for the future, but that's out of scope for this PR.
|
Updated to latest master after #8770 was merged. |
Description
This is one that I've been meaning to do for a while. This PR rewrites several sections of the Unicode feature doc, with the intent of making it easier to understand, promoting best practices and providing more examples for users.
Some minor reformatting was also done to the Macros feature doc.
Types of Changes
Checklist