Actions

Manual of Style

From Outscape Wiki

Welcome to the Manual of Style for the Outscape Wiki. This page is intended to give an overview of using the MediaWiki editor to format text and pages, as well as pointers on putting together some specific types of pages frequently used by this wiki. New editors should make sure to read the overview page on contributing to the wiki first.

Using the editor

This wiki uses MediaWiki - the same open source software as Wikipedia - so editing this wiki works in the same way. Anything related to editing a page not covered here, should be covered on the MediaWiki Help pages.

To open the editor on a page, click Actions in the top-right of the screen and select Edit from the drop-down menu that appears. The page's Discussion page and Edit History can also be accessed through this panel. Individual sections of a page may also be edited by clicking the "edit" prompt next to the section title.

Formatting text

To achieve anything other than plain text, special formatting must be used. Typically, this will be limited to headers, lists, links, and some basic font styling e.g. italic or bold. Some basic formatting options are:

''Italic text''
'''Bold text'''
* Bullet points
# Numbered list items

For further information:

  • Visit the MediaWiki page on formatting for a comprehensive list of text formatting options.
  • Click the "Edit" tab on other pages, to see how previous editors have used formatting.

Headers

Headers are used to organise a page and provide structure. The wiki also uses them to automatically generate the page contents shown at the top of pages, if the table of contents has been enabled.

Headers should be placed on their own line, and can be used between Levels 2 and 6. Level 1 should never be used - this is reserved for the page title. They use the following notation:

== Level 2 ==

=== Level 3 ===

==== Level 4 ====

===== Level 5 =====

====== Level 6 ======

Links and Redirects

Links can be used to link to both pages and categories. The text that the reader clicks on to follow the link is called the anchor text, and can be generated automatically or overridden. In addition to the below examples, you can find out more about link formatting here.

[[Mankind]] (link to the Mankind page)
[[Mankind#Emergence]] (anchor link to the Emergence section of the Mankind page)
[[#Emergence]] (while already on the Mankind page, link to the Emergence section]]
[[Mankind|View the Mankind page]] (link to the Mankind page with custom anchor text)
[[:Category:Mankind]] (link to the Mankind category)
[[:Category:Mankind|View all Mankind related content]] (link to the Mankind category with custom anchor text)
[https://mediawiki.org MediaWiki] (link to an external website with custom anchor text)

Note that adding external links is CAPTCHA-protected, as an anti-spam measure.

It is also possible to set up a link as a redirect, using the same formatting given above to automatically redirect a user to a different desired page. For example, the link for Beron redirects automatically to the appropriate section of the Natural Resources page, rather than a page called Beron. They are useful both as navigational aids and for cleaning up the syntax of pages for the benefit of editors.

Templates

Templates are called using {{Template Name}}, to bring in (or transclude) code from other pages. This is useful for complex features with pre-defined structures, such as Infoboxes.

{{TechInfoboxInfrastructure}} (call the Infrastructure Technology Infobox)

Images

To use an image on the page, it must be uploaded to the wiki if it hasn't already been. Once uploaded, it can be embedded to a page using the following syntax, with a size specified in pixels:

[[File:My_Image.jpg|400px]]

When displaying two un-captioned landscape images side-by-side, the optimal image widths are 620px. This ensures a good size on PC while also scaling appropriately for mobile/tablet devices.

See this page for more info on using images. If another page displays content in a way that you would like to copy, you can always click the "Edit" button to take a look at the code to see how it was done.

Galleries

For displaying multiple images together with captions, a gallery may be created:

<gallery>
File:My_First_Image.jpg|Caption 1
File:My_Second_Image.jpg|Caption 2
</gallery>

The default size of gallery images is 120px.

Data tables

As a rule of thumb, the use of tables should be avoided where possible, unless a significant quantity of data needs to be displayed. The reasons for this are that their syntax is generally clunky if built in-house, disrupting the flow of code that makes up the article, and they also have display issues on mobile devices (in-house Wikitables cannot be sorted at all when viewed on mobile).

Nonetheless, tables are still useful for displaying tabulated data. Interested editors should see the Help page for Tables. Tables may be written in MediaWiki syntax or in HTML, although the former is preferred due to its denser layout.

Imported Google Sheets

Some pages contain data tables which automatically render data that IDA have exported to a CSV file. This data should be updated automatically as the game config is adjusted, but cannot be changed by editors. Pages where these data table tags can be found are fine to edit, but the data table code itself should remain untouched to avoid disabling the table.

This example is taken from the Banshee page, generating a hull Infobox:

<datatable type="hull">https://spreadsheets.google.com/tq?tqx=out:csv&tq=SELECT%20A%2CB%2CC%2CD%2CE%2CF%2CG%2CH%2CI%2CJ%2CK%2CL%2CM%2CN%2CO%2CP%2CQ%2CR%2CS%2CT%2CU%2CV%2CAB%2CAC%20WHERE%20AC%20%3D%20%27Banshee%27&key=1GH0-ndSbVI2gAbzNrOjJxtyNwkOqoqyhwv9LTsFWWDM&gid=1386123040</datatable>

This example is from the Mankind Hulls page:

<datatable>https://spreadsheets.google.com/tq?tqx=out:csv&tq=SELECT%20B%2CC%2CD%2CE%2CF%2CG%2CH%2CI%2CJ%2CK%2CL%2CM%2CN%2CO%2CP%2CQ%2CR%2CS%2CT%2CU%2CV%20WHERE%20AA%20%3D%201%20ORDER%20BY%20X%20ASC&key=1GH0-ndSbVI2gAbzNrOjJxtyNwkOqoqyhwv9LTsFWWDM&gid=1386123040</datatable>

Please let us know if there is a particular data table you would like, or have a suggestion concerning any of the existing tables. Categories exist for pages which use these tables, or which have tables with out-of-date or missing info on them.

Videos

Videos hosted on YouTube may be embedded in pages using the following syntax:

{{#ev:youtube|Link|Size||||rel=0&showinfo=0}}

Please note that wiki articles should not be used to host general gameplay. Editors are advised to contact an admin first with any suggested video content.

Using categories

Categories are used to organize pages:

  • All pages should belong to at least one category.
  • All categories should belong to at least one other category, except for the top-most Wiki category.

Pages and subcategories can be added to a category by adding the following syntax to their content:

[[Category:Mankind Hulls]]

Such tags should always be at the very end of a page. To add content to multiple categories, simply use additional tags:

[[Category:Mankind Hulls]]
[[Category:Mankind]]

See the links section above to find out how to link to a category.

General Page Style Pointers

Infoboxes, Hatnotes and Contents Tables

If the page uses an infobox, this should always be at the very top of a page. Infoboxes are a convenient way to summarise key information about an article, and are used by Ship Hull and Technology pages. They are called either as pre-built tables or in-house templates, using the methods already described, and appear as a box on the right-hand side of a page.

If needed, a hatnote should be the second thing to include before the intro text, but after an infobox. Hatnotes are brief notes that appear at the top of an article as a navigational aid. They generally take the form, "This page describes X; for information on Y, see Z." Hatnotes should not have bullet points – if there are many possible alternative destinations, a disambiguation page should be considered. The Assault Troop Carriers article has a good example of a hatnote. Hatnotes can be easily created by calling the {{Hatnote}} template.

Page title names should be '''bolded''' in the intro text of all articles.

If the page has four or more section headings, a Table of Contents will be automatically generated. This can be forced for smaller pages using the __TOC__ command. If a table of contents is not desired on a page, it can be suppressed with the __NOTOC__ command.

Linking

In general, linking to another page should be done once per article. Exceptions are when each section is self contained, such as in the New Player Guide, or for infobox links, where links already in the infobox are repeated once in the main write up. The main idea is to provide accessible links without overdoing it.

Internal links have a couple of useful character recognition abilities:

  • The first character of a link is not case-sensitive, e.g. both [[Destroyer]] and [[destroyer]] will be recognised as links to the Destroyer page. However, all subsequent characters are case-sensitive and must be spelled correctly.
  • Spaces in titles, such as for Natural Resources, may be represented with underscore (_) characters.

When linking to a page, it is acceptable to use either the short or long name depending on your needs. For example, you can link to either [[Population]] or [[Populations]], since Population is a redirect to Populations. There is no need to use [[Populations|Population]], which adds unnecessary bulk to the page. However, be cautious when using ambiguous links like [[Battles]] which may not link to the intended page. Disambiguation pages which offer a variety of destinations are the best way to handle such cases.

Some particularly handy short links and redirects are:

  • The natural resources [[Beron]], [[Farsu]], [[Limbalt]], [[Ziryl]] and [[Olzine]], along with [[Credits]].
  • Singular versions of all structures, such as [[Farm]] and [[Military Base]].
  • Plural versions of all hull classes, such as [[Scouts]] and [[Cruisers]].
  • Links to the Major and Minor Factions categories at [[Major Factions]] and [[Minor Factions]].

Lists

In general, when using lists of items in a table or sub-category, the list should be alphabetized from A to Z. If the list entries are mixed format with numbers, the numbered entries should come first.

Numbers

Numbers between zero and nine should always be written as text within the body of an article, e.g. the Nuisance has five Weapon hard points. Infoboxes should always use numbers, regardless of their size.

Large numbers should always have a comma ',' at the thousands and millions mark and so on, for example:

  • 250
  • 3,750
  • 11,250
  • 101,250

Units of Measurement

  • Power for structures and ships is always measured in MWt (megawatt thermal).
  • Ship hull length is measured in m (metres).
  • Distance between star systems is measured in LY (light years).

Major Faction Pages

Pages describing (playable) Major Factions should be laid out as shown below. The first thing added to any faction page should be the CivInfobox, called as a template and with all fields filled out appropriately. Some fields will autocomplete if not specified in the syntax of the tech page, reducing the workload on the editor. For further details, see the Documentation pages for each infobox.

Any appropriate redirects to this page should also be set up, e.g. People's Realm.

Manual of Style
[[File:{{{image}}}|270px]]
Civilization Stats
Physical Strength: x1
Optimal Temp.: {{{optimal_temp}}}
Growth Range: {{{temp_tolerance}}}
Growth Multiplier: x1
Max. Pop. Multiplier: x1
Land/Water Affinity: Land
Optimal Water Balance: {{{optimal_water}}}
Max. Home Guard: 5%
Max. Unemployment: 25%
Max. Labor Shortage: 30%
Happiness Bonus: 30%
Penalty for Unhappiness: 50%
Tax Sensitivity: x0.45

The top of the page should also include the in-game description of that Faction as a quote, using the Quote template. This should come immediately after the Infobox. In-Game Description


Emergence

This section describes the faction's backstory. At present, this text is not found in the game anywhere, and has been supplied by IDA. Ordinary editors should not add to or otherwise edit it.

Civilization Features

This section includes two columns with brief descriptions of that faction's strengths and weaknesses. Some of these are detailed when selecting a Faction to enter a galaxy for the first time, but more can be added if appropriate.

  • + Strength
  • - Weakness

Finally, the page should be added to the Major Factions category, as well as the appropriate Faction category.

[[Category:Major_Factions]] [[Category:Mankind]]

Minor Faction Pages

Pages describing (non-playable) Minor Factions should be laid out as shown below. The first thing added to any faction page should be the CivInfobox, called as a template and with all fields filled out appropriately. Some fields will autocomplete if not specified in the syntax of the tech page, reducing the workload on the editor. For further details, see the Documentation pages for each infobox.

Manual of Style
[[File:{{{image}}}|270px]]
Civilization Stats
Physical Strength: x1
Optimal Temp.: {{{optimal_temp}}}
Growth Range: {{{temp_tolerance}}}
Growth Multiplier: x1
Max. Pop. Multiplier: x1
Land/Water Affinity: Land
Optimal Water Balance: {{{optimal_water}}}
Max. Home Guard: 5%
Max. Unemployment: 25%
Max. Labor Shortage: 30%
Happiness Bonus: 30%
Penalty for Unhappiness: 50%
Tax Sensitivity: x0.45

The top of the page should also include the in-game description of that Faction as a quote, using the Quote template. This should come immediately after the Infobox. In-Game Description


Description

Give the name of the faction, bolded appropriately to start off the article. A brief overview of where this faction can be found (which galaxies/planet types) should be included in this section.

Benefits to a Colony

Each Minor Faction confers some unique benefit to the controlling player, which should be described in this section. Any drawbacks or weaknesses of the faction should also be detailed here.

Trivia

Any information from previous builds or that is likely to become obsolete should be moved to this section.

Finally, the page should be added to the Minor Factions category.

[[Category:Minor_Factions]]

Structure Pages

Pages describing Structures should open with a brief description of their function.

  • More info on their functionality can be included in bullet points, to give a quick overview.
  • One-sentence descriptions of unlocking and upgrading the structure should also be provided here.

The table of contents will appear at this point.


Structures

An overview table should be used in this section to showcase the different structure versions, and the technologies needed to unlock them. For structures which have three possible Tiers, the StructureTable template can be called and used, the empty version of which is below.

For other structures, the table will have to be built manually. All structure images should be set at 250px, while hexagonal Tech images should be set at 70px. Both MediaWiki and HTML notation may be used to build these tables.


[[File:{{{Lvl_1_Image}}}|250px]] [[File:{{{Lvl_2_Image}}}|250px]] [[File:{{{Lvl_3_Image}}}|250px]]
Level 1 2 3
Upgradable? Yes Yes No
Research to unlock None [[File:{{{TechImage_2}}}|left|70px|link={{{ImageLink_2}}}]] {{{Research_2}}} [[File:{{{TechImage_3}}}|left|70px|link={{{ImageLink_3}}}]] {{{Research_3}}}
Civilization-specific Names
Mankind {{{MankindName_1}}} {{{MankindName_2}}} {{{MankindName_3}}}
The People's Realm {{{PRName_1}}} {{{PRName_2}}} {{{PRName_3}}}
Ripchee {{{RipcheeName_1}}} {{{RipcheeName_2}}} {{{RipcheeName_3}}}
Snithereal {{{SnakeName_1}}} {{{SnakeName_2}}} {{{SnakeName_3}}}
Syntis {{{SyntisName_1}}} {{{SyntisName_2}}} {{{SyntisName_3}}}

Research

  • Is the structure available immediately, or does it need to be unlocked through research (referring to the table above)?

Constructing and upgrading

  • Level 1 structures can be constructed directly.
  • Level 2 structures can be built only by upgrading a level 1 structure.
  • Level 3 structures can be built only by upgrading a level 2 structure.
  • Structures do not function while upgrading.

Stats & Upgrade Costs

Include the relevant external datatable here. The Stats header, like other previous headers, should be at Level 2.

Definitions

All column headers should be explained in this section. This header is smaller, at Level 3.

  • Column: the value/parameter denoted by the column.

Finally, the structure should be added to both the Structures category and the appropriate sub-category, depending on its classification in the Infrastructure tab. If the Structure is protected from orbital bombing, it should be added to this category as well.

[[Category:Structures]] [[Category:Structures - General]] [[Category:Protected Structures]] [[Category:Pages with Google Sheets]]

Hull Pages

Every hull in Outscape has its own page describing it and holding relevant data. The first thing to include on such pages is always the Hull Infobox, containing all key data for the hull. Infoboxes for individual Hulls are currently handled by an imported datatable, and cannot be constructed or edited by standard editors. The example below uses the Infobox for the October frigate.

October
Civilization People's Realm
Class Frigate
Flagship level 7
Tech level 1
Armour 770
Length 380 m
Engines 4 x L
Slots
General (S) 4
General (M) 2
Weapon (S) 4
Weapon (M) 2
Cost
Farsu 7,700
Credits 5,850
Build time (secs) 27,360

The hull's description from the Ship Designer should be included next, using the Quote template. Adapted from In-Game Description

The hull now needs a one-sentence introduction, e.g. The <Hull Name> is the Tier X [[Hull Type]] hull of [[Faction]].

For these pages, the table of contents must be explicitly called using the __TOC__ command.

Overview & Strategy

Give a general overview of the hull - with the slots that it has, what roles can it potentially perform? What weapons and/or equipment are worth fitting? What other ships does it work well with? Depending on its class, what kind of players will be able to unlock and use it? If the hull has specific weaknesses or limitations, what are they? Which other hulls could compensate for these, or replace it at a later stage in the game?

It may also be useful to compare the hull to its equivalent(s) from other Factions, e.g. what warships will this hull typically be up against? Which would win in a straight fight?

Trivia

Any information from previous builds or that is likely to become obsolete should be moved to this section.

Gallery

To illustrate the hull properly, a gallery should be created using the <gallery> tags and populated with suitable images. For these images, the default image size of 120px should be used. Each image should have a brief caption describing the image. These captions may also contain links, if appropriate.

Finally, at least five categories need adding - <Faction Hulls>, <Faction>, <Tier X Hulls>, and <Class>, along with the category of pages which use datatables imported from IDA. If the hull has Weapon slots, it should be added to the Hulls with Small, Medium or Large Weapons categories as appropriate.

[[Category:People's Realm Hulls]] [[Category:The People's Realm]] [[Category:Tier 1 Hulls]] [[Category:Frigates]] [[Category:Pages with Google Sheets]]

Module Pages

Module pages are intended to provide a brief overview and relevant stats for ship weapons and components. Depending on the individual module, this can be done as a bulleted list, or as full text in an Overview section. Some key points to cover are:

  • What does the module do?
  • When/how is the module unlocked?
  • Which hulls can use the module? (Some hulls, notably Corvettes, have exclusive access to specialist equipment.)
  • Does the module have any special requirements/activation costs?

Stats

Include the relevant external datatable here. The Stats header, like other previous headers, should be at Level 2.

Definitions

All column headers should be explained in this section. This header is smaller, at Level 3.

  • Column: the value/parameter denoted by the column.

Finally, any appropriate categories should be added. Ship Weapons should be members of both the Ship Weapons and Ship Parts categories. The Google Sheets category is always required for Module pages.

Technology Pages

Each Technology needs its own page describing it. A variety of Infoboxes are available for covering each section of the tech tree. This example uses TechInfoboxWeapon, for technologies in the Weapons and Warfare Equipment section of the tree. Some fields will autocomplete if not specified in the syntax of the tech page, reducing the workload on the editor. For further details, see the Documentation pages for each infobox.

Manual of Style
[[File:{{{Image}}}|225px]]
Weapons & Warfare Equipment Technology
Available To: All Major Factions
Prerequisite: None
Difficulty: {{{Difficulty}}}
Unlocks: {{{Unlocks}}}
Required By: None

Overview

Each Technology needs a brief overview - when will players unlock the ability to research it? Should they research it, and if so, when is the best time to do this? Is the Technology a crucial prerequisite for other techs further up the tree?

It is also worth giving a summary of what the tech itself unlocks, e.g. a structure or weapon, to help players make informed decisions about research.

Gallery

Each technology should also have a small gallery using the <gallery> tags, containing completed tech card(s) for the technology and a picture of what is unlocked, if appropriate.

Each tech page should be a member of the master Technologies category, as well as the appropriate sub-category for each section of the tech tree.

[[Category:Technologies]] [[Category:Technologies - Weapons & Warfare Equipment]]