Kerbal Space Program 2 Wiki:Manual of Style/Parts: Difference between revisions
More actions
(Link fix) Tag: 2017 source edit |
(Overall updates to the various article sections) |
||
Line 2: | Line 2: | ||
== Naming conventions == | == Naming conventions == | ||
Part articles are to be titled explicitly per their appearance in-game, e.g. IX-6315 "Dawn", PPD-20 "Wayfarer", Circular Intake, HS-01, et cetera. | Part articles are to be titled explicitly per their appearance in-game, e.g. [[IX-6315 "Dawn"]], [[PPD-20 "Wayfarer"]], [[Circular Intake]], [[HS-01]], et cetera. | ||
== Layout == | == Layout == | ||
Line 8: | Line 8: | ||
* '''<u>Infobox</u>''': The infobox should be present at the top of the article. Contents here should adhere to the template documentation. | * '''<u>Infobox</u>''': The infobox should be present at the top of the article. Contents here should adhere to the template documentation. | ||
* '''<u>Lead section</u>''': The name of the part should be in bold | * '''<u>Lead section</u>''': The name of the part should be in bold. Its classification, research node, and tech tree tier go first. Then a brief summary of the physical appearance of the part, its general applications in vessel design e.g. useful for interplanetary travel), and any notable details (the "Dawn" being the only Xenon engine, the [[LV-3000 "Tuba"|"Tuba"]] having the greatest gimbal range). Relationships to other parts can then also be mentioned if applicable (e.g. the [[RE-L10 "Poodle"|"Poodle"]] and [[SC-TT "Labradoodle"|"Labradoodle"]] engines); the terminology to use being "sibling" parts. | ||
* '''Usage''': Further explanation on the function and intended or potential uses of a part can be provided in greater detail here, building on anything mentioned in the lead section and/or introducing new information. | * '''Usage''': Further explanation on the function and intended or potential uses of a part can be provided in greater detail here, building on anything mentioned in the lead section and/or introducing new information. | ||
* '''<u>Synopsis</u>''': The in-game description of the part in italics, explicitly as present in the latest version and inclusive of typos | * '''<u>Synopsis</u>''': The in-game description of the part in italics, not within inclusive quotation marks, explicitly as present in the latest version and inclusive of typos. | ||
* '''Part modules''': Part modules should be | * '''Part modules''': Part modules other than the default "Statistics" data should be included using the Tabber extension in the order present in the part's expanded info panel in-game. | ||
* '''Gallery''': Additional images with captions of the part from in-game screenshots may be included here. | * '''Gallery''': Additional images with captions of the part from in-game screenshots may be included here. | ||
* '''Trivia''': If any noteworthy trivia exists for a part, such as a reference in its synopsis or relation to a real-life analog, it may be included here. | * '''Trivia''': If any noteworthy trivia exists for a part, such as a reference in its synopsis or relation to a real-life analog, it may be included here. | ||
Line 17: | Line 17: | ||
* '''K for Kerb''': Community references, jokes, and general un-official tomfoolery (Dres is not real.) should be left to this section. See the [https://dwarffortresswiki.org/index.php/Category:D_for_Dwarf Dwarf Fortress Wiki] for more. | * '''K for Kerb''': Community references, jokes, and general un-official tomfoolery (Dres is not real.) should be left to this section. See the [https://dwarffortresswiki.org/index.php/Category:D_for_Dwarf Dwarf Fortress Wiki] for more. | ||
* '''<u>Parts Navbox</u>''': The bottom of the page should display the <nowiki>{{Navbox Parts}}</nowiki> template by default. | * '''<u>Parts Navbox</u>''': The bottom of the page should display the <nowiki>{{Navbox Parts}}</nowiki> template by default. | ||
* '''<u>Categories</u>''': Relevant <nowiki>[[Categories]]</nowiki> should be listed at the bottom of the article. All parts should be categorized with [[Parts]] and their part type (e.g. [[Command Modules]]). Other categories can be added as necessary. | * '''<u>Categories</u>''': Relevant <nowiki>[[Categories]]</nowiki> should be listed at the bottom of the article. All parts should be categorized with [[Parts]] and their part type (e.g. [[Command Modules]]) which can be achieved through <nowiki>{{Navbox Parts}}</nowiki>. Other categories can be added as necessary. |
Latest revision as of 23:22, 16 September 2024
The following are guidelines for various aspects of writing article content about parts, established by consensus among KSP 2 Wiki editors. Please discuss them on the talk page if you have ideas or questions. Editors should also be familiar with the main Manual of Style.
Naming conventions[edit source]
Part articles are to be titled explicitly per their appearance in-game, e.g. IX-6315 "Dawn", PPD-20 "Wayfarer", Circular Intake, HS-01, et cetera.
Layout[edit source]
The following labels describe the ordering of sections used in articles related to parts, listed in order as they should be included in an article. Underlined items are required for article. These do not necessarily have to respond to the actual section headers and divisions. Do not try to conform to them if they are not helping to improve the article.
- Infobox: The infobox should be present at the top of the article. Contents here should adhere to the template documentation.
- Lead section: The name of the part should be in bold. Its classification, research node, and tech tree tier go first. Then a brief summary of the physical appearance of the part, its general applications in vessel design e.g. useful for interplanetary travel), and any notable details (the "Dawn" being the only Xenon engine, the "Tuba" having the greatest gimbal range). Relationships to other parts can then also be mentioned if applicable (e.g. the "Poodle" and "Labradoodle" engines); the terminology to use being "sibling" parts.
- Usage: Further explanation on the function and intended or potential uses of a part can be provided in greater detail here, building on anything mentioned in the lead section and/or introducing new information.
- Synopsis: The in-game description of the part in italics, not within inclusive quotation marks, explicitly as present in the latest version and inclusive of typos.
- Part modules: Part modules other than the default "Statistics" data should be included using the Tabber extension in the order present in the part's expanded info panel in-game.
- Gallery: Additional images with captions of the part from in-game screenshots may be included here.
- Trivia: If any noteworthy trivia exists for a part, such as a reference in its synopsis or relation to a real-life analog, it may be included here.
- Changes: This list details any changes made to a part per game version, beginning with its introduction, in reverse chronological order top to bottom (most recent at the top).
- K for Kerb: Community references, jokes, and general un-official tomfoolery (Dres is not real.) should be left to this section. See the Dwarf Fortress Wiki for more.
- Parts Navbox: The bottom of the page should display the {{Navbox Parts}} template by default.
- Categories: Relevant [[Categories]] should be listed at the bottom of the article. All parts should be categorized with Parts and their part type (e.g. Command Modules) which can be achieved through {{Navbox Parts}}. Other categories can be added as necessary.