Help:Style guide

Defer questions of style to Style and How-to Directory.

Article Names

Here are some guidelines for general pages:

• Wikipedia's naming conventions
• Wikipedia's disambiguation page

As a game, Spiral Knights has its own special names, so the Wikipedia guidelines will not always be appropriate.

File Names

Uploaded files should be named clearly and plainly. All images should have the appropriate image tag included in the file description. The preferred image format is PNG. For images created by the Spiral Knights community, please follow the following naming conventions:

• Bomb_Name_blast_radius.png - Used for bomb radius images
• Crafting-Item_Name.png - Used for crafting item icons
• Equipment-Item_Name icon.png - Used for equipment item icons (armor, helmets, shields, weapons)
• Equipment-Item_Name Stats.png- Used for equipment stats (armor, helmets, shields, weapons)
• Item_Name-Equipped.png - Used for equipped items (armor, helmets, shields, weapons)
• Monster-Monster_Name.png - Used for monsters (128x128px)
• Vendor_Name-Mugshot.png - Used for vendors

Templates

Infoboxes

• {{ArmorInfo}} ^(Usage) - For armor including armor, helmets, and shields
• {{Monster}} ^(Usage) - For monsters
• {{TrinketInfo}} ^(Usage) - For trinkets
• {{WeaponInfo}} ^(Usage) - For weapons including bombs, guns, and swords

Table of Contents

• {{TOCright}} ^(Usage) - For moving the TOC to the right
• {{CompactTOC}} ^(Usage) - For an ABC type TOC to replace the standard type. Used for alphabetical lists.

Other

• {{SKLink}} ^(Usage) - For making links visible in tables with dark backgrounds
• {{Star}} ^(Usage) - For showing the star rating graphically

Screenshots and images

• "Item equipped" images represent the item as it appears when worn. The best screenshots can be taken from the character information window. Armor images should include a front and back view.
• Bomb blast radius images are usually taken in a standard reference location, to facilitate comparisons between different bombs.
  • The preferred location is the depth 4 Clockworks Terminal, please see the current radius screenshots for the specific square (to the left of one with a spiral).
  • The image usually shows the white circles that appear before the bomb detonates - this keeps the image from being obscured by complex animations. "Shard" bombs (such as the crystal bomb) have a very small "blast radius", and may be better represented by an image showing the distance that shards travel.