Official Barotrauma Wiki:Guidelines

From Official Barotrauma Wiki
Revision as of 15:21, 9 April 2021 by Dynamoon (talk | contribs)
Jump to: navigation, search

Hello and welcome to editing the official Barotrauma wiki! If you’d like to suggest edits to this page, please leave a comment in the page discussion or get in touch with the wiki actives directly on the official Discord – they can also offer information that might be missing here, so don’t hesitate to talk to them.

Getting started

Once you have created an account, you are able to edit almost everything on this wiki. If you decide to make huge-scale changes to existing content, other editors would appreciate a heads-up, but smaller operations are free to be carried out at will. These include things like...

  • Supplementing missing information in existing articles
  • Expanding on stub articles
  • Correcting typos
  • Creating new articles where something is missing entirely
  • Updating outdated information as new versions of the game are released.

Every correction, big or small, is a step towards a better wiki, and greatly appreciated!

As you edit the wiki, please be extra careful with a few things in particular:

  • Reliability. Is the information you’re adding correct and objective? We’ll list our preferred sources further down.
  • Language and style. Is the information you’re adding presented in a way that another Barotrauma player can be expected to understand it without trouble? Are you writing good, neat English? It’s not an academic writing contest, but please write with care.
  • Please remember to be kind and respectful. Most of the content here is provided by players – volunteers like you. If you disagree with something, please be kind in pointing it out. If you wish to change something someone else has done, please do so while respecting the work the other person has put in. Please do not war or deliberately hurt this wiki, the old wiki, or your fellow editors.

Editing and Creating Content

Page structure

Wikitext may look daunting at first, so here are a few of the most common things you should recognize and use to make our wiki pages nice to read.

Headers

== Headers == are used to organize a page visually and generate the table of contents at the top of the page. 1 to 5 equal signs "=" can be used to create different headers:

=Very Big Header=
==Big Header==
===medium header===
====small header====
=====very small header=====

To make your header a proper header, it must be the only thing on that line, as in the examples above.

Table of contents

The size of the headers is used to determine subsections in the table of contents, __TOC__. For example, if you had the following headings:

=Section=
==Subsection==
===Subsection 2===
==Subsection 3==

Then the table of contents would be as follows:

1 Section
    1.1 Subsection
        1.1.1 Subsection 2
    1.2 Subsection 3

To place the table of contents in the page, simply write __TOC__ under the summary at the top of the page.

Hyperlinks

[[Hyperlinks]] are used to link to another page on this wiki. Simply make sure said page exists and type its name carefully to link to it:

[[Crawler]]
[[Any Page Name Case Sensitive]]
[[pagename|alternative text]] 

Please use hyperlinks generously (but not excessively – first mention is usually enough. Common sense!) to help readers make full use of the wiki.

Lists

Bulleted lists

*Starting several successive lines with an asterisk will turn them into bullet points.
**Additional asterisks will make for "sub bullet points" with indentation.

Numbered lists

#Replacing the asterisks with hashtags will produce numbered lists.

More details here.

Galleries

Many articles have a gallery section, usually at the bottom of the page, to gather relevant screenshots or gifs. They are presented as follows:

<gallery heights="450px" widths="900px">
File:Imagename.png|Description shown under the image
File:Imagename2.png|Description shown under the image
</gallery>

Note that gifs won't play unless the gallery's height and width exactly fits the gifs'. In other words, gifs won't play if they are resized.

Adding media

Besides text, a wiki needs images and sometimes also audio.

If you’re about to upload a new file, please start by making sure that file doesn't already exist – if you spotted a red link that is supposed to be an icon, for example, it’s possible that the link to that icon has been incorrectly typed or that its name was inadvertently changed during the wiki migration. So, before uploading a new file, please search this list of files.

If the file does exist: Please fix any red links by simply editing them to point to the proper file's name.

If the file doesn’t exist: Please upload a new image or audio file! Click on "Upload File" to the bottom of the left panel and follow the instructions, or use the batch uploader, also found in the editor window itself, to upload files in bulk.

There are a few rules about files and how to name them. Please follow these:

  • Prefer .png files for images.
  • When possible, source sprites from game files, not screenshots.
  • When a new submarine or creature is being added to the wiki, consider using the `wikiimage_sub` and `wikiimage_character` commands respectively; this should generate an image that is suitable for illustrating the new addition.
  • Always name audio files exactly as they are named in the game files.
  • Affliction icons are named "Affliction_[affliction_name].png"
  • Items that have both an in-game sprite and an inventory icon: in-game sprites are named "[item_name]_sprite.png" and inventory icons are named "[item_name].png".

Note that any regular space will be automatically replaced by an underscore "_", so both can be used in all cases for the same purpose and effect, whether it is when uploading or when linking to a file or page.

Once your file is uploaded, simply link to it where needed.