SmashWiki:Manual of Style: Difference between revisions

From SmashWiki, the Super Smash Bros. wiki
Jump to navigationJump to search
(any objections? I think not)
Line 1: Line 1:
{{guideline}}
{{guideline}}
This '''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.


==Article titles==
==Article titles==
* Article names should be in singular form, not plural.
* The titles of articles about individual characters should be the name by which the character is most commonly known in their corresponding series.
* Unless the name of the article contains (or is) a proper noun, none of the words should be capitalized except the first.


==Links==
*Titles should be singular, not plural.
*Do not use incorrect links. For example, if you are linking to ''[[Super Smash Bros. Brawl]]'', then use ''<nowiki>[[Super Smash Bros. Brawl]]</nowiki>'', not ''<nowiki>[[SSBB]]</nowiki>''. In other words, do not use abbreviations for links.
**Example: '''Item''' instead of '''Items'''
*Titles should be nouns as opposed to verbs.
**Example: '''Punishment''' instead of '''Punish'''
*If a title is not a proper noun, only the first word should be capitalized. Sometimes there is disagreement over what is a proper noun; this should be discussed on the talk page.
**Example: '''Back throw''' instead of '''Back Throw'''
*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 should be named according to how the game names them.
**Example: '''Fox McCloud''' instead of '''Fox'''
**Example: '''Fox (SSBB)''' instead of '''Fox McCloud (SSBB)'''


==Sections and headings==
==Sections/headings==
===Markup===
Use two equal signs (<nowiki>==</nowiki>) style markup for headings. Start with <nowiki>==</nowiki>, add the heading title, then end with <nowiki>==</nowiki>.


This section's heading was created with the markup:
===Levels===
*Most sections should be level two headings; that is, they are formatted with two equals signs. A subsection is one level higher than the section it is contained in.
**Example: The title of this section is formatted as <code>==Sections/headings==</code>. The subsection is formatted as <code>===Levels===</code>.


:<code><nowiki>==Sections and headings==</nowiki></code>
===Wording===
*Like article titles, headings should only be capitalized if they are proper nouns.
**Example: '''List of characters''' instead of '''List Of Characters'''
*Headings should be kept short.


This subsection's heading was created with the markup:
==Text==
 
*Long stretches of text should be broken into paragraphs. For very long strings of text, consider breaking the paragraphs into subsections.
:<code><nowiki>===Markup===</nowiki></code>
**Example: See the [[Subspace Emissary#Plot|Subspace Emissary plot summary]].


===Wording===
===Formatting===
* In a heading, '''capitalize only the first letter of the first word and the first letter of any proper nouns''', and leave all of the other letters in lowercase.
*The subject of an article should be highlighted in '''bold text''' in the first sentence of the article. Bold text should generally be avoided otherwise.
* '''Avoid putting links in headings'''.
*Names of games and other works should generally be displayed in ''italics''.
* Keep headings short.
*Coloured text is discouraged.


==Text==
==Writing style==
*Long bodies of text should be divided into paragraphs. In the case of very long bodies of text, consider dividing the content and arranging it under a number of subheadings.
*Style of writing should be semi-formal, with no silly remarks or slang.
*Language should be gender-neutral unless referring to a character or person.
*Language should be gender-neutral, unless referencing a specific character or person.
*All Pokémon should be treated as gender-neutral.
*All writing should be done in the third person.
**Example: '''the player must''' instead of '''you must'''
*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 spellings.
**Example: The following are all spelt correctly: '''canceled''', '''cancelled''', '''realize''', '''realise''', '''center''', '''centre''', '''color''', '''colour'''


===Text formatting===
==Spacing==
*''Italic text'' is used to emphasize certain words and names, though they should be used sparingly for this purpose. Game names should always be in italics. Use a pair of apostrophes (<nowiki>''</nowiki>) on either side of text you wish to italicize.
*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.
*'''Bold text''' is used to distinguish the subject of an article within the first paragraph of its content. Use three apostrophes (<nowiki>'''</nowiki>) on either side of text you wish to make bold.
**Example: Leaving a blank space between an article and its categories makes it easier to recognize the two.
*Colored text can be used sparingly, though not in very bright colours.
*The exception to the above is space between paragraphs. If there is not at least one blank line between two paragraphs, they will be treated as one single paragraph.


==Images==
==Images==
*Right-alignment is preferred to left- or center-alignment.
*Images should be right-aligned if possible.
*If there are too many images in a given article, consider making a gallery with a level two heading.
*Large images should be displayed as thumbnails, without a specified size.
*Use captions to explain the relevance of the image to the article.
*If an article has a lot of images, most of the images should be displayed in a gallery. Galleries should be listed under a level two heading (<code>==Gallery==</code>).
*Make large images a thumb.
*Specifying the size of a thumb image is not recommended.
 
=== Uploading Images ===
*Please name your files descriptively to avoid confusion. Uploading an image with the name "0239235jgjgkdgdf" will be deleted.
*'''Do not upload images we already have'''. If you plan on uploading an image, look around the Super Smash Bros. Wiki first to see if it has already been uploaded by someone else.


==Captions==
===Captions===
Complete sentences in captions should always end in a period. If the caption is not a complete sentence, it generally should not have a period at the end. Captions should also not be italicized.
*Images that are not part of an infobox should be given a caption relevant to the article.
*Captions should end with a period if and only if they are a complete sentence.
*Captions should generally avoid any formatting, though they may have links.


==Numbered lists==
===Uploading images===
Numbered lists can be used for listing steps in a process.
*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.
*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.


==Wikilinking==
==Internal links==
*Every time an article is mentioned on the page, you don't have to link to every single one. For example, [[Samus Aran]] may be mentioned five times. You only have to link to Samus Aran once. You can link to articles more than once if the page is very long.
*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.
*Use efficient link formats, especially for plurals. For example, do <nowiki>[[Item]]s instead of [[Item|Items]]</nowiki>.  
*Use efficient links, especially for plurals and verb forms.
*When including links in an article, there is no need to use capitalization or underscores, since the software produces them automatically.
**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.
**Example: Using <code><nowiki>[[SSBB]]</nowiki></code> or <code><nowiki>[[Brawl]]</nowiki></code> is fine in most cases (often table headings and infoboxes), whereas <code><nowiki>[[Super Smash Bros. Brawl]]</nowiki></code> should be used the first time it's mentioned on the page, and <code><nowiki>[[Super Smash Bros. Brawl|SSBB]]</nowiki></code> is never necessary and should be avoided
**Example: Using <code><nowiki>[[PK Thunder#PK Thunder 2|PK Thunder 2]]</nowiki></code> is an unneccessary waste of code compared to <code><nowiki>[[PK Thunder 2]]</nowiki></code>
*The capitalization of the first letter of the link does not matter, but the capitalization of the other letters does. This means that single-word links can be written for whatever capitalization is needed in the sentence, while links of two words or more cannot.
**Example: <code><nowiki>[[shield]]</nowiki></code> and <code><nowiki>[[Shield]]</nowiki></code> are equivalent
**Example: <code><nowiki>[[shield grab]]</nowiki></code> and <code><nowiki>[[Shield grab]]</nowiki></code> are equivalent, but <code><nowiki>[[Shield Grab]]</nowiki></code> is not
*When displaying an image, both <code><nowiki>[[Image:]]</nowiki></code> and <code><nowiki>[[File:]]</nowiki></code> are acceptable. Like American vs. non-American spellings, making an edit simply to change this is highly discouraged.


{{helpnav}}
{{helpnav}}

Revision as of 10:34, December 23, 2010

Guideline.png This page is a SmashWiki guideline, a principle that suggests how users should contribute and conduct themselves. When editing this page, please ensure that your revision reflects consensus. If in doubt, consider discussing changes on the talk page.

The SmashWiki Manual of Style is a style guide that aims to make the wiki easy to read, write, and understand.

Article titles

  • Titles should be singular, not plural.
    • Example: Item instead of Items
  • Titles should be nouns as opposed to verbs.
    • Example: Punishment instead of Punish
  • If a title is not a proper noun, only the first word should be capitalized. Sometimes there is disagreement over what is a proper noun; this should be discussed on the talk page.
    • Example: Back throw instead of Back Throw
  • 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 should be named according to how the game names them.
    • Example: Fox McCloud instead of Fox
    • Example: Fox (SSBB) instead of Fox McCloud (SSBB)

Sections/headings

Levels

  • Most sections should be level two headings; that is, they are formatted with two equals signs. A subsection is one level higher than the section it is contained in.
    • Example: The title of this section is formatted as ==Sections/headings==. The subsection is formatted as ===Levels===.

Wording

  • Like article titles, headings should only be capitalized if they are proper nouns.
    • Example: List of characters instead of List Of Characters
  • Headings should be kept short.

Text

  • Long stretches of text should be broken into paragraphs. For very long strings of text, consider breaking the paragraphs into subsections.

Formatting

  • The subject of an article should be highlighted in bold text in the first sentence of the article. Bold text should generally be avoided otherwise.
  • Names of games and other works should generally be displayed in italics.
  • Coloured text is discouraged.

Writing style

  • Style of writing should be semi-formal, with no silly remarks or slang.
  • Language should be gender-neutral, unless referencing a specific character or person.
  • All Pokémon should be treated as gender-neutral.
  • All writing should be done in the third person.
    • Example: the player must instead of you must
  • 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 spellings.
    • Example: The following are all spelt correctly: canceled, cancelled, realize, realise, center, centre, color, colour

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.
    • Example: Leaving a blank space between an article and its categories makes it easier to recognize the two.
  • The exception to the above is space between paragraphs. If there is not at least one blank line between two paragraphs, they will be treated as one single paragraph.

Images

  • Images should be right-aligned if possible.
  • Large images should be displayed as thumbnails, without a specified size.
  • If an article has a lot of images, most of the images should be displayed in a gallery. Galleries should be listed under a level two heading (==Gallery==).

Captions

  • Images that are not part of an infobox should be given a caption relevant to the article.
  • Captions should end with a period if and only if they are a complete sentence.
  • Captions should generally avoid any formatting, though they may have links.

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.
  • 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.

Internal links

  • Generally, only link to an article once. If "damage" is mentioned five times on a page, it should only link to [[damage]] 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.
  • Use efficient links, especially for plurals and verb forms.
    • Example: [[grab]]s instead of [[grab|grabs]]
  • 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.
    • Example: Using [[SSBB]] or [[Brawl]] is fine in most cases (often table headings and infoboxes), whereas [[Super Smash Bros. Brawl]] should be used the first time it's mentioned on the page, and [[Super Smash Bros. Brawl|SSBB]] is never necessary and should be avoided
    • Example: Using [[PK Thunder#PK Thunder 2|PK Thunder 2]] is an unneccessary waste of code compared to [[PK Thunder 2]]
  • The capitalization of the first letter of the link does not matter, but the capitalization of the other letters does. This means that single-word links can be written for whatever capitalization is needed in the sentence, while links of two words or more cannot.
    • Example: [[shield]] and [[Shield]] are equivalent
    • Example: [[shield grab]] and [[Shield grab]] are equivalent, but [[Shield Grab]] is not
  • When displaying an image, both [[Image:]] and [[File:]] are acceptable. Like American vs. non-American spellings, making an edit simply to change this is highly discouraged.