パーソナルツール

日本語に翻訳されたvimエディタのヘルプをインストールして使用する。

作者: 小見 拓 最終変更 2012年01月08日 12時00分

このページでは、 英語で記述されているvimエディタのヘルプの代わりに、 日本語に翻訳されたヘルプをインストールし、 vimエディタ上で使用する方法を紹介します。 (Windows, Mac)

概要

このページでは、 英語で記述されているvimエディタのヘルプの代わりに、
日本語に翻訳されたヘルプをインストールし、 vimエディタ上で使用する方法を紹介します。

日本語のヘルプを検索。

日本語に翻訳されたヘルプをインストールする。

翻訳されたヘルプドキュメントを入手する。

まず、日本語のヘルプドキュメントをダウンロードしてください。
日本語のヘルプドキュメントは、現在、次のURLで配布しています。

Vim日本語ドキュメント(香り屋)
http://www.kaoriya.net/vimdoc_j/

このページの、「Vim日本語ドキュメントダウンロード(スナップショット)」のリンクから
圧縮ファイルの形式のドキュメントをダウンロードしてください。

ヘルプの圧縮ファイル。解凍ツールに関連づけされている場合、アイコンは違うはず。

ダウンロードした圧縮ファイルを解凍する。

ダウンロードした圧縮ファイルを解凍します。
何らかの圧縮ファイル解凍ツールで解凍すると、次のように展開されるはずです。

runtime/
  |
  +-- doc/
  |     +-- ada.jax
  |     +-- autocmd.jax
  |     +-- change.jax
  |     +-- cmdline.jax
  |     +-- debug.jax
  |     +-- ....
  |
  +-- syntax/
        +-- help_ja.vim

Note

docディレクトリに含まれるファイルの拡張子「jax」の、「ja」の部分が、
ヘルプの言語の種類を示しています。

jaが言語を示している。

解凍したヘルプドキュメントをコピーする。

runtime/docディレクトリの拡張子「jax」のファイル、 runtime/syntaxディレクトリの「help_ja.vim」ファイルを、
それぞれ、ユーザの設定ファイルディレクトリのdocディレクトリ、syntaxディレクトリにコピーします。
ディレクトリが無い場合は、ディレクトリを作成してから、そのディレクトリにコピーしてください。

Windowsの場合のコピー先ディレクトリ
$HOME
  |
  +-- vimfiles/
        |
        +-- doc/     (このディレクトリに拡張子「jax」のファイルをコピー)
        |
        +-- syntax/  (このディレクトリに「help_ja.vim」をコピー)
Mac OSXの場合のコピー先ディレクトリ
$HOME
  |
  +-- .vim/
        |
        +-- doc/     (このディレクトリに拡張子「jax」のファイルをコピー)
        |
        +-- syntax/  (このディレクトリに「help_ja.vim」をコピー)

追加したヘルプドキュメントにhelptagsコマンドを実行する。

vimエディタを起動し、設定ファイルディレクトリにコピーした拡張子「jax」のファイルに、 「:helptags」コマンドを実行します。

" Windows環境の場合のコマンド
:helptags $HOME/vimfiles/doc
" Mac OSX環境の場合のコマンド
:helptags $HOME/.vim/doc

ヘルプの使い方

ここまでの設定を行うと、日本語環境のvimエディタでは、「:help」「:helpgrep」コマンド実行時に、
インストールされた日本語のヘルプが先に検索されるようになります。
(日本語のヘルプで見つからなかった場合は、英語のヘルプも検索します。)

:help {調べたいこと}

" コマンドの例
:help strlen
:helpgrep {調べたいこと}

" コマンドの例
:helpgrep strlen

参考:

言語を指定して、ヘルプを検索する。

英語のヘルプから検索する。

日本語のヘルプではなく、あえて、英語のヘルプドキュメントから検索する場合は、 検索語の後に「@en」を付けて検索します。
「@en」は、「:help」コマンド、「:helpgrep」コマンド、どちらでも使用できます。

" 英語のヘルプから検索
:help {調べたいこと}@en

" コマンドの例
:help strlen@en
" 英語のヘルプからgrep検索
:helpgrep {調べたいこと}@en

" コマンドの例
:helpgrep strlen@en

日本語のヘルプから検索する。

日本語のヘルプから検索する場合は、検索語に「@ja」を付けて検索します。
(英語のヘルプドキュメントは検索対象にしません。)

" 日本語のヘルプから検索
:help {調べたいこと}@ja

" コマンドの例
:help strlen@ja
" 日本語のヘルプからgrep検索
:helpgrep {調べたいこと}@ja

" コマンドの例
:helpgrep strlen@ja

ヘルプドキュメントの検索順を変更する。(英語のヘルプを優先して検索させる)

日本語環境では、「日本語のヘルプ → 英語のヘルプ」の順序でヘルプの検索が行われますが、

日本語のヘルプを検索 → 英語のヘルプを検索

この順序を逆にしたい時は、vimエディタの設定ファイルで次のように指定してください。

" 英語のヘルプ → 日本語のヘルプの順に検索
:set helplang=en,ja

逆に、「helplang」オプションのデフォルト値が変更されている場合などに、
「日本語 → 英語」の検索順序に設定する場合は、次のようにvimエディタの設定ファイルで指定します。

" 日本語のヘルプ → 英語のヘルプの順に検索
:set helplang=ja,en

Note

「helplang」に、英語「en」を指定していなくても、 日本語のヘルプでマッチするものが見つからなかった場合には、
英語のヘルプも検索されます。
つまり、次の2つの設定はどちらも、検索結果は同じになります。

:set helplang=ja,en
:set helplang=ja

注意事項など

vimエディタが使用しているエンコーディングが「utf-8」でない場合は、 「:helpgrep」コマンドで日本語文字列の検索がヒットしません。
vimエディタが使用しているエンコーディングは次のコマンドで調べられます。

:echo &encoding
ドキュメントアクション
コメント
blog comments powered by Disqus