Difference between revisions of "Help:Style guide"

Revision as of 11:22, 10 March 2015

Defer questions of style to The Wikipedia Manual of Style.

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)
• Item_Name-Equipped 2.png - Used for alternate angles (armor, helmets)
• Monster-Monster_Name.png - Used for monsters (128x128px)
• Vendor_Name-Mugshot.png - Used for vendors

Templates

Infoboxes

Gear:

• {{ArmorInfo}} ^(Usage) - For Armor items
• {{HelmetInfo}} ^(Usage) - For Helmet items
• {{ShieldInfo}} ^(Usage) - For Shield items
• {{TrinketInfo}} ^(Usage) - For Trinkets
• {{WeaponInfo}} ^(Usage) - For weapons including Bombs, Handguns, and Swords
• {{SpriteInfo}} ^(Usage) - For Battle Sprites

Aesthetics:

• {{CostumeInfo}} ^(Usage) - For Costume items
• {{FurnitureInfo}} ^(Usage) - For Furniture items

Other:

• {{Monster}} ^(Usage) - For Monsters

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

• An "Item equipped" image in an infobox represents an item as it appears in the tool-tip rotation in-game. Images should generally be the first clear frame of the tool-tip unless the item is obscured (as with certain accessories). Alternate angles should be shown in a gallery elsewhere on the page.

Due to how the game has changed overtime, filenames might seem to be...inaccurate. Images were uploaded (for quite a long time) to file destinations that had "equipped" in the name, because being "worn" or "equipped" was the only consistent view available at the time. Later on, tool-tip rotations were introduced. Since it would require a large chunk of time to change existing filenames (either by moving or reuploading), and nobody actually sees these filenames on published pages, the "inaccurate" naming convention remains.

• 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.

Spiral Spy images should never be uploaded to the wiki, no matter the circumstances.

Categories

Whenever fitting, articles should be categorized. See Special:Categories for a list of categories.

Videos

"You may post videos in the "external links" section of a wiki page, or on your own user page, provided that the video does not contain material that violates our Terms of Service. It's fine if the video you're linking is monetized, but the YouTube description must credit SEGA and Three Rings, and must provide a link back to our game." - Spiral Knights Support, 09 March 2015

Wikipedia MoS regarding "external links." Importantly:

Do not include the external link in the body of the article.

Keep the list short (on this wiki, it will usually be one demonstrative video).

Embedding videos seems to currently have technical issues.