diff options
| -rw-r--r-- | keyboards/s60-x/keymaps/ansi_qwertz/readme.md | 42 | ||||
| -rw-r--r-- | keyboards/s60-x/readme.md | 7 |
2 files changed, 21 insertions, 28 deletions
diff --git a/keyboards/s60-x/keymaps/ansi_qwertz/readme.md b/keyboards/s60-x/keymaps/ansi_qwertz/readme.md index 0938e49c8..50651896f 100644 --- a/keyboards/s60-x/keymaps/ansi_qwertz/readme.md +++ b/keyboards/s60-x/keymaps/ansi_qwertz/readme.md | |||
| @@ -1,27 +1,26 @@ | |||
| 1 | # ANSI_QWERTZ | 1 | # ANSI_QWERTZ |
| 2 | 2 | ||
| 3 | [Click here to go to the layers directly.](readme.md#layers) | 3 | [Click here to go to the layers directly.](readme.md#1.0-layers) |
| 4 | 4 | ||
| 5 | This keymap was specifically designed to support keycaps with ANSI layout and legends, while retaining the possibility of inputting characters | 5 | This keymap was specifically designed to support keycaps with ANSI layout and legends, while retaining the possibility of inputting characters |
| 6 | with diacritics that are normally not used in the english language. | 6 | with diacritics that are normally not used in the english language. |
| 7 | 7 | ||
| 8 | It currently relies on the US-International keyboard layout, which can be installed in any current operating system without the use of third party hardware. | 8 | It currently relies on the US-International keyboard layout, which can be installed in any current operating system without the use of third party hardware. |
| 9 | 9 | ||
| 10 | ##Features | 10 | ##0. Features |
| 11 | |||
| 12 | * Input of letters with diacritics on familiar QWERTZ layout | 11 | * Input of letters with diacritics on familiar QWERTZ layout |
| 13 | * Support for ANSI-legend keycaps | 12 | * Support for ANSI-legend keycaps |
| 14 | * Option to "revive" all dead keys | 13 | * Option to "revive" all dead keys |
| 14 | * Dedicated arrow cluster | ||
| 15 | * SpaceFN for easy access to Function keys and diacritic input | 15 | * SpaceFN for easy access to Function keys and diacritic input |
| 16 | * Locking "Gaming Mode" that disables SpaceFN and allows to bind GUI key in Games | 16 | * Locking "Gaming Mode" that disables SpaceFN and allows to bind GUI key in Games |
| 17 | * Reset key binding, no need to press hardware reset button to program | 17 | * Reset key binding, no need to press hardware reset button to program |
| 18 | * Microphone Mute key (requires 3rd-party software, see below) | 18 | * Microphone Mute key (requires 3rd-party software, see below) |
| 19 | 19 | ||
| 20 | ###Languages | 20 | ###0.0 Languages |
| 21 | |||
| 22 | The US-International Layout is currently required for the support of non-english languages. This keymap swaps Y and Z to provide the familiar QWERTZ position for characters when using that layout. | 21 | The US-International Layout is currently required for the support of non-english languages. This keymap swaps Y and Z to provide the familiar QWERTZ position for characters when using that layout. |
| 23 | All diacritic characters are input by either holding `Space` or `Fn` and pressing the corresponding key. For languages that aren't yet supported explicitly, | 22 | All diacritic characters are input by either holding `Space` or `Fn` and pressing the corresponding key. For languages that aren't yet supported explicitly, |
| 24 | one can also use AltGr to input the characters as intended by the US-Intl layout or the dead keys, if they're kept from being [revived](readme.md#revive-dead-keys). | 23 | one can also use AltGr to input the characters as intended by the US-Intl layout or the dead keys, if they're kept from being [revived](readme.md#0.4-revive-dead-keys). |
| 25 | 24 | ||
| 26 | The illustration below shows the "US International" layout available in the Language settings of Windows, Linux and Mac OS. | 25 | The illustration below shows the "US International" layout available in the Language settings of Windows, Linux and Mac OS. |
| 27 | 26 | ||
| @@ -32,73 +31,60 @@ which contains more dead keys to input pretty much every diacritic character in | |||
| 32 | 31 | ||
| 33 |  | 32 |  |
| 34 | 33 | ||
| 35 | ####Explicitly Supported Languages | 34 | ####0.0.0 Explicitly Supported Languages |
| 36 | |||
| 37 | * German | 35 | * German |
| 38 | 36 | ||
| 39 | ####Implicitly Supported Languages | 37 | ####0.0.1 Implicitly Supported Languages |
| 40 | |||
| 41 | This list only applies to Windows. Linux systems support all languages, see above. This list might be incomplete! Please add your language if you find it's supported. | 38 | This list only applies to Windows. Linux systems support all languages, see above. This list might be incomplete! Please add your language if you find it's supported. |
| 42 | 39 | ||
| 43 | * French | 40 | * French |
| 44 | 41 | ||
| 45 | ###SpaceFN | 42 | ###0.1 SpaceFN |
| 46 | |||
| 47 | SpaceFN basically means that `Space` acts as a normal spacebar when tapped, but acts as a layer-key when held down. | 43 | SpaceFN basically means that `Space` acts as a normal spacebar when tapped, but acts as a layer-key when held down. |
| 48 | This means that you can't hold space to output multiple spaces consecutively and that space only registers once released. | 44 | This means that you can't hold space to output multiple spaces consecutively and that space only registers once released. |
| 49 | The advantage is that the spacebar is easier to reach than any other `Fn`-key could be. | 45 | The advantage is that the spacebar is easier to reach than any other `Fn`-key could be. |
| 50 | 46 | ||
| 51 | ###"Gaming Mode" | 47 | ###0.2 "Gaming Mode" |
| 52 | |||
| 53 | To alleviate the problems SpaceFN would cause when gaming, the Gaming Mode is pretty much a layer that can be turned on by pressing Fn+RShift. | 48 | To alleviate the problems SpaceFN would cause when gaming, the Gaming Mode is pretty much a layer that can be turned on by pressing Fn+RShift. |
| 54 | This will turn the double-role Spacebar into a normal one, so the Fn-layer (and thus function and media keys) can only be accessed with the Fn-key. | 49 | This will turn the double-role Spacebar into a normal one, so the Fn-layer (and thus function and media keys) can only be accessed with the Fn-key. |
| 55 | It also turns the GUI-key (aka Win-key aka Super-key) into Right Shift, so it can be bound in Games. This is especially useful when playing with ESDF instead of WASD. | 50 | It also turns the GUI-key (aka Win-key aka Super-key) into Right Shift, so it can be bound in Games. This is especially useful when playing with ESDF instead of WASD. |
| 56 | 51 | ||
| 57 | ###Mute Microphone | 52 | ###0.3 Mute Microphone |
| 58 | |||
| 59 | The function layer has a "Mute Microphone"-key. As this is not an existing media key and you can't normally set a shortcut to this function, | 53 | The function layer has a "Mute Microphone"-key. As this is not an existing media key and you can't normally set a shortcut to this function, |
| 60 | you need to set this up in software before using it, see below. This key is bound to `RCtrl+LCtrl`, a keycombination that | 54 | you need to set this up in software before using it, see below. This key is bound to `RCtrl+LCtrl`, a keycombination that |
| 61 | no other program in existence uses for anything, at least to my knowledge. It also can't be pressed with this keymap in any other way. | 55 | no other program in existence uses for anything, at least to my knowledge. It also can't be pressed with this keymap in any other way. |
| 62 | 56 | ||
| 63 | ####Linux | 57 | ####0.3.0 Linux |
| 64 | |||
| 65 | Follow [these instructions](http://askubuntu.com/a/13364). | 58 | Follow [these instructions](http://askubuntu.com/a/13364). |
| 66 | 59 | ||
| 67 | #####Windows (Requires 3rd Party Software) | 60 | #####0.3.1 Windows (Requires 3rd Party Software) |
| 68 | |||
| 69 | *DISCLAIMER: I take no responsibility for any potential harm caused by third party applications!* | 61 | *DISCLAIMER: I take no responsibility for any potential harm caused by third party applications!* |
| 70 | 62 | ||
| 71 | You'll need a utility called "MicMute". It is available on [Sourceforge](https://sourceforge.net/projects/micmute/). | 63 | You'll need a utility called "MicMute". It is available on [Sourceforge](https://sourceforge.net/projects/micmute/). |
| 72 | After installing and running the tool, you only need to use the "Setup Shortcut" option to bind the key to muting the microphone | 64 | After installing and running the tool, you only need to use the "Setup Shortcut" option to bind the key to muting the microphone |
| 73 | and check whether your microphone is selected under "Devices". | 65 | and check whether your microphone is selected under "Devices". |
| 74 | 66 | ||
| 75 | ###Revive Dead Keys | 67 | ###0.4 Revive Dead Keys |
| 76 | |||
| 77 | Some diacritics that are commonly used are dead keys on the international layouts, for example `` ` ``, `'`, or `"`. | 68 | Some diacritics that are commonly used are dead keys on the international layouts, for example `` ` ``, `'`, or `"`. |
| 78 | The dead keys on the regular international layout (shown in red [here](readme.md#languages)) are revived with this keymap by automatically inserting a space if one of those characters is typed. | 69 | The dead keys on the regular international layout (shown in red [here](readme.md#0.1-languages)) are revived with this keymap by automatically inserting a space if one of those characters is typed. |
| 79 | If you don't want this to be the case, uncomment the following line in `keymap.c` prior to compiling: | 70 | If you don't want this to be the case, uncomment the following line in `keymap.c` prior to compiling: |
| 80 | |||
| 81 | ``` | 71 | ``` |
| 82 | //#define DONT_REVIVE_DEADKEYS 1 | 72 | //#define DONT_REVIVE_DEADKEYS 1 |
| 83 | ``` | 73 | ``` |
| 84 | 74 | ||
| 85 | ##Layers | 75 | ##Layers |
| 86 | |||
| 87 | ###Base Layer | 76 | ###Base Layer |
| 88 | |||
| 89 | The base layer is shown here for ANSI keysm, HHKB-style right shift and split backspace. If you use a 2U backspace key there, `Del` will not be available. | 77 | The base layer is shown here for ANSI keysm, HHKB-style right shift and split backspace. If you use a 2U backspace key there, `Del` will not be available. |
| 90 | Again, the Y and Z keys are swapped, so you get the QWERTZ-positions of Y and Z when using the US-International layout. | 78 | Again, the Y and Z keys are swapped, so you get the QWERTZ-positions of Y and Z when using the US-International layout. |
| 91 | 79 | ||
| 92 |  | 80 |  |
| 93 | 81 | ||
| 94 | ###Gaming layer | 82 | ###Gaming layer |
| 95 | |||
| 96 | To turn this layer on, please use the combination `Fn+RShift`, not `Space+RShift`. If you do the latter, the Function layer will become stuck. You can press `Fn` once to unstick it if this happens to you. A solution is being worked on. | 83 | To turn this layer on, please use the combination `Fn+RShift`, not `Space+RShift`. If you do the latter, the Function layer will become stuck. You can press `Fn` once to unstick it if this happens to you. A solution is being worked on. |
| 97 | 84 | ||
| 98 |  | 85 |  |
| 99 | 86 | ||
| 100 | ###Function Layer | 87 | ###Function Layer |
| 101 | |||
| 102 | This is the function layer for German diacritics. It can be accessed via the `Fn` or by holding `Space` on the base layer. | 88 | This is the function layer for German diacritics. It can be accessed via the `Fn` or by holding `Space` on the base layer. |
| 103 | 89 | ||
| 104 |  | 90 |  |
diff --git a/keyboards/s60-x/readme.md b/keyboards/s60-x/readme.md index 4bba4b68f..0c4dc10f8 100644 --- a/keyboards/s60-x/readme.md +++ b/keyboards/s60-x/readme.md | |||
| @@ -251,3 +251,10 @@ The custom keymap is where I tested all the switches, not being concerned with a | |||
| 251 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | 251 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ |
| 252 | │Ctrl │ Gui │ Alt │█████│█████│█████│Space│█████│█████│█████│ Alt │ Gui │ App │Ctrl │█████│ | 252 | │Ctrl │ Gui │ Alt │█████│█████│█████│Space│█████│█████│█████│ Alt │ Gui │ App │Ctrl │█████│ |
| 253 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ | 253 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ |
| 254 | |||
| 255 | ### 9. [ANSI_QWERTZ](keymap/ansi_qwertz/keymap.c) | ||
| 256 | |||
| 257 | This keymap was designed for inputting characters with diacritics with ANSI keycaps. | ||
| 258 | It provides toggleable SpaceFn functionality, a dedicated arrow cluster and a microphone mute key on the function layer as well as a bootloader reset key. | ||
| 259 | |||
| 260 | For more info, [check here](keymap/ansi_qwertz). \ No newline at end of file | ||
