Editing Guides/Page Layout Game

= Guide to Easy Editing =
This is a guide to "easy editing" a page for game 'things' like components, bots, buildings. (To see how the game 'things' are categorised, go [[Category Tree|here]])

*[[Cub]] page shows an example layout with the templates used in this guide.

Potential issues and questions to editors:
*Can be up to four separate templates needed depending on the page. Is that ok?
*Templates have to keep all parameters, and kept blank if not used. Confusing?

Key Words to know:
*Header - title (and size) of the paragraph or section <nowiki>  = very big =   ,   == big ==   ,   === medium ===  </nowiki> etc.
*Template - easy way to duplicate things like tables to lots of pages - [[https://www.mediawiki.org/wiki/Help:Templates|help]]
**Parameter - allows the template to produce different contents
*Navbox - the boxes at the bottom of the item page, showing a list of all the other items in it's category
*Infobox - the box at the top right of the item page, showing its picture and other important info
*Category - used to group pages

Please give feedback or ask for help in {{Discord}} #wiki-spoilers.

== Make a Page ==
Type the URL of the page you want to make. Capitalise the first letter of each word e.g. <code>wiki.desyncedgame.com/New Building 3x3 (4L)</code><br>
If a page has been made, feel free to edit it.

== Page Layout ==
Try to keep the layout of the game 'things' the same for each page. Here's a suggestion for item and entity pages:
*Infobox
*Intro
*Description
*Entity Statistics & Sockets and Storage template 
*Recipe & Produced by template
*Tips
*Category template
*Magic words

== Infobox ==
At the top of each page copy the following and add a short description. This will be the box with the image (if there is an image).

If there is no image, upload one with the same name as the page e.g. <code>New Building 3x3 (4L).png</code>
 <nowiki>
{{Infobox
|description = few words to describe page
}}
</nowiki>

== Headers ==
Pages are separated by <nowiki>===== Headers =====</nowiki>. </br>
Add the following headers if you need them:

<nowiki>===== Description =====</nowiki>

<nowiki>===== Tips =====</nowiki>

*Entity Statistics & Sockets and Storage, Recipe & Produced by headers are added automatically if you use the templates below.

== Templates ==
There are three ready to use templates, and one work in progress. Use them if you need them.

*Entity Statistics & Sockets and Storage - are grouped together.
*Component Statistics - needs testing, please provide feedback if you use it.
*Recipe & Produced by - is a group.
*Icon Link if you want a miniature icon with its accompanying url <nowiki>{{IL|Cub}}</nowiki> translates to {{IL|Cub}}
*Category - is needed if you want a navbox E.g.
{{ResourcesNav}}

=== Entity Statistics ===
An entity is something that moves (Bot, Bug) or a building that can equip a component.

If you want to add Entity Statistics & Sockets and Storage, you can do so by copying the following:
*Copy everything and leave unwanted parameters blank.
 <nowiki>
{{Entity_Stats
|health = 
|power = 
|movement-speed = 
|visibility = 
|storage = 
|size = 
|race = 
|entity-type1 = 
|entity-type2 = 
|socket-l = 
|socket-m = 
|socket-s = 
|socket-i = 
}}
</nowiki>
<!-- template is somewhat redundant with the inclusion of stats in Infoboxes
==== Component Statistics ====
Components are items made by materials that fit into sockets on an entity.
*Copy everything and leave unwanted parameters blank.
*'''This template needs testing''' / feedback. If there is a problem please tell us on discord.
 <nowiki>
{{Component_Stats
|health = 
|power = 
|visibility = 
|size = 
|race = 
}}
</nowiki>
-->

==== Recipe/Produced by ====
If you want to add a recipe, you can do so by copying the {{Recipe_Production template below.
*Copy and paste '''after stats'''. Insert names and numbers 
*You must include all the parameters. If there's only 1/2/3 ingredients or production, leave the rest blank. 
 <nowiki>
{{Recipe_Production
|name =
|ingredient1 =
|amount1 =
|ingredient2 = 
|amount2 = 
|ingredient3 = 
|amount3 = 
|ingredient4 = 
|amount4 = 
|produced-by1 =
|time1 =
|produced-by2 = 
|time2 = 
}} 
</nowiki>

==== Category ====
This template will add the Navbox and create a category which is important if you want your page to be added the the navbox automatically (*feature to be added later*).
*Copy and paste this at the '''bottom of the page'''
*If you only want to use one parameter, leave the others blank.
 <nowiki>
{{Category
|race =
|item-type =
|material-type =
|entity-type =
|unit-type =
}}
</nowiki>
The following parameters are used:
*race = Aliens / Bugs / Humans / Robots
*item-type = Components / Resources / Materials / Research / Packages
*material-type = Simple / Advanced / High-tech
*entity-type = Building / Unit
*unit-type = Alien / Bug / Human / Bot / Space

{| class="wikitable"
|+ Examples:
|-
! Page for [[Metal Ore]] !! Page for [[Scout]]
|-
|
 <nowiki>
{{Category
|race =
|item-type = Resources
|material-type =
|entity-type =
|unit-type =
}}
</nowiki>
|
 <nowiki>
{{Category
|race = Robots
|item-type =
|entity-type = Unit
|unit-type = Bot
}}
</nowiki>
|}

== Magic words ==
You can put them anywhere in the page on their own line. Putting them at the bottom keeps them out of the way.

Please let us know about other useful ones on the {{Discord}}.

<nowiki>__NOTOC__</nowiki>
*A table of contents is Added to pages with four or more headers, use NOTOC with two underscores either side to disable the TOC.
<nowiki>__NOEDITSECTION__</nowiki>
*Use this to disable the edit icon next to all the headers. Recommended to add when you finish making the page.

== Examples ==
Please look at pages' edit code to see some examples
While the site is getting set up, it's a bit of a mess so if you find a page that doesn't look like this guide, ignore it and find another.

[[Cub|A link to the Cub]] with the layout and recipes from this guide.



[[Category:Guides]]
__NOEDITSECTION__