Style guide: Difference between revisions

From Game Detectives Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
No edit summary
m remove section on wiki templates - documentation for these templates can be accessed on the templates' respective pages
 
(54 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== Date Formats ==
This style guide documents the editing guidelines for the Game Detectives wiki.
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.
<div class="toclimit-2">__TOC__</div>


== Structure ==
==Wikipedia Manual of Style==
=== ARG Namespaces ===
Articles about high-level subjects can be created, named sensibly, in the main namespace. For '''''all''''' articles pertaining ''solely'' to a specific ARG, a separate namespace should be created.


Example:
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.
This_ARG                        <- this is a page as well as the namespace
This_ARG:Timeline
This_ARG:Summary
That_ARG
That_ARG:Timeline
That_ARG:Summary


=== Other Custom Namespaces ===
==Additional Guidelines==
No additional namespaces should be created for organisation below the ARG Namespace level - use disambiguation instead, where necessary.
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.


=== Disambiguation ===
== Nomenclature ==
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 ===
This section outlines some naming conventions to promote consistency throughout the Game Detectives wiki:
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).


== Wiki Classes ==
* "'''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).


=== ARGBox ===
== Page Structure ==
Use <code>{{t|argbox|...}}</code> on the main page of an ARG, with parameters as shown below.
;Sample output
{{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
}}
<pre>{{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
}}</pre>


For more info, check out [[Template:Argbox]].
=== Main Page ===
The main page for an ARG should use the [[Meta:Style Guide#ARG Box|argbox]] template.


=== Discord Avatar ===
=== 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.


(''to be added'')
Example:
This_ARG                        <- this is a page as well as the namespace
This_ARG/Timeline
This_ARG/Summary
This_ARG/Characters


== Article Content ==
When creating subpages, ensure you [[mediawikiwiki:Help:Categories|categorize]] them.
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.)?
=== Disambiguation ===
* 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 ==
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.
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).
=== Non-ARG articles ===
* 'Puppetmaster' always appears as a single word ('puppet master' and 'puppet-master' are incorrect).


== Games and Other Media ==
Articles that do not pertain to a specific ARG should be in the main namespace.
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.).

Latest revision as of 20:29, 18 November 2025

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.

Retrieved from "https://wiki.gamedetectives.net/index.php?title=Style_guide&oldid=20398"