aboutsummaryrefslogtreecommitdiff
path: root/docs/faq_keymap.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2017-12-09 16:36:32 +1100
committerJack Humbert <jack.humb@gmail.com>2017-12-09 10:46:11 -0500
commit7b0356d1d49da6574570e110f61f95692afdb3d0 (patch)
treea3e70802085ea8089f1e7851529f0296247fa264 /docs/faq_keymap.md
parent6eb89ae906db7f226570e1839b88dcdd3a8fa962 (diff)
downloadqmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.tar.gz
qmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.zip
Convert all headings to Title Case
Diffstat (limited to 'docs/faq_keymap.md')
-rw-r--r--docs/faq_keymap.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/faq_keymap.md b/docs/faq_keymap.md
index 6a364eb53..a54a76521 100644
--- a/docs/faq_keymap.md
+++ b/docs/faq_keymap.md
@@ -7,7 +7,7 @@ See [Keycodes](keycodes.md) for an index of keycodes available to you. These lin
7 7
8Keycodes are actually defined in [common/keycode.h](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/keycode.h). 8Keycodes are actually defined in [common/keycode.h](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/keycode.h).
9 9
10## What Are The Default Keycodes? 10## What Are the Default Keycodes?
11 11
12There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JIS. North America primarily uses ANSI, Europe and Africa primarily use ISO, and Japan uses JIS. Regions not mentioned typically use either ANSI or ISO. The keycodes corresponding to these layouts are shown here: 12There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JIS. North America primarily uses ANSI, Europe and Africa primarily use ISO, and Japan uses JIS. Regions not mentioned typically use either ANSI or ISO. The keycodes corresponding to these layouts are shown here:
13 13
@@ -18,25 +18,25 @@ There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JI
18 18
19The key found on most modern keyboards that is located between `KC_RGUI` and `KC_RCTL` is actually called `KC_APP`. This is because when that key was invented there was already a key named `MENU` in the relevant standards, so MS chose to call that the `APP` key. 19The key found on most modern keyboards that is located between `KC_RGUI` and `KC_RCTL` is actually called `KC_APP`. This is because when that key was invented there was already a key named `MENU` in the relevant standards, so MS chose to call that the `APP` key.
20 20
21## `KC_SYSREQ` isn't working 21## `KC_SYSREQ` Isn't Working
22Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'. 22Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'.
23 23
24See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and 24See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and
25- http://en.wikipedia.org/wiki/Magic_SysRq_key 25- http://en.wikipedia.org/wiki/Magic_SysRq_key
26- http://en.wikipedia.org/wiki/System_request 26- http://en.wikipedia.org/wiki/System_request
27 27
28## Power key doesn't work 28## Power Key Doesn't Work
29Use `KC_PWR` instead of `KC_POWER` or vice versa. 29Use `KC_PWR` instead of `KC_POWER` or vice versa.
30- `KC_PWR` works with Windows and Linux, not with OSX. 30- `KC_PWR` works with Windows and Linux, not with OSX.
31- `KC_POWER` works with OSX and Linux, not with Windows. 31- `KC_POWER` works with OSX and Linux, not with Windows.
32 32
33More info: http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264 33More info: http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264
34 34
35## Oneshot modifier 35## One Shot Modifier
36Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'. Oneshot Shift mitgates this for me. 36Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'. Oneshot Shift mitgates this for me.
37https://github.com/tmk/tmk_keyboard/issues/67 37https://github.com/tmk/tmk_keyboard/issues/67
38 38
39## Modifier/Layer stuck 39## Modifier/Layer Stuck
40Modifier keys or layers can be stuck unless layer switching is configured properly. 40Modifier keys or layers can be stuck unless layer switching is configured properly.
41For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to unregister the modifier key or return to previous layer on release event. 41For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to unregister the modifier key or return to previous layer on release event.
42 42
@@ -58,7 +58,7 @@ After enabling this feature use keycodes `KC_LCAP`, `KC_LNUM` and `KC_LSCR` in y
58 58
59Old vintage mechanical keyboards occasionally have lock switches but modern ones don't have. ***You don't need this feature in most case and just use keycodes `KC_CAPS`, `KC_NLCK` and `KC_SLCK`.*** 59Old vintage mechanical keyboards occasionally have lock switches but modern ones don't have. ***You don't need this feature in most case and just use keycodes `KC_CAPS`, `KC_NLCK` and `KC_SLCK`.***
60 60
61## Input special charactors other than ASCII like Cédille 'Ç' 61## Input Special Characters Other Than ASCII like Cédille 'Ç'
62NO UNIVERSAL METHOD TO INPUT THOSE WORKS OVER ALL SYSTEMS. You have to define **MACRO** in way specific to your OS or layout. 62NO UNIVERSAL METHOD TO INPUT THOSE WORKS OVER ALL SYSTEMS. You have to define **MACRO** in way specific to your OS or layout.
63 63
64See this post for example **MACRO** code. 64See this post for example **MACRO** code.
@@ -79,7 +79,7 @@ And see this for **Unicode** input.
79- http://en.wikipedia.org/wiki/Unicode_input 79- http://en.wikipedia.org/wiki/Unicode_input
80 80
81 81
82## Apple/Mac keyboard Fn 82## Apple/Mac Keyboard `Fn`
83Not supported. 83Not supported.
84 84
85Apple/Mac keyboard sends keycode for Fn unlike most of other keyboards. 85Apple/Mac keyboard sends keycode for Fn unlike most of other keyboards.
@@ -88,13 +88,13 @@ I think you can send Apple Fn key using Apple venter specific Page 0xff01 and us
88https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/AppleHIDUsageTables.h 88https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/AppleHIDUsageTables.h
89 89
90 90
91## Media control keys in Mac OSX 91## Media Control Keys in Mac OSX
92#### KC_MNXT and KC_MPRV does not work on Mac 92#### KC_MNXT and KC_MPRV Does Not Work on Mac
93Use `KC_MFFD`(`KC_MEDIA_FAST_FORWARD`) and `KC_MRWD`(`KC_MEDIA_REWIND`) instead of `KC_MNXT` and `KC_MPRV`. 93Use `KC_MFFD`(`KC_MEDIA_FAST_FORWARD`) and `KC_MRWD`(`KC_MEDIA_REWIND`) instead of `KC_MNXT` and `KC_MPRV`.
94See https://github.com/tmk/tmk_keyboard/issues/195 94See https://github.com/tmk/tmk_keyboard/issues/195
95 95
96 96
97## Keys supported in Mac OSX? 97## Keys Supported in Mac OSX?
98You can know which keycodes are supported in OSX from this source code. 98You can know which keycodes are supported in OSX from this source code.
99 99
100`usb_2_adb_keymap` array maps Keyboard/Keypad Page usages to ADB scancodes(OSX internal keycodes). 100`usb_2_adb_keymap` array maps Keyboard/Keypad Page usages to ADB scancodes(OSX internal keycodes).
@@ -106,7 +106,7 @@ And `IOHIDConsumer::dispatchConsumerEvent` handles Consumer page usages.
106https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp 106https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp
107 107
108 108
109## JIS keys in Mac OSX 109## JIS Keys in Mac OSX
110Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`, `ひらがな(hiragana)` are not recognized on OSX. You can use **Seil** to enable those keys, try following options. 110Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`, `ひらがな(hiragana)` are not recognized on OSX. You can use **Seil** to enable those keys, try following options.
111 111
112* Enable NFER Key on PC keyboard 112* Enable NFER Key on PC keyboard
@@ -116,7 +116,7 @@ Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`
116https://pqrs.org/osx/karabiner/seil.html 116https://pqrs.org/osx/karabiner/seil.html
117 117
118 118
119## RN-42 Bluetooth doesn't work with Karabiner 119## RN-42 Bluetooth Doesn't Work with Karabiner
120Karabiner - Keymapping tool on Mac OSX - ignores inputs from RN-42 module by default. You have to enable this option to make Karabiner working with your keyboard. 120Karabiner - Keymapping tool on Mac OSX - ignores inputs from RN-42 module by default. You have to enable this option to make Karabiner working with your keyboard.
121https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237 121https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237
122 122
@@ -125,11 +125,11 @@ https://github.com/tmk/tmk_keyboard/issues/213
125https://github.com/tekezo/Karabiner/issues/403 125https://github.com/tekezo/Karabiner/issues/403
126 126
127 127
128## Esc and `~ on a single key 128## Esc and <code>&#96;</code> on a Single Key
129 129
130See the [Grave Escape](feature_grave_escape.md) feature. 130See the [Grave Escape](feature_grave_escape.md) feature.
131 131
132## Arrow on Right Modifier keys with Dual-Role 132## Arrow on Right Modifier Keys with Dual-Role
133This turns right modifer keys into arrow keys when the keys are tapped while still modifiers when the keys are hold. In TMK the dual-role function is dubbed **TAP**. 133This turns right modifer keys into arrow keys when the keys are tapped while still modifiers when the keys are hold. In TMK the dual-role function is dubbed **TAP**.
134``` 134```
135 135
@@ -181,7 +181,7 @@ It seems Windows 10 ignores the code and Linux/Xorg recognizes but has no mappin
181Not sure what keycode Eject is on genuine Apple keyboard actually. HHKB uses `F20` for Eject key(`Fn+f`) on Mac mode but this is not same as Apple Eject keycode probably. 181Not sure what keycode Eject is on genuine Apple keyboard actually. HHKB uses `F20` for Eject key(`Fn+f`) on Mac mode but this is not same as Apple Eject keycode probably.
182 182
183 183
184## What's weak_mods and real_mods in action_util.c 184## What's `weak_mods` and `real_mods` in `action_util.c`
185___TO BE IMPROVED___ 185___TO BE IMPROVED___
186 186
187real_mods is intended to retains state of real/physical modifier key state, while 187real_mods is intended to retains state of real/physical modifier key state, while
@@ -204,7 +204,7 @@ here real_mods lost state for 'physical left shift'.
204weak_mods is ORed with real_mods when keyboard report is sent. 204weak_mods is ORed with real_mods when keyboard report is sent.
205https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57 205https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57
206 206
207## Timer functionality 207## Timer Functionality
208 208
209It's possible to start timers and read values for time-specific events - here's an example: 209It's possible to start timers and read values for time-specific events - here's an example:
210 210