emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Removed unnecessary text in TUTORIAL and made some changes


From: Shynur Xie
Subject: [PATCH] Removed unnecessary text in TUTORIAL and made some changes
Date: Fri, 21 Apr 2023 16:00:59 +0000

Let me explain the reasons for those nontrivial modifications:

Added a period at the end of L7 (the 7th line of the original TUTORIAL
file), just like L9.

Since which key-chord C-<key> or M-<key> stands for has been explained
at L3-11, I modified/removed:
L21: "do it by holding down the CONTROL key while typing v"
L35: "hold down the META key and type v"
L119: "M-f (META-f) moves ..."
L173: "M-< (META Less-than)"
L174: "M-> (META Greater-than)"
L278: "CONTROL-x"
L289: "CONTROL-x"
L818: "M-q (META-q)"
L922: "CONTROL-v"
L923: "CONTROL-<ESC>"
L1000: "CONTROL-h"
L1054: "META-x"

The sentence (at L30-31) “Don't worry if you change this text before
we tell you to; that is called "editing" and that's what Emacs is
for.” is unnecessary, instead, I cut “Don't worry about this file
being changed; you will not alter the master tutorial.  This is your
personal copy of it.” from L311-313 and pasted it to L30 with my
modification.

Complemented 2 empty lines between the sections [SUMMARY] and [BASIC
CURSOR CONTROL] to uniform the style.

Removed "without the shift key, you would be typing M-comma" at L179
because it is obviously that typing comma-key without shift-key
usually can't emit a '<' character.

Since what <SPC> stands for has been explained at L260, I removed
"(<SPC> is the Space bar.)" at L377.

Changed "the Emacs manual" to "the GNU Emacs Manual" in order to make
it consistent with the manual (See L16 at
<git.savannah.gnu.org/cgit/emacs.git/tree/doc/emacs/emacs.texi#n16>
).

The sentence (at L478) "but is a little less convenient to type" makes
no sense, so I replaced it with "C-x u (Undo) also works exactly like
C-/."  There are 2 reasons:
1. See <gnu.org/software/emacs/manual/html_node/emacs/Undo.html#FOOT6>
   for what the 'u' stands for.
2. The style of writing "C-x u (Undo)" is consistent with "C-v (View
   next screen)" at L20.

The sentence (at L528) "So you do not find any file." is redundant
compared by its previous several lines:
“While you are entering the file name (or any minibuffer input), you
 can cancel the command with C-g.
 >> Type C-x C-f, then type C-g.  This cancels the minibuffer, and
    also cancels the C-x C-f command that was using the minibuffer.
    So you do not find any file.”

Replaced "Wrote ...TUTORIAL" with "Wrote TUTORIAL".  See the
definition of `write-region' for the message emitted by C-x C-s.

I removed some of the conversational elements (e.g., "Did you see what
happened?" at L851), but deliberately kept some in.  This was
intentional, so that readers could still feel the familiarity from
TUTORIAL's writing style.

The sentence (at L528) "To exit Emacs use C-x C-c." is redundant
because how to exit Emacs has been explained at L13/641/657, so I
removed it.

(End of Explanation)

____________________

A classmate and a friend of mine complained to me a few days ago that
Emacs documentation is too lengthy and overwhelming.  While I don't
entirely agree, it's clear that the TUTORIAL could be shortened, at
least to not discourage newcomers with its length.  So I made this
patch.

>From a beginner's perspective (I've consulted with my classmate who is
an Emacs novice and just started a few days ago), these modifications
didn't make anything unclear.

--
shynur

Attachment: 0001-Removed-unnecessary-text-in-TUTORIAL-and-made-some-c.patch
Description: 0001-Removed-unnecessary-text-in-TUTORIAL-and-made-some-c.patch


reply via email to

[Prev in Thread] Current Thread [Next in Thread]