Brawlhalla Wiki:Manual of Style

This page is a work in progress
 * See also: Brawlhalla Wiki:Rules

The following is a list of general rules to follow when adding content to articles. These rules are specific to the Brawlhalla Wiki. For style rules regarding Gamepedia articles in general, see the Gamepedia Manual of Style.

General guidelines

 * Articles must not contain personal opinions.
 * When writing about common thoughts or popular opinions strongly associated with the subject of the article, it should be placed in the designated Trivia section and must be clear that the topic is not fact.


 * Names for any item within Brawlhalla must be written using the same capitalization as seen in-game.

Grammar

 * Articles must be written in formal, proper American English as is used in-game.
 * All text retrieved from the game (lore, names, store descriptions, etc.) must retain its in-game form in all cases. This means any cannon error should not be corrected.

Bullet-point lists
Bullet-point lists usually contain brief pieces of information. Typically, bullet-point lists are used when information is not broad enough to include in paragraph form.

Bullet-point lists may also be used if there is a plethora of information that would be too long for paragraphs.

Out-of-game information
Some information on this wiki does not come directly from the game. When writing about information that cannot be found in-game, a citation is not needed. Unless the source is in some way included in the article itself, at the very least, a source should be provided in the edit summary.

Strategy
When writing about strategy, the tone of the section must portray its information as subjective and not fact. It must also be clear that the following information pertains to strategy and not mechanic.

Maintenance headers
Maintenance headers should appear at the very top of the article, just under the title. They must be nonintrusive, yet noticeable. They must clearly indicate the issue at hand and also provide a potential solution.

Maintenance headers should be created using the &#0123;{ambox}} template.

Disambiguation
Disambiguations are brief, italicized messages that inform the reader of another article with a similar name. Disambiguations must appear before the infobox and the body of the article.

Disambiguations should be created using the &#0123;{DisambigMsg}} template.

Trivia
Trivia are small pieces of information that do not fit in an existing paragraph and are not crucial enough to constitute their own separate paragraphs. Trivia should be placed in a designated Trivia section and should not take up more than two sentences per fact. Information in the Trivia section should be displayed in bullet point format.

Article layout
Articles should be arranged in the following order.


 * 1) Maintenance headers
 * 2) Disambiguation
 * 3) Infobox
 * 4) Body
 * 5) Trivia section
 * 6) See Also section

Some articles may not contain every item on this list, in which case any item may be omitted, as long as any present item is properly ordered.

Legend articles
The sections of the body in articles depicting Legends should be arranged in the following order.


 * 1) Lead paragraph(s)
 * 2) Lure
 * 3) 
 * 4) As the story goes
 * 5) Signature Moves
 * 6) List of Skins

Some articles may not contain every item on this list, in which case any item may be omitted, as long as any present item is properly ordered.

Images

 * Images with forced aspect ratios, such as Weapon infobox images requiring a square aspect ratio, must be centered, fitted snug to the edges, and have no unnecessary gaps on any side of the image.
 * Initially, animated objects, such as Legend or weapon skins and Sidekicks, should use the APNG format to ensure quality. However, due to a bug in the system, APNGs do not animate correctly. In the meantime, GIFs should be used until the APNG problem is ever fixed.

Images in infoboxes

 * Images of solely weapons or weapon skins, as seen in the infoboxes of their respective articles, must be rendered using the in-game image rendering tool, have transparent backgrounds, and must not be altered in such a way that changes its design, orientation, color, or any other crucial attribute.
 * These images must have an aspect ratio of 1:1 (square). To do this, transparent space should be added to each of the long sides of the image until the short sides and the long sides become the same length.
 * These images preferably have a resolution of 1280x1280px.


 * Images of solely Legends or Legend skins, as seen in the infoboxes of their respective articles, should depict the Legend in their idle stance, have transparent backgrounds, and must not be altered in such a way that changes its design, orientation, color, or any other crucial attribute.
 * If the Legend's idol stance does a poor job of representing the look of the Legend or skin, the lock-in stance may be used.
 * For Epic Skins, the image should depict the idol stance (or lock-in stance) of the specific skin, not the subsequent stance for the base Legend.
 * Where possible, these images must be rendered using the in-game image rendering tool.
 * Preferably, the long edge of these images should have a length of 1280px.


 * All infobox images must be large enough such that scaling them to their appropriate sizes is not blurry and retains important detains.

Flag images
Images of flags are primarily to indicate which region a Professional Player represents but may be used for other purposes as see fit.


 * Images of nation flags must be in the SVG format.
 * All text that may appear on a nation's flag must have a specific "path object" for each glyph.
 * What this means, there should be no copiable text that requires an external font or typeface to render correctly. eg. Every glyph that makes up the text on the Brazillian flag which reads "ORDEM E PROGRESSO" must be a separate object, and must not be plain text with a font applied to it. This ensures each flag displays correctly and accurately without an outside dependency on a font.

Naming

 * File names should clearly indicate what the file represents, have no spelling errors, and have consistent naming conventions across relative files.
 * Assets from the game files may keep their asset names if the asset has not been manually rendered or edited.

Cannon error
A cannon error is a spelling or grammatical error that appears in-game. These errors include, but are not limited to, typos, missing punctuation, and improper capitalization that appear in the Lore or Store Descriptions within Brawlhalla.

For example, the Store Description for Isaiah includes the excerpt "...all in a days work." Grammatically, this excerpt is missing the apostrophe in the word "day's." Since this error appears in-game, it is considered a cannon error.