Template:Class template: Difference between revisions

Latest revision as of 03:03, 18 December 2024

This template displays a message box on core class templates to warn users that they should only be used with the appropriate form—and adds these templates to Category:Class templates.

Usage

Provided fields fill out the class, form, and category names/links in the text of the message.

{{Class template|class=Ink|category=Inks}}

Warning: Class template

This is the main template for the Ink class—it should primarily be used with Form:Ink 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:Inks.

TemplateData

Used on top level class templates that should only be edited with the associated form.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Class	`class`	Name of the class.	String	required
Category	`category`	Name of the category used with pages in this class (do not include the "Category:" namespace).	String	required

@@ Line 1: / Line 1: @@
-{{ambox|text={{{class|}}}|color_bar=yellow|class=class-ambox}}
+<noinclude>
+This template displays a message box on core class templates to warn users that they should only be used with the appropriate form—and adds these templates to [[:Category:Class templates]].
+== Usage ==
+Provided fields fill out the class, form, and category names/links in the text of the message.
+<pre>
+{{Class template|class=Ink|category=Inks}}
+</pre>
+{{mbox
+ | title='''Warning:''' Class template
+ | text=This is the main template for the ''Ink'' class—it should primarily be used with [[Form:Ink]] 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.<p>Pages which use this template are listed at [[:Category:Inks]].</p>
+ | color_bar=#FFB511
+ | class=class-ambox
+}}
+== TemplateData ==
+<templatedata>
+{
+	"params": {
+		"class": {
+			"label": "Class",
+			"description": "Name of the class.",
+			"type": "string",
+			"required": true
+		},
+		"category": {
+			"label": "Category",
+			"description": "Name of the category used with pages in this class (do not include the \"Category:\" namespace).",
+			"type": "string",
+			"required": true
+		}
+	},
+	"description": "Used on top level class templates that should only be edited with the associated form.",
+	"format": "inline"
+}
+</templatedata>
+</noinclude><!--
+--><includeonly>{{mbox
+ | title='''Warning:''' Class template
+ | text=This is the main template for the ''{{{class|}}}'' class—it should primarily be used with [[Form:{{{class|}}}]] 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.<p>Pages which use this template are listed at [[:Category:{{{category|}}}]].</p>
+ | color_bar=#FFB511
+ | class=class-ambox
+}}[[Category:Class templates]]<!--
+--></includeonly>