Vim Tips Wiki
Register
(Tweak and put in Category:Policy)
(Change <tt> to <code>, perhaps also minor tweak.)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{NavPolicy}}
 
{{NavPolicy}}
  +
__NOTOC__
 
==Keep it simple==
 
==Keep it simple==
Generally, only simple tips are useful. A tip should not explain all details like a reference
+
Generally, only simple tips are useful. A tip should not explain all details like a reference manual.
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.
 
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.
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.
   
  +
==Tips should be informative and self-contained==
==Merge similar tips==
 
  +
More details in the text for the [[:Category:VimTip|VimTip category]] and our [[Vim_Tips_Wiki:Create_a_new_tip|tip creation guidelines]], but in general a tip should NOT depend on external links for content, it should be useful on its own. Additionally, a script with no explanation is useless to most people, and a tip that does not even explain the problem it tries to solve is useless to pretty much everyone.
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 &ndash; 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.
 
   
 
==Merge similar tips==
Suppose you want to merge tip 5 into tip 1, but you're not ready to delete tip 5:
 
  +
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 [[Vim_Tips_Wiki:Merge_guidelines|merge guidelines]].
# Copy any wanted material from tip 5 into tip 1.
 
# Put the following line at the top of tip 5:
 
#:<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).
 
   
  +
==Useful templates==
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.
 
  +
Several templates are available to simplify and standardize common tasks. For example, you could use the Help template by entering <code><nowiki>{{help|pattern}}</nowiki></code> into a tip. The result looks like this {{help|pattern}}.
   
  +
See the [[Vim_Tips_Wiki:Template_guidelines|template guidelines]] for an overview of the templates used for Vim tips.
==Referencing Vim Help==
 
Suppose you want to refer to a simple Vim help topic like ''pattern''. Put the following wikitext in the tip:
 
   
  +
==See also==
<pre><nowiki>==References==
 
  +
*[[Vim_Tips_Wiki:Policy|Policy introduction]].
*{{help|pattern}}</nowiki></pre>
 
  +
*[[Wikia:Help:Tutorial 1|Tutorial for editing wiki pages]].
  +
*[[Help:Editing|Help on editing, and wiki syntax]].
  +
*[[Vim_Tips_Wiki:Community_Portal|Community overview, and asking questions]].
  +
*[[Vim Tips Wiki:Create a new tip|How to create a new tip]].
   
Some punctuation ('''= &lt; &gt; [ ]''' and more) requires special treatment. See [[Template:Help]] for the details.
 
 
[[Category:Policy]]
 
[[Category:Policy]]

Latest revision as of 08:33, 15 July 2012

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.

Tips should be informative and self-contained[]

More details in the text for the VimTip category and our tip creation guidelines, but in general a tip should NOT depend on external links for content, it should be useful on its own. Additionally, a script with no explanation is useless to most people, and a tip that does not even explain the problem it tries to solve is useless to pretty much everyone.

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[]