Debug Your Life // 暮らしをデバッグする。

情報系の研究での気づきなどをつらつらと。

Vimのヘルプを日本語化

Vimのhelpって全部英語だから読むのに時間かかるんですよね。

ある程度Vimに慣れるまではヘルプ読む癖をつけるために楽したいなと思ってたらどうやら日本語化できるみたいです。作業に付随して色々と調べたので、メモしておこうかなと。

f:id:debug-your-life:20171225205543p:plain

1. vimdoc-jaのダウンロードURLの確認

https://github.com/vim-jp/vimdoc-jaにアクセスして、Clone or downloadってボタンを押すとダウンロード用のリンクが表示されます。 f:id:debug-your-life:20171217120857p:plain gitコマンド用のURLがhttps://github.com/vim-jp/vimdoc-ja.gitだと分かりました。

2. vimdoc-jaのダウンロード

$ git clone --depth 1 https://github.com/vim-jp/vimdoc-ja.git でvimdoc-jaディレクトリをカレントディレクトリへとダウンロードできます。

3. Vimディレクトリへとファイルを移動

Vimディレクトリの作成

Macでは~/.vim以下がデフォルトのVimディレクトリらしいです。

一応確認しておきましょう。$ vimVimを起動した後、:set runtimepath?でruntimepathを表示できます。

runtimepath=~/.vim,/usr/share/vim/vimfiles,/usr/share/vim/vim80,/usr/share/vim/vimfiles/after,~/.vim/after

と表示されましたので、安心して~/.vimVimディレクトリとすることができます。

Vimディレクトリを作るのが初めてなので、以下の操作で必要なディレクトリを作成しておきました。

$ mkdir ~/.vim
$ mkdir ~/.vim/doc
$ mkdir ~/.vim/syntax

ファイルの移動

ダウンロードしてきたvimdoc-jaディレクトリのうち、docディレクトリの中身を~/.vim/docへ、syntaxディレクトリの中身を~/.vim/syntaxへと移動させます。

4. ヘルプタグファイルの更新

$ vimVimを起動した後、:helptags ~/.vim/docでヘルプファイルの更新を行います。

注):helptagsの取り消しにあたるようなコマンドは見つからなかったことと、~/.vim/docを消したときの挙動から、環境変数などを元に戻したりする手間は発生しづらそうな気がしました。

5. ~/.vimrcの編集

ヘルプの言語の優先順位を設定します。~/.vimrcset helplang=ja,enと記述して日本語ヘルプファイルを優先すること、 あるいはset helplang=en,jaと記述して英語ヘルプファイルを優先することを明示しておきます。

また、:help@jaのようにすれば、~/.vimrcの記述に関わらず指定した言語でヘルプが表示できます。

最後に

Vimプラグインを管理するためのプラグインマネージャーとやらを導入すると、ディレクトリの構成とか考えなくて済みそうな予感です。

Debug your life!

参考記事

Vimのヘルプ機能を活用して快適Vim生活を送ろう - Qiita
Home · vim-jp/vimdoc-ja Wiki · GitHub
Vimのヘルプドキュメントを日本語化する | WEBサービス創造記
git リポジトリの最新の履歴だけを取得する shallow clone - Qiita
GitHubにあるリポジトリをローカルにcloneする方法 - Qiita
日本語に翻訳されたvimエディタのヘルプをインストールして使用する。 — 名無しのvim使い
vim-jp » Hack #34: Vimのディレクトリ構成
Vim:Vimのディレクトリ構成
vimプラグイン入門、またはvimを使いこんで婚約者をゲットする方法 - tumblr