GitBook: [qmk#27] No subject

docs/README.md

@@ -2,6 +2,8 @@
 
 [![Current Version](https://img.shields.io/github/tag/qmk/qmk\_firmware.svg)](/~https://github.com/qmk/qmk\_firmware/tags) [![Build Status](https://travis-ci.org/qmk/qmk\_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk\_firmware) [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) [![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm) [![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk\_firmware.svg)](/~https://github.com/qmk/qmk\_firmware/pulse/monthly) [![GitHub forks](https://img.shields.io/github/forks/qmk/qmk\_firmware.svg?style=social\&label=Fork)](/~https://github.com/qmk/qmk\_firmware/)
 
+![](<.gitbook/assets/Screenshot 2022-01-05 at 10.09.45.png>)
+
 <details>
 
 <summary>What is QMK Firmware?</summary>

docs/faq/faq_keymap.md

@@ -6,7 +6,7 @@ This page covers questions people often have about keymaps. If you haven't you s
 
 See [Keycodes](../reference/keycodes.md) for an index of keycodes available to you. These link to more extensive documentation when available.
 
-Keycodes are actually defined in [common/keycode.h](/~https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/keycode.h).
+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?
 
@@ -20,72 +20,72 @@ QMK has two features, Bootmagic and Command, which allow you to change the behav
 
 As a quick fix try holding down `Space`+`Backspace` while you plug in your keyboard. This will reset the stored settings on your keyboard, returning those keys to normal operation. If that doesn't work look here:
 
-* [Bootmagic](../features/feature_bootmagic.md)
-* [Command](../features/feature_command.md) 
+* [Bootmagic](../features/feature\_bootmagic.md)
+* [Command](../features/feature\_command.md)
 
 ## The Menu Key Isn't Working
 
 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
 
-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'.
+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
+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/Magic_SysRq_key)
-* [http://en.wikipedia.org/wiki/System\_request](http://en.wikipedia.org/wiki/System_request)
+* [http://en.wikipedia.org/wiki/Magic\_SysRq\_key](http://en.wikipedia.org/wiki/Magic\_SysRq\_key)
+* [http://en.wikipedia.org/wiki/System\_request](http://en.wikipedia.org/wiki/System\_request)
 
 ## Power Keys Aren't Working
 
-Somewhat confusingly, there are two "Power" keycodes in QMK: `KC_POWER` in the Keyboard/Keypad HID usage page, and `KC_SYSTEM_POWER` \(or `KC_PWR`\) in the Consumer page.
+Somewhat confusingly, there are two "Power" keycodes in QMK: `KC_POWER` in the Keyboard/Keypad HID usage page, and `KC_SYSTEM_POWER` (or `KC_PWR`) in the Consumer page.
 
 The former is only recognized on macOS, while the latter, `KC_SLEP` and `KC_WAKE` are supported by all three major operating systems, so it is recommended to use those instead. Under Windows, these keys take effect immediately, however on macOS they must be held down until a dialog appears.
 
 ## One Shot Modifier
 
-Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'. One Shot Shift mitigates this for me. [/~https://github.com/tmk/tmk\_keyboard/issues/67](/~https://github.com/tmk/tmk_keyboard/issues/67)
+Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'. One Shot Shift mitigates this for me. [/~https://github.com/tmk/tmk\_keyboard/issues/67](/~https://github.com/tmk/tmk\_keyboard/issues/67)
 
 ## 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.
 
-* [/~https://github.com/tmk/tmk\_core/blob/master/doc/keymap.md\#31-momentary-switching](/~https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#31-momentary-switching)
-* [http://geekhack.org/index.php?topic=57008.msg1492604\#msg1492604](http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604)
-* [/~https://github.com/tmk/tmk\_keyboard/issues/248](/~https://github.com/tmk/tmk_keyboard/issues/248)
+* [/~https://github.com/tmk/tmk\_core/blob/master/doc/keymap.md#31-momentary-switching](/~https://github.com/tmk/tmk\_core/blob/master/doc/keymap.md#31-momentary-switching)
+* [http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604](http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604)
+* [/~https://github.com/tmk/tmk\_keyboard/issues/248](/~https://github.com/tmk/tmk\_keyboard/issues/248)
 
 ## Mechanical Lock Switch Support
 
-This feature is for _mechanical lock switch_ like [this Alps one](http://deskthority.net/wiki/Alps_SKCL_Lock). You can enable it by adding this to your `config.h`:
+This feature is for _mechanical lock switch_ like [this Alps one](http://deskthority.net/wiki/Alps\_SKCL\_Lock). You can enable it by adding this to your `config.h`:
 
-```text
+```
 #define LOCKING_SUPPORT_ENABLE
 #define LOCKING_RESYNC_ENABLE
 ```
 
 After enabling this feature use keycodes `KC_LCAP`, `KC_LNUM` and `KC_LSCR` in your keymap instead.
 
-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`.**_
+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 Characters Other Than ASCII like Cédille 'Ç'
 
-See the [Unicode](../features/feature_unicode.md) feature.
+See the [Unicode](../features/feature\_unicode.md) feature.
 
 ## `Fn` Key on macOS
 
 Unlike most Fn keys, the one on Apple keyboards actually has its own keycode... sort of. It takes the place of the sixth keycode in a basic 6KRO HID report -- so an Apple keyboard is in fact only 5KRO.
 
 It is technically possible to get QMK to send this key. However, doing so requires modification of the report format to add the state of the Fn key. Even worse, it is not recognized unless the keyboard's VID and PID match that of a real Apple keyboard. The legal issues that official QMK support for this feature may create mean it is unlikely to happen.
 
-See [this issue](/~https://github.com/qmk/qmk_firmware/issues/2179) for detailed information.
+See [this issue](/~https://github.com/qmk/qmk\_firmware/issues/2179) for detailed information.
 
 ## 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\).
+`usb_2_adb_keymap` array maps Keyboard/Keypad Page usages to ADB scancodes(OSX internal keycodes).
 
-[https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo\_USB2ADB.c](https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo_USB2ADB.c)
+[https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo\_USB2ADB.c](https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo\_USB2ADB.c)
 
 And `IOHIDConsumer::dispatchConsumerEvent` handles Consumer page usages.
 
@@ -103,43 +103,42 @@ Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`
 
 ## 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](/~https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237)
+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](/~https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237)
 
-See these for the detail of this problem. [/~https://github.com/tmk/tmk\_keyboard/issues/213](/~https://github.com/tmk/tmk_keyboard/issues/213) [/~https://github.com/tekezo/Karabiner/issues/403](/~https://github.com/tekezo/Karabiner/issues/403)
+See these for the detail of this problem. [/~https://github.com/tmk/tmk\_keyboard/issues/213](/~https://github.com/tmk/tmk\_keyboard/issues/213) [/~https://github.com/tekezo/Karabiner/issues/403](/~https://github.com/tekezo/Karabiner/issues/403)
 
-## Esc and ````` on a Single Key
+## Esc and \`\`\`\`\` on a Single Key
 
-See the [Grave Escape](../features/feature_grave_esc.md) feature.
+See the [Grave Escape](../features/feature\_grave\_esc.md) feature.
 
 ## Eject on Mac OSX
 
-`KC_EJCT` keycode works on OSX. [/~https://github.com/tmk/tmk\_keyboard/issues/250](/~https://github.com/tmk/tmk_keyboard/issues/250) It seems Windows 10 ignores the code and Linux/Xorg recognizes but has no mapping by default.
+`KC_EJCT` keycode works on OSX. [/~https://github.com/tmk/tmk\_keyboard/issues/250](/~https://github.com/tmk/tmk\_keyboard/issues/250) It seems Windows 10 ignores the code and Linux/Xorg recognizes but has no mapping by default.
 
-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.
+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`
 
 _**TO BE IMPROVED**_
 
 real\_mods is intended to retains state of real/physical modifier key state, while weak\_mods retains state of virtual or temporary modifiers which should not affect state real modifier key.
 
-Let's say you hold down physical left shift key and type ACTION\_MODS\_KEY\(LSHIFT, KC\_A\),
+Let's say you hold down physical left shift key and type ACTION\_MODS\_KEY(LSHIFT, KC\_A),
 
 with weak\_mods,
 
-* \(1\) hold down left shift: real\_mods \|= MOD\_BIT\(LSHIFT\)
-* \(2\) press ACTION\_MODS\_KEY\(LSHIFT, KC\_A\): weak\_mods \|= MOD\_BIT\(LSHIFT\)
-* \(3\) release ACTION\_MODS\_KEY\(LSHIFT, KC\_A\): weak\_mods &= ~MOD\_BIT\(LSHIFT\)
+* (1) hold down left shift: real\_mods |= MOD\_BIT(LSHIFT)
+* (2) press ACTION\_MODS\_KEY(LSHIFT, KC\_A): weak\_mods |= MOD\_BIT(LSHIFT)
+*   (3) release ACTION\_MODS\_KEY(LSHIFT, KC\_A): weak\_mods &= \~MOD\_BIT(LSHIFT)
 
-  real\_mods still keeps modifier state.
+    real\_mods still keeps modifier state.
 
 without weak mods,
 
-* \(1\) hold down left shift: real\_mods \|= MOD\_BIT\(LSHIFT\)
-* \(2\) press ACTION\_MODS\_KEY\(LSHIFT, KC\_A\): real\_mods \|= MOD\_BIT\(LSHIFT\)
-* \(3\) release ACTION\_MODS\_KEY\(LSHIFT, KC\_A\): real\_mods &= ~MOD\_BIT\(LSHIFT\)
-
-  here real\_mods lost state for 'physical left shift'.
+* (1) hold down left shift: real\_mods |= MOD\_BIT(LSHIFT)
+* (2) press ACTION\_MODS\_KEY(LSHIFT, KC\_A): real\_mods |= MOD\_BIT(LSHIFT)
+*   (3) release ACTION\_MODS\_KEY(LSHIFT, KC\_A): real\_mods &= \~MOD\_BIT(LSHIFT)
 
-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](/~https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57)
+    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](/~https://github.com/tmk/tmk\_core/blob/master/common/action\_util.c#L57)