VimTip

Revision as of 03:07, 3 December 2009

What is a Vim Tip?

A Vim Tip is a nugget of advice which can help solve a particular problem using the Vim editor.

See About for how we started, and Community Portal for an overview, and information on how to ask questions.

Can a Vim Tip be a script?

As well as advice, a Vim Tip may include commands, or snippets of Vim script.

In some cases, a tip can also contain a large block of Vim script, however that is the exception. The Vim Tips wiki is intended to facilitate learning how to use Vim. Simply posting a script, or a link to a script, with no explanation of what it does and how it works, probably with a discussion of the considerations taken and decisions made during development, does not help anyone learn how to use Vim, and is discouraged.

The Vim scripts repository on the Vim website is the correct home for substantial scripts and plugins. The Vim scripts repository is also a great place to find ready-made solutions to a multitude of problems. The Vim Tips wiki is a community in which to share and develop your knowledge.

Should I publish my script here or at vim.org?

If you are willing to provide support and updates for your script as it evolves, then vim.org is the place to publish. It has a versioning and change log system so users of your script can keep up to date with new releases.

If you have a short and useful script, you could consider proposing a new tip with the script, if you add helpful descriptions and explanations.

If you create a user page, you are certainly welcome to place almost anything Vim-related under your own user name (including scripts that you may want some help developing) but these will probably not become an official VimTip. Consider other resources (such as google code or other free online version-controlled code repositories) if you want to do collaborative development of a serious script.

List of all accepted tips

See Category:VimTipProposed for tips that have not yet been accepted.

Contents	Top · 0-9 · A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

All items (1155)

#
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
Other

2

256 colors in vim

A

B

C

Next Last

@@ Line 1: / Line 1: @@
+==What is a Vim Tip?==
-The category of VimTips.
+A Vim Tip is a nugget of advice which can help solve a particular problem using the Vim editor.
+See [[Vim Tips Wiki:About|About]] for how we started, and [[Vim Tips Wiki:Community Portal|Community Portal]] for an overview, and information on how to ask questions.
-== What is a Vim Tip? ==
+==Can a Vim Tip be a script?==
+As well as advice, a Vim Tip may include commands, or snippets of Vim script.
+In some cases, a tip can also contain a large block of Vim script, however that is the exception. The Vim Tips wiki is intended to facilitate learning how to use Vim. Simply posting a script, or a link to a script, with no explanation of what it does ''and how it works'', probably with a discussion of the considerations taken and decisions made during development, does not help anyone learn how to use Vim, and is discouraged.
-A Vim Tip is a little nugget of advice which can help you to solve a particular problem in Vim.
+The Vim scripts repository on the [http://www.vim.org/ Vim website] is the correct home for substantial scripts and plugins. The Vim scripts repository is also a great place to find ready-made solutions to a multitude of problems. The Vim Tips wiki is a community in which to share and develop your knowledge.
-VimTips used to live on the vim website, but were migrated to this wiki in 2006/7/8 ?? to avoid spam, and to allow for collaborative editing.
+==Should I publish my script here or at vim.org?==
-== Can a Vim Tip be a little piece of code (i.e. a script)? ==
+If you are willing to provide support and updates for your script as it evolves, then vim.org is the place to publish. It has a versioning and change log system so users of your script can keep up to date with new releases.
+If you have a short and useful script, you could consider proposing a new tip with the script, if you add helpful descriptions and explanations.
-As well as advice, a Vim Tip might include commands, or snippet of Vim Script.
+If you create a user page, you are certainly welcome to place almost anything Vim-related under your own user name (including scripts that you may want some help developing) but these will probably not become an official VimTip. Consider other resources (such as google code or other free online version-controlled code repositories) if you want to do collaborative development of a serious script.
-=== Does it need to be small? ===
+==List of all accepted tips==
-I suppose a Vim Tip could contain a large block of vimscript, but the vim scripts repository on the Vim website (www.vim.org) might be a better place for large scripts.
+See [[:Category:VimTipProposed]] for tips that have not yet been [[Project:New tips|accepted]].
-== Should I publish my script as a Vimscripts, or should I publish it on the Wiki? ==
-If you are willing to provide support and updates for your script as it evolves, then the vimscripts database is a good place to publish.  It has a versioning and changelog system so users of your script can keep up to date with your new releases.  The VimTips wiki does not provide this structure.  But if you need help developing your script, it may be better to publish on the Wiki, so that other people can add fixes to the code.
-== List of All VimTips ==
 {{CategoryTOC}}