August:Style guide: Difference between revisions
No edit summary |
|||
(8 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
Pages must have appropriate titles. Names, locations, and titles should all be capitalised, '''though not the whole title'''. Block capitals should not be used in titles (e.g. 'Article titles' instead of 'ARTICLE TITLES'). Try to make the article's topic the subject of the first sentence in the article. For example, write "This style manual is a style guide" instead of "This style guide is known as...". | Pages must have appropriate titles. Names, locations, and titles should all be capitalised, '''though not the whole title'''. Block capitals should not be used in titles (e.g. 'Article titles' instead of 'ARTICLE TITLES'). Try to make the article's topic the subject of the first sentence in the article. For example, write "This style manual is a style guide" instead of "This style guide is known as...". | ||
'''Articles about items, monsters, quests, and non-player characters should be titled exactly as the subject's name appears in-game.''' A rule of thumb for article titles is that items only have the first letter of the first word in their name capitalized. There is no capitalization convention for monsters or non-player characters. Unless the monster or character's name has more than one capital in-game, do not put a capital at the beginning of every word. This is a common mistake which often causes broken links and time being diverted to moving these pages. If you are in doubt about a name, please check it in-game. If you come across a page with an incorrect title, please reach out to [[User:Bark]] or [[User:Steve]]. | '''Articles about items, monsters, quests, and non-player characters should be titled exactly as the subject's name appears in-game.''' A rule of thumb for article titles is that items only have the first letter of the first word in their name capitalized. There is no capitalization convention for monsters or non-player characters. Unless the monster or character's name has more than one capital in-game, do not put a capital at the beginning of every word. This is a common mistake which often causes broken links and time being diverted to moving these pages. | ||
If you are in doubt about a name, please check it in-game. If you come across a page with an incorrect title, please reach out to [[User:Bark|Bark]] or [[User:Steve|Steve]]. | |||
'''Words such as articles and short prepositions in titles should be left un-capitalised'''. These include words such as 'a', 'the', and 'of'. For example, the article on the ''Tombs of Amascut'' has the title 'Tombs of Amascut' (the 'of' is left un-capitalised). | '''Words such as articles and short prepositions in titles should be left un-capitalised'''. These include words such as 'a', 'the', and 'of'. For example, the article on the ''Tombs of Amascut'' has the title 'Tombs of Amascut' (the 'of' is left un-capitalised). | ||
Line 36: | Line 38: | ||
==Text elements== | ==Text elements== | ||
===Font colours=== | ===Font colours=== | ||
Colored font can be used '''sparingly''', though not in very bright colors. For example, you can use a dark color for a warning. Note that certain colors will not show up well against the article's background. | |||
===Invisible comments=== | ===Invisible comments=== | ||
Line 78: | Line 80: | ||
All prose, including bold text at the beginning of articles, should conform to standard [[wikipedia:Capitalization_in_English|capitalization in English]]. | All prose, including bold text at the beginning of articles, should conform to standard [[wikipedia:Capitalization_in_English|capitalization in English]]. | ||
;Proper nouns | ;Proper nouns | ||
* Proper nouns are to be | * Proper nouns are to be capitalized. The following is a non-exhaustive list of proper nouns: | ||
:For example: the [[King Black Dragon]] is a black dragon; the [[Kraken]] is a [[Slayer]] boss. | :For example: the [[King Black Dragon]] is a black dragon; the [[Kraken]] is a [[Slayer]] boss. | ||
* Common nouns, such as the names of most | * Common nouns, such as the names of most items and monsters, are to be lower case. If an item name contains a proper noun, the proper noun should be capitalized. For example, [[helm of Neitiznot]] | ||
;Notes & Exceptions | ;Notes & Exceptions | ||
* When mentioning a skill, it should always be mentioned by its proper name. For example, "Winter can be melted by lighting the brazier, requiring level 10 [[Firemaking]]." | * When mentioning a skill, it should always be mentioned by its proper name. For example, "Winter can be melted by lighting the brazier, requiring level 10 [[Firemaking]]." | ||
Line 90: | Line 92: | ||
===Punctuation=== | ===Punctuation=== | ||
Punctuation marks like semicolons, brackets, and commas are essential for clarity, structure, and emphasis in writing guides and editing pages. They help organize ideas, prevent misunderstandings, and enhance the professionalism of the text. | Punctuation marks like semicolons, brackets, and commas are essential for clarity, structure, and emphasis in writing guides and editing pages. They help organize ideas, prevent misunderstandings, and enhance the professionalism of the text. | ||
;Commas | ;Commas | ||
If you are listing multiple things, like different runes, each of them should have a comma at the end. I don't give a shit about the Oxford comma or not, so do whichever you want. | If you are listing multiple things, like different runes, each of them should have a comma at the end. '''I don't give a shit about the Oxford comma or not, so do whichever you want.''' | ||
*For example, "fire runes, earth runes, and water runes" or "fire runes, earth runes and water runes". Whatever your heart desires. | |||
For example, "fire runes, earth runes, and water runes" or "fire runes, earth runes and water runes". Whatever your heart desires | |||
;Semicolons | ;Semicolons | ||
If you are writing and need to use semicolons, make sure you follow these guidelines: | If you are writing and need to use semicolons, make sure you follow these guidelines: | ||
* Make sure there are two short independent clauses you can link. For example, "[[User:Steve]] is hungry; he needs a [ | * Make sure there are two short independent clauses you can link. For example, "[[User:Steve|Steve]] is hungry; he needs a [https://www.youtube.com/shorts/AynYAvxNVGM chicken burger]." | ||
* Place a semicolon before conjunctive adverbs (e.g., however, therefore) when they are linked to independent clauses. | * Place a semicolon before conjunctive adverbs (e.g., however, therefore) when they are linked to independent clauses. | ||
* Use semicolons to separate items in a list when the items themselves contain commas. For example, "The [[Slayer]] skill involves talking to | * Use semicolons to separate items in a list when the items themselves contain commas. For example, "The [[Slayer]] skill involves talking to Slayer masters, the low-tier slayer master; [[Slayer master#Turael]], the mid-tier; [[Slayer_master#Vanakka]], the high-tier [[Slayer_master#Nieve]]; and [[Nixite]], the end-game tier master." | ||
===Tense=== | ===Tense=== | ||
A rule of thumb is to use present tense in all cases. For example, articles for skills, activities, non-player characters, etc. should be written in present tense. An exception to this rule would be events that have occurred in the past, or for in-game content that has been removed. For example, holiday events that have already occurred should be written in past tense. For future updates and upcoming content that have been confirmed by Jagex, use the future tense. | A rule of thumb is to use present tense in all cases. For example, articles for skills, activities, non-player characters, etc. should be written in present tense. An exception to this rule would be events that have occurred in the past, or for in-game content that has been removed. For example, holiday events that have already occurred should be written in past tense. For future updates and upcoming content that have been confirmed by Jagex, use the future tense. | ||
Line 116: | Line 112: | ||
* '''Present tense:''' All other cases | * '''Present tense:''' All other cases | ||
=== | ===Common grammatical errors=== | ||
I'm not going to explain every single one of these. Do your best. | |||
''' | '''their''' there '''they're''' | ||
:Don't fuck these up. We will make fun of you. | |||
: | |||
'''its''' and '''it's''' | '''its''' and '''it's''' | ||
Line 138: | Line 122: | ||
::"He chose this area for <u>its</u> atmosphere." | ::"He chose this area for <u>its</u> atmosphere." | ||
*''it's''' is a contraction (shortcut) for '''it is''' OR '''it has'''. | |||
**it is – "It's your fault." | |||
**it has – "It's been a hot day." | |||
'''should of''' | '''should of''' | ||
:The reason people write "should of" when they mean '''should have''' is because the contraction of '''should have''' (should've) is pronounced like "should of". Avoid "should of" like the plague. Instead, write "should have". | :The reason people write "should of" when they mean '''should have''' is because the contraction of '''should have''' (should've) is pronounced like "should of". Avoid "should of" like the plague. Instead, write "should have". | ||
::"Those rookie editors made the mistake of writing 'should of' when they meant 'should have'". | ::"Those rookie editors made the mistake of writing 'should of' when they meant 'should have'". | ||
'''much''' and '''many''' | '''much''' and '''many''' | ||
Line 167: | Line 136: | ||
'''alter''' and '''altar''' | '''alter''' and '''altar''' | ||
:An '''altar''' is a piece of furniture used in | :An '''altar''' is a piece of furniture used in Prayer. To '''alter''' is to change something. | ||
'''affect''' and '''effect''' | '''affect''' and '''effect''' | ||
Line 173: | Line 142: | ||
'''your '''and '''you're''' | '''your '''and '''you're''' | ||
: | :Good luck | ||
'''duel '''and '''dual''' | '''duel '''and '''dual''' | ||
: | :The gambling addicts ask if we have the Duel Arena. | ||
:You would '''dual'''-wield two swords, or have a '''dual '''personality, meaning you have | :You would '''dual'''-wield two swords, or have a '''dual '''personality, meaning you have bugs in your skin. | ||
==Images== | ==Images== | ||
* Most images should exist already. If an image does not exist, ask first, as we should have access to sprites for all images that will look better than trying to take a screenshot in-game. | |||
===Uploading images=== | ===Uploading images=== | ||
* The preferred formats for images are | * The preferred formats for images are <code>.PNG</code>. | ||
* Images of items should have a transparent background. | * Images of items should have a transparent background. | ||
* Personal images | * Personal images should not be uploaded. Images should be able to be used on main space articles, else they will be deleted. | ||
* Please name your files descriptively to avoid confusion. For example if you are uploading a picture of a weapon, name it ''Rune longsword.png'' and not just ''Sword.png'' or ''RL.png''. | * Please name your files descriptively to avoid confusion. For example if you are uploading a picture of a weapon, name it ''Rune longsword.png'' and not just ''Sword.png'' or ''RL.png''. | ||
* '''Don't upload images we already have'''. | * '''Don't upload images we already have'''. Before you upload an image, search the wiki if someone has already uploaded a version of it. We don't need <code><nowiki>[[File:Fire rune.PNG]]</nowiki></code> or <code><nowiki>[[File:Fire rune.gif]]</nowiki></code> if someone has already uploaded <code><nowiki>[[File:Fire Rune.PNG]]</nowiki></code>. | ||
**If you're unsure if an image exists, ask! | |||
==Links== | ==Links== | ||
=== | ===Internal links=== | ||
* You don't have to link every single mention within an article. For example, [[Slayer]] may be mentioned five times. You only have to link to Slayer once. You can link to articles more than once if the page is very long. | * You don't have to link every single mention within an article. For example, [[Slayer]] may be mentioned five times. You only have to link to Slayer once. You can link to articles more than once if the page is very long. | ||
* When a skill is linked to, the name of the skill should be used, not a short form or a different spelling of it. Instead of saying "<code><nowiki>this item can be [[Mining|mined]] by...</nowiki></code>" you should state "<code><nowiki>this item can be obtained through the [[Mining]] skill by ...</nowiki></code>". | * When a skill is linked to, the name of the skill should be used, not a short form or a different spelling of it. Instead of saying "<code><nowiki>this item can be [[Mining|mined]] by...</nowiki></code>" you should state "<code><nowiki>this item can be obtained through the [[Mining]] skill by ...</nowiki></code>". | ||
Line 214: | Line 168: | ||
* When including wiki-links in an article, there is no need to use underscores or initial capitalization, since the software produces them automatically. For example, <code><nowiki>[[fire_rune]]</nowiki></code> and <code><nowiki>[[Fire rune]]</nowiki></code> work the same as <code><nowiki>[[fire rune]]</nowiki></code>. | * When including wiki-links in an article, there is no need to use underscores or initial capitalization, since the software produces them automatically. For example, <code><nowiki>[[fire_rune]]</nowiki></code> and <code><nowiki>[[Fire rune]]</nowiki></code> work the same as <code><nowiki>[[fire rune]]</nowiki></code>. | ||
* Do not place the last letters of a plural outside of a link that already has alternate text. For example, <code><nowiki>[[cow|cows]]</nowiki></code> should be used instead of <code><nowiki>[[cow]]s</nowiki></code>. | * Do not place the last letters of a plural outside of a link that already has alternate text. For example, <code><nowiki>[[cow|cows]]</nowiki></code> should be used instead of <code><nowiki>[[cow]]s</nowiki></code>. | ||
===External links=== | ===External links=== | ||
Line 227: | Line 177: | ||
===Ownership and bias=== | ===Ownership and bias=== | ||
* '''Keep personal bias out of articles.''' Even if "Mining is for noobs" or "Smithing is awesome", we do not need to hear it in the articles. | * '''Keep personal bias out of articles.''' Even if "Mining is for noobs" or "Smithing is awesome", we do not need to hear it in the articles. | ||
Latest revision as of 14:32, 17 August 2025
This style guide has the simple purpose of making the August Wiki easy to read by establishing a certain format. There are many ways to write a Wiki, but if everyone does things the same way, the articles will be easier to read and use, along with being easier to write and edit. Reading the style guide is important to ensure that each user's edits will be consistent.
Article titles
Pages must have appropriate titles. Names, locations, and titles should all be capitalised, though not the whole title. Block capitals should not be used in titles (e.g. 'Article titles' instead of 'ARTICLE TITLES'). Try to make the article's topic the subject of the first sentence in the article. For example, write "This style manual is a style guide" instead of "This style guide is known as...".
Articles about items, monsters, quests, and non-player characters should be titled exactly as the subject's name appears in-game. A rule of thumb for article titles is that items only have the first letter of the first word in their name capitalized. There is no capitalization convention for monsters or non-player characters. Unless the monster or character's name has more than one capital in-game, do not put a capital at the beginning of every word. This is a common mistake which often causes broken links and time being diverted to moving these pages.
If you are in doubt about a name, please check it in-game. If you come across a page with an incorrect title, please reach out to Bark or Steve.
Words such as articles and short prepositions in titles should be left un-capitalised. These include words such as 'a', 'the', and 'of'. For example, the article on the Tombs of Amascut has the title 'Tombs of Amascut' (the 'of' is left un-capitalised).
Sections and headings
Separating articles into sections makes them easy to read and navigate. Headings are used to split articles into sections.
Markup
Use two equal signs (==
) style markup for headings. Start with ==
, add the heading title, then end with ==
.
This section's heading was created with the markup:
==Sections and headings==
This subsection's heading was created with the markup:
===Markup===
Wording
- 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 lower case. Skills, names, and so on should all have the first letter capitalized. For example, "Fishing equipment", not "Fishing Equipment".
- Avoid putting links in headings.
- Make sure that the heading has an appropriate and accurate title, as this is important to help readers navigate the article. For example, do not make a "Monsters" section in an article about an area or dungeon and then include NPCin that section. Instead, make an "Inhabitants" section with "Monsters" and "NPCs" as subsections.
- Keep headings short.
Lead sections
A lead (introduction) summarizes the most important points of an article, creating interest in the topic. Thus, it should be limited to a few paragraphs. Certain information, such as strategies, should be in a separate section instead of in the lead. This applies only to articles that are of sufficient length to incorporate a lead.
Section organisation
An article should generally start with an Infobox when applicable, followed by a lead section. This should then be followed by multiple sections each detailing subjects about the article's topic.
If an article has at least four section headings, a navigable table of contents appears automatically, just after the lead.
Text elements
Font colours
Colored font can be used sparingly, though not in very bright colors. For example, you can use a dark color for a warning. Note that certain colors will not show up well against the article's background.
Invisible comments
Invisible comments are used to communicate with other editors in the article body. To do so, enclose the text which you intend to be read only by editors within <!--
and -->
. For example, using <!-- This is a comment -->
will be hidden in the article.
Bulleted lists
Bulleted lists can be used in quest walkthroughs and lists. For example, you can use bullets if you're listing what levels to train a certain skill or locations of an item. Do not forget proper punctuation. To add bullets, put an asterisk (*) before the name. For example:
* List name 1 * List name 2 ** Sub-list
would come out as:
- List name 1
- List name 2
- Sub-list
Numbered lists
All the rules for bulleted lists apply also to numbered lists. Numbered lists can be used for listing steps in a process. To add a numbered list, put a number sign (#) before the list name. For example:
# List name 1 # List name 2 # List name 3
would come out as:
- List name 1
- List name 2
- List name 3
Bold and italics
Place two apostrophes (''Italicized text'') on either side of a selection of text to italicize the selection. Italics are mainly used to emphasise certain words, though they should be used sparingly. Long stretches of italics are hard for some users to read.
Place three apostrophes ('''Boldfaced text''') on either side of a selection of text to boldface the selection. Bold is used as a stronger emphasis than italics, although it should be used extremely sparingly within articles, such as for a few critical points, and ideally not a whole sentence. However, the first appearance of an article's title in the article should always be boldfaced.
Place five apostrophes ('''''Boldfaced and italicised text''''') on either side of a selection to use bold and italics in combination on the selection. Bold and italics combined emphasise selections well, but should be used extremely rarely: bold italics represent more emphasis than is normally ever necessary.
Grammar and spelling
Case
All prose, including bold text at the beginning of articles, should conform to standard capitalization in English.
- Proper nouns
- Proper nouns are to be capitalized. The following is a non-exhaustive list of proper nouns:
- For example: the King Black Dragon is a black dragon; the Kraken is a Slayer boss.
- Common nouns, such as the names of most items and monsters, are to be lower case. If an item name contains a proper noun, the proper noun should be capitalized. For example, helm of Neitiznot
- Notes & Exceptions
- When mentioning a skill, it should always be mentioned by its proper name. For example, "Winter can be melted by lighting the brazier, requiring level 10 Firemaking."
Abbreviations
Try not to use abbreviations. For example, use "battleaxe" instead of "baxe". As far as looks go, it's much more pleasing to the eye to look at "Dragon claws result in higher overall damage output than Bandos godsword at Vorkath." than "Dclaws are better DPS than BGS at Vork".
Also try not to use ampersand (&) instead of and.
Punctuation
Punctuation marks like semicolons, brackets, and commas are essential for clarity, structure, and emphasis in writing guides and editing pages. They help organize ideas, prevent misunderstandings, and enhance the professionalism of the text.
- Commas
If you are listing multiple things, like different runes, each of them should have a comma at the end. I don't give a shit about the Oxford comma or not, so do whichever you want.
- For example, "fire runes, earth runes, and water runes" or "fire runes, earth runes and water runes". Whatever your heart desires.
- Semicolons
If you are writing and need to use semicolons, make sure you follow these guidelines:
- Make sure there are two short independent clauses you can link. For example, "Steve is hungry; he needs a chicken burger."
- Place a semicolon before conjunctive adverbs (e.g., however, therefore) when they are linked to independent clauses.
- Use semicolons to separate items in a list when the items themselves contain commas. For example, "The Slayer skill involves talking to Slayer masters, the low-tier slayer master; Slayer master#Turael, the mid-tier; Slayer_master#Vanakka, the high-tier Slayer_master#Nieve; and Nixite, the end-game tier master."
Tense
A rule of thumb is to use present tense in all cases. For example, articles for skills, activities, non-player characters, etc. should be written in present tense. An exception to this rule would be events that have occurred in the past, or for in-game content that has been removed. For example, holiday events that have already occurred should be written in past tense. For future updates and upcoming content that have been confirmed by Jagex, use the future tense.
- Past tense: Past events and in-game content that has been removed
- Future tense: Future updates and upcoming content that have been confirmed
- Present tense: All other cases
Common grammatical errors
I'm not going to explain every single one of these. Do your best.
their there they're
- Don't fuck these up. We will make fun of you.
its and it's
- Its is the possessive adjective and possessive pronoun form of the personal pronoun it.
- "He chose this area for its atmosphere."
- it's' is a contraction (shortcut) for it is OR it has.
- it is – "It's your fault."
- it has – "It's been a hot day."
should of
- The reason people write "should of" when they mean should have is because the contraction of should have (should've) is pronounced like "should of". Avoid "should of" like the plague. Instead, write "should have".
- "Those rookie editors made the mistake of writing 'should of' when they meant 'should have'".
much and many
- As in the above example, much refers to a quantity that can be measured. Many refers to a quantity that can be counted.
- "How much total experience do you have?"
- "How many people are in your clan chat?"
alter and altar
- An altar is a piece of furniture used in Prayer. To alter is to change something.
affect and effect
- One thing may affect (or change) another. The result of an action is its effect or effects. Also, to effect is to produce.
your and you're
- Good luck
duel and dual
- The gambling addicts ask if we have the Duel Arena.
- You would dual-wield two swords, or have a dual personality, meaning you have bugs in your skin.
Images
- Most images should exist already. If an image does not exist, ask first, as we should have access to sprites for all images that will look better than trying to take a screenshot in-game.
Uploading images
- The preferred formats for images are
.PNG
. - Images of items should have a transparent background.
- Personal images should not be uploaded. Images should be able to be used on main space articles, else they will be deleted.
- Please name your files descriptively to avoid confusion. For example if you are uploading a picture of a weapon, name it Rune longsword.png and not just Sword.png or RL.png.
- Don't upload images we already have. Before you upload an image, search the wiki if someone has already uploaded a version of it. We don't need
[[File:Fire rune.PNG]]
or[[File:Fire rune.gif]]
if someone has already uploaded[[File:Fire Rune.PNG]]
.- If you're unsure if an image exists, ask!
Links
Internal links
- You don't have to link every single mention within an article. For example, Slayer may be mentioned five times. You only have to link to Slayer once. You can link to articles more than once if the page is very long.
- When a skill is linked to, the name of the skill should be used, not a short form or a different spelling of it. Instead of saying "
this item can be [[Mining|mined]] by...
" you should state "this item can be obtained through the [[Mining]] skill by ...
". - Piped link formats for simple plurals are generally unnecessary. For example, use
[[lobster]]s
instead of[[lobster|lobsters]]
. - On the other hand, use
[[wolf|wolves]]
instead of[[wolf]]s
when appropriate. Don't be afraid to use a piped link when necessary, particularly if avoiding them contorts the language unnecessarily or introduces spelling or grammatical errors into the article. Piped links have legitimate uses in an article. - When including wiki-links in an article, there is no need to use underscores or initial capitalization, since the software produces them automatically. For example,
[[fire_rune]]
and[[Fire rune]]
work the same as[[fire rune]]
. - Do not place the last letters of a plural outside of a link that already has alternate text. For example,
[[cow|cows]]
should be used instead of[[cow]]s
.
External links
Do not link to external sites.
Writing articles
Everyone is encouraged to contribute meaningfully to the wiki.
Ownership and bias
- Keep personal bias out of articles. Even if "Mining is for noobs" or "Smithing is awesome", we do not need to hear it in the articles.