| 30 | |
| 31 | {{{#!comment |
| 32 | To install the plugin, you can copy it to the vim ftplugin directory. The |
| 33 | plugin contains 2 files: referl.py and referl.vim. For the plugin you also need |
| 34 | python 2. You can download it from http://www.python.org. |
| 35 | The For global installation, the ftplugin directory is usually located in |
| 36 | {{{/usr/share/vim/vimVersion/plugin}}}, for local install copy the plugin to |
| 37 | {{{HOME/.vim/plugin}}} directory. If you want to use the plugin only as filetype plugin then you should copy the files instead of plugin under ftplugin, and also add these lines to your .vimrc: |
| 38 | |
| 39 | {{{ |
| 40 | au BufNewFile,BufRead *.hrl source path/to/referl.vim |
| 41 | au BufNewFile,BufRead *.erl source path/to/referl.vim |
| 42 | }}} |
| 43 | |
| 44 | The .vimrc is located under {{{HOME}}}. |
| 45 | |
| 46 | Then you should set the variables in the referl.vim script: |
| 47 | |
| 48 | * {{{ref_base_path}}}: you must enter the full path to the root directory of the tool. |
| 49 | |
| 50 | * {{{ref_base_path}}}: you must enter the full path to the root directory of the tool. |
| 51 | |
| 52 | * {{{ref_datadir}}}: you can change the location of the database here. |
| 53 | |
| 54 | * {{{ref_name_type}}}: you can choose sname or name. |
| 55 | |
| 56 | * {{{re_server_name}}}: this variable has to match with the !RefactorErl server. |
| 57 | |
| 58 | * {{{ref_db_type}}}: here you can choose the database type !RefactorErl uses. |
| 59 | |
| 60 | }}} |