diff options
Diffstat (limited to 'mnv/runtime/doc/pi_tutor.txt')
| -rw-r--r-- | mnv/runtime/doc/pi_tutor.txt | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/mnv/runtime/doc/pi_tutor.txt b/mnv/runtime/doc/pi_tutor.txt new file mode 100644 index 0000000000..b24b45766a --- /dev/null +++ b/mnv/runtime/doc/pi_tutor.txt @@ -0,0 +1,53 @@ +*pi_tutor.txt* For MNV version 10.0. Last change: 2026 Feb 14 + +INTERACTIVE TUTORIALS FOR MNV *mnv-tutor-mode* + +mnv-tutor-mode provides a system to follow and create interactive tutorials +for mnv and third party plugins. It replaces the venerable `mnvtutor` system. + +Original Author: Felipe Morales <https://github.com/fmoralesc> + +============================================================================= +1. Usage *mnv-tutor-usage* + +mnv-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 "mnv-" + will always be shown first. + + If no [tutorial] is provided, the command starts the + "mnv-01-beginner" tutorial, which is equivalent to + MNV's `mnvtutor`, 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 *mnv-tutor-create* + +Writing mnv-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). + +============================================================================= + mnv:tw=78:ts=8:noet:ft=help:norl: |