Documentation for individual articles - items, objects, factions, locations etc

From Sheltered 2 Wiki
Jump to navigation Jump to search


Individual articles can be made for any little thing in the game, whether it's an item, object, faction, location, quest etc.

The goal of an individual article should be to provide specialised information on the article subject. Try to include general details that may assist a reader. Helpful hints are also appreciated if they would be relevant for a general audience. Any information that can go into the infobox for the topic should be placed there. The infobox is for a quick overview of technical information on the subject such as an image, recipe details, location info and so on and greatly assists providing that information to mobile users. Other blocks of text can go into the main body of the article.

Any information that is even remotely a spoiler should be covered by spoiler tags.

Templates

This is a quick-reference list for templates, their types, and what they should be used for.

There are templates created specifically to assist you in creating an article that provides a standardised and pre-formatted way of displaying the information, these should always be used where able (and it makes sense) in order to keep the style and structure of articles, as well as how information is presented, the same across articles.

The use of infoboxes also assists in giving a quick-reference of information to mobile users.

The templates will be different from one article type to another and range from formatting, icons, and infoboxes, eventually possibly whole article templates.

For a list of all templates available (whether in use or not) click here

Infobox Templates

All infoboxes consist of a game icon (and/or in-game image), the in-game description (verbatim, minus any included technical details) and technical information such as recipes, stats, uses, effects, findable locations etc. Some sections of an infobox should begin collapsed where they would be a spoiler.

Item Infobox -- General items
Junk Item Infobox -- Junk items (recycling information only)
Equipment Infobox -- Equipment items (equipped effects)
Weapon Infobox -- Weapon items (weapon stats, stamina cost, requirements, effects)
Medicine Infobox -- Medicine items (effects, stamina cost if usable in combat)
Faction Infobox -- Faction Information
NPC Infobox -- general NPC type characters, animals etc. (abilities, biomes, hostility/allegiance etc)
Animals Infobox -- aggressive animals type NPCs (skills, biomes, drops, etc)
Object Infobox -- Shelter object information (costs, uses, requirements)
Quest Infobox -- Quest details (basic non-spoiler information)
Location Infobox -- Places on map tiles (biome, encounters etc)
Biome Infobox -- Biomes (tile types, encounters, etc)

<more to come>

Formatting Templates

Icons -- Standardised use of icons from the game (with custom size), including in-line icon+text links such as StrengthStrength and ★★★