[elpa] externals/eev 7630bc4da7: Small changes in the docs of eev-kla.el.

[ELPA Syncer]

branch: externals/eev
commit 7630bc4da7df9cf254eb2f86e9cf81002b345581
Author: Eduardo Ochs <eduardoochs@gmail.com>
Commit: Eduardo Ochs <eduardoochs@gmail.com>

    Small changes in the docs of eev-kla.el.
---
 ChangeLog  |  4 +++
 VERSION    |  4 +--
 eev-kla.el | 84 ++++++++++++++++++++++++++++++++++++++++++--------------------
 3 files changed, 63 insertions(+), 29 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index a1be87ba48..63c2538bf6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2022-09-18  Eduardo Ochs  <eduardoochs@gmail.com>
+
+       * eev-kla.el: small changes in the docs.
+
 2022-09-17  Eduardo Ochs  <eduardoochs@gmail.com>
 
        * eev-edit.el (ee-preceding-tag-flash): new function.
diff --git a/VERSION b/VERSION
index b67ccfae30..f1cba80ba6 100644
--- a/VERSION
+++ b/VERSION
@@ -1,2 +1,2 @@
-Sat Sep 17 09:33:54 GMT 2022
-Sat Sep 17 06:33:54 -03 2022
+Sun Sep 18 10:50:25 GMT 2022
+Sun Sep 18 07:50:25 -03 2022
diff --git a/eev-kla.el b/eev-kla.el
index f74b6f81c9..7da1909c8c 100644
--- a/eev-kla.el
+++ b/eev-kla.el
@@ -19,7 +19,7 @@
 ;;
 ;; Author:     Eduardo Ochs <eduardoochs@gmail.com>
 ;; Maintainer: Eduardo Ochs <eduardoochs@gmail.com>
-;; Version:    20220917
+;; Version:    20220918
 ;; Keywords:   e-scripts
 ;;
 ;; Latest version: <http://angg.twu.net/eev-current/eev-kla.el>
@@ -48,19 +48,45 @@
 ;;
 ;; 0. Prerequisites
 ;; ================
-;; This tool will only make sense to people who understand `code-c-d',
-;; anchors, and `find-here-links' very well. See:
+;; This tool will only make sense to people who understand anchors,
+;; `code-c-d', and `find-here-links' very well. See:
 ;;
+;;   (find-eev-quick-intro "8. Anchors")
 ;;   (find-eev-quick-intro "9.1. `code-c-d'")
 ;;   (find-eev-quick-intro "9.2. Extra arguments to `code-c-d'")
 ;;   (find-eev-quick-intro "9.2. Extra arguments to `code-c-d'" "to anchors")
-;;   (find-eev-quick-intro "8. Anchors")
 ;;   (find-eev-quick-intro "4. Creating Elisp Hyperlinks")
 ;;   (find-eev-quick-intro "4.1. `find-here-links'")
 ;;
 ;;
 ;;
-;; 1. The problem
+;; 1. Very short introduction
+;; ==========================
+;; This:
+;;
+;;   (find-eev "eev-kla.el" "intro")
+;;
+;; is a short hyperlink to the anchor "intro" above. The standard way
+;; to create a link like that is using `find-here-links', refining,
+;; and shrinking, and that way needs many keys. It is explained here:
+;;
+;;   (find-saving-links-intro "2.3. The base case 3")
+;;
+;; This file implements another way to generate links like the one
+;; in the beginning of this section. Try this:
+;;
+;;   M-x eekla
+;;
+;; You will see a message like this one
+;;
+;;   Copied to the kill ring: (find-eev "eev-kla.el" "intro")
+;;
+;; in the echo area. Then go to the your notes, paste that link with
+;; `C-y', and follow it - it will take you back here.
+;;
+;;
+;;
+;; 2. The problem
 ;; ==============
 ;; This section of the main tutorial
 ;;
@@ -97,7 +123,7 @@
 ;;
 ;;
 ;;
-;; 2. Converting `c's to `d's
+;; 3. Converting `c's to `d's
 ;; ==========================
 ;; Remember that the arguments for a `code-c-d' are called "c" (for
 ;; "code") and "d" (for "directory"),
@@ -122,7 +148,7 @@
 ;;
 ;;
 ;;
-;; 3. Shortening filenames
+;; 4. Shortening filenames
 ;; =======================
 ;; Try:
 ;;
@@ -152,7 +178,7 @@
 ;;
 ;;
 ;;
-;; 4. Defaults
+;; 5. Defaults
 ;; ===========
 ;; When the functions `ee-kl-dir', `ee-kl-shortname', and
 ;; `ee-kl-sexp-klf' above are called without keyword arguments they
@@ -171,7 +197,7 @@
 ;;
 ;;
 ;;
-;; 5. `ee-preferred-c'
+;; 6. `ee-preferred-c'
 ;; ===================
 ;; In short: in the example that we are discussing there are three
 ;; possible sexp hyperlinks to this file:
@@ -186,14 +212,15 @@
 ;;
 ;; Each one is associated to a `c'. If `c' is "foo" we get the first
 ;; one, if `c' is "bar" we get the second, and if `c' is "plic" we get
-;; the third one... and the value of the variavle `ee-preferred-c'
+;; the third one... and the value of the variable `ee-preferred-c'
 ;; determines which is these short hyperlinks should be preferred.
 ;;
 ;; Try:
 ;;
 ;;   (find-evardescr 'ee-preferred-c)
 ;;
-;; you will get an explanation like this:
+;; you will get an explanation like this - but the name of the
+;; directory will be different:
 ;;
 ;;   ee-preferred-c is a variable defined in ‘eev-kla.el’.
 ;;
@@ -207,8 +234,7 @@
 ;;     This variable is safe as a file local variable if its value
 ;;     satisfies the predicate ‘stringp’.
 ;;
-;; and if you visit the .dir-locals.el file file mentioned above,
-;; with:
+;; and if you visit the .dir-locals.el file mentioned above, with:
 ;;
 ;;   (find-eev ".dir-locals.el")
 ;;
@@ -223,10 +249,10 @@
 ;;
 ;;
 ;;
-;; 6. `add-dir-local-variable'
+;; 7. `add-dir-local-variable'
 ;; ===========================
-;; When I started created my own ".dir-locals.el" files I found their
-;; syntax very hard to get right... but there's this:
+;; When I started created my own ".dir-locals.el" files - by hand! - I
+;; found their syntax very hard to get right... but there's this:
 ;;
 ;;   (find-enode "Directory Variables" "M-x add-dir-local-variable")
 ;;   (find-enode "Directory Variables" "M-x delete-dir-local-variable")
@@ -250,11 +276,12 @@
 ;;
 ;; Note that the three sexps starting with `find-2a's are three lines
 ;; long each, and they are commented out with a "'" at the beginning
-;; of the line.
+;; of the line. Also, note that you may need to save the dir-locals
+;; file, and reload the other file, for the changes to take effect.
 ;;
 ;;
 ;;
-;; 7. `eekla' and friends
+;; 8. `eekla' and friends
 ;; ======================
 ;; At the moment this file implements these commands:
 ;;
@@ -276,25 +303,28 @@
 ;;
 ;;         Copied to the kill ring: (find-eevfile "eev-kla.el")
 ;;
-;;   3) `M-x eeklas'
+;;   3) `M-x eeklas': <K>ill a <L>ink to an <A>nchor and <S>tring.
+;;      This is similar to `M-x eekla', but if "refines" the link
+;;      generated by `M-x eekla' by adding the region between the
+;;      point and the mark. For example, is the region is this "blah"
+;;      then `M-x eeklas' with show this message:
 ;;
-;;   4) `M-x eeklfs'
+;;        Copied to the kill ring: (find-eev "eev-kla.el" "test" "blah")
 ;;
-;;   5) `M-x ee-preferred-c-show', that shows the current directory
-;;      and the value of `ee-preferred-c' at the window at the right.
-;;      This is useful to check if the ".dir-locals.el" file was
-;;      correctly written. Try:
+;;   4) `M-x eeklfs': <K>ill a <L>ink to a <F>ile and <S>string.
+;;      If the region is this "bleh" then `M-x eeklfs' will show
+;;      this message:
 ;;
-;;        (ee-preferred-c-show)
+;;        Copied to the kill ring: (find-eevfile "eev-kla.el" "bleh")
 ;;
 ;; TODO: `M-x eeklt', that <K>ills a <L>ink made with (<T>o ...);
 ;; rewrite `ee-preferred-c-show' - I deleted the old version.
 ;;
 ;;
 ;;
-;; 8. Aliases
+;; 9. Aliases
 ;; ==========
-;; TODO: write this.
+;; See: (find-eev "eev-kla.el" "aliases")