File: help-at-pt.el.html
This file contains functionality to make the help provided by the
help-echo text or overlay property available to the keyboard user.
It also supports a more keyboard oriented alternative to
help-echo, namely a new text or overlay property kbd-help.
It provides facilities to access the local help available at point
either on demand, using the command display-local-help, or
automatically after a suitable idle time, through the customizable
variable help-at-pt-display-when-idle.
You can get a more global overview of the local help available in
the buffer, using the commands scan-buf-next-region and
scan-buf-previous-region, which move to the start of the next or
previous region with available local help and print the help found
there.
Suggested key bindings:
(keymap-global-set "C-<tab>" #'scan-buf-next-region)
(keymap-global-set "C-M-<tab>" #'scan-buf-previous-region)
Defined variables (4)
help-at-pt-display-when-idle | Automatically show local help on point-over. |
help-at-pt-timer | Non-nil means that a timer is set that checks for local help. |
help-at-pt-timer-delay | Delay before displaying local help. |
scan-buf-move-hook | Normal hook run by ‘scan-buf-next-region’. |
Defined functions (8)
display-local-help | (&optional INHIBIT-WARNING DESCRIBE-BUTTON) |
help-at-pt-cancel-timer | () |
help-at-pt-kbd-string | () |
help-at-pt-set-timer | () |
help-at-pt-string | (&optional KBD) |
scan-buf-move-to-region | (PROP &optional ARG HOOK) |
scan-buf-next-region | (&optional ARG) |
scan-buf-previous-region | (&optional ARG) |