Template:Documentation

Template page
Revision as of 08:50, 1 September 2016 by starcitizen>Facerafter
Template documentation (for the above template, sometimes hidden or invisible)
Template documentation (for the above template, sometimes hidden or invisible)

Template loop detected: Template:Documentation/doc


The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".

Usage

Place {{documentation}} at the top of the documentation page.

If the page to be documented is a subpage, use {{documentation|<pagename of page to be documented>}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{documentation|<Template:Foo/bar>}}.

The template will attempt to auto detect and link {{#Invoke:}} calls on template documentations or the require()/mw.loadData() depedency list on module documentations. If you want to supress the auto generated dependency list, use {{documentation}}

Note

This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.


TemplateData

The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
No parameters specified

Template documentation (for the above template, sometimes hidden or invisible)

Template loop detected: Template:Documentation The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".

Usage

Place {{documentation}} at the top of the documentation page.

If the page to be documented is a subpage, use {{documentation|<pagename of page to be documented>}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{documentation|<Template:Foo/bar>}}.

The template will attempt to auto detect and link {{#Invoke:}} calls on template documentations or the require()/mw.loadData() depedency list on module documentations. If you want to supress the auto generated dependency list, use {{documentation}}

Note

This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.


TemplateData

The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
No parameters specified