diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-06-10 14:58:24 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-06-10 14:58:24 -0400 |
| commit | ca01d94005f67ec4fa9528353481faa622d949ae (patch) | |
| tree | dd6d59d065492e3bb8192263a8a7e7cc0709c48f /docs/Unicode-and-additional-language-support.md | |
| parent | 558db0e03f0f3993e2b7fb5cc3f285393da0a4c3 (diff) | |
| download | qmk_firmware-ca01d94005f67ec4fa9528353481faa622d949ae.tar.gz qmk_firmware-ca01d94005f67ec4fa9528353481faa622d949ae.zip | |
convert docs to lowercase and underscores
Diffstat (limited to 'docs/Unicode-and-additional-language-support.md')
| -rw-r--r-- | docs/Unicode-and-additional-language-support.md | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/Unicode-and-additional-language-support.md b/docs/Unicode-and-additional-language-support.md deleted file mode 100644 index 562dae4b5..000000000 --- a/docs/Unicode-and-additional-language-support.md +++ /dev/null | |||
| @@ -1,54 +0,0 @@ | |||
| 1 | ## Unicode support | ||
| 2 | |||
| 3 | There are three Unicode keymap definition method available in QMK: | ||
| 4 | |||
| 5 | ### UNICODE_ENABLE | ||
| 6 | |||
| 7 | Supports Unicode input up to 0xFFFF. The keycode function is `UC(n)` in | ||
| 8 | keymap file, where *n* is a 4 digit hexadecimal. | ||
| 9 | |||
| 10 | ### UNICODEMAP_ENABLE | ||
| 11 | |||
| 12 | Supports Unicode up to 0xFFFFFFFF. You need to maintain a separate mapping | ||
| 13 | table `const uint32_t PROGMEM unicode_map[] = {...}` in your keymap file. | ||
| 14 | The keycode function is `X(n)` where *n* is the array index of the mapping | ||
| 15 | table. | ||
| 16 | |||
| 17 | ### UCIS_ENABLE | ||
| 18 | |||
| 19 | TBD | ||
| 20 | |||
| 21 | Unicode input in QMK works by inputing a sequence of characters to the OS, | ||
| 22 | sort of like macro. Unfortunately, each OS has different ideas on how Unicode is inputted. | ||
| 23 | |||
| 24 | This is the current list of Unicode input method in QMK: | ||
| 25 | |||
| 26 | * UC_OSX: MacOS Unicode Hex Input support. Works only up to 0xFFFF. Disabled by default. To enable: go to System Preferences -> Keyboard -> Input Sources, and enable Unicode Hex. | ||
| 27 | * UC_LNX: Unicode input method under Linux. Works up to 0xFFFFF. Should work almost anywhere on ibus enabled distros. Without ibus, this works under GTK apps, but rarely anywhere else. | ||
| 28 | * UC_WIN: (not recommended) Windows built-in Unicode input. To enable: create registry key under `HKEY_CURRENT_USER\Control Panel\Input Method\EnableHexNumpad` of type `REG_SZ` called `EnableHexNumpad`, set its value to 1, and reboot. This method is not recommended because of reliability and compatibility issue, use WinCompose method below instead. | ||
| 29 | * UC_WINC: Windows Unicode input using WinCompose. Requires [WinCompose](https://github.com/samhocevar/wincompose). Works reliably under many (all?) variations of Windows. | ||
| 30 | |||
| 31 | ## Additional language support | ||
| 32 | |||
| 33 | In `quantum/keymap_extras/`, you'll see various language files - these work the same way as the alternative layout ones do. Most are defined by their two letter country/language code followed by an underscore and a 4-letter abbreviation of its name. `FR_UGRV` which will result in a `ù` when using a software-implemented AZERTY layout. It's currently difficult to send such characters in just the firmware. | ||
| 34 | |||
| 35 | ## International Characters on Windows | ||
| 36 | |||
| 37 | [AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys among others. | ||
| 38 | |||
| 39 | The method does not require Unicode support in the keyboard itself but depends instead of AutoHotkey running in the background. | ||
| 40 | |||
| 41 | First you need to select a modifier combination that is not in use by any of your programs. | ||
| 42 | CtrlAltWin is not used very widely and should therefore be perfect for this. | ||
| 43 | There is a macro defined for a mod-tab combo `LCAG_T`. | ||
| 44 | Add this mod-tab combo to a key on your keyboard, e.g.: `LCAG_T(KC_TAB)`. | ||
| 45 | This makes the key behave like a tab key if pressed and released immediately but changes it to the modifier if used with another key. | ||
| 46 | |||
| 47 | In the default script of AutoHotkey you can define custom hotkeys. | ||
| 48 | |||
| 49 | <^<!<#a::Send, ä | ||
| 50 | <^<!<#<+a::Send, Ä | ||
| 51 | |||
| 52 | The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a. | ||
| 53 | AutoHotkey inserts the Text right of `Send, ` when this combination is pressed. | ||
| 54 | |||
