Caves of Qud Wiki:Style Guide: Difference between revisions

From Caves of Qud Wiki
Jump to navigation Jump to search
m (Added some headers for a basic outline)
(book layout, categories, and some formatting. What constitutes a "page"?)
Line 2: Line 2:


==Article Layout==
==Article Layout==
===Infoboxes===
Infoboxes, boxes which summarize data relating to the article, should appear at the top-right corner of the article content. Item tooltips are also "infoboxes".
Infoboxes should generally summarize available information; speculation, as well as "unknown" or "n/a" rows, should be avoided. Most information required in infoboxes will be in ObjectBlueprints.xml.


===Book Layout===
===Book Layout===
All books will have an [[Template:Item]] containing the title colored yellow, sprite, commerce value, and id. A section titled 'Contents' will contain the actual contents of the book, and will be formatted using <code><nowiki> {{ quote | <poem>{{#invoke: ColorParse | parse |(your text here)}}</poem>))</nowiki></code> for each "page".


===NPC Layout===
===NPC Layout===


==Writing==
==Writing==
===Categories===
Categories will be named in their plural form, ex [[:Category:Artifacts]].
==Formatting==
===Color===
The wiki already has a template for the main colors found inside Caves of Qud. Do not directly format the text with html;[[Template:Color]] has all hexcodes as well as way to quickly format a line with a single color.
===Colored Names===
Item names such as [[Stopsvalinn]] have multicolor names in game. For ease of use, call [[Module:ColorParse]] instead of manually changing each letter using the Color Template.


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

Revision as of 01:14, 21 June 2019

The Official Caves of Qud Wiki Style Guide is a standard of editing practices and formatting styles for article contribution. The situation may call for breaks from these guidelines, it is best to follow these as close as possible. This is heavily based on Gamepedia's own Manual of Style.

Article Layout

Infoboxes

Infoboxes, boxes which summarize data relating to the article, should appear at the top-right corner of the article content. Item tooltips are also "infoboxes".

Infoboxes should generally summarize available information; speculation, as well as "unknown" or "n/a" rows, should be avoided. Most information required in infoboxes will be in ObjectBlueprints.xml.

Book Layout

All books will have an Template:Item containing the title colored yellow, sprite, commerce value, and id. A section titled 'Contents' will contain the actual contents of the book, and will be formatted using {{ quote | <poem>{{#invoke: ColorParse | parse |(your text here)}}</poem>)) for each "page".

NPC Layout

Writing

Categories

Categories will be named in their plural form, ex Category:Artifacts.

Formatting

Color

The wiki already has a template for the main colors found inside Caves of Qud. Do not directly format the text with html;Template:Color has all hexcodes as well as way to quickly format a line with a single color.

Colored Names

Item names such as Stopsvalinn have multicolor names in game. For ease of use, call Module:ColorParse instead of manually changing each letter using the Color Template.

Sprite Uploading