Editing Style Guide

From MINR.ORG WIKI

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 2: Line 2:
 
There are often disputes over which style rule or formatting to use and hopefully the inclusion of an official style guide will help resolve these disputes as well as in helping to reach a consensus.
 
There are often disputes over which style rule or formatting to use and hopefully the inclusion of an official style guide will help resolve these disputes as well as in helping to reach a consensus.
  
Although Wikipedia already provides a more general [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style style guide], a more specific one is necessary for ''Minr'' specific guidelines. As such, only guidelines pertaining to the Minr Wiki and its basic formatting rules should be included here.
+
Although Wikipedia already provides a more general [[wp:Manual of Style|style guide]], a more specific one is necessary for ''Minr'' specific guidelines. As such, only guidelines pertaining to the Minr Wiki and its basic formatting rules should be included here.
  
 
== Notability ==
 
== Notability ==
Line 23: Line 23:
  
 
Redirects are exempt from the normal notability, but must redirect to an article that fits the notability guidelines. If a redirect leads to another wiki, it must use {{t|soft redirect}}. Redirects can be created if they fit one of the following:
 
Redirects are exempt from the normal notability, but must redirect to an article that fits the notability guidelines. If a redirect leads to another wiki, it must use {{t|soft redirect}}. Redirects can be created if they fit one of the following:
# Alternate spelling of the title, such as "[[Wooly Mammoth]]" for "[[Wolly Mammoth]]".
+
# Alternate spelling of the title, such as "[[Armour]]" for "[[Armor]]".
 
## Incorrect spelling, typos, and irregular formatting are not allowed.
 
## Incorrect spelling, typos, and irregular formatting are not allowed.
# Alternate or shortened name, provided the name is common usage, such as "[[STS]]" for "[[Shri Tra Savern]]".
+
# Alternate or shortened name, provided the name is common usage, such as "[[Log]]" for "[[Wood]]".
 
# Previous article title, including if the article was moved to another wiki.
 
# Previous article title, including if the article was moved to another wiki.
 
## An exception is if the previous title was not commonly used.
 
## An exception is if the previous title was not commonly used.
Line 38: Line 38:
  
 
Articles should follow a general naming format based on the type.
 
Articles should follow a general naming format based on the type.
* Articles about maps or challenges should match the name as represented by the plugin.
+
* Articles about blocks, items, and entities in game should use the in game name capitalized as it appears in game.
* Articles names should be singular. For example, use [[Challenge]] instead of Challenges.
+
** If the feature does not have an in game name, it should follow the same format as other articles of the same type. For example, the mob [[Spider Jockey]].
* If the feature does not have an in game name, it should follow the same format as other articles of the same type.
+
** If the article is about multiple things in the game, the title should equally represent all the titles. For example, an article about wooden and iron doors would be called [[Door]].
* If the article is about multiple things, the title should equally represent all the titles. For example, an article about Hexa and Welcome to Hell would be called [[Challenge]].
 
 
* Disambiguation articles should only contain "(disambiguation)" if the title without the word is used by an article.
 
* Disambiguation articles should only contain "(disambiguation)" if the title without the word is used by an article.
* If the article's type is unlisted, it should use the most relevant title in [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case], not title case, unless it is a proper noun.
+
* If the article's type is unlisted, it should use the most relevant title in [[WP:LOWERCASE|sentence case]], not title case, unless it is a proper noun.
  
 
== Writing ==
 
== Writing ==
Line 49: Line 48:
 
As this wiki's purpose is to document facts, you should always avoid speculative and unsourced information. Generally speaking, information does not require sources if they can directly be seen in-game or are otherwise obvious. Other information however, such as quotes from staff and information that is not widely known, must be sourced with a proper reference. The {{t|citation needed}} template should be placed after any information that requires a source. Do ''not'' add content to an article if you cannot find a proper source.
 
As this wiki's purpose is to document facts, you should always avoid speculative and unsourced information. Generally speaking, information does not require sources if they can directly be seen in-game or are otherwise obvious. Other information however, such as quotes from staff and information that is not widely known, must be sourced with a proper reference. The {{t|citation needed}} template should be placed after any information that requires a source. Do ''not'' add content to an article if you cannot find a proper source.
  
Articles in the main namespace should always be written in the third-person perspective and without terms referential to the reader. Try not to use abbreviations of words either. For instance, sentences like "You should not play [[Brother Therapy]] on your own." should be written as "The player should not play Brother Therapy on their own.".
+
Articles in the main namespace should always be written in the third-person perspective and without terms referential to the reader. Try not to use abbreviations of words either. For instance, sentences like "You shouldn't come close to creepers because they'll explode and kill you." should be written as "The player should not come close to creepers as they will explode, potentially killing the player.".
  
 
To emphasize points, ''italics'' should be used, not '''bold''' or ALL CAPS.
 
To emphasize points, ''italics'' should be used, not '''bold''' or ALL CAPS.
Line 55: Line 54:
 
=== Keeping articles concise and up to date ===
 
=== Keeping articles concise and up to date ===
  
In short, articles should only contain information that is up to date, i.e., implemented in the latest ''full'' version of ''Zero''. Anything that is outdated should be moved to the History section of the article. When something changes, note the change in the History section and remove the outdated information from other sections of the article. It is unnecessary to mention when a particular feature was implemented; this is once again reserved for the History section of the article. Sentences such as "[[FFA]] was created in 2012, and acts as a hub for the majority of playable maps." should be written as "[[FFA]] acts as a hub for the majority of playable maps."  
+
In short, articles should only contain information that is up to date, i.e., implemented in the latest ''full'' version of the game. Anything that is outdated should be moved to the History section of the article. When something changes, note the change in the History section and remove the outdated information from other sections of the article. It is unnecessary to mention when a particular feature was implemented; this is once again reserved for the History section of the article. Sentences such as "[[Trading]], which was implemented in 1.3.1, is a feature that allows players to exchange [[emerald]]s (previously [[Ruby|rubies]]) for other items." should be written as "Trading is a feature that allows players to exchange emeralds for other items."  
  
 
=== Grammar ===
 
=== Grammar ===
  
Pages on the wiki can either use ''American English'' or "British English". However, the same must be used throughout the entire article. For example: do not use ''color'' at one part of the page, and ''colour'' at a different part of the page.
+
Pages on the wiki can either use ''American English'' or "British English". However, the same must be used throughout an entire article.
 +
 
 +
=== Capitalization ===
 +
 
 +
In-game items should be treated as common nouns and as such ''should not'' be capitalized, unless they start a new sentence. This includes fictional items, such as [[prismarine]]. Proper nouns, however, such as [[the Nether]] or [[the Overworld]] ''should'' always be capitalized.
 +
 
  
 
=== Section headings ===
 
=== Section headings ===
Line 71: Line 75:
 
=== Italics ===
 
=== Italics ===
  
Any instance of "''Minr''" should be in italics. Any emphasis (in talk pages, etc.) should be in italics instead of being in bold or uppercase letters. Any instance of the name of a video game should also be in italics. For instance: ''Team Fortress 3''.
+
Any instance of "''Minr''" should be in italics. Any emphasis (in talk pages, etc.) should be in italics instead of being in bold or uppercase letters. Any instance of the name of a videogame should also be in italics. For instance: ''Team Fortress 3''.
  
 
=== Images ===
 
=== Images ===
  
When adding screenshots to an article, make sure the screenshots use vanilla textures and UI. Screenshots that use custom resource packs, UI mods and other custom content are not allowed.
+
When adding screenshots to an article, make sure the screenshots use vanilla textures and UI. Screenshots that use custom texturepacks, UI mods and other custom content are not allowed.
  
 
Image captions should not have periods at the end, unless the phrase is a full sentence.
 
Image captions should not have periods at the end, unless the phrase is a full sentence.
Line 85: Line 89:
 
** Images showcasing usage of specific features for decoration should be avoided.
 
** Images showcasing usage of specific features for decoration should be avoided.
 
* Articles should only have one image showcasing an individual attribute of the articles content. For example, a zombie wearing armor.
 
* Articles should only have one image showcasing an individual attribute of the articles content. For example, a zombie wearing armor.
* Images should showcase the most up to date version available for the content.
+
* Images should showcase the most up to date version of Minecraft available for the content.
 
** Images that are outdated are subject to be removed.
 
** Images that are outdated are subject to be removed.
  
 
=== Linking ===
 
=== Linking ===
:''For a complete guide to linking, please refer to Wikipedia's [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Linking Manual of Style for Linking].''
+
:''For a complete guide to linking, please refer to Wikipedia's [[wp:Manual of Style (linking)|Manual of Style for links]].''
  
 
The use of links is a difficult balance between providing the reader enough useful links to allow them to "wander through" articles and excessive linking which can distract them from their reading flow.
 
The use of links is a difficult balance between providing the reader enough useful links to allow them to "wander through" articles and excessive linking which can distract them from their reading flow.
Line 107: Line 111:
 
* Duplicating an important link distant from a previous occurrence in an article may well be appropriate. If an important term appears many times in a long article, but is only linked once at the very beginning of the article, it may actually be underlinked. Indeed, readers who jump directly to a subsection of interest must still be able to find a link. But take care in fixing such problems, the distance between duplicate links is an editor's preference, however if in doubt duplicate the term further down the article.
 
* Duplicating an important link distant from a previous occurrence in an article may well be appropriate. If an important term appears many times in a long article, but is only linked once at the very beginning of the article, it may actually be underlinked. Indeed, readers who jump directly to a subsection of interest must still be able to find a link. But take care in fixing such problems, the distance between duplicate links is an editor's preference, however if in doubt duplicate the term further down the article.
  
Linking to a redirect is preferred over using a piped link except in templates and other pages that will be transcluded. When a piped link is unavoidable, it should not point to a redirect. If a redirect can be avoided using a suffix on the link, that is preferred. E.g. Using <code><nowiki>[[Map]]s</nowiki></code> instead of <code><nowiki>[[Maps]]</nowiki></code> is desired.
+
Linking to a redirect is preferred over using a piped link except in templates and other pages that will be transcluded. When a piped link is unavoidable, it should not point to a redirect. If a redirect can be avoided using a suffix on the link, that is preferred. E.g. Using <code><nowiki>[[Creeper]]s</nowiki></code> instead of <code><nowiki>[[Creepers]]</nowiki></code> is desired.
  
 
=== Date formatting ===
 
=== Date formatting ===
  
''Minr'' is an international community. That is a good thing in general, but it makes a problem for numeric abbreviations of dates, such as "12/10/11": while most countries abbreviate dates as day/month/year, some Asian countries use year/month/day, and the US uses month/day/year. So the above date could represent any of three different dates.  To avoid this problem, most dates should be written in "Month&nbsp;DD, YYYY" format, ''e.g.'' "December&nbsp;10, 2011".  Do not use superscripts or suffixes such as "April 23<sup>rd</sup>" or "4th of May".  If a numeric or terse date is needed (such as in a table), then use YYYY-MM-DD, always with 2 digits for month and day (''e.g.'', 2011-12-10 or 2012-05-04).  Besides being the [https://en.wikipedia.org/wiki/ISO_8601 ISO standard], dates in this format will naturally sort properly, say if the table column is later made sortable.
+
The Minecraft Wiki is an international community. That is a good thing in general, but it makes a problem for numeric abbreviations of dates, such as "12/10/11": while most countries abbreviate dates as day/month/year, some Asian countries use year/month/day, and the US uses month/day/year. So the above date could represent any of three different dates.  To avoid this problem, most dates should be written in "Month&nbsp;DD, YYYY" format, ''e.g.'' "December&nbsp;10, 2011".  Do not use superscripts or suffixes such as "April 23<sup>rd</sup>" or "4th of May".  If a numeric or terse date is needed (such as in a table), then use YYYY-MM-DD, always with 2 digits for month and day (''e.g.'', 2011-12-10 or 2012-05-04).  Besides being the [[wikipedia:ISO 8601|ISO standard]], dates in this format will naturally sort properly, say if the table column is later made sortable.
  
 
== Article layout ==
 
== Article layout ==

Please note that all contributions to MINR.ORG WIKI may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see MINR.ORG WIKI:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)

Templates used on this page: