Vim Tips Wiki
Register
(General guidelines for editing tips)
 
(If merge, remove Template:Review)
Line 10: Line 10:
 
==Merge similar tips==
 
==Merge similar tips==
 
Tips which cover the same material should be merged. Keep the first similar tip, and delete the others (after copying any useful material to the tip you are keeping). Remember to be ruthless – please delete material that is only useful for obsolete versions of Vim. We can't support versions prior to Vim 6.0, although all versions prior to 7.0 are obsolete.
 
Tips which cover the same material should be merged. Keep the first similar tip, and delete the others (after copying any useful material to the tip you are keeping). Remember to be ruthless – please delete material that is only useful for obsolete versions of Vim. We can't support versions prior to Vim 6.0, although all versions prior to 7.0 are obsolete.
 
See [[Vim_Tips_Wiki:Delete_guidelines|deleting a tip]].
 
   
 
Suppose you want to merge tip 5 into tip 1, but you're not ready to delete tip 5:
 
Suppose you want to merge tip 5 into tip 1, but you're not ready to delete tip 5:
 
# Copy any wanted material from tip 5 into tip 1.
 
# Copy any wanted material from tip 5 into tip 1.
 
# Put the following line at the top of tip 5:
 
# Put the following line at the top of tip 5:
::<tt><nowiki>{{Merged|1}}</nowiki></tt>
+
#:<tt><nowiki>{{Merged|1}}</nowiki></tt>
  +
# If tip 5 contains a <tt><nowiki>{{Review}}</nowiki></tt> line, delete it (so tip 5 will not be listed in [[:Category:Review]] as needing review).
   
 
The merged template will advise anyone viewing tip 5 that they should be reading tip 1 instead. Later, we might decide to delete tip 5.
 
The merged template will advise anyone viewing tip 5 that they should be reading tip 1 instead. Later, we might decide to delete tip 5.
  +
 
See [[Vim_Tips_Wiki:Delete_guidelines|deleting a tip]].
   
 
==Referencing Vim Help==
 
==Referencing Vim Help==

Revision as of 12:14, 21 July 2007

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!

Merge similar tips

Tips which cover the same material should be merged. Keep the first similar tip, and delete the others (after copying any useful material to the tip you are keeping). Remember to be ruthless – please delete material that is only useful for obsolete versions of Vim. We can't support versions prior to Vim 6.0, although all versions prior to 7.0 are obsolete.

Suppose you want to merge tip 5 into tip 1, but you're not ready to delete tip 5:

  1. Copy any wanted material from tip 5 into tip 1.
  2. Put the following line at the top of tip 5:
    {{Merged|1}}
  3. If tip 5 contains a {{Review}} line, delete it (so tip 5 will not be listed in Category:Review as needing review).

The merged template will advise anyone viewing tip 5 that they should be reading tip 1 instead. Later, we might decide to delete tip 5.

See deleting a tip.

Referencing Vim Help

Suppose you want to refer to a simple Vim help topic like pattern. Put the following wikitext in the tip:

==References==
*{{help|pattern}}

Some punctuation (= < > [ ] and more) requires special treatment. See Template:Help for the details.