Minor documentation changes
This commit is contained in:
Felix Uhl
parent
c5f13e5836
commit
738151d12a
|
|
@ -1,27 +1,26 @@
|
|||
# ANSI_QWERTZ
|
||||
|
||||
[Click here to go to the layers directly.](readme.md#layers)
|
||||
[Click here to go to the layers directly.](readme.md#1.0-layers)
|
||||
|
||||
This keymap was specifically designed to support keycaps with ANSI layout and legends, while retaining the possibility of inputting characters
|
||||
with diacritics that are normally not used in the english language.
|
||||
|
||||
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.
|
||||
|
||||
##Features
|
||||
|
||||
##0. Features
|
||||
* Input of letters with diacritics on familiar QWERTZ layout
|
||||
* Support for ANSI-legend keycaps
|
||||
* Option to "revive" all dead keys
|
||||
* Dedicated arrow cluster
|
||||
* SpaceFN for easy access to Function keys and diacritic input
|
||||
* Locking "Gaming Mode" that disables SpaceFN and allows to bind GUI key in Games
|
||||
* Reset key binding, no need to press hardware reset button to program
|
||||
* Microphone Mute key (requires 3rd-party software, see below)
|
||||
|
||||
###Languages
|
||||
|
||||
###0.0 Languages
|
||||
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.
|
||||
All diacritic characters are input by either holding `Space` or `Fn` and pressing the corresponding key. For languages that aren't yet supported explicitly,
|
||||
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).
|
||||
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).
|
||||
|
||||
The illustration below shows the "US International" layout available in the Language settings of Windows, Linux and Mac OS.
|
||||
|
||||
|
|
@ -32,73 +31,60 @@ which contains more dead keys to input pretty much every diacritic character in
|
|||
|
||||
|
||||
|
||||
####Explicitly Supported Languages
|
||||
|
||||
####0.0.0 Explicitly Supported Languages
|
||||
* German
|
||||
|
||||
####Implicitly Supported Languages
|
||||
|
||||
####0.0.1 Implicitly Supported Languages
|
||||
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.
|
||||
|
||||
* French
|
||||
|
||||
###SpaceFN
|
||||
|
||||
###0.1 SpaceFN
|
||||
SpaceFN basically means that `Space` acts as a normal spacebar when tapped, but acts as a layer-key when held down.
|
||||
This means that you can't hold space to output multiple spaces consecutively and that space only registers once released.
|
||||
The advantage is that the spacebar is easier to reach than any other `Fn`-key could be.
|
||||
|
||||
###"Gaming Mode"
|
||||
|
||||
###0.2 "Gaming Mode"
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
|
||||
###Mute Microphone
|
||||
|
||||
###0.3 Mute Microphone
|
||||
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,
|
||||
you need to set this up in software before using it, see below. This key is bound to `RCtrl+LCtrl`, a keycombination that
|
||||
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.
|
||||
|
||||
####Linux
|
||||
|
||||
####0.3.0 Linux
|
||||
Follow [these instructions](http://askubuntu.com/a/13364).
|
||||
|
||||
#####Windows (Requires 3rd Party Software)
|
||||
|
||||
#####0.3.1 Windows (Requires 3rd Party Software)
|
||||
*DISCLAIMER: I take no responsibility for any potential harm caused by third party applications!*
|
||||
|
||||
You'll need a utility called "MicMute". It is available on [Sourceforge](https://sourceforge.net/projects/micmute/).
|
||||
After installing and running the tool, you only need to use the "Setup Shortcut" option to bind the key to muting the microphone
|
||||
and check whether your microphone is selected under "Devices".
|
||||
|
||||
###Revive Dead Keys
|
||||
|
||||
###0.4 Revive Dead Keys
|
||||
Some diacritics that are commonly used are dead keys on the international layouts, for example `` ` ``, `'`, or `"`.
|
||||
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.
|
||||
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.
|
||||
If you don't want this to be the case, uncomment the following line in `keymap.c` prior to compiling:
|
||||
|
||||
```
|
||||
//#define DONT_REVIVE_DEADKEYS 1
|
||||
```
|
||||
|
||||
##Layers
|
||||
|
||||
###Base Layer
|
||||
|
||||
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.
|
||||
Again, the Y and Z keys are swapped, so you get the QWERTZ-positions of Y and Z when using the US-International layout.
|
||||
|
||||
|
||||
|
||||
###Gaming layer
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
###Function Layer
|
||||
|
||||
This is the function layer for German diacritics. It can be accessed via the `Fn` or by holding `Space` on the base layer.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -251,3 +251,10 @@ The custom keymap is where I tested all the switches, not being concerned with a
|
|||
├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
|
||||
│Ctrl │ Gui │ Alt │█████│█████│█████│Space│█████│█████│█████│ Alt │ Gui │ App │Ctrl │█████│
|
||||
└─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
|
||||
|
||||
### 9. [ANSI_QWERTZ](keymap/ansi_qwertz/keymap.c)
|
||||
|
||||
This keymap was designed for inputting characters with diacritics with ANSI keycaps.
|
||||
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.
|
||||
|
||||
For more info, [check here](keymap/ansi_qwertz).
|
||||
Loading…
Reference in New Issue