Vim で日本語ヘルプを引く
昔、まだ Vim を使い始めたばかりだった頃、日本語ヘルプの導入に手間取ったことを思い出しました。
当時の自分に向けて書こうと思います。
まぁ、改めて書かなくともここに全部書いてあるんですが。
ここでいうヘルプとは、
:help
このコマンドで見れるやつのことです。
導入手順
- 日本語ヘルプファイル一式をダウンロードして展開
- 展開したファイル群を特定の場所に配置
- .vimrc に設定を追加
ヘルプ一式のダウンロード
https://github.com/vim-jp/vimdoc-ja/wiki
上記ページなどから日本語ヘルプファイルのアーカイブをダウンロードできます。
展開したファイルの配置
アーカイブを展開すると、doc と syntax というフォルダがあるかと思います。
doc の下に拡張子 jax のファイルがたくさんあります。これらが日本語のヘルプドキュメントです。
で、この doc と syntax フォルダを
に置きます。*1
こんな感じになっていればOKです。
.vim/ (or _vimfiles/) ├ doc/ │└ *.jax └ syntax/ └ help_ja.vim
.vimrc に設定を追加
.vimrc ファイル(Windows では _vimrc)に、
set helplang=ja
を追加します。
これで Vim から日本語ヘルプが見れるようになるはずです。
拡張子の意味
(2019/5/16追加)
"jax" という拡張子は、いったい何なんでしょうか。
デフォルトである英語版のヘルプファイルの拡張子は "txt" です。
それ以外の言語の場合、"??x" という形式で、? の部分は言語コードになっています。
日本語でいうなら ja-JP の ja が当てはまるので "jax" になるわけです。
余談ですが、help コマンドでヘルプを見る際に、
:help 'helplang'@en
のように、後ろに @言語コード
をくっつければ、指定した言語のヘルプを(存在するなら)見ることができます。
参照::help help-translated
https://vim-jp.org/vimdoc-ja/helphelp.html#help-translated