Vintage Story Wiki:Guidelines: Difference between revisions
VeryGoodDog (talk | contribs) m (version info) |
VeryGoodDog (talk | contribs) (formatting guidelines for items, headers, and fixed a header) |
||
| Line 6: | Line 6: | ||
}} | }} | ||
== Content | == Content page formats == | ||
Content pages should follow a general format so we can make sure the right info is on the page. Different topics have different formats, but each format isn't set in stone. | Content pages should follow a general format so we can make sure the right info is on the page. Different topics have different formats, but each format isn't set in stone. | ||
| Line 15: | Line 15: | ||
* be grouped on pages generally following the asset's variants, for example, all the plank types should be on one page because they don't really have much individual content. | * be grouped on pages generally following the asset's variants, for example, all the plank types should be on one page because they don't really have much individual content. | ||
* fit with American English spellings, 'color' over 'colour', and formattings, 'MM/DD/YY' not 'DD/MM/YY'. | * fit with American English spellings, 'color' over 'colour', and formattings, 'MM/DD/YY' not 'DD/MM/YY'. | ||
* avoid referring to the reader directly, instead refer to a ''player''. | |||
[https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia's MOS] is useful. | [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia's MOS] is useful. | ||
==== Titles ==== | ==== Titles ==== | ||
This applies to section titles as well as page titles. | |||
Titles should... | Titles should... | ||
* have the first word capitalized and all following words lowercase, for example: 'Stationary basket' not 'Stationary Basket'. | * have the first word capitalized and all following words lowercase, for example: 'Stationary basket' not 'Stationary Basket'. | ||
| Line 24: | Line 26: | ||
==== Infobox usage ==== | ==== Infobox usage ==== | ||
Try to use infoboxes wherever possible. See [[:Category:Infoboxes]] for a list of all infoboxes. | Try to use infoboxes wherever possible. See [[:Category:Infoboxes]] for a list of all infoboxes. | ||
=== Items === | |||
The info needed about items is pretty standard. Be sure to include: | |||
* How a player gets the item: Obtaining. | |||
* What the player does with it: Usage. | |||
'''Obtaining''' should detail the source: | |||
* Crafting | |||
** Grid | |||
** Alloy | |||
** Barrel | |||
** Clayforming | |||
** Knapping | |||
** Smithing | |||
* Smelting | |||
* Mining | |||
* Adventuring | |||
Adventuring encompases ruins loot, mob drops, and blocks found in various patches in the world. | |||
'''Usage''' should detail any use the item has: | |||
* Crafting | |||
* Smelting | |||
* Tool | |||
Info that doesn't fall into one of these categories should be placed directly under the Usage heading before any other info. | |||
When an item like a chisel or hammer is used in a grid recipe it should go under the Tool category. | |||
== Technical == | == Technical == | ||
The wiki runs on [https://www.mediawiki.org/wiki/MediaWiki_1.27 MediaWiki 1.27]. | The wiki runs on [https://www.mediawiki.org/wiki/MediaWiki_1.27 MediaWiki 1.27]. | ||
Revision as of 14:26, 7 January 2020
Writing a wiki is hard! But it is easier when more people work together. This page outlines various guidelines to help collaboration. If you need access to edit, go to the #wiki-and-translations Discord channel
Protip:
This is only a guideline, it is a living standard and may be changed as we grow as a community, and it's not strictly required. All rules can be broken and this is no exception. |
Content page formats
Content pages should follow a general format so we can make sure the right info is on the page. Different topics have different formats, but each format isn't set in stone.
General
Content
Content should...
- not be redundant, if you need info on two pages, say, an item's page and it's source, put a link to the other page with a brief detail of the relevant info.
- be grouped on pages generally following the asset's variants, for example, all the plank types should be on one page because they don't really have much individual content.
- fit with American English spellings, 'color' over 'colour', and formattings, 'MM/DD/YY' not 'DD/MM/YY'.
- avoid referring to the reader directly, instead refer to a player.
Wikipedia's MOS is useful.
Titles
This applies to section titles as well as page titles. Titles should...
- have the first word capitalized and all following words lowercase, for example: 'Stationary basket' not 'Stationary Basket'.
- reflect the name of the item in the game's assets, for example: 'Ore blasting bomb' not 'Bomb'.
Infobox usage
Try to use infoboxes wherever possible. See Category:Infoboxes for a list of all infoboxes.
Items
The info needed about items is pretty standard. Be sure to include:
- How a player gets the item: Obtaining.
- What the player does with it: Usage.
Obtaining should detail the source:
- Crafting
- Grid
- Alloy
- Barrel
- Clayforming
- Knapping
- Smithing
- Smelting
- Mining
- Adventuring
Adventuring encompases ruins loot, mob drops, and blocks found in various patches in the world.
Usage should detail any use the item has:
- Crafting
- Smelting
- Tool
Info that doesn't fall into one of these categories should be placed directly under the Usage heading before any other info. When an item like a chisel or hammer is used in a grid recipe it should go under the Tool category.
Technical
The wiki runs on MediaWiki 1.27.
