Style Guide

Hello! Welcome to the Discovery Mod Wiki Editing Style Guide.

• Note: Please refrain from editing this Guide. If you have style suggestions please discuss them on the Talk page or on the Discovery Forums

This Guide is intended as a reference for new and veteran wiki editors to acquaint themselves with the styles and formatting in use by the Discovery Mod Wiki. Following the directions and examples in this Guide will help the numerous people working on the Discovery Mod Wiki to maintain a consistent format and style across all of the wiki pages. Please be considerate of your co-editors and readers by attempting to keep consistency as much as possible. Consistency in style and format leads people to being able to find things quicker, to read faster, and to find the required information more efficiently.

If anything doesn't make sense or you don't understand something please give it some tries first and if you really don't get the idea, discuss it in the talk page. We are always aiming to improve this Guide.

To get started click in the contents list on the subject you are interested in.

The Basics

Below are some 'rules' that should be adhered to, for across-the-wiki style and formatting consistency. Information added to the wiki pages should be factual and not biased or subjective to any person's opinion. If you think a ship "sux" keep those comments to yourself. We are looking for information that is useful and true. If that "suxxy ship" turns a full 360 degrees in two hours, then please do write that up.

Spelling

Spelling should be in the American international form. If you are unsure what the American international spelling is for a particular word, just leave the word as written for other editors to correct. Below are some examples of US / UK words.

• Tire / Tyre
• capitalized / capitalised
• color / colour

Proper Nouns

A proper noun is the name that an item, place or person is known or called by. Proper nouns should have their first letter of every word of that noun capitalized. For example: "John Smith" is correct. "New york" is not correct.

Please use all words of a proper noun where required. e.g. James Powell, Ames Research Facility, Cadiz Base. There are exceptions to this rule and the Guide will go into further detail at the relevant places.

Page Titles

Page titles should be in First Letter Capitalized format. This excludes conjunctions (of, and,). To keep track of these conjunction titled pages, please list them here if found or created, stating the page title and type of page.

• Jump_Gate_and_Trade_Lane_Parts (commodity)

Page titles should be expanded. This means, please refrain from making pages titled "BPA", rather, expand the abbreviations so that "BPA" becomes "Bretonia Police Authority". This can be achieved by using piping links, or simply writing out the abbreviations.

In Text Links

In text links can use both lowercase words and uppercase. Use your discretion for which one is appropriate. Usually proper nouns will be first letter of every word capitalized.

Lowercase Links

Passengers are civilians who have money and courage for interstellar travels. As transports are favorite targets for pirate attacks, many passengers find it safer to travel to distant places in freelancing ships. You will find passengers willing to travel on almost all populated planets, price they will pay you generally depends on the length of the route.

Uppercase Links

This lush green world is the home of the Cambridge Research Institute - an institution devoted to pure scientific research. The idyllic green fields also find themselves home to the manor retreats of New London's aristocracy during the warmer months of the year. Bretonia's epidemic food shortages required the planetary regents to place scientists and farmers together to develop more bountiful crops, making Cambridge the primary food supplier for Bretonia. Now many Cambridge scientists sympathise with the Gaian echo-terrorist movement, prompting the formation of political groups such as The Green Front and igniting bitter debates among researchers on topics such as terraforming.

Piping Links

A piped link is when the highlighted words direct you to another discovery wiki page that does not use those words in the Title. The pipes should direct to the plural of items and subjects, unless it is a proper noun. See below for examples. The format is as follows [[Actual Piped Link|Words that are diplayed]].

*[[New York System|New York]]
*[[Bretonia Police Authority|BPA]]
*4 [[Class 4 Guns]]
*1 [[Class 7 Turrets|Class 7 Turret]] ****note the 's' missing when piping from a single weapon.

Results in:

• New York
• BPA
• 4 Class 4 Guns
• 1 Class 7 Turret ****note the 's' missing when piping from a single weapon.

Images

Any pictures that you upload should be well lit and the viewer should able to easily and clearly see what the subject is. Dark pictures with the sun backlighting the ships, although artistic, are unacceptable for this wiki. Please use well lit, isometric viewpoints for ships; well lit, well framed pictures for planets and bases. The pictures and images should be uploaded in the .jpg format and be of minimal filesize. If you don't know how to do this, please ask someone to do it for you, or contact someone who can do it. Blodo and Chovynz are two people who can. Image example Specs:

• Odin (598 × 480 pixel, file size: 32 KB, MIME type: image/jpeg)
• Gas_miner (800 × 600 pixel, file size: 35 KB, MIME type: image/jpeg)
• Planet New London (535 × 528 pixel, file size: 61 KB, MIME type: image/jpeg)

Categories

Every page should have an appropriate category. Every category section should go at the base of the page - the very last thing on the page. See the specific subject for more information.

Ship Pages

RH-GM40 "Odin"
254px
Ship Class	unknown
Built by	Red Hessians
Technical information
Guns/Turrets	6 / 1
Opt. weapon class	8
Max. weapon class	10
Other equipment	None
Hull strength	9,700
Max. shield class	10
Cargo space	65 units
Nanobots/Batteries	62/62/62/62
Max. impulse speed	80 m/s
Max. thrust speed	199 m/s
Max. cruise speed	unknown
Power output	11,400 u
Power recharge	1,160 u/s
Additional information
Ship price	$1,995,000
Package price	$2,128,130

Template

There is a nice looking well working ship Infobox template that is being used. If you find a ship without the template or add a new ship, please format the ship page using the template. Copy and paste below into the top of your Ship page and fill out the fields. The Description of the ship goes directly under this Infobox.Example of complete Ship Page.

{{Ship_Infobox
|name = 
|image = 
|shipclass = 
|shipowner = 
|guns = 
|turrets = 
|hull = 
|cargo = 
|maxregens = 
|optwepclass = 
|maxwepclass = 
|maxshieldclass = 
|maxspeed = 
|maxthrust = ??
|maxpower = 
|recharge = 
|equipment = 
|hullcost = 
|fullcost = 
}}
Description goes here.

Images

Images of ships are to be uploaded in .jpg format. If you don't know how to do this, please ask someone to do it for you, or contact someone who can do it. Blodo and Chovynz are two people who can. Image example specs:

• Odin (598 × 480 pixel, file size: 32 KB, MIME type: image/jpeg)

To use an uploaded image simply copy the name of the uploaded image into the template: |image = imagename.jpg

Price and Ship Costs

There was found to be an awkward discrepancy between certain ship prices. To address this discrepancy we have followed this plan. On the main ship lists is the Hull only price. That is the bare minimum that you can buy a ship for, minus all equipment, shields, weapons, bots and bats. On the individual pages of the ships, you will see two price fields, one for the Hull only, and one for the complete package. The full price can be found by using Datastorm or going in game and screen-shotting. The Hull price is found in the ini files or on the main ship lists. We suggest you just copy and paste from the main list. Please make sure both fields are completed wherever possible.

Headings

Most ships do not need many headings. Here are some suggested ones.

• Weapon Hardpoints Used to describe in detail what type guns, turrets or weapons the ship has and how many.
• Handling is used to describe the maneuverability and way the ship moves through space. See Odin for a good informative handling example.
• Availability is used to show where the ship is sold.
• Media is used for any further pictures or other media of the ships, that are different to the ones in the Infobox. Odin currently has 3 pictures associated with it. First is the thumbnail - what you see when you first come to the Odin page. The thumbnail is generated automatically by Wiki when you upload an image. The second picture is the medium scale image that has been uploaded to the Discovery Mod Wiki. The third is a PNG that has transparency. This image is not stored on the wiki in any way and is stored at an image hosting site - like Imageshack or Photobucket.

==Weapon Hardpoints==
* 1 [[Class 5 Turrets|Class 5 Turret]]
* 2 [[Class 9 Guns]]
* 4 [[Class 3 Guns]]

==Handling==
The Odin is thoroughly classified as a relatively large, although agile VHF. It's armour rating isn't 
especially high, and neither is it's power storage. When properly handled however...

==Availability==
* [[Freeport 9]], [[Omicron Theta]]
* [[Planet Manhattan]], [[New York System]], [[Liberty]]

== Media == ********Usage is [Link Name]
[http://img225.imageshack.us/img225/186/odineg0.png Ship render]

Categories

Every ship should have a Category assigned to it. At the very minimum these two below should be included in the Categories. Civilian line of ships will have the Civilian Category included; Outcasts ships will have the Outcasts Category.

[[Category: Discovery content]]
[[Category: Ships]]

Planet Pages

Manhattan
Unknown
Owner
Liberty Police Incorporated
Location
C3, New York System
Technical Data
Gravity	unknown
Docking bays	unknown
Amenities	unknown
Crew	unknown

Planet page titles are to be named Planet Name. There are a number of systems that have the same name as their major planet, so we use "Planet" to distinguish between the system and the planet.

When in text blocks and it is obvious the context is talking about a planet, you may drop the 'Planet'. I.e. "...the corsairs invaded Malta." When it is possible to be confused with the system please use "Planet Name".

Example Planet Page: Planet New London

Template

Please use the relevant information for the template fields

{{Base_Infobox
|name = New London
|image = Newlondon.jpg
|system = [[New London System]]
|sector = D6
|location = [[Bretonia]]
|owner = [[Bretonia Police Authority]]
|type = Terrestrial Planet
}}

Headings

Here are some suggested headings for Planets.

==Additional information==
* '''Diameter:''' 12,753 Km
* '''Mass:''' 5.98 x 10e24 Kg
* '''Terrain:''' Terrestrial
* '''Temperature:''' -46°C to 43°C
* '''Escape Velocity:''' 11.27 Km/sec 

==Imports==
*[[Oxygen]]
*[[Passengers]]

==Exports==
*[[Boron]]
*[[Consumer Goods]]
*[[Counterfeit Software]]
*[[Food Rations]]
*[[H-Fuel]]

== Ships for sale ==
*[[CSV]] - $186,670
*[[Startracker]] - $35,020
*[[Patriot]] - $21,900

Categories

Categories should always be added. At the very minimum have these two. Please place these at the base of the Planet page.

[[Category: Planets]]
[[Category: Bases]]

To Add to this guide

• Please refrain from editing this Guide

• Clear examples of wiki page name convention

• Example pages of at least

 * faction
 * system
 * base
 * commodity
 * ships (I think they are in best shape now)
 * misc page (if we have a template for it)

• Use categories

• and over all simple quide lines like do we write wiki link names in text with caps.