Editing Guidelines

This page is to help potential editors get up to speed on making edits to this wiki. Please make sure to read through the whole page before making or editing a page. Please refer to the To-Do List for new pages that need to be made or if pages need to be edited. Likewise, post in the Discord.

**Please read this article all the way through before making any edits and check back regularly. These guidelines will likely change.**

To-Do: This page is so that editors can work together to create and update pages. One of its functions could serve to show what editor is working on what.

## Typical rules

**DO** check to see if a page exists for the topic you want to make; ask if it's not in existence and you want to make it.

**DO** ask if you need help or are having trouble finding something.

**DO** check the To-Do List for a list of pages that are planned.

**DO** make suggestions.

**DON'T** mess up an existing page. We are working hard to ensure true data is created for others. The world doesn't need more fake data or news.

**DON'T** start drama. Please keep discussions and disagreements civil. The world doesn't need more drama. Take a step away and come back with a clear head.

Right now, all wiki discussion is held on the official Wildmender wiki. There's a dedicated channel for Wiki discussion.

## Formatting and Design

Here is a guideline on the formatting for this wiki. Suggestions are welcome.

### Linking

When making/editing a page, please use

```
[[double brackets]]
```

and simply type the name of the page that you're referring to. If the page doesn't exist, then type it in the source editor.

For example, in the Source Editor:

```
[[The Player]]
```

will appear as The Player. While using the Visual Editor, the double-bracket will prompt a pop-up that will suggest pages. If the page doesn't exist, then it won't accept the page you enter.

Links can also be made to **headings and sub-headings** in a page by adding '#' after the page name and then typing the heading before closing the brackets.

```
[[The Player#Health]]
```

Displayed as: The Player#Health

In most cases, you won't want to see that on a page. It won't flow well with the text. So to have a link show a different name or specific wording (such as "Spirits" instead of "Spirit" or vice versa), you can add a divider line ( "|" or the line above the "\" on the same key).

```
[[The Player#Health|Health]]
```

will be displayed as simply Health.

**DO** Add links Only to the first instance of each topic mentioned in an article.

## Terminology

Try to keep terminology and descriptions consistent across the pages. Use impersonal language. (This means no "You," "we," or others)

Do not use slang terms or colloquialisms.

Try to avoid terms like "probably", "looks like," "clearly," "really," and so on. We want to provide information that's accurate, and these words suggest that the information is an assumption or possibly opinion.

The following are terms that should be consistently worded (more to be added later):
**"The Player"**: When referring to the character that the player controls.

### Enemy Attacks

Use the present tense when describing things happening and use future tense when describing something with specific conditions (caused as consequence of an action or condition.)

### Controls

Use the controls listed in the key-binds.