VimScript Support implements a VimScript-IDE for Vim/gVim. It has been written to considerably speed up writing code in a consistent style. This is done by inserting complete statements, comments, idioms, and code snippets. Reading the Vim documentation is integrated. There are many additional hints and options which can improve speed and comfort when writing VimScript. Please read the documentation.
This plugin can be used with Vim version 7.x.
A system-wide installation for all users can also be done. This will have further effects on how the plug-in works. For a step-by-step instruction, as well as an explanation of the other consequences, please see the help file 'doc/vimsupport.txt' or look up the documentation via:
:help vimsupport-system-wide
The subdirectories in the zip archive vim-support.zip mirror the directory
structure which is needed below the local installation directory $HOME/.vim/
(find the value of $HOME with :echo $HOME from inside Vim).
(1.0) Save the template files in '$HOME/.vim/vim-support/templates/Templates' if you have changed any of them.
(1.1) Copy the zip archive vim-support.zip to $HOME/.vim and run
unzip vim-support.zip
Afterwards, these files should exist:
$HOME/.vim/autoload/mmtemplates/...
$HOME/.vim/doc/...
$HOME/.vim/plugin/vim-support.vim
(1.2) Loading of plugin files must be enabled. If not use
:filetype plugin on
This is the minimal content of the file '$HOME/.vimrc'. Create one if there is none or use the files in $HOME/.vim/vim-support/rc as a starting point.
(1.3) Set at least some personal details. Use the map \ntw inside a Vim buffer or the menu entry:
Vim -> Snippets -> template setup wizard
It will help you set up the file runtimepath/templates/personal.templates . The file is read by all plug-ins supporting this feature to get your personal details. Here is the minimal personalization (my settings as an example):
SetMacro( 'AUTHOR', 'Dr. Fritz Mehner' )
SetMacro( 'AUTHORREF', 'fgm' )
SetMacro( 'EMAIL', '[email protected]' )
SetMacro( 'COPYRIGHT', 'Copyright (c) |YEAR|, |AUTHOR|' )
Use the file $HOME/.vim/templates/vim.templates to customize or add to your Vim template library. It can also be set up via the wizard.
(Read more about the template system in the plugin documentation)
(1.4) Make the plugin help accessible by typing the following command on the Vim command line:
:helptags $HOME/.vim/doc/
(1.5) Consider additional settings in the file '$HOME/.vimrc'. The files customization.vimrc and customization.gvimrc are replacements or extensions for your .vimrc and .gvimrc. You may want to use parts of them. The files are documented.
The subdirectories in the zip archive vim-support.zip mirror the directory
structure which is needed below the local installation directory $HOME/vimfiles/
(find the value of $HOME with :echo $HOME from inside Vim).
(2.0) Save the template files in '$HOME/vimfiles/vim-support/templates/Templates' if you have changed any of them.
(2.1) Copy the zip archive vim-support.zip to $HOME/vimfiles and run
unzip vim-support.zip
Afterwards, these files should exist:
$HOME/vimfiles/autoload/mmtemplates/...
$HOME/vimfiles/doc/...
$HOME/vimfiles/plugin/vim-support.vim
(2.2) Loading of plugin files must be enabled. If not use
:filetype plugin on
This is the minimal content of the file '$HOME/_vimrc'. Create one if there is none or use the files in $HOME/vimfiles/vim-support/rc as a starting point.
(2.3) Set at least some personal details. Use the map \ntw inside a Vim buffer or the menu entry:
Vim -> Snippets -> template setup wizard
It will help you set up the file runtimepath/templates/personal.templates . The file is read by all plug-ins supporting this feature to get your personal details. Here is the minimal personalization (my settings as an example):
SetMacro( 'AUTHOR', 'Dr. Fritz Mehner' )
SetMacro( 'AUTHORREF', 'fgm' )
SetMacro( 'EMAIL', '[email protected]' )
SetMacro( 'COPYRIGHT', 'Copyright (c) |YEAR|, |AUTHOR|' )
Use the file $HOME/vimfiles/templates/vim.templates to customize or add to your Vim template library. It can also be set up via the wizard.
(Read more about the template system in the plugin documentation)
(2.4) Make the plugin help accessible by typing the following command on the Vim command line:
:helptags $HOME\vimfiles\doc\
(2.5) Consider additional settings in the file '$HOME/_vimrc'. The files customization.vimrc and customization.gvimrc are replacements or extensions for your _vimrc and _gvimrc. You may want to use parts of them. The files are documented.
There are a lot of features and options which can be used and influenced:
- use of template files and macros
- using and managing personal code snippets
- using additional plugins
Look at the VimScript Support help with:
:help vimsupport
+-----------------------------------------------+
| +-------------------------------------------+ |
| | ** PLEASE READ THE DOCUMENTATION ** | |
| | Actions differ for different modes! | |
| +-------------------------------------------+ |
+-----------------------------------------------+
Any problems? See the TROUBLESHOOTING section at the end of the help file 'doc/vimsupport.txt'.
- Add 'g:Vim_CustomTemplateFile'.
- Add template personalization file and setup wizard.
- Change the map for 'comment -> code' to '\co' for consistency with the other plug-ins. The old map '\cu' still works, however.
- New and reworked templates.
- Minor changes.
-> see file 'vim-support/doc/ChangeLog'
README.md
This file.
autoload/mmtemplates/*
The template system.
doc/vimsupport.txt
The help file for the Vim Support.
doc/templatesupport.txt
The help file for the template system.
plugin/vim-support.vim
The VimScript plugin for Vim/gVim.
vim-support/codesnippets/*
Some VimScript code snippets as a starting point.
vim-support/templates/Templates
VimScript main template file.
vim-support/templates/*.templates
Several dependent template files.
The following files and extensions are for convenience only. vim-support.vim will work without them. The settings are explained in the files themselves.
ftdetect/template.vim
ftplugin/template.vim
syntax/template.vim
Additional files for working with templates.
vim-support/doc/vim-hotkeys.pdf
Reference card for the key mappings. The mappings can
be used with the non-GUI Vim, where the menus are not
available.
vim-support/doc/ChangeLog
The change log.
vim-support/rc/customization.gvimrc
Additional settings for use in .gvimrc:
hot keys, mouse settings, fonts, ...
The file is commented. Append it to your .gvimrc if you
like.
vim-support/rc/customization.vimrc
Additional settings for use in .vimrc:
incremental search, tabstop, hot keys,
font, use of dictionaries, ...
The file is commented. Append it to your .vimrc if you
like.
vim-support/rc/*.templates
Sample template files for customization. Used by the
template setup wizard.
Many thanks to Wolfgang Mehner (wolfgang-mehner at web.de) for his template engine Template Support.
This plug-in has been developed together with Fritz Mehner, who maintained it until 2015.