Caves of Qud Wiki:Style Guide: Difference between revisions

No edit summary
Line 20: Line 20:
===Categories===
===Categories===
Categories will be named in their plural form, ex [[:Category:Artifacts]]. All words will be capitalized.
Categories will be named in their plural form, ex [[:Category:Artifacts]]. All words will be capitalized.
===Reliability===
To make sure that all information on this wiki is up to date, make sure to use [[Template:As Of Patch]] on the top of pages.
To make sure that information is correct in the first place, if it is in a difficult to find area (a cs file that is NOT the ID specified in the page's infobox) be sure to note which cs file you found it in by using the <code><nowiki><ref></ref></nowiki></code> tags. The expected format is XRL.(file path).cs (method name if cs file is very large).
===Formality===
Unless it is a guide, writing in the second person (referring to the reader directly with 'you') is highly discouraged against. It should be referred to as the Player character, to distinguish between the actual player themselves.
Avoid writing recommendations and personal opinions in the main text, and separate them into their own section so readers are able to discern what is factual and what is personal opinion.
===Terminology===
Avoid protagonist bias as well: many other creatures are fully capable of using objects and mutations the same way as the player does. Avoid mentioning the player character when "this creature" is more accurate to describe the possible users.
* Do not refer to the NPCs of this game as "monsters"; they are '''creatures'''.
* A parasang is made of 9 connected '''zones'''.
* "Pounds" is discouraged as referring to weight and [[Template:Pounds]] is preferred.
* Surround all complicated dice logic with [[Template:Dice tooltip]].
* The currency is '''drams''' or $.
* A global ingame turn at (a turn at 100 quickness) is referred to as a '''Game tick''', but a player based turn counter that does not depend on quickness can be referred to as an ingame '''turn'''.


==Formatting==
==Formatting==