718
edits
Caves of Qud Wiki:Style Guide: Difference between revisions
m
Add some guidance on using spoiler warnings.
(→“Currently”: clarify what the rule is about and what it isn't about) |
Kernelmethod (talk | contribs) m (Add some guidance on using spoiler warnings.) |
||
| (14 intermediate revisions by 6 users not shown) | |||
| Line 2: | Line 2: | ||
The Official Caves of Qud Wiki Style Guide is a standard of editing practices and formatting styles for article contribution. Please follow these guidelines as closely as possible, but use your judgment and/or ask others if you believe a situation calls for breaking or amending them. | The Official Caves of Qud Wiki Style Guide is a standard of editing practices and formatting styles for article contribution. Please follow these guidelines as closely as possible, but use your judgment and/or ask others if you believe a situation calls for breaking or amending them. | ||
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=== | ||
{{gamename}} has all items and creatures titles written in all lowercase, unless the name is proper([[Sparafucile]] vs [[giant centipede nest]]). To keep in the same spirit, all items and creatures will follow the same convention. If possible, the capitalization format of the game must be obeyed as much as possible. As an example, all mutations are capitalized in Title Case as they are in game ([[Multiple Legs]]) but cybernetics are not ([[cherubic visage]]). Concepts and mechanics that have no official name will follow standard wiki title format. The same concept applies to capitalizations of terms that appear within the text of an article. | {{gamename}} has all items and creatures titles written in all lowercase, unless the name is proper ([[Sparafucile]] vs [[giant centipede nest]]). To keep in the same spirit, all items and creatures will follow the same convention. If possible, the capitalization format of the game must be obeyed as much as possible. As an example, all mutations are capitalized in Title Case as they are in game ([[Multiple Legs]]) but cybernetics are not ([[cherubic visage]]). Concepts and mechanics that have no official name will follow standard wiki title format. The same concept applies to capitalizations of terms that appear within the text of an article. | ||
Exceptions can be made for section titles, table headers, and similar labels - these typically are written in Title Case regardless of the terminology involved. | Exceptions can be made for section titles, table headers, and similar labels - these typically are written in Title Case regardless of the terminology involved. | ||
| Line 20: | Line 21: | ||
| {{favilink|Corrosive Gas Generation}} | | {{favilink|Corrosive Gas Generation}} | ||
|- | |- | ||
| Skills | | Skills | ||
| Title Case | | Title Case | ||
| [[Dual Wield]] | | [[Dual Wield]] | ||
| Line 71: | Line 72: | ||
Categories should be named in their plural form when appropriate, capitalized in title case. E.g., [[:Category:Weapons]]. (However, note also [[:Category:Lore]], so named because the word "lore" has no common plural form.) | Categories should be named in their plural form when appropriate, capitalized in title case. E.g., [[:Category:Weapons]]. (However, note also [[:Category:Lore]], so named because the word "lore" has no common plural form.) | ||
You can use [https://en.wikipedia.org/wiki/Wikipedia:Categorization Wikipedia categorization guidelines] as a general reference for how categorization should work. Articles should generally be placed only in the most specific applicable category | You can use [https://en.wikipedia.org/wiki/Wikipedia:Categorization Wikipedia categorization guidelines] as a general reference for how categorization should work. Articles should generally be placed only in the most specific applicable category. All categories should have parent categories that eventually chain up to the [[:Category:Caves_of_Qud_Wiki|top-level caves of qud wiki category]]. For example, if an article is in [[:Category:Chairs]] it shouldn't also be in [[:Category:Furniture]]. It's okay to add multiple categories to an article if those categories aren't part of the same direct category hierarchy. For example, the [[miner's helmet]] page has both the Helmets and Light Sources categories. | ||
Note that many articles have a primary category already specified in their QBE-populated template, which will look like this (example from Shale wall with agate deposits): | |||
<pre> | |||
| categories = Gemstone Walls | |||
</pre> | |||
This category is already applied to the article so there's no need to add the category manually by adding <code><nowiki>[[Category:Gemstone Walls]]</nowiki></code> to the page | |||
===Reliability=== | ===Reliability=== | ||
| Line 81: | Line 88: | ||
===Formality=== | ===Formality=== | ||
Writing in the second person (referring to the reader directly with "you") usually has preferable alternatives. Consider using "the player" or "the player character" instead as appropriate, or something more suited to the context. | |||
Any recommendations or other opinions must be presented only in sections marked with [[Template:Opinion]], in order to help the reader distinguish verifiable fact from other additions. | Any recommendations or other opinions must be presented only in sections marked with [[Template:Opinion]], in order to help the reader distinguish verifiable fact from other additions. | ||
| Line 99: | 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 111: | Line 118: | ||
==== “Currently” ==== | ==== “Currently” ==== | ||
When referring to a feature of the game or some other state of affairs that is not expected to change except between game versions, the word “currently” carries an implicit expectation that the thing being described may change in the future. This is a claim that must be backed up with a source in order to be verifiable. The best way to source such a claim is to link to an issue on the [https://bitbucket.org/bbucklew/cavesofqud-public-issue-tracker/issues public issue tracker] that has been seen during a triage and not immediately closed. The easiest way to tell that this is the case is if the issue has been assigned to someone and its status is | When referring to a feature of the game or some other state of affairs that is not expected to change except between game versions, the word “currently” carries an implicit expectation that the thing being described may change in the future. This is a claim that must be backed up with a source in order to be verifiable. The best way to source such a claim is to link to an issue on the [https://bitbucket.org/bbucklew/cavesofqud-public-issue-tracker/issues public issue tracker] that has been seen during a triage and not immediately closed. The easiest way to tell that this is the case is if the issue has been assigned to someone and its status is “Open”. | ||
Making clear what game version is affected can provide a useful reference point for when the claim may have been true, and can save time for other editors if they decide to recheck the claim to see if it remains true or not. To do this, either: | |||
* make sure there is an up-to-date [[Template:As of patch]] on the page; | |||
* or use a phrase such as “as of patch [patch]” in place of “currently”. | |||
This rule is not related to uses of the word “currently” that are about something that is expected to change within a game session. For instance, “a creature that is currently flying” does not run afoul of this rule and does not call for a citation to justify that wording. | This rule is not related to uses of the word “currently” that are about something that is expected to change within a game session. For instance, “a creature that is currently flying” does not run afoul of this rule and does not call for a citation to justify that wording. | ||
| Line 120: | 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 136: | 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 149: | 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=== | ||
| Line 186: | Line 246: | ||
==Sprite Uploading== | ==Sprite Uploading== | ||
{{Main | Sprite Uploading}} | {{Main | Sprite Uploading}} | ||
== Modding == | |||
=== Naming Conventions === | |||
When writing mod code for the wiki that involves unique internal identifiers, such as object blueprint names or part names, ensure that the names are prefixed with <code>QudWiki_</code> in order to show good practice for avoiding name clashes. | |||
[[Category:Caves of Qud Wiki]] | [[Category:Caves of Qud Wiki]] | ||