Vim Tips Wiki
(tidy up step 1/2)
(Change <tt> to <code>, perhaps also minor tweak.)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{NavPolicy}}
 
{{NavPolicy}}
  +
__NOTOC__
 
There are very few policies which apply across all Wikia &ndash; see [[Wikia:Category:Policy]].
   
  +
Policies in the Vim Tips wiki are decided by the wiki community. We have suggested guidelines rather than rules. Each policy page has <code><nowiki>[[Category:Policy]]</nowiki></code> at the bottom, so they are listed in the [[:Category:Policy|policy category]].
== General Notes by Wikia ==
 
   
 
The [[Project:Simplified Ruleset|simplified ruleset]] from Wikipedia is worth reading!
There are very few policies which apply across all Wikia. These can be found on the Central Wikia at [[Wikia:Category:Policy]].
 
   
 
==General guidelines for the Vim Tips wiki==
Other policies for this Wikia will be decided by the wiki community. It's generally best to keep policies as simple as possible, and not to introduce too many rules. A growing wiki can usually do well with a few simple policies and a lot of good will and cooperation.
 
 
This page is the starting point for people asking how to do it '''right'''. We are thinking of three groups of users:
   
 
#'''Readers''' that find typos or want to add a comment, should just '''be bold'''. Content is more important than form, so if you want to contribute, please click ''edit'' and write your stuff.
Adding <nowiki>[[Category:Policy]]</nowiki> to any policy pages will add them to the policy category. This is found [[:Category:Policy|here]].
 
 
#'''Contributors''' of new tips should get along with just the [[Project:Golden Rules|Golden Rules]]. Contributors are encouraged to get an account to ''watch'' their pages.
 
#'''Editors''' that review and repair tips should get acquainted with the more detailed guidelines below. Editors are encouraged to get an account and join the '''[http://lists.wikia.com/mailman/listinfo/vim-l mailing list]'''.
   
 
==Guidelines for editors==
Here is the [[Project:Simplified Ruleset|simplified ruleset]] from wikipedia. Worth reading!
 
 
Most of the tips were imported from a database on http://www.vim.org. Some tips have low quality, or are outdated, or misformatted etc. So we need a lot of help to enhance them. Tips that need help can be found in [[:Category:Review]]. Please see the more detailed '''Vim Tip Guidelines''' in the list at the top of this page.
   
  +
We encourage contributors and editors to get an account and to create a [[Special:Listusers|user page]]. See the ''Log in'' or ''Create an account'' links at the top of any page. Having an account allows other people to contact you by editing your talk (discussion) page. That can be useful to exchange information about the best procedures for editing tips.
== General Guidelines for the Vim Tips Wiki==
 
   
  +
==See also==
Since we have a lot of content, we need some guidelines to get the wiki in good shape. This page is the starting point for people asking how to do it '''right'''. We are thinking of three groups of users:
 
  +
*[[Vim_Tips_Wiki:General guidelines|Vim Tip Guidelines]].
  +
*[[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]].
   
 
[[Category:Policy]]
# '''Readers''', that find typos or add a small comment, should just '''be bold'''. The idea is that content is more important than form. So if you want to contribute, simply click edit and write your stuff.
 
# '''Contributors''' of new tips should also get along with [[Project:Golden Rules]]. These could get an account to ''watch'' their pages.
 
# '''Editors''' that review and repair other tips (may they be new or imported), should get aquainted with the more detailed guidlines below. Editors are encouraged to join the [http://lists.wikia.com/pipermail/vim-l/|mailing list]]
 
 
== Detailed Guidelines for contributors ==
 
 
Most of the tips were imported from a database on http://vim.org. Some tips have low quality, or are outdated, or misformatted etc. So we need a '''lot''' of help to enhance them. Tips that need help can be found in [[:Category:Review]]. For these tips we have developed more detailed guidelines:
 
 
* [[Vim_Tips_Wiki:General_guidelines]]
 
* [[Vim_Tips_Wiki:Title_guidelines]]
 
* [[Vim_Tips_Wiki:Comment_guidelines]]
 
* [[Vim_Tips_Wiki:Category_guidelines]]
 
* [[Vim_Tips_Wiki:Discussion_guidelines]]
 
* [[Vim_Tips_Wiki:Delete_guidelines]]
 
 
 
 
----
 
== Strategy ==
 
 
This is a stub; ideas from the maillist discussions and [[Forum:What_is_the_ultimate_goal_for_Tips_pages?]] should be incorporated here.
 
 
All rules/guidelines should clearly say that these are advices to make the wiki more valuable. Under [[Project:Simplified Ruleset]] this is expressed nicely with '''Don't follow the rules'''. Perhaps this could be done better at [[Project:Golden Rules]].
 
 
First ideas:
 
* '''Page titles'''
 
** allowed chars?
 
** number of words?
 
** specific form (omit "a" "the")?
 
** specific grammar: eg. subject-predicate-object, imperative?
 
:::See [[Vim_Tips_Wiki:Title_guidelines]] for more ideas.
 
 
* '''Tip body.'''
 
** more structure, especially when comments are merged in.
 
** for longer tips TOC.
 
 
* '''Existing Comments.'''
 
** drop comments that have bad attitude, or have no good content
 
** merge additions to the tips into the real tip.
 
:::See [[Vim_Tips_Wiki:Comment_guidelines]] for more ideas.
 
 
* howto merge similar articles?
 
:::See [[Vim_Tips_Wiki:General_guidelines]] for information on merging.
 
[[Category:Policy|*]]
 

Latest revision as of 08:39, 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

There are very few policies which apply across all Wikia – see Wikia:Category:Policy.

Policies in the Vim Tips wiki are decided by the wiki community. We have suggested guidelines rather than rules. Each policy page has [[Category:Policy]] at the bottom, so they are listed in the policy category.

The simplified ruleset from Wikipedia is worth reading!

General guidelines for the Vim Tips wiki[]

This page is the starting point for people asking how to do it right. We are thinking of three groups of users:

  1. Readers that find typos or want to add a comment, should just be bold. Content is more important than form, so if you want to contribute, please click edit and write your stuff.
  2. Contributors of new tips should get along with just the Golden Rules. Contributors are encouraged to get an account to watch their pages.
  3. Editors that review and repair tips should get acquainted with the more detailed guidelines below. Editors are encouraged to get an account and join the mailing list.

Guidelines for editors[]

Most of the tips were imported from a database on http://www.vim.org. Some tips have low quality, or are outdated, or misformatted etc. So we need a lot of help to enhance them. Tips that need help can be found in Category:Review. Please see the more detailed Vim Tip Guidelines in the list at the top of this page.

We encourage contributors and editors to get an account and to create a user page. See the Log in or Create an account links at the top of any page. Having an account allows other people to contact you by editing your talk (discussion) page. That can be useful to exchange information about the best procedures for editing tips.

See also[]