ヘルプファイルの書き方

ヘルプタグ

ヘルプタグを定義する

 *myplugin-somefunc*

• ヘルプファイルの中で、キーワードを"*"で囲む。
• ヘルプタグはすべてのヘルプファイルでユニークにする。

そのヘルプタグを参照する

 |myplugin-somefunc|

ヘルプタグの検索

• :help somefunc または :helpgrep myplugin-
• helpgrepコマンドは :helpgrep myplugin- | cwin のようにパイプをつなげられない。helptagsコマンド実行後、:cwin はできる。

ヘルプタグの更新

 :helptags $HOME/.vim/doc
 :helptags %:p

記法・フォーマット

見出し

 My Headding~

• 行末に"~"チルダを付ける。

引用

 >
   if (1) {
       print 10;
   }
 <

• ">"と"<"で囲み、その中の行を、行頭を1スペース以上空けて書く。

仕切り線

 ========================

参考

• :help help-writing

モード

  vim:tw=78:ts=8:ft=help:

• ヘルプファイルの最終行でモードを設定する。