Caves of Qud Wiki:Style Guide: Difference between revisions

Caves of Qud Wiki:Style Guide (view source)

Revision as of 16:42, 24 September 2019

305 bytes added , 16:42, 24 September 2019

major (incomplete) edit spree

Sol

Bureaucrats, Interface administrators, Administrators

1,046

edits

@@ Line 1: / Line 1: @@
-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 [https://help.gamepedia.com/Manual_of_Style Manual of Style].
+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.
+This is heavily based on Gamepedia's own [https://help.gamepedia.com/Manual_of_Style Manual of Style].
 ==Article Layout==
@@ Line 9: / Line 11: @@
 ===Prerelease Content===
-All content that has requires prerelease content to be enabled must be prefaced with [[Template:Prerelease Content]].
+All content that requires that prerelease content be enabled in order to appear in the game must be prefaced with [[Template:Prerelease Content]].
 ===Book Layout===
-All books will have an [[Template:Item]]  and is autogenerated by [[Qud Blueprint Explorer]]. Details should not be directly altered, including the category that is below the template. They must be there in order for QBE to function correctly. A section titled 'Contents' will contain the actual contents of the book, and will be formatted using <code><nowiki> {{Book Page|(your text here)})</nowiki></code> for each "page", with no extraneous whitespace inside of the text part of the template, i.e., none that isn't present in the actual page.
+Book articles should include [[Template:Item]], which is normally generated by [[Qud Blueprint Explorer]]. Please do not alter these except through QBE, as they're required in order for QBE to function correctly. The actual contents of the book should appear under a section titled 'Contents', using <code><nowiki> {{Book Page|(your text here)})</nowiki></code> to format each "page", with the 'exact' contents of the book's page data in the game files, including the exact whitespace used.
 ===NPC Layout===
-All NPCs will use [[Template:Character]] and is autogenerated by [[Qud Blueprint Explorer]]. Details should not be directly altered, including the category that is below the template. They must be there in order for QBE to function correctly.
+NPC articles should include [[Template:Character]], which is normally generated by [[Qud Blueprint Explorer]]. Please do not alter these except through QBE, as they're required in order for QBE to function correctly.
 ==Writing==
 ===Categories===
-Categories will be named in their plural form, ex [[:Category:Artifacts]]. All words will be capitalized.
+Categories should be named in their plural form when appropriate, with all words capitalized. E.g., [[:Category:Artifacts]]. (However, note also [[:Category:Lore]], so named because the word "lore" has no common plural form.)
 ===Reliability===
 To make sure that all information on this wiki is up to date, make sure to use [[Template:As Of Patch]] on the top of pages.
-To make sure that information is correct in the first place, if it is in a difficult to find area (a cs file that is NOT the ID specified in the page's infobox) be sure to note which cs file you found it in by using the <code><nowiki><ref></ref></nowiki></code> tags. The expected format is XRL.(file path).cs (method name if cs file is very large).
+To make sure that information is correct in the first place, if it is in a difficult-to-find location (e.g., a C# class whose name is ''not'' the ID specified in the page's infobox), be sure to note which C# class you found it in by using a <code><nowiki><ref></ref></nowiki></code> tag. The expected format is <code>Namespace.Class:Method</code>, although the method may be omitted if the class's implementation is small or if it's not applicable. Line numbers must not be included, because they may be inconsistent across disassemblies.
 ===Formality===
-Unless it is a guide, writing in the second person (referring to the reader directly with 'you') is highly discouraged against. It should be referred to as the Player character, to distinguish between the actual player themselves.
+Unless the article is a guide, 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.
-Avoid writing recommendations and personal opinions in the main text, and separate them into their own section marked with [[Template:Opinion]] so readers are able to discern what is factual and what is personal opinion.
+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.
 ===Terminology===