Merge pull request #25206 from neovim/backport-25204-to-release-0.9

[Backport release-0.9] docs(tutor): clarify the meaning of ✗ and ✓
This commit is contained in:
zeertzjq 2023-09-17 09:06:21 +08:00 committed by GitHub
commit 26c6d78a0c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 48 additions and 49 deletions

View File

@ -3,6 +3,7 @@
Neovim is a very powerful editor that has many commands, too many to explain in Neovim is a very powerful editor that has many commands, too many to explain in
a tutorial such as this. This tutorial is designed to describe enough of the a tutorial such as this. This tutorial is designed to describe enough of the
commands that you will be able to easily use Neovim as an all-purpose editor. commands that you will be able to easily use Neovim as an all-purpose editor.
It is IMPORTANT to remember that this tutorial is set up to teach by use. That It is IMPORTANT to remember that this tutorial is set up to teach by use. That
means that you need to do the exercises to learn them properly. If you only means that you need to do the exercises to learn them properly. If you only
read the text, you will soon forget what is most important! read the text, you will soon forget what is most important!
@ -19,17 +20,16 @@ pressing [<Esc>](<Esc>) and then [u](u) will undo the latest change.
This tutorial is interactive, and there are a few things you should know. This tutorial is interactive, and there are a few things you should know.
- Type [<Enter>](<Enter>) on links [like this](holy-grail ) to open the linked help section. - Type [<Enter>](<Enter>) on links [like this](holy-grail ) to open the linked help section.
- Or simply type [K](K) on any word to find its documentation! - Or simply type [K](K) on any word to find its documentation!
- You can close this help window with `:q`{vim} - You can close this help window with `:q`{vim} `<Enter>`{normal}
- Sometimes you will be required to modify text like
this here
When there is a ✗ sign at the left, you will be required to modify text.
Once you have done the changes correctly, the ✗ sign at the left will change Once you have done the changes correctly, the ✗ sign at the left will change
to ✓. I imagine you can already see how neat Neovim can be. to ✓. I imagine you can already see how neat Neovim can be.
Other times, you'll be prompted to run a command (I'll explain this later): Other times, you'll be prompted to run a command (I'll explain this later):
~~~ cmd
:help <Enter> `:help`{vim} `<Enter>`{normal}
~~~
or press a sequence of keys or press a sequence of keys
~~~ normal ~~~ normal
<Esc>0f<Space>d3wP$P <Esc>0f<Space>d3wP$P
@ -70,19 +70,19 @@ NOTE: The cursor keys should also work. But using hjkl you will be able to
2. Type: 2. Type:
`:q!`{vim} `<Enter>`{normal}. `:q!`{vim} `<Enter>`{normal}
This quits the editor, DISCARDING any changes you have made. This quits the editor, DISCARDING any changes you have made.
3. Open Neovim and get back here by executing the command that got you into 3. Open Neovim and get back here by executing the command that got you into
this tutorial. That might be: this tutorial. That might be:
:Tutor <Enter> `:Tutor`{vim} `<Enter>`{normal}
4. If you have these steps memorized and are confident, execute steps 4. If you have these steps memorized and are confident, execute steps
1 through 3 to exit and re-enter the editor. 1 through 3 to exit and re-enter the editor.
NOTE: [:q!](:q) <Enter> discards any changes you made. In a few lessons you NOTE: [:q!](:q) `<Enter>`{normal} discards any changes you made. In a few lessons you
will learn how to save the changes to a file. will learn how to save the changes to a file.
5. Move the cursor down to Lesson 1.3. 5. Move the cursor down to Lesson 1.3.

View File

@ -1,6 +1,5 @@
{ {
"expect": { "expect": {
"25": -1,
"103": "The cow jumped over the moon.", "103": "The cow jumped over the moon.",
"125": "There is some text missing from this line.", "125": "There is some text missing from this line.",
"126": "There is some text missing from this line.", "126": "There is some text missing from this line.",

View File

@ -229,11 +229,11 @@ These elements are specified in separate JSON files like this
~~~ json ~~~ json
{ {
"expect": { "expect": {
"1": "This is how this line should look.", "1": "This is how this line should look.",
"2": "This is how this line should look.", "2": "This is how this line should look.",
"3": -1 "3": -1
} }
} }
~~~ ~~~

View File

@ -1,35 +1,35 @@
{ {
"expect": { "expect": {
"63": "This is text with **important information**", "63": "This is text with **important information**",
"64": "This is text with **important information**", "64": "This is text with **important information**",
"71": "TODO: Document '&variable'", "71": "TODO: Document '&variable'",
"72": "TODO: Document '&variable'", "72": "TODO: Document '&variable'",
"78": "# This is a level 1 header", "78": "# This is a level 1 header",
"79": "# This is a level 1 header", "79": "# This is a level 1 header",
"80": "### This is a level 3 header", "80": "### This is a level 3 header",
"81": "### This is a level 3 header", "81": "### This is a level 3 header",
"82": "# This is a header with a label {*label*}", "82": "# This is a header with a label {*label*}",
"83": "# This is a header with a label {*label*}", "83": "# This is a header with a label {*label*}",
"108": "A link to help for the ['breakindent']('breakindent') option", "108": "A link to help for the ['breakindent']('breakindent') option",
"109": "A link to help for the ['breakindent']('breakindent') option", "109": "A link to help for the ['breakindent']('breakindent') option",
"123": "A link to the [Links](*links*) section", "123": "A link to the [Links](*links*) section",
"124": "A link to the [Links](*links*) section", "124": "A link to the [Links](*links*) section",
"139": "A link to [the vim-tutor-mode tutorial](@tutor:tutor)", "139": "A link to [the vim-tutor-mode tutorial](@tutor:tutor)",
"140": "A link to [the vim-tutor-mode tutorial](@tutor:tutor)", "140": "A link to [the vim-tutor-mode tutorial](@tutor:tutor)",
"157": "~~~ viml", "157": "~~~ viml",
"158": "echom 'the value of &number is'.string(&number)", "158": "echom 'the value of &number is'.string(&number)",
"159": "~~~", "159": "~~~",
"161": "~~~ viml", "161": "~~~ viml",
"162": "echom 'the value of &number is'.string(&number)", "162": "echom 'the value of &number is'.string(&number)",
"163": "~~~", "163": "~~~",
"188": "~~~ normal", "188": "~~~ normal",
"189": "d2w", "189": "d2w",
"190": "~~~", "190": "~~~",
"192": "~~~ normal", "192": "~~~ normal",
"193": "d2w", "193": "d2w",
"194": "~~~", "194": "~~~",
"206": "`d2w`{normal}", "206": "`d2w`{normal}",
"207": "`d2w`{normal}", "207": "`d2w`{normal}",
"244": -1 "244": -1
} }
} }