PHP Manual for Vim » 荒野无灯weblog

Keep It Simple, Stupid.

荒野无灯weblog

PHP Manual for Vim

实现的功能:
在用Vim编辑PHP文件时,按K键即可查看PHP Manual.

1. 首先, 下载特殊定制的PHP手册(包含PHP5.3的所有函数) :
vim-php-manual.tar.gz
2. 把下载的文件解压缩, 放置到一个目录, 比如
~/.vim/phpdoc/
3. 配置vimrc(linux下是.vimrc,windows下是_vimrc), 把phpmanual目录添加到runtimepath

set runtimepath+=$HOME/.vim/phpdoc

为什么要把phpmanual目录添加到runtimepath, 是因为:
在vim中, 调用help的时候, help会去所有的runtimpath下的doc目录中寻找tags文件,
来寻找要查找的帮助关键字.
在我们下载的vim-php-manual.tar.gz文件中, 就包含了doc/tags这样的文件目录结构, 所以只要把phpmanual目录加入runtimepath, 并且设置keywordprg为vim的help, 就可以实现在光标处按”K”跳转到函数手册了.

4. 配置vimrc, 使得keywordprg=”help”
注:一般情况下,keywordprg默认是!man或!man -s

autocmd BufNewFile,Bufread *.module,*.inc,*.php set keywordprg="help"

如果在使用的时候,Vim提示你:

tags file not sorted

用vim打开phpmanual/doc/tags, 然后%sort一下就可以了

使用截图:

php-man-for-vim.png

此文基本参考:
将PHP Manual融入(g)Vim | 风雪之隅

Tagged in : VIM,PHP Manual

All Comments (0)
Gravatar image
No Comments