COMJAT.NET Wiki policies
From Wiki@comjat.net
Contents |
Think about what you do
A wiki is a self organising thing! Article live, they grow, they change. Still you can retrieve the old versions of that article - similar to a version control system. Still be aware of what you do! Especially when you create a user: Deletion of your user afterwards is not intended by the wiki software. A user can only be blocked. The user can neither be renamed nor get deleted (from inside the wiki)!
Similar applies to articles. Once you created an article, you can delete it, but you still can retrieve it back from the version control. It is never deleted forever.
| Everybody can contribute, but nobody can destroy. |
List of policies
Below you find the list of policies which to follow when you want to participate in this wiki.
Policies for new accounts
To keep it unified, use your last name as account name when creating a new account.
| When you create a new account, by convention use your last name! |
Take a look at this wiki's user list and expired users to verify on the users of this wiki.
Policies for writing an article
First you must be familiar with the wiki software in general. How do I create a new article? How do I format an article? What is the concept behind the wiki? It's not complicated, thousands of non-technicians write for the Wikipedia!
| Consult the Wiki User's Guide on how write articles for our wiki. |
Topic
Please take care that the topic fits the idea of this wiki when you are aboute to contribute. Any off-topic contributions such as spam will result in the article getting deleted or changes getting reverted. The entire user might get blocked in case of abusing this wiki (spam).
| In case of abuse, contributions will get deleted and in turn entire users will get blocked. |
Title
Make the article title start with an upper case letter and in case there are no special upper case letters in the article title, contiune with lower case!
| Use upper case only for the first letter of the article title (if possible). |
Think carefully on the article name, take a look at existing article names in order to find a meaningful, unique and non-ambiguous name. Remember that the article with the given name will be there forever even if you rename it!
Templates
An article always should consist of an introduction, the author and a category. Also take a look at existing articles to see how an article should look like. You can use the template below to start with:
= Introduction = (some introductory text) == Author == YourFirstName YourLastName [[User:YourUserName]] = Some headline to start with = == Some sub-headline to continue with == [[Category:someCategory]]
Figure 1: Default article template
For the cheat-sheet category, this template might be more suitable:
= Description =
(some description of the command)
== Author ==
YourFirstName YourLastName [[User:YourUserName]]
= Command =
>some-command -a -b -c
'''Figure 1''': The command with this ('''-a'''), that ('''-b''') and even more ('''-c''').
(the command to be discussed)
== Some arguments zo play with ==
* '''''-a''''' - Some 1st argument's description
* '''''-b''''' - Some 2nd argument's description
* '''''-c''''' - Some 3rd argument's description
== Sample output ==
<pre>
(some sample output here)
</pre>
= Links =
* [http://www.fuenf-eins-sechs-eins-de Some sample link]
[[Category:someCategory]]
Figure 2: Cheat-sheet article template
Category
Think carefully on the category name, take a look at existing category names in order to find a meaningful, unique and non-ambiguous name. Before you invent your own category take a look at the list of categories.
Formatting
Consult the Wiki User's Guide for information on using the wiki software. You can also take a look at the existing articles in order to find out on how to format your text.
Aliases
If a name, an e-mail address, a filename or a path is meant to be an alias, i.e. in a tutorial the reader might insert an own substitute, then make this alias italic:
Some Alias
Example: somebody@somewhere.net
Technical terms
Technical terms are to be written in italic, so that the reader easily identifies them:
Some technical term
Example: Linux
Alert boxes
| Information and tips: Use the code below for an alert box like this. |
{| cellpadding="5" cellspacing="0" class="wikitable" style="width: 100%; background:#DFE6F5; border:1px dashed black;"
|Information and tips: Use this code for a blue alert box.
|-
|}
| Alerts and warnings: Use the code below for an alert box like this. |
{| cellpadding="5" cellspacing="0" class="wikitable" style="width: 100%; background:#FFB0B0; border:1px dashed black;"
|Alerts and warnings: Use this code for a red alert box.
|-
|}
Language
Please use English for your articles as many different peaple in different countries consume and contribute - English is the least common denominator.
| English is the language for articles in this wiki. |
