Vim Tips Wiki
Register
(→‎Examples and explanations: example for renaming)
(tweak)
Line 2: Line 2:
 
__NOTOC__
 
__NOTOC__
 
==In short==
 
==In short==
'''Avoid the discussion page for tips.'''
+
'''Do not use the discussion page for tips.'''
   
 
==Examples and explanations==
 
==Examples and explanations==
Please avoid using the discussion page (also known as the talk page) for Vim Tips.
+
Do not use 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.
+
If you think a tip has a problem, please add a note to the Comments section where everyone can see it (click "edit" in the right margin, on the "Comments" line). 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 <tt><nowiki>==Comments==</nowiki></tt> heading):
+
You might add text like the following examples:
 
*TODO: Merge with <tt><nowiki>[[VimTip5]]</nowiki></tt>.<tt><nowiki> ~~~~</nowiki></tt>
 
*I think we should delete the comments about "very nomagic".<tt><nowiki> ~~~~</nowiki></tt>
 
*I think we should rename this tip to "Search for current word in multiple files".<tt><nowiki> ~~~~</nowiki></tt>
   
  +
Include a signature in your comment: On the last line of your text, add a space then four tilde characters ("<tt><nowiki> ~~~~</nowiki></tt>"). You will see how this appears when you click "Preview".
*TODO: Merge with <tt><nowiki>[[VimTip5]]</nowiki></tt>.
 
*I think we should delete the comments about "very nomagic".
 
*I think we should rename this tip to "Search for current word in multiple files".
 
   
Put a line of four dashes (<tt><nowiki>----</nowiki></tt>) after your comment (to separate it from comments that may be added later).
+
You can use a line of four dashes (<tt>----</tt>) before your comment to separate it from earlier comments.
   
 
We use, and will keep, the discussion pages for articles that are not tips (user pages, categories, templates, policies). There are some exceptions ([[CSV|example]]), but generally we delete the discussion page for tips (after moving any useful content to the comments on the tip page) because dealing with two pages rather than one is unnecessarily hard.
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 only want useful tips, so eventually all comments should be removed, after merging any useful information into the tip. Using a 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==
 
==Discussion is welcome at vim-l==
All meta discussion regarding the wiki should use the [http://lists.wikia.com/mailman/listinfo/vim-l Vim-l mailing list]. If you're not ready to join the mailing list, you could edit the talk page of any [[Special:Listusers|active user]].
+
All meta discussion regarding the wiki should use the [http://lists.wikia.com/mailman/listinfo/vim-l Vim-l mailing list]. If you're not ready to join the mailing list, you could edit the talk page of any active user; see [[Special:RecentChanges|Recent changes]].
   
 
[[Category:Policy]]
 
[[Category:Policy]]

Revision as of 01:03, 31 August 2009

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

Do not use the discussion page for tips.

Examples and explanations

Do not use the discussion page (also known as the talk page) for Vim Tips.

If you think a tip has a problem, please add a note to the Comments section where everyone can see it (click "edit" in the right margin, on the "Comments" line). 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:

  • TODO: Merge with [[VimTip5]]. ~~~~
  • I think we should delete the comments about "very nomagic". ~~~~
  • I think we should rename this tip to "Search for current word in multiple files". ~~~~

Include a signature in your comment: On the last line of your text, add a space then four tilde characters (" ~~~~"). You will see how this appears when you click "Preview".

You can use a line of four dashes (----) before your comment to separate it from earlier comments.

We use, and will keep, the discussion pages for articles that are not tips (user pages, categories, templates, policies). There are some exceptions (example), but generally we delete the discussion page for tips (after moving any useful content to the comments on the tip page) because dealing with two pages rather than one is unnecessarily hard.

We only want useful tips, so eventually all comments should be removed, after merging any useful information into the tip. Using a talk page potentially hides relevant information, and may require other people to edit two pages instead of just one.

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; see Recent changes.