mirror of
https://github.com/vim/vim
synced 2025-07-15 16:51:57 +00:00
5a8f9958e2
Problem: The Github repo link in the Contribution section has been
archived for 5 years. So people who want to contribute to the
tutor plugin should just send PR to Vim repo, similar to most
other Vim features, so there is no need for a Contribution
section in the plugin doc.
Solution: Replace it with an Original Author note at the beginning of
the help document.
closes: #17341
Signed-off-by: Phạm Bình An <111893501+brianhuster@users.noreply.github.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
54 lines
2.0 KiB
Plaintext
54 lines
2.0 KiB
Plaintext
*pi_tutor.txt* For Vim version 9.1. Last change: 2025 May 19
|
|
|
|
INTERACTIVE TUTORIALS FOR VIM *vim-tutor-mode*
|
|
|
|
vim-tutor-mode provides a system to follow and create interactive tutorials
|
|
for vim and third party plugins. It replaces the venerable `vimtutor` system.
|
|
|
|
Original Author: Felipe Morales <https://github.com/fmoralesc>
|
|
|
|
=============================================================================
|
|
1. Usage *vim-tutor-usage*
|
|
|
|
vim-tutor-mode tutorials are hypertext documents, they have rich text and
|
|
contain links. To stand out from the rest of the text, links are underlined.
|
|
You can follow them by placing the cursor over them and pressing <Enter>, or
|
|
by double-clicking them.
|
|
|
|
1.1 Commands
|
|
------------
|
|
*:Tutor*
|
|
:Tutor [tutorial] Opens a tutorial. Command-line completion for
|
|
[tutorial] is provided, the candidates are a list of
|
|
".tutor" files found in the "tutor/<lang>/" folder in
|
|
the 'runtimepath'. Tutorials prefixed with "vim-"
|
|
will always be shown first.
|
|
|
|
If no [tutorial] is provided, the command starts the
|
|
"vim-01-beginner" tutorial, which is equivalent to
|
|
Vim's `vimtutor`, chapter 1.
|
|
|
|
Uses the translated tutorial for the current message
|
|
language if possible (|v:lang|), e.g. to open the
|
|
chapter 1 of the Italian tutor, use: >
|
|
|
|
:lang it_IT.UTF-8
|
|
:Tutor
|
|
<
|
|
=============================================================================
|
|
2. Creating tutorials *vim-tutor-create*
|
|
|
|
Writing vim-tutor-mode tutorials is easy. For an overview of the format used,
|
|
please consult the "tutor.tutor" file: >
|
|
|
|
:Tutor tutor
|
|
<
|
|
New tutorials must be placed in the 'tutor/' folder in the 'runtimepath'
|
|
to be detected by the :Tutor command.
|
|
|
|
It is recommended to use a less formal style when writing tutorials than in
|
|
regular documentation (unless the content requires it).
|
|
|
|
=============================================================================
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|