Lets RP Wiki:Style guide

Manual of styles on the Let's RP Wiki
(Redirected from Help:Style guide)
Note: Most guidelines in this style guide are established three years after the creation of the wiki, many pages might not conform to this style guide. Please make corrections on the pages if that's the case. If you have any questions or suggestions, feel free to post on the discussion page.

This style guide is made to make the Let's RP Wiki easy to read by having the same standard across pages. The following guide is intended as a reference for general situations. It may not cover every situation that may come up.

For a more complete manual of style, the Wikipedia Manual of Style may be useful.

Article titles

TL;DR: Use in-game name and sentence case for the title.

A title should always be exactly the same as the in-game name of the subject, except when multiple subjects have the same name (and thus disambiguation parentheses are required). In-game names and sentence case should be used, with redirects utilized for other names.

  • Block capitals should not be used in titles (Article titles, not ARTICLE TITLES).
  • Use italics if needed, conforming to Project:Style guide#Italics.
  • Do not use articles (a, an, or the) as the first word (Vagos, not The Vagos), unless it is an integral part of a name (The Cartel).
  • Use full name instead of abbreviations if possible (Federal investigation bureau, not FIB). Use a redirect if the abbreviation is common.
  • Use straight quotation marks or apostrophes, create a redirect for curly ones if needed (', not ’).

Sometimes technical restrictions of MediaWiki prevent editors naming pages after their in-game names:

  • The subject name does not begin with a capital letter.
  • The subject name includes a /.
  • The subject name includes a character that cannot be used in page names, including # < > [ ] | { } _.
  • The subject begins with a string that would put the page in the wrong namespace. Such strings might include: Project:, File:, or User:, etc.

In such cases, problem characters should be replaced substitutes of left out altogether. Generally, replace | with -, and : in namespaces with -; leave out "#"". False subpages should be at the same name. In all cases DISPLAYTITLE ({{DISPLAYTITLE:iFruit}} for IFruit) should be used to mark the page as such.

Layout

A simple article should have at least a lead section, references, short description. The rest can be added when needed. For more details on template placement, see Project:Templates.

  1. Before the lead section
    1. Related articles templates
    2. Maintenance templates
    3. Infoboxes
    4. Images (if no infoboxes)
  2. Body
    1. Lead section (also called the introduction)
    2. Content
    3. Trivia
    4. Gallery
    5. See also
    6. Notes
    7. References
  3. Bottom matter
    1. Navplates
    2. Short description
    3. Categories
    4. Stub templates

Sections and headings

TL;DR: Keep headings short, concise, in plain text, and in sentence case.

Separating articles into sections makes them easy to read and navigate. Headings are used to splitting articles into sections.

Markup

  • Use equals signs around a section heading: ==Title== for a primary section, ===Title=== for a subsection, and so on to ======Title======, with no level skipped.
  • =Title= is never used.
  • Spaces around the title are optional and ignored, e.g. == Title ==.

Wording

  • Keep heading short
  • Use sentence case (capitalize only the first letter of the first word and the first letter of any proper nouns).
  • Not redundantly refer back to the subject of the article (e.g., Early life, not Smith's early life or His early life).
  • Not refer to a higher-level heading, unless doing so is shorter or clearer.
  • Not be numbered or lettered as an outline.
  • Not be phrased as a question.
  • Avoid the use of color or unusual fonts that might cause accessibility problems.
  • Not wrap headings in markup, which may break their display and also cause additional accessibility issues.

To avoid technical complications:

  • Be unique within a page, so that section links lead to the right place.
  • Avoid links, especially where only part of a heading is linked.
  • Avoid images or icons.
  • Avoid templates.
  • Avoid citations or footnotes.

Lead sections

A lead (introduction) summarizes the most essential points of an article, creating interest in the topic.

  • Subject should be defined within the first 250 characters.
  • Should be limited to a few paragraphs.
  • Subject should be mentioned as early as possible in the first sentence and should be bolded.
  • Certain information, such as strategies and trivia, should be in a separate section instead of in the lead.

Text elements

Internal links

  • Don't link the same article more than once, except if the article is too long or the link is in a template. For example, UwU Cafe may be mentioned five times. You only have to link to UwU Cafe once.
  • Piped link formats for simple plurals (s, es) are generally unnecessary. For example, use [[UwU Cafe]]s instead of [[UwU Cafe|UwU Cafe]].
  • On the other hand, use pipe symbols for complex plurals. For example, [[wolf|wolves]] instead of [[wolf]]s.
  • Do not place the last letters of a plural outside of a link that already has alternate text.

External links

Avoid linking to external sites in the main article with the rare exception of the GTAV Wiki, though it should be linked through the {{Link Fandom}} template. External links can be added to other sections such as trivia, notes, see also, references if it adds value to the article.

Font colors

Colored font should be avoided except for templates. If you need to use a colored font, you might want to create a template instead.

Bold

TL;DR: Bold the first mention of the subject and its alias.

Boldface is commonly used on the wiki, but restricted to several usages:

  • First mention of the subject of the page. For example, the term Vagos is bolded on the Vagos page.
  • First mention of the alias of the subject of the page.
  • Pseudo-heading, when a heading does not form a section and use as a stylistic heading.
  • Avoid using bold for emphasis in the article text, instead use {{em}}.

Boldface is sometimes applied automatically, either by MediaWiki software or by the browser:

  • Section headings
  • Description lists
  • Table headers and captions (but not
image captions)
  • A link to the page on which that link appears called a self link

Italics

TL;DR: Use {{em}} to emphasize text. Some names and titles should be italicized.

Italics should be used in the following conditions:

  • Emphasize text, but only
through the {{em}} template or the <em>...</em> HTML tag.

Quotes

  • Use straight quotation marks ' " instead of curly quotation marks.
  • Use {{Quote}} for quotes more than 40 words or more than one paragraph.
  • Quoted sources should leave date formats in whatever the quoted source used. (So don't edit a quote to change the date format.)

Numbers

  • Use comma as the thousands separator. Separators should be used for numbers greater than 1,000.
    • Do not use separators for template input, the template will format the number.
  • Ranges should be indicated with an endash (–; –) rather than a hyphen ("1–5" not "1-5").

Date and time

  • Use YYYY-MM-DD HH:MM:DD format, aka ISO 8601. Drop any unneeded precision on the right.
  • When approximating dates, use the same YYYY(+ whatever precision available) format and add (before), (after) or (circa) as a suffix to the date.(2022 (before); 2022-12-01 (after); 2022 (circa))
  • Date ranges indicating a status is current should include "Present", or leave blank. Ex Start:2022 End: Present
  • {{Start date and age}} can be used to indicate the passage of time both in real world and in lore (February 12, 2018; 6 years ago (2018-02-12)).

Grammar and spelling

Capital letters

TL;DR: Use common sense and lower case for everything unless it is a proper noun.

Avoid unnecessary capitalization. It is primarily needed for proper names, acronyms, and for the first letter of a sentence. Refer to CIG sources on what words should be capitalized, and use common sense to determine if it is a proper noun. Note that title text should always be ignored as they are often written in title case.

Below are a list of common nouns that should always be capitalized:

Note that rare exception does occur with cases like the planet and company (iFruit).

Spelling

While British English is generally acceptable, American English is strongly preferred. Everything in GTAV uses the American spelling, so does the wiki. If there is a spelling conflict between GTAV and American English, use the GTAV spelling.

Abbreviations

TL;DR: Try not to use abbreviations.

Abbreviations should only be used if it is defined in the article, and it does not affect the readability. Additional rules apply for article title as stated below:

  • Do not use abbreviations for article title unless there is no known full name.
  • Redirect acronyms and abbreviations to the article. The redirect page itself should be placed into Category:Abbreviations.
  • Create Disambiguation page if two or more different meanings for the abbreviations exist, instead of a redirect page.

Identity / Point of view

  • Third-person wherever possible
  • Use neutral, factual information
  • Avoid personal ideas and opinions
  • Use the word "character" to describe in-game entities such as individuals, players, or NPCs.
  • Use gender-neutral language

Editorial notes

Please use the {{Note}} when it's necessary to make editorial comments.

Example:

Wiki Staff Editorial Note: As of 2023-01-01 the Los Vagos gang claims no territory outside of Jamestown

File Names

File names (typically, the names of images uploaded to the wiki) should be descriptive and should contain the subject of the file to allow them to be easily found in searches. For example, file names like "Momo Curie - UwU Uniform" should be used instead of "screenshot 1002305122021 slideshow small". Make sure that all words in the file name are spelled correctly to avoid the need to rename a file in the future.

Non-article styles

Disambiguation

Wikis must resolve ambiguous references when a link is to a term that has more than one distinct meaning. This process is called disambiguation.

When one term is clearly the more expected result, it can remain the primary link, and a {{for}} or {{about}} entry should head off the article. (See Project:Templates for examples.)

When it is not so clear, the term becomes a disambiguation page, linking to the possible meanings.

Alternate meanings take the form of Term (other meaning). (Note lower case for disambiguation meaning.) Alternative meanings should also have a for statement at the head of the article.

Talk and user pages

The writing style on community pages, such as talk pages and user pages, are more informal than content pages. This allows for easier, more friendly communication and a more familiar tone.

As with any personal-related content, respect is paramount when dealing with other editors and users. Insults, releasing personal information, or personal attacks will not be tolerated, even on your own user page. Please treat other editors with respect. They're people too!

See also


Retrieved from "https://wiki.letsrp.co.uk/index.php?title=Lets_RP_Wiki:Style_guide&oldid=1521"