add a bunch of emacs packages HELP

2 files changed, 155 insertions, 0 deletions

diff --git a/.config/emacs/lisp/evil-collection/modes/outline/README.org b/.config/emacs/lisp/evil-collection/modes/outline/README.org
new file mode 100644
index 0000000..e79174b
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/outline/README.org
@@ -0,0 +1,39 @@
+* outline
+
+  Evil bindings for [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html][outline-mode]].
+
+  Folding sticks to Evil's =z= namespace, augmenting the defaults =zO=, =za=,
+  =zc=, =zm=, =zo=, =zr= with outline-specific commands.
+
+** Key bindings
+
+   Bindings applied to =outline-mode-map= in normal state.
+
+   | Command                            | Original  | Evil               |
+   |------------------------------------+-----------+--------------------|
+   | =outline-hide-body=                | =C-c C-t= | =zB=               |
+   | =outline-hide-entry=               | =C-c C-c= | =zE=               |
+   | =outline-show-entry=               | =C-c C-e= | =ze=               |
+   | =outline-hide-leaves=              | =C-c C-l= | =zl=               |
+   | =outline-show-branches=            | =C-c C-k= | =zK=               |
+   | =outline-show-children=            | =C-c TAB= | =zk=               |
+   | =outline-hide-other=               | =C-c C-o= | =zp=               |
+   | =outline-up-heading=               | =C-c C-u= | =zu=               |
+   | =outline-previous-visible-heading= | =C-c C-p= | =[[=               |
+   | =outline-next-visible-heading=     | =C-c C-n= | =]]=               |
+   | =outline-backward-same-level=      | =C-c C-b= | =C-k=, =gk=        |
+   | =outline-forward-same-level=       | =C-c C-f= | =C-j=, =gj=        |
+   | =outline-promote=                  | =C-c C-<= | =M-h=              |
+   | =outline-demote=                   | =C-c C->= | =M-l=              |
+   | =outline-move-subtree-up=          | =C-c C-^= | =M-k=              |
+   | =outline-move-subtree-down=        | =C-c C-v= | =M-j=              |
+   | =outline-insert-heading=           | =C-c RET= | =M-<return>=       |
+   | =outline-show-all=                 | =C-c C-a= | =<backtab>= (opt.) |
+   | =outline-toggle-children=          | =C-c TAB= | =<tab>= (opt.)     |
+
+** Customization
+
+   | Variable                                         | Default | Purpose                                                                                    |
+   |--------------------------------------------------+---------+--------------------------------------------------------------------------------------------|
+   | =evil-collection-outline-bind-tab-p=             | =nil=   | Bind =<tab>= / =<backtab>= to outline cycling (off by default to avoid clashing with Org). |
+   | =evil-collection-outline-enable-in-minor-mode-p= | =t=     | Inherit the same bindings in =outline-minor-mode= via auxiliary keymap parenting.          |
diff --git a/.config/emacs/lisp/evil-collection/modes/outline/evil-collection-outline.el b/.config/emacs/lisp/evil-collection/modes/outline/evil-collection-outline.el
new file mode 100644
index 0000000..856387e
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/outline/evil-collection-outline.el
@@ -0,0 +1,116 @@
+;;; evil-collection-outline.el --- Evil bindings for outline-mode -*- lexical-binding: t -*-
+
+;; Copyright (C) 2017 Pierre Neidhardt
+
+;; Author: Pierre Neidhardt <mail@ambrevar.xyz>
+;; Maintainer: James Nguyen <james@jojojames.com>
+;; Pierre Neidhardt <mail@ambrevar.xyz>
+;; URL: https://github.com/emacs-evil/evil-collection
+;; Version: 0.0.1
+;; Package-Requires: ((emacs "26.3"))
+;; Keywords: evil, outline, tools
+
+;; This file is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published
+;; by the Free Software Foundation; either version 3, or (at your
+;; option) any later version.
+;;
+;; This file is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; For a full copy of the GNU General Public License
+;; see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;; Evil bindings for outline-mode.
+
+;;; Code:
+(require 'evil-collection)
+(require 'outline)
+
+(defcustom evil-collection-outline-bind-tab-p nil
+  "Enable <tab>-based bindings in Outline mode.
+
+Unless you have Evil bindings set up for Org mode, Org will
+preserve the Emacs-state <tab> keys in Org mode. Set this option
+to t if you want to inherit the <tab>-based bindings from Outline
+mode."
+  :group 'evil-collection-outline
+  :type 'boolean)
+
+(defcustom evil-collection-outline-enable-in-minor-mode-p t
+  "Enable Outline mode bindings in Outline minor mode.
+
+To override individual bindings, modify the minor mode keymap.
+For example, \"zB\" is bound to `outline-hide-body' in Outline
+mode. To turn off this specific binding in Outline minor mode,
+you can do:
+
+    (evil-define-minor-mode-key \='normal \='outline-minor-mode \"zB\" nil)"
+  :group 'evil-collection-outline
+  :type 'boolean)
+
+(defconst evil-collection-outline-maps '(outline-mode-map))
+
+;;;###autoload
+(defun evil-collection-outline-setup ()
+  "Set up `evil' bindings for `outline'."
+  (evil-set-initial-state 'outline-mode 'normal)
+  (when evil-collection-outline-bind-tab-p
+    (evil-collection-define-key 'normal 'outline-mode-map
+      (kbd "<backtab>") 'outline-show-all ; Also "z r" by default
+      (kbd "<tab>") 'outline-toggle-children)) ; Also "z a" by default
+  (evil-collection-define-key 'normal 'outline-mode-map
+    ;; folding
+    ;; Evil default keys:
+    ;; zO: Show recursively for current branch only.
+    ;; za: Toggle first level like outline-toggle-children.
+    ;; zc: Hide complete subtree.
+    ;; zm: Show only root notes.
+    ;; zo: Show current node like "za".
+    ;; zr: Show everything.
+    ;; "ze" 'outline-hide-entry
+    ;; "zE" 'outline-show-entry
+    ;; "zl" 'outline-hide-leaves
+    ;; "zb" 'outline-show-branches
+    ;; "zo" 'outline-hide-other
+    "zB" 'outline-hide-body ; Hide all bodies, Emacs has "C-c C-t".
+    "zE" 'outline-hide-entry ; Hide current body, Emacs has "C-c C-c".
+    "ze" 'outline-show-entry ; Show current body only, not subtree, reverse of outline-hide-entry, Emacs has "C-c C-e".
+    "zl" 'outline-hide-leaves ; Like `outline-hide-body' but for current subtree only, Emacs has "C-c C-l".
+    "zK" 'outline-show-branches ; Show all children recursively but no body.  Emacs has "C-c C-k".
+    "zk" 'outline-show-children ; Direct children only unlike `outline-show-branches', and no content unlike `outline-show-entry' and `outline-toggle-children'.  Emacs has "C-c TAB".
+    "zu" 'outline-up-heading
+
+    "zp" 'outline-hide-other ; Hide all nodes and bodies except current body.  Emacs has "C-c C-o".
+    ;; outline-hide-sublevels ; q ; Is it any different from `outline-hide-body'?
+    ;; outline-hide-subtree ; Emacs has "C-c C-d", Evil has default "zc".
+    ;; outline-show-subtree ; Emacs has "C-c C-s", Evil has default "zO".
+
+    ;; TODO: To mark subtree ("C-c @"), we would need to define a tree object.
+
+    ;; motion
+    "[[" 'outline-previous-visible-heading
+    "]]" 'outline-next-visible-heading
+    (kbd "C-k") 'outline-backward-same-level
+    (kbd "C-j") 'outline-forward-same-level
+    "gk" 'outline-backward-same-level
+    "gj" 'outline-forward-same-level
+
+    (kbd "M-h") 'outline-promote ; Org-mode has "M-<left>", Evil-org has "M-h"
+    (kbd "M-j") 'outline-move-subtree-down ; Org-mode has "M-<down>", Evil-org has "M-j"
+    (kbd "M-k") 'outline-move-subtree-up ; Org-mode has "M-<up>", Evil-org has "M-k"
+    (kbd "M-l") 'outline-demote ; Org-mode has "M-<right>", Evil-org has "M-l"
+
+    (kbd "M-<return>") 'outline-insert-heading) ; Org-mode has "M-<return>"
+
+  ;; Enable bindings in Outline minor mode if requested
+  (when evil-collection-outline-enable-in-minor-mode-p
+    (let* ((minor-map (evil-get-minor-mode-keymap 'normal 'outline-minor-mode))
+           (major-map (evil-get-auxiliary-keymap outline-mode-map 'normal)))
+      (set-keymap-parent minor-map major-map))))
+
+(provide 'evil-collection-outline)
+;;; evil-collection-outline.el ends here