Template:TemplateDataHeader/doc: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
(TemplateData updated)
(+source)
 
(2 intermediate revisions by the same user not shown)
Line 13: Line 13:


Use <code><nowiki>{{TemplateDataHeader|Template name}}</nowiki></code> if you want an alternative name for the template to be displayed.
Use <code><nowiki>{{TemplateDataHeader|Template name}}</nowiki></code> if you want an alternative name for the template to be displayed.
:{|
{{TemplateDataHeader|Template name}}
|}


== TemplateData ==
Use <code><nowiki>{{TemplateData header|nolink=1}}</nowiki></code> to omit the wikilink from the word "TemplateData" in the header text, for instances where it is already linked outside this template.
:{|
{{TemplateDataHeader|nolink=1}}
|}
 
Use <code><nowiki>{{TemplateData header|noheader=1}}</nowiki></code> to omit the first sentence of the header text.
:{|
{{TemplateDataHeader|noheader=1}}
|}
 
== Parameters ==
{{TemplateDataHeader}}
{{TemplateDataHeader}}
<templatedata>
<templatedata>
{
{
"description": "Inserts a brief header for the template data section. Adds the page to [[Category:TemplateData documentation]]",
  "description": "Inserts a brief header for the template data section. Adds the page to [[Category:TemplateData documentation]]",
"params": {
  "params": {
"1": {
    "1": {
"label": "Template name",
      "label": "Template name",
"description": "The name of the template to display. Default is {{BASEPAGENAME}}.",
      "description": "Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.",
"type": "string",
      "type": "string",
"required": false
      "required": false
},
    },
"noheader": {
    "nolink": {
"label": "Remove header",
      "label": "No link",
"description": "If specified and not empty then header will not be added.",
      "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",
      "type": "string",
"required": false,
      "required": false,
"example": "noheader=1 or noheader=yes"
      "example": "nolink=1"
}
    },
}
    "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,
      "example": "noheader=1 or noheader=yes"
    }
  }
}
}
</templatedata>
</templatedata>


== Source ==
Code initialy taken from [https://en.wikipedia.org/wiki/Template:TemplateData_header Wikipedia - Template:TemplateData_header]


<includeonly>
<includeonly>

Latest revision as of 23:24, 11 December 2017

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.

Usage

==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 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 documentation for this template used by VisualEditor and other tools.

TemplateData for TemplateDataHeader

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

TemplateData for TemplateDataHeader

Parameters

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

ParameterDescriptionTypeStatus
Template name1

Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.

Stringoptional
No linknolink

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.

Example
nolink=1
Stringoptional
No headernoheader

Assigning any value to this parameter will cause the template to omit the first sentence of the header text.

Example
noheader=1 or noheader=yes
Stringoptional

Source

Code initialy taken from Wikipedia - Template:TemplateData_header