[vim/vim] Port the tutor plugin from neovim (#6414)
Yegappan Lakshmanan
The github page for this plugin is at
https://github.com/fmoralesc/vim-tutor-mode
A slightly modified version of this is included in neovim. I have ported over
the plugin to Vim (with slight modifications).
You can view, comment on, or merge this pull request online at:
https://github.com/vim/vim/pull/6414
Commit Summary
- Port the tutor plugin from neovim
File Changes
- A runtime/autoload/tutor.vim (219)
- A runtime/doc/pi_tutor.txt (50)
- M runtime/filetype.vim (3)
- A runtime/ftplugin/tutor.vim (45)
- A runtime/plugin/tutor.vim (6)
- A runtime/syntax/tutor.vim (77)
- A runtime/syntax/vimnormal.vim (16)
- A runtime/tutor/en/vim-01-beginner.tutor (979)
- A runtime/tutor/en/vim-01-beginner.tutor.json (45)
- A runtime/tutor/tutor.tutor (247)
- A runtime/tutor/tutor.tutor.json (35)
Patch Links:
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub, or unsubscribe.
codecov[bot]
Codecov Report
Merging #6414 into master will decrease coverage by
0.61%.
The diff coverage isn/a.
@@ Coverage Diff @@ ## master #6414 +/- ## ========================================== - Coverage 88.11% 87.50% -0.62% ========================================== Files 144 143 -1 Lines 159156 158310 -846 ========================================== - Hits 140243 138523 -1720 - Misses 18913 19787 +874
| Impacted Files | Coverage Δ | |
|---|---|---|
| src/libvterm/src/rect.h | 0.00% <0.00%> (-96.56%) |
⬇️ |
| src/libvterm/src/state.c | 49.41% <0.00%> (-40.58%) |
⬇️ |
| src/libvterm/include/vterm.h | 0.00% <0.00%> (-37.50%) |
⬇️ |
| src/libvterm/src/keyboard.c | 51.57% <0.00%> (-36.85%) |
⬇️ |
| src/libvterm/src/pen.c | 50.73% <0.00%> (-33.93%) |
⬇️ |
| src/libvterm/src/encoding.c | 44.55% <0.00%> (-27.73%) |
⬇️ |
| src/libvterm/src/vterm.c | 48.13% <0.00%> (-18.54%) |
⬇️ |
| src/libvterm/src/parser.c | 84.31% <0.00%> (-10.79%) |
⬇️ |
| src/libvterm/src/mouse.c | 41.66% <0.00%> (-6.67%) |
⬇️ |
| src/ui.c | 79.83% <0.00%> (-3.82%) |
⬇️ |
| ... and 30 more |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered by Codecov. Last update 007f9d6...7d14113. Read the comment docs.
Bram Moolenaar
So, at least part of this comes from the plugin from Felipe Morales? Please ask him to put a license on his work. Without a license we are not allowed to use it. The Vim license would be best, like it applies to most of the runtime code.
Yegappan Lakshmanan
So, at least part of this comes from the plugin from Felipe Morales? Please ask him to put a license on his work. Without a license we are not allowed to use it. The Vim license would be best, like it applies to most of the runtime code.
vim-dev ML
Bram Moolenaar
Now we need to find out what in the current vimtutor is missing from
this plugin implementation.
--
Article in the first Free Software Magazine: "Bram Moolenaar studied
electrical engineering at the Technical University of Delft and
graduated in 1985 on a multi-processor Unix architecture."
Response by "dimator": Could the school not afford a proper
stage for the ceremony?
/// Bram Moolenaar -- Br...@Moolenaar.net -- http://www.Moolenaar.net \\\
/// sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ \\\
\\\ an exciting new programming language -- http://www.Zimbu.org ///
\\\ help me help AIDS victims -- http://ICCF-Holland.org ///
vim-dev ML
Bram Moolenaar
I finally found some time to look at this. I have my doubts if this is better than the existing vimtutor. It looks nicer, but it also uses several mechanisms that take it away from "raw" Vim. The tutor is especially made in a way that users can play around with the commands. There should not be any surprises, such as hidden text (conceal mode is used) and signs popping up depending on what the text looks like.
Does someone have experience with giving this tutor to actual new Vim users? A teacher perhaps.
Unless there is a clear advantage, I rather stick with the "old boring" tutor, since it has worked fine for a long time.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you commented.
Yegappan Lakshmanan
I finally found some time to look at this. I have my doubts if this is better than the existing vimtutor. It looks nicer, but it also uses several mechanisms that take it away from "raw" Vim. The tutor is especially made in a way that users can play around with the commands. There should not be any surprises, such as hidden text (conceal mode is used) and signs popping up depending on what the text looks like.
Does someone have experience with giving this tutor to actual new Vim users? A teacher perhaps.
vim-dev ML
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Nick Jensen
I've had a play with it. The makefile doesn't currently install the actual initial tutor (runtime/tutor/en/vim-01-beginner.tutor) so entering :Tutor in vim results in this error: "No tutorial with that name found". After moving the files to the expected location it runs well.
I do think that using this tutor is a much more pleasant experience than the standard vimtutor, and the signs changing from a red ✗ to a green ✓ when you've matched a line is nice feedback. However I also agree with Bram that the tutor should be simple, and there are some things that might be confusing due to use of conceal. For example, learning to use hjkl as the first first lesson and moving around a line becomes a bit confusing when you try to navigate over the links in "Lesson 0", as l appears to do nothing for a while (the cursor is moving over the concealed ](holy-grail ) part of [like this](holy-grail )).
There are also some bugs:
- After completing section 3.1 (deleting and putting lines with
ddandp) the signs no longer match up with the lines:
Actually after further testing I realise that this only happens if the 4th line is deleted. But after doing that and causing this issue: - In lesson 3.2 the X does not become a checkmark after correcting the line:
Note that this works correctly unless the section 3.1 error has been triggered.
I didn't test further. Overall it seems like a good idea to me but might need to be more robust?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you commented.
Nick Jensen
I didn't test further. Overall it seems like a good idea to me but might need to be more robust?
Having said this, the original tutor is still there, so someone following a 10 year old recommendation to run "vimtutor" from the command line will still see the normal old tutor - which is good. Having this version as an optional plugin is a nice addition.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you commented.
依云
I don't like the new tutor (but it's only my opinion; I'm not a teacher).
- The concealed text is indeed annoying and confusing.
- With those check marks, it feels more like a test than a tutorial. The user tends to complete them rather than explore what they can do with the thing they just learned. When I read such tutorials (Vim's old one, an Emacs one, and a helix one) I tend to try operations that the text doesn't tell me to do and understand the result. The check marks discourage this.
- Too many fancy stuff. The user will wonder how it's implemented since the tutorial itself is a text buffer in the editor. The plain text one will make the user focus on the basics it's teaching.
- The first page doesn't teach how to move cursors. The new user won't be able to read further without other materials.
- It uses existing config files, so that the behavior may be different than what the tutorial says. Those config files can be installed by a system admin on a shared machine, or by the user with OS package managers, or the OS tries to ship some "sane default" config, or the user followed a tutorial to install a customized suite but now they want to learn the basics.
- There is no translation yet (but this could be improved later).
—
Reply to this email directly, view it on GitHub.
You are receiving this because you commented.
Bram Moolenaar
> > I didn't test further. Overall it seems like a good idea to me but
> > might need to be more robust?
are no longer valid. Not sure what would be a good way to avoid this.
> Having said this, the original tutor is still there, so someone
> following a 10 year old recommendation to run "vimtutor" from the
> command line will still see the normal old tutor - which is good.
> Having this version as an optional plugin is a nice addition.
It could even be mentioned in the user manual. Or plugin managers can
mention it as the first plugin to use.
--
hundred-and-one symptoms of being an internet addict:
55. You ask your doctor to implant a gig in your brain.
\\\ sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ ///
Yegappan Lakshmanan
Christian Brabandt
I include this as an optional plugin. Thanks all
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you commented.
Christian Brabandt
—
Reply to this email directly, view it on GitHub.
You are receiving this because you commented.