SmashWiki:Manual of Style: Difference between revisions

no edit summary
(→‎Tournament pages: Should make a note about character usage in pools.)
No edit summary
Line 13: Line 13:
*Titles should conform to what is most commonly used and understood, [[SW:OFFICIAL|not necessarily what is official]]. In other words, terms should be referred to as they make the most sense within the community (e.g. "[[tilt attack]]s" or "tilts" as opposed to "[[strong attack]]s").
*Titles should conform to what is most commonly used and understood, [[SW:OFFICIAL|not necessarily what is official]]. In other words, terms should be referred to as they make the most sense within the community (e.g. "[[tilt attack]]s" or "tilts" as opposed to "[[strong attack]]s").
**Example: '''Tech''' instead of '''Ukemi''', as while the latter is an official term, players universally use the former.
**Example: '''Tech''' instead of '''Ukemi''', as while the latter is an official term, players universally use the former.
**Example: '''Glancing blow''' instead of '''phantom hit''', as while some players use the latter, the former is a widely-recognized official term.
**Example: '''Glancing blow''' instead of '''phantom hit''', as while some players use the latter, the former is a widely recognized official term.
*General character articles (those that focus on a character as they are outside of the ''Smash Bros.'' series) should be named according to how the character is most commonly known in their originating series. On the other hand, articles about playable characters' appearances in the ''Smash'' series should be named according to how the game names them.
*General character articles (those that focus on a character as they are outside of the ''Smash Bros.'' series) should be named according to how the character is most commonly known in their originating series. On the other hand, articles about playable characters' appearances in the ''Smash'' series should be named according to how the game names them.
**Example: '''Fox McCloud''' instead of '''Fox'''
**Example: '''Fox McCloud''' instead of '''Fox'''
Line 34: Line 34:
==Text==
==Text==
*Long stretches of text should be broken into paragraphs. For very long strings of text, consider breaking the paragraphs into subsections.
*Long stretches of text should be broken into paragraphs. For very long strings of text, consider breaking the paragraphs into subsections.
**Example: See the [[Plot summary of the Subspace  Emissary]].
**Example: See the [[Plot summary of The Subspace  Emissary]].
*Disambiguation pages should be ordered in terms of relevancy (such as playable characters being prioritized over other entities with similar-sounding names/handles. An example: [[Cloud Strife]] being prioritized over [[Cloud9]]).
*Disambiguation pages should be ordered in terms of relevancy (such as playable characters being prioritized over other entities with similar-sounding names/handles. An example: [[Cloud Strife]] being prioritized over [[Cloud9]]).


Line 63: Line 63:
*Likewise, when multiple acceptable variants of a word exist (regardless of region), there is no reason to change the word written on a page into another variant of it.
*Likewise, when multiple acceptable variants of a word exist (regardless of region), there is no reason to change the word written on a page into another variant of it.
**Example: The following are both spelled correctly: '''Samus{{'}}''', '''Samus's'''
**Example: The following are both spelled correctly: '''Samus{{'}}''', '''Samus's'''
*When referring to differences in games based on geographical region, "NTSC" is used for the North America region and "PAL" is used for the Europe region. While this terminology may be antiquated, its meaning is generally understood, and it is much shorter and cleaner than alternatives.
*When referring to differences in games based on geographical region, "NTSC" is used for the Americas and Japan region and "PAL" is used for the Europe and Australia region. While this terminology may be antiquated, its meaning is generally understood, and it is much shorter and cleaner than alternatives.
*As the ''Smash Bros.'' series was developed in Japan, all its underlying data is coded in metric units. Therefore, when referring to in-game measurements, always use metric first, followed by an imperial measurement if necessary.
*As the ''Smash Bros.'' series was developed in Japan, all its underlying data is coded in metric units. Therefore, when referring to in-game measurements, always use metric first, followed by an imperial measurement if necessary.
**Example: "Hit Sandbag '''1000 m (3280 ft.)''' or more in Home-Run Contest."
**Example: "Hit Sandbag '''1000 m (3280 ft.)''' or more in Home-Run Contest."
Line 76: Line 76:


==Spacing==
==Spacing==
*Generally, spacing does not matter to readers of an article (the software removes most extra spacing); however it can have a large impact on the readability of the code when one is trying to edit the page. The code should have enough spacing to make the coding clear while not taking up too much room.
*Generally, spacing does not matter to readers of an article (the software removes most extra spacing); however, it can have a large impact on the readability of the code when one is trying to edit the page. The code should have enough spacing to make the coding clear while not taking up too much room.
**Example: It does not matter whether one uses one space or two spaces between sentences, as both are reduced to one space.
**Example: It does not matter whether one uses one space or two spaces between sentences, as both are reduced to one space.
**Example: Leaving a blank space between an article and its categories makes it easier to recognize the two.
**Example: Leaving a blank space between an article and its categories makes it easier to recognize the two.
**Exception: If there is not at least one blank line between two paragraphs, they will be treated as one single paragraph.
**Exception: If there is not at least one blank line between two paragraphs, they will be treated as one single paragraph.
**Exception: More than two consecutive blank lines may leave a proportionally-sized blank space on the page.
**Exception: More than two consecutive blank lines may leave a proportionally sized blank space on the page.
**Exception: Complex tables and templates can be very picky at times when it comes to spaces and returns. Be mindful and always preview edits of such pages.
**Exception: Complex tables and templates can be very picky at times when it comes to spaces and returns. Be mindful and always preview edits of such pages.


Line 95: Line 95:
===Uploading images===
===Uploading images===
*Avoid uploading duplicate images. If the intent is to replace an existing image, discuss the change first, then upload the new image on top of the old one (if possible).
*Avoid uploading duplicate images. If the intent is to replace an existing image, discuss the change first, then upload the new image on top of the old one (if possible).
*Images should be named descriptively. A name such as "00293347.jpg" is not useful and will lead to the image being either moved or deleted.
*Images should be named descriptively. A name such as "00293347.jpg" is not useful and may lead to the image being either moved or deleted.


==Internal links==
==Internal links==
*Generally, only link to an article once. If "damage" is mentioned five times on a page, it should only link to <code><nowiki>[[damage]]</nowiki></code> the first time. The exception is if the page is very long, in which case it can be linked again near the start of a later section. If helpful to readers, links may be repeated in infoboxes, tables, images, image captions, and footnotes.  
*Generally, only link to an article once. If "damage" is mentioned five times on a page, it should only link to <code><nowiki>[[damage]]</nowiki></code> the first time. The exception is if the page is very long, in which case it can be linked again near the start of a later section. If helpful to readers, links may be repeated in infoboxes, tables, images, image captions, and footnotes.  
*Use efficient links, especially for plurals and verb forms.
*Use efficient links, especially for plurals and verb forms.
**There are [[:Category:Shortcut templates|many different templates]] that can be used to allow links to be shortened so they avoid taking up too much space, including: {{t|SSB}}, {{t|SSBM}}, {{t|SSBB}}, {{t|SSB4}}, {{t|s}}, {{t|b}}, {{t|Sm}}, and {{t|t}}.
**There are [[:Category:Shortcut templates|many different templates]] that can be used to allow links to be shortened so they avoid taking up too much space, including: {{t|SSB}}, {{t|SSBM}}, {{t|SSBB}}, {{t|SSB4}}, {{t|SSBU}}, {{t|s}}, {{t|b}}, {{t|Sm}}, and {{t|t}}.
**Example: <code><nowiki>[[grab]]s</nowiki></code> instead of <code><nowiki>[[grab|grabs]]</nowiki></code>
**Example: <code><nowiki>[[grab]]s</nowiki></code> instead of <code><nowiki>[[grab|grabs]]</nowiki></code>
*Similarly to the above, linking to a redirect that is an abbreviation or a redirect that links to a section of another page is acceptable (and often preferred), unless an abbreviation isn't appropriate in the context.
*Similarly to the above, linking to a redirect that is an abbreviation or a redirect that links to a section of another page is acceptable (and often preferred), unless an abbreviation isn't appropriate in the context.
Line 116: Line 116:
**Games should be ordered by release date. Non-Smash Bros. events and modded games go at the end.
**Games should be ordered by release date. Non-Smash Bros. events and modded games go at the end.
**Singles should be placed before doubles.
**Singles should be placed before doubles.
*When reporting which characters a player used in a tournament, it is standard to not list every character the player chose over the tournament, but only list characters that were used to win a game in a won set. Additionally, characters used by high-placing players in early pool matches should generally be ignored, as the massive skill gaps that typically occur in these matches means top/high level players will typically win these matches regardless of their effort and so a character they may have [[sandbagging|sandbagged]] with in these matches does not truly reflect the characters that legitimately contributed to their final placing.
*When reporting which characters a player used in a tournament, it is standard to not list every character the player chose over the tournament, but only list characters that were used to win a game in a won set. Additionally, characters used by high-placing players in early pool matches should generally be ignored, as the massive skill gaps that typically occur in these matches mean top/high level players will typically win these matches regardless of their effort and so a character they may have [[sandbagging|sandbagged]] with in these matches does not truly reflect the characters that legitimately contributed to their final placing.
*When ordering players who are tied, the order should be as given in the tournament's official bracket, or if there is none easily available, in the order they were eliminated.
*When ordering players who are tied, the order should be as given in the tournament's official bracket, or if there is none easily available, in the order they were eliminated.