Editing RimWorld Wiki:Style guide
Jump to navigation
Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 4: | Line 4: | ||
* New content added to this page should address a persistently recurring style issue. | * New content added to this page should address a persistently recurring style issue. | ||
* Any substantive edit to this page should reflect consensus. When in doubt, discuss first on the talk page. | * Any substantive edit to this page should reflect consensus. When in doubt, discuss first on the talk page. | ||
+ | __TOC__ | ||
== Language == | == Language == | ||
Line 11: | Line 12: | ||
== Page titles == | == Page titles == | ||
Plural: Pages should be singular unless plural in-game (e.g. Frag grenades) or refer to a group of similar things (e.g. Trees). | Plural: Pages should be singular unless plural in-game (e.g. Frag grenades) or refer to a group of similar things (e.g. Trees). | ||
− | + | ||
Capitalization: | Capitalization: | ||
;Page names that use sentence case: | ;Page names that use sentence case: | ||
* In-game items and features, e.g. Wood, Steel helmet, Muscle parasites, Advanced component, Learning helper | * In-game items and features, e.g. Wood, Steel helmet, Muscle parasites, Advanced component, Learning helper | ||
* General topics, e.g. Defense tactics, World generation | * General topics, e.g. Defense tactics, World generation | ||
− | ; | + | ;Pages names that use title case: |
* AI storytellers, e.g. Randy Random | * AI storytellers, e.g. Randy Random | ||
* Guides, e.g. Extreme Heat Guide | * Guides, e.g. Extreme Heat Guide | ||
Line 46: | Line 47: | ||
* Use sentence case for thoughts. e.g. Eating raw food will cause the "Ate raw food" thought. | * Use sentence case for thoughts. e.g. Eating raw food will cause the "Ate raw food" thought. | ||
− | == Images == | + | ==Images== |
* Screenshots should be high quality, cropped to focus on the subject, and free from UI clutter. | * Screenshots should be high quality, cropped to focus on the subject, and free from UI clutter. | ||
* Image filenames should: | * Image filenames should: | ||
Line 54: | Line 55: | ||
** e.g. Caravan packing spot.png, Game-of-Ur board.png, Save file for Mac using EasyFind.png . | ** e.g. Caravan packing spot.png, Game-of-Ur board.png, Save file for Mac using EasyFind.png . | ||
− | == Table of contents == | + | ==Table of contents== |
* Generally, the table of contents is floated right by use of [[Template:TOCright]]. | * Generally, the table of contents is floated right by use of [[Template:TOCright]]. | ||
− | * The table of contents (automatically added on pages with 4 or more sections) may be suppressed (by placing the magic word | + | * The table of contents (automatically added on pages with 4 or more sections) may be suppressed (by placing the magic word __NOTOC__ at the top of the page or at least before the main content. Suppressing the TOC is usually desirable on pages that are short enough that most or all of the sections are visible. |
* On tables with a TOC, a table or section might inadvertently be pushed below the TOC. Currently, the following is used to remove the white space and make the content flow alongside the TOC: | * On tables with a TOC, a table or section might inadvertently be pushed below the TOC. Currently, the following is used to remove the white space and make the content flow alongside the TOC: | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
Line 85: | Line 86: | ||
* '''Acquisition:''' Details how the page subject may be acquired. This may include details on construction or crafting, the places it may be found or traded for, its presence as a quest reward, or the raiders it can be looted from | * '''Acquisition:''' Details how the page subject may be acquired. This may include details on construction or crafting, the places it may be found or traded for, its presence as a quest reward, or the raiders it can be looted from | ||
− | * '''Summary:''' Details information about the item that | + | * '''Summary:''' Details information about the item that is readily conveyed by the standardized templates on the page and don't fit in the other sections - for example the effects of the [[Psychic shock lance]] are not Analysis or Acquisition, nor are they conveyed by the infobox or other information. |
* '''Analysis:''' The place for comparison, value judgements, tactics, etc. Comparing the armor of Flak vests to other armor alternatives goes here, strategies for using psychic insanity lances for maximum effect goes here etc. This section can have some overlap with others - a farming strategy for the acquisition of Insect Jelly is a valid subject for example. Discussion about the stats or effects of an item might involve listing them just like Summary does, but is still valid. Subsections should be added as needed for clarity. | * '''Analysis:''' The place for comparison, value judgements, tactics, etc. Comparing the armor of Flak vests to other armor alternatives goes here, strategies for using psychic insanity lances for maximum effect goes here etc. This section can have some overlap with others - a farming strategy for the acquisition of Insect Jelly is a valid subject for example. Discussion about the stats or effects of an item might involve listing them just like Summary does, but is still valid. Subsections should be added as needed for clarity. | ||
− | |||
− | |||
* '''Version history:''' Lists a changelog of the pages subject. Changes should be listed as changes i.e. "1.2.2900 - now provides ability to fly" instead of retroactive consideration e.g. "1.2.2900 - prior to this, it didn't allow you to fly". Similarly, if possible and know the exact changes should be listed e.g. "1.2.2900 - Sharp armor increased from 100% -> 150%". Ideally the version number would be specific but this is not always known or possible - do not link to a specific version unless that version is the one that implemented the specific change i.e. don't link 1.1.2258 specifically if all you know is that it was somewhere in 1.1. Ideally the following format should be used, placed in bullet points "<nowiki>*[[Version/<Version Number>|<Version Number>]] - <Change desc> </nowiki>. A gallery of relevant changes may be included at the end - for example showing old textures. | * '''Version history:''' Lists a changelog of the pages subject. Changes should be listed as changes i.e. "1.2.2900 - now provides ability to fly" instead of retroactive consideration e.g. "1.2.2900 - prior to this, it didn't allow you to fly". Similarly, if possible and know the exact changes should be listed e.g. "1.2.2900 - Sharp armor increased from 100% -> 150%". Ideally the version number would be specific but this is not always known or possible - do not link to a specific version unless that version is the one that implemented the specific change i.e. don't link 1.1.2258 specifically if all you know is that it was somewhere in 1.1. Ideally the following format should be used, placed in bullet points "<nowiki>*[[Version/<Version Number>|<Version Number>]] - <Change desc> </nowiki>. A gallery of relevant changes may be included at the end - for example showing old textures. | ||
− | |||
== Definitions == | == Definitions == | ||
Line 102: | Line 100: | ||
** All other words are generally lower case unless proper nouns. | ** All other words are generally lower case unless proper nouns. | ||
* SMW: Semantic MediaWiki. The plugin that allows storing and querying of data by means of properties stored in the Property namespace. | * SMW: Semantic MediaWiki. The plugin that allows storing and querying of data by means of properties stored in the Property namespace. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
[[Category:Help]] | [[Category:Help]] |