codekingpro/portable-devtools
114k
1*pi_tutor.txt* For Vim version 9.2. Last change: 2026 Feb 142 3INTERACTIVE TUTORIALS FOR VIM *vim-tutor-mode*4 5vim-tutor-mode provides a system to follow and create interactive tutorials6for vim and third party plugins. It replaces the venerable `vimtutor` system.7 8Original Author: Felipe Morales <https://github.com/fmoralesc>9 10=============================================================================111. Usage *vim-tutor-usage*12 13vim-tutor-mode tutorials are hypertext documents, they have rich text and14contain links. To stand out from the rest of the text, links are underlined.15You can follow them by placing the cursor over them and pressing <Enter>, or16by double-clicking them.17 181.1 Commands19------------20 *:Tutor*21:Tutor [tutorial] Opens a tutorial. Command-line completion for22 [tutorial] is provided, the candidates are a list of23 ".tutor" files found in the "tutor/<lang>/" folder in24 the 'runtimepath'. Tutorials prefixed with "vim-"25 will always be shown first.26 27 If no [tutorial] is provided, the command starts the28 "vim-01-beginner" tutorial, which is equivalent to29 Vim's `vimtutor`, chapter 1.30 31 Uses the translated tutorial for the current message32 language if possible (|v:lang|), e.g. to open the33 chapter 1 of the Italian tutor, use: >34 35 :lang it_IT.UTF-836 :Tutor37<38=============================================================================392. Creating tutorials *vim-tutor-create*40 41Writing vim-tutor-mode tutorials is easy. For an overview of the format used,42please consult the "tutor.tutor" file: >43 44 :Tutor tutor45<46New tutorials must be placed in the 'tutor/' folder in the 'runtimepath'47to be detected by the :Tutor command.48 49It is recommended to use a less formal style when writing tutorials than in50regular documentation (unless the content requires it).51 52=============================================================================53 vim:tw=78:ts=8:noet:ft=help:norl:54 