vimからもPHPのマニュアルを開きたい
vimではデフォルトでmanを参照する機能がある。
ノーマルモードで参照したい単語上でShift+kを押すと参照できる。
PHPのマニュアルもShift+kで参照できるようにしてみた。
テキストブラウザをインストールできない環境でも使用したいことがあると思うので、
テキストブラウザ不要の設定方法です。
ざっくりとした手順
- PHPのマニュアルドキュメントをDownloadし、htmlファイルからtxtファイルに変換する
- 変換したマニュアルファイルをサーバ上に配置
- .vimrcの設定(PHPマニュアルのdocを読み込むように設定 & Shift+kでhelpを開くように設定する)
1.PHPのマニュアルドキュメントをDownloadし、htmlファイルからtxtファイルに変換する
PHPの公式ページではマニュアルがDownloadできます。
そこから日本語版のマニュアル(htmlバージョン)をDownloadしてください。
[ダウンロードページ] http://php.net/get/php_manual_ja.tar.gz/from/a/mirror
vimでhelpのdocとして使うにはDownloadしたHTMLファイルをtxtファイルに変換します。
自力でスクリプトを組んだり、ツールを使ってもいいと思いますが、
私が変換をかけたものをgithubにおいておきましたので、もしよければそちらを使用してください。
もちろん自己責任ですがw
[github] https://github.com/MasaharuSuizu/phpnamual-jp-txtfiles
※2016/03/24時点のPHPマニュアルです。
(1度に100ファイルまでしかuploadできなかったのでzipファイルにしました。お手数をおかけしますが、使用される方は解凍してください。)
2. 変換したマニュアルファイルをサーバ上に配置
ファイルですが、好きな場所でいいと思いますが、
vim関連なので
${HOME}/.vim/phpmanual/doc/xxxxxx.txt
みたいな配置でいいのではないかと思います。
お任せします。
3. .vimrcの設定(PHPマニュアルのdocを読み込むように設定 & Shift+kでhelpを開くように設定する)
set runtimepathでPHPマニュアルのdocを読み込むように設定をし、
set keywordprgでhelpを開くようにしてください。
" PHPのdocが置かれているディレクトリをruntimepathに追加" 現在は、~/.vim/phpmanual/doc/isset.txtみたいな感じにphpのマニュアルを置いているsetruntimepath+=~/.vim/phpmanual
" helpをword上で<Shift>kで開くようにするsetkeywordprg=:help
上記の設定をするだけでvimからPHPのマニュアルを見ることができます。
こんな感じで。
通常のvimのhelpと同様にhelpからhelpへの遷移もできます。
このキャプチャだと、unsetにカーソルを合わせてCtrl+]でunsetのヘルプに遷移します。
通常のhelpと変わりませんがコマンドも書いておきます。
| 動き | コマンド |
|---|---|
| 違うワードのhelpに移動 | Ctrl+] |
| 遷移先から戻る | :pop |
| 閉じる | (help画面にカーソルを合わせて) :close |
終わりに
他の言語はわかりませんが、マニュアルがドキュメント化されていれば同様のやり方でできるのではないかと思います。
まあもうプラグインがあるかもしれませんが。（テキストブラウザは使っているかもしれないけど）
もしこの記事が何かのお役に立ったのならば幸いです。