Template:Documentation

From Test Wiki
Revision as of 22:13, 22 July 2024 by c>Rodejong (https://dev.miraheze.org/w/index.php?title=Template:Simple_documentation&oldid=18597)
The template description below will not be displayed when the template is placed.
Template: v · d · eTemplate/doc: v · d · e
Goal

This template can be used to add information about the purpose and use of a template. It also serves to create a separation between a template and the information about use that is not included when a template is placed.

Usage

The template can be used with two parameters and must be put between <noinclude></noinclude>.

<noinclude>{{documentation|1=

Explanation of purpose and use of the template

}}
</noinclude>
<noinclude>{{documentation|content=

Explanation of purpose and use of the template

}}
</noinclude>
It is suggested to always use the following parts in the template information
  • Goal
  • Usage
And if applicable
  • Default values
  • Related templates

For clarity, headings are best preceded by a semicolon (;).