Styling Guide

This page is a general style guide for editors and contributors of this wiki. All editors are expected to agree and follow this guide when editing in order to ensure content consistency and quality all across the Antiyoy Wiki. None of the pages are protected so everyone can edit. **As long as you edit in good faith, you can't do anything wrong.**

## Writing

* **Write in English to your best extend.** Grammar can be corrected later by others and should not be a barrier to entry. Try to use simple wording as you write. Feel free to correct spelling and grammar mistakes.
* **Try to be as impersonal as possible.** Remember you are giving out information, not your own point of view. Refrain from writing biased walls of text about your experience with something on the page, do that in blogs or in the comment section at the bottom of the page instead.
* **Humor in the content section is discouraged.** Avoid being funny or witty as you write, people are here for pieces of information, not for a laugh.
* **Avoid adding unconfirmed or uncertain information.** If you are not sure that the information is correct, please write in the comments.

## Page formatting

Every page should have at least one or two sentences at the top, which sum up the whole page and at least one picture under that. If a page has an established format, please follow it.

## Uppercase and lowercase words

Every unit, building and tree should be written with a starting uppercase letter followed by lowercase letters. Hex names should be written with lowercase letter, unless they are at the start of a sentence or a page title. Here's the whole list:

* units:
	+ Peasant
	+ Spearman
	+ Baron
	+ Knight

* buildings:
	+ Castle
	+ Farm
	+ Tower
	+ Strong tower

* hexes:
	+ captured hex
	+ neutral hex
	+ water hex

* trees:
	+ palm tree
	+ pine tree

* menu options:
	+ Skirmish
	+ Editor
	+ User levels
	+ Campaign
	+ Load game
	+ Resume
	+ Restart
	+ Save game
	+ Main menu

* others:
	+ gravestone
	+ Province
	+ Coin
	+ blitzkrieg
	+ trench warfare
	+ tower(s) (when referring to Tower and/or Strong tower)
	+ Fog of war
	+ Coin balance (top left when a Province is selected)
	+ Coin income (top middle when a Province is selected)

## Uploading images

Feel free to upload as many images as you want. Try to upload high quality images if possible.

Uploading images: "Explore" > "Images" > "ADD NEW IMAGE" (top right corner). Then drag and drop the desired file and press "Upload file".

## Term usage

Use **"capture"** (instead of "claim or "destroy") when referring to capturing units, buildings, hexes or trees.

Use **"create"** when referring to creating units or buildings.

Use **"spawn"** when referring to trees or gravestones being spawned.

## Using Source Mode

Source mode is generally preferred over Visual mode when editing. Editors can switch to Source mode by switching between "Visual" and "Source" tabs on the top right of the Editor Window.

Source mode enables the use of features such as templates, commenting, easier formatting and most importantly, the browser's spell check.

You can always use the **Preview** button on the bottom middle of the Editor Window before you **Save**.

Here are some basic tips in using Wiki markup and HTML tags in Source mode:

### Headers

Headers are section titles used throughout any page with more than one attributes.

Headings:

```
== Heading_title ==
```

Subheading:

```
=== Subheading_title ===
```

Smaller headers can be created by adding more "=" on each side, with a maximum of five.

### Links

**Not** every word that has a page should have a link. Do not link words to the same page name they're on (example: do not link "Spearman" on page "Spearman"), unless you link it to a section. Too much linking hurts user experience so be responsible with linking and think if a word really needs a link.

General linking to sections:

```
[[page_title#page_heading (or page_subheading)|displayed_text]]
```

Linking the word "Strong tower" to page "Tower", heading "Strong tower (Advanced)":

```
[[Tower#Strong tower (Advanced)|Strong tower]]
```

Visual editor: highlight a word then pressing *ctrl + K* or clicking on the "Link" icon and select the appropriate page. Visual editor does not allow linking to subheadings.

Note that (other than the first letter) this feature is case sensitive. If the word "units" has to be used, then typing `[[units]]` will produce units. Note that the link links to the same page but appears without the uppercase "U".

Linking to categories:

```
[[:Category:Hex|displayed_text]]
```

Linking to external sites:

```
[URL displayed_text]</syntaxhighlight>
<pre>[https://github.com/yiotro/Antiyoy Source code]
```

### Bold, italic, underline

Bold text (ctrl + B):

```
'''bold_text'''
```

Italic text (ctrl + I):

```
''italic_text''
```

Underlined text (ctrl + U):

```
<u>underlined_text</u>
```

### Commenting

Commenting is creating hidden text that only editors can see in Source mode. This is usually used for embedding instructions when working with layouts, or hiding a large amount of text that is subjected for deletion.

Comment:

```
<!-- comment -->
```

### Bullets

* Bullets can be added by typing `*` in front of a line of text.
	+ Typing `**` will produce a "sub-bullet".
	1. Typing # instead of \* numbers the list.

### Line Break

Typing `<br />` will produce a line break
like this.

### Categories

Adding categories to pages:

```
[[Category:Name_of_category]]
```

Categories should be written at the bottom of pages.

## Desktop/Mobile

This wiki is mainly (~75%) viewed by mobile users, therefore it makes sense to optimize it for mobile users. After a major edit was made it is recommended to see how it looks on a mobile device (phone). The main problem are wide tables on mobile i.e. tables with a lot of columns. The problem with wide tables is that images in those tables get shrunk to the smallest width of that column. Therefore it is recommended to reduce the number of columns or to avoid tables in general (at least those with images). The other problem is JavaScript on mobile. Most mobile browsers support JavaScript, but Fandom does not. While features like image maps and other Javascript features are great on desktop it is recommended to add an alternative to those features. Where styling might be an issue for desktop or mobile you can use a trick in Source editor to hide the unwanted parts on desktop or mobile and replacing them with others. Use the following:

```
<div style="display:none"> <!-- For mobile users. -->
//text here will be displayed only to mobile users
</div>
<div class="hidden"> <!-- For desktop users. -->
//text here will be displayed only to desktop users
</div>

```

Questions should be directed at Administrators.

**Commenting on edits is recommended.**

Parts of this page were sourced from the WARFRAME Fandom wiki [1].