User:GuntherBayBeee/sandbox/Template:Documentation

From the Super Mario Wiki, the Mario encyclopedia
Jump to navigationJump to search

Template documentation
Click here to view this documentation or there to edit it. (About template documentation)
Please note that portions of the template sample may only be visible with values provided.

This template is not only inspired by the {{documentation}} template on Bulbapedia, but also used on template pages to contain documentation, instructions and information about how to use the template.

Templates are a powerful tool and scrutinizes the display of lots of information in a consistent and manageable way; they may be confusing to new users, however, and experienced users may also have difficulty making sense of the more complex ones. Furthermore, templates must be accompanied by documentation to improve usability, and to encourage others to experiment with templates and use them to their maximum potential.

What to include

A template's documentation must include a brief summary of what the template is for, and where it is intended to be used. This must be followed by a breakdown of any parameters and what values they accept. Lastly, there must be at least one example of the template in use.

Usage

To include {{documentation}} on a template page, place it at the bottom of the template page, directly after the last line of code, between <noinclude>...</noinclude> tags:

<last line of a template's code><noinclude>
{{documentation}}
</noinclude>