Changes between Version 11 and Version 12 of VimInterface


Ignore:
Timestamp:
Mar 4, 2014, 4:58:39 PM (11 years ago)
Author:
manualwiki
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • VimInterface

    v11 v12  
    1 The command interface provides the use of ReactorErl in VIM.  
    2  
    31In VIM, a VIM plugin has to be made to create a user 
    4 interface which contains the menus of RefactorErl as well as 
     2interface which contains the menus of !RefactorErl as well as 
    53those commands with the help of which the refactorings can be run 
    64and the files loaded in the system can be handled. 
    … …  
    108=== Installation === 
    119 
    12 To install the plugin, you can copy it to the vim ftplugin 
    13 directory. For global installation, the plugin directory is 
    14 usually located in {{{/usr/share/vim/vimVersion/ftplugin}}}, for local install 
    15 copy the plugin to {{{HOME/.vim/ftplugin}}} 
    16 directory. 
     10To install the plugin, you can copy it to the vim ftplugin directory. The plugin is located in {{{REFACTORERL/lib/referl_ui/vim/ftplugin}}} directory and consists of 2 files: referl.py and referl.vim. For the plugin you also need 
     11python 2. You can download it from http://www.python.org. 
     12For global installation, the ftplugin directory is usually located in 
     13{{{/usr/share/vim/vimVersion/ftplugin}}}, for local install copy the plugin to 
     14{{{HOME/.vim/ftplugin}}} directory.  
    1715 
    18 Then you should modify the {{{refpath}}} variable in the script to 
    19 the installation directory of RefactorErl. You should also set the other  
     16Next, you should modify the {{{refpath}}} variable in the referl.vim script to 
     17the installation directory of !RefactorErl. You should also set the other  
    2018variables shown in the table. 
    2119 
    2220|| Variable name || Value || 
    23 || {{{refpath}}} || path to RefactorErl || 
    24 || {{{ref_base_path}}} || path to the tool || 
     21|| {{{refpath}}} || you must enter the full path to the !RefactorErl executable under the directory of the tool (under {{{bin}}} directory). || 
     22|| {{{ref_base_path}}} || you must enter the full path to the root directory of the tool. || 
    2523|| {{{ref_undo_mode}}} || selective_undo or one_step || 
    26 || {{{ref_datadir}}} || path to directory of data || 
     24|| {{{ref_datadir}}} || path to directory of data used by !RefactorErl || 
    2725|| {{{ref_name_type}}} || sname or name || 
    2826|| {{{ref_server_name}}} || name of the server node || 
    29 || {{{ref_db_type}}} || the type of db backend || 
     27|| {{{ref_db_type}}} || here you can choose the database type !RefactorErl uses. || 
    3028 
    3129 
    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: 
     30If you want to use the plugin only as filetype plugin then you should copy the files instead of plugin under ftplugin, and also add the following lines to your .vimrc. (The .vimrc is located under {{{HOME}}}.) 
    3831 
    3932{{{  
    … …  
    4134au BufNewFile,BufRead *.erl source path/to/referl.vim 
    4235}}} 
    43  
    44 The .vimrc is located under {{{HOME}}}.  
    45  
    46 Then you should set the variables in the referl.vim script: 
    47  
    48  * {{{refpath}}}: you must enter the full path to the RefactorErl executable under the directory of the tool (under {{{bin}}} directory).  
    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  
    6036 
    6137 
    … …  
    7753 
    7854VIM can be used both in command line and in graphical environment. The 
    79 VIM plugin of RefactorErl supports both of them. In the graphical 
     55VIM plugin of !RefactorErl supports both of them. In the graphical 
    8056front-end every command can be reached from the 
    81 RefactorErl menu. The features are grouped to be easily found. These 
     57!RefactorErl menu. The features are grouped to be easily found. These 
    8258groups and the most important tasks can be found in the following, and the second column of the table shows the 
    8359corresponding command to be used in non-graphical mode. 
    … …  
    9975==== Server submenu ==== 
    10076The server can be started and stopped by the menus and commands shown 
    101 in the following table. If the RefactorErl cannot be started 
     77in the following table. If the !RefactorErl cannot be started 
    10278an error message is shown in command buffer. 
    10379