Просмотр кода страницы Помощь с Wiki




=Before you begin=
* The [[Special:SpecialPages]] page is the #1 weapon against unorganized or lacking wiki pages. It can be reached from the [http://i.imgur.com/pTsPYpc.png main menu cogwheel].
* The [[Special:Version]] special page has useful information on what extensions are installed for more advanced knowledge on wiki syntax and functionality.
* If you're not sure how to use wiki syntax, check out the official [https://www.mediawiki.org/wiki/Help:Formatting Mediawiki Formatting] page.
* Check out your [[Special:Preferences | "Editing" user preferences]] and make sure you have the enhanced editing toolbar enabled, among other optional tweaks.


=Editing Standard=
The editing standard of the wiki is extremely important, as the wiki is what governs how players learn the game. So it has to be legible and coherent for what it is you are trying to display/explain, whether its a mechanic or a job/caste.

==Editing Philosophy==
When it comes to creating a new page or editing a pre-existing page the current design philosophy on the wiki is to provide a lot of visual feedback to the reader i.e. Images and gifs displaying what X mechanic or item does and what it looks like. This is because lots and lots of text is what the reader does NOT want to have to go through in order to find out how to do X. The only exception to that rule is pages regarding lore.


One of the most important goals to consider when writing or editing a wiki page is that you want the information that you are providing to be in it's most simplest form so that it is easy to understand for any and all players. Whether it is for someone who is a native english speaker or someone who is an ESL, the simplicity of the explanation is what make your edit good because it means that more people can understand it. 


An example of this is via teaching, if your teacher explains a topic in a convoluted and long winded manner then the likelihood of the class fully understanding said topic is very low as some students may get bored or find it hard to follow. If they explain it in a short and concise manner, then it is a lot simpler to understand. The example of teaching is because as a wiki editor you're the unseen teacher of the hundreds who play this game, so your explanations etc need to make sense and be easy to follow.


'''Questions to think about when editing a page or creating a new one:'''

* Have I written too much?
* Could I condense this down?
* Could I simplify my writing?
* Could I provide visual aid to what I'm explaining?
* Would a new player be able to understand this without any prior context knowledge?

''If you are ever in doubt about your edit just post a preview of your edit in  #wiki-work on discord for wiki contributors and the wiki maintainer to look at and provide feedback.''


Lastly, after finishing an edit, write a brief summary of what the edit is before you save page as it helps organise your edit amongst all the others so other editors can see when a certain section or topic was added to a page. Here's the summary for this section being added to give you an example of what this should look like:

[[File:Page_summary.png|link=]]


=Mediawiki Code=
This section is to cover the basics of mediawiki code  so that new and returning wiki contributors can refresh themselves with the basic and adanced code.



<tabs>
<tab name="Basic Formatting Code">

{| style="border: 2px solid black; class="mw-collapsible"
 ! style="background-color:#31532f; width:150px;"|'''Action to be performed:'''
 ! style="background-color:#31532f;"|<center>'''The Code:'''</center>
 ! style="background-color:#31532f;"|<center>'''The Output:'''</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Removes the table of contents
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> <nowiki>__NOTOC__</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> Removes the table of contents. 

The code will not appear on the page when viewed.</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Applying Bolding to text
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki>'''Bold'''</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> '''Bold'''</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Applying Italics to text
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki>''Italics''</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center>''Italics''</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Applying underlines to text
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki><U>Underline Text.</U></nowiki>


<small>''This is HTML code as mediawiki does not have a native underline command.''</small></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><U>Underline Text.</U></center>

|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Applying strikethroughs to text
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki><S>Strikethrough Text.</S></nowiki>


<small>''This is HTML code as mediawiki does not have a native strikethrough command.''</small></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><S>Strikethrough Text.</S></center>

|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Making formatting Centered
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki><center>Centered Text.</center></nowiki>


<small>''This is HTML code as mediawiki does not have a native center command.''</small></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center>Centered Text.</center>

|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Dividing line
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> This is a
<nowiki>----</nowiki>

Dividing Line
</center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center>This is a
----
Dividing Line</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Page headers
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |

<nowiki>= Page Header One=</nowiki>
* <small>''This is the same header level as the page title at the top, so normally you won't use this and instead will use header two.''</small>


<nowiki>== Page Header Two==</nowiki>

<nowiki>=== Page Header Three ===</nowiki>

<nowiki>==== Page Header Four ====</nowiki>

<nowiki>===== Page Header Five =====</nowiki>

<nowiki>====== Page Header Six ======</nowiki>


A way that we like to use headers is to place images{Files) in them to help them stand out visually for the reader.


<small><nowiki>======[[File:Vendor Utilities.png]]  Marine Vendor [[File:Vendor Utilities.png]] ======</nowiki></small>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | To avoid messing up the table of contents for this page the below image will detail what this would look like.
[[File:Wiki_Page_Headers.png|link=]]

|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Bullet Points
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | This is a
<nowiki>* Bullet Point</nowiki>

|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | This is a
* Bullet Point

|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Numbered List
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | This is a
<nowiki>
# Numbered List 1</nowiki>

<nowiki># Numbered List 2</nowiki>

<nowiki># Numbered List 3</nowiki>

|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | This is a
# Numbered List 1
# Numbered List 2
# Numbered List 3
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Linking outside the wiki
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki>[https://cm-ss13.com/forums/ Linking outside the wiki]</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center>[https://cm-ss13.com/forums/ Linking outside the wiki]</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Linking within the wiki
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki>[[Marine_Equipment | Linking within the wiki]]</nowiki>


<nowiki>[[Pagename (as it appears in the address bar)| Desired Words]]</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center>[[Marine_Equipment | Linking within the wiki]]</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Displaying Images
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | 


<center><nowiki>[[File:Vendor Utilities.png]]</nowiki>


<nowiki>[[File:Vendor Utilities.png|32px]]</nowiki>


<nowiki>[[File:Vendor Utilities.png|128px]]</nowiki>


<small>''You can alter the display size of a file by changing the pixels as shown above.''</small>
</center>

----
*Most files are uploaded to be 64x64px, so please keep to this.
*Remember if the image you desire is not on the wiki, please upload it [[Special:Upload | HERE.]]
*Please be certain beforehand that it is not on the wiki first. If you're unsure ask in #wiki-work on discord.</center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center>
[[File:Vendor Utilities.png|link=]]
[[File:Vendor Utilities.png|32px|link=]]
[[File:Vendor Utilities.png|128px|link=]]

</center>
|}
</tab>



<tab name="Advanced Formatting Code">

{| style="border: 2px solid black; class="mw-collapsible"
 ! style="background-color:#31532f; width:150px;"|'''Action to be performed:'''
 ! style="background-color:#31532f;"|<center>'''The Code:'''</center>
 ! style="background-color:#31532f;"|<center>'''The Output:'''</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Text for just the editors
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> <nowiki>
<!-- The Gaps are here for readability when editing --></nowiki></center> <small>This of course will not show up in the Output section as you will only see it if you open a page to edit.</small>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> <!-- The Gaps are here for readability when editing --></center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | No wiki code
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki><nowiki>'''Bold'''</nowiki></nowiki></center> <small>This stops wikicode from functioning, highly useful when filling out a usage section on a template.</small>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> <nowiki>'''Bold'''</nowiki></center>
|}

</tab>

<tab name="Table Formatting Code">

{| style="border: 2px solid black; class="mw-collapsible"
 ! style="background-color:#31532f; width:150px;"|'''Action to be performed:'''
 ! style="background-color:#31532f;"|<center>'''The Code:'''</center>
 ! style="background-color:#31532f;"|<center>'''The Output:'''</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Fill in
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> <nowiki>Fill in</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> Fill in</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Fill in
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki>Fill in</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> Fill in</center>
|}

</tab>

<tab name="Advanced Table Formatting">

{| style="border: 2px solid black; class="mw-collapsible"
 ! style="background-color:#31532f; width:150px;"|'''Action to be performed:'''
 ! style="background-color:#31532f;"|<center>'''The Code:'''</center>
 ! style="background-color:#31532f;"|<center>'''The Output:'''</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Fill in
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> <nowiki>Fill in</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> Fill in</center>
|-
|style="width:125px; border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | Fill in
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" | <center><nowiki>Fill in</nowiki></center>
|style="border: 2px solid black; border-bottom: 2px solid black; padding: 5px;" |<center> Fill in</center>
|}

</tab>

</tabs>

=Contributing=
* Place <nowiki>{{outdated}}</nowiki> at the top of a wiki page to display a banner showing that the page is outdated and needs help. [[:Category:Outdated|View all outdated pages here]] - you're welcome to help update them.
* [[Special:ShortPages]] might be looking for more data.
* [[Special:WantedFiles]] are all linked images that don't have a file attached to them. In 90% of cases, you can let [https://cm-ss13.com/wiki/User:Sargeantmuffinman Sargeantmuffinman], [https://cm-ss13.com/memberlist.php?mode=viewprofile&u=239 TopHatPenguin] or Harryob know about these and they can upload the correct icon directly from source files. (Combined icons won't work for this, such as a human wearing armor, clothing, and holding weapons.)
* [[Special:WantedPages]] are links to pages that don't exist yet, but someone feels it's needed.
* If you [[Special:Upload | upload a file]], make sure it doesn't already exist by checking [[Special:ListFiles]]. '''It is crucial that existing files are replaced by [http://i.imgur.com/2Zj2ckj.png uploading a new version] - DO NOT upload another version of the file with a different name!'''
* Tables have their own markup that is clean and easy to edit. Visit the official Mediawiki [https://www.mediawiki.org/wiki/Help:Tables#Wiki_table_markup_summary Help:Tables] page for more info. There are also a few 3rd-party tools to assist with formatting, such as the [http://www.tablesgenerator.com/mediawiki_tables Mediawiki Tables Generator].
* [https://www.mediawiki.org/wiki/Help:Templates Templates] are extremely powerful wiki additions that help eliminate redundancy in markup and provide a clean, easy-to-edit layout for future contributors. [http://cm-ss13.com/wiki/Special:AllPages?from=&to=&namespace=10 Check out the templates we're using]. For example, you can add <nowiki>{{tocright}}</nowiki> to any page to have the Table of Contents move to the right side of the page. Advanced templates can include [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions ParserFunctions] (using #if, #ifexp, #switch, etc) for calculation and string handling (e.g. item infoboxes that show a default "Image not found" image if one doesn't exist), leading to some very clean and professional-looking documentation.
* Some other features include [https://www.mediawiki.org/wiki/Help:Magic_words Magic Words], which can be useful in templates or in special cases, such as hiding the Table of Contents (TOC).
* [https://www.mediawiki.org/wiki/Category:Help All other Mediawiki-specific Help pages are here] if you'd like to learn more.

=Cleaning=
* [[Special:LonelyPages]] has a list of pages that ''might'' need to be deleted or worked on (anything deleted can be restored).
* [[Special:UnusedFiles]] might also need to be deleted (anything deleted can be restored).
** Note: normal users are unable to delete pages, but [http://cm-ss13.com/wiki/index.php?title=Special:ListUsers&group=Trusted Trusted users] can.