Kerbal Space Program 2 Wiki:Manual of Style/Parts: Difference between revisions

From Kerbal Space Program 2 Wiki
Jump to navigation Jump to search
m 1 revision imported: Attempt to import MoS subpages from fandom wiki
added mention of research node and tech tree
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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 [https://kerbal-space-program-2.fandom.com/wiki/Kerbal_Space_Program_2_Wiki:Manual_of_Style Manual of Style].
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 [[Kerbal Space Program 2 Wiki:Manual of Style|Manual of Style]].


== 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 ==
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 <u>required </u>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.
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 <u>required </u>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.


* '''<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 {{Tl|Infobox part}} template should be present at the top of the article. Configure the article's [[GameData:Example|GameData:]] counterpart to change the contents if necessary.
* '''<u>Lead section</u>''': The name of the part should be in bold, its classification, research node, tech tree tier, and science cost 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 [[IX-6315 "Dawn"|"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 ("sibling" parts, e.g. the [[RE-L10 "Poodle"|"Poodle"]] and [[SC-TT "Labradoodle"|"Labradoodle"]] engines).
 
* '''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>Lead section</u>''': The name of the part should be in bold, followed by its [[Parts#classifications|classification]]. 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). End this section with the part's research node and tech tree tier.
* '''<u>Synopsis</u>''': The in-game description of the part in italics, explicitly as present in the latest version and inclusive of typos, see below for further information.
 
* '''Part modules''': Part modules should be briefly introduced and identified, then included in the order present in the parts expanded info panel in-game. This content should adhere to template documentation.
* '''<u>Usage</u>''': 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, not within inclusive quotation marks, explicitly as present in the latest version and inclusive of typos.
 
* '''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. 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.
 
* '''<u>Changes</u>''': 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).
* '''<u>Changes</u>''': 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 [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.
* '''K for Kerb''': Community references, jokes, and general un-official tomfoolery (Dres is not real.) should be left to this section. Start the section using {{Tl|K for Kerb}}. See the [https://dwarffortresswiki.org/index.php/Category:D_for_Dwarf Dwarf Fortress Wiki] for more.
* '''<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>See also</u>'''
** Bulleted list of other related / relevant articles
** '''<u>Parts Navbox</u>''': The bottom of the page should display the {{Tl|Navbox Parts}} 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 [[[[:Category:Parts|Parts]]]] and their part type (e.g. [[Command Modules]]) which can be achieved through {{Tl|Navbox Parts}}. Other categories can be added as necessary.

Latest revision as of 19:49, 30 March 2025

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

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

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 part}} template should be present at the top of the article. Configure the article's GameData: counterpart to change the contents if necessary.
  • Lead section: The name of the part should be in bold, followed by its classification. 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). End this section with the part's research node and tech tree tier.
  • 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.
  • 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. 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.
  • 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. Start the section using {{K for Kerb}}. See the Dwarf Fortress Wiki for more.
  • See also
    • Bulleted list of other related / relevant articles
    • 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.