pi_tutor.txt (2050B)
1 *pi_tutor.txt* For Vim version 9.2. Last change: 2026 Feb 14 2 3 INTERACTIVE TUTORIALS FOR VIM *vim-tutor-mode* 4 5 vim-tutor-mode provides a system to follow and create interactive tutorials 6 for vim and third party plugins. It replaces the venerable `vimtutor` system. 7 8 Original Author: Felipe Morales <https://github.com/fmoralesc> 9 10 ============================================================================= 11 1. Usage *vim-tutor-usage* 12 13 vim-tutor-mode tutorials are hypertext documents, they have rich text and 14 contain links. To stand out from the rest of the text, links are underlined. 15 You can follow them by placing the cursor over them and pressing <Enter>, or 16 by double-clicking them. 17 18 1.1 Commands 19 ------------ 20 *:Tutor* 21 :Tutor [tutorial] Opens a tutorial. Command-line completion for 22 [tutorial] is provided, the candidates are a list of 23 ".tutor" files found in the "tutor/<lang>/" folder in 24 the 'runtimepath'. Tutorials prefixed with "vim-" 25 will always be shown first. 26 27 If no [tutorial] is provided, the command starts the 28 "vim-01-beginner" tutorial, which is equivalent to 29 Vim's `vimtutor`, chapter 1. 30 31 Uses the translated tutorial for the current message 32 language if possible (|v:lang|), e.g. to open the 33 chapter 1 of the Italian tutor, use: > 34 35 :lang it_IT.UTF-8 36 :Tutor 37 < 38 ============================================================================= 39 2. Creating tutorials *vim-tutor-create* 40 41 Writing vim-tutor-mode tutorials is easy. For an overview of the format used, 42 please consult the "tutor.tutor" file: > 43 44 :Tutor tutor 45 < 46 New tutorials must be placed in the 'tutor/' folder in the 'runtimepath' 47 to be detected by the :Tutor command. 48 49 It is recommended to use a less formal style when writing tutorials than in 50 regular documentation (unless the content requires it). 51 52 ============================================================================= 53 vim:tw=78:ts=8:noet:ft=help:norl: