Module:Data/doc - Revision history

KiwiShark: fix links

2025-03-09T04:36:57Z

fix links

← Older revision		Revision as of 06:36, 9 March 2025
Line 4:		Line 4:
	<code><1></code> (Entity): This argument is taken as the title of the intended Data: page to search through.		<code><1></code> (Entity): This argument is taken as the title of the intended Data: page to search through.

	E.g.: "Kerbol", "LW-Sw "SWERV""		E.g.: "Kerbol", "LV-SW "SWERV""

	<code><2+></code> (Parameter chain): Arguments 2 and beyond define the parameter chain to search on the data page.		<code><2+></code> (Parameter chain): Arguments 2 and beyond define the parameter chain to search on the data page.
Line 18:		Line 18:

	== Examples ==		== Examples ==
	A list of example JSON sets can be found at [[~~Data~~:Example]].		A list of example JSON sets can be found at [[GameData:Example]].

	<code><nowiki>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</nowiki></code> - Returns the mass of the "SWERV" in tons, <code>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</code>.		<code><nowiki>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</nowiki></code> - Returns the mass of the "SWERV" in tons, <code>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</code>.

	<code><nowiki>{{#invoke:Data\|getData\|LV-3000 "Tuba"\|modules\|engine\|thrust\|vac}}</nowiki></code> - Returns the vacuum thrust of the "Tuba" in kilonewtons, <code>510.0</code>.		<code><nowiki>{{#invoke:Data\|getData\|LV-3000 "Tuba"\|modules\|engine\|thrust\|vac}}</nowiki></code> - Returns the vacuum thrust of the "Tuba" in kilonewtons, <code>510.0</code>.

KiwiShark: moved some comment text from the module into the documentation

2024-12-06T19:39:33Z

moved some comment text from the module into the documentation

← Older revision		Revision as of 21:39, 6 December 2024
Line 2:		Line 2:

	== Arguments ==		== Arguments ==
	<code><1></code> (~~Subject~~): This argument is taken as the title of the intended Data: page to search through.		<code><1></code> (Entity): This argument is taken as the title of the intended Data: page to search through.

			E.g.: "Kerbol", "LW-Sw "SWERV""

	<code><2+></code> (Parameter chain): Arguments 2 and beyond define the parameter chain to search on the data page.		<code><2+></code> (Parameter chain): Arguments 2 and beyond define the parameter chain to search on the data page.

			E.g.: "mass", "max_temp", "modules\|engine\|isp_vac", "modules\|generator\|outputs\|units"

	== Functions ==		== Functions ==

KiwiShark: added additional function explanations and fixed example linking

2024-11-30T02:46:16Z

added additional function explanations and fixed example linking

← Older revision		Revision as of 04:46, 30 November 2024
Line 8:		Line 8:
	== Functions ==		== Functions ==
	<code>getData</code>: The primary function of the module. Accepts the full argument set to determine the parameter to return from the subject.		<code>getData</code>: The primary function of the module. Accepts the full argument set to determine the parameter to return from the subject.

			<code>getFuelLabels</code>: Used for engine infobox construction. Accepts a part name (only works for engines) for <code><1></code> and optionally "alt" for <code><2></code>. Returns a line-break separated list of the propellant names used by an engine mode. ''Should probably be moved to a different Module.''

			<code>getFuelValues</code>: Used for engine infobox construction. Accepts a part name (only works for engines) for <code><1></code> and optionally "alt" for <code><2></code>. Returns a line-break separated list of the propellant use rates of an engine mode. ''Should probably be moved to a different Module.''

	== Examples ==		== Examples ==
	An example ~~populated~~ JSON ~~set~~ can be found at [[Data:Example~~]], and blank at [[Data:Example/blank~~]].		A list of example JSON sets can be found at [[Data:Example]].

	<code><nowiki>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</nowiki></code> - Returns the mass of the "SWERV", <code>~~4.000~~</code>.		<code><nowiki>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</nowiki></code> - Returns the mass of the "SWERV" in tons, <code>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</code>.

	<code><nowiki>{{#invoke:Data\|getData\|LV-3000 "Tuba"\|modules\|engine\|thrust\|vac}}</nowiki></code> - Returns the vacuum thrust of the "Tuba", <code>510.0</code>.		<code><nowiki>{{#invoke:Data\|getData\|LV-3000 "Tuba"\|modules\|engine\|thrust\|vac}}</nowiki></code> - Returns the vacuum thrust of the "Tuba" in kilonewtons, <code>510.0</code>.

KiwiShark: Updated example content

2024-10-12T16:24:25Z

Updated example content

← Older revision		Revision as of 18:24, 12 October 2024
Line 4:		Line 4:
	<code><1></code> (Subject): This argument is taken as the title of the intended Data: page to search through.		<code><1></code> (Subject): This argument is taken as the title of the intended Data: page to search through.

	<code><2+></code> (Parameter chain): Arguments 2~~, 3, 4,~~ and ~~so on~~ define the parameter chain to search on the data page.		<code><2+></code> (Parameter chain): Arguments 2 and beyond define the parameter chain to search on the data page.

	== Functions ==		== Functions ==
Line 10:		Line 10:

	== Examples ==		== Examples ==
	~~<code><LV-SW_"SWERV"><mass></code> - Returns the mass of the "SWERV"~~, ~~<code>4.000<~~/~~code>~~.		An example populated JSON set can be found at [[Data:Example]], and blank at [[Data:Example/blank]].

	<code><LV-~~3000_~~"~~Tuba~~"><~~modules~~><~~engine~~><~~thrust~~><vac></code> - Returns the vacuum thrust of the "Tuba", <code>510.0</code>.		<code><nowiki>{{#invoke:Data\|getData\|LV-SW "SWERV"\|mass}}</nowiki></code> - Returns the mass of the "SWERV", <code>4.000</code>.

			<code><nowiki>{{#invoke:Data\|getData\|LV-3000 "Tuba"\|modules\|engine\|thrust\|vac}}</nowiki></code> - Returns the vacuum thrust of the "Tuba", <code>510.0</code>.

KiwiShark: Format fixes

2024-10-09T21:48:59Z

Format fixes

← Older revision		Revision as of 23:48, 9 October 2024
Line 3:		Line 3:
	== Arguments ==		== Arguments ==
	<code><1></code> (Subject): This argument is taken as the title of the intended Data: page to search through.		<code><1></code> (Subject): This argument is taken as the title of the intended Data: page to search through.
	<code>2+</code> (Parameter chain): Arguments 2, 3, 4, and so on define the parameter chain to search on the data page.
			<code><2+></code> (Parameter chain): Arguments 2, 3, 4, and so on define the parameter chain to search on the data page.

	== Functions ==		== Functions ==
Line 9:		Line 10:

	== Examples ==		== Examples ==
	<LV-SW_"SWERV"><mass> - Returns the mass of the "SWERV", <code>4.000</code>.		<code><LV-SW_"SWERV"><mass></code> - Returns the mass of the "SWERV", <code>4.000</code>.
	<LV-3000_"Tuba"><modules><engine><thrust><vac> - Returns the vacuum thrust of the "Tuba", <code>510.0</code>.
			<code><LV-3000_"Tuba"><modules><engine><thrust><vac></code> - Returns the vacuum thrust of the "Tuba", <code>510.0</code>.

KiwiShark: Started documenting the module

2024-10-09T21:45:43Z

Started documenting the module

New page

The Data module exists to translate information from Data: pages to templates/articles.

== Arguments ==
<code><1></code> (Subject): This argument is taken as the title of the intended Data: page to search through.
<code>2+</code> (Parameter chain): Arguments 2, 3, 4, and so on define the parameter chain to search on the data page.

== Functions ==
<code>getData</code>: The primary function of the module. Accepts the full argument set to determine the parameter to return from the subject.

== Examples ==
<LV-SW_"SWERV"><mass> - Returns the mass of the "SWERV", <code>4.000</code>.
<LV-3000_"Tuba"><modules><engine><thrust><vac> - Returns the vacuum thrust of the "Tuba", <code>510.0</code>.