Manual of Style

From Risk of Rain Wiki
(Redirected from Manual of style)
Jump to navigation Jump to search

This is an instruction manual that addresses the editing rules used by the Risk of Rain Wiki in writing, titles, pages, and linking. Please read it before you edit any pages. However, make sure to observe current trends as well as these rules.

This manual will address all editing rules in an objective manner, though there will be cases where editing rules are subjective. If there are any unresolved disputes over what best applies to the editing rules of the Risk of Rain Wiki, please contact Starport592.

Advanced wikicode

Wikicode Guide
Besides writing pages in The Risk of Rain Wiki on factual, useful information, contributors are expected to have proper spelling and grammar and a basic knowledge of wikicode. Some of the most commonly used forms of wikicode are below. Should you forget, above the text editing box for pages are a row of buttons with many common wikicode attributes such as bolding text or adding external links.

  • Tables: Tables are started and ended with a "{" and a "|". Rows can be split with a "|" and a "-", and portions within rows can be split with vertical lines. Title headings can be done via exclamation points rather than vertical lines. For example:
{|
! Character
! Bonus Stat per Level
|-
| Commando
| N/A
|-
| Bandit
| +1.5% crit chance
|-
| Mercenary
| The Mercenary gains 2.5% attack speed per level.
|}

Will become:

Character Bonus Stat per Level
Commando N/A
Bandit +1.5% crit chance
Mercenary +2.5% attack speed

Formatting attributes can also be added to the table. The first row's attributes apply to the entire table. Attributes on the lines with vertical lines and dashes apply to that row. Attributes for just one cell can be placed before the content, divided with another vertical line. For example:

{| border="1" style="border: 1px solid #565646; border-collapse: collapse;"
|- style="background: #1E1111;"
! Character
! Bonus Stat per Level
|- style="background: #1E1111;color:#EFD27B;"
| Commando
| align="right" | N/A
|- style="background: #1E1111;color:#CD7BD7;"
| Bandit
| align="right" | +1.5% crit chance
|- style="background: #1E1111;color:#ABE2F8;"
| Mercenary
| align="right" | +2.5% attack speed
|}

Will become:

Character Bonus Stat per Level
Commando N/A
Bandit +1.5% crit chance
Mercenary +2.5% attack speed

Page titles

The rules for page titles dictate that all proper nouns are capitalized, as are all locations, and names unless specifically not capitalized. Titles are not written like book titles with most words capitalized (unless the page is about a Template:Character); note the title of this page as Manual of style, not Manual of Style.

Consistency in the titling of pages is desired in that it makes for a much more professional looking wiki with regards to the public perception of the wiki. Any page title that has a name in it should not be stored in a biographical format; i.e., "Chris Christodoulou", and not "Christodoulou, Chris" as the page title for Chris Christodoulou. For pages where only a first name (Providence) exists, the name should be used as the only title of the page.

Also, only add links once within a given part of a page; if you say "Commando" more than once in a section, only link it the first time it appears. Instances further apart from each other may be linked more than once, it is your decision on how far apart to place repeat links. For consistency, if most parts of a list are links, then link to an page as many times necessary in that list.

Disambiguation

The bracketed terms used to disambiguate pages with titles that would otherwise be the same page should be a single short word and lowercase, except when proper nouns or in-game terminology are involved.

Nouns, capitalization, and in-game terminology

  • Items and all words in pages should always capitalized; they are considered proper nouns for the style of the Risk of Rain Wiki. "Crowbar", "Will-o'-the-wisp", or "Imp Overlord's Tentacle"are all correct as written; a page would not be titled "Imp overlord's tentacle". Item/phrases should match to the in-game text, such as "All your attacks explode!" and not "All Your Attacks Explode!!!"
  • Locations should also be capitalized in a manner uniform with English grammar.
  • Regarding names and terms outside of the Risk of Rain universe, things such as names, references, or level names such be italicized and wider terms, such as names of other video game series or real-world locations should have quotation marks around them. Example, "The Legend of Zelda" and rupee.
  • In-game terminology should be properly capitalized, such as Chest, Shop, or Shrine.

Remember that consistency with the rules above is quite important, and your cooperation is always appreciated.

Style of writing: editing, bias, and opinion

Note that the Risk of Rain Wiki is designed to be a resource for encyclopedia, and as such should have the best possible level of literary style. Also as an encyclopedia, please do not use the second person view in descriptions, as this is unprofessional: "You can get the item Colossal Knurl as a boss drop" is incorrect, while "The item Colossal Knurl is a boss drop" is correct.

Check for spelling and grammatical errors before editing a page; if you notice factual or spelling errors on a page other than the ones you have created, feel free to correct the problems, as this wiki is an open project. In order to avoid arguments over factual accuracy, it is best to provide source references for controversial statements. Furthermore, personal opinion (e.g: Samson is a terrible character) should not be added to articles, no matter how popular said opinion is. Speculation should also be avoided, unless directly confirmed by Paul Morse or Duncan Drummond (Hoppo Games).

Image preferences

Images are often a useful visual addition to the content of pages. However, in some cases, it is questionable what images are appropriate for pages.

  • Please save in-game screenshots or sprite rips in .png format, and not .jpeg format.
  • If there is official artwork, such as game sprites, this is always the preferred image.
  • If there is no official artwork, such as screenshots from the game or complementary side-material, ones created by contributing users are preferred over images taken from outside sources. There will inevitably be arguments about which user-created image is proper, as there is no exact rule on such; however, the image should generally be the highest quality available and the most informative image.
  • Animated images should be avoided based with how big and distracting the animation is. Small uses, like the animation of drones or enemies are accpetable.
  • Replacing existing images is acceptable, since the wiki favors the image with the better quality, not the greater seniority. However, please avoid disputes by talking about the change with the original uploader before re-uploading the image's new version.
  • In order to keep the amount of pictures manageable, please check for similar pictures before uploading. For example: There is no need for another picture for the Command artifact, since there are already enough depicting with that topic.
  • Please refrain from uploading pictures that serve no purpose on this wiki. For anything non wiki related, use an external image host. Examples include: Pictures only meant for your User Page, screens showing items picked up during the last playthrough or a depiction of the survivor during a playthrough.
  • Proper image cropping is required. Only the Risk of Rain window should be shown, preferably without window borders.
  • Images should be placed in the page's gallery or their proper locations (such as in an item table). With certain exceptions, placing images in random locations should be avoided, as it makes the page look messy.

Formatting preferences

  • For backgrounds and templates pages, obtrusively bright colors should be avoided. Generally, the Risk of Rain Wiki style favors neutral and cool colors.

A set of pre-programmed colors have been set for use. These colors are the most preferable when formatting text:

(You can copy and paste the following code for the corresponding color)

Syntax

Sample

{{Highlight|<Text>}} Text
{{Highlight/Blue|<Text>}} Text
{{Highlight/Red|<Text>}} Text
{{Highlight/Green|<Text>}} Text
{{Highlight/Common|<Text>}} Text
{{Highlight/Uncommon|<Text>}} Text
{{Highlight/Rare|<Text>}} Text
{{Highlight/Equipment|<Text>}} Text
{{Highlight/Boss|<Text>}} Text
{{Highlight/Special|<Text>}} Text
{{Highlight/Artifact|<Text>}} Text
{{Highlight/Commando|<Text>}} Text
{{Highlight/Enforcer|<Text>}} Text
{{Highlight/Bandit|<Text>}} Text
{{Highlight/Huntress|<Text>}} Text
{{Highlight/HAN-D|<Text>}} Text
{{Highlight/Engineer|<Text>}} Text
{{Highlight/Miner|<Text>}} Text
{{Highlight/Sniper|<Text>}} Text
{{Highlight/Acrid|<Text>}} Text
{{Highlight/Mercenary|<Text>}} Text
{{Highlight/Loader|<Text>}} Text
{{Highlight/CHEF|<Text>}} Text
{{Highlight/Drizzle|<Text>}} Text
{{Highlight/Rainstorm|<Text>}} Text
{{Highlight/Monsoon|<Text>}} Text
  • Smaller tables are generally better, assuming they still have adequate information. Even small things, such as a thin 1px border, are preferred.

We at the Risk of Rain Wiki are here to create, provide, and maintain a large database filled with Risk of Rain information. Your help is appreciated more than you think.

If you would like more specific details regarding the accepted style here at the Risk of Rain Wiki, or find yourself in a situation not covered by this manual, please refer to Wikipedia's Manual of Style.