Welcome to editing the Spelunky Wiki! This is a guide made to help new editors become acquainted with the established style of the wiki and help it stay consistent across pages.
This guide is NOT a list of rules; it simply lists some of the most common practices on the wiki. Not all pages have to follow the manual of style, and parts of it may be taken or added to pages whenever seen fit to do so. Ultimately, whatever is best for the wiki is what should be done.
General
- Personal opinion should not be on articles, no matter how popular said opinion is.
Language
- American English should be used on pages.
- When describing ingame events or entity behavior, present tense should be used over past tense. "Snakes bite the Spelunker on contact" is preferred over "Snakes will bite the Spelunker on contact", "The door opens" over "The door will open", etc.
- Standard weapons and equipment that are not one of a kind should be referred to as such.
- For example, "A Camera" is preferred over "The Camera".
- Items that are one of a kind (outside of using Spelunky 2's Clone Gun) should be referred to as such.
Naming
- Avoid using made up names for subjects, such as "Back Item". The "official" name for a subject is considered its name ingame. Otherwise, the "official name" is considered its name in the game files, or its name in developer patch notes.
- If a subject appears in multiple Spelunky games and has differing names across them, articles should only use the name from the respective game; Tomb Lords are not to be referred to as Mummies in Spelunky Classic articles.
- When referring to the player character, use Spelunker. Using "the player" on pages is acceptable, as long as it is addressing the player directly, and not the Spelunker they play as. Don't use second person (i.e, "you").
Templates/Categories
Article Management Templates
When a page needs a bit of extra help, an article management template can be added to the very top. The {{Improve}} template looks like this:
| This page needs improvement. If you could make it better, that would be amazing. |
Specifications can also be added, such as {{Improve|This is a test!}}
| This page needs improvement. If you could make it better, that would be amazing. Specifically: This is a test! |
A list of Article Management Templates can be found here.
Version History
A full version history of the topic should also be supplied by typing {{VersionHistory2}}. As the "2" at the end of the template suggests, we only have a version history for Spelunky 2 as of now.
Navigation boxes, whenever applicable, should be added to the bottom of pages added via templates, just after the version history template. An example of this would be {{Spelunky HD Places}}. A full list of navigation templates can be found here. Pages should have applicable categories and templates.
Categories
Categories are added by typing "[[Category:Desired Category]] at the very bottom of the page. A list of categories can be found here. The main ones are "Spelunky (game)", and "Spelunky (game) (topic)", such as Category:Spelunky HD Items.
Samples
Sample pages can be found here, outlining pages for certain topics: Project:Manual of Style/Sample
Once more, these sample pages are a guide, not the rule. It is ultimately you who needs to make a good article.
