Styleguide: Difference between revisions

== About ==

Guidelines for editing pages on the wiki for consistent quality and style.

=== Edits ===

Every time you save your edit a commit is made. This commit will be reviewed by administrators. To make their lives easier try not to split your changes into dozens of separate commits but do them all in one go. Another thing that really helps is adding a summary (aka 'Comment') and make proper use of the ''minor edit'' option. Both will tell the administrator what to look for when checking the edit. Stating your intention as well, can prevent misunderstandings like: <code>Rephrased foreword for increased readability.</code>

=== New Pages ===

Avoid duplicates by thoroughly searching in the wiki and asking if need be. Try to following the existing naming schemes including capitalization. Here is an example, if you were to write a guide of how to walk properly:

* '''Almost there:''' Guide to walking

* '''Good:''' Guide to Walking

=== Jokes ===

Some pages are intended to be entertaining, but when writing guides, please remember that a new player might not realize that something is a joke or sarcasm and will instead take it at face value. For more practical guides, less jokes are better. Where it is more discretionary, please think about where jokes fit and where they don't, and if you are updating someone else's joke, think whether yours is ''actually funnier''.

=== Terminology ===

Try to be consistent with any terminology and ask for clarification if need be:

* Use '''tick''' instead of '''cycle'''

=== Categories ===

You can put articles into categores by inserting the appropriate command like <code><nowiki>[[Category:Guides]]</nowiki></code>. This should be done at the bottom of the page. Please refrain from creating new categories or editing article-categories without talking about it with the wiki-staff first. This is necessary for categories to be consistent.

=== Article Quality ===

When revising and writing articles try to consider the following things:

!Correct Language

|Check grammar / punctuation / typos. Basically make sure it feels like authentic english

|-

!Lore

|-

!Design

'''Do not upload duplicate files'''. Update them instead. When uploading new versions of images it can take a while for them to get cached by the wiki. There is no need for repeated uploads. This can take quite a while.

=== Sprites ===

Where possible, sprites should be uploaded as a 32px by 32px PNG graphic (for static images) or a 32px by 32px GIF image for animated images. All images should be on an alpha (transparent) background where possible.

=== Map Images ===

Should consist of the area being covered and its immediate surrounding walls. Always include full tiles. A quality crop can be easily achieved by using a 32px by 32px grid and the marquee tool set to snap to said grid.

Refer to the images below for further guidance.

!Good

!Bad

|[[File:Badcrop.png]]

|}

== Collaboration ==

=== Private pages / sandboxes ===

To use your sandbox use [[Special:MyPage/Sandbox]] to be redirected to your own sandbox. You can create as many private sandboxes as you want. Just create an article in the appropriate namespace like:

https://wiki.yogstation.net/wiki/User:YourUserName/YourSandboxName

=== Editing templates ===

Be very careful when editing templates, as breaking them will look really bad. It is easy to miss relevant use cases - use your sandbox to tinker with a copy and coordinate with the wiki-staff before applying bigger changes.

And as always, make sure to update the documentation.

[[Category:Guides]] [[Category:Game Resources]]

{{Contribution guides}}