[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/eev bfd11b4 47/64: Added some sections to `find-escript
From: |
Stefan Monnier |
Subject: |
[elpa] externals/eev bfd11b4 47/64: Added some sections to `find-escripts-intro' |
Date: |
Sun, 7 Apr 2019 16:59:11 -0400 (EDT) |
branch: externals/eev
commit bfd11b4f513a7743fa7cc145e4c372a7813f257e
Author: Eduardo Ochs <address@hidden>
Commit: Eduardo Ochs <address@hidden>
Added some sections to `find-escripts-intro'
---
VERSION | 4 ++--
eev-intro.el | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 69 insertions(+), 2 deletions(-)
diff --git a/VERSION b/VERSION
index 6c0c1d2..ddb55e6 100644
--- a/VERSION
+++ b/VERSION
@@ -1,2 +1,2 @@
-Sat Mar 2 16:16:53 GMT 2019
-Sat Mar 2 13:16:53 -03 2019
+Sun Mar 3 00:17:28 GMT 2019
+Sat Mar 2 21:17:28 -03 2019
diff --git a/eev-intro.el b/eev-intro.el
index ffe009e..b109349 100644
--- a/eev-intro.el
+++ b/eev-intro.el
@@ -8061,8 +8061,75 @@ follow these conventions:
+4.7. A convention about order
+-----------------------------
+(Explain why I feel natural to put the eepitch block that
+installs the lua5.1 packages at the end of the first e-script
+block, after the hyperlinks to files from that package)
+
+
+
+
+
+
+
+
5. Tools for writing e-scripts
==============================
+One of my favorite ways of describing eev is as a \"tool to
+create executable logs\", but this only make sense if we clarify
+some ideas and terms. The e-script in Example 1 has two e-script
+blocks plus an index. The fist block has notes about installing
+the packages for Lua5.1 in Debian and inspecting them, and the
+second block is about downloading and using an eev-based Lua
+tutorial. Let's think of each of these blocks as a _task_.
+
+The task \"install Lua5.1\" is performed in one way if we're
+doing it for the first time, and in a different was if we're
+doing it for the n-th time with some memory of what we did in the
+previous times and of what we found important and what not.
+Performing a task like this consists of several steps, that can
+be roughly divided into \"visiting\" and \"commands\". I borrowed
+the term \"visiting\" from Emacs:
+
+ (find-enode \"Visiting\" \"Visiting Files\")
+
+Look at the first block of Example 1 again. It has several elisp
+hyperlinks to information about the packages \"lua5.1\" and
+\"lua5.1-doc\". Following those hyperlinks let us \"visit\" the
+descriptions of the two packages, their lists of files, and some
+of their directories. Then the e-script block has three URL links
+to the Lua documentation in general and to its reference manual,
+and then an eepitch block that runs an \"apt-get install\".
+
+We saw how to follow links and how to execute eepitch blocks, so
+an e-script block is \"executable\". But in what sense it is a
+\"log\"?
+
+ 1. In the old days log books were always made of paper, and
+ there was nothing automatic in taking notes with them. We
+ would have to decide what to write and how to write it, and
+ we would have to alternate between the \"task\" and \"taking
+ notes\". After many years of practice people _some_ people
+ would learn how to take notes without distract themselves
+ much from the task at hand, and they would learn how to make
+ their notes at the same time concise and readable enough.
+
+ 2. Nowadays, with computers, there are _some_ ways to write
+ logs automatically - for example, most shells record the
+ commands given to them - but the output is of low quality.
+
+ 3. Eev takes an intermediate stance between \"notes by hand\"
+ and \"automatic notes\". It is possible to do
+ \"task\"+\"notes\" with just a few more keystrokes than for
+ doing just \"task\", but that requires learning some tricks,
+ and having some practice.
+
+The next sections discuss those tricks.
+
+
+
+
5.1. Anchors-to pairs and e-script blocks
-----------------------------------------
- [elpa] externals/eev c920947 38/64: Part of eev-plinks.el was commented out by accidented; fixed that., (continued)
- [elpa] externals/eev c920947 38/64: Part of eev-plinks.el was commented out by accidented; fixed that., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 244f47a 34/64: Made eev-intro.el require info.el., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 95052ba 55/64: Added several fields to eev-pkg.el., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 3950e1e 16/64: First commit in two years; `find-eev-quick-intro', `to-latin1', and lots more, Stefan Monnier, 2019/04/07
- [elpa] externals/eev eee817f 56/64: Added a README (for the ELPA package)., Stefan Monnier, 2019/04/07
- [elpa] externals/eev e0d1bf1 44/64: Added some sections to `find-escripts-intro'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev d671913 61/64: Rewrote `ee-code-c-d-rest'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 3baac40 43/64: Added some sections to `find-escripts-intro'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 2dadb94 52/64: Added `find-pdftools-page'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev de74bf9 35/64: Added lots of comments., Stefan Monnier, 2019/04/07
- [elpa] externals/eev bfd11b4 47/64: Added some sections to `find-escripts-intro',
Stefan Monnier <=
- [elpa] externals/eev 082a9f4 42/64: Changes in parts of `find-eev-intro' and `find-escripts-intro'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev e4d30ff 39/64: Rewrote parts of `find-escripts-intro' and `find-links-intro'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev f974ef7 37/64: Added lots of comments to eev-plinks.el., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 41323e0 58/64: Moved the function `ee-template0' to the file eev-template0.el., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 3325b83 41/64: Some clean-ups in the code for `find-eintro-links' and `find-einfo-links'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 8afeb43 45/64: Cleaned up eev-mode.el and other files., Stefan Monnier, 2019/04/07
- [elpa] externals/eev 8179ff8 19/64: Make `find-eev-quick-intro\' and `find-emacs-keys-intro\' more important, Stefan Monnier, 2019/04/07
- [elpa] externals/eev 4e07159 57/64: Added some comments to eepitch.el., Stefan Monnier, 2019/04/07
- [elpa] externals/eev f6fd28a 62/64: Cleaned up the comments about `ee-code-c-d-filter-2'., Stefan Monnier, 2019/04/07
- [elpa] externals/eev fc52991 32/64: Fontify the `find-xxx-intro' buffers., Stefan Monnier, 2019/04/07