Template:Documentation

[view | edit | history | purge this page]Documentation

This template uses Module:Documentation, a script written in Lua.

This template produces a standardized documentation page for templates. These documentation page should detail the intent of the template, how to use it, any parameters the template takes (including acceptable arguments and optionality), and where necessary provide examples on what the template looks like in action. This template also allows proper categorization of template pages.

Usage

At the end of the template page in question, add

<noinclude>{{doc}}</noinclude>

This prevents the documentation from being transcluded every time the template is called.

Examples

Below is a copy-paste ready template for blank Documentation pages.

Introduction goes here - one line summary of what the template does

== Usage ==

Demonstrate how to use the template. The section below should list out every parameter with a description, such that a user should be able to just copy-paste it into a page for use.
<pre>
{{Templatename
|Parameter1= Parameter1 description
|Parameter2= Parameter2 description
|ParameterN= ParameterN description
}}</pre>

=== Parameters ===

{| class="wikitable"
|-
! Parameters !! Description !! Type !! Required
|-
| parameter1 || Description of what parameter1 is || string/boolean/file/number/any || yes/no/suggested
|}

=== Examples ===

Insert demonstrations of how to use the template, including the use of suggested parameters.

<includeonly>
<!-- Template categories/interwikis here -->
<!--e.g. [[Category:Notice templates]] or [[Category:Navbox templates]] or whatever-->
</includeonly>

[view | edit | history | purge this page]The above documentation is transcluded from Template:Documentation/doc.