Template:Documentation

From IxWiki
Revision as of 14:51, 28 August 2022 by mp>A876 (A876 moved page Template:Doc to Template:Documentation over redirect: because what is a "Doc"? because shorter redirects to longer. (almost no templates have any "Doc".))
Jump to navigation Jump to search

[edit] [purge] Documentation

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}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{documentation}}.

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".

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
No parameters specified