Template:Tutorial: Difference between revisions

Revision as of 20:27, 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
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
Tutorial type	`type`	What type of tutorial this is. Suggested values `Maintenance` `Hack` `Prepress` `Printing` `Finishing`	String	required
Tools needed	`tools`	What tools to have on hand. Example Metric feeler gauge	String	suggested
Parts needed	`parts`	Replacement parts needed.	String	suggested
Error codes	`errors`	Error codes associated with this tutorial.	String	suggested

@@ 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
+		},
+		"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.",
+			"example": "Metric feeler gauge",
+			"type": "string",
+			"suggested": true
+		},
+		"parts": {
+			"label": "Parts needed",
+			"description": "Replacement parts needed.",
+			"type": "string",
+			"suggested": true
+		},
+		"errors": {
+			"label": "Error codes",
+			"description": "Error codes associated with this tutorial.",
+			"type": "string",
+			"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)."
+}
+</templatedata>
 </noinclude><includeonly>{{Infobox tutorial
 | title = {{PAGENAME}}