Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve wording and punctuation in meow-tutor #151

Merged
merged 2 commits into from
Dec 23, 2021
Merged

Improve wording and punctuation in meow-tutor #151

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06fa19f
Improve wording and punctuation in meow-tutor V2
Dec 22, 2021
b12be9a
Merge branch 'master' into improve-wording-v3
DogLooksGood Dec 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 40 additions & 35 deletions meow-tutor.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
==================================================================

Meow is yet another modal editing mode for Emacs.
What's modal editing? How to use Meow? Let's start our journey!
What's modal editing? How do I use Meow? Let's start our journey!

If you wonder what a keystroke means when reading this, just ask
Emacs! Press C-h k then press the key you want to query.
Expand Down Expand Up @@ -128,7 +128,7 @@
\\[meow-join] \\[meow-append] - Insert cursor at the start of the line.
\\[meow-line] \\[meow-append] - Insert cursor at the end of the line.

The commands are composable. \\[meow-join] will select the beginning of the
These commands are composable. \\[meow-join] will select the beginning of the
current line up until the end of the non-empty line above.
\\[meow-append] switches to Insert mode at the end of current selection.
Using both commands together will result in the cursor position being at
Expand Down Expand Up @@ -162,16 +162,17 @@
+ Press \\[meow-join] to select the start of the current line and
the non-empty line above.

+ Press \\[meow-append] to enter Insert mode after selected region.
+ Press \\[meow-append] to enter Insert mode, with the cursor position being in front
of the selected region.

=================================================================
= MOTIONS AND SELECTIONS =
=================================================================

Pressing \\[meow-next-word] will select everything from the cursor position until
the end of the current word. Numbers that show up on the screen
indicate a quick way to extend your selection. You can unselect
the region with the \\[meow-cancel-selection] key.
Pressing \\[meow-next-word] will select everything from the cursor position
until the end of the current word.
Numbers that show up on the screen indicate a quick way to extend your selection.
You can unselect the region with the \\[meow-cancel-selection] key.

Pressing \\[meow-kill] will delete the current selection.

Expand All @@ -187,21 +188,21 @@
--> This sentence pencil has vacuum extra words in the it.
This sentence has vacuum words in it.

Note: pressing \\[meow-kill] without selection will delete everything
Note: Pressing \\[meow-kill] without a selection will delete everything
from cursor position until the end of line.

=================================================================
= WORDS VS SYMBOLS =
=================================================================

Pressing \\[meow-mark-word] will select the whole word under the cursor. \\[meow-mark-symbol] will
select whole symbol. Symbols are separated only by whitespace,
select the whole symbol. Symbols are separated only by whitespace,
whereas words can also be separated by other characters.

To understand the difference better do the following exercise:
To understand the difference better, do the following exercise:

1. Move the cursor to the line below marked -->.
2. Use \\[meow-mark-word] and \\[meow-mark-symbol] on each word in a sentece.
2. Use \\[meow-mark-word] and \\[meow-mark-symbol] on each word in a sentence.
3. Observe the difference in selection.

--> Select-this and this.
Expand All @@ -228,7 +229,7 @@
2. Select the word with \\[meow-mark-word].
3. Extend the selection with \\[meow-next-word].
4. Press \\[meow-kill] to delete the selection.
5. (Optional) Try reversing the cursor and extending selection.
5. (Optional) Try reversing the cursor and extending the selection.

--> This sentence is most definitelly not at all short.
This sentence is short.
Expand All @@ -242,9 +243,9 @@
to select multiple lines at once.

1. Move the cursor to the second line below marked -->.
2. Press \\[meow-line] to select the line, and \\[meow-kill] to delete it.
2. Press \\[meow-line] to select the current line, and \\[meow-kill] to delete it.
3. Move to the fourth line.
4. Select 2 lines either by hitting \\[meow-line] twice or \\[meow-line] 2 combination.
4. Select 2 lines either by hitting \\[meow-line] twice or \\[meow-line] 2 in combination.
5. Delete the selection with \\[meow-kill].

--> 1) Roses are red,
Expand Down Expand Up @@ -338,7 +339,9 @@

+ Motion can be repeated multiple times by using a number modifier.

+ Extend selection by THING modifiers (\\[meow-beginning-of-thing] \\[meow-end-of-thing] \\[meow-inner-of-thing] \\[meow-bounds-of-thing])
+ Extend selection by using THING modifiers
Motion Prefix: (\\[meow-beginning-of-thing] \\[meow-end-of-thing] \\[meow-inner-of-thing] \\[meow-bounds-of-thing])
THING as a Suffix: (r,s,c,g,p,l,d,b)

+ Find by a single character with \\[meow-till] and \\[meow-find].

Expand All @@ -348,7 +351,8 @@

Pressing \\[meow-change] will delete the current selection and switch to
Insert mode. If there is no selection it will only delete
the character under the cursor. It is a shorthand for \\[meow-delete] \\[meow-insert].
the character under the cursor and switch to Insert mode.
It is a shorthand for \\[meow-delete] \\[meow-insert].

1. Move the cursor to the line below marked -->.
2. Select the incorrect word with \\[meow-next-word].
Expand All @@ -363,7 +367,7 @@
= KILL ANK YANK =
=================================================================

The \\[meow-kill] also copies the deleted content which can be then
The \\[meow-kill] key also copies the deleted content which can then be
pasted with \\[meow-yank].

1. Move the cursor to the line below marked -->.
Expand All @@ -378,7 +382,7 @@
= SAVE AND YANK =
=================================================================

Pressing \\[meow-save] copies the selection, which can be then pasted
Pressing \\[meow-save] copies the selection, which can then be pasted
with \\[meow-yank] under the cursor.

1. Move the cursor to the line below marked -->.
Expand Down Expand Up @@ -423,22 +427,22 @@
= BEACON (BATCHED KEYBOARD MACROS) =
=================================================================

Keyboard macro is an Emacs builtin function. Now with Meow, it's
Keyboard macro is a function that is built-in to Emacs. Now with Meow, it's
more powerful. We can do things like multi-editing with Beacon
mode in Meow.

Select a region, then press \\[meow-grab] to \"grab\" it, then enter
Insert mode, meow will now enter Beacon mode. Meow will create multiple
cursors and all edits you do to one cursor will be synced to other
cursors after you exit insert mdoe. Type \\[meow-grab] again to cancel
cursors after you exit Insert mode. Type \\[meow-grab] again to cancel
grabbing.

1. Move the cursor to the first line below marked -->.
2. Select the six lines.
3. Type \\[meow-grab] to grab the selection. Edits you
make will be synced to other cursors.
4. Use Insert mode to correct the lines. Then exit insert mode.
Other cursors will fix the other lines after you exit insert mode.
make will be synced to the other cursors.
4. Use Insert mode to correct the lines. Then exit Insert mode.
Other cursors will fix the other lines after you exit Insert mode.
5. Type \\[meow-grab] to cancel the grabbing.

--> Fix th six nes at same ime.
Expand All @@ -463,12 +467,12 @@
1. Move the cursor to the line below marked -->
2. Select the whole line (you know how to do this)
3. Press \\[meow-grab] the grab the selection
4. Press \\[meow-back-word] to create fake cursors at each word beginning
5. Press \\[kmacro-start-macro-or-insert-counter] to start key macro
recording
4. Press \\[meow-back-word] to create fake cursors at the beginning of each word
in the backwards direction.
5. Press \\[kmacro-start-macro-or-insert-counter] to start key macro recording.
6. Edit.
7. Press \\[kmacro-end-or-call-macro] to stop macro recording and apply
to all fake cursors
your edits to all fake cursors.
8. Press \\[meow-grab] again to cancel grab.
--> 1 2 3
[| \"1\" |] [| \"2\" |] [| \"3\" |]
Expand All @@ -486,8 +490,9 @@
5. Meow will start recording. Press \\[meow-change] to switch to Insert mode
(character under current cursor is deleted)
6. type _
7. Press ESC to go back to NORMAL, then macro will be applied to all fake cursors.
8. Press \\[meow-grab] again to cancel grab
7. Press ESC to go back to NORMAL, then the macro will
be applied to all fake cursors.
8. Press \\[meow-grab] again to cancel the grab

--> x-y-foo-bar-baz
x_y_foo_bar_baz
Expand All @@ -497,11 +502,11 @@
=================================================================

The visit command \\[meow-visit] can help to select a symbol in your
buffer with completion. Once you have something selected with \\[meow-visit]
You can use \\[meow-search] to search for the next occurance.
buffer with completion. Once you have something selected with the \\[meow-visit] key,
you can use \\[meow-search] to search for the next occurance of that selection.

If you want a backword search, you can reverse the selection with \\[meow-reverse], because
\\[meow-search] will respect the direction of current selection.
If you want a backword search, you can reverse the selection with \\[meow-reverse]
because \\[meow-search] will respect the direction of the current selection.

1. Move the cursor to the line below marked -->.
2. Select the word \"dog\" with \\[meow-visit] dog RET.
Expand All @@ -516,7 +521,7 @@
the last one, dog says meow

Note: You can also start searching after \\[meow-mark-word] or \\[meow-mark-symbol]. Actually, you
can use \\[meow-search] whenever you have a selection. The search command
can use \\[meow-search] whenever you have any kind of selection. The search command
is built on regular expression. The symbol boundary will be
added to your search if the selection is created with \\[meow-visit], \\[meow-mark-word] and \\[meow-mark-symbol].

Expand All @@ -531,7 +536,7 @@
start with different input.

Once Keypad is started, your single key input, will be treated
as that key pressed with Control.
as that key prefixed with Control.

Let's see some examples:

Expand Down