Jump to content

Template:TemplateData/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

{{TemplateData|TemplateData content}}

This template is intended for inclusion in template documentation, either within /doc or the <noinclude>...</noinclude> tags of a template. It displays any content, intended to be TemplateData or transclusions of TemplateData from other locations, along with standard headers. If parameter 1 is not specified, this template detects whether the subpage /TemplateData exists for the current template, and provides a standardized header based on its existence:

  • /TemplateData exists - the template automatically transcludes the TemplateData subpage into the documentation to be used by the visual editor and other tools that read the machine code, including all of the proper headers, along with links to edit and view the page and its history.
  • /TemplateData does not exist - the template creates a section header with links to create the TemplateData subpage and preloads basic TemplateData code that is usable by Wikipedia tools.

Examples

[edit]

Default /TemplateData subpage exists

[edit]

{{TemplateData}}

Template Data [view] [edit] [history] [purge]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:TemplateData in articles based on its TemplateData.

TemplateData for TemplateData

Creates a standard section header for TemplateData, and links for editing/viewing/history/purge for existing TemplateData subpage, and creation with preload for non-existent subpage.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
TemplateData content1

Bare TemplateData content and/or transclusions of TemplateData from other pages

Contentoptional
Manage TemplateData page2

Page containing template-specific TemplateData

Page nameoptional


Missing /TemplateData subpage

[edit]

{{TemplateData}}

Template Data [create] [purge]

Alternate TemplateData content

[edit]
Simple TemplateData not needing a subpage
{{TemplateData|
<templatedata>{
  "description": "simple template description",
  "format": "inline",
  "params": { }
}</templatedata>
}}
Template Data [view] [edit] [history] [purge]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:TemplateData in articles based on its TemplateData.

TemplateData for TemplateData

simple template description

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
No parameters specified
Complex TemplateData transcluded from elsewhere
{{TemplateData|
{{TemplateData/other_TD_page|{{PAGENAME}}}}
|template:TemplateData/other_TD_page
}}
Template Data [view] [edit] [history] [purge]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:TemplateData in articles based on its TemplateData.

TemplateData for TemplateData

TemplateData for use with any other template

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
No parameters specified

See also

[edit]