Vim Tips Wiki
Register
(Add links to policy/help/community.)
(Update guidelines (fairly minor))
Line 8: Line 8:
 
If a tip is only useful in an obsolete version of Vim, the tip should be deleted. Vim version 7.0 was released in May 2006 and the best tip for people using older versions is ''please update''!
 
If a tip is only useful in an obsolete version of Vim, the tip should be deleted. Vim version 7.0 was released in May 2006 and the best tip for people using older versions is ''please update''!
   
See [[Vim_Tips_Wiki:Delete_guidelines|deleting a tip]] for information about deleting a tip, or marking a tip as Deprecated, or effectively hiding a tip.
+
See [[Vim_Tips_Wiki:Delete_guidelines|deleting a tip]], or the [[Vim_Tips_Wiki:Template_guidelines|template guidelines]] to flag a tip as Deprecated or Dodgy.
   
 
==Merge similar tips==
 
==Merge similar tips==

Revision as of 10:29, 15 January 2008

Vim Tip Guidelines
Quick reference
General guidelines
Titles and renaming a tip
Comments
Categories
Discussion page
Merging similar tips
Deleting a tip
Templates
Formatting code blocks
Entities and other magic
Script comments

Keep it simple

Generally, only simple tips are useful. A tip should not explain all details like a reference manual.

A tip may deal with a complex topic. However, the tip should merely illustrate the concepts and provide an example. It should not cover all possibilities.

If a tip is only useful in an obsolete version of Vim, the tip should be deleted. Vim version 7.0 was released in May 2006 and the best tip for people using older versions is please update!

See deleting a tip, or the template guidelines to flag a tip as Deprecated or Dodgy.

Merge similar tips

Tips which cover the same material should be merged. You can simply flag duplicate tips to notify others that the tips need to be merged. Or, you can merge the material into one tip. See the merge guidelines.

Useful templates

Several templates are available to simplify and standardize common tasks. For example, you could use the Help template by entering {{help|pattern}} into a tip. The result looks like this :help pattern.

See the template guidelines for an overview of the templates used for Vim tips.

See also