718
edits
Caves of Qud Wiki:Style Guide: Difference between revisions
m
Add some guidance on using spoiler warnings.
m (not sure whether this is still accurate since gamepedia merged with wikia, and it doesn't add much information anyway) |
Kernelmethod (talk | contribs) m (Add some guidance on using spoiler warnings.) |
||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 4: | Line 4: | ||
Pages that are tagged as [[:Category:Guides]] are not required to closely follow this style guide, but are still encouraged to consider following any guidelines that are useful for them to follow. In particular, it is not necessary for them to explicitly call out opinions. Such pages should also make it obvious at a glance that they are guides. | Pages that are tagged as [[:Category:Guides]] are not required to closely follow this style guide, but are still encouraged to consider following any guidelines that are useful for them to follow. In particular, it is not necessary for them to explicitly call out opinions. Such pages should also make it obvious at a glance that they are guides. | ||
See also: [[Caves_of_Qud_Wiki:Policy_and_Rules|Policy and Rules]] | |||
==Article Layout== | ==Article Layout== | ||
===Page Names and Capitalization=== | ===Page Names and Capitalization=== | ||
| Line 20: | Line 21: | ||
| {{favilink|Corrosive Gas Generation}} | | {{favilink|Corrosive Gas Generation}} | ||
|- | |- | ||
| Skills | | Skills | ||
| Title Case | | Title Case | ||
| [[Dual Wield]] | | [[Dual Wield]] | ||
| Line 105: | Line 106: | ||
* {{Favilink|giant centipede nest}} | * {{Favilink|giant centipede nest}} | ||
* {{Favilink|yonderbrush}} | * {{Favilink|yonderbrush}} | ||
* {{Favilink | * {{Favilink|wine weep}} | ||
* {{Favilink|pulsed field magnet}} | * {{Favilink|pulsed field magnet}} | ||
| Line 129: | Line 130: | ||
Avoid the word “monster”, except as used in the game. Prefer “creature” instead, regardless of how the player or player character may feel about the creature in question. | Avoid the word “monster”, except as used in the game. Prefer “creature” instead, regardless of how the player or player character may feel about the creature in question. | ||
==== “The” ==== | |||
While it is an established feature of technical writing, the “indefinite the”, i.e., the use of “the” followed by a singular common noun used to refer to an entire class of thing, is dispreferred in favor of using “a”/“an” and a singular noun, or no article and a plural noun. E.g., | |||
* A slugsnout is a type of swine. – Fine | |||
* Slugsnouts are a type of swine. – Fine | |||
* The slugsnout is a type of swine. – Not Preferred | |||
The idea is partly to make it clearer when something really is unique, e.g., “the Kesil Face”. | |||
==== Units ==== | ==== Units ==== | ||
| Line 145: | 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 158: | Line 182: | ||
===Colored Names=== | ===Colored Names=== | ||
Item names such as [[Stopsvalinn]] have multicolor names in game. For ease of use, call [[Template:Qud text]] instead of manually changing each letter using the Color Template. If referring to an item or character in its page, use [[Template:name]] to automatically make the colored version of the item. If referring to other items and characters with a link, use [[Template:favilink]]. | Item names such as [[Stopsvalinn]] have multicolor names in game. For ease of use, call [[Template:Qud text]] instead of manually changing each letter using the Color Template. If referring to an item or character in its page, use [[Template:name]] to automatically make the colored version of the item. | ||
If referring to other items and characters with a link, you should use favilinks. There are three favilink templates available: | |||
* [[Template:Favilink]] takes the name of an item or mutation and links to it. | |||
* [[Template:Favilink page]] takes the name of a page and links to it. | |||
* [[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 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=== | ||