Template:TemplateData header/doc: Difference between revisions

Latest revision as of 07:36, 20 September 2023

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

This template uses Lua:

Module:Check for unknown parameters

The {{TemplateData header}} template inserts a brief header for the template data section, and adds the page to Category:Templates using TemplateData.

Usage

==TemplateData==
{{TemplateData header}}
<templatedata>{
...
}</templatedata>

Note: Section headers of ==Parameters== or ==Usage== may also be used.

Use {{TemplateData header|Template name}} to display a name for the template other than the default, which is {{BASEPAGENAME}}. Do not add namespace Template:

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Template name

Use {{TemplateData header|nolink=1}} to omit the wikilink from the word "TemplateData" in the header text, for instances where it is already linked outside this template.

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for TemplateData header

Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.

Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for TemplateData header

Example

Using a collapse box for Template:Elc:

Template:Nowiki template demo

Parameters

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for TemplateData header

Inserts a brief header for the TemplateData section. Adds the page to [[:Category:Templates using TemplateData]]

Template parameters
Parameter		Description	Type	Status
Template name	`1`	Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.	String	optional
No link	`nolink`	Assigning any value to this parameter will omit cause the template to omit the wikilink from the word "TemplateData" in the header text, for instances where it is already linked outside this template.	String	optional
No header	`noheader`	Assigning any value to this parameter will cause the template to omit the first sentence of the header text.	String	optional

@@ Line 1: / Line 1: @@
-<div class="templatedata-header">{{#if:{{{noheader|}}}|<!--
+{{Documentation subpage}}
- noheader:
+<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
--->{{Template parameter usage|based=y}}|<!--
+{{Lua|Module:Check for unknown parameters}}
- +header:
--->This is the {{#if:{{{nolink|}}}|<!--
-  +header, nolink TD
-  -->TemplateData|<!--
-  +header,  +link [[TD]]; DEFAULT:
--->[[Wikipedia:TemplateData|TemplateData]]}}<!--
-   e.o. #if:nolink; DEFAULT:
---> for this template used by [[mw:Extension:TemplateWizard|TemplateWizard]], [[Wikipedia:VisualEditor|VisualEditor]] and other tools. {{Template parameter usage|based=y}}<!--
-   e.o. #if:noheader
--->}}
-'''TemplateData for {{{1|{{BASEPAGENAME}}}}}'''
+The {{tlx|TemplateData header}} template inserts a brief header for the template data section, and adds the page to [[:Category:Templates using TemplateData]].
-</div><includeonly><!--
- check parameters
+== Usage ==
--->{{#invoke:Check for unknown parameters|check
+<pre style="overflow:auto;">
-|unknown={{template other|1=[[Category:Pages using TemplateData header with unknown parameters|_VALUE_]]}}
+==TemplateData==
-|template=Template:TemplateData header
+{{TemplateData header}}
-|1 |nolink |noheader
+<templatedata>{
-|preview=<div class="error" style="font-weight:normal">Unknown parameter '_VALUE_' in [[Template:TemplateData header]].</div>
+...
-}}<!--
+}</templatedata>
--->{{template other|{{sandbox other||
-[[Category:Templates using TemplateData]]
-}}}}</includeonly><!--
+Note: Section headers of ==Parameters== or ==Usage== may also be used.
+</pre>
---><noinclude>{{Documentation}}</noinclude>
+Use <code><nowiki>{{TemplateData header|Template name}}</nowiki></code> to display a name for the template other than the default, which is [[Help:Magic_words#Variables|<nowiki>{{BASEPAGENAME}}</nowiki>]]. Do ''not'' add namespace <code>Template:</code>
+:{|
+|{{TemplateData header|Template name}}
+|}
+Use <code><nowiki>{{TemplateData header|nolink=1}}</nowiki></code> to omit the [[Help:Link#Wikilinks|wikilink]] from the word "TemplateData" in the header text, for instances where it is already linked outside this template.
+:{|
+|{{TemplateData header|nolink=1}}
+|}
+Use <code><nowiki>{{TemplateData header|noheader=1}}</nowiki></code> to omit the first sentence of the header text.
+:{|
+|{{TemplateData header|noheader=1}}
+|}
+==Example==
+:Using a collapse box for {{elc|Template:User}}:
+{{nowiki template demo|code=<nowiki>
+{{collapse top|title=TemplateData}}
+{{TemplateData header|User}}
+<templatedata>
+{
+	"description": "This template is used to create a link to a user's user page (unless using {{Useranon}}), talk page, and contributions, and generates a special notification (aka 'ping').",
+	"params": {
+		"1": {
+			"label": "User name",
+			"type": "string",
+			"required": true,
+			"description": "The user name that you want to create links to and notify.",
+			"aliases":["user"]
+		},
+		"project": {
+			"label": "Sister project",
+			"type": "string",
+			"description": "Used to link to a sister project instead of the English Wikipedia. Use the standard interwiki prefix."
+		},
+		"lang": {
+			"label": "Other language project",
+			"type": "string",
+			"description": "Used to link to another language project. If used with the \"sister project\" parameter, links to another language of a sister project. Otherwise links to another language Wikipedia. Use the standard language code."
+		},
+		"separator": {
+			"label": "Separator",
+			"description": "Used to change the separator between the links. If unused, defaults to a dot."
+		}
+	}
+}
+</templatedata>
+{{collapse bottom}}</nowiki>}}
+==Parameters==
+{{TemplateData header}}
+<templatedata>{
+  "description": "Inserts a brief header for the TemplateData section. Adds the page to [[:Category:Templates using TemplateData]]",
+  "params": {
+    "1": {
+      "label": "Template name",
+      "description": "Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.",
+      "type": "string",
+      "required": false
+    },
+    "nolink": {
+      "label": "No link",
+      "description": "Assigning any value to this parameter will omit cause the template to omit the wikilink from the word \"TemplateData\" in the header text, for instances where it is already linked outside this template.",
+      "type": "string",
+      "required": false
+    },
+    "noheader": {
+      "label": "No header",
+      "description": "Assigning any value to this parameter will cause the template to omit the first sentence of the header text.",
+      "type": "string",
+      "required": false
+    }
+  }
+}</templatedata>
+==Tracking categories==
+* {{clc|Category:Pages using TemplateData header with unknown parameters}}
+* {{clc|Category:Templates using TemplateData}}
+==See also==
+* {{tl|Crude TemplateData}}
+* {{tl|Format TemplateData}}
+* {{tl|Template parameter usage}}
+* {{tl|TemplateData}}
+<includeonly>{{sandbox other||
+<!-- Categories below this line; interwikis at Wikidata -->
+{{DEFAULTSORT:Templatedata Header}}
+[[Category:TemplateData|Header]]
+[[Category:Documentation header templates]]
+}}</includeonly>

Template:TemplateData header/doc: Difference between revisions

Latest revision as of 07:36, 20 September 2023

Contents

Usage

Example

Parameters

Tracking categories

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Guides

Tools