Template:TemplateData header

From Official Kodi Wiki
Revision as of 13:25, 2 November 2021 by RogueScholar (talk | contribs) (Create template to label display of TemplateData on template documentation pages)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for TemplateData header

[edit] Template documentation
Emblem-important-yellow.png NOTICE: This is a documentation subpage for Template:TemplateData header:
It contains usage information, categories and other content that is not part of the original template page.

The {{TemplateData header}} template inserts a brief header for the TemplateData 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.

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.

TemplateData for TemplateData header

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

TemplateData for TemplateData header

Example

Using a collapse box for &lsqbr;&lsqbr;Template:User&rsqbr;&rsqbr;:
{{Collapse top|title=TemplateData}} {{TemplateData header|User}} <templatedata>{ "description": "This template is used to create a link to a user's user page, 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" ] }, "separator": { "label": "Separator", "description": "Used to change the separator between the links. If unused, defaults to a dot." } } }</templatedata> {{Collapse bottom}}

Parameters

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

TemplateData for TemplateData header

<templatedata>{

 "description": "Inserts a brief header for the template data section. Adds the page to",
 "params": {
   "1": {
     "label": "Template name",
     "description": "Used to display a name for the template other than the default, which is TemplateData header.",
     "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>

See also