Help:Contributing

From Remnant 2 Wiki
Jump to navigation Jump to search

Welcome to the (unofficial) Remnant Wiki! Everything that you'll find on this website comes from volunteer effort, built by and for the community. Any effort toward that is appreciated.

Getting started[edit source]

Every minor or major edit on this wiki makes a meaningful difference in spreading accurate information about Remnant 2. We make mistakes and forget things. If there is something clearly incorrect or missing, please do make the edit and don't be afraid of breaking things. Each edit can be previewed, and you can leave any details about your edit in the "Summary" text box. Please keep in mind, edits made without an account will display your IP address. Most pages also have a comments section at the bottom for you to ask questions, post potential corrections or alternative ideas.

For any questions, feel free to join the Discord and ask away! New editors are always welcome.

Creating a page[edit source]

At this point in the wiki's progression, any topic you're looking to cover likely exists somewhere. However, if you have found a grey link (a link leading to a non-existent page), or the wiki lacks coverage of specific content, create a new page. There may also be a scenario where content exists, but its missing a clearly recognizable search term. In this case, we would use a "redirect".

Whatever your goal may be, travel to the desired page name (ex. remnant2.wiki.gg/Combat) and click Create or Create Source in the upper right. Once text is submitted onto the page, it will be automatically created and editable like any other.

In the event of a redirect, submit the text below in the source editor.

#REDIRECT [[pagename]]

Improving a page[edit source]

Most editing effort goes toward gradual improvements of an existing page. There are many improvements that could be made to just about any page, for example:

  • Adding screenshots through the file uploader
  • Writing or rewriting sections to better fill the page's intended purpose
  • Updating values to match the current patch
  • Fixing grammar mistakes

When editing a page, there's an option to either Edit or Edit Source. The standard edit button offers a visual interface to make changes, while the source editor uses wikitext. You may swap between each at any time. If you'd like to get a feel for either one, feel free to mess around on your user page located at remnant2.wiki.gg/wiki/User:Your_Username.

Some pages are specifically marked in need of help or maintenance of some sort. These can be found here.

Formatting[edit source]

Page style[edit source]

Main article: Meta:Style guide

When writing content, there are general guidelines to follow to maintain consistency between pages and to better work with links. The style guide contains detailed information on proper page/section titles, capitalization, and overall order of content. Beginners should not be discouraged by the lengthy details and instead reference the guide as needed.

Common templates[edit source]

Throughout the wiki, you will see templates used all over the place. A description for an item might look like the following:

While carrying an Engineer Heavy Weapon, gain {{v|15%}} Movement Speed and {{v|1}} Stack of {{Bulwark}}.

Resulting in the text: While carrying an Engineer Heavy Weapon, gain 15% Movement Speed and 1 Stack of  BULWARKSpecial effect:  BULWARK

On the Traveler:
Increases damage reduction.
1 Stack: +7% DR
2 Stacks: +13% DR
3 Stacks: +18% DR
4 Stacks: +22% DR
5 Stacks: +25% DR
6 Stacks: +27% DR

On enemies:
+10% Physical Resistance per level
.

This example uses the templates {{value}} and {{Bulwark}} to enhance text, making it both appear more accurate to the in-game text while also providing helpful tooltips. Most in-game keywords have an associated template, though they do not need to be used in common writing. When writing long-form articles such as this one, templates such as {{main}} or {{notice}} may prove more useful.

Media[edit source]

Main article: Meta:Style guide

Files may be uploaded to the website here. Please make sure that any uploaded file has a license and proper crediting, as anything risking copyright issue will be taken down. The vast majority of uploads will be images or audio, as other file types are only permitted in rare circumstances. See the style guide for rules and guidelines.

Images[edit source]

See also: Images

Uploaded images are embedded using the general syntax: [[File:filename.extension|options|caption]]. For more parameters, see the official documentation in the link above.

Video[edit source]

Main article: EmbedVideo

YouTube videos may be embedded on a page with a linked start/end timestamp using the linked extension. Make sure to have adequate permission to post the video, otherwise it may be taken down.

Audio[edit source]

Main article: {{audio}}

Uploaded audio files are embedded using the linked template. These will generally be processed in-game files attributed to Gunfire Games, though exceptions may be made for cool ideas.

Wikitext[edit source]

See also: Wikitext

Section headings[edit source]

Headers can be used with surrounding = equal signs. When nesting headers, smaller headers (more equal signs) should be used. While there are six different size options, we generally start with two and add from there.

  • ==Underlined large heading==
  • ===Nested sub-heading===
  • ======Smallest heading======

Tags/markup[edit source]

HTML tags[edit source]

  • <br> for line breaks
  • <code>text</code> for highlighted snippits of text/code
  • <pre>text</pre> for highlighted blocks of code
  • <blockquote>text</blockquote> for quotes

Wikitext markup[edit source]

  • '''bold text'''
  • ''italicized text''
  • * or # to create bulleted/numbered lists
  • : to indent, which can be used multiple times on the same line
  • ---- or <hr> for a horizontal rule, a line separating paragraphs

Other[edit source]

See also[edit source]