From e37f949c76e01af76e398b01dd4f8cb8ca3ac419 Mon Sep 17 00:00:00 2001 From: Joschua Kesper Date: Fri, 27 Sep 2024 18:55:56 +0200 Subject: [PATCH 1/2] Added an faq entry for the mini-language Since this is a frequest point of confusion in issues (see below) I think this FAQ entry is justified even though it's just terminology used in issues (and a small part of the tutorial). Some examples of problems / instances where it would increase clarity: - #886 - #877 - #846 --- doc/faq.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/faq.md b/doc/faq.md index d15487a0..73be023f 100644 --- a/doc/faq.md +++ b/doc/faq.md @@ -14,6 +14,7 @@ - [Mac](#mac) - [Q: How to use the special features printed on Apple function keys?](#q-how-to-use-the-special-features-printed-on-apple-function-keys) - [General](#general) + - [Q: What does `Ta`, `Pa` and `Ra` stand for?](#q-what-does-ta-pa-and-ra-stand-for) - [Q: Why doesn't the 'Print' keycode work for my print screen button?](#q-why-doesnt-the-print-keycode-work-for-my-print-screen-button) - [Q: Why can't I remap the Fn key on my laptop?](#q-why-cant-i-remap-the-fn-key-on-my-laptop) - [Q: Why do some key combination not work?](#q-why-do-some-key-combination-not-work) @@ -199,6 +200,23 @@ example. ## General +### Q: What does `Ta`, `Pa` and `Ra` stand for? + +A: Those are part of a mini-language from the tutorial: + +- `Px` signifies the press of the button (or keycode) `x` +- `Rx` signifies the release of `x` +- `Tx` signifies the sequential and near instantaneous press and release of `x` +- `100` signifies 100ms passing without any action + +So for example when talking about buttons: + +- `Tesc Ta` is a tap of `Esc` and a press of `a` +- `P@a Tb R@a` is the alias `@a` pressed around the button `b` + +This language is useful since "tap" is normally a synonym for "press" +and this may lead to confusion in discussions and issues. + ### Q: Why doesn't the 'Print' keycode work for my print screen button? A: Because the keycode for "print screen" is actually 'SysReq' ("ssrq" or "sys") From b3e3c495b18c042b4b63c41f33c6a0044c9e9e1d Mon Sep 17 00:00:00 2001 From: Joschua Kesper Date: Fri, 27 Sep 2024 19:05:27 +0200 Subject: [PATCH 2/2] Added FAQ entry relating to os keymaps --- doc/faq.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/faq.md b/doc/faq.md index 73be023f..5c836e7c 100644 --- a/doc/faq.md +++ b/doc/faq.md @@ -14,6 +14,7 @@ - [Mac](#mac) - [Q: How to use the special features printed on Apple function keys?](#q-how-to-use-the-special-features-printed-on-apple-function-keys) - [General](#general) + - [Q: Why can't I remap certain (non US) buttons?](#q-why-cant-i-remap-certain-non-us-buttons) - [Q: What does `Ta`, `Pa` and `Ra` stand for?](#q-what-does-ta-pa-and-ra-stand-for) - [Q: Why doesn't the 'Print' keycode work for my print screen button?](#q-why-doesnt-the-print-keycode-work-for-my-print-screen-button) - [Q: Why can't I remap the Fn key on my laptop?](#q-why-cant-i-remap-the-fn-key-on-my-laptop) @@ -200,6 +201,18 @@ example. ## General +### Q: Why can't I remap certain (non US) buttons? + +KMonad works prior to your OS keymapping taking affect. +It also uses the names taken from the standard US qwerty layout. + +If you were for example looking to remap an `ΓΌ` on a german qwertz keyboard +you would specify the letter that would be there in qwerty (`[`). + +This is of course also true for buttons which are in a different place. +On the german layout the `+` is reached without shift, while on US qwerty it's +on `S-=`. This means it's also not a valid keycode to specify in your `defsrc`. + ### Q: What does `Ta`, `Pa` and `Ra` stand for? A: Those are part of a mini-language from the tutorial: