718
edits
Caves of Qud Wiki:Style Guide: Difference between revisions
m
Add some guidance on using spoiler warnings.
Kernelmethod (talk | contribs) m (Add some more information on favilinks.) |
Kernelmethod (talk | contribs) m (Add some guidance on using spoiler warnings.) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 21: | Line 21: | ||
| {{favilink|Corrosive Gas Generation}} | | {{favilink|Corrosive Gas Generation}} | ||
|- | |- | ||
| Skills | | Skills | ||
| Title Case | | Title Case | ||
| [[Dual Wield]] | | [[Dual Wield]] | ||
| Line 156: | Line 156: | ||
* the 3×3×infinity set of zones associated with a given world map tile | * the 3×3×infinity set of zones associated with a given world map tile | ||
* the distance from one zone to any zone on an adjacent world map tile | * the distance from one zone to any zone on an adjacent world map tile | ||
=== Spoilers === | |||
Any content encountered in Caves of Qud may be added to the wiki. However, in the interest of helping readers who want to avoid spoiling late-game and hidden content, pages should be marked with [[Template:Spoiler]] where appropriate, e.g. | |||
{{spoiler}} | |||
The question of whether or not content should be marked with <code><nowiki>{{spoiler}}</nowiki></code> is left to the writer's discretion. In general, we advise adhering to the following guidelines: | |||
* Content that appears in the modding section of the wiki or in wiki meta-discussion pages (such as this one) ''does not'' need to include spoiler warnings. | |||
* Content related to non-dynamically-generated quests ''should'' include spoiler warnings, especially for quests that appear in the mid- to late-game. | |||
* Content related to hidden content that is not easily encountered by players, such as [[Tzimtzlum]], ''should'' include spoiler warnings. | |||
* Content related to special enemies, such as the [[Girsh Nephilim]], ''should'' include spoiler warnings. | |||
==Formatting== | ==Formatting== | ||
| Line 177: | Line 190: | ||
* [[Template:Favilink id]] is useful when you wish to specifically link to an object by its blueprint ID, a mutation by its mutation ID, and so on. | * [[Template:Favilink id]] is useful when you wish to specifically link to an object by its blueprint ID, a mutation by its mutation ID, and so on. | ||
The differences between these favilink types can be relevant when objects or mutations share the same name, for example, the {{favilink id|NightVision}} implant and the {{favilink id|Mutation:DarkVision}} mutation: | The differences between these favilink types can be relevant when objects or mutations share the same name, for example, the {{favilink id|NightVision}} implant and the {{favilink id|Mutation:DarkVision}} mutation. The table below shows how one might link to one page versus the other: | ||
{| class="wikitable" | |||
! Page | |||
! Examples | |||
|- | |||
| {{favilink id|NightVision}} (the implant) | |||
| | |||
* <code><nowiki>{{favilink|Night Vision}}</nowiki></code> | |||
* <code><nowiki>{{favilink id|NightVision}}</nowiki></code> | |||
* <code><nowiki>{{favilink page|Night Vision (implant)}}</nowiki></code> | |||
|- | |||
| {{favilink id|Mutation:DarkVision}} (the mutation) | |||
| | |||
* <code><nowiki>{{favilink page|Night Vision}}</nowiki></code> | |||
* <code><nowiki>{{favilink id|Mutation:DarkVision}}</nowiki></code> | |||
|} | |||
Note that mutations linked with [[Template:Favilink id]] must be prefixed with <code><nowiki>Mutation:</nowiki></code> to distinguish them from object blueprint IDs. | |||
Use of favilink should follow [[#Links | the general rules for linking]]. | |||
===Quoting In-Game Descriptions=== | ===Quoting In-Game Descriptions=== | ||