Caves of Qud Wiki:Style Guide: Difference between revisions

→‎References: AOP placement
(→‎Terminology: explain “currently”)
(→‎References: AOP placement)
Line 121: Line 121:
==References==
==References==


As a general principle, articles should aspire to help readers discover where to look to verify the information they present, particularly whenever it's not obvious where to look. For this reason, articles should cite in-game sources whenever it aids in this discovery.
As a general principle, articles should aspire to help readers discover where to look to verify the information they present, particularly whenever it's not obvious where to look, for purposes of verification and for modding. For this reason, articles should cite in-game sources whenever it aids in this discovery.


For citations to the game's C# code, use [[Template:Code Reference]] (see the documentation on that page for a usage example).
For citations to the game's C# code, use [[Template:Code Reference]] (see the documentation on that page for a usage example).
Line 129: Line 129:
All cases not covered by more specific advice can use <code><nowiki><ref>ref syntax</ref></nowiki></code>.
All cases not covered by more specific advice can use <code><nowiki><ref>ref syntax</ref></nowiki></code>.


Whenever an article contains any citations, its very last heading should be a <code><nowiki>== References ==</nowiki></code> heading, which should in most circumstances be left blank and be filled automatically by the wiki with the citations that were made.
Whenever an article contains any citations, its very last heading should be a <code><nowiki>{{References|(game version number)}}</nowiki></code>.
 
=== Maintaining up-to-date-ness ===
To guarantee that the data on a page is correct, we have two main locations that we place the game version our information comes from:
* The infobox footer, which is either automatically populated by QBE, or manually added by setting the <code>gameversion</code> parameter in the infobox to the game version. This is used for the infobox related data only.
* References, added by adding <code><nowiki>{{References|(game version number)}}</nowiki></code> at the end of the article, before any navboxes. This is used for manually written information in the main body of the article.
For other pages, regular <code><nowiki>{{As Of Patch|(game version number)}}</nowiki></code> will be placed at the very top of the article, although if the page uses references, it is best to place in the references section as stated previously.


==Sprite Uploading==
==Sprite Uploading==