Vim Tips Wiki
Register
m (forums on this wiki)
(Change <tt> to <code>, perhaps also minor tweak.)
Tag: rollback
(21 intermediate revisions by 11 users not shown)
Line 1: Line 1:
==In Short==
 
 
 
{{NavPolicy}}
 
{{NavPolicy}}
  +
__NOTOC__
'''Avoid the discussion page while a tip is being reviewed'''
 
 
==In short==
 
'''Do not use the discussion page for tips.'''
   
==Examples and Explanations==
+
==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.
Please avoid using the discussion page (also known as the talk page) for any tip that is still being reviewed.
 
   
  +
You might add text like the following examples:
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.
 
 
*TODO: Merge with <code><nowiki>[[VimTip5]]</nowiki></code>.<code><nowiki> ~~~~</nowiki></code>
 
*I think we should delete the comments about "very nomagic".<code><nowiki> ~~~~</nowiki></code>
  +
*I think we should rename this tip to "Search for current word in multiple files".<code><nowiki> ~~~~</nowiki></code>
   
  +
Include a signature in your comment: On the last line of your text, add a space then four tilde characters ("<code><nowiki> ~~~~</nowiki></code>"). You will see how this appears when you click "Preview".
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 can use a line of four dashes (<code>----</code>) before your comment to separate it from earlier comments.
*TODO: Merge with <tt><nowiki>[[VimTip5]]</nowiki></tt>.
 
*I think we should delete the comments about "very nomagic".
 
   
  +
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 (by hiding potentially relevant information, or by requiring them 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.
It is traditional to keep discussion pages forever. If you're going to put something on the discussion page, please make it worthwhile!
 
   
  +
==Discussion is welcome at vim-l==
==Further things on discussion==
 
All meta discussion regarding the wiki should be done at the [http://lists.wikia.com/mailman/listinfo/vim-l mailing list]. There are also forums on this wiki, but these are not used very frequently.
+
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 08:32, 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

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.