summaryrefslogtreecommitdiff
path: root/docs/getting_started_make_guide.md
diff options
context:
space:
mode:
authorKonstantin Đorđević <vomindoraan@gmail.com>2019-01-07 21:56:57 +0100
committerDrashna Jaelre <drashna@live.com>2019-01-07 12:56:57 -0800
commitcd9262d7b2dcde5d31aa34f066dd593a012d7049 (patch)
treebb9cda36efc39af997e019af4f6a91f451d12807 /docs/getting_started_make_guide.md
parent6e984a8b5e34ba181b0893a929af569a1faef2b6 (diff)
Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774)
* Remove unused UNICODE(n) macro, update docs * Add note about max length of unicode_map to docs * QK_UNICODE_MAP → QK_UNICODEMAP * Refactor process_unicode_map * process_unicode_map → process_unicodemap This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself. * Update references and ordering in docs/understanding_qmk * Add additional note to docs/understanding_qmk * &unicode_map[index] → unicode_map + index This avoids the issue of the compiler sometimes complaining about the array index being out of range * Update docs/getting_started_make_guide * Update method sections in docs/feature_unicode
Diffstat (limited to 'docs/getting_started_make_guide.md')
-rw-r--r--docs/getting_started_make_guide.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md
index e515411901..adc1aed751 100644
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@@ -93,19 +93,17 @@ This enables MIDI sending and receiving with your keyboard. To enter MIDI send m
93 93
94`UNICODE_ENABLE` 94`UNICODE_ENABLE`
95 95
96This allows you to send unicode symbols via `UC(<unicode>)` in your keymap. Only codes up to 0x7FFF are currently supported. 96This allows you to send Unicode characters using `UC(<code point>)` in your keymap. Code points up to `0x7FFF` are supported. This covers characters for most modern languages, as well as symbols, but it doesn't cover emoji.
97 97
98`UNICODEMAP_ENABLE` 98`UNICODEMAP_ENABLE`
99 99
100This allows sending unicode symbols using `X(<unicode>)` in your keymap. Codes 100This allows you to send Unicode characters using `X(<map index>)` in your keymap. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported.
101up to 0xFFFFFFFF are supported, including emojis. You will need to maintain
102a separate mapping table in your keymap file.
103 101
104Known limitations: 102`UCIS_ENABLE`
105- Under Mac OS, only codes up to 0xFFFF are supported.
106- Under Linux ibus, only codes up to 0xFFFFF are supported (but anything important is still under this limit for now).
107 103
108Characters out of range supported by the OS will be ignored. 104This allows you to send Unicode characters by inputting a mnemonic corresponding to the character you want to send. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported.
105
106For further details, as well as limitations, see the [Unicode page](feature_unicode.md).
109 107
110`BLUETOOTH_ENABLE` 108`BLUETOOTH_ENABLE`
111 109
@@ -117,7 +115,7 @@ This allows you output audio on the C6 pin (needs abstracting). See the [audio p
117 115
118`FAUXCLICKY_ENABLE` 116`FAUXCLICKY_ENABLE`
119 117
120Uses buzzer to emulate clicky switches. A cheap imitation of the Cherry blue switches. By default, uses the C6 pin, same as AUDIO_ENABLE. 118Uses buzzer to emulate clicky switches. A cheap imitation of the Cherry blue switches. By default, uses the C6 pin, same as `AUDIO_ENABLE`.
121 119
122`VARIABLE_TRACE` 120`VARIABLE_TRACE`
123 121