* ヘルプファイルの書き方 [#v5b3c6f4]
** ヘルプタグ [#w8539f0f]
*** ヘルプタグを定義する [#vc1d5fe4]
*myplugin-somefunc*
- ヘルプファイルの中で、キーワードを"*"で囲む。
- ヘルプタグはすべてのヘルプファイルでユニークにする。
*** そのヘルプタグを参照する [#hc19a21e]
|myplugin-somefunc|
*** ヘルプタグの検索 [#u608a263]
- :help somefunc または :helpgrep myplugin-
- helpgrepコマンドは :helpgrep myplugin- | cwin のようにパイプをつなげられない。helptagsコマンド実行後、:cwin はできる。
*** ヘルプタグの更新 [#x363e99a]
:helptags $HOME/.vim/doc
:helptags %:p
** 記法・フォーマット [#lb1fc2b4]
*** 見出し [#obfae518]
My Headding~
- 行末に"~"チルダを付ける。
*** 引用 [#r74e7e57]
>
if (1) {
print 10;
}
<
- ">"と"<"で囲み、その中の行を、行頭を1スペース以上空けて書く。
*** 仕切り線 [#ob658beb]
========================
** 参考 [#df5e21dd]
- :help help-writing
** モード [#y3b27363]
vim:tw=78:ts=8:ft=help:
- ヘルプファイルの最終行でモードを設定する。
