| commit | author | age | ||
| 5cb5f7 | 1 | Overview |
| C | 2 | ======== |
| 3 | This library provides minor mode `volatile-highlights-mode', which | |
| 4 | brings visual feedback to some operations by highlighting portions | |
| 5 | relating to the operations. | |
| 6 | ||
| 7 | All of highlights made by this library will be removed | |
| 8 | when any new operation is executed. | |
| 9 | ||
| 10 | ||
| 11 | INSTALLING | |
| 12 | ========== | |
| 13 | To install this library, save this file to a directory in your | |
| 14 | `load-path' (you can view the current `load-path' using "C-h v | |
| 15 | load-path" within Emacs), then add the following line to your | |
| 16 | .emacs start up file: | |
| 17 | ||
| 18 | (require 'volatile-highlights) | |
| 19 | (volatile-highlights-mode t) | |
| 20 | ||
| 21 | ||
| 22 | USING | |
| 23 | ===== | |
| 24 | To toggle volatile highlighting, type `M-x volatile-highlights-mode <RET>'. | |
| 25 | ||
| 26 | While this minor mode is on, a string `VHL' will be displayed on the modeline. | |
| 27 | ||
| 28 | Currently, operations listed below will be highlighted While the minor mode | |
| 29 | `volatile-highlights-mode' is on: | |
| 30 | ||
| 31 | - `undo': | |
| 32 | Volatile highlights will be put on the text inserted by `undo'. | |
| 33 | ||
| 34 | - `yank' and `yank-pop': | |
| 35 | Volatile highlights will be put on the text inserted by `yank' | |
| 36 | or `yank-pop'. | |
| 37 | ||
| 38 | - `kill-region', `kill-line', any other killing function: | |
| 39 | Volatile highlights will be put at the positions where the | |
| 40 | killed text used to be. | |
| 41 | ||
| 42 | - `delete-region': | |
| 43 | Same as `kill-region', but not as reliable since | |
| 44 | `delete-region' is an inline function. | |
| 45 | ||
| 46 | - `find-tag': | |
| 47 | Volatile highlights will be put on the tag name which was found | |
| 48 | by `find-tag'. | |
| 49 | ||
| 50 | - `occur-mode-goto-occurrence' and `occur-mode-display-occurrence': | |
| 51 | Volatile highlights will be put on the occurrence which is selected | |
| 52 | by `occur-mode-goto-occurrence' or `occur-mode-display-occurrence'. | |
| 53 | ||
| 54 | - Non incremental search operations: | |
| 55 | Volatile highlights will be put on the the text found by | |
| 56 | commands listed below: | |
| 57 | ||
| 58 | `nonincremental-search-forward' | |
| 59 | `nonincremental-search-backward' | |
| 60 | `nonincremental-re-search-forward' | |
| 61 | `nonincremental-re-search-backward' | |
| 62 | `nonincremental-repeat-search-forward' | |
| 63 | `nonincremental-repeat-search-backwar' | |
| 64 | ||
| 65 | Highlighting support for each operations can be turned on/off individually | |
| 66 | via customization. Also check out the customization group | |
| 67 | ||
| 68 | `M-x customize-group RET volatile-highlights RET' | |
| 69 | ||
| 70 | ||
| 71 | EXAMPLE SNIPPETS FOR USING VOLATILE HIGHLIGHTS WITH OTHER PACKAGES | |
| 72 | ================================================================== | |
| 73 | ||
| 74 | - vip-mode | |
| 75 | ||
| 76 | (vhl/define-extension 'vip 'vip-yank) | |
| 77 | (vhl/install-extension 'vip) | |
| 78 | ||
| 79 | - evil-mode | |
| 80 | ||
| 81 | (vhl/define-extension 'evil 'evil-paste-after 'evil-paste-before | |
| 82 | 'evil-paste-pop 'evil-move) | |
| 83 | (vhl/install-extension 'evil) | |
| 84 | ||
| 85 | - undo-tree | |
| 86 | ||
| 87 | (vhl/define-extension 'undo-tree 'undo-tree-yank 'undo-tree-move) | |
| 88 | (vhl/install-extension 'undo-tree) | |
