Merge pull request #1782 from h-east/add-pi_tutor

Add pi_tutor.{txt,jax}

Author: h-east

doc/pi_tutor.jax

@@ -0,0 +1,53 @@
+*pi_tutor.txt*    For Vim バージョン 9.1.  Last change: 2024 Nov 03
+
+☆Vim の対話的なチュートリアル			 *vim-tutor-mode*
+
+vim-tutor-mode は、vim およびサードパーティのプラグインの対話的なチュートリア
+ルを実行および作成するためのシステムを提供する。これは、古くからある
+`vimtutor` システムに代わるものである。
+
+=============================================================================
+1. 使用法                                                     *vim-tutor-usage*
+
+vim-tutor-mode チュートリアルはハイパーテキストドキュメントで、リッチテキスト
+とリンクが含まれている。テキストの残りの部分と区別するために、リンクには下線が
+引かれている。
+カーソルをリンクの上に置いて <Enter> キーを押すか、リンクをダブルクリックする
+と、リンクをたどることができる。
+
+1.1 コマンド
+------------
+								      *:Tutor*
+:Tutor {tutorial}	チュートリアルを開く。{tutorial} のコマンドライン補完
+			が提供されており、候補は 'runtimepath' の 'tutor/' フォ
+			ルダにある '.tutor' ファイルのリストである。'vim-' で
+			始まるチュートリアルは常に最初に表示される。
+
+			{tutorial} が指定されていない場合、コマンドは Vim の
+			`vimtutor` に相当する 'vim-01-beginner' チュートリアル
+			を開始する。
+
+=============================================================================
+2. チュートリアルの作成                                      *vim-tutor-create*
+
+vim-tutor-mode チュートリアルの作成は簡単である。使用される形式の概要について
+は、'tutor.tutor' ファイルを参照: >
+
+    :Tutor tutor
+<
+新しいチュートリアルは、:Tutor コマンドで検出されるように、'runtimepath' の
+'tutor/' フォルダに配置する必要がある。
+
+チュートリアルを書くときは、通常のドキュメントよりもカジュアルなスタイルを使用
+することをお勧めする (コンテンツで必要な場合を除く)。
+
+=============================================================================
+3. コントリビュートする
+
+プラグインの開発は github [1] で行われている。気軽に問題を報告したり、提案した
+りして欲しい。
+
+[1]: https://github.com/fmoralesc/vim-tutor-mode
+
+=============================================================================
+ vim:tw=78:ts=8:noet:ft=help:norl:

en/pi_tutor.txt

@@ -0,0 +1,52 @@
+*pi_tutor.txt*    For Vim version 9.1.  Last change: 2024 Nov 03
+
+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.
+
+=============================================================================
+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/'  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`.
+
+=============================================================================
+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).
+
+=============================================================================
+3. Contributing
+
+Development of the plugin is done over at github [1].  Feel free to report
+issues and make suggestions.
+
+[1]: https://github.com/fmoralesc/vim-tutor-mode
+
+=============================================================================
+ vim:tw=78:ts=8:noet:ft=help:norl: