Help Configuration

Helpful
Popper
- Popper Buffers
Which-key
- Activating Which-key
  - C-h During Key Combination Entry
  - Press <f4> in Any Mode
- Which-key Window Location
End

Helpful

Helpful improves the Emacs help functions by adding new features to the *Help* buffers such as:

Links to source code
Better formatting of docstrings
Lists of callers
Keymaps
Aliases
And more…

(use-package helpful
  :straight t
  :defer t
  :bind
  ("C-h f" . #'helpful-callable)
  ("C-h v" . #'helpful-variable)
  ("C-h k" . #'helpful-key)
  ("C-c C-d" . #'helpful-at-point)
  ("C-h F" . #'helpful-function)
  ("C-h C" . #'helpful-command))

Popper

Popper lets a user define any window as a short-term pop up window.

(use-package popper
  :straight t
  :bind (("C-`"   . popper-toggle-latest)
         ("M-`"   . popper-cycle)
         ("C-M-`" . popper-toggle-type))
  :init
  (setq popper-reference-buffers
          '("\\*Messages\\*"
            "\\*Embark Actions\\*"
            "Output\\*$"
            "\\*Async Shell Command\\*"
            "\\*Whicher Report\\*"
            help-mode
            compilation-mode))
  (popper-mode +1)
  (popper-echo-mode +1))

Popper Buffers

For each buffer that will become a popper pop up buffer, it must be defined below:

(setq popper-reference-buffers
        '("\\*Messages\\*"
          "\\*Embark Actions\\*"
          "Output\\*$"
          "\\*Async Shell Command\\*"
          "\\*Whicher Report\\*"
          help-mode
          compilation-mode))

Which-key

Which-key provides a pop-up menu when there is a pause in the minibuffer or if executed directly to show the keyboard commands available to the current buffer.

(use-package which-key
  :straight t
  :defer 3
  :custom
  (which-key-show-early-on-C-h t)
  :config
  (global-set-key (kbd "<f4>") 'which-key-show-major-mode)
  (which-key-setup-side-window-right-bottom)
  (which-key-mode))

Activating Which-key

How to start which-key

C-h During Key Combination Entry

Type C-h during any key combination to pop-up which key

(which-key-show-early-on-C-h t)

Press <f4> in Any Mode

Use the <f4> key in any major mode to see the key bindings

(global-set-key (kbd "<f4>") 'which-key-show-major-mode)

Which-key Window Location

Set up which-key to use the side window preferably

(which-key-setup-side-window-right-bottom)

End

(provide 'freemacs-help)

;;; freemacs-help.el ends here