Difference between revisions of "Meta:Style Guide"

From Game Detectives Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
m (Added G to AR (omega12))
(complete rewrite)
Line 1: Line 1:
== Date Formats ==
+
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.
All dates written using solely numbers on the wiki should abide to the ISO 8601 standard, '''YYYY-MM-DD'''; eg. 1970-01-01, 2016-08-15.
 
  
If inline (part of some text) use the format '''DD MMM. YYYY'''; eg. 1 Jan. 1970, 15 Aug. 2016.
+
__TOC__
  
== Structure ==
+
== General Guidelines ==
=== ARG Page Structure===
+
 
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.
+
* '''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 - try to make each page accessible to newcomers.
 +
* 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 here:''' https://www.mediawiki.org/wiki/Help:Formatting
 +
 
 +
=== Ease of Reading ===
 +
 
 +
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 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 "players" or "participants", depending on the context.
 +
 
 +
Example:
 +
<pre>
 +
Through the use of clever lateral thinking, we solved the puzzle.
 +
</pre>
 +
becomes
 +
<pre>
 +
Through the use of clever lateral thinking, players were able to solve the puzzle.
 +
</pre>
 +
 
 +
== 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 24-hour time, in the [https://www.timeanddate.com/worldclock/timezone/utc UTC timezone].
 +
 
 +
== Page Structure ==
 +
 
 +
The main page for an ARG should use the [[#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.
 +
 
 +
=== Page Sections ===
 +
 
 +
Defining sections for a wiki page is often a judgement call for 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.
 +
 
 +
=== Multiple Page Structure ===
 +
 
 +
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 needed 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.
  
 
Example:
 
Example:
Line 12: Line 67:
 
  This_ARG/Timeline
 
  This_ARG/Timeline
 
  This_ARG/Summary
 
  This_ARG/Summary
  That_ARG
+
  This_ARG/Characters
That_ARG/Timeline
 
That_ARG/Summary
 
  
=== Other Custom Namespaces ===
+
Additionally, when creating subpages, ensure you [[https://www.mediawiki.org/wiki/Help:Categories categorize them properly]]!
No additional namespaces should be created for organisation below the ARG Namespace level - use disambiguation instead, where necessary.
 
  
 
=== 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. An example of this is [[Project 11]] (the ARG) and [[Project 11 (puppetmaster)]] (the name of the [[puppetmaster]]).
  
 
=== Non-ARG articles ===
 
=== Non-ARG articles ===
Articles that do not pertain solely to a specific ARG should be in the main namespace. An example of this is puppetmaster articles, like [[Valve]] and [[gayfarang]] (as puppetmasters could potentially create more than a single ARG).
+
 
 +
Articles that do not pertain solely to a specific ARG should be in the main namespace. An example of this is puppetmaster articles, like [[Valve]] and [[gayfarang]].  This is because puppetmasters could potentially create more than a single ARG.
 +
 
 +
== Nomenclature ==
 +
 
 +
This section outlines some naming conventions to promote consistency across the wiki. This is not intended as a comment on a phrase's 'correctness' in the real world (some, of course, have multiple acceptable usages), rather an approved style for this wiki.
 +
 
 +
* 'ARG' always appears in caps ('Arg' and 'arg' are incorrect).
 +
* 'Puppetmaster' always appears as a single word ('puppet master' and 'puppet-master' are incorrect).
  
 
== Wiki Classes ==
 
== Wiki Classes ==
  
 
=== ARGBox ===
 
=== ARGBox ===
 +
 
Use <code>{{t|argbox|...}}</code> on the main page of an ARG, with parameters as shown below.
 
Use <code>{{t|argbox|...}}</code> on the main page of an ARG, with parameters as shown below.
 
;Sample output
 
;Sample output
Line 56: Line 118:
  
 
For more info, check out [[Template:Argbox]].
 
For more info, check out [[Template:Argbox]].
 
=== Discord Avatar ===
 
 
(''to be added'')
 
 
== Article Content ==
 
The wiki should act as its own glossary. The first block of text in an article should briefly describe the subject of the article before going into more details. Remember the following points:
 
 
* What type of 'thing' is this (ARG, character, organisation, phrase, etc.)?
 
* What game/ARG or other item does it relate to?
 
* What are the most important points about this thing (what does a casual reader need to know right away)?
 
 
== Nomenclature ==
 
This section outlines some naming conventions to promote consistency across the wiki. This is not intended as a comment on a phrase's 'correctness' in the real world (some, of course, have multiple acceptable usages), rather an approved style for this wiki.
 
 
* 'ARG' always appears in caps ('Arg' and 'arg' are incorrect).
 
* 'Puppetmaster' always appears as a single word ('puppet master' and 'puppet-master' are incorrect).
 
 
== Games and Other Media ==
 
If you refer to a game (or similar content) that an ARG relates to, remember to mention what type of 'thing' it is and link to a article about it. This article can be brief, but should include the ARGs it relates to, as well as external links to extended information (Steam store page/Wikipedia article etc.).
 

Revision as of 23:59, 31 July 2017

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.

General Guidelines

  • 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 - try to make each page accessible to newcomers.
  • 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 upload them to our wiki, then embed (instead of embedding from an external source).
  • A full formatting guide can be found here: https://www.mediawiki.org/wiki/Help:Formatting

Ease of Reading

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 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 "players" or "participants", depending on the context.

Example:

Through the use of clever lateral thinking, we solved the puzzle.

becomes

Through the use of clever lateral thinking, players were able to solve the puzzle.

Dates and Times

All dates written using solely numbers on the wiki should abide by the ISO 8601 standard:

YYYY-MM-DD

When writing dates inline, any of the following formats can be used:

MON. DD, YYYY
Month DD, YYYY
Month DD
DD MON. YYYY

Note: Please try to keep inline date styles consistent for any given page.

Times should be in 24-hour time, in the UTC timezone.

Page Structure

The main page for an ARG should use the #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.

Page Sections

Defining sections for a wiki page is often a judgement call for 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 Phase 1, one for Phase 2, and one for Phase 3. The first of these phases is broken up into 5 "sequences", so its wiki page is structured accordingly.

Multiple Page Structure

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 needed 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.

Example:

This_ARG                         <- this is a page as well as the namespace
This_ARG/Timeline
This_ARG/Summary
This_ARG/Characters

Additionally, when creating subpages, ensure you [categorize them properly]!

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).

Non-ARG articles

Articles that do not pertain solely to a specific ARG should be in the main namespace. An example of this is puppetmaster articles, like Valve and gayfarang. This is because puppetmasters could potentially create more than a single ARG.

Nomenclature

This section outlines some naming conventions to promote consistency across the wiki. This is not intended as a comment on a phrase's 'correctness' in the real world (some, of course, have multiple acceptable usages), rather an approved style for this wiki.

  • 'ARG' always appears in caps ('Arg' and 'arg' are incorrect).
  • 'Puppetmaster' always appears as a single word ('puppet master' and 'puppet-master' are incorrect).

Wiki Classes

ARGBox

Use {{argbox}} on the main page of an ARG, with parameters as shown below.

Sample output
Example ARG
Completed on yyyy-mm-dd
Example.png
This is the description
Type Official ARG
Creator Valve
Discovered
"yyyy-mm-dd" contains an extrinsic dash or other characters that are invalid for a date interpretation.
Completed
"yyyy-mm-dd" contains an extrinsic dash or other characters that are invalid for a date interpretation.
{{argbox
| float       = right
| name        = Example ARG
| image       = File:Example.png
| imagewidth  = 150
| description = This is the description
| creator     = Valve
| type        = Official ARG
| status      = Completed
| discovered  = yyyy-mm-dd
| completed   = yyyy-mm-dd
}}

For more info, check out Template:Argbox.