Vim Tips Wiki
(move the #vim "best plugins" to a new section)
(Undo revision 33113 by 116.231.115.209 (talk) Feed has failed for a long time; try old smaller value to see if it helps.)
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[Category:VimInformation]]
==Vim scripts – recent changes==
 
 
Information on scripts that help when working with Vim:
  +
*[[Script:Best plugins selected by the IRC community|Best plugins selected by the IRC community]] plugins recommended by the [[Vim_on_Freenode|#vim community]]
  +
*[[Script:Featured scripts|Featured scripts]] overview of some useful scripts
  +
*[[:Category:Lists of scripts|Lists of scripts]] shows all lists of scripts
  +
  +
==Recent changes at Vim Scripts==
 
'''Following are recent changes to the [http://www.vim.org/scripts Vim Scripts on vim.org]'''
 
'''Following are recent changes to the [http://www.vim.org/scripts Vim Scripts on vim.org]'''
<rss>http://feed43.com/vim-scripts.xml|charset=UTF-8|short|date|max=10</rss>
+
<rss>http://feed43.com/vim-scripts.xml|short|max=10</rss>
 
''If the RSS feed failed to load, try'' [http://vim.wikia.com/wiki/Vim_scripts?action=purge ''purging the cache''].
 
''If the RSS feed failed to load, try'' [http://vim.wikia.com/wiki/Vim_scripts?action=purge ''purging the cache''].
   
==Best plugins==
 
'''The following scripts were selected as "best" by the [[Vim_on_Freenode|#vim community]].'''
 
   
  +
==Scripts on this wiki==
*{{script|id=23|text=Enhanced Commentify}} author Meikel Brandmeyer
 
  +
Each script at [http://www.vim.org/scripts vim.org] has a link to a page on this wiki where the script can be discussed. See the [[Vim Tips Wiki:Script comment guidelines|script comment guidelines]].
:The best language-aware tool to switch lines between commented and uncommented.
 
   
  +
Tips that describe or document a script are generally not useful. There are well over 2000 scripts at vim.org and many more on other sites, so outlining a significant number of scripts in separate tips would not be helpful since the information could not easily be found. In addition, any documentation for a script on this wiki will become out of date as the script is updated. The best procedure is for all documentation to be packaged with the script, with just a link and a brief description here. Readers can then scan a list of many scripts and follow the link for those that are of interest.
*{{script|id=1506|text=Large File}} author Charles Campbell
 
:Edit large files quickly.
 
:Automatically speeds up Vim by switching off features like syntax highlighting when editing a large file.
 
   
  +
For historical reasons, there are some old tips that do not comply with this advice (the tip is just a description of a script on another site); in due course such tips will probably be deleted. New tips, however, must provide useful information without relying on external content. We need this approach because there are already too many tips and that makes finding useful information difficult for readers, and makes maintenance hard for editors.
*{{script|id=1658|text=NERD Tree}} author Marty Grenfell
 
:A tree explorer plugin for navigating the file system.
 
:Can open and bookmark directories or files.
 
   
  +
Anyone is welcome to add a script description to the [[Script:Featured scripts|featured tips]] list – just copy the format of another description and keep it brief.
*{{script|id=1643|text=Super Tab}} author Gergely Kontra and Eric Van Dewoestine
 
:Do all your insert-mode completion with the Tab key. {{help|ins-completion}}
 
 
*{{script|id=1697|text=Surround}} author Tim Pope
 
:Easily add, delete or change "surroundings".
 
:Handles parentheses, brackets, quotes, XML tags, and more.
 
:For example, <tt>ds(</tt> deletes the outer pair of parentheses.
 
 
*{{script|id=273|text=Tag List}} author Yegappan Lakshmanan
 
:Source code browser using Exuberant Ctags.
 
:Supports C/C++, Java, Perl, Python, tcl, sql, php and more.
 
:Provides an overview of the structure of source code files, and allows you to efficiently browse source code.
 
 
==Featured scripts==
 
'''Here are some scripts that may help your life with Vim!'''
 
 
*{{script|id=2208|text=txtfmt The Vim Highlighter}} author [[User:Stahlman|Brett Stahlman]]
 
*[http://www.freewebs.com/txtfmt/ screenshots]
 
:A plugin that provides word-processor style highlighting to beautify any type of text file.
 
:The highlighting mechanism uses invisible tokens that are inserted into a Txtfmt buffer with easy to use mappings provided by the filetype plugin.
 
:Each token affects either the color or formatting of subsequent text.
 
:Supports 8 configurable colors and all combinations of formatting attributes (bold, underline, italic, standout, reverse, undercurl).
 
:Txtfmt highlighting regions can nest within syntax regions created by other plugins such as TVO (The Vim Outliner).
 
:Use the <tt>:TOhtml</tt> command that ships with Vim to create an html version of the txtfmt buffer.
 
:Nearly everything is configurable, with defaults to work "right out of the box".
 
:Complete documentation is in an extensive Vim help file.
 
 
*{{script|id=2244|text=less.bat}} author [[User:Ewfalor|Ewfalor]]
 
:A batch file using Vim to implement the ''less'' utility for Windows users.
 
:Makes Vim a rewindable, syntax-highlighting, searchable pager.
 
:Based upon less.sh from the macros directory of the Vim distribution.
 
:Uses macros/less.vim in the 'runtimepath'.
 
:Works with pipes as well as file names.
 
 
*[http://www.noah.org/wiki/Twit Twitter client] author [[User:Noahspurrier|Noahspurrier]]
 
:A stand-alone command-line Twitter status update client in Python.
 
:Requires only a recent version of Python.
 
:Supports updating your Twitter status in Vim, and at the command line.
 
:Easily tweet from inside Vim by selecting text to send. You can select text and type <tt>\twit</tt> to have that text appear in your Twitter status, or use <tt>:%!twit</tt> to send the entire current document to Twitter.
 
:You can set your username and password in the environment so they don't need to be repeatedly entered.
 
 
*{{script|id=1879|text=autocomplpop.vim}} author Takeshi NISHIDA
 
:A plugin to automatically complete each word, after typing two or more characters.
 
:Popup menu for word completion also appears when moving the cursor while in insert mode.
 
:Behavior is customizable.
 
 
*{{script|id=2368|text=CCTree C Call-Tree Explorer}} author Hari Rangarajan
 
:A plugin to generate call-trees for any function or macro in real-time, within Vim.
 
:Functionality is similar to that of packages like KScope or Source-navigator. Requires Cscope.
 
 
==Recommended procedure for this page==
 
Useful scripts should be listed on this page regardless of whether a tip also describes the script. However, if all useful content from a tip is moved to here, then the tip can be deleted.
 
 
If the list of featured scripts becomes too large, we will archive some of them (that is, move their descriptions to a subpage).
 
 
{{Todo}}
 
*Need a link to a page giving a general overview of scripts/plugins.
 
*Probably add some more descriptions using some of the [[Vim_Tips_Wiki:New_tips/200802|tips added by Metacosm in February 2008]].
 
 
==Old information==
 
This section includes some information on scripts that may assist users of old versions of Vim.
 
 
===Spell checking for Vim prior to version 7===
 
Spell checking is built-in to Vim since version 7.0. For earlier versions, you can find scripts for English spell checking, as well as for other languages, at:
 
*[http://mysite.verizon.net/astronaut/vim/index.html#vimlinks_scripts Dr Chip's links]
 
*[http://mysite.verizon.net/astronaut/vim/index.html#Spelling Dr Chip's spelling checker]
 
 
===Corrections to scripts===
 
We do ''not'' want corrections to scripts on the Vim Tips wiki (such information cannot be verified with reasonable effort, and is valid only for specific versions and for a limited time). Instead, please notify the script maintainer so any problems can be rectified, or post to the [http://www.vim.org/maillist.php vim-dev mailing list]. The following list contains some information that may be useful, but we will delete it later.
 
*In {{script|id=168}}, there is an error in file ide.vim line 600 which is <tt>return ret;</tt> (omit the ';' to fix).
 
   
 
==See also==
 
==See also==
 
*[[Vim documentation]]
 
*[[Vim documentation]]
  +
*Add comments on the [[{{TALKPAGENAME}}|discussion page]] which includes information on scripts for old versions of Vim
 
==Comments==
 
 
[[Category:VimInformation]]
 

Revision as of 12:02, 17 April 2012

Information on scripts that help when working with Vim:

Recent changes at Vim Scripts

Following are recent changes to the Vim Scripts on vim.org

If the RSS feed failed to load, try purging the cache.


Scripts on this wiki

Each script at vim.org has a link to a page on this wiki where the script can be discussed. See the script comment guidelines.

Tips that describe or document a script are generally not useful. There are well over 2000 scripts at vim.org and many more on other sites, so outlining a significant number of scripts in separate tips would not be helpful since the information could not easily be found. In addition, any documentation for a script on this wiki will become out of date as the script is updated. The best procedure is for all documentation to be packaged with the script, with just a link and a brief description here. Readers can then scan a list of many scripts and follow the link for those that are of interest.

For historical reasons, there are some old tips that do not comply with this advice (the tip is just a description of a script on another site); in due course such tips will probably be deleted. New tips, however, must provide useful information without relying on external content. We need this approach because there are already too many tips and that makes finding useful information difficult for readers, and makes maintenance hard for editors.

Anyone is welcome to add a script description to the featured tips list – just copy the format of another description and keep it brief.

See also