input/layout: major refactor

To conform the module to Doom's naming and style conventions.

This introduces two breaking changes:

+ doom-bepo-cr-rotation-style was renamed +layout-bepo-cr-rotation-style
+ Replaces the doom-bepo- prefix for this module's bepo library with
  +layout-bepo-

And the following fixes:

+ Corrects the file path in file header comments.
+ input/layout/autoload/bepo.el is no longer compiled/indexed if +bepo
  isn't activated.
This commit is contained in:
Henrik Lissner 2021-05-01 00:56:08 -04:00
parent 4afdd4f788
commit 485381f6d1
4 changed files with 550 additions and 537 deletions

View file

@ -18,6 +18,8 @@
- [[#configuration][Configuration]]
- [[#bépo-1][Bépo]]
- [[#troubleshooting][Troubleshooting]]
- [[#outstanding-issues-contributions-welcome][Outstanding issues (contributions welcome)]]
- [[#bépo-2][Bépo]]
- [[#how-to-investigate-an-issue-][How to investigate an issue ?]]
- [[#how-to-deactivate-the-new-bindings-and-go-back-to-the-old-ones-][How to deactivate the new bindings and go back to the old ones ?]]
@ -58,7 +60,6 @@ Support for the bépo layout includes:
- Bind =`~= functions to =$#= keys when possible
*** Easymotion
If you use =evil-easymotion=, then all the bindings that were on =gs= have been
moved to =gé=.
@ -106,14 +107,15 @@ Therefore, in org-mode:
* Configuration
** Bépo
=doom-bepo-cr-rotation-style= controls whether:
=+layout-bepo-cr-rotation-style= controls whether:
- =qwerty-c= functions are mapped on =bépo-l= key, and =qwerty-r= functions on
=bépo-h= key (='ergodis=), or
- =qwerty-c= functions are mapped on =bépo-h= key, and =qwerty-r= functions on
=bépo-l= key (='strict=)
='strict= would be the logical choice but the =c= functions are used more often
than the =r= ones so [[https://bepo.fr/wiki/Vim#Principe][Ergodis]] advises to
actually put all the =c= functions on the key that does not need a curl.
than the =r= ones so [[https://bepo.fr/wiki/Vim#Principe][Ergodis]] advises to actually put all the =c= functions on
the key that does not need a curl.
* Troubleshooting
# Common issues and their solution, or places to look for help.
@ -121,6 +123,7 @@ actually put all the =c= functions on the key that does not need a curl.
*** Bépo
- in eshell, the key `c` is still bound to
`evil-collection-eshell-evil-change` in normal mode
** How to investigate an issue ?
If a key is misbehaving, use =describe-key= (=C-h k= or =SPC h k= or =F1 k=) to
see the functions bound to the key, and more importantly in which map it is
@ -132,6 +135,7 @@ active.
Most likely the solution is to call one of the "key rotation" functions on the
relevant keymaps.
** How to deactivate the new bindings and go back to the old ones ?
If you are learning a new layout you might want to go back to tho old one to
"get work done". Sadly the only way is to comment out the module, run =doom