[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/eev 26bd206 05/10: New section: (find-eev-quick-intro "
|
From: |
Stefan Monnier |
|
Subject: |
[elpa] externals/eev 26bd206 05/10: New section: (find-eev-quick-intro "4.2. `find-ekey-links' and friends") |
|
Date: |
Tue, 25 Jun 2019 00:05:10 -0400 (EDT) |
branch: externals/eev
commit 26bd2068b74491e8900263684b1797104cca31a2
Author: Eduardo Ochs <address@hidden>
Commit: Eduardo Ochs <address@hidden>
New section: (find-eev-quick-intro "4.2. `find-ekey-links' and friends")
---
ChangeLog | 12 +++++
VERSION | 4 +-
eev-beginner.el | 6 +--
eev-elinks.el | 97 +++++++++++++++-----------------------
eev-intro.el | 141 +++++++++++++++++++++++++++++++++++++++-----------------
5 files changed, 152 insertions(+), 108 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 5c7b54e..0662303 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2019-06-23 Eduardo Ochs <address@hidden>
+
+ * eev-elinks.el (ee-find-eboundkey-links): reordered the links.
+
+ * eev-intro.el (find-eev-quick-intro): new section: "4.2.
+ `find-ekey-links' and friends".
+
+ * eev-elinks.el (find-ekey-links): added an (eek "M-h M-f ...").
+
+ * eev-beginner.el (eev-beginner): do not bind `M-h M-h' to
+ `find-here-links-beginner'.
+
2019-06-22 Eduardo Ochs <address@hidden>
* eev-pdflike.el: make `find-pdf-page' use texworks on M$ Windows.
diff --git a/VERSION b/VERSION
index e42a525..b0d56ee 100644
--- a/VERSION
+++ b/VERSION
@@ -1,2 +1,2 @@
-Sat Jun 22 17:58:52 GMT 2019
-Sat Jun 22 14:58:52 -03 2019
+Mon Jun 24 02:24:50 GMT 2019
+Sun Jun 23 23:24:50 -03 2019
diff --git a/eev-beginner.el b/eev-beginner.el
index df5c22e..61d5c2e 100644
--- a/eev-beginner.el
+++ b/eev-beginner.el
@@ -19,7 +19,7 @@
;;
;; Author: Eduardo Ochs <address@hidden>
;; Maintainer: Eduardo Ochs <address@hidden>
-;; Version: 2019jun17
+;; Version: 2019jun23
;; Keywords: e-scripts
;;
;; Latest version: <http://angg.twu.net/eev-current/eev-beginner.el>
@@ -90,10 +90,6 @@
"Load all basic modules of eev, turn eev-mode on, and open a tutorial."
(interactive)
(require 'eev-load)
- ;;
- ;; See: (find-eev "eev-elinks.el" "find-here-links-beginner")
- (define-key eev-mode-map "\M-h\M-h" 'find-here-links-beginner)
- ;;
(eev-mode 1)
(find-eev-quick-intro))
diff --git a/eev-elinks.el b/eev-elinks.el
index 2c6651a..dca994a 100644
--- a/eev-elinks.el
+++ b/eev-elinks.el
@@ -19,7 +19,7 @@
;;
;; Author: Eduardo Ochs <address@hidden>
;; Maintainer: Eduardo Ochs <address@hidden>
-;; Version: 2019jun12
+;; Version: 2019jun23
;; Keywords: e-scripts
;;
;; Latest version: <http://angg.twu.net/eev-current/eev-elinks.el>
@@ -234,6 +234,8 @@ The buffer is put in Emacs Lisp mode."
(apply 'find-elinks
`((find-efunction-links ',f ,@pos-spec-list)
(eek ,(format "M-h M-f %s" f))
+ (find-eev-quick-intro "4.2. `find-ekey-links' and friends")
+ ""
,@(ee-find-efunction-links f)
)
pos-spec-list))
@@ -242,23 +244,24 @@ The buffer is put in Emacs Lisp mode."
"Return a list of hyperlinks for F (a function symbol).
This is an internal function used by `find-efunction-links' and
`find-ekey-links'."
- `((where-is ',f)
- (describe-function ',f)
- (find-efunctiondescr ',f)
+ `((find-efunctiondescr ',f)
(find-efunction ',f)
(find-efunctionpp ',f)
(find-efunctiond ',f)
- ;; (find-eCfunction ',f) ; obsolete
- (find-estring (documentation ',f))
- (find-estring (documentation ',f t))
- (symbol-file ',f 'defun)
- (find-fline (symbol-file ',f 'defun))
""
,@(if (commandp f)
`((Info-goto-emacs-command-node ',f)
(find-enode "Command Index" ,(format "* %S:" f))
))
(find-elnode "Index" ,(format "* %S:" f))
+ ""
+ (where-is ',f)
+ (symbol-file ',f 'defun)
+ (find-fline (symbol-file ',f 'defun))
+ (find-estring (documentation ',f))
+ (find-estring (documentation ',f t))
+ (describe-function ',f)
+ ;; (find-eCfunction ',f) ; obsolete
))
@@ -377,14 +380,15 @@ See: (find-eev \"eev-elinks.el\" \"find-ekey-links\")"
(apply 'find-elinks
`((find-ekey-links ,key ,@pos-spec-list)
;; Convention: the first sexp always regenerates the buffer.
- (find-ekey-links ,key)
- (eek ,(format "M-h M-k %s" longkey))
- (eek ,(format "M-h M-k %s" longkey+))
- (find-efunctiondescr ',f)
- ""
(find-elongkey-links ,longkey)
(find-elongkey-links ,longkey+)
(find-efunction-links ',f)
+ (eek ,(format "M-h M-k %s" longkey))
+ (eek ,(format "M-h M-k %s" longkey+))
+ (eek ,(format "M-h M-f %s" f))
+ ;; (find-efunctiondescr ',f)
+ ""
+ (find-eev-quick-intro "4.2. `find-ekey-links' and friends")
""
,@(ee-find-eboundkey-links key f)
)
@@ -403,6 +407,7 @@ See `read-kbd-macro' and `edmacro-mode' for the format."
`((find-elongkey-links ,longkey)
(find-ekey-links ,key)
(find-efunction-links ',f)
+ (find-eev-quick-intro "4.2. `find-ekey-links' and friends")
""
,@(ee-find-eboundkey-links key f)
)
@@ -413,23 +418,24 @@ See `read-kbd-macro' and `edmacro-mode' for the format."
"From KEY and its binding, F, produce a list of hyperlinks.
This is an internal function used by `find-ekey-links' and
`find-elongkey-links'."
- `((where-is ',f)
- (describe-function ',f)
- (find-efunctiondescr ',f)
+ `((find-efunctiondescr ',f)
+ (find-ekeydescr ,key)
(find-efunction ',f)
(find-efunctionpp ',f)
(find-efunctiond ',f)
- (find-estring (documentation ',f))
- (find-estring (documentation ',f t))
""
- (describe-key ,key)
- (describe-key-briefly ,key)
- (find-ekeydescr ,key)
(Info-goto-emacs-key-command-node ,key)
(Info-goto-emacs-command-node ',f)
(find-enode "Command Index" ,(format "* %S:" f))
(find-elnode "Index" ,(format "* %S:" f))
""
+ (describe-key-briefly ,key)
+ (find-estring (documentation ',f))
+ (find-estring (documentation ',f t))
+ (describe-key ,key)
+ (describe-function ',f)
+ ""
+ (where-is ',f)
(key-description ,key)
(format-kbd-macro ,key)
(format-kbd-macro ,key t)
@@ -938,42 +944,14 @@ See: (find-pdf-like-intro)
(setq page (or page (ee-current-page)))
(setq bufname (or bufname (buffer-name)))
(setq offset (or offset ee-page-offset))
- (let* ((c ee-page-c)
- (fname ee-page-fname)
- (find-cpage (ee-intern "find-%spage" c))
- (find-ctext (ee-intern "find-%stext" c))
- (kill (or (ee-last-kill) ""))
- (page- (- page offset))
- )
- ;;
- '(apply 'find-elinks `(
- (find-pdflike-page-links ,page ,bufname ,offset ,@rest)
- (find-efunction 'find-pdflike-page-links)
- ""
- (,find-cpage ,page)
- (,find-ctext ,page)
- (,find-cpage (+ ,offset ,page-))
- (,find-ctext (+ ,offset ,page-))
- ""
- (,find-cpage ,page ,kill)
- (,find-ctext ,page ,kill)
- (,find-cpage (+ ,offset ,page-) ,kill)
- (,find-ctext (+ ,offset ,page-) ,kill)
- ""
- (code-pdf-page ,c ,fname)
- (code-pdf-text ,c ,fname ,offset)
- ,(ee-HS bufname)
- ) rest)
- ;;
- (apply 'find-elinks `(
- (find-pdflike-page-links ,page ,bufname ,offset ,@rest)
- (find-efunction 'find-pdflike-page-links)
- (find-eev-quick-intro "10.4. Generating short hyperlinks to PDFs")
- (find-eev-quick-intro "11.1. `find-pdf-links'")
- ""
- ,@(ee-pdflike-page-links page bufname offset)
- ) rest)
- ))
+ (apply 'find-elinks `(
+ (find-pdflike-page-links ,page ,bufname ,offset ,@rest)
+ ;; (find-efunction 'find-pdflike-page-links)
+ (find-eev-quick-intro "10.4. Generating short hyperlinks to PDFs")
+ (find-eev-quick-intro "11.1. `find-pdf-links'")
+ ""
+ ,@(ee-pdflike-page-links page bufname offset)
+ ) rest))
;; (find-pdflike-page-links)
;; (find-angg ".emacs.papers" "kopkadaly")
@@ -1345,7 +1323,8 @@ See: (find-here-links-intro \"5. `find-here-links-1'\")"
;; Convention: the first sexp always regenerates the buffer.
;; (find-efunction 'find-code-pdf-links)
,(ee-template0 "\
-;; See: (find-eev-quick-intro \"9.3. Hyperlinks to PDF files\")
+;; See: (find-eev-quick-intro \"9.1. `code-c-d'\")
+;; (find-eev-quick-intro \"9.3. Hyperlinks to PDF files\")
;; (find-eev-quick-intro \"9.4. Shorter hyperlinks to PDF files\")
;; (find-eev-quick-intro \"11.1. `find-pdf-links'\")
diff --git a/eev-intro.el b/eev-intro.el
index 4993e03..dad04e8 100644
--- a/eev-intro.el
+++ b/eev-intro.el
@@ -19,7 +19,7 @@
;;
;; Author: Eduardo Ochs <address@hidden>
;; Maintainer: Eduardo Ochs <address@hidden>
-;; Version: 2019jun22
+;; Version: 2019jun23
;; Keywords: e-scripts
;;
;; Latest version: <http://angg.twu.net/eev-current/eev-intro.el>
@@ -470,26 +470,30 @@ For example,
(find-efunction-links 'find-file)
creates this buffer, and switches to it:
- ___________________________________________________________
- |# (find-efunction-links 'find-file) |
- |# (where-is 'find-file) |
- |# (describe-function 'find-file) |
- |# (find-efunctiondescr 'find-file) |
- |# (find-efunction 'find-file) |
- |# (find-efunctionpp 'find-file) |
- |# (find-efunctiond 'find-file) |
- |# (find-estring (documentation 'find-file)) |
- |# (find-estring (documentation 'find-file t)) |
- |# (symbol-file 'find-file 'defun) |
- |# (find-fline (symbol-file 'find-file 'defun)) |
- | |
- |# (Info-goto-emacs-command-node 'find-file) |
- |# (find-enode \"Command Index\" \"* find-file:\") |
- |# (find-elnode \"Index\" \"* find-file:\") |
- | |
- | |
- |--:**- *Elisp hyperlinks* All L1 (Fundamental eev)--|
- |___________________________________________________________|
+ ____________________________________________________________________
+ |# (find-efunction-links 'find-file) |
+ |# (eek \"M-h M-f find-file\") |
+ |# (find-eev-quick-intro \"4.2. `find-ekey-links' and friends\") |
+ | |
+ |# (find-efunctiondescr 'find-file) |
+ |# (find-efunction 'find-file) |
+ |# (find-efunctionpp 'find-file) |
+ |# (find-efunctiond 'find-file) |
+ | |
+ |# (Info-goto-emacs-command-node 'find-file) |
+ |# (find-enode \"Command Index\" \"* find-file:\") |
+ |# (find-elnode \"Index\" \"* find-file:\") |
+ | |
+ |# (where-is 'find-file) |
+ |# (symbol-file 'find-file 'defun) |
+ |# (find-fline (symbol-file 'find-file 'defun)) |
+ |# (find-estring (documentation 'find-file)) |
+ |# (find-estring (documentation 'find-file t)) |
+ |# (describe-function 'find-file) |
+ | |
+ | |
+ | -:**- *Elisp hyperlinks* All L1 (Fundamental eev) ----------|
+ |____________________________________________________________________|
@@ -508,23 +512,24 @@ elisp hyperlinks buffer containing some hyperlinks to
\"here\" - and how
it does that depends on the major mode and on the name of the current
buffer. For example, typing `M-h M-h' here generates:
- ____________________________________________________________
- |# See: |
- |# (find-links-intro \"`find-here-links'\") |
- |# (find-efunctiondescr 'eev-mode \"M-h M-h\") |
- | |
- |http://angg.twu.net/eev-intros/find-eev-quick-intro.html |
- |# (find-eev-quick-intro) |
- | |
- | |
- |--:**- *Elisp hyperlinks* All L1 (Fundamental eev) -|
- |____________________________________________________________|
+ ___________________________________________________________________
+ |# See: |
+ |# (find-eev-quick-intro \"4.1. `find-here-links'\") |
+ |# (find-emacs-keys-intro \"1. Basic keys (eev)\" \"M-h M-h\") |
+ |# (find-here-links-intro \"4. `find-here-links-3'\") |
+ | |
+ |# http://angg.twu.net/eev-intros/find-eev-quick-intro.html |
+ |# (find-eev-quick-intro) |
+ | |
+ | |
+ | -:**- *Elisp hyperlinks* All L1 (Fundamental eev) --------|
+ |___________________________________________________________________|
The elisp hyperlink
# (find-eev-quick-intro)
-opens this tutorial.
+at the end opens this tutorial.
The best way to learn how to create very quickly these
\"hyperlinks to things we saw or visited\" and to copy them to
@@ -542,6 +547,58 @@ explained here:
+4.2. `find-ekey-links' and friends
+----------------------------------
+Emacs is huge and you will probably want to save in your notes
+many links about keys and functions that look interesting - using
+`M-2 M-j' from time to time to visit
+
+ (find-emacs-keys-intro)
+
+and learning the keys listed there will not be enough.
+
+Try the eek links below:
+
+ (eek \"M-h M-k C-x 4 0\")
+ (eek \"M-h M-k C-x 4 0 ;; kill-buffer-and-window\")
+ (eek \"M-h M-k C-s\")
+ (eek \"M-h M-k C-s ;; isearch-forward\")
+ (eek \"M-h M-f isearch-forward\")
+
+ (eek \"M-h M-k M-h M-k ;; find-ekey-links\")
+ (eek \"M-h M-k M-h M-f ;; find-efunction-links\")
+
+You will notice that:
+
+ 1. they create temporary buffers with lots of elisp hyperlinks,
+
+ 2. you can \"go back\" from these buffers with `M-k',
+
+ 3. the function name after the \";;\" is a comment and is
+ ignored by Emacs (but is useful for humans),
+
+ 4. you can copy these hyperlinks to your \"~/TODO\",
+
+ 5. the \"M-h M-k\" and \"M-h M-f\" in the beginning are
+ reminders that we can use `M-h M-k <key-sequence>' and `M-h
+ M-f <function-name>' to create help buffers about other keys
+ and functions,
+
+ 6. for _some_ keys and functions, but not all, the hyperlinks
+ like
+
+ (Info-goto-emacs-key-command-node \"\\C-s\")
+ (Info-goto-emacs-command-node 'isearch-forward)
+ (find-enode \"Command Index\" \"* isearch-forward:\")
+ (find-elnode \"Index\" \"* defun:\")
+
+ that appear near the bottom of the elisp hyperlinks buffers,
+ point to relevant points in the Emacs manuals - see the next
+ section.
+
+
+
+
5. Links to Emacs documentation
===============================
Try these links (some of them need the Emacs manuals installed):
@@ -2022,11 +2079,6 @@ Eev has a git repository at:
https://github.com/edrx/eev.git
-All recent changes are being made at the \"UTF-8\" branch and I
-haven't learned yet how to make the master branch point to
-UTF-8... so if you clone the repository you'll have to do a
-\"checkout UTF-8\" the go to the most recent version.
-
Try this:
(eepitch-shell)
@@ -2036,7 +2088,6 @@ rm -Rfv /tmp/eev2
mkdir /tmp/eev2/
cd /tmp/eev2/ && git clone https://github.com/edrx/eev.git .
cd /tmp/eev2/
-git checkout UTF-8
# (find-gitk \"/tmp/eev2/\")
{
echo '#!/bin/sh'
@@ -2589,9 +2640,11 @@ This buffer is _temporary_ and _editable_.
It is meant as both a tutorial and a sandbox.
-(find-eval-intro \"9. Producing and refining hyperlinks\")
-(find-emacs-keys-intro \"and refining them\")
-(find-eval-intro \"6. Refining hyperlinks\")
+
+This tutorial supposes that you already know how to
+create \"hyperlinks to here\" - see:
+ (find-here-links-intro)
+ (find-emacs-keys-intro \"and refining them\")
@@ -2770,6 +2823,10 @@ sequence intended for beginners. I prefer to use
something like
4. A tip for beginners
======================
+TODO: Rewrite this section! It was mostly superseded by:
+
+ (find-here-links-intro \"4. `find-here-links-3'\")
+
Some people find the instructions above hard to follow because
they force them to remember lots of things that are off-screen.
If you run the second sexp below,
- [elpa] externals/eev updated (3c15e4b -> e836949), Stefan Monnier, 2019/06/25
- [elpa] externals/eev e89c18c 01/10: Added more tutorial links to `find-code-pdf-links'., Stefan Monnier, 2019/06/25
- [elpa] externals/eev b6940a2 02/10: Rewrote the section "The first line regenerates the buffer" in (find-links-intro)., Stefan Monnier, 2019/06/25
- [elpa] externals/eev 7b8924c 04/10: make `find-pdf-page' use texworks on M$ Windows., Stefan Monnier, 2019/06/25
- [elpa] externals/eev 0ac2da4 07/10: Added some figures to (find-here-links-intro)., Stefan Monnier, 2019/06/25
- [elpa] externals/eev 5b27f53 09/10: Added `find-urlretrieve'., Stefan Monnier, 2019/06/25
- [elpa] externals/eev 153017a 06/10: Fixed some typos in eev-pdflike.el., Stefan Monnier, 2019/06/25
- [elpa] externals/eev 38a290a 03/10: Added `M-h M-3' and documentation for it., Stefan Monnier, 2019/06/25
- [elpa] externals/eev 26bd206 05/10: New section: (find-eev-quick-intro "4.2. `find-ekey-links' and friends"),
Stefan Monnier <=
- [elpa] externals/eev 9417a58 08/10: Small changes in `find-here-links-3'., Stefan Monnier, 2019/06/25
- [elpa] externals/eev e836949 10/10: Merge remote-tracking branch 'eev/UTF-8' into externals/eev, Stefan Monnier, 2019/06/25