Difference between revisions of "Meta:Style Guide"

From Game Detectives Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
Line 1: Line 1:
  
 
== Structure ==
 
== Structure ==
 
+
=== ARG Namespaces ===
Articles about high-level subjects can be created, named sensibly, in the main namespace. For '''''all''''' articles pertaining to a specific ARG, a separate namespace should be created.
+
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.
 
 
An ARG may have sub-namespaces underneath it for clues and similar large groupings of items, such as 'Clues'. Use these sparingly, only where really necessary (and where there are enough sub-pages to warrant it).  
 
  
 
Example:
 
Example:
Line 10: Line 8:
 
  This_Arg:Timeline
 
  This_Arg:Timeline
 
  This_Arg:Summary
 
  This_Arg:Summary
  This_Arg:Clues                  <- this is a page as well as the namespace
+
  That_Arg
This_Arg:Clues:The_Golden_Apple
 
This_Arg:Clues:The_Dancing_Frog
 
 
  That_Arg:Timeline
 
  That_Arg:Timeline
 
  That_Arg:Summary
 
  That_Arg:Summary
 +
 +
=== Other Custom Namespaces ===
 +
No additional namespaces should be created for organisation below the ARG Namespace level - use disambiguation instead, where necessary.
 +
 +
=== 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]]).
 +
 +
== 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.
 +
 +
== 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).
 +
 +
== 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).

Revision as of 19:56, 18 June 2016

Structure

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:

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

No additional namespaces should be created for organisation below the ARG Namespace level - use disambiguation instead, where necessary.

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

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.

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

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