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.

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

The Basics

Below are some subjects 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 other's opinions. 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, 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 capitalised. For example: "John Smith" is correct. "New york" is not correct.

Please use proper nouns 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,). Again there are exceptions and will be stated where relevent. 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)

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 an internal page that does not use those words in the Title. The pipes should direct to the plural of items and subjects, unless there is a proper noun. See below for examples. The format is as follows Words that are diplayed

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

Categories

Every page should have an appropriate category. See the specific subject for more information.

Ship Pages

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.

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 filled as much at 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. One 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 2nd 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 associated with 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]]

To Add to this guide

• Please refarin from editing this Guide

• Clear examples of wiki page name convention

• Example pages to 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.