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