aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_unicode.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_unicode.md')
-rw-r--r--docs/feature_unicode.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/feature_unicode.md b/docs/feature_unicode.md
index a6f2cb4d0..aedffe4ea 100644
--- a/docs/feature_unicode.md
+++ b/docs/feature_unicode.md
@@ -66,13 +66,16 @@ Then define a table like this in your keymap file:
66 66
67```c 67```c
68const qk_ucis_symbol_t ucis_symbol_table[] = UCIS_TABLE( 68const qk_ucis_symbol_t ucis_symbol_table[] = UCIS_TABLE(
69 UCIS_SYM("poop", 0x1F4A9), // 💩 69 UCIS_SYM("poop", 0x1F4A9), // 💩
70 UCIS_SYM("rofl", 0x1F923), // 🤣 70 UCIS_SYM("rofl", 0x1F923), // 🤣
71 UCIS_SYM("kiss", 0x1F619) // 😙 71 UCIS_SYM("cuba", 0x1F1E8, 0x1F1FA), // 🇨🇺
72 UCIS_SYM("look", 0x0CA0, 0x005F, 0x0CA0), // ಠ_ಠ
72); 73);
73``` 74```
74 75
75To use it, call `qk_ucis_start()`. Then, type the mnemonic for the character (such as "rofl"), and hit Space or Enter. QMK should erase the "rofl" text and insert the laughing emoji. 76By default, each table entry may be up to 3 code points long. This number can be changed by adding `#define UCIS_MAX_CODE_POINTS n` to your `config.h` file.
77
78To use UCIS input, call `qk_ucis_start()`. Then, type the mnemonic for the character (such as "rofl") and hit Space, Enter or Esc. QMK should erase the "rofl" text and insert the laughing emoji.
76 79
77### Customization 80### Customization
78 81
@@ -90,7 +93,7 @@ Unicode input in QMK works by inputting a sequence of characters to the OS, sort
90 93
91The following input modes are available: 94The following input modes are available:
92 95
93* **`UC_MAC`**: macOS built-in Unicode hex input. Supports code points up to `0xFFFF` (`0x10FFFF` with Unicode Map). 96* **`UC_MAC`**: macOS built-in Unicode hex input. Supports code points up to `0x10FFFF` (all possible code points).
94 97
95 To enable, go to _System Preferences > Keyboard > Input Sources_, add _Unicode Hex Input_ to the list (it's under _Other_), then activate it from the input dropdown in the Menu Bar. 98 To enable, go to _System Preferences > Keyboard > Input Sources_, add _Unicode Hex Input_ to the list (it's under _Other_), then activate it from the input dropdown in the Menu Bar.
96 By default, this mode uses the left Option key (`KC_LALT`) for Unicode input, but this can be changed by defining [`UNICODE_KEY_MAC`](#input-key-configuration) with another keycode. 99 By default, this mode uses the left Option key (`KC_LALT`) for Unicode input, but this can be changed by defining [`UNICODE_KEY_MAC`](#input-key-configuration) with another keycode.