Template:Tutorial: Difference between revisions

Latest revision as of 21:04, 29 January 2025

Warning: Class template

This is the main template for the Tutorial class—it should primarily be used with Form:Tutorial to create or edit associated pages, and not invoked in other circumstances. Most of the content can be edited with the VisualEditor, but for best functionality please use the specified form.

Pages which use this template are listed at Category:Tutorials.

TemplateData

The main template for the "Tutorial" class used on how-to type articles. This template handles semantic annotation and transcludes display templates for the data (mainly Template:Infobox tutorial).

Template parameters[Edit template data]
Parameter		Description	Type	Status
Tutorial type	`tutorial_type`	What type of tutorial this is. Suggested values `Maintenance` `Hack` `Prepress` `Printing` `Finishing`	String	required
Difficulty	`difficulty`	How complex/advanced this tutorial is to follow. Suggested values `Beginner` `Intermediate` `Expert`	String	suggested
Time estimate	`time`	Estimate of how long this tutorial will take.	String	suggested
For series	`series`	The list of duplicator series this tutorial applies to.	Page name	suggested
Tools needed	`tools`	What tools to have on hand.	Unknown	optional
Parts needed	`parts`	Replacement parts needed.	Unknown	optional
Error codes	`errors`	Error codes associated with this tutorial.	Unknown	optional

@@ Line 1: / Line 1: @@
 <noinclude>{{Class template|class=Tutorial|category=Tutorials}}
+== TemplateData ==
+<templatedata>
+{
+	"params": {
+		"difficulty": {
+			"label": "Difficulty",
+			"description": "How complex/advanced this tutorial is to follow.",
+			"type": "string",
+			"suggestedvalues": [
+				"Beginner",
+				"Intermediate",
+				"Expert"
+			],
+			"suggested": true
+		},
+		"time": {
+			"label": "Time estimate",
+			"description": "Estimate of how long this tutorial will take.",
+			"type": "string",
+			"suggested": true
+		},
+		"tutorial_type": {
+			"label": "Tutorial type",
+			"description": "What type of tutorial this is.",
+			"type": "string",
+			"suggestedvalues": [
+				"Maintenance",
+				"Hack",
+				"Prepress",
+				"Printing",
+				"Finishing"
+			],
+			"required": true
+		},
+		"tools": {
+			"label": "Tools needed",
+			"description": "What tools to have on hand."
+		},
+		"parts": {
+			"label": "Parts needed",
+			"description": "Replacement parts needed."
+		},
+		"errors": {
+			"label": "Error codes",
+			"description": "Error codes associated with this tutorial."
+		},
+		"series": {
+			"label": "For series",
+			"description": "The list of duplicator series this tutorial applies to.",
+			"type": "wiki-page-name",
+			"suggested": true
+		}
+	},
+	"description": "The main template for the \"Tutorial\" class used on how-to type articles. This template handles semantic annotation and transcludes display templates for the data (mainly Template:Infobox tutorial).",
+	"paramOrder": [
+		"tutorial_type",
+		"difficulty",
+		"time",
+		"series",
+		"tools",
+		"parts",
+		"errors"
+	]
+}
+</templatedata>
 </noinclude><includeonly>{{Infobox tutorial
 | title = {{PAGENAME}}
+| tutorial_type = {{{tutorial_type|}}}
 | difficulty = {{{difficulty|}}}
 | time = {{{time|}}}
-| type = {{{type|}}}
+| series = {{{series|}}}
 | tools = {{{tools|}}}
 | parts = {{{parts|}}}