SmashWiki

SmashWiki:Manual of Style: Difference between revisions

Project page Discussion

SmashWiki:Manual of Style (view source)

Revision as of 11:37, October 9, 2024

390 bytes added ,  4 months ago
m
→‎Tournament pages: results is countable so it should be many
m (→‎Tournament pages: results is countable so it should be many)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{guideline}}
{{shortcut|[[SW:MoS]]}}
{{shortcut|[[SW:MoS]]}}
{{guideline}}
The '''SmashWiki Manual of Style''' is a style guide that aims to make the wiki easy to read, write, and understand.
The '''SmashWiki Manual of Style''' is a style guide that aims to make the wiki easy to read, write, and understand.


Line 58: Line 58:
*There is no preference whether to use American or non-American English; therefore, one should not make an edit to a page that consists of only changing such spelling/grammar. However, it is preferred to remain consistent within a section or article. Relatedly, articles on localized subjects, such as American tournaments or British players, should use the same regionalization as their subjects.
*There is no preference whether to use American or non-American English; therefore, one should not make an edit to a page that consists of only changing such spelling/grammar. However, it is preferred to remain consistent within a section or article. Relatedly, articles on localized subjects, such as American tournaments or British players, should use the same regionalization as their subjects.
**Example: The following are all spelled correctly: '''canceled''', '''cancelled''', '''realize''', '''realise''', '''center''', '''centre''', '''color''', '''colour'''
**Example: The following are all spelled correctly: '''canceled''', '''cancelled''', '''realize''', '''realise''', '''center''', '''centre''', '''color''', '''colour'''
**Example: Putting trailing punctuation inside or outside quotation marks is okay.
**Example: Putting trailing punctuation '''"inside,"''' or '''"outside",''' quotation marks is okay.
**Exception: Double quotes must be used, as single quotes are used for formatting.
**Exception: Double quotes must be used, as single quotes are used for formatting.
**Exception: Technical syntax may require a specific form of "color" or "colour".
**Exception: Technical syntax may require a specific form of "color" or "colour".
*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 something exist (regardless of region), there is no reason to change what's currently 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'''
**Example: Both '''twenty-three''' and '''23''' may be used, as can '''twenty-third''' and '''23rd''', as long as the number is not so big as to be unwieldy (such as 123).
**Exception: Numbers based on technical data (e.g. an attack's damage) should always be in "23" form.
*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.
*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.
Line 117: Line 119:
**Singles should be placed before doubles.
**Singles should be placed before doubles.
*The amount of placings expected to be documented within any bracket on a tournament page will vary depending on the size and skill depth of the tournament. There are no hard rules to this, but generally, any local level event should have at least the top 8 listed, a smaller regional should have at least the top 16 listed, a larger regional should have at least the top 32 listed, a superregional should have at least the top 48 listed, a major should have at least the top 64 listed, and a supermajor should have at least the top 96 or even top 128 listed. Any tournament with too few results reported for its level should be tagged with {{t|results}}.
*The amount of placings expected to be documented within any bracket on a tournament page will vary depending on the size and skill depth of the tournament. There are no hard rules to this, but generally, any local level event should have at least the top 8 listed, a smaller regional should have at least the top 16 listed, a larger regional should have at least the top 32 listed, a superregional should have at least the top 48 listed, a major should have at least the top 64 listed, and a supermajor should have at least the top 96 or even top 128 listed. Any tournament with too few results reported for its level should be tagged with {{t|results}}.
**On another note, there is no such thing as "too much results" on any tournament page, SmashWiki does not have a limit to how deeply a tournament's results can be documented on the wiki. In fact, the wiki should ideally have the complete results documented, as the online source for the tournament's results may not always be available in the future if a reader wants to see more of the results than what SmashWiki documents (as the many ''Brawl'' tournaments whose results were permanently lost when [[AllisBrawl]] went down can attest to). SmashWiki just does not expect any editor to extensively document results beyond a high enough cutoff, given the increasingly high amount of effort it requires to write down results with each additional placing, which would become monumental with some of the biggest supermajors that have had thousands of entrants. If an editor does want to document especially deeply into a tournament's results or even the entire tournament, the only caveat is that they should stop automatically linking players who do not have an article and will likely not merit an article in the near future, so as to not fill [[wanted pages]] with players who should not have Smasher articles. Additionally, if a tournament's results table were to get excessively large, its complete results table should be placed on a subpage, while the main page has a table with the top 64 or so listed.
**On another note, there is no such thing as "too many results" on any tournament page, SmashWiki does not have a limit to how deeply a tournament's results can be documented on the wiki. In fact, the wiki should ideally have the complete results documented, as the online source for the tournament's results may not always be available in the future if a reader wants to see more of the results than what SmashWiki documents (as the many ''Brawl'' tournaments whose results were permanently lost when [[AllisBrawl]] went down can attest to). SmashWiki just does not expect any editor to extensively document results beyond a high enough cutoff, given the increasingly high amount of effort it requires to write down results with each additional placing, which would become monumental with some of the biggest supermajors that have had thousands of entrants. If an editor does want to document especially deeply into a tournament's results or even the entire tournament, the only caveat is that they should stop automatically linking players who do not have an article and will likely not merit an article in the near future, so as to not fill [[wanted pages]] with players who should not have Smasher articles. Additionally, if a tournament's results table were to get excessively large, its complete results table should be placed on a subpage, while the main page has a table with the top 64 or so listed.
*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 and even 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, so as to not mislead which characters were actually responsible for the player's placing. Additionally, characters used by high-placing players in early pool matches should generally be ignored, as the massive skill gaps that often occur in these matches mean top and even 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 listing a [[Template:Flag|flag]] next to a player, it should not be strictly based on their birth country nor where they have official citizenship, but rather their country of permanent residence at the time the tournament took place. For example, {{Sm|ZeRo}} is from [[Chile]], but immigrated to the [[United States]] by the end of 2013, so all tournament results from before 2014 should have him listed with the Chilean flag, but all tournaments after that point should use the American flag for him in their results instead. In a more extreme example, {{Sm|Hungrybox}} was born in [[Argentina]], but has resided in the United States for most of his life, including for his entire ''Smash'' career, and thus all of his results on the wiki should have him listed with the American flag rather than the Argentine flag, despite him not becoming an American citizen until 2017.
*When listing a [[Template:Flag|flag]] next to a player, it should not be strictly based on their birth country nor where they have official citizenship, but rather their country of permanent residence at the time the tournament took place. For example, {{Sm|ZeRo}} is from [[Chile]], but immigrated to the [[United States]] by the end of 2013, so all tournament results from before 2014 should have him listed with the Chilean flag, but all tournaments after that point should use the American flag for him in their results instead. In a more extreme example, {{Sm|Hungrybox}} was born in [[Argentina]], but has resided in the United States for most of his life, including for his entire ''Smash'' career, and thus all of his results on the wiki should have him listed with the American flag rather than the Argentine flag, despite him not becoming an American citizen until 2017.
**Conversely, if a player is only living in another country on a short term temporary basis, such as on a visitor visa or for a short university stint, their flag should not be changed.
**Conversely, if a player is only living in another country on a short term temporary basis, such as on a visitor visa or for a short university stint, their flag should not be changed.
Line 125: Line 127:


==See also==
==See also==
[[/Words to Watch|Words to Watch]]
*[[/Words to Watch|Words to Watch]]


{{helpnav}}
{{helpnav}}
Retrieved from "https://www.ssbwiki.com/Special:MobileDiff/1822454...1929664"