Difference between revisions of "CrawlWiki:Style guide"

From CrawlWiki
Jump to: navigation, search
(stub for style guide)
 
(some starting guidelines from nethackwiki)
Line 1: Line 1:
 
CrawlWiki has no formal style guide as of yet. Changes should be discussed on the talk page.
 
CrawlWiki has no formal style guide as of yet. Changes should be discussed on the talk page.
 +
 +
(currently this style guide is shamelessly copied from the nethackwiki style guide)
 +
 +
== Tone ==
 +
CrawlWiki is not just an encyclopedia of ''DCSS'', but articles in the main namespace should be written in a largely encyclopaedic tone. That means clearly separating facts from comments, by putting strategy tips in their own section, and comments on the talk page. Spelling and grammar should follow (american/british standardized?) rules.
 +
 +
Please keep your sentences short, especially if your native language favors long ones.
 +
 +
== Article names ==
 +
Try to be consistent with existing articles:
 +
 +
* Name most pages with lowercase letters, like [[scroll of identify]], but use uppercase for proper nouns, like [[Orb of Zot]].
 +
* Prefer singular to plural (i.e. [[Dragon]] instead of [[Dragons]])
 +
* Redirect acronyms like [[GDA]] to pages like [[gold dragon armour]]. However, [[identification]], [[scroll of identify]], and [[spellbook of identify]] can be three separate pages.
 +
 +
The first time the article name appears in the main text, it should be '''bolded'''. This includes the titles of any redirects redirecting to the article. In-game messages documented in a definition list will be bolded automatically:
 +
 +
; "You feel centered in your personal space."
 +
: You gained teleport control through eating a corpse, while hallucinating
 +
 +
formats into
 +
 +
; "You feel centered in your personal space."
 +
: You gained teleport control through eating a corpse, while hallucinating
 +
 +
===Redirects===
 +
When creating a new article, redirect variations on that name to it, to avoid someone duplicating the article under a slightly different title.
 +
 +
For in-game messages, redirect the message (e.g. [[The golden haze around you disappears]]) to the article about the thing that caused it. If the message can have multiple causes, create a disambiguation page (e.g. [[Your skin feels warm for a moment]]).
 +
 +
The syntax for a redirect is like this:
 +
 +
#REDIRECT <nowiki>[[spellbook of protection]]</nowiki>
 +
 +
See [http://meta.wikimedia.org/wiki/Help:Redirect] for help creating redirects.
 +
 +
===Other links===
  
 
[http://nethackwiki.com/wiki/NetHackWiki:Style_guide nethackwiki style guide]
 
[http://nethackwiki.com/wiki/NetHackWiki:Style_guide nethackwiki style guide]
  
 
[http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style wiki's manual of style]
 
[http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style wiki's manual of style]

Revision as of 18:01, 20 December 2012

CrawlWiki has no formal style guide as of yet. Changes should be discussed on the talk page.

(currently this style guide is shamelessly copied from the nethackwiki style guide)

Tone

CrawlWiki is not just an encyclopedia of DCSS, but articles in the main namespace should be written in a largely encyclopaedic tone. That means clearly separating facts from comments, by putting strategy tips in their own section, and comments on the talk page. Spelling and grammar should follow (american/british standardized?) rules.

Please keep your sentences short, especially if your native language favors long ones.

Article names

Try to be consistent with existing articles:

The first time the article name appears in the main text, it should be bolded. This includes the titles of any redirects redirecting to the article. In-game messages documented in a definition list will be bolded automatically:

; "You feel centered in your personal space."
: You gained teleport control through eating a corpse, while hallucinating

formats into

"You feel centered in your personal space."
You gained teleport control through eating a corpse, while hallucinating

Redirects

When creating a new article, redirect variations on that name to it, to avoid someone duplicating the article under a slightly different title.

For in-game messages, redirect the message (e.g. The golden haze around you disappears) to the article about the thing that caused it. If the message can have multiple causes, create a disambiguation page (e.g. Your skin feels warm for a moment).

The syntax for a redirect is like this:

#REDIRECT [[spellbook of protection]]

See [1] for help creating redirects.

Other links

nethackwiki style guide

wiki's manual of style