Mapdev:WikiGuide

Style and format guide for mapdev wiki pages

Technical Pages

the structure of a technical page should be thus:

• title
• short description of the pages content
• pretty Images
• Specification

this means the exact format for text, images, file locations, naming, etc

• (optional)implementation

engine details on how its put into the game if relevant, also if there are multiple ways to use the information, most of the time i expect this section will be removed

• (optional)History

relevant history as to why the feature is how it is, i expect this section to be removed in most cases

• (optional)additional Information

for curiosity's sake if someone has more information on the subject they wish to add, such as with the terrain additional information regarding ROAM algorithms, etc.. i expect this section to be removed in most cases

• (optional)forum discussion

forum links relating to the feature that are useful

Howto's

Should attempt to deal with one thing at a time, and not try to be a "how to make the best map ever" type thing, keep it focused on one thing, keep it neat.

Common Problems

if the description and solution to the problem can be fit into a couple of paragraphs, there is no need to make a new page for it, just chuck it under the heading on the main page.

Page Elements

Infobox

use the infobox template for tips and cautions

eg.

{{Tip|blah blah blah}}

	Tip
	blah blah blah

{{Caution|blah blah blah}}

	Caution
	blah blah blah

FIXME

Wherever there is information missing that needs adding use {{{FIXME}}} tags

{{FIXME}}

Later people can use this page to know what needs work

Example Image

<center>
{| class="wikitable"
|+ Example
| [[File:imagename.jpg]] || [[File:imagename.png]]
|-
! Example Image !! Ingame Result
|}</center>

Example

(link image here with max height 256)	(link image here with max height 256)
Example Image	Ingame Result

Image Spec

{| class="wikitable" width="100%"
! width="15%" | File Location
| file path relative to root of map folder
|-
! File Format
| What file format can be used.
|-
! Colour Depth
| bits per pixel
|-
! Channels
| what colour channels
|-
! Resolution
| Either an exact value, a description or below.
<center>
{| class="wikitable" style="text-align: center;"
!Spring Map Size<sup>*</sup>
!pixels = Spring Map Size * 512
|-
| 2
| 1024
|-
| 4
| 2048
|-
| 6
| 3072
|-
| ...
| ...
|-
| 32
| 16 384
|-
| style="text-align: left;font-style:italic" colspan=2 | * must be multiples of 2
|}</center>
|}

File Location	file path relative to root of map folder
File Format	What file format can be used.
Colour Depth	bits per pixel
Channels	what colour channels
Resolution	Either an exact value, a description or below. Spring Map Size* pixels = Spring Map Size * 512 2 1024 4 2048 6 3072 ... ... 32 16 384 * must be multiples of 2