Vim Tips Wiki
Register
m (Lowercase "Examples and explanations")
(Harden the "avoid talk page" guidelines)
Line 1: Line 1:
 
{{NavPolicy}}
 
{{NavPolicy}}
  +
__NOTOC__
 
==In short==
 
==In short==
'''Avoid the discussion page while a tip is being reviewed.'''
+
'''Avoid the discussion page for tips.'''
   
 
==Examples and explanations==
 
==Examples and explanations==
Please avoid using the discussion page (also known as the talk page) for any tip that is still being reviewed.
+
Please avoid using the discussion page (also known as the talk page) for Vim Tips.
   
  +
There are around 1300 tips, and most of them need a lot of work. Some are obsolete and some are misguided. Many are incomplete, or need to be merged. If you think a tip has a problem, please just add to the Comments section where everyone can see it. Some people are uneasy about the appearance of a tip, and don't like to write something like "This is not needed since version 7.0" in a comment. But that's exactly what you should do if you want to help readers and editors.
Around 1400 tips were imported from vim.org in June 2007. Until that process is reasonably complete, we should not add additional clutter to the wiki.
 
   
If you have something to say about a tip, please add to the Comments section at the bottom of the tip. You might add text like the following examples (before other comments, just after the ''<nowiki>==Comments==</nowiki>'' heading):
+
You might add text like the following examples (before other general comments, just after the <tt><nowiki>==Comments==</nowiki></tt> heading):
   
 
*TODO: Merge with <tt><nowiki>[[VimTip5]]</nowiki></tt>.
 
*TODO: Merge with <tt><nowiki>[[VimTip5]]</nowiki></tt>.
 
*I think we should delete the comments about "very nomagic".
 
*I think we should delete the comments about "very nomagic".
   
  +
Put a line of four dashes (<tt><nowiki>----</nowiki></tt>) after your comment (to separate it from comments that may be added later).
Like all wiki rules, you are free to disregard the recommendation that the discussion page should not be used. However, please try to avoid adding to the workload of other people who may be trying to fix the tips (using the talk page potentially hides relevant information, or may require other people to edit two pages instead of just one).
 
   
 
Like all wiki rules, you are free to disregard the recommendation that the discussion page should not be used. However, please try to avoid adding to the workload of other people who may be trying to fix the tips: using the talk page potentially hides relevant information, and may require other people to edit two pages instead of just one.
It is traditional to keep discussion pages forever. If you're going to put something on the discussion page, please make it worthwhile!
 
  +
  +
We use, and will keep, the discussion pages for articles that are not tips (for example, categories, templates, policies). However, current practice is to delete the discussion page for tips (while moving any useful content to the comments on the tip page) because dealing with two pages rather than one is just too hard.
   
 
==Discussion is welcome at vim-l==
 
==Discussion is welcome at vim-l==

Revision as of 11:13, 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

In short

Avoid the discussion page for tips.

Examples and explanations

Please avoid using the discussion page (also known as the talk page) for Vim Tips.

There are around 1300 tips, and most of them need a lot of work. Some are obsolete and some are misguided. Many are incomplete, or need to be merged. If you think a tip has a problem, please just add to the Comments section where everyone can see it. Some people are uneasy about the appearance of a tip, and don't like to write something like "This is not needed since version 7.0" in a comment. But that's exactly what you should do if you want to help readers and editors.

You might add text like the following examples (before other general comments, just after the ==Comments== heading):

  • TODO: Merge with [[VimTip5]].
  • I think we should delete the comments about "very nomagic".

Put a line of four dashes (----) after your comment (to separate it from comments that may be added later).

Like all wiki rules, you are free to disregard the recommendation that the discussion page should not be used. However, please try to avoid adding to the workload of other people who may be trying to fix the tips: using the talk page potentially hides relevant information, and may require other people to edit two pages instead of just one.

We use, and will keep, the discussion pages for articles that are not tips (for example, categories, templates, policies). However, current practice is to delete the discussion page for tips (while moving any useful content to the comments on the tip page) because dealing with two pages rather than one is just too hard.

Discussion is welcome at vim-l

All meta discussion regarding the wiki should use the Vim-l mailing list. If you're not ready to join the mailing list, you could edit the talk page of any active user.