Deep Rock Galactic Wiki:Style guide

This is a guide to editing the Deep Rock Galactic Wiki in accordance with the established style. It describes accepted and established practices at the Deep Rock Galactic Wiki, which are governed by precedent. Editors are advised to follow these guidelines closely in order to prevent their edits from being reverted.

The style guide exists to ensure cross-page consistency, a very important attribute of a wiki. Modifications may be suggested, but bear in mind that the style guide merely lists practices that are widely in use. It is not a means to impose extensive policies or even personal preferences.

Regardless, not all pages may follow the style guide entirely. While that may be due to good reason (which should then, in non-obvious cases, be marked, e.g. with a comment), it is often caused by the sheer number of pages, some of which have not been touched in a long time. All editors are encouraged to rectify such deviations.

Language

• Use American English, as this is the official language used in-game.

• Use Present Simple when describing the gameplay process or game mechanics:

✓ Correct: Each player receives a reward based off of the first person who opens the pack; however, if the next player to claim already owns it, they are rewarded with a different one.

✗ Incorrect: Each player will receive a reward based off of the first person who opens the pack; however, if the next player to claim already owns it, they will be rewarded with a different one.

• Refer to the reader as "the player(s)" or "the team" in 3rd person when describing the gameplay process or game mechanics:

✓ Correct: After the M.U.L.E. units have been recalled to the Drop Pod, the team must then repair an Orbital Relay Uplink to proceed. Players who are downed within the triangulation zone do not advance the progress bar.

✗ Incorrect: After the M.U.L.E. units have been recalled to the Drop Pod, you must then repair an Orbital Relay Uplink to proceed. If you are downed within the triangulation zone, you do not advance the progress bar.

✗ Incorrect: After the M.U.L.E. units have been recalled to the Drop Pod, the dwarves must then repair an Orbital Relay Uplink to proceed. Dwarves who are downed within the triangulation zone do not advance the progress bar.

Numbers

• In numbers with at least 4 digits before the decimal point, separate thousands with non-breaking spaces. Do not use regular spaces or other characters.

✓ Correct: 1 260 400

✗ Incorrect: 1 260 400 1,260,400 1'260'400 1260400

• Use period as a decimal point: 6.25

• If ratios are displayed as a percentage, round to two decimal places: 33.33%

• If a number displays time or distance, shorten the metric to the first letter. Do not put spaces between the number and the letter.

✓ Correct: 6.25s 1m35s

✗ Incorrect: 6.25 s 6.25sec 1 m 35 s

• Whenever it's unclear from context whether "m" means minutes or meters, shorten minutes to "m" and use the full word for meters.

• In ranges of values, use a single hyphen - with spaces both before and after it. The metric is put once after the second number.

✓ Correct: 0.5 - 0.6km

✗ Incorrect: 0.5-0.6km 0.5km - 0.6km

Operators

For addition, subtraction and multiplication, use the signs plus +, hyphen - and the letter x. For editing convenience, the multiply sign × is not used.

Do not put a space after any of theses signs, no matter if what follows is a number or a word.

When showing a stat change (e.g. from a weapon upgrade), put the operator in front of the number.

✓ Correct: x1.69 player health

✗ Incorrect: 1.69x player health

Images

Screenshots

For NVIDIA Control Pannel:

• Completly disable Anti-Aliasing for DRG
• In-game graphics options: set Resolution Scale and Image Sharpening to 100%
• Use photo mode (default Alt + F2). The Green Screen filter option allows to hide the background. You can also change its color.

Page Structure

Page Titles

• The first letter of each word should be uppercase, with the exception of words such as "and" or "of". Pages in the "Deep Rock Galactic Wiki:"-namespace (such as the Admin noticeboard) are an exception to this.

• When the title of the page occurs in the body of the article for the first time, mark it with bold text. The first occurence will usually happen within the first couple of sentences. Do not use bold text for the subsequent occurrences.

✓ Correct:

Core Stones are a bonus item introduced with the Season 05: Drilling Deeper update. Every Core Stone collected gives 1 scrip (up to a maximum of 15 scrip, claimed at the Season Terminal on the Space Rig) if collected while Season 5 is active.

<...>

If a mission is failed, as long as the Core Stone was deposited, players can still claim their Scrip from the Season Terminal, as well as gain some of the experience and credits they grant.

Sections

• The top-level sections used on a page should be == Section ==, followed by === Subsection ===, ==== Subsubsection ====, and finally ===== Subsubsubsection =====
• Notably, = Header = should not be used.
• Do not use the <big> tag to create "upperacase" letters in headers.
• Sections should follow the same naming conventions as page titles.

Page Contents

All content needs to be factual / non-opinative. Don't use guessing for numbers / facts without a base for it.

Tips

All tips and recommendations should go on Tips, tricks and strategies.

Trivia

All trivia should be about game's history or references, not about bugs, and neither about how the game works internally.

References

References are usually small, numbered footnotes like this.^[1]
They should be either directly following the fact that they support, before any punctuation, or at the end of the sentence they support following all punctuation.

Case usage in templates

Template name follows the same rule than the page title (i.e. Title Case).
Cargo Table Name are an exception, they will use PascalCase.
Variable should use camelCase.

Experimental

Content that is part of a future update (not part of Live version yet) should only be worked using the WIP sub-pages

Massive Editing

Use the "Preview page" feature to see potential changes and commit them all in one go. Do not spam-post edits (constantly updating a page and hitting the "save" button).

Translations

To translate a page, use the proper localized section, NOT the main wiki. This section can be accessed with a two-letter code directly following the top-level web domain. For example:

Main wiki front page	https://deeprockgalactic.wiki.gg/wiki/Deep_Rock_Galactic_Wiki
Russian wiki front page	https://deeprockgalactic.wiki.gg/ru/wiki/Deep_Rock_Galactic_Wiki
Spanish wiki front page	https://deeprockgalactic.wiki.gg/es/wiki/Deep_Rock_Galactic_Wiki

Development Q&A

The guide for adding new entries to the Development Q&A is located on its talk page.