---

Ⅰ. 插件描述

Yii API manual plugin for VIM

Ⅱ. 基本信息

创建日期：  2011-12-28 使用用户：  1 Github星：  6 插件作者：  Michael Härtl

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'mikehaertl/yii-api-vim'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'mikehaertl/yii-api-vim'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'mikehaertl/yii-api-vim'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/mikehaertl/yii-api-vim

Ⅳ. 文档说明

# Yii API plugin for VIM

This is the API manual for Yii as VIM plugin.

Installation

Download the files from here,
extract the package and move the docs/ directory to your ~/.vim directory.

Alternatively you can use a plugin manager like Vundle (recommended).

If the help is not available after installation, you can try to issue this command in VIM:

:helptags ~/.vimrc/doc

Use

There's no real configuration required for this plugin. After installing it, you can
ask for help on Yii classes like this:

:help CWebUser

If you want to use keyword search (which allows to press <S-k> over any keyword)
then you should add this line to your .vimrc:

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

Create custom version

The package also contains the Yii command that was used to create the help files.
This command requires a copy of Yii somewhere. If you extracted this package to
/tmp/yii-api-vim you can create the helpfiles in /tmp/yii-api-vim/doc like this:

git clone https://github.com/yiisoft/yii.git /tmp/yii-repo
cd /tmp/yii-repo/build

export YII_CONSOLE_COMMANDS=/tmp/yii-api-vim/yii_commands/
./build vimapi /tmp/yii-api-vim/doc

Again you may have to call :helptags /tmp/yii-api-vim/doc after the above command.