Template:Commissioning: Difference between revisions

Revision as of 14:02, 23 December 2020

This tool is not ready for usage yet, since not all commissioning steps are completed yet. The process is not yet tracked on GitHub. Feel free to contribute to making it usable, any help is very welcome!

Task	comment	Status
Name the tool:	-	pending
Take a picture	-	pending
Find the manual as PDF	needed for all machines - add a link to the InfoBox or comment where you could not find it	pending
Documentation	this page, status: in commissioning	pending
Print QR-Code	use the wikicrawler	pending
Introduction	-	pending
Security Check	to be done or witnessed by a manager	pending
Test	to be done or witnessed by a manager	pending
tool's name, owner and approx. value	provide to Patrick for inventorization	pending
Last step: make it available	physically and in the wiki - then delete this template	pending

Documentation

This template marks a tool as not usable yet, since it was not fully [[commissioned]].

Template parameters
Parameter		Description	Type	Status
Issue Number	`IssueNumber`	Marks the commissioning progess as being discussed on GitHub and adds a link to the respective issue Default Default link to the issue tracker Example 223 Auto value	Number	optional
Name: Comment	`NamingComment`	Provides a comment for the name of the tool if needed. Default pending	String	optional
Name: Status	`Naming`	Indicated the status of providing the name of the new tool.	String	optional
PictureComment	`PictureComment`	no description	Unknown	optional
Picture: Status	`Picture`	Indicates the status of taking a picture of the new machine Default pending Auto value `pending`	String	optional
ManualComment	`ManualComment`	no description	Unknown	optional
Manual	`Manual`	no description	Unknown	optional
DocumentationComment	`DocumentationComment`	no description	Unknown	optional
Documentation	`Documentation`	no description	Unknown	optional
QRComment	`QRComment`	no description	Unknown	optional
QR	`QR`	no description	Unknown	optional
IntroductionComment	`IntroductionComment`	no description	Unknown	optional
Introduction	`Introduction`	no description	Unknown	optional
SecurityComment	`SecurityComment`	no description	Unknown	optional
Security	`Security`	no description	Unknown	optional
TestComment	`TestComment`	no description	Unknown	optional
Test	`Test`	no description	Unknown	optional
OwnerValueComment	`OwnerValueComment`	no description	Unknown	optional
OwnerValue	`OwnerValue`	no description	Unknown	optional
AvailabilityComment	`AvailabilityComment`	no description	Unknown	optional
Availability	`Availability`	no description	Unknown	optional

To use this template, simply insert this code at the top of your page and enter the relevant parameters:

{{Commissioning
|IssueNumber=42
|Naming=
|NamingComment=
|Picture=
|PictureComment=
|Manual=
|ManualComment=
|Documentation=
|DocumentationComment=
|QR=
|QRComment=
|Introduction=
|IntroductionComment=
|Security=
|SecurityComment=
|Test=
|TestComment=
|OwnerValue=
|OwnerValueComment=
|Availability=
|AvailabilityComment=
}}

@@ Line 28: / Line 28: @@
 <noinclude>
-This template marks a tool as not usable yet, since it was not fully [[commissioned]].
+== Documentation ==
+<templatedata>
+{
+	"params": {
+		"IssueNumber": {
+			"label": "Issue Number",
+			"description": "Marks the commissioning progess as being discussed on GitHub and adds a link to the respective issue",
+			"example": "223",
+			"default": "Default link to the issue tracker",
+			"type": "number",
+			"autovalue": ""
+		},
+		"NamingComment": {
+			"description": "Provides a comment for the name of the tool if needed.",
+			"type": "string",
+			"label": "Name: Comment",
+			"default": "pending"
+		},
+		"Naming": {
+			"label": "Name: Status",
+			"type": "string",
+			"description": "Indicated the status of providing the name of the new tool."
+		},
+		"PictureComment": {},
+		"Picture": {
+			"label": "Picture: Status",
+			"description": "Indicates the status of taking a picture of the new machine",
+			"type": "string",
+			"default": "pending",
+			"autovalue": "pending"
+		},
+		"ManualComment": {},
+		"Manual": {},
+		"DocumentationComment": {},
+		"Documentation": {},
+		"QRComment": {},
+		"QR": {},
+		"IntroductionComment": {},
+		"Introduction": {},
+		"SecurityComment": {},
+		"Security": {},
+		"TestComment": {},
+		"Test": {},
+		"OwnerValueComment": {},
+		"OwnerValue": {},
+		"AvailabilityComment": {},
+		"Availability": {}
+	},
+	"description": "This template marks a tool as not usable yet, since it was not fully [[commissioned]]."
+}
+</templatedata>
-== Documentation ==
 To use this template, simply insert this code at the top of your page and enter the relevant parameters:
 <pre>
@@ Line 57: / Line 107: @@
 }}
 </pre>
 </noinclude>