Difference between revisions of "Help:Style guide"

From SpiralKnights

Jump to: navigation, search
m (eh it always needs updating. It's on my personal to do list anyway.)
m (this is more direct for now. Trying to keep this as close to Wikipedia's format as possible - page is due for a major ToC-inspired overhaul as soon as I have time.)
Line 5: Line 5:
 
If you have more questions, ask editors on the [http://forums.spiralknights.com/en/forum/14 wiki editor forums].
 
If you have more questions, ask editors on the [http://forums.spiralknights.com/en/forum/14 wiki editor forums].
  
You can check the [[:Category:Help]] for useful links.
+
You can check the [http://wiki.spiralknights.com/index.php?title=Special%3APrefixIndex&from=&namespace=12 index of namespace 12 (the Help namespace)] for useful links.
  
 
==Wiki Format==
 
==Wiki Format==

Revision as of 06:13, 29 February 2016

Defer questions of style to The Wikipedia Manual of Style.

If something seems to be a pattern on this wiki, follow it.

If you have more questions, ask editors on the wiki editor forums.

You can check the index of namespace 12 (the Help namespace) for useful links.

Wiki Format

There are a few different kinds of pages used around this wiki, such as "lists" and pages about individual items. Below is a list of page formats for easy copypasting to make sure you get all relevant information in the same places in articles consistently:

Wiki Navigation

Redirects

SpiralKnights:Redirect - list of reasons to redirect, and how to tag them.

Categories

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

Naming Convention

Articles

Here are some guidelines for general pages:

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

Files (Images)

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:
Aesthetics:

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

Visuals

Spiral Spy files (and files created in relation to Spiral Spy) should never be uploaded to this wiki, no matter the circumstances. This is due to a variety of reasons, the most important of which is considered to be proof of existence and authenticity. In short, staff wants pictures on this wiki to be captured strictly from in-game. The decision was communicated here and seems to be final, considering multiple discussions with staff on the matter after the forum post.

Avoid using gifs. They should never be used as a representative image under any circumstances, or "main" images such as those displayed in infoboxes.[1]

Images


Tooltips

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 or at a terrible angle (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.

Battle Sprites

Use example images on the Maskeraith (Spiralhorn) page. Details to come - basically, the inspect window shows the size comparison between T1/2/3 sprites and keeps dimensions consistent, compared to cropped images.

Animations

We want high quality animations! No .gifs! Boooo! We prefer to use APNG.


Tooltips

Tooltip animations for an item should be 201px (width) by 222px (height) and feature a full 360° rotation. The animation should be captured from the tool-tip rotation in-game and not from spiral spy. When capturing costumes (or helmets, armor, etc.), make sure they dont have any accessories attached. Compare the angle of the tooltip with similar items already uploaded to maintain consistency around this wiki.

You may use the following guide to create Animated PNG pictures:

Overworld


Compare your item with existing files on this wiki. A picture is worth 1000 words, an animation is worth 1000x more. Then use this guide in junction with the one above, where relevant:

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.

Personal tools