Guide to contributing to the wiki: Difference between revisions

Jump to navigation Jump to search
Removes incorrect info.
imported>Errorage
(Removes incorrect info.)
(17 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== Welcome ==
== Welcome ==


We're happy you've shown interest in contributing to the wiki. This is a quick guide to how you can help
We're happy you've shown interest in contributing to the wiki, we welcome all editors and assume good faith for all edits made, so there are very few protected pages. Don't be afraid to jump in and start correcting and adding to pages.
 
This is a quick guide to how you can help.


== [[Wikicode]] ==
== [[Wikicode]] ==
Line 11: Line 13:
=== New pages ===
=== New pages ===


New content is constantly being added to ss13 which needs tutorials and such. before you start to write a page, search for it and if you can't find it, start one yourself. If you wish to work on a page uninterrupted, make it in your personal [[Special:MyPage/Sandbox|sandbox]] area or anywhere in your own pages. If you don't know wikicode, you can create a unformatted page and ask someone else to format it for you.
New content is constantly being added to ss13 which needs tutorials and such. Before you start to write a page, search for it and if you can't find it, start one yourself. We welcome all contributions to the wiki and trust all edits to be made in good faith. As a recommendation if you wish to work on a page uninterrupted and not worry about other users edits while working, make it in your personal [[Special:MyPage/Sandbox|sandbox]] area or anywhere in your own pages. If you don't know wikicode, you can create a unformatted page and ask someone else to format it for you.


=== Content revisions ===
=== Content revisions ===
Line 35: Line 37:
<code>
<code>
<nowiki>{{Needs revision}}</nowiki><br>
<nowiki>{{Needs revision}}</nowiki><br>
</code>
<code>
<nowiki>{{Needs revision | reason = Out of date.}}</nowiki><br>
</code>
</code>
or<br>
or<br>
Line 40: Line 45:
<nowiki>{{delete}}</nowiki>
<nowiki>{{delete}}</nowiki>
</code>
</code>
==Talk Pages==
When write on a page or user's '''talk page''' (for example [[Talk:Main_Page]]), there are a few things you need to know.
===Signature===
Always end of your message with your signature, so everyone knows who wrote what (without checking the edit history).<br>
This can be done easily by using <code><nowiki>~~~~</nowiki></code> after your message. You can customize your signature on your [[Special:Preferences|user preferences page]].
{|class="wikitable" style="font-size:90%; border: 2px solid darkgrey" cellpadding="3" cellspacing="0" colspan="2" ||
|-
!Code:
||
<nowiki>Look. ~~~~</nowiki>
|-
!Result:
||
Look. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:35, 30 November 2013 (CET)
|}
===Indentation===
When replying to another user's message, be sure to ''indent'' your message so it is visibly a reply to the above message.<br>
This is done by simply adding <code><nowiki>:</nowiki></code> at the start of the line will cause this effect.
{|class="wikitable" style="font-size:90%; border: 2px solid darkgrey" cellpadding="3" cellspacing="0" colspan="2" ||
|-
!Code:
||
<nowiki>Look. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:35, 30 November 2013 (CET)</nowiki><br>
<nowiki>:At what? ~~~~</nowiki>
|-
!Result:
||
Look. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:35, 30 November 2013 (CET)
:At what? - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:40, 30 November 2013 (CET)
|}
===Headline===
If you are starting a new topic, add a headline with the name of the topic. If a talk page is used a lot, it can become confusing if the topics aren't separated with headlines. It also allows for section editing, which makes editing long talk pages a lot easier.<br>
This is one of the most basic things on a wiki, and are used by typing <code><nowiki>==Topic==</nowiki></code> on the line above your message.
{|class="wikitable" style="font-size:90%; border: 2px solid darkgrey" cellpadding="3" cellspacing="0" colspan="2" ||
|-
!Code:
||
<nowiki>==Look at this tutorial==</nowiki><br>
<nowiki>Look. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:35, 30 November 2013 (CET)</nowiki><br>
<nowiki>:At what? - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:40, 30 November 2013 (CET)</nowiki><br>
<nowiki>::This tutorial I made. ~~~~</nowiki>
|-
!Result:
||
<font size="4">Look at this tutorial</font> <nowiki>[</nowiki><span style="color: blue">edit</span><nowiki>]</nowiki>
----
Look. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:35, 30 November 2013 (CET)
:At what? - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:40, 30 November 2013 (CET)
::This tutorial I made. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|talk]]) 10:45, 30 November 2013 (CET)
|}


== Jokes ==
== Jokes ==


Some pages are intended to be entertaining but when writing guides, remember that a newbie might not realize something is a joke or sarcasm, even if it's blatantly obvious to the rest of us. Think where jokes fit and where they don't. Also, if you're updating someone else's joke think if it's actually funnier.
Some pages are intended to be entertaining but when writing guides, remember that a newbie might not realize something is a joke or sarcasm, even if it's blatantly obvious to the rest of us. Think where jokes fit and where they don't. Also, if you're updating someone else's joke, think whether yours is actually funnier.
 
== Guide to Writing and Revising a Guide ==
Always keep in mind what these guides are for; they're so newbies can quickly skim across them so they can have half an idea what they've just been selected for.
 
'''A good guide needs, by order:'''
* A brief one-two paragraph description of what the mode is.
* A bullet point list of short to the point key points of key mechanics, these should be no longer than two sentences each. And remember: key points means the important shit you need to know to atleast bumble fuck your way around at round start, you should be able to read and understand it within 5 minutes.
* A more meaty section detailing the game mechanics in depth (this is where you explain what all runes and talismans do, including the ones that are barely used), it should still be clear and concise.
* A summary of the key points, yes - one at the start and one at the end. Reiteration helps to hammer things home. This one will more or less be simple list to remind the reader of things, it wont explain them.
* Further reading - this is where you link to the pages that detail advanced strategies for fighting for and against the cult. No you don't put them on the main page because that will clutter it.
* Links! Remember to add links to [[Game modes|game modes]], [[Guides#Antagonist Guides|antagonist roles]], [[jobs]], items and [[guides]] you mention! Simply do it when you re-read your content before submitting.
 
 
A bad guide is one that's a giant wall of text that's overly fluffed up and full of opinionated bullshit.<br>
A newbie is going to take one glance at it and shit their pants out of fright, and advanced player is just going to go "Yeah.... I'm not reading someone's sperg page".
 
[At the moment]{{citation needed}} [[Guides#Security guides|Security's guides]] are good. [[Space Law]] is unfluffed and tells plainly the basics of what a [[security officer]] needs to know to start patrolling and robusting greyshirts. The [[Guide to security]] is more fleshed out and explains things more in depth and lists strategies to counter antags.<br>
[[Cult]], [[Malf]], and [[Traitor]] are bad because they're giant imposing walls of text that reads like a newspaper: squished up text that obscures the facts with needless opinions and blurbs that you don't need to know off the bat.
 
'''So remember:'''
* Facts good, opinions bad.
* Keep your facts clear of irrelevant fluff and other bullshit.
* Keep the basic guide basic, keep the advanced stuff on a separate page.
* Important stuff first, depth and explanation and unimportant things second.
* White space, tables, sections, and formatting are essential for ease of reading. We're not print media, space isn't at a premium so use it freely.
* Links!
* I just used the above template to write this guide.


== Useful pages ==
== Useful pages ==
Line 60: Line 149:


The wiki also supports the features of the [http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions ParserFunctions] extension.
The wiki also supports the features of the [http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions ParserFunctions] extension.
== Spambot protection - Security question ==
To create an account you will need to provide the answer of one of two questions. One being about the game engine (byond) and the other about the chan board (tg). The answers to the questions are in brackets.
You will need to provide the answer to the question every time you make an edit as an unregistered user. The question is just above the edit content field.


[[Category:Guides]] [[Category:Game Resources]]
[[Category:Guides]] [[Category:Game Resources]]
{{Contribution guides}}
{{Contribution guides}}

Navigation menu