MarioWiki:Manual of Style: Difference between revisions

From the Super Mario Wiki, the Mario encyclopedia
Jump to navigationJump to search
mNo edit summary
Line 28: Line 28:
==Step-by-step example article==
==Step-by-step example article==
Let's say that the article "Super Mario Wiki" was created by a user, and it was part of the knowledge base (in reality it is not and an article about the wiki itself, unlike Wikipedia, would be deleted). Here's the wikitext (what appears in the editbox) of this article:
Let's say that the article "Super Mario Wiki" was created by a user, and it was part of the knowledge base (in reality it is not and an article about the wiki itself, unlike Wikipedia, would be deleted). Here's the wikitext (what appears in the editbox) of this article:
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>is a wkii about the mario series. has many articles like super mario bros you can edit but you must craete an account to make pictures</nowiki></span>
 
<pre>
is a wkii about the mario series. has many articles like super mario bros you can edit but you must craete an account to make pictures
</pre>


First of all, the understood guideline "good grammar" is obviously broken. Remember that this is an encyclopedia, and we must at least look like one. Here's the same text corrected:
First of all, the understood guideline "good grammar" is obviously broken. Remember that this is an encyclopedia, and we must at least look like one. Here's the same text corrected:
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>It is a wiki about the Mario series. It has many articles like the game Super Mario Bros. Anyone can edit, but you must create an account to upload images.</nowiki></span>
 
<pre>
It is a wiki about the Mario series. It has many articles like the game Super Mario Bros. Anyone can edit, but you must create an account to upload images.
</pre>


Now, we will run this article through the seven critical criteria listed above and compare the final article to this.
Now, we will run this article through the seven critical criteria listed above and compare the final article to this.
Line 37: Line 43:
===Bolding the title===
===Bolding the title===
We start out an article by restating the title of the article, and also '''bolding it for emphasis'''. This is a simple rule to remember and easy to add. Here we replace "It" and add a "The" to keep the sentence sensible:
We start out an article by restating the title of the article, and also '''bolding it for emphasis'''. This is a simple rule to remember and easy to add. Here we replace "It" and add a "The" to keep the sentence sensible:
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>The '''Super Mario Wiki''' is a wiki about the Mario series. ...</nowiki></span>
 
<pre>
The '''Super Mario Wiki''' is a wiki about the Mario series. ...
</pre>


When the article is a game, referring to [[#Italicizing titles|Step 5]], using five apostrophes (<tt><nowiki>'''''</nowiki></tt>) for bold and italics. Note that the title doesn't need to be bolded again after the first time (e.g. in image captions, infoboxes).
When the article is a game, referring to [[#Italicizing titles|Step 5]], using five apostrophes (<tt><nowiki>'''''</nowiki></tt>) for bold and italics. Note that the title doesn't need to be bolded again after the first time (e.g. in image captions, infoboxes).
Line 45: Line 54:


In our example article, we have one detail: the game ''Super Mario Bros.'' is one of many articles on the wiki. Here we add some more about the wiki as well as more games:
In our example article, we have one detail: the game ''Super Mario Bros.'' is one of many articles on the wiki. Here we add some more about the wiki as well as more games:
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>The '''Super Mario Wiki''' is a wiki about the Mario series and its related series, Wario, Yoshi, Donkey Kong, and Super Smash Bros. It has many articles, such as Super Mario Bros., Super Mario World, New Super Mario Bros., Bowser, Extra Life, Goomba and much more. In most of these games, such as New Super Mario Bros., the plumber Mario saves Princess Peach from Bowser, who is the main antagonist. There are over 45000 files uploaded, 90,000,000 page views, 15000 users and 14 administrators (though a few are inactive). The wiki was created on August 12th, 2005 by Porplemontage, and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but you must create an account to upload files or create new articles.</nowiki></span>
 
<pre>
The '''Super Mario Wiki''' is a wiki about the Mario series and its related series, Wario, Yoshi, Donkey Kong, and Super Smash Bros. It has many articles, such as Super Mario Bros., Super Mario World, New Super Mario Bros., Bowser, Extra Life, Goomba and much more. In most of these games, such as New Super Mario Bros., the plumber Mario saves Princess Peach from Bowser, who is the main antagonist. There are over 45000 files uploaded, 90,000,000 page views, 15000 users and 14 administrators (though a few are inactive). The wiki was created on August 12th, 2005 by Porplemontage, and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but you must create an account to upload files or create new articles.
</pre>


Your details depend on the type of article you're creating. Think of the basics - a person who has never played the game(s) would need to get a fair idea what it is. There ''are'' a few things that should be avoided when writing, such as adding speculation, rambling on about insignificant details, or putting overly dramatic or dark spins on things; a full list of common writing issues can be found [[MarioWiki:Good writing|here]]. Padding should also be avoided, and if you don't know the topic well-enough to do more than state the obvious, don't create the article at all. Newly created stubs will be deleted automatically so try to add a decent amount of information to the page you are creating. Remember, it's the amount of info that matters, not the length, and simple subjects will inevitably have small articles, but that does not make them stubs.
Your details depend on the type of article you're creating. Think of the basics - a person who has never played the game(s) would need to get a fair idea what it is. There ''are'' a few things that should be avoided when writing, such as adding speculation, rambling on about insignificant details, or putting overly dramatic or dark spins on things; a full list of common writing issues can be found [[MarioWiki:Good writing|here]]. Padding should also be avoided, and if you don't know the topic well-enough to do more than state the obvious, don't create the article at all. Newly created stubs will be deleted automatically so try to add a decent amount of information to the page you are creating. Remember, it's the amount of info that matters, not the length, and simple subjects will inevitably have small articles, but that does not make them stubs.
Line 55: Line 67:


Our example article fixes up the "you" in the last sentence:
Our example article fixes up the "you" in the last sentence:
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>... a person must create an account to upload files or create new articles.</nowiki></span>
 
<pre>
... a person must create an account to upload files or create new articles.
</pre>


===Linking, linking, linking!===
===Linking, linking, linking!===
Line 61: Line 76:


Our example article includes one User namespace piped link for Porplemontage, but in articles, mostly all links are to other articles. Note only the ''Super Mario'' franchise page is created as of 03:29, 2 March 2007 (EST).
Our example article includes one User namespace piped link for Porplemontage, but in articles, mostly all links are to other articles. Note only the ''Super Mario'' franchise page is created as of 03:29, 2 March 2007 (EST).
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>The '''Super Mario Wiki''' is a wiki about the [[Super Mario (franchise)|''Super Mario'' franchise]] and its related series, [[Wario (franchise)|Wario]], [[Yoshi (franchise)|Yoshi]], [[Donkey Kong (franchise)|Donkey Kong,]] and [[Super Smash Bros.]] It has many articles, such as [[Super Mario Bros.]], [[Super Mario World]], [[New Super Mario Bros.]], [[Bowser]], [[Extra Life]], [[Goomba]] and much more. In most of these games, such as New Super Mario Bros., the plumber [[Mario]] saves [[Princess Peach]] from Bowser, who is the main antagonist. There are over 45000 files uploaded, 90,000,000 page views, 15000 users and 14 administrators (though a few are inactive). ... The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.</nowiki></span>
 
<pre>
The '''Super Mario Wiki''' is a wiki about the [[Super Mario (franchise)|''Super Mario'' franchise]] and its related series, [[Wario (franchise)|Wario]], [[Yoshi (franchise)|Yoshi]], [[Donkey Kong (franchise)|Donkey Kong,]] and [[Super Smash Bros.]] It has many articles, such as [[Super Mario Bros.]], [[Super Mario World]], [[New Super Mario Bros.]], [[Bowser]], [[Extra Life]], [[Goomba]] and much more. In most of these games, such as New Super Mario Bros., the plumber [[Mario]] saves [[Princess Peach]] from Bowser, who is the main antagonist. There are over 45000 files uploaded, 90,000,000 page views, 15000 users and 14 administrators (though a few are inactive). ... The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.
</pre>


===Italicizing titles===
===Italicizing titles===
Line 67: Line 85:


As our Super Mario Wiki article gets better, notice that the second occurrence of "New Super Mario Bros." is still italicized, just not linked.
As our Super Mario Wiki article gets better, notice that the second occurrence of "New Super Mario Bros." is still italicized, just not linked.
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>The '''Super Mario Wiki''' is a wiki about the [[Super Mario (franchise)|''Super Mario'' franchise]] and its related series, [[Wario (franchise)|''Wario'']], [[Yoshi (franchise)|''Yoshi'']], [[Donkey Kong (franchise)|''Donkey Kong'']], and ''[[Super Smash Bros.]]'' It has many articles, such as ''[[Super Mario Bros.]]'', ''[[Super Mario World]]'', ''[[New Super Mario Bros.]]'', [[Bowser]], [[Extra Life]], [[Goomba]] and much more. In most of these games, such as ''New Super Mario Bros.'', the plumber [[Mario]] saves [[Princess Peach]] from Bowser, who is the main antagonist. ...</nowiki></span>
 
<pre>
The '''Super Mario Wiki''' is a wiki about the [[Super Mario (franchise)|''Super Mario'' franchise]] and its related series, [[Wario (franchise)|''Wario'']], [[Yoshi (franchise)|''Yoshi'']], [[Donkey Kong (franchise)|''Donkey Kong'']], and ''[[Super Smash Bros.]]'' It has many articles, such as ''[[Super Mario Bros.]]'', ''[[Super Mario World]]'', ''[[New Super Mario Bros.]]'', [[Bowser]], [[Extra Life]], [[Goomba]] and much more. In most of these games, such as ''New Super Mario Bros.'', the plumber [[Mario]] saves [[Princess Peach]] from Bowser, who is the main antagonist. ...
</pre>


===Navigation templates===
===Navigation templates===
[[MarioWiki:Navigation templates|Navigation templates]] list a bunch of related articles. Most templates pertain to a particular game (such as {{tem|SMB}}) and will list all the characters, items, etc. that appear in that game, although others will list all the specific types of a certain group of species, items, etc. (such as ({{tem|Koopas}} or {{tem|Mushrooms}}). Sometimes an unmade article is already on one of these templates in red, waiting to be added, sometimes you will have to edit the template to include it. Sometimes there is no navigation template yet for your subject or game. But if there ''is'' an appropriate template, add it - it has the same effect as linking, but even better.
[[MarioWiki:Navigation templates|Navigation templates]] list a bunch of related articles. Most templates pertain to a particular game (such as {{tem|SMB}}) and will list all the characters, items, etc. that appear in that game, although others will list all the specific types of a certain group of species, items, etc. (such as ({{tem|Koopas}} or {{tem|Mushrooms}}). Sometimes an unmade article is already on one of these templates in red, waiting to be added, sometimes you will have to edit the template to include it. Sometimes there is no navigation template yet for your subject or game. But if there ''is'' an appropriate template, add it - it has the same effect as linking, but even better.


Let's say that a template called <nowiki>{{gaming wikis}}</nowiki> was a navigational template listing all wikis related to video games. So:
Let's say that a template called <nowiki>{{Gaming wikis}}</nowiki> was a navigational template listing all wikis related to video games. So:
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>... The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.</nowiki></span>


:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>{{gaming wikis}}</nowiki></span>
<pre>
... The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.
 
{{Gaming wikis}}
</pre>


===Categories===
===Categories===
Line 83: Line 107:


Let's say the categories Gaming, Wikis and Websites exist here, and that Wikis is a subcategory of Websites. In that case:
Let's say the categories Gaming, Wikis and Websites exist here, and that Wikis is a subcategory of Websites. In that case:
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>... The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.</nowiki></span>


:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>{{gaming wikis}}</nowiki></span>
<pre>
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>[[Category:Gaming]]</nowiki></span>
... The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>[[Category:Wikis]]</nowiki></span>


Note that Websites isn't on the article, but it can still be reached by going through Wikis, just as this article can still be reached from Websites by going through the intermediate subcategory.  
{{Gaming wikis}}
[[Category:Gaming]]
[[Category:Wikis]]
</pre>
 
Note that Websites isn't on the article, but it can still be reached by going through Wikis, just as this article can still be reached from Websites by going through the intermediate subcategory.


Also note that categories and templates often overlap in subject matter. This is perfectly fine, however templates are expected to provide enhanced navigation assets for readers (i.e. subdividing a large group of related pages by more specific criteria, such as characters vs. items appearing in the same game). If a category or a group of categories adequately links a group of pages, a template may not be needed at all.
Also note that categories and templates often overlap in subject matter. This is perfectly fine, however templates are expected to provide enhanced navigation assets for readers (i.e. subdividing a large group of related pages by more specific criteria, such as characters vs. items appearing in the same game). If a category or a group of categories adequately links a group of pages, a template may not be needed at all.
Line 96: Line 123:


''Congratulations! The article ''"Super Mario Wiki"'', with the text''
''Congratulations! The article ''"Super Mario Wiki"'', with the text''
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>The '''Super Mario Wiki''' is a wiki about the [[Super Mario (franchise)|''Super Mario'' franchise]] and its related series, [[Wario (franchise)|''Wario'']], [[Yoshi (franchise)|''Yoshi'']], [[Donkey Kong (franchise)|''Donkey Kong'']], and ''[[Super Smash Bros.]]'' It has many articles, such as ''[[Super Mario Bros.]]'', ''[[Super Mario World]]'', ''[[New Super Mario Bros.]]'', [[Bowser]], [[Extra Life]], [[Goomba]] and much more. In most of these games, such as ''New Super Mario Bros.'', the plumber [[Mario]] saves [[Princess Peach]] from Bowser, who is the main antagonist. There are over 45000 files uploaded, 90,000,000 page views, 15000 users and 14 administrators (though a few are inactive). The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.</nowiki></span>


:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>{{gaming wikis}}</nowiki></span>
<pre>
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>[[Category:Gaming]]</nowiki></span>
The '''Super Mario Wiki''' is a wiki about the [[Super Mario (franchise)|''Super Mario'' franchise]] and its related series, [[Wario (franchise)|''Wario'']], [[Yoshi (franchise)|''Yoshi'']], [[Donkey Kong (franchise)|''Donkey Kong'']], and ''[[Super Smash Bros.]]'' It has many articles, such as ''[[Super Mario Bros.]]'', ''[[Super Mario World]]'', ''[[New Super Mario Bros.]]'', [[Bowser]], [[Extra Life]], [[Goomba]] and much more. In most of these games, such as ''New Super Mario Bros.'', the plumber [[Mario]] saves [[Princess Peach]] from Bowser, who is the main antagonist. There are over 45000 files uploaded, 90,000,000 page views, 15000 users and 14 administrators (though a few are inactive). The wiki was created on August 12th, 2005 by [[User:Porplemontage|Porplemontage]], and is now a very vibrant wiki - sustaining over 1000 edits a day. Anyone can edit, but a person must create an account to upload files or create new articles.
:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>[[Category:Wikis]]</nowiki></span>
 
{{Gaming wikis}}
[[Category:Gaming]]
[[Category:Wikis]]
</pre>
 
''would be an '''acceptable article''' on the Super Mario Wiki (if such an article were allowed). '''[[Special:Random|Now try it with a real article!]]'''''
''would be an '''acceptable article''' on the Super Mario Wiki (if such an article were allowed). '''[[Special:Random|Now try it with a real article!]]'''''


Line 112: Line 143:
An article's top-level body headings (typically level 2, surrounded by <code><nowiki>==</nowiki></code>) should not contain any links (e.g. <code><nowiki>==[[Mario]]==</nowiki></code>), since this makes the show/hide function cumbersome on mobile, and linking to the section may not work correctly. While it's always preferred to use links in the body text rather than in headings, lower-level headings may be a link when there's no convenient place for it within the section itself.
An article's top-level body headings (typically level 2, surrounded by <code><nowiki>==</nowiki></code>) should not contain any links (e.g. <code><nowiki>==[[Mario]]==</nowiki></code>), since this makes the show/hide function cumbersome on mobile, and linking to the section may not work correctly. While it's always preferred to use links in the body text rather than in headings, lower-level headings may be a link when there's no convenient place for it within the section itself.


Article sections should be separated by a blank line in wikitext, unless the line contains the {{tem|br}} template or similar. In addition, a blank line should precede the list of [[MarioWiki:Navigation templates|navigation templates]], categories, and interlanguage links, which are all grouped together at the bottom of the article.
Article sections should be separated by a blank line in wikitext, unless the line contains the {{tem|br}} template or similar. In addition, a blank line should precede the list of [[MarioWiki:Navigation templates|navigation templates]], categories, and interlanguage links, which are all grouped together at the bottom of the article. For example:
 
<pre>
==References==
<references/>
 
{{Gaming wikis}}
[[Category:Gaming]]
[[Category:Wikis]]
</pre>


===Empty sections===
===Empty sections===
{{main|MarioWiki:Empty sections}}
{{main|MarioWiki:Empty sections}}
Sections should not solely consist of a link to another page. While the <nowiki>{{main}}</nowiki> template is to be used to link to the stand-alone pages, a summary of the content (for pages like [[Glitch]] and [[Pre-release and unused content]]) or a sample of the most representative elements (for content-hoarding pages such as image galleries or quote lists) should be present.
Sections should not solely consist of a link to another page. While the <nowiki>{{main}}</nowiki> template is to be used to link to the stand-alone pages, a summary of the content (for pages like [[Glitch]] and [[Pre-release and unused content]]) or a sample of the most representative elements (for content-hoarding pages such as image galleries or quote lists) should be present.


===History===
===History===
Line 147: Line 187:
===Verb tense===
===Verb tense===
====Fiction====
====Fiction====
When writing an article describing characters, events, or locations from fictional sources (e.g. games, comics, films, TV shows, literature, etc.), present tense should be used.  
When writing an article describing characters, events, or locations from fictional sources (e.g. games, comics, films, TV shows, literature, etc.), present tense should be used.


:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>Toadsworth also appears in ''Mario & Luigi: Partners in Time''. He is with Mario and Luigi when Princess Peach takes an experimental trip back in time, and is paranoid that something terrible will happen. His fears later become justified, as when the time machine returns a Shroob is in it. Before that, however, he promptly faints, and requires a Refreshroom to revive him. He is still confused when he wakes up and accidentally pushes Mario and Luigi into a time hole. He later teams up with his younger self to teach the Bros. new moves and keep Baby Peach entertained while she stays in the future.  
<pre>
</nowiki></span>
Toadsworth also appears in ''Mario & Luigi: Partners in Time''. He is with Mario and Luigi when Princess Peach takes an experimental trip back in time, and is paranoid that something terrible will happen. His fears later become justified, as when the time machine returns a Shroob is in it. Before that, however, he promptly faints, and requires a Refreshroom to revive him. He is still confused when he wakes up and accidentally pushes Mario and Luigi into a time hole. He later teams up with his younger self to teach the Bros. new moves and keep Baby Peach entertained while she stays in the future.
</pre>


====Non-fiction====
====Non-fiction====
When writing non-fiction, such as a biography or the history of a game series, past and present tense can be used as needed, depending on whether whatever is being described has already happened or is in the process of happening.  
When writing non-fiction, such as a biography or the history of a game series, past and present tense can be used as needed, depending on whether whatever is being described has already happened or is in the process of happening.


:<span style="color:#777;font-family:Courier New;font-size:13px"><nowiki>Aside from Princess Daisy, Deanna Mustard also portrayed Baby Daisy in her debut in ''Mario Kart Wii''. She has provided voices for various minor characters throughout the ''Super Mario'' franchise as well. Mustard also voiced White Mage, a third party Square Enix character, in ''Mario Hoops 3-on-3''. Deanna Mustard has been providing Daisy's voice for more than half a decade, and continues to do so. </nowiki></span>
<pre>
Aside from Princess Daisy, Deanna Mustard also portrayed Baby Daisy in her debut in ''Mario Kart Wii''. She has provided voices for various minor characters throughout the ''Super Mario'' franchise as well. Mustard also voiced White Mage, a third party Square Enix character, in ''Mario Hoops 3-on-3''. Deanna Mustard has been providing Daisy's voice for more than half a decade, and continues to do so.  
</pre>


Future tense should be avoided when referring to subjects appearing in upcoming media; as trailers and screenshots show said subjects to have already been incorporated into and are thus ''presently'' in the game, present tense must be used.
Future tense should be avoided when referring to subjects appearing in upcoming media; as trailers and screenshots show said subjects to have already been incorporated into and are thus ''presently'' in the game, present tense must be used.