emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(:input): update READMEs to new format

Browse source
This commit is contained in:
Henrik Lissner 2021-10-16 01:27:36 +02:00 • committed by Henrik Lissner
parent 2dcef764f1
commit ca7579a1e9
4 changed files with 206 additions and 159 deletions
Download patch file Download diff file Expand all files Collapse all files

9
modules/input/README.org Normal file
View file

@ -0,0 +1,9 @@
← [[doom-module-index:][Back to module index]] ↖ [[doom-module-source:input][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :input
#+CREATED: May 13, 2019
#+SINCE: 2.0.9
* Description
Modules in this category extend Emacs support for additional keyboard layouts
and input methods for non-English languages.

84
modules/input/chinese/README.org
View file

@ -1,51 +1,67 @@
#+TITLE: input/chinese ← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::input chinese][Issues]] ↖ [[doom-module-source:input/chinese][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
#+DATE: May 13, 2019 --------------------------------------------------------------------------------
#+SINCE: 2.1 #+TITLE: :input chinese
#+STARTUP: inlineimages #+SUBTITLE: Spend your 3 hours a week in Emacs
#+CREATED: May 13, 2019
#+SINCE: 21.12.0
* Table of Contents :TOC_3:noexport: * Description :unfold:
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#using-fcitx5][Using fcitx5]]
- [[#troubleshooting][Troubleshooting]]
* Description
This module adds support for traditional Chinese script by introducing two input This module adds support for traditional Chinese script by introducing two input
methods: Pinyin and Wubi. methods: Pinyin and Wubi.
#+begin_quote ** Maintainers
Because I am unable to personally test this module, help to improve this module *This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
would be greatly appreciated! Especially where performance is concerned.
#+end_quote
** Module Flags ** Module flags
This module provides no flags. /This module has no flags./
** Plugins ** Packages
+ [[https://github.com/tumashu/pyim][pyim]] (unless =+wubi=) - [[doom-package:][ace-pinyin]]
+ [[https://github.com/zilongshanren/chinese-wbim][chinese-wbim]] (if =+wubi=) - [[doom-package:][chinese-wbim]] if [[doom-module:][+wubi]]
+ [[https://github.com/cute-jumper/fcitx.el][fcitx]] - [[doom-package:][fcitx]]
+ [[https://github.com/cute-jumper/ace-pinyin][ace-pinyin]] - [[doom-package:][pangu-spacing]]
+ [[https://github.com/coldnew/pangu-spacing][pangu-spacing]] - [[doom-package:][pyim]] unless [[doom-module:][+wubi]]
** Hacks ** Hacks
+ ~org-html-paragraph~ has been modified to join consecutive Chinese lines into - ~org-html-paragraph~ has been modified to join consecutive Chinese lines into
a single long line without wanted spaced (when exporting org-mode to html). a single long line without wanted spaced (when exporting org-mode to html).
* TODO Prerequisites ** TODO Changelog
* TODO Features # This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
* TODO Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
#+begin_quote
🔨 This module is missing install instructions. [[doom-contrib-module:][Write some?]]
#+end_quote
* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* TODO Configuration * TODO Configuration
#+begin_quote
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote
** Using fcitx5 ** Using fcitx5
Modify ~fcitx-remote-command~ to change the default: Modify ~fcitx-remote-command~ to change the default:
#+BEGIN_SRC elisp #+begin_src emacs-lisp
;; in $DOOMDIR/config.el ;; in $DOOMDIR/config.el
(setq fcitx-remote-command "fcitx5-remote") (setq fcitx-remote-command "fcitx5-remote")
#+END_SRC #+end_src
* TODO Troubleshooting * Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote

78
modules/input/japanese/README.org
View file

@ -1,43 +1,57 @@
#+TITLE: input/japanese ← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::input japanese][Issues]] ↖ [[doom-module-source:input/japanese][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
#+DATE: May 13, 2019 --------------------------------------------------------------------------------
#+TITLE: :input japanese
#+SUBTITLE: Ah, a man of culture
#+CREATED: May 13, 2019
#+SINCE: 2.1 #+SINCE: 2.1
#+STARTUP: inlineimages
* Table of Contents :TOC_3:noexport: * Description :unfold:
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]
* Description
This module adds support for Japanese script. This module adds support for Japanese script.
#+begin_quote ** Maintainers
Because I am unable to personally test this module, help to improve this module *This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
would be greatly appreciated! Especially where performance is concerned.
#+end_quote
** Module Flags ** Module flags
This module provides no flags. /This module has no flags./
** Plugins ** Packages
+ [[https://github.com/emacs-jp/migemo][migemo]] - [[doom-package:][avy-migemo]]
+ [[https://github.com/momomo5717/avy-migemo][avy-migemo]] - [[doom-package:][ddskk]]
+ [[https://github.com/hsaito/ddskk][ddskk]] - [[doom-package:][migemo]]
+ [[https://github.com/coldnew/pangu-spacing][pangu-spacing]] - [[doom-package:][pangu-spacing]]
** Hacks ** Hacks
+ ~org-html-paragraph~ has been modified to join consecutive Chinese lines into - ~org-html-paragraph~ has been modified to join consecutive Chinese lines into
a single long line without wanted spaced (when exporting org-mode to html). a single long line without wanted spaced (when exporting org-mode to html).
* TODO Prerequisites ** TODO Changelog
+ For incremental search with Migemo, one of the following is required: # This section will be machine generated. Don't edit it by hand.
+ [[https://github.com/koron/cmigemo][cmigemo]], which is recommended, or /This module does not have a changelog yet./
+ [[http://0xcc.net/migemo/][CVS Head Migemo]]
* TODO Features * TODO Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
- For incremental search with Migemo, one of the following is required:
- [[https://github.com/koron/cmigemo][cmigemo]] (recommended)
- or [[http://0xcc.net/migemo/][CVS Head Migemo]]
* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* TODO Configuration * TODO Configuration
* TODO Troubleshooting #+begin_quote
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote

192
modules/input/layout/README.org
View file

@ -1,140 +1,140 @@
#+TITLE: input/layout ← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::input layout][Issues]] ↖ [[doom-module-source:input/layout][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
#+DATE: Jun 29, 2020 --------------------------------------------------------------------------------
#+SINCE: v3.0 #+TITLE: :input layout
#+STARTUP: inlineimages nofold #+SUBTITLE: auie,ctsrnm is the superior home row
#+CREATED: Jun 29, 2020
#+SINCE: 21.12.0
* Table of Contents :TOC_3:noexport: * Description :unfold:
- [[#description][Description]] This module provides barebones support for using Doom with non-qwerty keyboard
- [[#maintainers][Maintainers]] layouts.
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#bépo][Bépo]]
- [[#easymotion][Easymotion]]
- [[#leaving-mnemonics-alone-when-possible][Leaving mnemonics alone when possible]]
- [[#possible-contributions][Possible contributions]]
- [[#org-mode][Org-mode]]
- [[#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 ?]]
* Description
This module provides barebones support for using Doom with non-qwerty layouts.
** Maintainers ** Maintainers
+ @gagbo (Author, Bépo) - [[doom-user:][@gagbo]] ([[kbd:][+bepo]])
** Module Flags [[doom-contrib-maintainer:][Become a maintainer?]]
+ =+azerty= Remaps keybinds to accommodate the
[[https://en.wikipedia.org/wiki/AZERTY][Azerty keyboard layout]].
+ =+bepo= Remaps keybinds to accommodate the
[[https://en.wikipedia.org/wiki/B%C3%89PO][BÉPO keyboard layout]] (version
1.1, in particualr).
** Plugins ** Module flags
None - +azerty ::
Remap keybinds to accommodate the [[https://en.wikipedia.org/wiki/AZERTY][Azerty keyboard layout]].
- +bepo ::
Remap keybinds to accommodate the [[https://en.wikipedia.org/wiki/B%C3%89PO][BÉPO keyboard layout]] (version 1.1, in
particular).
* Prerequisites ** Packages
If you are using =:editor evil=, you should use =(evil +everywhere)=, as the /This module doesn't install any packages./
module uses =evil-collection= utilities to do the remapping.
If you are not using =:editor evil=, then you have nothing to do. ** TODO Hacks
#+begin_quote
🔨 This module's hacks haven't been documented yet. [[doom-contrib-module:][Document them?]]
#+end_quote
** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
/This module has no external requirements./
* TODO Usage
#+begin_quote
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote
* Features
# An in-depth list of features, how to use them, and their dependencies.
** Bépo ** Bépo
Support for the bépo layout includes: Support for the bépo layout includes:
- Setting Avy keys to the correct home row keys - Setting Avy keys to the correct home row keys
- Changing navigation keys to =ctsr= - Changing navigation keys to [[kbd:][c]], [[kbd:][t]], [[kbd:][s]], and [[kbd:][r]]
+ old =t= is mapped to =j= + old [[kbd:][t]] is mapped to [[kbd:][j]]
+ old =s= is mapped to =k= (i.e. staging in the magit status buffer is done + old [[kbd:][s]] is mapped to [[kbd:][k]] (i.e. staging in the magit status buffer is done with
with =k=) [[kbd:][k]])
+ See [[*Configuration][Configuration]] to see where old =c= and =r= functions + See [[*Configuration][Configuration]] to see where old [[kbd:][c]] and [[kbd:][r]] functions
are remapped are remapped
- Bind =<>= functions to =«»= keys when possible - Bind [[kbd:][<>]] functions to [[kbd:][«»]] keys when possible
- Bind =[]= functions to =()= keys when possible (the "unimpaired-like" - Bind [[kbd:][[]]] functions to [[kbd:][()]] keys when possible (the "unimpaired-like" bindings)
bindings) - Bind [[kbd:][é]] key to [[kbd:][w]] functions when possible
- Bind =é= key to =w= functions when possible - Bind [[kbd:][è]] key to useful functions when possible
- Bind =è= key to useful functions when possible - Bind [[kbd:][`~]] functions to [[kbd:][$#]] keys when possible
- Bind =`~= functions to =$#= keys when possible
*** Easymotion *** Easymotion
If you use =evil-easymotion=, then all the bindings that were on =gs= have been If you use [[doom-package:][evil-easymotion]], then all the bindings that were on [[kbd:][gs]] have been
moved to =gé=. moved to [[kbd:][gé]].
In short : =g s j= -> =g é t= (evilem-motion-next-line). And so on. In short : [[kbd:][g s j]] -> [[kbd:][g é t]] (~evilem-motion-next-line~). And so on.
*** Leaving mnemonics alone when possible *** Leaving mnemonics alone when possible
Exchanging =hjkl= to =ctsr= has the effect of destroying a few mnemonics: the Exchanging [[kbd:][h]]/[[kbd:][j]]/[[kbd:][k]]/[[kbd:][l]] to [[kbd:][c]]/[[kbd:][t]]/[[kbd:][s]]/[[kbd:][r]] has the effect of destroying a few mnemonics: the
change operator becomes =l= for example, or the window split becomes =SPC é k=. change operator becomes [[kbd:][l]] for example, or the window split becomes [[kbd:][SPC é k]].
The module tries to limit those changes to the minimum, especially in special The module tries to limit those changes to the minimum, especially in special
buffers. A concrete example is magit. buffers. A concrete example is magit.
As the =magit: project= buffer (obtained with =magit-status=) does not need As the =magit: project= buffer (obtained with ~M-x magit-status~) does not need
left-right navigation, keys =c=, =r=, =h=, and =l= keep their "expected" bindings, left-right navigation, keys [[kbd:][c]], [[kbd:][r]], [[kbd:][h]], and [[kbd:][l]] keep their "expected" bindings, while
while =t=, =s=, =j=, and =k= are flipped: [[kbd:][t]], [[kbd:][s]], [[kbd:][j]], and [[kbd:][k]] are flipped:
- checking the log from a magit buffer is still on =l= - checking the log from a magit buffer is still on [[kbd:][l]]
- staging a file/region has been moved to =k= - staging a file/region has been moved to [[kbd:][k]]
*** Possible contributions *** Possible contributions
**** Avoid =g= and =z= to be used too often **** Avoid [[kbd:][g]] and [[kbd:][z]] to be used too often
A nice addition in the future might be to have all the normal mode bindings that A nice addition in the future might be to have all the normal mode bindings that
start with =g= start with =,= instead to avoid the curl on these common start with [[kbd:][g]] start with [[kbd:][,]] instead to avoid the curl on these common bindings.
bindings. This is *not* implemented for the time being. This is *not* implemented for the time being.
The same thing could be done to =z=, potentially using =à= instead. The same thing could be done to [[kbd:][z]], potentially using [[kbd:][à]] instead.
**** Proper minor mode **** Proper minor mode
Also, implementing all those changes as a minor we could flip on and off would Also, implementing all those changes as a minor we could flip on and off would
help with adoption help with adoption
**** Put "word" text objects to é instead of w **** Put "word" text objects to é instead of w
"inside word" and "around word" are =iw= and =aw=, which use the very poorly "inside word" and "around word" are [[kbd:][iw]] and [[kbd:][aw]], which use the very poorly rated [[kbd:][w]]
rated =w= key in the bépo layout. Finding a way to use =é= or even =è= more for key in the bépo layout. Finding a way to use [[kbd:][é]] or even [[kbd:][è]] more for these would be
these would be a welcome change a welcome change
*** Org-mode *** Org-mode
=evil-org= allows to define =evil-org-movement-bindings= to automatically map [[doom-package:][evil-org]] allows to define ~evil-org-movement-bindings~ to automatically map
movement bindings on non-hjkl keys. It maps automatically keys to =C-c= and movement bindings on non-hjkl keys. It maps automatically keys to [[kbd:][C-c]] and [[kbd:][C-r]] in
=C-r= in normal and insert states though, and it's not really user friendly in normal and insert states though, and it's not really user friendly in Emacs to
Emacs to remap those. remap those.
Therefore, in org-mode: Therefore, in ~org-mode~:
- =org-shiftright= is bound to =C-»= - ~org-shiftright~ is bound to [[kbd:][C-»]]
- =org-shiftleft= is bound to =C-«= - ~org-shiftleft~ is bound to [[kbd:][C-«]]
* TODO Configuration
#+begin_quote
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote
* Configuration
** Bépo ** Bépo
=+layout-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 - =qwerty-c= functions are mapped on =bépo-l= key, and =qwerty-r= functions on
=bépo-h= key (='ergodis=), or =bépo-h= key (~'ergodis~), or
- =qwerty-c= functions are mapped on =bépo-h= key, and =qwerty-r= functions on - =qwerty-c= functions are mapped on =bépo-h= key, and =qwerty-r= functions on
=bépo-l= key (='strict=) =bépo-l= key (~'strict~)
='strict= would be the logical choice but the =c= functions are used more often ~'strict~ would be the logical choice but the [[kbd:][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 than the [[kbd:][r]] ones so [[https://bepo.fr/wiki/Vim#Principe][Ergodis]] advises to actually put all the [[kbd:][c]] functions on the
the key that does not need a curl. key that does not need a curl.
* Troubleshooting * Troubleshooting
# Common issues and their solution, or places to look for help. [[doom-report:][Report an issue?]]
** Outstanding issues (contributions welcome) ** Outstanding issues (contributions welcome)
*** Bépo *** Bépo
- in eshell, the key `c` is still bound to - In [[doom-package:][eshell]], the key [[kbd:][c]] is still bound to ~evil-collection-eshell-evil-change~ in
`evil-collection-eshell-evil-change` in normal mode normal mode.
** How to investigate an issue ? ** How to investigate an issue ?
If a key is misbehaving, use =describe-key= (=C-h k= or =SPC h k= or =F1 k=) to If a key is misbehaving, use ~M-x describe-key~ ([[kbd:][C-h k]] or [[kbd:][SPC h k]] or [[kbd:][F1 k]]) to
see the functions bound to the key, and more importantly in which map it is see the command bound to the key, and more importantly in which keymap it is
bound. bound.
You should ignore all =evil-collection-...-backup-map= keymaps, as they are You should ignore all ~evil-collection-*-backup-map~ keymaps, as they are
artifacts from =evil-collection-translate-key= and those maps are actually not artifacts from ~evil-collection-translate-key~ and those maps are actually not
active. active.
Most likely the solution is to call one of the "key rotation" functions on the Most likely the solution is to call one of the "key rotation" functions on the
@ -142,8 +142,16 @@ relevant keymaps.
** 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 ?
If you are learning a new layout you might want to go back to tho old one to 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 "get work done". Sadly the only way is to comment out the module, run ~$ doom
sync= and restart emacs. sync~ and restart emacs.
Restoring the session =SPC q l= by default helps to lower the impact of the Restoring the session [[kbd:][SPC q l]] by default helps to lower the impact of the
restart. restart.
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote