Caves of Qud Wiki:Style Guide: Difference between revisions

Exceptions can be made for section titles, table headers, and similar labels - these typically are written in Title Case regardless of the terminology involved.

| {{favilink|Corrosive Gas Generation}}

| {{favilink|Lake Hinnom}}, {{favilink|banner of the Holy Rhombus}}, {{favilink|flume-flier of the sky-bear}}

| {{favilink|desert canyons}}

| {{favilink|spaser pistol}}, {{favilink|gelatinous prism}}

* {{Favilink|snapjaw scavenger}}

* {{Favilink|Q Girl}}

* {{Favilink|giant amoeba}}

* {{Favilink|giant centipede nest}}

* {{Favilink|yonderbrush}}

* {{Favilink|wine weep}}

* {{Favilink|pulsed field magnet}}

* {{Favilink|watervine}}

* {{Favilink|witchwood tree}}

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.

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”.

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:

| {{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.

* If you have a stylized depiction of a snapjaw, then that would certainly be relevant to the [[Snapjaws]] page or a more specific page, such as {{favilink|Snapjaw Scavenger}}.

* An OC with the {{favilink|Multiple Arms}} mutation could be added to the page for that mutation.

For example, suppose that your art was uploaded to [https://wiki.cavesofqud.com/wiki/File:Super_Cool_Dromad.webp File:Super_Cool_Dromad.webp]. Then to link your art in the {{favilink|Dromad}} page (or perhaps the [[Dromad merchants]] page), you would go to that page, edit it, and then add the following line to the page in the location that you want to upload it: