Difference between revisions of "Style guide"
From Unofficial Stationeers Wiki
(I'll be back later. I'll try to write some stuff up and add some links, then discuss article titles and layout a bit.) |
(→Section organization) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
==Page titles== | ==Page titles== | ||
| + | Page titles adhere to the English in-game names wherever possible. | ||
| + | Items which are constructible are either named by their item name or their constructed name, this should eventually be unified, but it is the current state. (see [[Kit (Arc Furnace)]] vs [[Hydroponic Station]]) | ||
| + | When we don't have simple 1:1 representations of in-game objects, there may be more compromises. | ||
==Article layout== | ==Article layout== | ||
| + | |||
| + | ===Section organization=== | ||
| + | * Infoboxes | ||
| + | * Summary/introduction | ||
| + | * ToC | ||
| + | * Extended description and documentation if applicable | ||
| + | * Recipes and input/output | ||
| + | * Data Network properties | ||
| + | |||
| + | Don't follow a heading with another heading. Articles already have a main heading, so there's no need for an article to start with a top-level heading. | ||
| + | This also ensures that the page starts with relevant information rather than a table of contents. | ||
Latest revision as of 14:49, 26 October 2019
This page is an open draft for our style guide, everyone's invited to discussion on the talk page
Page titles[edit]
Page titles adhere to the English in-game names wherever possible. Items which are constructible are either named by their item name or their constructed name, this should eventually be unified, but it is the current state. (see Kit (Arc Furnace) vs Hydroponic Station)
When we don't have simple 1:1 representations of in-game objects, there may be more compromises.
Article layout[edit]
Section organization[edit]
- Infoboxes
- Summary/introduction
- ToC
- Extended description and documentation if applicable
- Recipes and input/output
- Data Network properties
Don't follow a heading with another heading. Articles already have a main heading, so there's no need for an article to start with a top-level heading. This also ensures that the page starts with relevant information rather than a table of contents.