Vintage Story Wiki:Guidelines: Difference between revisions
(added section about page deletion) |
VeryGoodDog (talk | contribs) (info about icons and images) |
||
| Line 14: | Line 14: | ||
* 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. | * 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 | * fit with American English spellings, 'color' over 'colour', and formats, 'MM/DD/YY' not 'DD/MM/YY'. | ||
* avoid referring to the reader directly, instead refer to a ''player''. | * 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. | ||
| Line 26: | Line 26: | ||
==== Infobox usage ==== | ==== Infobox usage ==== | ||
Try to use infoboxes wherever possible. See [[:Category:Infoboxes]] for a list of all infoboxes. Also, try to use [[:Category:ControlsTemplates]] when describing the actual controls of the game, for example: '{{Using}} a chisel...' not 'Using (right mouse button) a chisel...'. | Try to use infoboxes wherever possible. See [[:Category:Infoboxes]] for a list of all infoboxes. Also, try to use [[:Category:ControlsTemplates]] when describing the actual controls of the game, for example: '{{Using}} a chisel...' not 'Using (right mouse button) a chisel...'. | ||
==== Icons and images ==== | |||
To generate images run the command <code>.blockitempngexport 400</code> which outputs images 400px by 400px. | |||
When uploading icons for blocks, entities, and items, leave the name of the image as is, except remove any direction related words from the filename. This helps maintain a consistent naming pattern for all blocks, entities, and items. | |||
For example, <code>shelf-normal-east.png</code> should be changed to <code>shelf.png</code>, but <code>rockpolished-andesite.png</code> should '''NOT''' be changed to <code>polished-andesite.png</code>. | |||
=== Items === | === Items === | ||
Revision as of 15:03, 10 May 2021
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 formats, '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...
- reflect the name of the item in the game's assets, for example: 'Ore blasting bomb' not 'Bomb'.
- be complete noun or verb phrases, for example: 'Tool Strength Chart' not 'Chart: Tool Strength'.
Infobox usage
Try to use infoboxes wherever possible. See Category:Infoboxes for a list of all infoboxes. Also, try to use Category:ControlsTemplates when describing the actual controls of the game, for example: ' using a chisel...' not 'Using (right mouse button) a chisel...'.
Icons and images
To generate images run the command .blockitempngexport 400 which outputs images 400px by 400px.
When uploading icons for blocks, entities, and items, leave the name of the image as is, except remove any direction related words from the filename. This helps maintain a consistent naming pattern for all blocks, entities, and items.
For example, shelf-normal-east.png should be changed to shelf.png, but rockpolished-andesite.png should NOT be changed to polished-andesite.png.
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.
Infoboxes
Infoboxes are very useful as quick reference tools. Try to use them as often as possible as they make a page feel a lot more complete :). For help using them, see the tutorial.
Page Deletion
Information about page deletion can be found here: Category:Deletion_candidates
Interesting Links
Technical
The wiki runs on MediaWiki
