Skip to content

Commit 9569fc5

Browse files
committed
Edited the Emacs seciton.
1 parent 7f7b4e2 commit 9569fc5

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

index.html

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ <h3>Navigating this document</h3>
334334

335335
<p>
336336
<em>pymolsnips</em> is a library of pml code fragments that have been formatted for several popular <em>text editors</em>.
337-
Note the word processors (e.g., MS Word, Libre Office, Open Office) are not included here: <em>word processors should never be used to store computer code!</em>
337+
Note that the word processors (e.g., MS Word, Libre Office, Open Office) are not included here: <em>word processors should never be used to store computer code!</em>
338338
If you do so, you can inadvertently pick up hidden characters that are hard to find and remove during debugging.
339339
In addition, word processing documents are usually binary files that are difficult to put under version control.
340340
</p>
@@ -351,7 +351,7 @@ <h3>Navigating this document</h3>
351351
Most editors have their own format for snippets.
352352
The user downloads the file or folder of snippet files for their text editor and then installs the snippets according to the requirements for a particular text editor.
353353
The one exception is the CudaText editor.
354-
The snippets come pre-installed with this editor.
354+
The pymolsnips snippets come pre-installed with this editor.
355355
</p>
356356

357357
<p>
@@ -792,14 +792,14 @@ <h3>Installing and using snippets with CudaText</h3>
792792

793793
<p>
794794
Over 100 other variants of <em>Emacs</em> are available.
795-
<em>Spacemacs</em> is a version that has a gentler learning curve in part because it can be driven by a menu of commands that is readily accessible.
796-
<em>Spacemacs</em> allows the use of Vim key bindings, <em>Emacs</em> key bindings, or both.
795+
<em>Spacemacs</em> has a gentler learning curve in part because it can be driven by a menu of commands that is readily accessible.
796+
<em>Spacemacs</em> allows the use of <em>Vim</em> key bindings, <em>Emacs</em> key bindings, or both.
797797
<em>Spacemacs</em> does have its own keybindings that have to be mastered.
798-
This leads to the problem of needing to translate <em>Spacemacs</em> to Gnu <em>Emacs</em> and back again when tapping into external <em>Emacs</em> resources.
798+
This leads to the problem of needing to translate <em>Spacemacs</em> to <em>GNU Emacs</em> and back again when tapping into external <em>Emacs</em> resources.
799799
</p>
800800

801801
<p>
802-
<em>Doom Emacs</em> and <em>Prelude Emacs</em> are additional off-shoots of <em>Emacs</em> that are suppose to be easier to adopt.
802+
<em>Doom Emacs</em> and <em>Prelude Emacs</em> are additional popular variants of <em>Emacs</em> that are suppose to be easier to adopt.
803803
They are similar to <em>Spacemacs</em>.
804804
</p>
805805

@@ -808,15 +808,16 @@ <h3>Installing and using snippets with CudaText</h3>
808808
</p>
809809

810810
<p>
811-
For several reasons, we recommend becoming productive in GNU <em>Emacs</em> first before trying the <em>Emacs</em> variants.
811+
For several reasons, we recommend becoming productive in <em>GNU Emacs</em> first before trying the <em>Emacs</em> variants.
812812
First, the on-line resources that support mastery of GNU <em>Emacs</em> are far greater than the resources that support the variants.
813-
Second, the documentation for the variants assumes a significant amount of prior knowledge of GNU <em>Emacs</em>.
814-
Third, these variants run on top of GNU <em>Emacs</em>.
813+
Second, the documentation for the variants assume significant prior knowledge of <em>GNU Emacs</em>.
814+
Third, these variants run on top of <em>GNU Emacs</em>.
815+
You will eventually have to learn <em>GNU Emacs</em> as you master one of these variants.
815816
</p>
816817

817818
<p>
818-
It takes one to two weeks of nibbling away at <em>Emacs</em> tutorials to become productive at text editing in <em>Emacs</em>.
819-
There is a built-in tutorial in <em>Emacs</em> as well as many on-line tutorials.
819+
It takes one to two weeks of nibbling away at <em>GNU Emacs</em> tutorials to become productive at text editing in <em>Emacs</em>.
820+
There is a built-in tutorial in <em>GNU Emacs</em> as well as many on-line tutorials.
820821
A visually appealing tutorial is available <a href="https://www.gnu.org/software/emacs/tour/">here</a>.
821822
</p>
822823

@@ -828,6 +829,7 @@ <h3>Installing and using snippets with CudaText</h3>
828829
<p>
829830
The one danger of <em>Emacs</em> is that it is easy to spend countless of hours configuring the <em>init.el</em> file and adding additional packages.
830831
Many beginners spend too much time adding too many packages, most of which they never use.
832+
We know this from personal experience.
831833
As a beginner, you should ease off editing your <em>init.el</em> file if it has grown to 500 lines in the first several weeks of using <em>Emacs</em>.
832834
A good practice is to add one package at a time and master each added package before adding another new package.
833835
</p>
@@ -857,7 +859,7 @@ <h3>Installing and using snippets with CudaText</h3>
857859
</p>
858860

859861
<p>
860-
The interface to <em>Emacs</em> is either a X-terminal window or a simple GUI that can be made complex by opening many <em>buffers</em>, which are like windows.
862+
The interface to <em>Emacs</em> is either an X-terminal window or a simple GUI that can be made complex by opening many <em>buffers</em>, which are like windows.
861863
The management and navigation of buffers is a skill that the beginner needs to master early.
862864
</p>
863865

@@ -871,20 +873,20 @@ <h3>Installing and using snippets with CudaText</h3>
871873
</p>
872874

873875
<p>
874-
Vim users can quickly become productive in <em>Emacs</em> because the Vim key bindings are available through the add-on package called evil-mode.
875-
Mastery of the Vim key bindings in Vim is initially painful because it is like learning how to type for the first time.
876-
Here again, mastery of a few dozen key bindings will enable you to be productive in Vim and in Evil-mode in <em>Emacs</em>.
876+
<em>Vim</em> users can quickly become productive in <em>Emacs</em> because the <em>Vim</em> key bindings are available through the add-on package called evil-mode.
877+
Mastery of the <em>Vim</em> key bindings in <em>Vim</em> is initially painful because it is like learning how to type for the first time.
878+
Here again, mastery of a few dozen key bindings will enable you to be productive in <em>Vim</em> and in Evil-mode in <em>Emacs</em>.
877879
<em>Vim</em> key bindings are thought to bear more efficient for editing text than <em>Emacs</em> key-bindings, so their availability in <em>Emacs</em> greatly enhances a <em>Vim</em> user's productivity in </em>Emacs</em>.
878880
</p>
879881

880882
<p>
881883
Mastery of <em>Vim</em> key-bindings is a wise investment because they are available in many text editors and IDEs.
882884
They are even available in <em>Jupyter Notebooks</em>!
883-
In addition, Vim is more widely distributed than <em>Emacs</em>.
885+
In addition, <em>Vim</em> is more widely distributed than <em>Emacs</em>.
884886
</p>
885887

886888
<p>
887-
If you are a user of national laboratory computer systems, be cautious with your fantasy of being able to transfer your <em>init.el</em> file and reestablish your <em>Emacs</em> computing environment.
889+
If you use a national laboratory computer system, restrain your fantasy of being able to transfer your <em>init.el</em> file and reestablish your <em>Emacs</em> computing environment.
888890
Many national facilities use Centos Linux and are unable or unwilling to make available the most recent stable version of <em>Emacs</em>.
889891
I have found that the available versions are several years out of date and hence difficult to install all of my favorite packages.
890892
It may take an hour of removing calls to install incompatible packages before you can establish a subset of your favorite packages.
@@ -913,18 +915,18 @@ <h3>Installing and using snippets with CudaText</h3>
913915

914916
<p>
915917
The <em>.emacs.d</em> configuration directory is a hidden directory in the home directory.
916-
It is the home of the installed packages and plugins.
917-
</p>
918-
919-
<p>
918+
This directory is the home of the installed packages and plugins.
920919
The main configuration file resides is this directory and is named <em>init.el</em>.
921-
The <em>init.el</em> file is the analog of Vim's <em>.vimrc</em> configuration file.
920+
The <em>init.el</em> file is the analog of <em>Vim</em> 's <em>.vimrc</em> configuration file.
922921
The commands in the <em>init.el</em> file are written in elisp.
923922
Fortunately, <em>elisp</em> is easy to edit and augment without knowing much about how to program with <em>elisp</em>.
924923
</p>
925924

926925
<p>
927-
I store my configuration in a <em>config.el</em> file (see file listing at top of page).
926+
I store my configuration in a <em>config.org</em> file (see file listing at top of page).
927+
The org file is written in org-mode markdown.
928+
The lisp commands are placed in code blocks .
929+
The code is extracted from the oth file and
928930
</p>
929931

930932
<h3>Installing <em>Emacs</em></h3>
@@ -934,7 +936,7 @@ <h3>Installing <em>Emacs</em></h3>
934936
<p>
935937
<em>Emacs</em> can be downloaded <a href="https://www.gnu.org/software/emacs/">from</a> and insalled with a platform specific installer.
936938
Older versions of <em>Emacs</em> comes pre-installed on Mac OS, but you may want a more recent version.
937-
You should remove the old version with the commands <code>sudo rm /usr/bin/emacs</code> and <code>sudo rm -rf /usr/share/emacs</code>.
939+
You should remove the old version(s) of Emacs with the commands <code>sudo rm /usr/bin/emacs</code> and <code>sudo rm -rf /usr/share/emacs</code>.
938940
Binaries for the Mac are <a href="https://emacsformacosx.com">available</a>.
939941
As of August 2020, version 27.1-1 is the stable release.
940942
</p>
@@ -965,7 +967,7 @@ <h3>Installing and using snippets with <em>Emacs</em></h3>
965967
</p>
966968
<p>
967969
Each snippet is stored in a single file.
968-
The files are stored in a subfolder in the hidden folder <code>~.eamcs.d/plugins/</code> in the home directory.
970+
The files are stored in a subfolder in the hidden folder <code>~/.eamcs.d/plugins</code> in the home directory.
969971
</p>
970972

971973
<h1>Variants of <em>Emacs</em> to consider</h1>
@@ -1449,25 +1451,25 @@ <h3>Installing and using snippets with Micro</h3>
14491451

14501452

14511453
<a name='Neovim'><h2>Neovim</h2></a>
1452-
This a recent branch of Vim.
1454+
This a recent branch of <em>Vim</em>.
14531455
Much of the <a href=#Vim>Vim</a> section applies.
14541456

14551457

14561458

14571459
<a name="spacemacs"><h2>Spacemacs (Universal)</h2></a>
14581460

14591461
<p>
1460-
Spacemacs (pronounced <em>space macs</em>) is a <em>Vim</em> emulator that runs on top of <em>Emacs</em>.
1462+
Spacemacs (pronounced <em>space macs</em>) runs on top of <em>Emacs</em>.
14611463
Its command leader is the spacebar hence the word <em>space</em> in the name.
1462-
It is very different from running the <em>Emacs</em> in evil-mode (evil-mode enables the use of Vim keybindings in <em>Emacs</em>).
1464+
It is very different from running the <em>Emacs</em> in evil-mode (evil-mode enables the use of <em>Vim</em> keybindings in <em>Emacs</em>).
14631465
As a result, it should be treated as a separate editor from <em>Emacs</em> and <em>Vim</em>.
14641466
</p>
14651467

14661468
<p>
14671469
<em>Spacemacs</em> has its own set of mnemonic commands that you need to master.
14681470
In other words, you will use <em>Vim</em>, <em>Emacs</em>, and <em>Spacemacs</em> commands in one editor.
14691471
It might be less intimidating if you have mastered some of the basics of <em>Vim</em> and <em>Emacs</em>.
1470-
<em>Spacemacs</em> does not go as far as allowing you to use Vim plugins and configurations although you do have full access to the emacs plugins which are known as packages.
1472+
<em>Spacemacs</em> does not go as far as allowing you to use <em>Vim</em> plugins and configurations although you do have full access to the emacs plugins which are known as packages.
14711473
</p>
14721474

14731475
<h3>Installing and using snippets with Spacemacs</h3>
@@ -1656,7 +1658,7 @@ <h3>Installing and using snippets with TextMate</h3>
16561658
A newer branch of <em>Vim</em>called <em>neovim</em> is also available.
16571659
<em>Vim</em> and <em>neovim</em> are available from software managers like MacPorts, fink, Homebrew, Anaconda, or it can be downloaded as a <a href="https://www.vim.org/download.php"> stand-alone application</a>.
16581660
The standard versions of both run in the terminal.
1659-
MacVim provides a GIU version of <em>Vim</em>.
1661+
<em>MacVim</em> provides a GIU version of <em>Vim</em>.
16601662
This version of <em>Vim</em> is integrated with Mac OS.
16611663
Unless you a developer of GUI applications for the Mac, you probably want to stick to the terminal version
16621664
</p>
@@ -1667,7 +1669,7 @@ <h3>Installing and using snippets with TextMate</h3>
16671669
That bug has been fixed in version 8.1.2152.
16681670
I found that the MacPorts Vim was behind this version.
16691671
I tried to compile <em>Vim</em> version 8.2.12; I gave up due to inference with the conda in the <em>Julia</em> installed by <em>Homebrew</em>.
1670-
So I gave up my approach using macports, and I installed Vim version 8.2.0 via <em>Homebrew</em>.
1672+
So I gave up my approach using macports, and I installed <em>Vim</em> version 8.2.0 via <em>Homebrew</em>.
16711673
This version worked fine.
16721674
It has been automatically updated to 8.2.1950 when running <em>brew update</em>.
16731675
</p>

0 commit comments

Comments
 (0)