[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/which-key 5cec113 10/51: Announce which-key-manual-upda
From: |
Stefan Monnier |
Subject: |
[elpa] externals/which-key 5cec113 10/51: Announce which-key-manual-update |
Date: |
Tue, 8 Sep 2020 10:26:16 -0400 (EDT) |
branch: externals/which-key
commit 5cec1133cff535708feda43b8f6daa4dccbc28a2
Author: Justin Burkett <justin@burkett.cc>
Commit: Justin Burkett <justin@burkett.cc>
Announce which-key-manual-update
---
README.org | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index 4991566..c9992da 100644
--- a/README.org
+++ b/README.org
@@ -3,6 +3,10 @@
** Recent Changes
+*** 2019-07-31: Added =which-key-manual-update=
+ Allows one to trigger =which-key= on demand, rather than automatically. See
+ the docstring and [[#manual-activation][Manual Activation]].
+
*** 2017-12-13: Added =which-key-enable-extended-define-key=
Allows for a concise syntax to specify replacement text using =define-key=
or alternatives that use =define-key= internally. See the docstring and
@@ -24,6 +28,7 @@
** Table of Contents :TOC_3:
- [[#which-key][which-key]]
- [[#recent-changes][Recent Changes]]
+ - [[#2019-07-31-added-which-key-manual-update][2019-07-31: Added
=which-key-manual-update=]]
- [[#2017-12-13-added-which-key-enable-extended-define-key][2017-12-13:
Added =which-key-enable-extended-define-key=]]
- [[#2017-11-13-added-which-key-show-major-mode][2017-11-13: Added
=which-key-show-major-mode=]]
- [[#introduction][Introduction]]
@@ -35,6 +40,7 @@
- [[#side-window-right-option][Side Window Right Option]]
- [[#side-window-right-then-bottom][Side Window Right then Bottom]]
- [[#minibuffer-option][Minibuffer Option]]
+ - [[#manual-activation][Manual Activation]]
- [[#additional-commands][Additional Commands]]
- [[#special-features-and-configuration-options][Special Features and
Configuration Options]]
- [[#popup-type-options][Popup Type Options]]
@@ -129,7 +135,23 @@
variable =max-mini-window-height=. Also, the paging commands do not work
reliably with the minibuffer option. Use the side window on the bottom
option if you need paging.
-
+
+** Manual Activation
+ #+NAME: #manual-activation
+ If you only want the =which-key= popup when you need it, you can try a setup
+ along the following lines
+
+ #+BEGIN_SRC emacs-lisp
+ ;; make sure which-key doesn't show normally
+ (setq which-key-idle-delay 1000)
+ (which-key-mode)
+ (setq prefix-help-command 'which-key-manual-update)
+ #+END_SRC
+
+ This will prevent which-key from showing automatically, and allow you to use
+ =C-h= in the middle of a key sequence to show the =which-key= buffer and
keep
+ it open for the remainder of the key sequence.
+
** Additional Commands
- =which-key-show-top-level= will show most key bindings without a prefix.
It
is most and not all, because many are probably not interesting to most
- [elpa] externals/which-key a256c4b 13/51: Use which-key-idle-secondary-delay value in manual updates, (continued)
- [elpa] externals/which-key a256c4b 13/51: Use which-key-idle-secondary-delay value in manual updates, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key a916c9a 15/51: Fix typos (#222), Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 45bfcd3 22/51: Make which-key-show prefix mode-line work like top and bottom, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 1231016 29/51: More workflow fixes, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 7bc87e0 41/51: Test once a month, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key ebb4e92 47/51: Add which-key-add-keymap-based-replacements, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key e048b2a 48/51: Stop testing against v24.5, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key d794c4a 51/51: Improve keymap-based-replacement description in README, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key cf8572a 07/51: which-key-persistent-popup-p -> which-key-persistent-popup, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 8554a9f 17/51: Generalize C-h commands to use help-char, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 5cec113 10/51: Announce which-key-manual-update,
Stefan Monnier <=
- [elpa] externals/which-key dcb9820 16/51: Default to imprecise window fitting on terminal, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key e554326 49/51: Remove testing badge from README, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key db3d003 21/51: Add full keymap versions of show-{major, minor}-mode, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 8b49ae9 42/51: Fix last commit, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key b11227b 23/51: Strip out advice in command docstrings, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 9ff54ff 37/51: Fix short windows being resized, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 9550707 40/51: Merge remote-tracking branch 'hlissner/patch-1', Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 3642c11 45/51: Speed up which-key--maybe-replace, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key da1abb4 27/51: Fix previous commit, Stefan Monnier, 2020/09/08
- [elpa] externals/which-key 2b10b8e 50/51: Remove use of focus-{in, out}-hook, Stefan Monnier, 2020/09/08