Ⅰ. 插件描述
Edit Matlab scripts in Vim/gVim. Insert code snippets, run the code checker and look up help.Ⅱ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'wolfgangmehner/matlab-support':source %
:PluginInstall对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'wolfgangmehner/matlab-support':source %
:NeoBundleInstall使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'wolfgangmehner/matlab-support':source %
:PlugInstall使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/wolfgangmehner/matlab-supportⅣ. 文档说明
Preface
This repository is mainly for the use with plug-in managers.
The development happens here:
(WolfgangMehner/vim-plugins)
README for matlab-support.vim (Version 0.8rc2) / Mar 25 2014
- INSTALLATION
- RELEASE NOTES
- FILES
- ADDITIONAL TIPS
- CREDITS
MATLAB-IDE for Vim/gVim. It is written to considerably speed up writing code in
a consistent style. This is done by inserting complete statements, idioms and
- These code fragments are provided in an extendible template library.
This plug-in also supports the use of the MATLAB code checker "mlint", and
provides quick access to the online documentation of the Matlab functions.
Please read the documentation.
This plug-in can be used with Vim version 7.x .
This software is not part of MATLAB. Neither the author nor the provided
software are associated with MathWorks, Inc in any way.
The MathWorks, Inc and MATLAB are registered trademarks of The MathWorks, Inc.
INSTALLATION
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/matlabsupport.txt' or look up the documentation via:
:help matlabsupport-system-wide
(1) LINUX
The subdirectories in the zip archive matlab-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/matlab-support/templates/' if
you have changed any of them.
(1.1) Copy the zip archive matlab-support.zip to $HOME/.vim and run
unzip matlab-support.zip
(1.2) Loading of plug-in 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 file in $HOME/.vim/matlab-support/rc as a starting point.
(1.3) Set at least some personal details in the file
'$HOME/.vim/matlab-support/templates/Templates'
Here is the minimal personalization (my settings as an example):
SetMacro( 'AUTHOR', 'Wolfgang Mehner' )
SetMacro( 'AUTHORREF', 'WM' )
SetMacro( 'EMAIL', 'wolfgang-mehner@web.de' )
SetMacro( 'ORGANIZATION', '' )
SetMacro( 'COPYRIGHT', 'Copyright (c) |YEAR|, |AUTHOR|' )
(Read more about the template system in the plug-in documentation)
(1.4) Make the plug-in 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.
(2) WINDOWS
The subdirectories in the zip archive matlab-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/matlab-support/templates/'
if you have changed any of them.
(2.1) Copy the zip archive matlab-support.zip to $HOME/vimfiles and run
unzip matlab-support.zip
(2.2) Loading of plug-in 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 file in $HOME/vimfiles/matlab-support/rc as a starting
point.
(2.3) Set at least some personal details in the file
'$HOME/vimfiles/matlab-support/templates/Templates'
Here is the minimal personalization (my settings as an example):
SetMacro( 'AUTHOR', 'Wolfgang Mehner' )
SetMacro( 'AUTHORREF', 'WM' )
SetMacro( 'EMAIL', 'wolfgang-mehner@web.de' )
SetMacro( 'ORGANIZATION', '' )
SetMacro( 'COPYRIGHT', 'Copyright (c) |YEAR|, |AUTHOR|' )
(Read more about the template system in the plug-in documentation)
(2.4) Make the plug-in 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.
(3) ADDITIONAL REMARKS
There are a lot of features and options which can be used and influenced:
- use of the extendible template library
- automated generation of comments for functions
- use of the MATLAB code checker mlint
- quick access to the online documentation
- removing the Matlab menu
Look at the Matlab-Support help with:
:help matlabsupport
+-----------------------------------------------+
| +-------------------------------------------+ |
| | ** PLEASE READ THE DOCUMENTATION ** | |
| | Actions differ for different modes! | |
| +-------------------------------------------+ |
+-----------------------------------------------+
Any problems? See the TROUBLESHOOTING section at the end of the help file
'doc/matlabsupport.txt'.
RELEASE NOTES
RELEASE NOTES FOR VERSION 0.8
- Initial release.
RELEASE NOTES FOR OLDER VERSIONS
-> see file 'matlab-support/doc/ChangeLog'
FILES
README.md
This file.
autoload/mmtemplates/*
The template system.
doc/matlabsupport.txt
The help file for Matlab support.
doc/templatesupport.txt
The help file for the template system.
plugin/matlab-support.vim
The Matlab plug-in for Vim/gVim.
matlab-support/templates/Templates
Matlab main template files.
matlab-support/templates/*.templates
Several dependent template files.
The following files and extensions are for convenience only.
matlab-support.vim will work without them:
ftplugin/matlab.vim
Example filetype plug-in for Matlab:
modifies tabs according to Matlab standard
matlab-support/doc/ChangeLog
Complete change log.
matlab-support/rc/additions.gvimrc
Additional settings for use in .gvimrc:
hot keys, mouse settings, fonts, ...
matlab-support/rc/additions.vimrc
Example settings for use in .vimrc:
setup of the plug-in
matlab-support/rc/customization.gvimrc
Suggestion for the configuration file .gvimrc:
hot keys, mouse settings, fonts, ...
matlab-support/rc/customization.vimrc
Suggestion for the configuration file .vimrc:
hot keys, tabstop, use of dictionaries,
the setup of the plug-in, ...
The settings are explained in the files themselves.
matlab-support/rc/sample_template_file
Sample template file for personalization, when using a
system-wide installation.
ADDITIONAL TIPS
(1) You may want to use a central hidden directory for all your backup files:
1.1 Add the following line to .vimrc:
set backupdir=$HOME/.vim.backupdir
1.2 Create $HOME/.vim.backupdir .
1.3 Add the following line to your shell initialization file ~/.profile :
find $HOME/.vim.backupdir/ -name "*" -type f -mtime +60 -exec rm -f {} \;
When you are logging in all files in the backup directory older then 60
days (-mtime +60) will be removed (60 days is a suggestion, of course).
Be sure to backup in shorter terms !
(2) gVim. Toggle 'insert mode' <--> 'normal mode' with the right mouse button
(see mapping in file customization.gvimrc).
(3) gVim. Use tear off menus.
(4) Try 'Focus under mouse' as window behavior (No mouse click when the mouse
pointer is back from the menu entry).
(5) Use Emulate3Buttons "on" (X11) even for a 3-button mouse. Pressing left and
right button simultaneously without moving your fingers is faster than
moving a finger to the middle button (which is often a wheel).
CREDITS
Fritz Mehner (vim.org user name: mehner) for a number of things:
- His plug-ins (bash-support, c-support, perl-support, ...) provided the
inspiration and model for this plug-in and the utilized template support. - Parts of the documentation and other material (including the 'ADDITIONAL TIPS'
above) are taken from his plug-ins as well.
- His plug-ins (bash-support, c-support, perl-support, ...) provided the
Sameer Sheorey (sameer0s) and Fabrice Guy (Fabrice)
- for demonstrating how to use mlint with Vim.
For a complete list of people who made contributions to this plug-in,
please be so kind as to take a look at the credits:
:help matlabsupport-credits