User:Hackerman67/Style Guide
.gif)
Notes: This is a draft for the RLCraft Wiki style guide, akin to Wikipedia's Manual of style and Minecraft Wiki's Style Guide. Below are my personal suggestions for the guide and don't reflect the finished product. If Help:Consensus is reached, a conventional location to host the style guide would be RLCraft_Wiki:Style_Guide as well as preferrably an intuitive navigation bar.
Style Guide is a set of community guidelines for editing that contributors should try their best to adhere to. These trump other wiki editing guidelines, with the exception of any rules or terms set by https://wiki.gg, under which this wiki operates. All additions to the style guide necessite a level of mw:Help:Consensus, meaning that a single editor should not add their personal suggestions/preferences here without offering a forum about it beforehand.
See: User:Hackerman67/Style Guide/Suggested_Additions
Spelling
In-game spelling
In-game spelling is to be prioritised.
American v.s. British
- Minecraft, most of the mods and the overwhelming majority of the wiki employ American spelling, so that is what one should adhere to on main namespace articles (and related categories) for the sake of uniformity
- #In-game_spelling trumps this
Capitalisation
As a general rule, all in-game terms are to follow in-game capitalisation, and the rest of the "main namespace"--from which this Style Guide, for example, is exempt--should follow common "title capitalisation rules" (see: Help:Capitalisation).
- In-game terms
- Principal words in:
- Titles / URLs
- Headers
Links
Linking to Minecraft Wiki
If a vanilla Minecraft concept appears in an article, it can be linked to Minecraft Wiki's corresponding page, e.g. [[mc:Carrot|Carrot]] -> Carrot, but doing so could prove detrimental. In RLCraft, Carrots have differing uses from vanilla--and even if they didn't right now, they might in the future--which ought to be informed of on the wiki. However, even if the Carrot page is made, the previously made link still links to mc:Carrot and would have to be manually searched and edited. Instead consider linking all concepts to their respective pages, e.g., Carrot and Iron Ingot with the {{Vanilla}} template at the top of the page.
See: Template:Vanilla
Layout
Example layout for an item page
- Notification templates
- Infobox template
- Main description/introduction
- Uses
- Effects
- Obtaining
- Loot
- Crafting
- Trivia
Categories
Automatic categories
Certain Templates, such as {{Item}}, automatically categorise pages based on their parameter inputs, such as type and renewable. As such, they do not need to--and generally should not--be manually added to main namespace articles.
If there is a need for a new category or change to pre-existing category, consider primarily doing so via templates for easy single point access for any future changes.
Tree model
The current design policy on this wiki's categories is the so called tree model. This means that instead of applying every overarching category that fits an article, such as Category:Hostile Mobs, Category:Entities, Category:Lycanites mobs and Category:Lycanites Undead for Reaper, add it to Category:Hostile Mobs and Category:Lycanites Undead, which in turn is categorised under Category:Lycanites mobs, which is under Category:Mobs, etc...
Bullet list example of the "tree model":
Plural v.s. singular
The general rule is to favor the plural form for noun categories, such as 'Category:Mods' for Mods.
Category page as article (to be avoided)
Articles belong in the "Main" namespace. Categories are separate navigational and categorisation tools. Rarely, if ever, should a category host actual information--or be linked to as such--rather than indexing. Either #REDIRECTing to the other is to be avoided.
Example (to be avoided): Information previously residing at Category:Information.
Redirecting
Redirects can and should be used:
- when the page for the exact subject doesn't exist but information for it does exist on another page
- Redirecting missing pages to existing information
- for alternative spelling of an article, e.g., Lycanites Mobs (actual mod name) and Lycanites Mobs (correct grammar) or Mod and Mods
- as a rule of thumb, whenever you find it plausible that yourself or others might look for or link to an article under an alternative spelling, a redirection is useful and warranted
- after having migrated the content of or moved a page onto another
- even if you've marked the page for deletion
Avoid
- Double redirects
- MediaWiki has a feature which makes redirecting to another redirect page land at the latter instead of its target. As such, redirecting to a pre-existing redirect page is to be avoided. See: Special:DoubleRedirects
- Redirecting from main namespace to category namespace or vice versa. See: #Category page as article (to be avoided)See also: RLCraft_Wiki:Style_Guide/Redirects
Templates
Using the intended templates in the intended fashion ensures a high standard of quality across pages.
Infoboxes
Article management templates
- Template:Article Version
- Template:Incomplete
- Template:Stub
- Template:Work_in_progress
- Template:RemovedContent
- Template:Delete
Other templates
- Template:Disambiguation
- Template:Li
- Example:
Foxhound
- Example:
See: Templates
Quotes
Quotes should be copied from source as-is. If there is clearly in error, the {{Sic}} template should be used, to, among other reasons, alert future editors against correcting it. Template:More
- Syntax
{{Sic|fod|food}}- Result
- Template:Sic