Template:TemplateDataHeader/doc: Difference between revisions

Revision as of 16:09, 31 July 2016

This is a documentation subpage for Template:TemplateDataHeader .
It contains usage information, categories and other content that is not part of the original template page.

Inserts a brief header for the template data section. Adds the page to Category:TemplateData documentation.

==TemplateData== or ==Parameters== or ==Usage==
{{TemplateDataHeader}}
<templatedata>{
...
}</templatedata>

Use {{TemplateDataHeader|Template name}} if you want an alternative name for the template to be displayed.

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for TemplateDataHeader

Inserts a brief header for the template data section. Adds the page to [[Category:TemplateData documentation]]

Template parameters
Parameter		Description	Type	Status
Template name	`1`	The name of the template to display. Default is {{BASEPAGENAME}}.	String	optional
Remove header	`noheader`	If specified and not empty then header will not be added. Example noheader=1 or noheader=yes	String	optional

@@ Line 16: / Line 16: @@
 == TemplateData ==
 {{TemplateDataHeader}}
-<templatedata>{
+<templatedata>
-  "description": "Inserts a brief header for the template data section. Adds the page to [[Category:TemplateData documentation]]",
+{
-  "params": {
+	"description": "Inserts a brief header for the template data section. Adds the page to [[Category:TemplateData documentation]]",
-    "1": {
+	"params": {
-      "label": "Template name",
+		"1": {
-      "description": "The name of the template to display. Default is {{BASEPAGENAME}}.",
+			"label": "Template name",
-      "type": "string",
+			"description": "The name of the template to display. Default is {{BASEPAGENAME}}.",
-      "required": false
+			"type": "string",
-    }
+			"required": false
-  }
+		},
-}</templatedata>
+		"noheader": {
+			"label": "Remove header",
+			"description": "If specified and not empty then header will not be added.",
+			"type": "string",
+			"required": false,
+			"example": "noheader=1 or noheader=yes"
+		}
+	}
+}
+</templatedata>