Cutieguwu/qmk
1
0
Fork 0
Code Issues Pull Requests Actions 54 Packages Projects Releases Wiki Activity

Add usage clarifications to docs/features/unicode.md (#26156)

Browse Source 
* Add usage clarifications to docs/features/unicode.md

* Apply suggestions from code review

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>

---------

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
This commit is contained in:
Konstantin Đorđević
2026-05-22 07:57:44 +02:00
committed by GitHub
parent 62d25f02a4
commit cf2dcd6e24
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/unicode.md
+7 -4
View File
@@ -8,9 +8,9 @@ There are some limitations to this feature. Because there is no "standard" metho
## Usage {#usage}
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See below for more details.
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See [below](#input-subsystems) for more details.
Add the following to your keymap's `rules.mk`:
To start, add the following to your keymap's `rules.mk`:
```make
UNICODE_COMMON = yes
@@ -18,7 +18,7 @@ UNICODE_COMMON = yes
## Basic Configuration {#basic-configuration}
Add the following to your `config.h`:
The following options can be set or overridden in your `config.h`:
|Define |Default |Description |
|------------------------|------------------|--------------------------------------------------------------------------------|
@@ -29,11 +29,14 @@ Add the following to your `config.h`:
|`UNICODE_CYCLE_PERSIST` |`true` |Whether to persist the current Unicode input mode to EEPROM |
|`UNICODE_TYPE_DELAY` |`10` |The amount of time to wait, in milliseconds, between Unicode sequence keystrokes|
The default values work well for most use cases, so users usually only need to define `UNICODE_SELECTED_MODES` to set their desired input modes.
However, if you plan on switching input modes manually (see [keycodes](#keycodes) below) and don't plan on cycling through them, this definition can be omitted.
### Audio Feedback {#audio-feedback}
If you have the [Audio](audio) feature enabled on your board, you can configure it to play sounds when the input mode is changed.
Add the following to your `config.h`:
Add one or more of the following definitions to your `config.h`:
|Define |Default|Description |
|-------------------|-------|-----------------------------------------------------------|