Starsector Wiki:Style guide

Here are examples for various types of documents.

General page stylingWeapon pageShip page

• All article and section titles should use sentence casing (e.g. "A really long title" instead of "A Really Long Title").
  • Sentence casing helps distinguish common nouns from proper nouns--e.g. irradiated worlds (with Irradiated condition) vs. Irradiated worlds (the actual planet type).
  • Capitalization rules for proper nouns (e.g. Salvage Rig, Colony Crises, Persean League) still apply, however.
• Use the singular form rather than the plural form for article title names (e.g. Ship, not "Ships")
  • This makes linking to an article much easier in most cases, like using [[Ship]] instead of [[Ships|Ship]], and more freely allows the use of word-ending links like [[Ship]]s
  • However, if a proper noun is often referred using its plural form, like Credits or Pirates, then it can be fine to leave it as plural.
  • On the other hand, category names should generally be plural (e.g Category:Ships, not Category:Ship).
• Use bolding and italicizing sparingly. Overusing bold or italic letters makes the article more difficult to read and obscures key information.
• If in doubt, refer to Wikipedia's Manual of Style, or just use your best judgement and keep the pages you edit consistent relative to other similar pages.
  • Consistent formatting between pages of similar content will make it easier to mass edit the pages later using wiki bot accounts, if they are ever needed.
• (Please feel free to discuss or make other suggestions on how pages should be styled or formatted, as the Style Guide is still WIP and would really benefit from an overall consensus.)

Only up to date for version 0.97a. It is likely still broadly correct but not verified for the most up to date data yet. Please double check the Version History.

	Description when viewing weapon.
–In-game description

	Description when viewed from Codex.
–Additional Codex description

Overview

The (Weapon name) is a (brief description). (Some brief additional information)

Availability

(Insert where the weapon can be found or encountered, including faction markets, special fleets, etc.)

Notes

(Insert any other useful, factual information about this weapon)

Tips and strategies

The following section contains user-submitted suggestions, these may be inaccurate or outdated.

(Add suggested tips and other suggested uses for this weapon)

Changelog

Patch 0.95.1a: One-line change Patch 0.95a:  Change that has multiple lines Another line Patch 0.9a:  Change that has a subsection: Like so

Only up to date for version 0.97a. It is likely still broadly correct but not verified for the most up to date data yet. Please double check the Version History.

	The in-game description goes here
–In-Game Description

Buffalo • Buffalo (P) • Buffalo (TT) (only add this section if the ship has multiple skins, like the Buffalo)

Overview

The (Ship name) is a (brief description). (Some brief additional information)

Availability

(Insert where the ship can be found or encountered, including faction markets, special fleets, etc.)

Variants

(Insert any variants that appear in-game—e.g. the ones that appear in the Autofit screen)

(surround this section with a <tabber> tag; see the Astral page for an actual example)
|*|Standard= 8x capacitors, 8x vents

• 1x LR PD Laser

Hullmods: Auxiliary Thrusters |*|Variant2= 8x capacitors, 7x vents

• 1x PD Laser

Hullmods: Unstable Injector

Notes

(Insert any other useful, factual information about the ship)

Tips and strategies

The following section contains user-submitted suggestions, these may be inaccurate or outdated.

(Insert any tips, strategy, tactics, or other suggested uses with this ship)

Changelog

Patch 0.95.1a: One-line change Patch 0.95a:  Change that has multiple lines Another line Patch 0.9a:  Change that has a subsection: Like so