Improve `which-key-mode' usage and add notes.

This commit is contained in:
Gerard Vermeulen 2024-06-20 12:06:24 +02:00
parent 3013bafac1
commit b7ccd6e94f

View File

@ -223,12 +223,12 @@ of [[info:emacs#Saving Customizations][saving customizations (info)]].
lazy-count-prefix-format nil lazy-count-prefix-format nil
lazy-count-suffix-format " (%s/%s)" lazy-count-suffix-format " (%s/%s)"
lazy-highlight-initial-delay 1.0 lazy-highlight-initial-delay 1.0
max-mini-window-height 0.5 ; Prevent `which-key-mode' paging (try `C-x')!
mode-line-compact t mode-line-compact t
next-error-message-highlight t next-error-message-highlight t
recentf-max-saved-items 100 recentf-max-saved-items 100
recentf-mode t recentf-mode t
save-place-mode t save-place-mode t
savehist-additional-variables nil ; Docstring is not OK!
savehist-mode t savehist-mode t
scroll-bar-mode nil scroll-bar-mode nil
tab-always-indent 'complete tab-always-indent 'complete
@ -1030,9 +1030,18 @@ looks for files.
Table [[tab:basic-key-bindings]] lists basic key bindings. Enabling Table [[tab:basic-key-bindings]] lists basic key bindings. Enabling
=which-key-mode= is another way of associating key bindings with commands. =which-key-mode= is another way of associating key bindings with commands.
Execute src_emacs-lisp[:results none]{(find-library "which-key")} to check Execute src_emacs-lisp[:results none]{(find-library "which-key")} to check
whether this library is builtin. This setup does not enable =which-key-mode= whether this library is builtin. Notes:
because of rare interference with for instance a process that the =compile= 1. This setup does not enable =which-key-mode= because of rare interference with
command launches. for instance a process that the =compile= command launches.
2. ChatGPT bullshits on "How to page in =which-key-mode= on Emacs".
3. Execute src_emacs-lisp[:results none]{(setopt max-mini-window-height 0.5)} to
make =which-key-mode= display all keys without paging (try "C-x").
4. Execute src_emacs-lisp[:results none]{(which-key-setup-side-window-right)} to
*enable* =which-key= paging support (use fn-F1 on Darwin). Setting
=max-mini-window-height= is the easiest solution.
5. Execute src_emacs-lisp[:results none]{(which-key-setup-minibuffer)} to
*disable* =which-key= paging support (and display the first =which-key-mode=
page in the minibuffer).
#+attr_latex: :booktabs yes :float table #+attr_latex: :booktabs yes :float table
#+caption[Basic key bindings]: #+caption[Basic key bindings]: