Difference between revisions of "Vintage Story Wiki:Guidelines"

From Vintage Story Wiki
Jump to navigation Jump to search
m
 
Line 12: Line 12:
 
==== Content ====
 
==== Content ====
 
Content should...
 
Content should...
* not be redundant, if you need to include info on two pages, (Ex: item page and the item's source page) include links connecting the two pages. The text on each page should include a brief summary of the relevant info.
+
* not be redundant, if you need to include info on two pages, (Ex: item page and the item's source's page) include links connecting the two pages. The text on each page should include a brief summary 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.
 
* 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'.
Line 36: Line 36:
 
** Grid
 
** Grid
 
** Knapping
 
** Knapping
** Barrel (Leather working, food preservation, other)
+
** Barrel
 
** Clay forming
 
** Clay forming
 
** Smelting and Casting
 
** Smelting and Casting

Latest revision as of 19:30, 16 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 to include info on two pages, (Ex: item page and the item's source's page) include links connecting the two pages. The text on each page should include a brief summary 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
    • Knapping
    • Barrel
    • Clay forming
    • Smelting and Casting
    • Smithing
  • Foraging, Gathering or Harvesting
  • Mining
  • Adventuring (encompasses ruins loot, mob drops, etc.)

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.