[elpa] externals/eev 1b0d1dd 25/64: Added several sections to `find-eev-quick-intro'.

[Stefan Monnier]

branch: externals/eev
commit 1b0d1ddd50aa1f517c6b979000b1c25fa0f61351
Author: Eduardo Ochs <address@hidden>
Commit: Eduardo Ochs <address@hidden>

    Added several sections to `find-eev-quick-intro'.
---
 ChangeLog    | 14 +++++++++++
 eejump.el    |  9 ++++---
 eev-eval.el  |  6 +++--
 eev-intro.el | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++--------
 eev-mode.el  | 51 ++++++++++++++++++++++++---------------
 5 files changed, 122 insertions(+), 36 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 1a99154..b91408e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2019-01-23  Eduardo Ochs  <address@hidden>
+
+       * eejump.el: moved the binding for `M-j' to eev-intro.el.
+
+       * eev-mode.el (eev-mode-map-set): rewrote some comments.
+       (eev-mode-map-set): removed the binding for `find-git-links-1'.
+       (eev-mode-map-set): added the binding for `M-j' (`eejump').
+
+       * eev-intro.el (find-eev-quick-intro): added sections "3.1.
+       Non-elisp hyperlinks", "7.2. The list of eejump targets", "7.3.
+       Defining eejump targets"; small changes in other sections.
+
+       * eev-eval.el: added comments.
+
 2019-01-05  Eduardo Ochs  <address@hidden>
 
        * eev-code.el (find-code-c-d-rest): new function.
diff --git a/eejump.el b/eejump.el
index 9bc3150..a8ada8c 100644
--- a/eejump.el
+++ b/eejump.el
@@ -19,7 +19,7 @@
 ;;
 ;; Author:     Eduardo Ochs <address@hidden>
 ;; Maintainer: Eduardo Ochs <address@hidden>
-;; Version:    2016sep23
+;; Version:    2019jan23
 ;; Keywords:   e-scripts
 ;;
 ;; Latest version: <http://angg.twu.net/eev-current/eejump.el>
@@ -43,11 +43,10 @@
 
 
 
-;; This module installs a key binding into eev-mode-keymap, so:
-(require 'eev-mode)                    ; (find-eev "eev-mode.el")
-
-(define-key eev-mode-map "\M-j" 'eejump)
+;; See: (find-eevfile "eev-mode.el" "M-j")
+;; (define-key eev-mode-map "\M-j" 'eejump)
 
+ 
 (defun eejump (arg)
   "See: (find-eev-quick-intro \"7.1. eejump\")
 and: (find-eejump-intro)"
diff --git a/eev-eval.el b/eev-eval.el
index 0fcb7fe..669a3ae 100644
--- a/eev-eval.el
+++ b/eev-eval.el
@@ -19,7 +19,7 @@
 ;;
 ;; Author:     Eduardo Ochs <address@hidden>
 ;; Maintainer: Eduardo Ochs <address@hidden>
-;; Version:    2012dec29
+;; Version:    2019jan23
 ;; Keywords:   e-scripts
 ;;
 ;; Latest version: <http://angg.twu.net/eev-current/eev-eval.el>
@@ -45,6 +45,9 @@
 ;;;                                       |_|                       
 ;;;
 ;;; evaluating sexps (alternatives to eval-last-sexp)
+;;; See: (find-eev-quick-intro "2. Evaluating Lisp")
+;;;      (find-eev-quick-intro "2. Evaluating Lisp" "When you type `M-e'")
+;;;      (find-eev-quick-intro "2. Evaluating Lisp" "numeric prefixes")
 ;;;
 
 ;; ee-eval-sexp-eol may be obsolete
@@ -107,7 +110,6 @@
     (eval sexp)))
 
 
-
 (defun ee-eval-last-sexp (&optional arg)
   "By default, evaluate sexp before point, and print value in minibuffer.
 This is eev's variant of `eval-last-sexp', and it can behave in
diff --git a/eev-intro.el b/eev-intro.el
index 1749d22..2605e94 100644
--- a/eev-intro.el
+++ b/eev-intro.el
@@ -20,7 +20,7 @@
 ;;
 ;; Author:     Eduardo Ochs <address@hidden>
 ;; Maintainer: Eduardo Ochs <address@hidden>
-;; Version:    2019jan08
+;; Version:    2019jan23
 ;; Keywords:   e-scripts
 ;;
 ;; Latest version: <http://angg.twu.net/eev-current/eev-intro.el>
@@ -6041,6 +6041,26 @@ access to the \"non-free\" respository... ask for help 
if you need!
 
 
 
+3.1. Non-elisp hyperlinks
+-------------------------
+Emacs has ways to follow URLs, but the keys for that are totally
+different from the ones for elisp hyperlinks. You can follow the URL
+below by putting the point on it and typing `M-x browse-url':
+
+  http://www.lua.org/start.html
+
+This will make emacs invoke the default browser on that URL. See:
+
+  (find-enode \"Browse-URL\")
+
+Eev defines several functions similar to `browse-url', but they are
+presently considered advanced features. See:
+
+  (find-brxxx-intro)
+
+
+
+
 
 4. Creating Elisp Hyperlinks
 ============================
@@ -6188,7 +6208,7 @@ The Emacs manuals are in \"info\" format, which means:
        ]         forward-node        (Top->1->1.1->1.2->2->3->3.1->...->Index)
        [         backward-node       (Top<-1<-1.1<-1.2<-2<-3<-3.1<-...<-Index)
 
-Try the keys above now - they are VERY imporant! Use:
+Try the keys above now - they are VERY important! Use:
 
   (eek \"<down> M-3 M-e  ;; open the hyperlink below in another window\")
   (find-node \"(emacs)Basic\")
@@ -6392,7 +6412,19 @@ Note that `M-1 M-j' can be typed as:
     type j,
   release the meta key.
 
-Internally, what happens is that:
+instead of:
+
+  hold the meta key,
+    type 1,
+  release the meta key,
+  hold the meta key,
+    type j,
+  release the meta key;
+
+There is no need to release and press agian the meta key between
+the `1' and the `j'.
+
+Internally, what happens when you type `M-1 M-j' is this:
 
   `M-j' is bound to `eejump',
   `M-1 M-j' runs `eejump' with argument 1, i.e., (eejump 1)
@@ -6401,18 +6433,45 @@ Internally, what happens is that:
 
     (defun eejump-1 () (find-fline \"~/TODO\"))
 
-Note that if you type `M-J' (i.e., meta-uppercase-j) on the line below
-then it will be converted into the \"(defun eejump-1 ...)\" above,
+So `M-1 M-j' runs the one-liner `(find-fline \"~/TODO\")',
+`M-5 M-j' runs the one-liner `(find-eev-quick-intro)',
+and so on.
 
-  1 (find-fline \"~/TODO\")
 
-and note also that if you type `M-j' without a prefix argument then it
-runs `(find-eejumps)', which displays all the current eejump targets,
-as defuns. Try it:
+
+7.2. The list of eejump targets
+-------------------------------
+If you type `M-j' without a prefix argument then it runs
+`(find-eejumps)', that displays all the current eejump targets as
+defuns, one in each line. Try it:
 
   (eek \"M-j\")
   (find-eejumps)
 
+You will see that two of those entries are:
+
+  (defun eejump-1 () (find-fline \"~/TODO\"))
+  (defun eejump-5 () (find-eev-quick-intro))
+
+
+
+7.3. Defining eejump targets
+----------------------------
+We can define new eejump targets, or overwrite the current ones, by
+just running `defun's to define functions with names starting with
+`eejump-'. Try:
+
+  (defun eejump-9 () (find-eev-quick-intro \"7.2.\"))
+  (defun eejump-9 () (find-eev-quick-intro \"7.3.\"))
+  (fmakunbound 'eejump-9)
+  (find-eejumps)
+
+Note that if you type `M-J' (i.e., meta-uppercase-j,
+`eewrap-eejump') on the line below then it will be converted into
+the first \"(defun eejump- ...)\" above:
+
+  9 (find-eev-quick-intro \"7.2.\")
+
 An advanced feature: if you type `M-J' on a line that starts with
 something that is not a number, you get a defun for a \"command
 with a very short name\" like the ones that are described in the
@@ -6424,7 +6483,6 @@ next section. Try it now:
 
 
 
-
 7.2. Commands with very short names
 -----------------------------------
 Let's start with an example. If we are editing a LaTeX file, say
diff --git a/eev-mode.el b/eev-mode.el
index f2d24b4..cb54765 100644
--- a/eev-mode.el
+++ b/eev-mode.el
@@ -1,6 +1,6 @@
 ;;; eev-mode.el -- a minor mode with keybindings for using eev conveniently.
 
-;; Copyright (C) 2012,2013 Free Software Foundation, Inc.
+;; Copyright (C) 2012,2013,2019 Free Software Foundation, Inc.
 ;;
 ;; This file is (not yet?) part of GNU eev.
 ;;
@@ -19,7 +19,7 @@
 ;;
 ;; Author:     Eduardo Ochs <address@hidden>
 ;; Maintainer: Eduardo Ochs <address@hidden>
-;; Version:    2013nov15
+;; Version:    2019jan23
 ;; Keywords:   e-scripts
 ;;
 ;; Latest version: <http://angg.twu.net/eev-current/eev-mode.el>
@@ -54,24 +54,32 @@ See: (find-eval-intro \"`M-k'\")"
 (defun eev-mode-map-set ()
   "Add the standard keybindings for eev to `eev-mode-keymap'."
   ;;
-  ;; Eepitch: a simple way to script interactive programs.
-  ;; Explanation: (find-eepitch-intro "The main key: <F8>")
-  ;;              (find-eepitch-intro "Creating eepitch blocks: <M-T>")
-  ;;      Source: (find-eev "eepitch.el")
-  (define-key eev-mode-map [f8]   'eepitch-this-line)
-  (define-key eev-mode-map "\M-T" 'eewrap-eepitch)
-  ;;
   ;; Keys for following hyperlinks and for going back.
-  ;; Explanation: (find-eval-intro "`M-e'")
-  ;;              (find-eval-intro "Going back")
-  ;;      Source: (find-eev "eev-eval.el")
+  ;; See: (find-eev-quick-intro "2. Evaluating Lisp" "When you type `M-e'")
+  ;;      (find-eev-quick-intro "3. Elisp hyperlinks" "go back" "`M-k'")
+  ;; Source: (find-eev "eev-eval.el")
   (define-key eev-mode-map "\M-e" 'ee-eval-sexp-eol)  ; extends C-e C-x C-e
   (define-key eev-mode-map "\M-E" 'ee-eval-last-sexp) ; extends     C-x C-e
   (define-key eev-mode-map "\M-k" 'ee-kill-this-buffer)
   (define-key eev-mode-map "\M-K" 'bury-buffer)
   ;;
-  ;; Explanation: (find-wrap-intro)
-  ;;       Tests: (find-wrap-intro "all wrapping functions")
+  ;; Jump to numbered places (or actions).
+  ;; See:    (find-eev-quick-intro "7.1. eejump")
+  ;; Source: (find-eev "eejump.el")
+  (define-key eev-mode-map "\M-j" 'eejump)
+  ;;
+  ;; Eepitch: a simple way to script interactive programs.
+  ;; See: (find-eev-quick-intro "6. Controlling shell-like programs")
+  ;;      (find-eev-quick-intro "6.1. The main key: <F8>")
+  ;;      (find-eev-quick-intro "6.3. Creating eepitch blocks: `M-T'")
+  ;; Source: (find-eev "eepitch.el")
+  (define-key eev-mode-map [f8]   'eepitch-this-line)
+  (define-key eev-mode-map "\M-T" 'eewrap-eepitch)
+  ;;
+  ;; Functions that transform ("wrap") the current line.
+  ;; See: (find-eev-quick-intro "`eewrap-(something)'")
+  ;;      (find-wrap-intro)
+  ;;      (find-wrap-intro "all wrapping functions")
   ;;      Source: (find-eev "eev-wrap.el")
   (define-key eev-mode-map "\M-A" 'eewrap-anchor)
   (define-key eev-mode-map "\M-C" 'eewrap-code-c-d)
@@ -85,7 +93,10 @@ See: (find-eval-intro \"`M-k'\")"
   (define-key eev-mode-map "\M-Z" 'eewrap-zsh)
   ;;
   ;; Keys for creating temporary buffers with elisp hyperlinks:
-  ;;      Source: (find-eev "eev-elinks.el")
+  ;; The highest-level command is `M-h M-h', described here:
+  ;;   (find-eev-quick-intro "4. Creating Elisp Hyperlinks")
+  ;;   (find-eev-quick-intro "4. Creating Elisp Hyperlinks" "`M-h M-h'")
+  ;; Source: (find-eev "eev-elinks.el")
   (define-key eev-mode-map "\M-h\M-d" 'find-debpkg-links)    
   (define-key eev-mode-map "\M-h\M-f" 'find-efunction-links) 
   (define-key eev-mode-map "\M-h\M-i" 'find-einfo-links)     
@@ -104,15 +115,17 @@ See: (find-eval-intro \"`M-k'\")"
   (define-key eev-mode-map "\M-h\M-t" 'find-etpat)
   (define-key eev-mode-map "\M-ht"    'find-etpat0)
   ;;
-  ;; Extras:
-  (define-key eev-mode-map "\M-hg"    'find-git-links-1)
-  ;;
-  ;; Keys for editing hyperlinks:
+  ;; Keys for refining hyperlinks.
+  ;; See: (find-eval-intro "Producing and refining hyperlinks")
+  ;;      (find-eval-intro "`M-h M-2'")
   ;; Source: (find-eev "eev-edit.el")
   (define-key eev-mode-map "\M-h\M-2" 'ee-duplicate-this-line)
   (define-key eev-mode-map "\M-h\M-y" 'ee-yank-pos-spec)
   (define-key eev-mode-map "\M-h\M--" 'ee-shrink-hyperlink-at-eol)
   ;;
+  ;; Obsolete:
+  ;; (define-key eev-mode-map "\M-hg"    'find-git-links-1)
+  ;;
   )
 
 (when (not eev-mode-map)