HighSpell Wiki/Style Guide: Difference between revisions
Created page with "Below is the style guide for the HighSpell Wiki. * Articles written using Amercian English are preferred over other forms of English. ** E.g. Using the word "color" instead of "colour". * Capitalize article page titles according to [https://apastyle.apa.org/style-grammar-guidelines APA style guidelines]. ** E.g. "Sewer Rat" instead of "Sewer rat". ** [https://capitalizer.spegal.dev Click here for a capitalization tool.] * Use a plural noun as an article's title..." |
mNo edit summary |
||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Below is the style guide for the [[HighSpell Wiki]]. | Below is the style guide for the [[Main Page|HighSpell Wiki]]. | ||
* Articles written using | * All article titles and spellings should mirror how they appear in-game first and foremost. | ||
** E.g. Using the word "color" instead of "colour". | ** E.g. "[[Helmet Of Melee]]" is how it appears in game, versus "Helmet of Melee". | ||
* Articles written using American English are preferred over other forms of English. | |||
** E.g. Using the word "[[Chat Colors|color]]" instead of "colour". | |||
* Capitalize article page titles according to [https://apastyle.apa.org/style-grammar-guidelines APA style guidelines]. | * Capitalize article page titles according to [https://apastyle.apa.org/style-grammar-guidelines APA style guidelines]. | ||
** E.g. "[[Sewer Rat]]" instead of "Sewer rat". | ** E.g. "[[Sewer Rat]]" instead of "Sewer rat". | ||
| Line 8: | Line 10: | ||
* Use a plural noun as an article's title if the subject sounds more natural when grouped together. | * Use a plural noun as an article's title if the subject sounds more natural when grouped together. | ||
** E.g. "[[Bronze Arrows]]" instead of "Bronze Arrow". | ** E.g. "[[Bronze Arrows]]" instead of "Bronze Arrow". | ||
* Avoid placing images directly within paragraphs, as they can disrupt readability. Images should primarily be used in tables or designated image sections to maintain a clean and easy-to-follow layout. | |||
** E.g. "The Goblin can drop [[Copper Ore]] sometimes." instead of "The Goblin can drop {{ItemIcon|Copper Ore|size=24px}} sometimes." | |||
* Italicise titles of works. | * Italicise titles of works. | ||
** E.g. "HighSpell is an online multiplayer game." | ** E.g. "''[[HighSpell]]'' is an online multiplayer game." | ||
* Link a keyword the first time it appears in each main section; even if it's a link to the current page. If the page has multiple main sections, repeat the link in each one. | * Link a keyword the first time it appears in each main section; even if it's a link to the current page. If the page has multiple main sections, repeat the link in each one. | ||
** E.g. "[[Water Obelisk Teleport]] is a [[Magic]] spell that requires special scrolls and level 40 Magic to cast." | ** E.g. "[[Water Obelisk Teleport]] is a [[Magic]] spell that requires special scrolls and level 40 Magic to cast." | ||
* Avoid including punctuation in link text unless the punctuation is part of the noun itself. | * Avoid including punctuation in link text unless the punctuation is part of the noun itself. | ||
** E.g. "Here's an article about [[squirrel|squirrels]]! Did you know that squirrels like to climb up [[Tree|trees]]?" | ** E.g. "Here's an article about [[squirrel|squirrels]]! Did you know that squirrels like to climb up [[Tree|trees]]?" | ||
* Prefer numerals with Western delimiting commas over written numbers. | * Prefer numerals with Western delimiting commas over written numbers when the value is eleven (11) or higher. | ||
** E.g. "50,000" instead of "fifty-thousand". | ** E.g. "50,000" instead of "fifty-thousand". | ||
* Use the DD | * Unless representing a specific item quantity or cost, in which case numerals under eleven are acceptable for clarity. | ||
* Use the 'Month Day, Year' format for dates (e.g., | ** E.g. "5 ×{{ItemIcon|Fire Scroll|size=24px}}" instead of "Five ×{{ItemIcon|Fire Scroll|size=24px}}" | ||
* Use the <code><nowiki>{{Stub}}</nowiki></code> template at the end of articles that are sparse and need more content. | * Use the MM-DD-YYYY format for numerical dates (e.g., 04-20-2021). | ||
* Use the <code><nowiki>{{Item}}</nowiki></code> template at the beginning of articles about in-game items. | * Use the 'Month Day, Year' format for dates (e.g., April 20th, 2021). | ||
* Use the <code><nowiki>{{NPC}}</nowiki></code> template at the beginning of articles about in-game [[Non-player | * Use the <code style="border: 1px solid var(--border-color-base) !important; background: var(--bg-contrast) !important;"><nowiki>{{Stub}}</nowiki></code> template at the end of articles that are sparse and need more content. | ||
* Use the <code><nowiki>{{Shop}}</nowiki></code> template at the beginning of articles about in-game [[shops]]. | * Use the <code style="border: 1px solid var(--border-color-base) !important; background: var(--bg-contrast) !important;"><nowiki>{{Item}}</nowiki></code> template at the beginning of articles about in-game items. | ||
* Use the <code><nowiki>{{Update}}</nowiki></code> template at the beginning of articles that consist of an official news post copied verbatim from [https://highspell.com HighSpell's website]. | * Use the <code style="border: 1px solid var(--border-color-base) !important; background: var(--bg-contrast) !important;"><nowiki>{{NPC}}</nowiki></code> template at the beginning of articles about in-game [[Non-player Character|NPCs]]. | ||
* Use the <code style="border: 1px solid var(--border-color-base) !important; background: var(--bg-contrast) !important;"><nowiki>{{Shop}}</nowiki></code> template at the beginning of articles about in-game [[shops]]. | |||
* Use the <code style="border: 1px solid var(--border-color-base) !important; background: var(--bg-contrast) !important;"><nowiki>{{Update}}</nowiki></code> template at the beginning of articles that consist of an official news post copied verbatim from [https://highspell.com HighSpell's website]. | |||
* Use descriptive file names. | * Use descriptive file names. | ||
** E.g. "Frost Warrior.jpg" instead of "screenshot_8642049_4869nice94.jpg". | ** E.g. "Frost Warrior.jpg" instead of "screenshot_8642049_4869nice94.jpg". | ||