|
|
| (11 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| This page documents rules, styles, and conventions for the Game Detectives wiki. Please try your best to adhere to them when creating new pages, writing new content, or editing existing content. | | This style guide documents the editing guidelines for the Game Detectives wiki. |
|
| |
|
| __TOC__ | | <div class="toclimit-2">__TOC__</div> |
|
| |
|
| ==Wikipedia Manual of Style== | | ==Wikipedia Manual of Style== |
|
| |
|
| This wiki adheres to the [https://en.wikipedia.org/wiki/Wikipedia%3aManual_of_Style Wikipedia Manual of Style]. This is the definitive style guide for wiki content and should be followed unless otherwise noted.
| | The [https://en.wikipedia.org/wiki/Wikipedia%3aManual_of_Style Wikipedia Manual of Style] is the definitive style guide for wiki content, and provides guidelines for article structure, grammar, and formatting. The rules outlined in the Wikipedia Manual of Style should also be followed on the Game Detectives wiki. |
|
| |
|
| ==Overview== | | ==Additional Guidelines== |
| | This section outlines some considerations specific to the Game Detectives wiki: |
| | * All pages must be written in English. When citing ARG elements that are written in another language, an English translation must be provided. |
| | * In order to prevent [[wikipedia:Link_rot|link rot]], media should be [http://wiki.gamedetectives.net/index.php?title=Special:Upload uploaded] to the Game Detectives wiki wherever possible, instead of embedding the media from an external source. |
|
| |
|
| === General Guidelines === | | == Nomenclature == |
| | |
| * Pages should be written in English. If a page requires use of another language, an English translation should be provided.
| |
| * '''Proofread your edits!''' If you see a typo on a page, don't hesitate to correct it!
| |
| * Write with the newbie's perspective in mind - aim to craft pages that are accessible to someone who knows nothing about a given ARG.
| |
| * Take advantage of Mediawiki's formatting when appropriate. Images and videos can be embedded in the page to maximize readability.
| |
| * When embedding images, it's preferable to [http://wiki.gamedetectives.net/index.php?title=Special:Upload upload] them to our wiki, then embed (instead of embedding from an external source).
| |
| * '''A full formatting guide can be found [https://www.mediawiki.org/wiki/Help:Formatting here].'''
| |
| | |
| ===Language===
| |
| Tips:
| |
| *Avoid ambiguity, jargon, and vague or unnecessarily complex wording.
| |
| *Use words your audience will understand, and use just enough words to convey your message.
| |
| *Define terms that may not be obvious to individuals who are new to what you are writing about.
| |
| *Keep paragraphs and sentences short and concise.
| |
| *Use contractions or don't. Just be consistent.
| |
| === Tense ===
| |
| | |
| '''Always write in the past tense.'''
| |
| | |
| This rule is particularly important when writing about puzzle solutions. This rule applies even when writing about something that is ''presently occurring''. If events are initially described in present tense, then the description needs to be altered later on to reflect that it happened in the past.
| |
| | |
| This also goes for future tense - talk about what information was revealed rather than where the investigation is today.
| |
|
| |
|
| '''Example:'''
| | This section outlines some naming conventions to promote consistency throughout the Game Detectives wiki: |
|
| |
|
| <code>The website '''will be updated''' on the 12th of '''this month''', according to the tweet by the PM.</code>
| | * "'''ARG'''" should always appear in capital letters ("Arg" and "arg" are incorrect). |
| | | * "'''Puppetmaster'''" should always be a single word ("puppet master" and "puppet-master" are incorrect). |
| Should be written as:
| | * "'''Easter egg'''" should always use a capital "E" for "Easter" and a lowercase "e" for "egg" ("Easter Egg" and "easter egg" are incorrect). |
| | |
| <code>The PM tweeted that the website '''would be updated''' on the 12th of '''December'''.</code>
| |
| | |
| ''Side note: As above, don't refer to dates relatively. Reference exact dates in the past tense to preserve readability even after the event concludes.''
| |
| | |
| '''Example 2:'''
| |
| | |
| <code>Discord user imnotgoats found the solution to puzzle one '''is''': 27</code>
| |
| | |
| Should be written as:
| |
| | |
| <code>Players discovered puzzle one's solution '''was''': 27</code>
| |
| | |
| ''Side note: Reference participants as "player(s)" (as opposed to users, etc) to maintain congruence with other wiki articles.''
| |
| | |
| === Readability ===
| |
| | |
| As mentioned above, write with the newbie's perspective in mind. This means embedding the most pertinent media directly onto the page, and linking to relevant sources where necessary. When in doubt, '''more links and embedded media are better''' (but not to the point where you can't read any of the words on the page, of course).
| |
| | |
| Additionally, be wary of writing run-on sentences when describing what occurred in an ARG. ARGs can get really complex, ''really'' quickly, so it's easy for a newcomer to feel overwhelmed. When in doubt, '''step back and think about how to break down your explanation'''.
| |
| | |
| === Point of View ===
| |
| | |
| The wiki should have a consistent, neutral voice, and should ''not'' read as though it was written by one or two solvers. '''Avoid using the word "we" at all costs!''' Instead, consider replacing it with something like "players" or "participants", depending on the context.
| |
| | |
| '''Example:''' | |
| | |
| <code>Through the use of clever lateral thinking, '''we solved''' the puzzle.</code>
| |
| | |
| Should be written as:
| |
| | |
| <code>Through the use of clever lateral thinking, '''players were able to solve''' the puzzle.</code>
| |
| | |
| === Mentioning Players ===
| |
| | |
| Players '''may''' be mentioned by name if:
| |
| * They were the only person present at a live event
| |
| * They were a prevalent player during a live event (eg. streamed the event)
| |
| | |
| Players should '''not''' be mentioned by name if:
| |
| * They solved a single ARG puzzle
| |
| * They solved multiple ARG puzzles
| |
| * They were one of many players who attended a live event
| |
| | |
| Generally speaking, mentioning players by name in the body of the wiki has a negative impact on readability and detracts from an otherwise informational format. Separate credits pages, especially as demanded by the community, are encouraged, and the above rules need not apply to them.
| |
| | |
| === Dates and Times ===
| |
| | |
| All dates written using solely numbers on the wiki should abide by the '''ISO 8601 standard''':
| |
| | |
| <pre>
| |
| YYYY-MM-DD
| |
| </pre>
| |
| | |
| When writing dates inline, any of the following formats can be used:
| |
| | |
| <pre>
| |
| MON. DD, YYYY
| |
| Month DD, YYYY
| |
| Month DD
| |
| DD MON. YYYY
| |
| </pre>
| |
| | |
| ''Note: Please try to keep inline date styles consistent for any given page.''
| |
| | |
| Times should be in written in 24-hour time, and should use the [https://www.timeanddate.com/worldclock/timezone/utc UTC timezone].
| |
|
| |
|
| == Page Structure == | | == Page Structure == |
|
| |
|
| The main page for an ARG should use the [[#ARGBox|ARGBox]] template, set to float to the right. At the top of the page, above the table of contents, there should be a brief summary of the ARG, including links to any related media.
| | === Main Page === |
| | | The main page for an ARG should use the [[Meta:Style Guide#ARG Box|argbox]] template. |
| === Page Sections === | |
| | |
| Defining sections for a wiki page is often a judgement call for wiki editors. However, if an ARG is explicitly broken up into distinct segments, it may make sense to define the sections accordingly. For instance, [[Waking Titan]] is explicitly broken up into 3 "phases". Wiki editors mirrored this structure by breaking the ARG up into 3 sub-pages: one for [[Waking Titan/Phase 1|Phase 1]], one for [[Waking Titan/Phase 1|Phase 2]], and one for [[Waking Titan/Phase 3|Phase 3]]. The [[Waking Titan/Phase 1|first of these phases]] is broken up into 5 "sequences", so its wiki page is structured accordingly.
| |
| | |
| ==== Subpages ====
| |
|
| |
|
| The main page for an ARG can host whatever information is deemed necessary by wiki editors. If the ARG is small, the main page may suffice to contain the full documentation of the ARG. However, as ARGs become more sprawling and complex, more pages may be required to track them. Articles about high-level subjects can be created, named sensibly, in the main namespace. For '''''all''''' articles pertaining ''solely'' to a specific ARG, subpages should be used.
| | === Subpages === |
| | As an ARG becomes more complicated, it may require more pages. For '''''all''''' articles pertaining ''solely'' to a specific ARG, subpages should be used. Subpages can use [[Meta:Style Guide#Auto ARG Box|autoargbox]] to generate argbox templates from the main page. |
|
| |
|
| Example: | | Example: |
| Line 123: |
Line 34: |
| This_ARG/Characters | | This_ARG/Characters |
|
| |
|
| Additionally, when creating subpages, ensure you [https://www.mediawiki.org/wiki/Help:Categories categorize] them properly!
| | When creating subpages, ensure you [[mediawikiwiki:Help:Categories|categorize]] them. |
|
| |
|
| === Disambiguation === | | === Disambiguation === |
|
| |
|
| Where there is a requirement for two articles with the same name ''in the same namespace'', disambiguation should be used in the form of parenthesis after the article name. An example of this is [[Project 11]] (the ARG) and [[Project 11 (puppetmaster)]] (the name of the [[puppetmaster]]). | | Where there is a requirement for two articles with the same name ''in the same namespace'', disambiguation should be used in the form of parenthesis after the article name. |
|
| |
|
| === Non-ARG articles === | | === Non-ARG articles === |
|
| |
|
| Articles that do not pertain solely to a specific ARG should be in the main namespace. This is because puppetmasters could potentially create more than a single ARG. | | Articles that do not pertain to a specific ARG should be in the main namespace. |
| | |
| == Nomenclature ==
| |
| | |
| This section outlines some naming conventions to promote consistency across the wiki. This section is ''not'' intended to comment on a phrase's 'correctness' in the real world - rather, these guidelines outline an approved style for this wiki.
| |
| | |
| * "'''ARG'''" always appears in caps ("Arg" and "arg" are incorrect).
| |
| * "'''Puppetmaster'''" is a single word ("puppet master" and "puppet-master" are incorrect).
| |
| * "'''Easter egg'''" only has a capital on 'Easter' ("Easter Egg" and "easter egg" are incorrect).
| |
| | |
| == Wiki Templates ==
| |
| | |
| === Article Message Box ===
| |
| | |
| {{ambox/doc}}
| |
| | |
| === ARG Box ===
| |
| | |
| {{argbox/doc}}
| |
| | |
| === Auto ARG Box ===
| |
| | |
| {{autoArgbox/doc}}
| |
| | |
| === ArgHeader ===
| |
| | |
| {{argHeader/doc}}
| |
| | |
| === ArgHeader sub-page ===
| |
| | |
| {{argHeaderSub/doc}}
| |
| | |
| === Auto-category Page ===
| |
| | |
| {{cat/doc}}
| |
| | |
| === Auto-category sub-page ===
| |
| | |
| {{subCat/doc}}
| |
| | |
| === Back to top button ===
| |
| | |
| {{backToTop/doc}}
| |
| | |
| === Message box ===
| |
| | |
| {{mbox/doc}}
| |
| | |
| === Other page message box ===
| |
| | |
| {{ombox/doc}}
| |
| | |
| === Outdated ===
| |
| | |
| {{outdated/doc}}
| |
| | |
| === Stub ===
| |
| | |
| {{stub/doc}}
| |
| | |
| === To-do ===
| |
| | |
| {{todo/doc}}
| |
| | |
| === Underlinked ===
| |
| | |
| {{underlinked/doc}}
| |
| | |
| === Update ===
| |
| | |
| {{update/doc}}
| |
| | |
| === Work in progress ===
| |
| | |
| {{WIP/doc}}
| |
This style guide documents the editing guidelines for the Game Detectives wiki.
Wikipedia Manual of Style
The Wikipedia Manual of Style is the definitive style guide for wiki content, and provides guidelines for article structure, grammar, and formatting. The rules outlined in the Wikipedia Manual of Style should also be followed on the Game Detectives wiki.
Additional Guidelines
This section outlines some considerations specific to the Game Detectives wiki:
- All pages must be written in English. When citing ARG elements that are written in another language, an English translation must be provided.
- In order to prevent link rot, media should be uploaded to the Game Detectives wiki wherever possible, instead of embedding the media from an external source.
Nomenclature
This section outlines some naming conventions to promote consistency throughout the Game Detectives wiki:
- "ARG" should always appear in capital letters ("Arg" and "arg" are incorrect).
- "Puppetmaster" should always be a single word ("puppet master" and "puppet-master" are incorrect).
- "Easter egg" should always use a capital "E" for "Easter" and a lowercase "e" for "egg" ("Easter Egg" and "easter egg" are incorrect).
Page Structure
Main Page
The main page for an ARG should use the argbox template.
Subpages
As an ARG becomes more complicated, it may require more pages. For all articles pertaining solely to a specific ARG, subpages should be used. Subpages can use autoargbox to generate argbox templates from the main page.
Example:
This_ARG <- this is a page as well as the namespace
This_ARG/Timeline
This_ARG/Summary
This_ARG/Characters
When creating subpages, ensure you categorize them.
Disambiguation
Where there is a requirement for two articles with the same name in the same namespace, disambiguation should be used in the form of parenthesis after the article name.
Non-ARG articles
Articles that do not pertain to a specific ARG should be in the main namespace.