diff options
Diffstat (limited to 'docs/faq_keymap.md')
| -rw-r--r-- | docs/faq_keymap.md | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/faq_keymap.md b/docs/faq_keymap.md index 6a364eb538..a54a76521d 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 Keycodes are actually defined in [common/keycode.h](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/keycode.h). -## What Are The Default Keycodes? +## What Are the Default Keycodes? There 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: @@ -18,25 +18,25 @@ There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JI The 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. -## `KC_SYSREQ` isn't working +## `KC_SYSREQ` Isn't Working Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'. See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and - http://en.wikipedia.org/wiki/Magic_SysRq_key - http://en.wikipedia.org/wiki/System_request -## Power key doesn't work +## Power Key Doesn't Work Use `KC_PWR` instead of `KC_POWER` or vice versa. - `KC_PWR` works with Windows and Linux, not with OSX. - `KC_POWER` works with OSX and Linux, not with Windows. More info: http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264 -## Oneshot modifier +## One Shot Modifier Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'. Oneshot Shift mitgates this for me. https://github.com/tmk/tmk_keyboard/issues/67 -## Modifier/Layer stuck +## Modifier/Layer Stuck Modifier keys or layers can be stuck unless layer switching is configured properly. For 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. @@ -58,7 +58,7 @@ After enabling this feature use keycodes `KC_LCAP`, `KC_LNUM` and `KC_LSCR` in y Old 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`.*** -## Input special charactors other than ASCII like Cédille 'Ç' +## Input Special Characters Other Than ASCII like Cédille 'Ç' NO UNIVERSAL METHOD TO INPUT THOSE WORKS OVER ALL SYSTEMS. You have to define **MACRO** in way specific to your OS or layout. See this post for example **MACRO** code. @@ -79,7 +79,7 @@ And see this for **Unicode** input. - http://en.wikipedia.org/wiki/Unicode_input -## Apple/Mac keyboard Fn +## Apple/Mac Keyboard `Fn` Not supported. Apple/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 https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/AppleHIDUsageTables.h -## Media control keys in Mac OSX -#### KC_MNXT and KC_MPRV does not work on Mac +## Media Control Keys in Mac OSX +#### KC_MNXT and KC_MPRV Does Not Work on Mac Use `KC_MFFD`(`KC_MEDIA_FAST_FORWARD`) and `KC_MRWD`(`KC_MEDIA_REWIND`) instead of `KC_MNXT` and `KC_MPRV`. See https://github.com/tmk/tmk_keyboard/issues/195 -## Keys supported in Mac OSX? +## Keys Supported in Mac OSX? You can know which keycodes are supported in OSX from this source code. `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. https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp -## JIS keys in Mac OSX +## JIS Keys in Mac OSX Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`, `ひらがな(hiragana)` are not recognized on OSX. You can use **Seil** to enable those keys, try following options. * Enable NFER Key on PC keyboard @@ -116,7 +116,7 @@ Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)` https://pqrs.org/osx/karabiner/seil.html -## RN-42 Bluetooth doesn't work with Karabiner +## RN-42 Bluetooth Doesn't Work with Karabiner Karabiner - 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. https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237 @@ -125,11 +125,11 @@ https://github.com/tmk/tmk_keyboard/issues/213 https://github.com/tekezo/Karabiner/issues/403 -## Esc and `~ on a single key +## Esc and <code>`</code> on a Single Key See the [Grave Escape](feature_grave_escape.md) feature. -## Arrow on Right Modifier keys with Dual-Role +## Arrow on Right Modifier Keys with Dual-Role This 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**. ``` @@ -181,7 +181,7 @@ It seems Windows 10 ignores the code and Linux/Xorg recognizes but has no mappin Not 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. -## What's weak_mods and real_mods in action_util.c +## What's `weak_mods` and `real_mods` in `action_util.c` ___TO BE IMPROVED___ real_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'. weak_mods is ORed with real_mods when keyboard report is sent. https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57 -## Timer functionality +## Timer Functionality It's possible to start timers and read values for time-specific events - here's an example: |